quantum/template/ps2avrgb/usbconfig.h

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