usbconfig-prototype.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  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), GNU GPL v3 or proprietary (CommercialLicense.txt)
  8. * This Revision: $Id: usbconfig-prototype.h 734 2009-03-23 11:10:07Z 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 kHz. Legal values are 12000, 12800, 15000, 16000,
  44. * 16500 and 20000. The 12.8 MHz and 16.5 MHz versions of the code require no
  45. * crystal, they tolerate +/- 1% deviation from the nominal frequency. All
  46. * other rates require a precision of 2000 ppm and thus a crystal!
  47. * Default if not specified: 12 MHz
  48. */
  49. #define USB_CFG_CHECK_CRC 0
  50. /* Define this to 1 if you want that the driver checks integrity of incoming
  51. * data packets (CRC checks). CRC checks cost quite a bit of code size and are
  52. * currently only available for 18 MHz crystal clock. You must choose
  53. * USB_CFG_CLOCK_KHZ = 18000 if you enable this option.
  54. */
  55. /* ----------------------- Optional Hardware Config ------------------------ */
  56. /* #define USB_CFG_PULLUP_IOPORTNAME D */
  57. /* If you connect the 1.5k pullup resistor from D- to a port pin instead of
  58. * V+, you can connect and disconnect the device from firmware by calling
  59. * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
  60. * This constant defines the port on which the pullup resistor is connected.
  61. */
  62. /* #define USB_CFG_PULLUP_BIT 4 */
  63. /* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
  64. * above) where the 1.5k pullup resistor is connected. See description
  65. * above for details.
  66. */
  67. /* --------------------------- Functional Range ---------------------------- */
  68. #define USB_CFG_HAVE_INTRIN_ENDPOINT 0
  69. /* Define this to 1 if you want to compile a version with two endpoints: The
  70. * default control endpoint 0 and an interrupt-in endpoint (any other endpoint
  71. * number).
  72. */
  73. #define USB_CFG_HAVE_INTRIN_ENDPOINT3 0
  74. /* Define this to 1 if you want to compile a version with three endpoints: The
  75. * default control endpoint 0, an interrupt-in endpoint 3 (or the number
  76. * configured below) and a catch-all default interrupt-in endpoint as above.
  77. * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
  78. */
  79. #define USB_CFG_EP3_NUMBER 3
  80. /* If the so-called endpoint 3 is used, it can now be configured to any other
  81. * endpoint number (except 0) with this macro. Default if undefined is 3.
  82. */
  83. /* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */
  84. /* The above macro defines the startup condition for data toggling on the
  85. * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
  86. * Since the token is toggled BEFORE sending any data, the first packet is
  87. * sent with the oposite value of this configuration!
  88. */
  89. #define USB_CFG_IMPLEMENT_HALT 0
  90. /* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
  91. * for endpoint 1 (interrupt endpoint). Although you may not need this feature,
  92. * it is required by the standard. We have made it a config option because it
  93. * bloats the code considerably.
  94. */
  95. #define USB_CFG_SUPPRESS_INTR_CODE 0
  96. /* Define this to 1 if you want to declare interrupt-in endpoints, but don't
  97. * want to send any data over them. If this macro is defined to 1, functions
  98. * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if
  99. * you need the interrupt-in endpoints in order to comply to an interface
  100. * (e.g. HID), but never want to send any data. This option saves a couple
  101. * of bytes in flash memory and the transmit buffers in RAM.
  102. */
  103. #define USB_CFG_INTR_POLL_INTERVAL 10
  104. /* If you compile a version with endpoint 1 (interrupt-in), this is the poll
  105. * interval. The value is in milliseconds and must not be less than 10 ms for
  106. * low speed devices.
  107. */
  108. #define USB_CFG_IS_SELF_POWERED 0
  109. /* Define this to 1 if the device has its own power supply. Set it to 0 if the
  110. * device is powered from the USB bus.
  111. */
  112. #define USB_CFG_MAX_BUS_POWER 100
  113. /* Set this variable to the maximum USB bus power consumption of your device.
  114. * The value is in milliamperes. [It will be divided by two since USB
  115. * communicates power requirements in units of 2 mA.]
  116. */
  117. #define USB_CFG_IMPLEMENT_FN_WRITE 0
  118. /* Set this to 1 if you want usbFunctionWrite() to be called for control-out
  119. * transfers. Set it to 0 if you don't need it and want to save a couple of
  120. * bytes.
  121. */
  122. #define USB_CFG_IMPLEMENT_FN_READ 0
  123. /* Set this to 1 if you need to send control replies which are generated
  124. * "on the fly" when usbFunctionRead() is called. If you only want to send
  125. * data from a static buffer, set it to 0 and return the data from
  126. * usbFunctionSetup(). This saves a couple of bytes.
  127. */
  128. #define USB_CFG_IMPLEMENT_FN_WRITEOUT 0
  129. /* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
  130. * You must implement the function usbFunctionWriteOut() which receives all
  131. * interrupt/bulk data sent to any endpoint other than 0. The endpoint number
  132. * can be found in 'usbRxToken'.
  133. */
  134. #define USB_CFG_HAVE_FLOWCONTROL 0
  135. /* Define this to 1 if you want flowcontrol over USB data. See the definition
  136. * of the macros usbDisableAllRequests() and usbEnableAllRequests() in
  137. * usbdrv.h.
  138. */
  139. #define USB_CFG_LONG_TRANSFERS 0
  140. /* Define this to 1 if you want to send/receive blocks of more than 254 bytes
  141. * in a single control-in or control-out transfer. Note that the capability
  142. * for long transfers increases the driver size.
  143. */
  144. /* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
  145. /* This macro is a hook if you want to do unconventional things. If it is
  146. * defined, it's inserted at the beginning of received message processing.
  147. * If you eat the received message and don't want default processing to
  148. * proceed, do a return after doing your things. One possible application
  149. * (besides debugging) is to flash a status LED on each packet.
  150. */
  151. /* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */
  152. /* This macro is a hook if you need to know when an USB RESET occurs. It has
  153. * one parameter which distinguishes between the start of RESET state and its
  154. * end.
  155. */
  156. /* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */
  157. /* This macro (if defined) is executed when a USB SET_ADDRESS request was
  158. * received.
  159. */
  160. #define USB_COUNT_SOF 0
  161. /* define this macro to 1 if you need the global variable "usbSofCount" which
  162. * counts SOF packets. This feature requires that the hardware interrupt is
  163. * connected to D- instead of D+.
  164. */
  165. /* #ifdef __ASSEMBLER__
  166. * macro myAssemblerMacro
  167. * in YL, TCNT0
  168. * sts timer0Snapshot, YL
  169. * endm
  170. * #endif
  171. * #define USB_SOF_HOOK myAssemblerMacro
  172. * This macro (if defined) is executed in the assembler module when a
  173. * Start Of Frame condition is detected. It is recommended to define it to
  174. * the name of an assembler macro which is defined here as well so that more
  175. * than one assembler instruction can be used. The macro may use the register
  176. * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages
  177. * immediately after an SOF pulse may be lost and must be retried by the host.
  178. * What can you do with this hook? Since the SOF signal occurs exactly every
  179. * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in
  180. * designs running on the internal RC oscillator.
  181. * Please note that Start Of Frame detection works only if D- is wired to the
  182. * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES!
  183. */
  184. #define USB_CFG_CHECK_DATA_TOGGLING 0
  185. /* define this macro to 1 if you want to filter out duplicate data packets
  186. * sent by the host. Duplicates occur only as a consequence of communication
  187. * errors, when the host does not receive an ACK. Please note that you need to
  188. * implement the filtering yourself in usbFunctionWriteOut() and
  189. * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable
  190. * for each control- and out-endpoint to check for duplicate packets.
  191. */
  192. #define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0
  193. /* define this macro to 1 if you want the function usbMeasureFrameLength()
  194. * compiled in. This function can be used to calibrate the AVR's RC oscillator.
  195. */
  196. /* -------------------------- Device Description --------------------------- */
  197. #define USB_CFG_VENDOR_ID 0xc0, 0x16
  198. /* USB vendor ID for the device, low byte first. If you have registered your
  199. * own Vendor ID, define it here. Otherwise you use one of obdev's free shared
  200. * VID/PID pairs. Be sure to read USBID-License.txt for rules!
  201. * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc.
  202. * + Use this VID/PID pair ONLY if you understand the implications!
  203. */
  204. #define USB_CFG_DEVICE_ID 0xdc, 0x05
  205. /* This is the ID of the product, low byte first. It is interpreted in the
  206. * scope of the vendor ID. If you have registered your own VID with usb.org
  207. * or if you have licensed a PID from somebody else, define it here. Otherwise
  208. * you use obdev's free shared VID/PID pair. Be sure to read the rules in
  209. * USBID-License.txt!
  210. * + This template uses obdev's shared VID/PID pair: 0x16c0/0x5dc.
  211. * + Use this VID/PID pair ONLY if you understand the implications!
  212. */
  213. #define USB_CFG_DEVICE_VERSION 0x00, 0x01
  214. /* Version number of the device: Minor number first, then major number.
  215. */
  216. #define USB_CFG_VENDOR_NAME 'o', 'b', 'd', 'e', 'v', '.', 'a', 't'
  217. #define USB_CFG_VENDOR_NAME_LEN 8
  218. /* These two values define the vendor name returned by the USB device. The name
  219. * must be given as a list of characters under single quotes. The characters
  220. * are interpreted as Unicode (UTF-16) entities.
  221. * If you don't want a vendor name string, undefine these macros.
  222. * ALWAYS define a vendor name containing your Internet domain name if you use
  223. * obdev's free shared VID/PID pair. See the file USBID-License.txt for
  224. * details.
  225. */
  226. #define USB_CFG_DEVICE_NAME 'T', 'e', 'm', 'p', 'l', 'a', 't', 'e'
  227. #define USB_CFG_DEVICE_NAME_LEN 8
  228. /* Same as above for the device name. If you don't want a device name, undefine
  229. * the macros. See the file USBID-License.txt before you assign a name if you
  230. * use a shared VID/PID.
  231. */
  232. /*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */
  233. /*#define USB_CFG_SERIAL_NUMBER_LEN 0 */
  234. /* Same as above for the serial number. If you don't want a serial number,
  235. * undefine the macros.
  236. * It may be useful to provide the serial number through other means than at
  237. * compile time. See the section about descriptor properties below for how
  238. * to fine tune control over USB descriptors such as the string descriptor
  239. * for the serial number.
  240. */
  241. #define USB_CFG_DEVICE_CLASS 0xff /* set to 0 if deferred to interface */
  242. #define USB_CFG_DEVICE_SUBCLASS 0
  243. /* See USB specification if you want to conform to an existing device class.
  244. * Class 0xff is "vendor specific".
  245. */
  246. #define USB_CFG_INTERFACE_CLASS 0 /* define class here if not at device level */
  247. #define USB_CFG_INTERFACE_SUBCLASS 0
  248. #define USB_CFG_INTERFACE_PROTOCOL 0
  249. /* See USB specification if you want to conform to an existing device class or
  250. * protocol. The following classes must be set at interface level:
  251. * HID class is 3, no subclass and protocol required (but may be useful!)
  252. * CDC class is 2, use subclass 2 and protocol 1 for ACM
  253. */
  254. /* #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 42 */
  255. /* Define this to the length of the HID report descriptor, if you implement
  256. * an HID device. Otherwise don't define it or define it to 0.
  257. * If you use this define, you must add a PROGMEM character array named
  258. * "usbHidReportDescriptor" to your code which contains the report descriptor.
  259. * Don't forget to keep the array and this define in sync!
  260. */
  261. /* #define USB_PUBLIC static */
  262. /* Use the define above if you #include usbdrv.c instead of linking against it.
  263. * This technique saves a couple of bytes in flash memory.
  264. */
  265. /* ------------------- Fine Control over USB Descriptors ------------------- */
  266. /* If you don't want to use the driver's default USB descriptors, you can
  267. * provide our own. These can be provided as (1) fixed length static data in
  268. * flash memory, (2) fixed length static data in RAM or (3) dynamically at
  269. * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
  270. * information about this function.
  271. * Descriptor handling is configured through the descriptor's properties. If
  272. * no properties are defined or if they are 0, the default descriptor is used.
  273. * Possible properties are:
  274. * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
  275. * at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is
  276. * used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if
  277. * you want RAM pointers.
  278. * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
  279. * in static memory is in RAM, not in flash memory.
  280. * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
  281. * the driver must know the descriptor's length. The descriptor itself is
  282. * found at the address of a well known identifier (see below).
  283. * List of static descriptor names (must be declared PROGMEM if in flash):
  284. * char usbDescriptorDevice[];
  285. * char usbDescriptorConfiguration[];
  286. * char usbDescriptorHidReport[];
  287. * char usbDescriptorString0[];
  288. * int usbDescriptorStringVendor[];
  289. * int usbDescriptorStringDevice[];
  290. * int usbDescriptorStringSerialNumber[];
  291. * Other descriptors can't be provided statically, they must be provided
  292. * dynamically at runtime.
  293. *
  294. * Descriptor properties are or-ed or added together, e.g.:
  295. * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
  296. *
  297. * The following descriptors are defined:
  298. * USB_CFG_DESCR_PROPS_DEVICE
  299. * USB_CFG_DESCR_PROPS_CONFIGURATION
  300. * USB_CFG_DESCR_PROPS_STRINGS
  301. * USB_CFG_DESCR_PROPS_STRING_0
  302. * USB_CFG_DESCR_PROPS_STRING_VENDOR
  303. * USB_CFG_DESCR_PROPS_STRING_PRODUCT
  304. * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
  305. * USB_CFG_DESCR_PROPS_HID
  306. * USB_CFG_DESCR_PROPS_HID_REPORT
  307. * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
  308. *
  309. * Note about string descriptors: String descriptors are not just strings, they
  310. * are Unicode strings prefixed with a 2 byte header. Example:
  311. * int serialNumberDescriptor[] = {
  312. * USB_STRING_DESCRIPTOR_HEADER(6),
  313. * 'S', 'e', 'r', 'i', 'a', 'l'
  314. * };
  315. */
  316. #define USB_CFG_DESCR_PROPS_DEVICE 0
  317. #define USB_CFG_DESCR_PROPS_CONFIGURATION 0
  318. #define USB_CFG_DESCR_PROPS_STRINGS 0
  319. #define USB_CFG_DESCR_PROPS_STRING_0 0
  320. #define USB_CFG_DESCR_PROPS_STRING_VENDOR 0
  321. #define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0
  322. #define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0
  323. #define USB_CFG_DESCR_PROPS_HID 0
  324. #define USB_CFG_DESCR_PROPS_HID_REPORT 0
  325. #define USB_CFG_DESCR_PROPS_UNKNOWN 0
  326. /* ----------------------- Optional MCU Description ------------------------ */
  327. /* The following configurations have working defaults in usbdrv.h. You
  328. * usually don't need to set them explicitly. Only if you want to run
  329. * the driver on a device which is not yet supported or with a compiler
  330. * which is not fully supported (such as IAR C) or if you use a differnt
  331. * interrupt than INT0, you may have to define some of these.
  332. */
  333. /* #define USB_INTR_CFG MCUCR */
  334. /* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */
  335. /* #define USB_INTR_CFG_CLR 0 */
  336. /* #define USB_INTR_ENABLE GIMSK */
  337. /* #define USB_INTR_ENABLE_BIT INT0 */
  338. /* #define USB_INTR_PENDING GIFR */
  339. /* #define USB_INTR_PENDING_BIT INTF0 */
  340. /* #define USB_INTR_VECTOR SIG_INTERRUPT0 */
  341. #endif /* __usbconfig_h_included__ */