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