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