firmware/usbconfig.h

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