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