Guest User

avrusbconfig

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