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