usbconfig-prototype.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  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: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt)
  8. * This Revision: $Id: usbconfig-prototype.h 600 2008-05-13 10:34:56Z cs $
  9. */
  10. #ifndef __usbconfig_h_included__
  11. #define __usbconfig_h_included__
  12. /*
  13. General Description:
  14. This file is an example configuration (with inline documentation) for the USB
  15. driver. It configures AVR-USB for USB D+ connected to Port D bit 2 (which is
  16. also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may
  17. wire the lines to any other port, as long as D+ is also wired to INT0 (or any
  18. other hardware interrupt, as long as it is the highest level interrupt, see
  19. section at the end of this file).
  20. + To create your own usbconfig.h file, copy this file to your project's
  21. + firmware source directory) and rename it to "usbconfig.h".
  22. + Then edit it accordingly.
  23. */
  24. /* ---------------------------- Hardware Config ---------------------------- */
  25. #define USB_CFG_IOPORTNAME D
  26. /* This is the port where the USB bus is connected. When you configure it to
  27. * "B", the registers PORTB, PINB and DDRB will be used.
  28. */
  29. #define USB_CFG_DMINUS_BIT 4
  30. /* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
  31. * This may be any bit in the port.
  32. */
  33. #define USB_CFG_DPLUS_BIT 2
  34. /* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
  35. * This may be any bit in the port. Please note that D+ must also be connected
  36. * to interrupt pin INT0! [You can also use other interrupts, see section
  37. * "Optional MCU Description" below, or you can connect D- to the interrupt, as
  38. * it is required if you use the USB_COUNT_SOF feature. If you use D- for the
  39. * interrupt, the USB interrupt will also be triggered at Start-Of-Frame
  40. * markers every millisecond.]
  41. */
  42. #define USB_CFG_CLOCK_KHZ (F_CPU/1000)
  43. /* Clock rate of the AVR in MHz. Legal values are 12000, 15000, 16000, 16500
  44. * and 20000. The 16.5 MHz version of the code requires no crystal, it
  45. * tolerates +/- 1% deviation from the nominal frequency. All other rates
  46. * require a precision of 2000 ppm and thus a crystal!
  47. * Default if not specified: 12 MHz
  48. */
  49. /* ----------------------- Optional Hardware Config ------------------------ */
  50. /* #define USB_CFG_PULLUP_IOPORTNAME D */
  51. /* If you connect the 1.5k pullup resistor from D- to a port pin instead of
  52. * V+, you can connect and disconnect the device from firmware by calling
  53. * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
  54. * This constant defines the port on which the pullup resistor is connected.
  55. */
  56. /* #define USB_CFG_PULLUP_BIT 4 */
  57. /* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
  58. * above) where the 1.5k pullup resistor is connected. See description
  59. * above for details.
  60. */
  61. /* --------------------------- Functional Range ---------------------------- */
  62. #define USB_CFG_HAVE_INTRIN_ENDPOINT 0
  63. /* Define this to 1 if you want to compile a version with two endpoints: The
  64. * default control endpoint 0 and an interrupt-in endpoint (any other endpoint
  65. * number).
  66. */
  67. #define USB_CFG_HAVE_INTRIN_ENDPOINT3 0
  68. /* Define this to 1 if you want to compile a version with three endpoints: The
  69. * default control endpoint 0, an interrupt-in endpoint 3 (or the number
  70. * configured below) and a catch-all default interrupt-in endpoint as above.
  71. * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
  72. */
  73. #define USB_CFG_EP3_NUMBER 3
  74. /* If the so-called endpoint 3 is used, it can now be configured to any other
  75. * endpoint number (except 0) with this macro. Default if undefined is 3.
  76. */
  77. /* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */
  78. /* The above macro defines the startup condition for data toggling on the
  79. * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
  80. * Since the token is toggled BEFORE sending any data, the first packet is
  81. * sent with the oposite value of this configuration!
  82. */
  83. #define USB_CFG_IMPLEMENT_HALT 0
  84. /* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
  85. * for endpoint 1 (interrupt endpoint). Although you may not need this feature,
  86. * it is required by the standard. We have made it a config option because it
  87. * bloats the code considerably.
  88. */
  89. #define USB_CFG_INTR_POLL_INTERVAL 10
  90. /* If you compile a version with endpoint 1 (interrupt-in), this is the poll
  91. * interval. The value is in milliseconds and must not be less than 10 ms for
  92. * low speed devices.
  93. */
  94. #define USB_CFG_IS_SELF_POWERED 0
  95. /* Define this to 1 if the device has its own power supply. Set it to 0 if the
  96. * device is powered from the USB bus.
  97. */
  98. #define USB_CFG_MAX_BUS_POWER 100
  99. /* Set this variable to the maximum USB bus power consumption of your device.
  100. * The value is in milliamperes. [It will be divided by two since USB
  101. * communicates power requirements in units of 2 mA.]
  102. */
  103. #define USB_CFG_IMPLEMENT_FN_WRITE 0
  104. /* Set this to 1 if you want usbFunctionWrite() to be called for control-out
  105. * transfers. Set it to 0 if you don't need it and want to save a couple of
  106. * bytes.
  107. */
  108. #define USB_CFG_IMPLEMENT_FN_READ 0
  109. /* Set this to 1 if you need to send control replies which are generated
  110. * "on the fly" when usbFunctionRead() is called. If you only want to send
  111. * data from a static buffer, set it to 0 and return the data from
  112. * usbFunctionSetup(). This saves a couple of bytes.
  113. */
  114. #define USB_CFG_IMPLEMENT_FN_WRITEOUT 0
  115. /* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
  116. * You must implement the function usbFunctionWriteOut() which receives all
  117. * interrupt/bulk data sent to any endpoint other than 0. The endpoint number
  118. * can be found in 'usbRxToken'.
  119. */
  120. #define USB_CFG_HAVE_FLOWCONTROL 0
  121. /* Define this to 1 if you want flowcontrol over USB data. See the definition
  122. * of the macros usbDisableAllRequests() and usbEnableAllRequests() in
  123. * usbdrv.h.
  124. */
  125. #define USB_CFG_LONG_TRANSFERS 0
  126. /* Define this to 1 if you want to send/receive blocks of more than 254 bytes
  127. * in a single control-in or control-out transfer. Note that the capability
  128. * for long transfers increases the driver size.
  129. */
  130. /* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
  131. /* This macro is a hook if you want to do unconventional things. If it is
  132. * defined, it's inserted at the beginning of received message processing.
  133. * If you eat the received message and don't want default processing to
  134. * proceed, do a return after doing your things. One possible application
  135. * (besides debugging) is to flash a status LED on each packet.
  136. */
  137. /* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */
  138. /* This macro is a hook if you need to know when an USB RESET occurs. It has
  139. * one parameter which distinguishes between the start of RESET state and its
  140. * end.
  141. */
  142. /* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */
  143. /* This macro (if defined) is executed when a USB SET_ADDRESS request was
  144. * received.
  145. */
  146. #define USB_COUNT_SOF 0
  147. /* define this macro to 1 if you need the global variable "usbSofCount" which
  148. * counts SOF packets. This feature requires that the hardware interrupt is
  149. * connected to D- instead of D+.
  150. */
  151. #define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0
  152. /* define this macro to 1 if you want the function usbMeasureFrameLength()
  153. * compiled in. This function can be used to calibrate the AVR's RC oscillator.
  154. */
  155. /* -------------------------- Device Description --------------------------- */
  156. #define USB_CFG_VENDOR_ID 0xc0, 0x16
  157. /* USB vendor ID for the device, low byte first. If you have registered your
  158. * own Vendor ID, define it here. Otherwise you use one of obdev's free shared
  159. * VID/PID pairs. Be sure to read USBID-License.txt for rules!
  160. * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc.
  161. * + Use this VID/PID pair ONLY if you understand the implications!
  162. */
  163. #define USB_CFG_DEVICE_ID 0xdc, 0x05
  164. /* This is the ID of the product, low byte first. It is interpreted in the
  165. * scope of the vendor ID. If you have registered your own VID with usb.org
  166. * or if you have licensed a PID from somebody else, define it here. Otherwise
  167. * you use obdev's free shared VID/PID pair. Be sure to read the rules in
  168. * USBID-License.txt!
  169. * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc.
  170. * + Use this VID/PID pair ONLY if you understand the implications!
  171. */
  172. #define USB_CFG_DEVICE_VERSION 0x00, 0x01
  173. /* Version number of the device: Minor number first, then major number.
  174. */
  175. #define USB_CFG_VENDOR_NAME 'o', 'b', 'd', 'e', 'v', '.', 'a', 't'
  176. #define USB_CFG_VENDOR_NAME_LEN 8
  177. /* These two values define the vendor name returned by the USB device. The name
  178. * must be given as a list of characters under single quotes. The characters
  179. * are interpreted as Unicode (UTF-16) entities.
  180. * If you don't want a vendor name string, undefine these macros.
  181. * ALWAYS define a vendor name containing your Internet domain name if you use
  182. * obdev's free shared VID/PID pair. See the file USBID-License.txt for
  183. * details.
  184. */
  185. #define USB_CFG_DEVICE_NAME 'T', 'e', 'm', 'p', 'l', 'a', 't', 'e'
  186. #define USB_CFG_DEVICE_NAME_LEN 8
  187. /* Same as above for the device name. If you don't want a device name, undefine
  188. * the macros. See the file USBID-License.txt before you assign a name if you
  189. * use a shared VID/PID.
  190. */
  191. /*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */
  192. /*#define USB_CFG_SERIAL_NUMBER_LEN 0 */
  193. /* Same as above for the serial number. If you don't want a serial number,
  194. * undefine the macros.
  195. * It may be useful to provide the serial number through other means than at
  196. * compile time. See the section about descriptor properties below for how
  197. * to fine tune control over USB descriptors such as the string descriptor
  198. * for the serial number.
  199. */
  200. #define USB_CFG_DEVICE_CLASS 0xff /* set to 0 if deferred to interface */
  201. #define USB_CFG_DEVICE_SUBCLASS 0
  202. /* See USB specification if you want to conform to an existing device class.
  203. * Class 0xff is "vendor specific".
  204. */
  205. #define USB_CFG_INTERFACE_CLASS 0 /* define class here if not at device level */
  206. #define USB_CFG_INTERFACE_SUBCLASS 0
  207. #define USB_CFG_INTERFACE_PROTOCOL 0
  208. /* See USB specification if you want to conform to an existing device class or
  209. * protocol. The following classes must be set at interface level:
  210. * HID class is 3, no subclass and protocol required (but may be useful!)
  211. * CDC class is 2, use subclass 2 and protocol 1 for ACM
  212. */
  213. /* #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 42 */
  214. /* Define this to the length of the HID report descriptor, if you implement
  215. * an HID device. Otherwise don't define it or define it to 0.
  216. * If you use this define, you must add a PROGMEM character array named
  217. * "usbHidReportDescriptor" to your code which contains the report descriptor.
  218. * Don't forget to keep the array and this define in sync!
  219. */
  220. /* #define USB_PUBLIC static */
  221. /* Use the define above if you #include usbdrv.c instead of linking against it.
  222. * This technique saves a couple of bytes in flash memory.
  223. */
  224. /* ------------------- Fine Control over USB Descriptors ------------------- */
  225. /* If you don't want to use the driver's default USB descriptors, you can
  226. * provide our own. These can be provided as (1) fixed length static data in
  227. * flash memory, (2) fixed length static data in RAM or (3) dynamically at
  228. * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
  229. * information about this function.
  230. * Descriptor handling is configured through the descriptor's properties. If
  231. * no properties are defined or if they are 0, the default descriptor is used.
  232. * Possible properties are:
  233. * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
  234. * at runtime via usbFunctionDescriptor().
  235. * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
  236. * in static memory is in RAM, not in flash memory.
  237. * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
  238. * the driver must know the descriptor's length. The descriptor itself is
  239. * found at the address of a well known identifier (see below).
  240. * List of static descriptor names (must be declared PROGMEM if in flash):
  241. * char usbDescriptorDevice[];
  242. * char usbDescriptorConfiguration[];
  243. * char usbDescriptorHidReport[];
  244. * char usbDescriptorString0[];
  245. * int usbDescriptorStringVendor[];
  246. * int usbDescriptorStringDevice[];
  247. * int usbDescriptorStringSerialNumber[];
  248. * Other descriptors can't be provided statically, they must be provided
  249. * dynamically at runtime.
  250. *
  251. * Descriptor properties are or-ed or added together, e.g.:
  252. * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
  253. *
  254. * The following descriptors are defined:
  255. * USB_CFG_DESCR_PROPS_DEVICE
  256. * USB_CFG_DESCR_PROPS_CONFIGURATION
  257. * USB_CFG_DESCR_PROPS_STRINGS
  258. * USB_CFG_DESCR_PROPS_STRING_0
  259. * USB_CFG_DESCR_PROPS_STRING_VENDOR
  260. * USB_CFG_DESCR_PROPS_STRING_PRODUCT
  261. * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
  262. * USB_CFG_DESCR_PROPS_HID
  263. * USB_CFG_DESCR_PROPS_HID_REPORT
  264. * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
  265. *
  266. */
  267. #define USB_CFG_DESCR_PROPS_DEVICE 0
  268. #define USB_CFG_DESCR_PROPS_CONFIGURATION 0
  269. #define USB_CFG_DESCR_PROPS_STRINGS 0
  270. #define USB_CFG_DESCR_PROPS_STRING_0 0
  271. #define USB_CFG_DESCR_PROPS_STRING_VENDOR 0
  272. #define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0
  273. #define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0
  274. #define USB_CFG_DESCR_PROPS_HID 0
  275. #define USB_CFG_DESCR_PROPS_HID_REPORT 0
  276. #define USB_CFG_DESCR_PROPS_UNKNOWN 0
  277. /* ----------------------- Optional MCU Description ------------------------ */
  278. /* The following configurations have working defaults in usbdrv.h. You
  279. * usually don't need to set them explicitly. Only if you want to run
  280. * the driver on a device which is not yet supported or with a compiler
  281. * which is not fully supported (such as IAR C) or if you use a differnt
  282. * interrupt than INT0, you may have to define some of these.
  283. */
  284. /* #define USB_INTR_CFG MCUCR */
  285. /* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */
  286. /* #define USB_INTR_CFG_CLR 0 */
  287. /* #define USB_INTR_ENABLE GIMSK */
  288. /* #define USB_INTR_ENABLE_BIT INT0 */
  289. /* #define USB_INTR_PENDING GIFR */
  290. /* #define USB_INTR_PENDING_BIT INTF0 */
  291. /* #define USB_INTR_VECTOR SIG_INTERRUPT0 */
  292. #endif /* __usbconfig_h_included__ */