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