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