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