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