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