Line 1... |
Line 1... |
1 |
/* Name: usbconfig.h |
1 |
/* Name: usbconfig.h |
2 |
* Project: AVR USB driver |
2 |
* Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers |
3 |
* Author: Christian Starkjohann |
3 |
* Author: Christian Starkjohann |
4 |
* Creation Date: 2005-04-01 |
4 |
* Creation Date: 2005-04-01 |
5 |
* Tabsize: 4 |
5 |
* Tabsize: 4 |
6 |
* Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH |
6 |
* Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH |
7 |
* License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) |
7 |
* License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) |
8 |
* This Revision: $Id: usbconfig-prototype.h 275 2007-03-20 09:58:28Z cs $ |
- |
|
9 |
*/ |
8 |
*/ |
10 |
|
9 |
|
11 |
#ifndef __usbconfig_h_included__ |
10 |
#ifndef __usbconfig_h_included__ |
12 |
#define __usbconfig_h_included__ |
11 |
#define __usbconfig_h_included__ |
13 |
|
12 |
|
14 |
/* |
13 |
/* |
15 |
General Description: |
14 |
General Description: |
16 |
This file is an example configuration (with inline documentation) for the USB |
15 |
This file is an example configuration (with inline documentation) for the USB |
17 |
driver. It configures AVR-USB for an ATMega8 with USB D+ connected to Port D |
16 |
driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is |
18 |
bit 2 (which is also hardware interrupt 0) and USB D- to Port D bit 0. You may |
17 |
also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may |
19 |
wire the lines to any other port, as long as D+ is also wired to INT0. |
18 |
wire the lines to any other port, as long as D+ is also wired to INT0 (or any |
- |
|
19 |
other hardware interrupt, as long as it is the highest level interrupt, see |
- |
|
20 |
section at the end of this file). |
20 |
To create your own usbconfig.h file, copy this file to the directory |
21 |
+ To create your own usbconfig.h file, copy this file to your project's |
21 |
containing "usbdrv" (that is your project firmware source directory) and |
22 |
+ firmware source directory) and rename it to "usbconfig.h". |
22 |
rename it to "usbconfig.h". Then edit it accordingly. |
23 |
+ Then edit it accordingly. |
23 |
*/ |
24 |
*/ |
24 |
|
25 |
|
25 |
/* ---------------------------- Hardware Config ---------------------------- */ |
26 |
/* ---------------------------- Hardware Config ---------------------------- */ |
26 |
|
27 |
|
27 |
#define USB_CFG_IOPORTNAME D |
28 |
#define USB_CFG_IOPORTNAME D |
28 |
/* This is the port where the USB bus is connected. When you configure it to |
29 |
/* This is the port where the USB bus is connected. When you configure it to |
29 |
* "B", the registers PORTB, PINB and DDRB will be used. |
30 |
* "B", the registers PORTB, PINB and DDRB will be used. |
30 |
*/ |
31 |
*/ |
31 |
#define USB_CFG_DMINUS_BIT 0 |
32 |
#define USB_CFG_DMINUS_BIT 4 |
32 |
/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected. |
33 |
/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected. |
33 |
* This may be any bit in the port. |
34 |
* This may be any bit in the port. |
34 |
*/ |
35 |
*/ |
35 |
#define USB_CFG_DPLUS_BIT 2 |
36 |
#define USB_CFG_DPLUS_BIT 2 |
36 |
/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected. |
37 |
/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected. |
37 |
* This may be any bit in the port. Please note that D+ must also be connected |
38 |
* This may be any bit in the port. Please note that D+ must also be connected |
- |
|
39 |
* to interrupt pin INT0! [You can also use other interrupts, see section |
- |
|
40 |
* "Optional MCU Description" below, or you can connect D- to the interrupt, as |
- |
|
41 |
* it is required if you use the USB_COUNT_SOF feature. If you use D- for the |
- |
|
42 |
* interrupt, the USB interrupt will also be triggered at Start-Of-Frame |
- |
|
43 |
* markers every millisecond.] |
- |
|
44 |
*/ |
- |
|
45 |
#define USB_CFG_CLOCK_KHZ (F_CPU/1000) |
- |
|
46 |
/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000, |
- |
|
47 |
* 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code |
- |
|
48 |
* require no crystal, they tolerate +/- 1% deviation from the nominal |
- |
|
49 |
* frequency. All other rates require a precision of 2000 ppm and thus a |
- |
|
50 |
* crystal! |
- |
|
51 |
* Since F_CPU should be defined to your actual clock rate anyway, you should |
38 |
* to interrupt pin INT0! |
52 |
* not need to modify this setting. |
- |
|
53 |
*/ |
- |
|
54 |
#define USB_CFG_CHECK_CRC 0 |
- |
|
55 |
/* Define this to 1 if you want that the driver checks integrity of incoming |
- |
|
56 |
* data packets (CRC checks). CRC checks cost quite a bit of code size and are |
- |
|
57 |
* currently only available for 18 MHz crystal clock. You must choose |
- |
|
58 |
* USB_CFG_CLOCK_KHZ = 18000 if you enable this option. |
39 |
*/ |
59 |
*/ |
40 |
|
60 |
|
41 |
/* ----------------------- Optional Hardware Config ------------------------ */ |
61 |
/* ----------------------- Optional Hardware Config ------------------------ */ |
42 |
|
62 |
|
43 |
/* #define USB_CFG_PULLUP_IOPORTNAME D */ |
63 |
/* #define USB_CFG_PULLUP_IOPORTNAME D */ |
Line 52... |
Line 72... |
52 |
* above for details. |
72 |
* above for details. |
53 |
*/ |
73 |
*/ |
54 |
|
74 |
|
55 |
/* --------------------------- Functional Range ---------------------------- */ |
75 |
/* --------------------------- Functional Range ---------------------------- */ |
56 |
|
76 |
|
57 |
#define USB_CFG_HAVE_INTRIN_ENDPOINT 1 |
77 |
#define USB_CFG_HAVE_INTRIN_ENDPOINT 0 |
58 |
/* Define this to 1 if you want to compile a version with two endpoints: The |
78 |
/* Define this to 1 if you want to compile a version with two endpoints: The |
59 |
* default control endpoint 0 and an interrupt-in endpoint 1. |
79 |
* default control endpoint 0 and an interrupt-in endpoint (any other endpoint |
- |
|
80 |
* number). |
60 |
*/ |
81 |
*/ |
61 |
#define USB_CFG_HAVE_INTRIN_ENDPOINT3 0 |
82 |
#define USB_CFG_HAVE_INTRIN_ENDPOINT3 0 |
62 |
/* Define this to 1 if you want to compile a version with three endpoints: The |
83 |
/* Define this to 1 if you want to compile a version with three endpoints: The |
63 |
* default control endpoint 0, an interrupt-in endpoint 1 and an interrupt-in |
84 |
* default control endpoint 0, an interrupt-in endpoint 3 (or the number |
64 |
* endpoint 3. You must also enable endpoint 1 above. |
85 |
* configured below) and a catch-all default interrupt-in endpoint as above. |
- |
|
86 |
* You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature. |
- |
|
87 |
*/ |
- |
|
88 |
#define USB_CFG_EP3_NUMBER 3 |
- |
|
89 |
/* If the so-called endpoint 3 is used, it can now be configured to any other |
- |
|
90 |
* endpoint number (except 0) with this macro. Default if undefined is 3. |
- |
|
91 |
*/ |
- |
|
92 |
/* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */ |
- |
|
93 |
/* The above macro defines the startup condition for data toggling on the |
- |
|
94 |
* interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1. |
- |
|
95 |
* Since the token is toggled BEFORE sending any data, the first packet is |
- |
|
96 |
* sent with the oposite value of this configuration! |
65 |
*/ |
97 |
*/ |
66 |
#define USB_CFG_IMPLEMENT_HALT 0 |
98 |
#define USB_CFG_IMPLEMENT_HALT 0 |
67 |
/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature |
99 |
/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature |
68 |
* for endpoint 1 (interrupt endpoint). Although you may not need this feature, |
100 |
* for endpoint 1 (interrupt endpoint). Although you may not need this feature, |
69 |
* it is required by the standard. We have made it a config option because it |
101 |
* it is required by the standard. We have made it a config option because it |
70 |
* bloats the code considerably. |
102 |
* bloats the code considerably. |
71 |
*/ |
103 |
*/ |
- |
|
104 |
#define USB_CFG_SUPPRESS_INTR_CODE 0 |
- |
|
105 |
/* Define this to 1 if you want to declare interrupt-in endpoints, but don't |
- |
|
106 |
* want to send any data over them. If this macro is defined to 1, functions |
- |
|
107 |
* usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if |
- |
|
108 |
* you need the interrupt-in endpoints in order to comply to an interface |
- |
|
109 |
* (e.g. HID), but never want to send any data. This option saves a couple |
- |
|
110 |
* of bytes in flash memory and the transmit buffers in RAM. |
- |
|
111 |
*/ |
72 |
#define USB_CFG_INTR_POLL_INTERVAL 20 |
112 |
#define USB_CFG_INTR_POLL_INTERVAL 10 |
73 |
/* If you compile a version with endpoint 1 (interrupt-in), this is the poll |
113 |
/* If you compile a version with endpoint 1 (interrupt-in), this is the poll |
74 |
* interval. The value is in milliseconds and must not be less than 10 ms for |
114 |
* interval. The value is in milliseconds and must not be less than 10 ms for |
75 |
* low speed devices. |
115 |
* low speed devices. |
76 |
*/ |
116 |
*/ |
77 |
#define USB_CFG_IS_SELF_POWERED 0 |
117 |
#define USB_CFG_IS_SELF_POWERED 0 |
Line 93... |
Line 133... |
93 |
* "on the fly" when usbFunctionRead() is called. If you only want to send |
133 |
* "on the fly" when usbFunctionRead() is called. If you only want to send |
94 |
* data from a static buffer, set it to 0 and return the data from |
134 |
* data from a static buffer, set it to 0 and return the data from |
95 |
* usbFunctionSetup(). This saves a couple of bytes. |
135 |
* usbFunctionSetup(). This saves a couple of bytes. |
96 |
*/ |
136 |
*/ |
97 |
#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 |
137 |
#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 |
98 |
/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoint 1. |
138 |
/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints. |
99 |
* You must implement the function usbFunctionWriteOut() which receives all |
139 |
* You must implement the function usbFunctionWriteOut() which receives all |
100 |
* interrupt/bulk data sent to endpoint 1. |
140 |
* interrupt/bulk data sent to any endpoint other than 0. The endpoint number |
- |
|
141 |
* can be found in 'usbRxToken'. |
101 |
*/ |
142 |
*/ |
102 |
#define USB_CFG_HAVE_FLOWCONTROL 0 |
143 |
#define USB_CFG_HAVE_FLOWCONTROL 0 |
103 |
/* Define this to 1 if you want flowcontrol over USB data. See the definition |
144 |
/* Define this to 1 if you want flowcontrol over USB data. See the definition |
104 |
* of the macros usbDisableAllRequests() and usbEnableAllRequests() in |
145 |
* of the macros usbDisableAllRequests() and usbEnableAllRequests() in |
105 |
* usbdrv.h. |
146 |
* usbdrv.h. |
106 |
*/ |
147 |
*/ |
- |
|
148 |
#define USB_CFG_DRIVER_FLASH_PAGE 0 |
- |
|
149 |
/* If the device has more than 64 kBytes of flash, define this to the 64 k page |
- |
|
150 |
* where the driver's constants (descriptors) are located. Or in other words: |
- |
|
151 |
* Define this to 1 for boot loaders on the ATMega128. |
- |
|
152 |
*/ |
- |
|
153 |
#define USB_CFG_LONG_TRANSFERS 0 |
- |
|
154 |
/* Define this to 1 if you want to send/receive blocks of more than 254 bytes |
- |
|
155 |
* in a single control-in or control-out transfer. Note that the capability |
- |
|
156 |
* for long transfers increases the driver size. |
- |
|
157 |
*/ |
- |
|
158 |
/* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */ |
- |
|
159 |
/* This macro is a hook if you want to do unconventional things. If it is |
- |
|
160 |
* defined, it's inserted at the beginning of received message processing. |
- |
|
161 |
* If you eat the received message and don't want default processing to |
- |
|
162 |
* proceed, do a return after doing your things. One possible application |
- |
|
163 |
* (besides debugging) is to flash a status LED on each packet. |
- |
|
164 |
*/ |
- |
|
165 |
/* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */ |
- |
|
166 |
/* This macro is a hook if you need to know when an USB RESET occurs. It has |
- |
|
167 |
* one parameter which distinguishes between the start of RESET state and its |
- |
|
168 |
* end. |
- |
|
169 |
*/ |
- |
|
170 |
/* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */ |
- |
|
171 |
/* This macro (if defined) is executed when a USB SET_ADDRESS request was |
- |
|
172 |
* received. |
- |
|
173 |
*/ |
- |
|
174 |
#define USB_COUNT_SOF 0 |
- |
|
175 |
/* define this macro to 1 if you need the global variable "usbSofCount" which |
- |
|
176 |
* counts SOF packets. This feature requires that the hardware interrupt is |
- |
|
177 |
* connected to D- instead of D+. |
- |
|
178 |
*/ |
- |
|
179 |
/* #ifdef __ASSEMBLER__ |
- |
|
180 |
* macro myAssemblerMacro |
- |
|
181 |
* in YL, TCNT0 |
- |
|
182 |
* sts timer0Snapshot, YL |
- |
|
183 |
* endm |
- |
|
184 |
* #endif |
- |
|
185 |
* #define USB_SOF_HOOK myAssemblerMacro |
- |
|
186 |
* This macro (if defined) is executed in the assembler module when a |
- |
|
187 |
* Start Of Frame condition is detected. It is recommended to define it to |
- |
|
188 |
* the name of an assembler macro which is defined here as well so that more |
- |
|
189 |
* than one assembler instruction can be used. The macro may use the register |
- |
|
190 |
* YL and modify SREG. If it lasts longer than a couple of cycles, USB messages |
- |
|
191 |
* immediately after an SOF pulse may be lost and must be retried by the host. |
- |
|
192 |
* What can you do with this hook? Since the SOF signal occurs exactly every |
- |
|
193 |
* 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in |
- |
|
194 |
* designs running on the internal RC oscillator. |
- |
|
195 |
* Please note that Start Of Frame detection works only if D- is wired to the |
- |
|
196 |
* interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES! |
- |
|
197 |
*/ |
- |
|
198 |
#define USB_CFG_CHECK_DATA_TOGGLING 0 |
- |
|
199 |
/* define this macro to 1 if you want to filter out duplicate data packets |
- |
|
200 |
* sent by the host. Duplicates occur only as a consequence of communication |
- |
|
201 |
* errors, when the host does not receive an ACK. Please note that you need to |
- |
|
202 |
* implement the filtering yourself in usbFunctionWriteOut() and |
- |
|
203 |
* usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable |
- |
|
204 |
* for each control- and out-endpoint to check for duplicate packets. |
- |
|
205 |
*/ |
- |
|
206 |
#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0 |
- |
|
207 |
/* define this macro to 1 if you want the function usbMeasureFrameLength() |
- |
|
208 |
* compiled in. This function can be used to calibrate the AVR's RC oscillator. |
- |
|
209 |
*/ |
- |
|
210 |
#define USB_USE_FAST_CRC 0 |
- |
|
211 |
/* The assembler module has two implementations for the CRC algorithm. One is |
- |
|
212 |
* faster, the other is smaller. This CRC routine is only used for transmitted |
- |
|
213 |
* messages where timing is not critical. The faster routine needs 31 cycles |
- |
|
214 |
* per byte while the smaller one needs 61 to 69 cycles. The faster routine |
- |
|
215 |
* may be worth the 32 bytes bigger code size if you transmit lots of data and |
- |
|
216 |
* run the AVR close to its limit. |
- |
|
217 |
*/ |
107 |
|
218 |
|
108 |
/* -------------------------- Device Description --------------------------- */ |
219 |
/* -------------------------- Device Description --------------------------- */ |
109 |
|
220 |
|
110 |
#define USB_CFG_VENDOR_ID 0xc0, 0x16 |
221 |
#define USB_CFG_VENDOR_ID 0xc0, 0x16 /* = 0x16c0 = 5824 = voti.nl */ |
111 |
/* USB vendor ID for the device, low byte first. If you have registered your |
222 |
/* USB vendor ID for the device, low byte first. If you have registered your |
112 |
* own Vendor ID, define it here. Otherwise you use obdev's free shared |
223 |
* own Vendor ID, define it here. Otherwise you may use one of obdev's free |
113 |
* VID/PID pair. Be sure to read USBID-License.txt for rules! |
224 |
* shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules! |
- |
|
225 |
* *** IMPORTANT NOTE *** |
114 |
* This template uses obdev's shared VID/PID pair for HIDs: 0x16c0/0x5df. |
226 |
* This template uses obdev's shared VID/PID pair for Vendor Class devices |
115 |
* Use this VID/PID pair ONLY if you understand the implications! |
227 |
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand |
- |
|
228 |
* the implications! |
116 |
*/ |
229 |
*/ |
117 |
#define USB_CFG_DEVICE_ID 0xdf, 0x05 |
230 |
#define USB_CFG_DEVICE_ID 0xdc, 0x05 /* = 0x05dc = 1500 */ |
118 |
/* This is the ID of the product, low byte first. It is interpreted in the |
231 |
/* This is the ID of the product, low byte first. It is interpreted in the |
119 |
* scope of the vendor ID. If you have registered your own VID with usb.org |
232 |
* scope of the vendor ID. If you have registered your own VID with usb.org |
120 |
* or if you have licensed a PID from somebody else, define it here. Otherwise |
233 |
* or if you have licensed a PID from somebody else, define it here. Otherwise |
121 |
* you use obdev's free shared VID/PID pair. Be sure to read the rules in |
234 |
* you may use one of obdev's free shared VID/PID pairs. See the file |
122 |
* USBID-License.txt! |
235 |
* USB-IDs-for-free.txt for details! |
- |
|
236 |
* *** IMPORTANT NOTE *** |
123 |
* This template uses obdev's shared VID/PID pair for HIDs: 0x16c0/0x5df. |
237 |
* This template uses obdev's shared VID/PID pair for Vendor Class devices |
124 |
* Use this VID/PID pair ONLY if you understand the implications! |
238 |
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand |
- |
|
239 |
* the implications! |
125 |
*/ |
240 |
*/ |
126 |
#define USB_CFG_DEVICE_VERSION 0x00, 0x01 |
241 |
#define USB_CFG_DEVICE_VERSION 0x00, 0x01 |
127 |
/* Version number of the device: Minor number first, then major number. |
242 |
/* Version number of the device: Minor number first, then major number. |
128 |
*/ |
243 |
*/ |
129 |
#define USB_CFG_VENDOR_NAME 'w', 'w', 'w', '.', 'o', 'b', 'd', 'e', 'v', '.', 'a', 't' |
244 |
#define USB_CFG_VENDOR_NAME 'o', 'b', 'd', 'e', 'v', '.', 'a', 't' |
130 |
#define USB_CFG_VENDOR_NAME_LEN 12 |
245 |
#define USB_CFG_VENDOR_NAME_LEN 8 |
131 |
/* These two values define the vendor name returned by the USB device. The name |
246 |
/* These two values define the vendor name returned by the USB device. The name |
132 |
* must be given as a list of characters under single quotes. The characters |
247 |
* must be given as a list of characters under single quotes. The characters |
133 |
* are interpreted as Unicode (UTF-16) entities. |
248 |
* are interpreted as Unicode (UTF-16) entities. |
134 |
* If you don't want a vendor name string, undefine these macros. |
249 |
* If you don't want a vendor name string, undefine these macros. |
135 |
* ALWAYS define a vendor name containing your Internet domain name if you use |
250 |
* ALWAYS define a vendor name containing your Internet domain name if you use |
136 |
* obdev's free shared VID/PID pair. See the file USBID-License.txt for |
251 |
* obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for |
137 |
* details. |
252 |
* details. |
138 |
*/ |
253 |
*/ |
139 |
#define USB_CFG_DEVICE_NAME 'T', 'e', 'm', 'p', 'l', 'a', 't', 'e' |
254 |
#define USB_CFG_DEVICE_NAME 'T', 'e', 'm', 'p', 'l', 'a', 't', 'e' |
140 |
#define USB_CFG_DEVICE_NAME_LEN 8 |
255 |
#define USB_CFG_DEVICE_NAME_LEN 8 |
141 |
/* Same as above for the device name. If you don't want a device name, undefine |
256 |
/* Same as above for the device name. If you don't want a device name, undefine |
142 |
* the macros. See the file USBID-License.txt before you assign a name if you |
257 |
* the macros. See the file USB-IDs-for-free.txt before you assign a name if |
143 |
* use a shared VID/PID. |
258 |
* you use a shared VID/PID. |
144 |
*/ |
259 |
*/ |
145 |
/*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */ |
260 |
/*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */ |
146 |
/*#define USB_CFG_SERIAL_NUMBER_LEN 0 */ |
261 |
/*#define USB_CFG_SERIAL_NUMBER_LEN 0 */ |
147 |
/* Same as above for the serial number. If you don't want a serial number, |
262 |
/* Same as above for the serial number. If you don't want a serial number, |
148 |
* undefine the macros. |
263 |
* undefine the macros. |
149 |
* It may be useful to provide the serial number through other means than at |
264 |
* It may be useful to provide the serial number through other means than at |
150 |
* compile time. See the section about descriptor properties below for how |
265 |
* compile time. See the section about descriptor properties below for how |
151 |
* to fine tune control over USB descriptors such as the string descriptor |
266 |
* to fine tune control over USB descriptors such as the string descriptor |
152 |
* for the serial number. |
267 |
* for the serial number. |
153 |
*/ |
268 |
*/ |
154 |
#define USB_CFG_DEVICE_CLASS 0 |
269 |
#define USB_CFG_DEVICE_CLASS 0xff /* set to 0 if deferred to interface */ |
155 |
#define USB_CFG_DEVICE_SUBCLASS 0 |
270 |
#define USB_CFG_DEVICE_SUBCLASS 0 |
156 |
/* See USB specification if you want to conform to an existing device class. |
271 |
/* See USB specification if you want to conform to an existing device class. |
- |
|
272 |
* Class 0xff is "vendor specific". |
157 |
*/ |
273 |
*/ |
158 |
#define USB_CFG_INTERFACE_CLASS 3 /* HID */ |
274 |
#define USB_CFG_INTERFACE_CLASS 0 /* define class here if not at device level */ |
159 |
#define USB_CFG_INTERFACE_SUBCLASS 0 |
275 |
#define USB_CFG_INTERFACE_SUBCLASS 0 |
160 |
#define USB_CFG_INTERFACE_PROTOCOL 0 |
276 |
#define USB_CFG_INTERFACE_PROTOCOL 0 |
161 |
/* See USB specification if you want to conform to an existing device class or |
277 |
/* See USB specification if you want to conform to an existing device class or |
162 |
* protocol. |
278 |
* protocol. The following classes must be set at interface level: |
163 |
* This template defines a HID class device. If you implement a vendor class |
279 |
* HID class is 3, no subclass and protocol required (but may be useful!) |
164 |
* device, set USB_CFG_INTERFACE_CLASS to 0 and USB_CFG_DEVICE_CLASS to 0xff. |
280 |
* CDC class is 2, use subclass 2 and protocol 1 for ACM |
165 |
*/ |
281 |
*/ |
166 |
#define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 42 /* total length of report descriptor */ |
282 |
/* #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 42 */ |
167 |
/* Define this to the length of the HID report descriptor, if you implement |
283 |
/* Define this to the length of the HID report descriptor, if you implement |
168 |
* an HID device. Otherwise don't define it or define it to 0. |
284 |
* an HID device. Otherwise don't define it or define it to 0. |
169 |
* Since this template defines a HID device, it must also specify a HID |
- |
|
170 |
* report descriptor length. You must add a PROGMEM character array named |
285 |
* If you use this define, you must add a PROGMEM character array named |
171 |
* "usbHidReportDescriptor" to your code which contains the report descriptor. |
286 |
* "usbHidReportDescriptor" to your code which contains the report descriptor. |
172 |
* Don't forget to keep the array and this define in sync! |
287 |
* Don't forget to keep the array and this define in sync! |
173 |
*/ |
288 |
*/ |
174 |
|
289 |
|
- |
|
290 |
/* #define USB_PUBLIC static */ |
- |
|
291 |
/* Use the define above if you #include usbdrv.c instead of linking against it. |
- |
|
292 |
* This technique saves a couple of bytes in flash memory. |
- |
|
293 |
*/ |
- |
|
294 |
|
175 |
/* ------------------- Fine Control over USB Descriptors ------------------- */ |
295 |
/* ------------------- Fine Control over USB Descriptors ------------------- */ |
176 |
/* If you don't want to use the driver's default USB descriptors, you can |
296 |
/* If you don't want to use the driver's default USB descriptors, you can |
177 |
* provide our own. These can be provided as (1) fixed length static data in |
297 |
* provide our own. These can be provided as (1) fixed length static data in |
178 |
* flash memory, (2) fixed length static data in RAM or (3) dynamically at |
298 |
* flash memory, (2) fixed length static data in RAM or (3) dynamically at |
179 |
* runtime in the function usbFunctionDescriptor(). See usbdrv.h for more |
299 |
* runtime in the function usbFunctionDescriptor(). See usbdrv.h for more |
180 |
* information about this function. |
300 |
* information about this function. |
181 |
* Descriptor handling is configured through the descriptor's properties. If |
301 |
* Descriptor handling is configured through the descriptor's properties. If |
182 |
* no properties are defined or if they are 0, the default descriptor is used. |
302 |
* no properties are defined or if they are 0, the default descriptor is used. |
183 |
* Possible properties are: |
303 |
* Possible properties are: |
184 |
* + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched |
304 |
* + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched |
185 |
* at runtime via usbFunctionDescriptor(). |
305 |
* at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is |
- |
|
306 |
* used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if |
- |
|
307 |
* you want RAM pointers. |
186 |
* + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found |
308 |
* + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found |
187 |
* in static memory is in RAM, not in flash memory. |
309 |
* in static memory is in RAM, not in flash memory. |
188 |
* + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), |
310 |
* + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), |
189 |
* the driver must know the descriptor's length. The descriptor itself is |
311 |
* the driver must know the descriptor's length. The descriptor itself is |
190 |
* found at the address of a well known identifier (see below). |
312 |
* found at the address of a well known identifier (see below). |
Line 212... |
Line 334... |
212 |
* USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER |
334 |
* USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER |
213 |
* USB_CFG_DESCR_PROPS_HID |
335 |
* USB_CFG_DESCR_PROPS_HID |
214 |
* USB_CFG_DESCR_PROPS_HID_REPORT |
336 |
* USB_CFG_DESCR_PROPS_HID_REPORT |
215 |
* USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) |
337 |
* USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) |
216 |
* |
338 |
* |
- |
|
339 |
* Note about string descriptors: String descriptors are not just strings, they |
- |
|
340 |
* are Unicode strings prefixed with a 2 byte header. Example: |
- |
|
341 |
* int serialNumberDescriptor[] = { |
- |
|
342 |
* USB_STRING_DESCRIPTOR_HEADER(6), |
- |
|
343 |
* 'S', 'e', 'r', 'i', 'a', 'l' |
- |
|
344 |
* }; |
217 |
*/ |
345 |
*/ |
218 |
|
346 |
|
219 |
#define USB_CFG_DESCR_PROPS_DEVICE 0 |
347 |
#define USB_CFG_DESCR_PROPS_DEVICE 0 |
220 |
#define USB_CFG_DESCR_PROPS_CONFIGURATION 0 |
348 |
#define USB_CFG_DESCR_PROPS_CONFIGURATION 0 |
221 |
#define USB_CFG_DESCR_PROPS_STRINGS 0 |
349 |
#define USB_CFG_DESCR_PROPS_STRINGS 0 |
Line 225... |
Line 353... |
225 |
#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 |
353 |
#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 |
226 |
#define USB_CFG_DESCR_PROPS_HID 0 |
354 |
#define USB_CFG_DESCR_PROPS_HID 0 |
227 |
#define USB_CFG_DESCR_PROPS_HID_REPORT 0 |
355 |
#define USB_CFG_DESCR_PROPS_HID_REPORT 0 |
228 |
#define USB_CFG_DESCR_PROPS_UNKNOWN 0 |
356 |
#define USB_CFG_DESCR_PROPS_UNKNOWN 0 |
229 |
|
357 |
|
- |
|
358 |
|
- |
|
359 |
#define usbMsgPtr_t unsigned short |
- |
|
360 |
/* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to |
- |
|
361 |
* a scalar type here because gcc generates slightly shorter code for scalar |
- |
|
362 |
* arithmetics than for pointer arithmetics. Remove this define for backward |
- |
|
363 |
* type compatibility or define it to an 8 bit type if you use data in RAM only |
- |
|
364 |
* and all RAM is below 256 bytes (tiny memory model in IAR CC). |
- |
|
365 |
*/ |
- |
|
366 |
|
230 |
/* ----------------------- Optional MCU Description ------------------------ */ |
367 |
/* ----------------------- Optional MCU Description ------------------------ */ |
231 |
|
368 |
|
232 |
/* The following configurations have working defaults in usbdrv.h. You |
369 |
/* The following configurations have working defaults in usbdrv.h. You |
233 |
* usually don't need to set them explicitly. Only if you want to run |
370 |
* usually don't need to set them explicitly. Only if you want to run |
234 |
* the driver on a device which is not yet supported or with a compiler |
371 |
* the driver on a device which is not yet supported or with a compiler |
Line 240... |
Line 377... |
240 |
/* #define USB_INTR_CFG_CLR 0 */ |
377 |
/* #define USB_INTR_CFG_CLR 0 */ |
241 |
/* #define USB_INTR_ENABLE GIMSK */ |
378 |
/* #define USB_INTR_ENABLE GIMSK */ |
242 |
/* #define USB_INTR_ENABLE_BIT INT0 */ |
379 |
/* #define USB_INTR_ENABLE_BIT INT0 */ |
243 |
/* #define USB_INTR_PENDING GIFR */ |
380 |
/* #define USB_INTR_PENDING GIFR */ |
244 |
/* #define USB_INTR_PENDING_BIT INTF0 */ |
381 |
/* #define USB_INTR_PENDING_BIT INTF0 */ |
- |
|
382 |
/* #define USB_INTR_VECTOR INT0_vect */ |
245 |
|
383 |
|
246 |
#endif /* __usbconfig_h_included__ */ |
384 |
#endif /* __usbconfig_h_included__ */ |