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