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: Proprietary, free under certain conditions. See Documentation.
   8  * This Revision: $Id: usbconfig.h 43 2005-04-10 21:04:36Z cs $
   9  */
  10
  11 #ifndef __usbconfig_h_included__
  12 #define __usbconfig_h_included__
  13
  14 /*
  15 General Description:
  16 This file contains parts of the USB driver which can be configured and can or
  17 must be adapted to your hardware.
  18
  19 Please note that the usbdrv contains a usbconfig-prototype.h file now. We
  20 recommend that you use that file as a template because it will always list
  21 the newest features and options.
  22 */
  23
  24 /* ---------------------------- Hardware Config ---------------------------- */
  25
  26 #define USB_CFG_IOPORTNAME      B
  27 /* This is the port where the USB bus is connected. When you configure it to
  28  * "PORTB", the registers PORTB, PINB (=PORTB-2) and DDRB (=PORTB-1) will be
  29  * used.
  30  */
  31 #define USB_CFG_DMINUS_BIT      0
  32 /* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
  33  * This MUST be bit 0 or 7. All other values will result in a compile error!
  34  */
  35 #define USB_CFG_DPLUS_BIT       1
  36 /* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
  37  * This may be any bit in the port. Please note that D+ must also be connected
  38  * to interrupt pin INT0!
  39  */
  40
  41 /* #define USB_CFG_PULLUP_IOPORTNAME   B */
  42 /* This is the port where the USB D- pullup resistor is connected. When you
  43  * configure it to "PORTB", the registers PORTB and DDRB (=PORTB-1) will be
  44  * used. If this constant is defined, the macros usbDeviceConnect() and
  45  * usbDeviceDisconnect will be available.
  46  */
  47 /* #define USB_CFG_PULLUP_BIT          2 */
  48 /* This is the bit number in USB_CFG_PULLUP_IOPORT where the USB D- 1.5 kOhm
  49  * pullup resistor is connected instead of VBUS. This may be any bit in
  50  * the port.
  51  */
  52
  53 /* --------------------------- Functional Range ---------------------------- */
  54
  55 #define USB_CFG_HAVE_INTRIN_ENDPOINT    0
  56 /* Define this to 1 if you want to compile a version with two endpoints: The
  57  * default control endpoint 0 and an interrupt-in endpoint 1.
  58  */
  59 #define USB_CFG_IMPLEMENT_HALT          0
  60 /* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
  61  * for endpoint 1 (interrupt endpoint). Although you may not need this feature,
  62  * it is required by the standard. We have made it a config option because it
  63  * bloats the code considerably.
  64  */
  65 #define USB_CFG_INTR_POLL_INTERVAL      10
  66 /* If you compile a version with endpoint 1 (interrupt-in), this is the poll
  67  * interval. The value is in milliseconds and must not be less than 10 ms for
  68  * low speed devices.
  69  */
  70 #define USB_CFG_IS_SELF_POWERED         0
  71 /* Define this to 1 if the device has its own power supply. Set it to 0 if the
  72  * device is powered from the USB bus.
  73  */
  74 #define USB_CFG_MAX_BUS_POWER           50
  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_SAMPLE_EXACT            1
  80 /* This variable affects Sampling Jitter for USB receiving. When it is 0, the
  81  * driver guarantees a sampling window of 1/2 bit. The USB spec requires
  82  * that the receiver has at most 1/4 bit sampling window. The 1/2 bit window
  83  * should still work reliably enough because we work at low speed. If you want
  84  * to meet the spec, set this value to 1. This will unroll a loop which
  85  * results in bigger code size.
  86  * If you have problems with long cables, try setting this value to 1.
  87  */
  88 #define USB_CFG_IMPLEMENT_FN_WRITE      1
  89 /* Set this to 1 if you want usbFunctionWrite() to be called for control-out
  90  * transfers. Set it to 0 if you don't need it and want to save a couple of
  91  * bytes.
  92  */
  93 #define USB_CFG_IMPLEMENT_FN_READ       1
  94 /* Set this to 1 if you need to send control replies which are generated
  95  * "on the fly" when usbFunctionRead() is called. If you only want to send
  96  * data from a static buffer, set it to 0 and return the data from
  97  * usbFunctionSetup(). This saves a couple of bytes.
  98  */
  99
 100 /* -------------------------- Device Description --------------------------- */
 101
 102 #define  USB_CFG_VENDOR_ID  0xc0, 0x16  /* 5824 in dec, stands for VOTI */
 103 /* USB vendor ID for the device, low byte first. If you have registered your
 104  * own Vendor ID, define it here. Otherwise you use obdev's free shared
 105  * VID/PID pair. Be sure to read USBID-License.txt for rules!
 106  */
 107 #define USB_CFG_DEVICE_ID   0xdc, 0x05  /* 1500 in dec, obdev's free PID */
 108 /* This is the ID of the product, low byte first. It is interpreted in the
 109  * scope of the vendor ID. If you have registered your own VID with usb.org
 110  * or if you have licensed a PID from somebody else, define it here. Otherwise
 111  * you use obdev's free shared VID/PID pair. Be sure to read the rules in
 112  * USBID-License.txt!
 113  */
 114 #define USB_CFG_DEVICE_VERSION  0x01, 0x01
 115 /* Version number of the device: Minor number first, then major number.
 116  */
 117 #define USB_CFG_VENDOR_NAME     'w', 'w', 'w', '.', 'f', 'i', 's', 'c', 'h', 'l', '.', 'd', 'e'
 118 #define USB_CFG_VENDOR_NAME_LEN 13
 119 /* These two values define the vendor name returned by the USB device. The name
 120  * must be given as a list of characters under single quotes. The characters
 121  * are interpreted as Unicode (UTF-16) entities.
 122  * If you don't want a vendor name string, undefine these macros.
 123  * ALWAYS define a vendor name containing your Internet domain name if you use
 124  * obdev's free shared VID/PID pair. See the file USBID-License.txt for
 125  * details.
 126  */
 127 #define USB_CFG_DEVICE_NAME             'U', 'S', 'B', 'a', 's', 'p'
 128 #define USB_CFG_DEVICE_NAME_LEN 6
 129 /* Same as above for the device name. If you don't want a device name, undefine
 130  * the macros. See the file USBID-License.txt before you assign a name.
 131  */
 132 #define USB_CFG_SERIAL_NUMBER_LENGTH  0
 133 /* Set this define to the number of charcters in the serial number if your
 134  * device should have a serial number to uniquely identify each hardware
 135  * instance. You must supply the serial number in a string descriptor with the
 136  * name "usbCfgSerialNumberStringDescriptor", e.g.:
 137  * #define USB_CFG_SERIAL_NUMBER_LENGTH  5
 138  * int usbCfgSerialNumberStringDescriptor[] PROGMEM = {
 139  *     USB_STRING_DESCRIPTOR_HEADER(USB_CFG_SERIAL_NUMBER_LENGTH),
 140  *     '1', '2', '3', '4', '5'
 141  * };
 142  * See usbdrv.h for more information about the USB_STRING_DESCRIPTOR_HEADER()
 143  * macro or usbdrv.c for example string descriptors.
 144  * You may want to put "usbCfgSerialNumberStringDescriptor" at a constant
 145  * flash memory address (with magic linker commands) so that you don't need
 146  * to recompile if you change it.
 147  */
 148 #define USB_CFG_DEVICE_CLASS    0xff
 149 #define USB_CFG_DEVICE_SUBCLASS 0
 150 /* See USB specification if you want to conform to an existing device class.
 151  */
 152 #define USB_CFG_INTERFACE_CLASS     0
 153 #define USB_CFG_INTERFACE_SUBCLASS  0
 154 #define USB_CFG_INTERFACE_PROTOCOL  0
 155 /* See USB specification if you want to conform to an existing device class or
 156  * protocol.
 157  */
 158 #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH    0   /* total length of report descriptor */
 159 /* Define this to the length of the HID report descriptor, if you implement
 160  * an HID device. Otherwise don't define it or define it to 0.
 161  */
 162
 163 #endif /* __usbconfig_h_included__ */