1  | /* Name: usbconfig.h
  | 
2  |  * Project: AVR USB driver
  | 
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) or proprietary (CommercialLicense.txt)
  | 
8  |  * This Revision: $Id: usbconfig-prototype.h 600 2008-05-13 10:34:56Z 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 AVR-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       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       (16000)
  | 
47  | /* Clock rate of the AVR in MHz. Legal values are 12000, 15000, 16000, 16500
  | 
48  |  * and 20000. The 16.5 MHz version of the code requires no crystal, it
  | 
49  |  * tolerates +/- 1% deviation from the nominal frequency. All other rates
  | 
50  |  * require a precision of 2000 ppm and thus a crystal!
  | 
51  |  * Default if not specified: 12 MHz
  | 
52  |  */
  | 
53  | 
  | 
54  | /* ----------------------- Optional Hardware Config ------------------------ */
  | 
55  | 
  | 
56  | /* #define USB_CFG_PULLUP_IOPORTNAME   D */
  | 
57  | /* If you connect the 1.5k pullup resistor from D- to a port pin instead of
  | 
58  |  * V+, you can connect and disconnect the device from firmware by calling
  | 
59  |  * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
  | 
60  |  * This constant defines the port on which the pullup resistor is connected.
  | 
61  |  */
  | 
62  | /* #define USB_CFG_PULLUP_BIT          4 */
  | 
63  | /* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
  | 
64  |  * above) where the 1.5k pullup resistor is connected. See description
  | 
65  |  * above for details.
  | 
66  |  */
  | 
67  | 
  | 
68  | /* --------------------------- Functional Range ---------------------------- */
  | 
69  | 
  | 
70  | #define USB_CFG_HAVE_INTRIN_ENDPOINT    0
  | 
71  | /* Define this to 1 if you want to compile a version with two endpoints: The
  | 
72  |  * default control endpoint 0 and an interrupt-in endpoint (any other endpoint
  | 
73  |  * number).
  | 
74  |  */
  | 
75  | #define USB_CFG_HAVE_INTRIN_ENDPOINT3   0
  | 
76  | /* Define this to 1 if you want to compile a version with three endpoints: The
  | 
77  |  * default control endpoint 0, an interrupt-in endpoint 3 (or the number
  | 
78  |  * configured below) and a catch-all default interrupt-in endpoint as above.
  | 
79  |  * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
  | 
80  |  */
  | 
81  | #define USB_CFG_EP3_NUMBER              3
  | 
82  | /* If the so-called endpoint 3 is used, it can now be configured to any other
  | 
83  |  * endpoint number (except 0) with this macro. Default if undefined is 3.
  | 
84  |  */
  | 
85  | /* #define USB_INITIAL_DATATOKEN           USBPID_DATA1 */
  | 
86  | /* The above macro defines the startup condition for data toggling on the
  | 
87  |  * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
  | 
88  |  * Since the token is toggled BEFORE sending any data, the first packet is
  | 
89  |  * sent with the oposite value of this configuration!
  | 
90  |  */
  | 
91  | #define USB_CFG_IMPLEMENT_HALT          0
  | 
92  | /* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
  | 
93  |  * for endpoint 1 (interrupt endpoint). Although you may not need this feature,
  | 
94  |  * it is required by the standard. We have made it a config option because it
  | 
95  |  * bloats the code considerably.
  | 
96  |  */
  | 
97  | #define USB_CFG_INTR_POLL_INTERVAL      10
  | 
98  | /* If you compile a version with endpoint 1 (interrupt-in), this is the poll
  | 
99  |  * interval. The value is in milliseconds and must not be less than 10 ms for
  | 
100  |  * low speed devices.
  | 
101  |  */
  | 
102  | #define USB_CFG_IS_SELF_POWERED         0
  | 
103  | /* Define this to 1 if the device has its own power supply. Set it to 0 if the
  | 
104  |  * device is powered from the USB bus.
  | 
105  |  */
  | 
106  | #define USB_CFG_MAX_BUS_POWER           100
  | 
107  | /* Set this variable to the maximum USB bus power consumption of your device.
  | 
108  |  * The value is in milliamperes. [It will be divided by two since USB
  | 
109  |  * communicates power requirements in units of 2 mA.]
  | 
110  |  */
  | 
111  | #define USB_CFG_IMPLEMENT_FN_WRITE      1
  | 
112  | /* Set this to 1 if you want usbFunctionWrite() to be called for control-out
  | 
113  |  * transfers. Set it to 0 if you don't need it and want to save a couple of
  | 
114  |  * bytes.
  | 
115  |  */
  | 
116  | #define USB_CFG_IMPLEMENT_FN_READ       0
  | 
117  | /* Set this to 1 if you need to send control replies which are generated
  | 
118  |  * "on the fly" when usbFunctionRead() is called. If you only want to send
  | 
119  |  * data from a static buffer, set it to 0 and return the data from
  | 
120  |  * usbFunctionSetup(). This saves a couple of bytes.
  | 
121  |  */
  | 
122  | #define USB_CFG_IMPLEMENT_FN_WRITEOUT   0
  | 
123  | /* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
  | 
124  |  * You must implement the function usbFunctionWriteOut() which receives all
  | 
125  |  * interrupt/bulk data sent to any endpoint other than 0. The endpoint number
  | 
126  |  * can be found in 'usbRxToken'.
  | 
127  |  */
  | 
128  | #define USB_CFG_HAVE_FLOWCONTROL        0
  | 
129  | /* Define this to 1 if you want flowcontrol over USB data. See the definition
  | 
130  |  * of the macros usbDisableAllRequests() and usbEnableAllRequests() in
  | 
131  |  * usbdrv.h.
  | 
132  |  */
  | 
133  | #define USB_CFG_LONG_TRANSFERS          0
  | 
134  | /* Define this to 1 if you want to send/receive blocks of more than 254 bytes
  | 
135  |  * in a single control-in or control-out transfer. Note that the capability
  | 
136  |  * for long transfers increases the driver size.
  | 
137  |  */
  | 
138  | /* #define USB_RX_USER_HOOK(data, len)     if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
  | 
139  | /* This macro is a hook if you want to do unconventional things. If it is
  | 
140  |  * defined, it's inserted at the beginning of received message processing.
  | 
141  |  * If you eat the received message and don't want default processing to
  | 
142  |  * proceed, do a return after doing your things. One possible application
  | 
143  |  * (besides debugging) is to flash a status LED on each packet.
  | 
144  |  */
  | 
145  | /* #define USB_RESET_HOOK(resetStarts)     if(!resetStarts){hadUsbReset();} */
 | 
146  | /* This macro is a hook if you need to know when an USB RESET occurs. It has
  | 
147  |  * one parameter which distinguishes between the start of RESET state and its
  | 
148  |  * end.
  | 
149  |  */
  | 
150  | /* #define USB_SET_ADDRESS_HOOK()              hadAddressAssigned(); */
  | 
151  | /* This macro (if defined) is executed when a USB SET_ADDRESS request was
  | 
152  |  * received.
  | 
153  |  */
  | 
154  | #define USB_COUNT_SOF                   0
  | 
155  | /* define this macro to 1 if you need the global variable "usbSofCount" which
  | 
156  |  * counts SOF packets. This feature requires that the hardware interrupt is
  | 
157  |  * connected to D- instead of D+.
  | 
158  |  */
  | 
159  | #define USB_CFG_HAVE_MEASURE_FRAME_LENGTH   0
  | 
160  | /* define this macro to 1 if you want the function usbMeasureFrameLength()
  | 
161  |  * compiled in. This function can be used to calibrate the AVR's RC oscillator.
  | 
162  |  */
  | 
163  | 
  | 
164  | /* -------------------------- Device Description --------------------------- */
  | 
165  | 
  | 
166  | #define  USB_CFG_VENDOR_ID       0xc0, 0x16
  | 
167  | /* USB vendor ID for the device, low byte first. If you have registered your
  | 
168  |  * own Vendor ID, define it here. Otherwise you use one of obdev's free shared
  | 
169  |  * VID/PID pairs. Be sure to read USBID-License.txt for rules!
  | 
170  |  * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc.
  | 
171  |  * + Use this VID/PID pair ONLY if you understand the implications!
  | 
172  |  */
  | 
173  | #define  USB_CFG_DEVICE_ID       0xdc, 0x05
  | 
174  | /* This is the ID of the product, low byte first. It is interpreted in the
  | 
175  |  * scope of the vendor ID. If you have registered your own VID with usb.org
  | 
176  |  * or if you have licensed a PID from somebody else, define it here. Otherwise
  | 
177  |  * you use obdev's free shared VID/PID pair. Be sure to read the rules in
  | 
178  |  * USBID-License.txt!
  | 
179  |  * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc.
  | 
180  |  * + Use this VID/PID pair ONLY if you understand the implications!
  | 
181  |  */
  | 
182  | #define USB_CFG_DEVICE_VERSION  0x00, 0x01
  | 
183  | /* Version number of the device: Minor number first, then major number.
  | 
184  |  */
  | 
185  | #define USB_CFG_VENDOR_NAME     'o', 'b', 'd', 'e', 'v', '.', 'a', 't'
  | 
186  | #define USB_CFG_VENDOR_NAME_LEN 8
  | 
187  | /* These two values define the vendor name returned by the USB device. The name
  | 
188  |  * must be given as a list of characters under single quotes. The characters
  | 
189  |  * are interpreted as Unicode (UTF-16) entities.
  | 
190  |  * If you don't want a vendor name string, undefine these macros.
  | 
191  |  * ALWAYS define a vendor name containing your Internet domain name if you use
  | 
192  |  * obdev's free shared VID/PID pair. See the file USBID-License.txt for
  | 
193  |  * details.
  | 
194  |  */
  | 
195  | #define USB_CFG_DEVICE_NAME     'T', 'e', 'm', 'p', 'l', 'a', 't', 'e'
  | 
196  | #define USB_CFG_DEVICE_NAME_LEN 8
  | 
197  | /* Same as above for the device name. If you don't want a device name, undefine
  | 
198  |  * the macros. See the file USBID-License.txt before you assign a name if you
  | 
199  |  * use a shared VID/PID.
  | 
200  |  */
  | 
201  | /*#define USB_CFG_SERIAL_NUMBER   'N', 'o', 'n', 'e' */
  | 
202  | /*#define USB_CFG_SERIAL_NUMBER_LEN   0 */
  | 
203  | /* Same as above for the serial number. If you don't want a serial number,
  | 
204  |  * undefine the macros.
  | 
205  |  * It may be useful to provide the serial number through other means than at
  | 
206  |  * compile time. See the section about descriptor properties below for how
  | 
207  |  * to fine tune control over USB descriptors such as the string descriptor
  | 
208  |  * for the serial number.
  | 
209  |  */
  | 
210  | #define USB_CFG_DEVICE_CLASS        0xff    /* set to 0 if deferred to interface */
  | 
211  | #define USB_CFG_DEVICE_SUBCLASS     0
  | 
212  | /* See USB specification if you want to conform to an existing device class.
  | 
213  |  * Class 0xff is "vendor specific".
  | 
214  |  */
  | 
215  | #define USB_CFG_INTERFACE_CLASS     0   /* define class here if not at device level */
  | 
216  | #define USB_CFG_INTERFACE_SUBCLASS  0
  | 
217  | #define USB_CFG_INTERFACE_PROTOCOL  0
  | 
218  | /* See USB specification if you want to conform to an existing device class or
  | 
219  |  * protocol. The following classes must be set at interface level:
  | 
220  |  * HID class is 3, no subclass and protocol required (but may be useful!)
  | 
221  |  * CDC class is 2, use subclass 2 and protocol 1 for ACM
  | 
222  |  */
  | 
223  |  #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH    0
  | 
224  | /* Define this to the length of the HID report descriptor, if you implement
  | 
225  |  * an HID device. Otherwise don't define it or define it to 0.
  | 
226  |  * If you use this define, you must add a PROGMEM character array named
  | 
227  |  * "usbHidReportDescriptor" to your code which contains the report descriptor.
  | 
228  |  * Don't forget to keep the array and this define in sync!
  | 
229  |  */
  | 
230  | 
  | 
231  | /* #define USB_PUBLIC static */
  | 
232  | /* Use the define above if you #include usbdrv.c instead of linking against it.
  | 
233  |  * This technique saves a couple of bytes in flash memory.
  | 
234  |  */
  | 
235  | 
  | 
236  | /* ------------------- Fine Control over USB Descriptors ------------------- */
  | 
237  | /* If you don't want to use the driver's default USB descriptors, you can
  | 
238  |  * provide our own. These can be provided as (1) fixed length static data in
  | 
239  |  * flash memory, (2) fixed length static data in RAM or (3) dynamically at
  | 
240  |  * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
  | 
241  |  * information about this function.
  | 
242  |  * Descriptor handling is configured through the descriptor's properties. If
  | 
243  |  * no properties are defined or if they are 0, the default descriptor is used.
  | 
244  |  * Possible properties are:
  | 
245  |  *   + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
  | 
246  |  *     at runtime via usbFunctionDescriptor().
  | 
247  |  *   + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
  | 
248  |  *     in static memory is in RAM, not in flash memory.
  | 
249  |  *   + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
  | 
250  |  *     the driver must know the descriptor's length. The descriptor itself is
  | 
251  |  *     found at the address of a well known identifier (see below).
  | 
252  |  * List of static descriptor names (must be declared PROGMEM if in flash):
  | 
253  |  *   char usbDescriptorDevice[];
  | 
254  |  *   char usbDescriptorConfiguration[];
  | 
255  |  *   char usbDescriptorHidReport[];
  | 
256  |  *   char usbDescriptorString0[];
  | 
257  |  *   int usbDescriptorStringVendor[];
  | 
258  |  *   int usbDescriptorStringDevice[];
  | 
259  |  *   int usbDescriptorStringSerialNumber[];
  | 
260  |  * Other descriptors can't be provided statically, they must be provided
  | 
261  |  * dynamically at runtime.
  | 
262  |  *
  | 
263  |  * Descriptor properties are or-ed or added together, e.g.:
  | 
264  |  * #define USB_CFG_DESCR_PROPS_DEVICE   (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
  | 
265  |  *
  | 
266  |  * The following descriptors are defined:
  | 
267  |  *   USB_CFG_DESCR_PROPS_DEVICE
  | 
268  |  *   USB_CFG_DESCR_PROPS_CONFIGURATION
  | 
269  |  *   USB_CFG_DESCR_PROPS_STRINGS
  | 
270  |  *   USB_CFG_DESCR_PROPS_STRING_0
  | 
271  |  *   USB_CFG_DESCR_PROPS_STRING_VENDOR
  | 
272  |  *   USB_CFG_DESCR_PROPS_STRING_PRODUCT
  | 
273  |  *   USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
  | 
274  |  *   USB_CFG_DESCR_PROPS_HID
  | 
275  |  *   USB_CFG_DESCR_PROPS_HID_REPORT
  | 
276  |  *   USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
  | 
277  |  *
  | 
278  |  */
  | 
279  | 
  | 
280  | #define USB_CFG_DESCR_PROPS_DEVICE                  0
  | 
281  | #define USB_CFG_DESCR_PROPS_CONFIGURATION           0
  | 
282  | #define USB_CFG_DESCR_PROPS_STRINGS                 0
  | 
283  | #define USB_CFG_DESCR_PROPS_STRING_0                0
  | 
284  | #define USB_CFG_DESCR_PROPS_STRING_VENDOR           0
  | 
285  | #define USB_CFG_DESCR_PROPS_STRING_PRODUCT          0
  | 
286  | #define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER    0
  | 
287  | #define USB_CFG_DESCR_PROPS_HID                     0
  | 
288  | #define USB_CFG_DESCR_PROPS_HID_REPORT              0
  | 
289  | #define USB_CFG_DESCR_PROPS_UNKNOWN                 0
  | 
290  | 
  | 
291  | /* ----------------------- Optional MCU Description ------------------------ */
  | 
292  | 
  | 
293  | /* The following configurations have working defaults in usbdrv.h. You
  | 
294  |  * usually don't need to set them explicitly. Only if you want to run
  | 
295  |  * the driver on a device which is not yet supported or with a compiler
  | 
296  |  * which is not fully supported (such as IAR C) or if you use a differnt
  | 
297  |  * interrupt than INT0, you may have to define some of these.
  | 
298  |  */
  | 
299  | /* #define USB_INTR_CFG            MCUCR */
  | 
300  | /* #define USB_INTR_CFG_SET        ((1 << ISC00) | (1 << ISC01)) */
  | 
301  | /* #define USB_INTR_CFG_CLR        0 */
  | 
302  | /* #define USB_INTR_ENABLE         GIMSK */
  | 
303  | /* #define USB_INTR_ENABLE_BIT     INT0 */
  | 
304  | /* #define USB_INTR_PENDING        GIFR */
  | 
305  | /* #define USB_INTR_PENDING_BIT    INTF0 */
  | 
306  | /* #define USB_INTR_VECTOR         SIG_INTERRUPT0 */
  | 
307  | 
  | 
308  | #endif /* __usbconfig_h_included__ */
  |