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                  PORTB
  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               1
  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 /* --------------------------- Functional Range ---------------------------- */
  38
  39 #define USB_CFG_HAVE_INTRIN_ENDPOINT    0
  40 /* Define this to 1 if you want to compile a version with two endpoints: The
  41  * default control endpoint 0 and an interrupt-in endpoint 1.
  42  */
  43 #define USB_CFG_INTR_POLL_INTERVAL              10
  44 /* If you compile a version with endpoint 1 (interrupt-in), this is the poll
  45  * interval. The value is in milliseconds and must not be less than 10 ms for
  46  * low speed devices.
  47  */
  48 #define USB_CFG_IS_SELF_POWERED                 0
  49 /* Define this to 1 if the device has its own power supply. Set it to 0 if the
  50  * device is powered from the USB bus.
  51  */
  52 #define USB_CFG_MAX_BUS_POWER                   50
  53 /* Set this variable to the maximum USB bus power consumption of your device.
  54  * The value is in milliamperes. [It will be divided by two since USB
  55  * communicates power requirements in units of 2 mA.]
  56  */
  57 #define USB_CFG_SAMPLE_EXACT                    1
  58 /* This variable affects Sampling Jitter for USB receiving. When it is 0, the
  59  * driver guarantees a sampling window of 1/2 bit. The USB spec requires
  60  * that the receiver has at most 1/4 bit sampling window. The 1/2 bit window
  61  * should still work reliably enough because we work at low speed. If you want
  62  * to meet the spec, set this value to 1. This will unroll a loop which
  63  * results in bigger code size.
  64  * If you have problems with long cables, try setting this value to 1.
  65  */
  66 #define USB_CFG_IMPLEMENT_FN_WRITE              1
  67 /* Set this to 1 if you want usbFunctionWrite() to be called for control-out
  68  * transfers. Set it to 0 if you don't need it and want to save a couple of
  69  * bytes.
  70  */
  71 #define USB_CFG_IMPLEMENT_FN_READ               1
  72 /* Set this to 1 if you need to send control replies which are generated
  73  * "on the fly" when usbFunctionRead() is called. If you only want to send
  74  * data from a static buffer, set it to 0 and return the data from
  75  * usbFunctionSetup(). This saves a couple of bytes.
  76  */
  77
  78 /* -------------------------- Device Description --------------------------- */
  79
  80 #define USB_CFG_VENDOR_ID               0xeb, 0x03
  81 /* USB vendor ID for the device, low byte first. 0xeb, 0x03 is Atmel's vendor
  82  * ID. Don't use it for hardware you sell or publish!
  83  */
  84 #define USB_CFG_DEVICE_ID               0xb4, 0xc7
  85 /* This is the ID of the device, low byte first. It is interpreted in the
  86  * scope of the vendor ID. The only requirement is that no two devices may
  87  * share the same product and vendor IDs. Not even if the devices are never
  88  * on the same bus together!
  89  */
  90 #define USB_CFG_DEVICE_VERSION  0x00, 0x01
  91 /* Version number of the device: Minor number first, then major number.
  92  */
  93 #define USB_CFG_VENDOR_NAME             'w', 'w', 'w', '.', 'f', 'i', 's', 'c', 'h', 'l', '.', 'd', 'e'
  94 #define USB_CFG_VENDOR_NAME_LEN 13
  95 /* These two values define the vendor name returned by the USB device. The name
  96  * must be given as a list of characters under single quotes. The characters
  97  * are interpreted as Unicode (UTF-16) entities.
  98  * If you don't want a vendor name string, undefine these macros.
  99  */
 100 #define USB_CFG_DEVICE_NAME             'U', 'S', 'B', 'a', 's', 'p'
 101 #define USB_CFG_DEVICE_NAME_LEN 6
 102 /* Same as above for the device name. If you don't want a device name, undefine
 103  * the macros.
 104  */
 105 #define USB_CFG_DEVICE_CLASS    0xff
 106 #define USB_CFG_DEVICE_SUBCLASS 0
 107 /* See USB specification if you want to conform to an existing device class.
 108  */
 109 #define USB_CFG_INTERFACE_CLASS         0
 110 #define USB_CFG_INTERFACE_SUBCLASS      0
 111 #define USB_CFG_INTERFACE_PROTOCOL      0
 112 /* See USB specification if you want to conform to an existing device class or
 113  * protocol.
 114  */
 115
 116
 117 #endif /* __usbconfig_h_included__ */