Professional Documents
Culture Documents
01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Dulcimer: firmware/usbconfig.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>firmware/usbconfig.h File Reference</h1>Configuration options for the USB-
driver. <a href="#_details">More...</a>
<p>
<p>
<a href="firmware_2usbconfig_8h-source.html">Go to the source code of this
file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td
class="memItemRight" valign="bottom"><a class="el"
href="firmware_2usbconfig_8h.html#98ed17962b55543b35e10ae1f8ebe09b">USB_CFG_IOPORTN
AME</a> D</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Configuration options for the USB-driver.
<p>
This file is almost identical to the original usbconfig.h by Christian Starkjohann,
in structure and content.<p>
It contains parts of the USB driver which can be configured and can or must be
adapted to your hardware. <dl class="author"
compact><dt><b>Author:</b></dt><dd>Ronald Schaten <<a
href="mailto:ronald@schatenseite.de">ronald@schatenseite.de</a>> </dd></dl>
<dl class="version" compact><dt><b>Version:</b></dt><dd></dd></dl>
<dl class="rcs" compact><dt><b>Id</b></dt><dd>usbconfig.h,v 1.1 2008-07-09 20:47:12
rschaten Exp </dd></dl>
<p>
License: GNU GPL v2 (see License.txt)
<p>Definition in file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="8aae9f682ca9f91faae0453e4351a50b"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_CONFIGURATION"
ref="8aae9f682ca9f91faae0453e4351a50b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_CONFIGURATION 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a916bf33f6f8f481a219d0a81b5b225e"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_DEVICE"
ref="a916bf33f6f8f481a219d0a81b5b225e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DESCR_PROPS_DEVICE 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="dfbd53b5310c36b1e4b06d6a3b992e8a"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_HID"
ref="dfbd53b5310c36b1e4b06d6a3b992e8a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DESCR_PROPS_HID 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="248eae427d6cea0046661eb8438b7198"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_HID_REPORT"
ref="248eae427d6cea0046661eb8438b7198" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_HID_REPORT 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9c0556a4c6c5a1ab8f6598aee8e5bf6a"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_STRING_0"
ref="9c0556a4c6c5a1ab8f6598aee8e5bf6a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_STRING_0 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a08084f9755a643e02d469b66b129ef6"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_STRING_PRODUCT"
ref="a08084f9755a643e02d469b66b129ef6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_STRING_PRODUCT 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="82224c07d3a1f9fcccbff70b71c8ea51"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER"
ref="82224c07d3a1f9fcccbff70b71c8ea51" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="55edf2117128387162339d98ba2af0f4"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_STRING_VENDOR"
ref="55edf2117128387162339d98ba2af0f4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_STRING_VENDOR 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="750fb6cc3e8eafaddae659af97f6f737"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_STRINGS"
ref="750fb6cc3e8eafaddae659af97f6f737" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_STRINGS 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3c9ed2d932cf0f5fc9788a91028a8b4b"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DESCR_PROPS_UNKNOWN"
ref="3c9ed2d932cf0f5fc9788a91028a8b4b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_DESCR_PROPS_UNKNOWN 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9ce4f96ad98b3db8205691e8bc723e55"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DEVICE_CLASS" ref="9ce4f96ad98b3db8205691e8bc723e55"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DEVICE_CLASS 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
See USB specification if you want to conform to an existing device class.
<p>
This setting means to specify the class at the interface level.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00148">148</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="bc740455309399430b0f49bf7931d1d7"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DEVICE_ID" ref="bc740455309399430b0f49bf7931d1d7"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DEVICE_ID 0x31, 0xe1
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is the ID of the product, low byte first.
<p>
It is interpreted in the scope of the vendor ID. If you have registered your own
VID with usb.org or if you have licensed a PID from somebody else, define it here.
Otherwise you use obdev's free shared VID/PID pair. Be sure to read the rules in
USBID-License.txt!
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00122">122</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9b482a2b2740652ffe7dcb6695ca0c91"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DEVICE_NAME" ref="9b482a2b2740652ffe7dcb6695ca0c91"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DEVICE_NAME 'D',
'u', 'l', 'c', 'i', 'm', 'e', 'r' </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Same as above for the device name.
<p>
If you don't want a device name, undefine the macros. See the file USBID-
License.txt before you assign a name.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00141">141</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="e68f17e6baf13805abc56e74beadeb57"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DEVICE_NAME_LEN"
ref="e68f17e6baf13805abc56e74beadeb57" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DEVICE_NAME_LEN 8
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Length of USB_CFG_DEVICE_NAME.
<p>
</div>
</div><p>
<a class="anchor" name="89e5ad66f8b835866e7d836c73bfd30d"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DEVICE_SUBCLASS"
ref="89e5ad66f8b835866e7d836c73bfd30d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DEVICE_SUBCLASS 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
See USB specification if you want to conform to an existing device subclass.
<p>
</div>
</div><p>
<a class="anchor" name="ba3c7c0cd4055ba3bbf5df38e57b6d27"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DEVICE_VERSION" ref="ba3c7c0cd4055ba3bbf5df38e57b6d27"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DEVICE_VERSION 0x00,
0x01 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Version number of the device: Minor number first, then major number.
<p>
</div>
</div><p>
<a class="anchor" name="3a8bf6679cd70d1ddcc05024ffef9922"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DMINUS_BIT" ref="3a8bf6679cd70d1ddcc05024ffef9922"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DMINUS_BIT 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
<p>
This may be any bit in the port.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00028">28</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3005cdbb03c707af8007363632d7d02d"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_DPLUS_BIT" ref="3005cdbb03c707af8007363632d7d02d"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_DPLUS_BIT 2
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
<p>
This may be any bit in the port. Please note that D+ must also be connected to
interrupt pin INT0!
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00033">33</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5495a12e572cdaa8e11358f92d1b324f"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_HAVE_FLOWCONTROL"
ref="5495a12e572cdaa8e11358f92d1b324f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_HAVE_FLOWCONTROL 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define this to 1 if you want flowcontrol over USB data.
<p>
See the definition of the macros usbDisableAllRequests() and usbEnableAllRequests()
in usbdrv.h.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00100">100</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="fe176bba6f05a034a5eec11f7ed6302b"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_HAVE_INTRIN_ENDPOINT"
ref="fe176bba6f05a034a5eec11f7ed6302b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_HAVE_INTRIN_ENDPOINT 1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define this to 1 if you want to compile a version with two endpoints: The default
control endpoint 0 and an interrupt-in endpoint 1.
<p>
</div>
</div><p>
<a class="anchor" name="973c0b60531876ba52c4447e0fd0a150"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_HAVE_INTRIN_ENDPOINT3"
ref="973c0b60531876ba52c4447e0fd0a150" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_HAVE_INTRIN_ENDPOINT3 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define this to 1 if you want to compile a version with three endpoints: The default
control endpoint 0, an interrupt-in endpoint 1 and an interrupt-in endpoint 3.
<p>
You must also enable endpoint 1 above.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00059">59</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="47d9bef5c10a1b9ba917eca583d2abc9"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH"
ref="47d9bef5c10a1b9ba917eca583d2abc9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 63 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define this to the length of the HID report descriptor, if you implement an HID
device.
<p>
Otherwise don't define it or define it to 0.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00167">167</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6be8d20f2d0eb0e87460b26681e60611"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_IMPLEMENT_FN_READ"
ref="6be8d20f2d0eb0e87460b26681e60611" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_IMPLEMENT_FN_READ 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this to 1 if you need to send control replies which are generated "on the fly"
when <a class="el"
href="bootloader_2main_8c.html#60cb66d7dc4c292a004b2b4e796a7e0b">usbFunctionRead()<
/a> is called.
<p>
If you only want to send data from a static buffer, set it to 0 and return the data
from <a class="el"
href="bootloader_2main_8c.html#e6f351eca7bf6fb1251f9a478cbae2b0">usbFunctionSetup()
</a>. This saves a couple of bytes.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00090">90</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7f117e204e14ff1028ada59f622173f2"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_IMPLEMENT_FN_WRITE"
ref="7f117e204e14ff1028ada59f622173f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_IMPLEMENT_FN_WRITE 1
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this to 1 if you want <a class="el"
href="bootloader_2main_8c.html#92f69288e90801df366cde5a838a818f">usbFunctionWrite()
</a> to be called for control-out transfers.
<p>
Set it to 0 if you don't need it and want to save a couple of bytes.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00084">84</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="febecafb2986c559a5d346d601be9de3"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_IMPLEMENT_FN_WRITEOUT"
ref="febecafb2986c559a5d346d601be9de3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_IMPLEMENT_FN_WRITEOUT 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define this to 1 if you want to use interrupt-out (or bulk out) endpoint 1.
<p>
You must implement the function usbFunctionWriteOut() which receives all
interrupt/bulk data sent to endpoint 1.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00095">95</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f2a9b3ecff1707f1b6554a881a87b954"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_IMPLEMENT_HALT" ref="f2a9b3ecff1707f1b6554a881a87b954"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_IMPLEMENT_HALT 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define this to 1 if you also want to implement the ENDPOINT_HALT feature for
endpoint 1 (interrupt endpoint).
<p>
Although you may not need this feature, it is required by the standard. We have
made it a config option because it bloats the code considerably.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00065">65</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="34f6fe9486b66e8220a82a0eb87a7447"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_INTERFACE_CLASS"
ref="34f6fe9486b66e8220a82a0eb87a7447" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_INTERFACE_CLASS 0x03
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
See USB specification if you want to conform to an existing device class or
protocol.
<p>
This is HID class.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00155">155</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8ddab89b764bfd88d024c7d9c9931de3"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_INTERFACE_PROTOCOL"
ref="8ddab89b764bfd88d024c7d9c9931de3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_INTERFACE_PROTOCOL 0x01 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
See USB specification if you want to conform to an existing device class or
protocol.
<p>
This is keyboard protocol.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00163">163</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c643f27afa43062c19b8f0674b6be1b5"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_INTERFACE_SUBCLASS"
ref="c643f27afa43062c19b8f0674b6be1b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_INTERFACE_SUBCLASS 0x01 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
See USB specification if you want to conform to an existing device class or
protocol.
<p>
This is a boot device.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00159">159</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9cccddfefa62f926a0d7bba9f183a4d3"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_INTR_POLL_INTERVAL"
ref="9cccddfefa62f926a0d7bba9f183a4d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define
USB_CFG_INTR_POLL_INTERVAL 10 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If you compile a version with endpoint 1 (interrupt-in), this is the poll interval.
<p>
The value is in milliseconds and must not be less than 10 ms for low speed devices.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00070">70</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="98ed17962b55543b35e10ae1f8ebe09b"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_IOPORTNAME" ref="98ed17962b55543b35e10ae1f8ebe09b"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_IOPORTNAME D
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is the port where the USB bus is connected.
<p>
When you configure it to "B", the registers PORTB, PINB and DDRB will be used.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00024">24</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d5fd70b5fabd8abd34d5b9ef7100b709"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_IS_SELF_POWERED"
ref="d5fd70b5fabd8abd34d5b9ef7100b709" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_IS_SELF_POWERED 0
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define this to 1 if the device has its own power supply.
<p>
Set it to 0 if the device is powered from the USB bus.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00074">74</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="be324d9b00dc186bcbac65ed0f94811c"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_MAX_BUS_POWER" ref="be324d9b00dc186bcbac65ed0f94811c"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_MAX_BUS_POWER 100
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this variable to the maximum USB bus power consumption of your device.
<p>
The value is in milliamperes. [It will be divided by two since USB communicates
power requirements in units of 2 mA.]
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00079">79</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9326b8ec9f809ce66d54349691646930"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_VENDOR_ID" ref="9326b8ec9f809ce66d54349691646930"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_VENDOR_ID 0x42, 0x42
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
We cannot use Obdev's free shared VID/PID pair because this is a HID.
<p>
We use John Hyde's VID (author of the book "USB Design By Example") for this
example instead. John has offered this VID for use by students for non-commercial
devices. Well... This example is for demonstration and education only... DO NOT LET
DEVICES WITH THIS VID ESCAPE YOUR LAB! The Product-ID is a random number.<p>
USB vendor ID for the device, low byte first. If you have registered your own
Vendor ID, define it here. Otherwise you use obdev's free shared VID/PID pair. Be
sure to read USBID-License.txt for rules!
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00115">115</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="25a2baf5c8feb0982a47050423add0ec"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_VENDOR_NAME" ref="25a2baf5c8feb0982a47050423add0ec"
args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_VENDOR_NAME 'w',
'w', 'w', '.', 's', 'c', 'h', 'a', 't', 'e', 'n', 's', 'e', 'i', 't', 'e', '.',
'd', 'e' </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These two values define the vendor name returned by the USB device.
<p>
The name must be given as a list of characters under single quotes. The characters
are interpreted as Unicode (UTF-16) entities. If you don't want a vendor name
string, undefine these macros. ALWAYS define a vendor name containing your Internet
domain name if you use obdev's free shared VID/PID pair. See the file USBID-
License.txt for details.
<p>Definition at line <a class="el" href="firmware_2usbconfig_8h-
source.html#l00134">134</a> of file <a class="el" href="firmware_2usbconfig_8h-
source.html">usbconfig.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3085d820d9dc6e939737a3f1b9a457d7"></a><!-- doxytag:
member="usbconfig.h::USB_CFG_VENDOR_NAME_LEN"
ref="3085d820d9dc6e939737a3f1b9a457d7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USB_CFG_VENDOR_NAME_LEN 19
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Length of USB_CFG_DEVICE_VERSION.
<p>