| 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), GNU GPL v3 or proprietary (CommercialLicense.txt) |
| 8 | * This Revision: $Id: usbconfig.h,v 1.1.1.1 2009/03/15 17:46:59 simimeie Exp $ |
| 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 B |
| 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 1 |
| 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 (F_CPU/1000) |
| 47 | /* Clock rate of the AVR in MHz. Legal values are 12000, 12800, 15000, 16000, |
| 48 | * 16500 and 20000. The 12.8 MHz and 16.5 MHz versions of the code require no |
| 49 | * crystal, they tolerate +/- 1% deviation from the nominal frequency. All |
| 50 | * other rates 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 1 |
| 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_SUPPRESS_INTR_CODE 0 |
| 98 | /* Define this to 1 if you want to declare interrupt-in endpoints, but don't |
| 99 | * want to send any data over them. If this macro is defined to 1, functions |
| 100 | * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if |
| 101 | * you need the interrupt-in endpoints in order to comply to an interface |
| 102 | * (e.g. HID), but never want to send any data. This option saves a couple |
| 103 | * of bytes in flash memory and the transmit buffers in RAM. |
| 104 | */ |
| 105 | #define USB_CFG_INTR_POLL_INTERVAL 200 |
| 106 | /* If you compile a version with endpoint 1 (interrupt-in), this is the poll |
| 107 | * interval. The value is in milliseconds and must not be less than 10 ms for |
| 108 | * low speed devices. |
| 109 | * (fox) don't make this too high, it will overflow due to the high clock rate |
| 110 | */ |
| 111 | #define USB_CFG_IS_SELF_POWERED 0 |
| 112 | /* Define this to 1 if the device has its own power supply. Set it to 0 if the |
| 113 | * device is powered from the USB bus. |
| 114 | */ |
| 115 | #define USB_CFG_MAX_BUS_POWER 50 |
| 116 | /* Set this variable to the maximum USB bus power consumption of your device. |
| 117 | * The value is in milliamperes. [It will be divided by two since USB |
| 118 | * communicates power requirements in units of 2 mA.] |
| 119 | */ |
| 120 | #define USB_CFG_IMPLEMENT_FN_WRITE 0 |
| 121 | /* Set this to 1 if you want usbFunctionWrite() to be called for control-out |
| 122 | * transfers. Set it to 0 if you don't need it and want to save a couple of |
| 123 | * bytes. |
| 124 | */ |
| 125 | #define USB_CFG_IMPLEMENT_FN_READ 1 |
| 126 | /* Set this to 1 if you need to send control replies which are generated |
| 127 | * "on the fly" when usbFunctionRead() is called. If you only want to send |
| 128 | * data from a static buffer, set it to 0 and return the data from |
| 129 | * usbFunctionSetup(). This saves a couple of bytes. |
| 130 | */ |
| 131 | #define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 |
| 132 | /* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints. |
| 133 | * You must implement the function usbFunctionWriteOut() which receives all |
| 134 | * interrupt/bulk data sent to any endpoint other than 0. The endpoint number |
| 135 | * can be found in 'usbRxToken'. |
| 136 | */ |
| 137 | #define USB_CFG_HAVE_FLOWCONTROL 0 |
| 138 | /* Define this to 1 if you want flowcontrol over USB data. See the definition |
| 139 | * of the macros usbDisableAllRequests() and usbEnableAllRequests() in |
| 140 | * usbdrv.h. |
| 141 | */ |
| 142 | #define USB_CFG_LONG_TRANSFERS 0 |
| 143 | /* Define this to 1 if you want to send/receive blocks of more than 254 bytes |
| 144 | * in a single control-in or control-out transfer. Note that the capability |
| 145 | * for long transfers increases the driver size. |
| 146 | */ |
| 147 | /* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */ |
| 148 | /* This macro is a hook if you want to do unconventional things. If it is |
| 149 | * defined, it's inserted at the beginning of received message processing. |
| 150 | * If you eat the received message and don't want default processing to |
| 151 | * proceed, do a return after doing your things. One possible application |
| 152 | * (besides debugging) is to flash a status LED on each packet. |
| 153 | */ |
| 154 | /* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */ |
| 155 | /* This macro is a hook if you need to know when an USB RESET occurs. It has |
| 156 | * one parameter which distinguishes between the start of RESET state and its |
| 157 | * end. |
| 158 | */ |
| 159 | /* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */ |
| 160 | /* This macro (if defined) is executed when a USB SET_ADDRESS request was |
| 161 | * received. |
| 162 | */ |
| 163 | #define USB_COUNT_SOF 0 |
| 164 | /* define this macro to 1 if you need the global variable "usbSofCount" which |
| 165 | * counts SOF packets. This feature requires that the hardware interrupt is |
| 166 | * connected to D- instead of D+. |
| 167 | */ |
| 168 | /* #ifdef __ASSEMBLER__ |
| 169 | * macro myAssemblerMacro |
| 170 | * in YL, TCNT0 |
| 171 | * sts timer0Snapshot, YL |
| 172 | * endm |
| 173 | * #endif |
| 174 | * #define USB_SOF_HOOK myAssemblerMacro |
| 175 | * This macro (if defined) is executed in the assembler module when a |
| 176 | * Start Of Frame condition is detected. It is recommended to define it to |
| 177 | * the name of an assembler macro which is defined here as well so that more |
| 178 | * than one assembler instruction can be used. The macro may use the register |
| 179 | * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages |
| 180 | * immediately after an SOF pulse may be lost and must be retried by the host. |
| 181 | * What can you do with this hook? Since the SOF signal occurs exactly every |
| 182 | * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in |
| 183 | * designs running on the internal RC oscillator. |
| 184 | * Please note that Start Of Frame detection works only if D- is wired to the |
| 185 | * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES! |
| 186 | */ |
| 187 | #define USB_CFG_CHECK_DATA_TOGGLING 0 |
| 188 | /* define this macro to 1 if you want to filter out duplicate data packets |
| 189 | * sent by the host. Duplicates occur only as a consequence of communication |
| 190 | * errors, when the host does not receive an ACK. Please note that you need to |
| 191 | * implement the filtering yourself in usbFunctionWriteOut() and |
| 192 | * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable |
| 193 | * for each control- and out-endpoint to check for duplicate packets. |
| 194 | */ |
| 195 | #define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0 |
| 196 | /* define this macro to 1 if you want the function usbMeasureFrameLength() |
| 197 | * compiled in. This function can be used to calibrate the AVR's RC oscillator. |
| 198 | */ |
| 199 | |
| 200 | /* -------------------------- Device Description --------------------------- */ |
| 201 | |
| 202 | #define USB_CFG_VENDOR_ID 0xc0, 0x16 |
| 203 | /* USB vendor ID for the device, low byte first. If you have registered your |
| 204 | * own Vendor ID, define it here. Otherwise you use one of obdev's free shared |
| 205 | * VID/PID pairs. Be sure to read USBID-License.txt for rules! |
| 206 | * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc. |
| 207 | * + Use this VID/PID pair ONLY if you understand the implications! |
| 208 | */ |
| 209 | #define USB_CFG_DEVICE_ID 0xdc, 0x05 |
| 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 |
| 214 | * USBID-License.txt! |
| 215 | * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc. |
| 216 | * + Use this VID/PID pair ONLY if you understand the implications! |
| 217 | */ |
| 218 | #define USB_CFG_DEVICE_VERSION 0x00, 0x01 |
| 219 | /* Version number of the device: Minor number first, then major number. |
| 220 | */ |
| 221 | #define USB_CFG_VENDOR_NAME 'w', 'w', 'w', '.', 'p', 'o', 'e', 'm', 'p', 'e', 'l', 'f', 'o', 'x', '.', 'd', 'e' |
| 222 | #define USB_CFG_VENDOR_NAME_LEN 17 |
| 223 | /* These two values define the vendor name returned by the USB device. The name |
| 224 | * must be given as a list of characters under single quotes. The characters |
| 225 | * are interpreted as Unicode (UTF-16) entities. |
| 226 | * If you don't want a vendor name string, undefine these macros. |
| 227 | * ALWAYS define a vendor name containing your Internet domain name if you use |
| 228 | * obdev's free shared VID/PID pair. See the file USBID-License.txt for |
| 229 | * details. |
| 230 | */ |
| 231 | #define USB_CFG_DEVICE_NAME 'd', 's', '1', '8', '2', '0', 't', 'o', 'u', 's', 'b' |
| 232 | #define USB_CFG_DEVICE_NAME_LEN 11 |
| 233 | /* Same as above for the device name. If you don't want a device name, undefine |
| 234 | * the macros. See the file USBID-License.txt before you assign a name if you |
| 235 | * use a shared VID/PID. |
| 236 | */ |
| 237 | /*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */ |
| 238 | /*#define USB_CFG_SERIAL_NUMBER_LEN 0 */ |
| 239 | /* Same as above for the serial number. If you don't want a serial number, |
| 240 | * undefine the macros. |
| 241 | * It may be useful to provide the serial number through other means than at |
| 242 | * compile time. See the section about descriptor properties below for how |
| 243 | * to fine tune control over USB descriptors such as the string descriptor |
| 244 | * for the serial number. |
| 245 | */ |
| 246 | #define USB_CFG_DEVICE_CLASS 0xff /* set to 0 if deferred to interface */ |
| 247 | #define USB_CFG_DEVICE_SUBCLASS 0 |
| 248 | /* See USB specification if you want to conform to an existing device class. |
| 249 | * Class 0xff is "vendor specific". |
| 250 | */ |
| 251 | #define USB_CFG_INTERFACE_CLASS 0 /* define class here if not at device level */ |
| 252 | #define USB_CFG_INTERFACE_SUBCLASS 0 |
| 253 | #define USB_CFG_INTERFACE_PROTOCOL 0 |
| 254 | /* See USB specification if you want to conform to an existing device class or |
| 255 | * protocol. The following classes must be set at interface level: |
| 256 | * HID class is 3, no subclass and protocol required (but may be useful!) |
| 257 | * CDC class is 2, use subclass 2 and protocol 1 for ACM |
| 258 | */ |
| 259 | /* #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 42 */ |
| 260 | /* Define this to the length of the HID report descriptor, if you implement |
| 261 | * an HID device. Otherwise don't define it or define it to 0. |
| 262 | * If you use this define, you must add a PROGMEM character array named |
| 263 | * "usbHidReportDescriptor" to your code which contains the report descriptor. |
| 264 | * Don't forget to keep the array and this define in sync! |
| 265 | */ |
| 266 | |
| 267 | /* #define USB_PUBLIC static */ |
| 268 | /* Use the define above if you #include usbdrv.c instead of linking against it. |
| 269 | * This technique saves a couple of bytes in flash memory. |
| 270 | */ |
| 271 | |
| 272 | /* ------------------- Fine Control over USB Descriptors ------------------- */ |
| 273 | /* If you don't want to use the driver's default USB descriptors, you can |
| 274 | * provide our own. These can be provided as (1) fixed length static data in |
| 275 | * flash memory, (2) fixed length static data in RAM or (3) dynamically at |
| 276 | * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more |
| 277 | * information about this function. |
| 278 | * Descriptor handling is configured through the descriptor's properties. If |
| 279 | * no properties are defined or if they are 0, the default descriptor is used. |
| 280 | * Possible properties are: |
| 281 | * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched |
| 282 | * at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is |
| 283 | * used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if |
| 284 | * you want RAM pointers. |
| 285 | * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found |
| 286 | * in static memory is in RAM, not in flash memory. |
| 287 | * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), |
| 288 | * the driver must know the descriptor's length. The descriptor itself is |
| 289 | * found at the address of a well known identifier (see below). |
| 290 | * List of static descriptor names (must be declared PROGMEM if in flash): |
| 291 | * char usbDescriptorDevice[]; |
| 292 | * char usbDescriptorConfiguration[]; |
| 293 | * char usbDescriptorHidReport[]; |
| 294 | * char usbDescriptorString0[]; |
| 295 | * int usbDescriptorStringVendor[]; |
| 296 | * int usbDescriptorStringDevice[]; |
| 297 | * int usbDescriptorStringSerialNumber[]; |
| 298 | * Other descriptors can't be provided statically, they must be provided |
| 299 | * dynamically at runtime. |
| 300 | * |
| 301 | * Descriptor properties are or-ed or added together, e.g.: |
| 302 | * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18)) |
| 303 | * |
| 304 | * The following descriptors are defined: |
| 305 | * USB_CFG_DESCR_PROPS_DEVICE |
| 306 | * USB_CFG_DESCR_PROPS_CONFIGURATION |
| 307 | * USB_CFG_DESCR_PROPS_STRINGS |
| 308 | * USB_CFG_DESCR_PROPS_STRING_0 |
| 309 | * USB_CFG_DESCR_PROPS_STRING_VENDOR |
| 310 | * USB_CFG_DESCR_PROPS_STRING_PRODUCT |
| 311 | * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER |
| 312 | * USB_CFG_DESCR_PROPS_HID |
| 313 | * USB_CFG_DESCR_PROPS_HID_REPORT |
| 314 | * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) |
| 315 | * |
| 316 | * Note about string descriptors: String descriptors are not just strings, they |
| 317 | * are Unicode strings prefixed with a 2 byte header. Example: |
| 318 | * int serialNumberDescriptor[] = { |
| 319 | * USB_STRING_DESCRIPTOR_HEADER(6), |
| 320 | * 'S', 'e', 'r', 'i', 'a', 'l' |
| 321 | * }; |
| 322 | */ |
| 323 | |
| 324 | #define USB_CFG_DESCR_PROPS_DEVICE 0 |
| 325 | #define USB_CFG_DESCR_PROPS_CONFIGURATION 0 |
| 326 | #define USB_CFG_DESCR_PROPS_STRINGS 0 |
| 327 | #define USB_CFG_DESCR_PROPS_STRING_0 0 |
| 328 | #define USB_CFG_DESCR_PROPS_STRING_VENDOR 0 |
| 329 | #define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0 |
| 330 | #define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 |
| 331 | #define USB_CFG_DESCR_PROPS_HID 0 |
| 332 | #define USB_CFG_DESCR_PROPS_HID_REPORT 0 |
| 333 | #define USB_CFG_DESCR_PROPS_UNKNOWN 0 |
| 334 | |
| 335 | /* ----------------------- Optional MCU Description ------------------------ */ |
| 336 | |
| 337 | /* The following configurations have working defaults in usbdrv.h. You |
| 338 | * usually don't need to set them explicitly. Only if you want to run |
| 339 | * the driver on a device which is not yet supported or with a compiler |
| 340 | * which is not fully supported (such as IAR C) or if you use a differnt |
| 341 | * interrupt than INT0, you may have to define some of these. |
| 342 | */ |
| 343 | /* #define USB_INTR_CFG MCUCR */ |
| 344 | /* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */ |
| 345 | /* #define USB_INTR_CFG_CLR 0 */ |
| 346 | /* #define USB_INTR_ENABLE GIMSK */ |
| 347 | /* #define USB_INTR_ENABLE_BIT INT0 */ |
| 348 | /* #define USB_INTR_PENDING GIFR */ |
| 349 | /* #define USB_INTR_PENDING_BIT INTF0 */ |
| 350 | /* #define USB_INTR_VECTOR SIG_INTERRUPT0 */ |
| 351 | |
| 352 | #endif /* __usbconfig_h_included__ */ |