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