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