usbconfig.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. /* Name: usbconfig.h
  2. * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers
  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 785 2010-05-30 17:57:07Z cs $
  9. */
  10. #pragma once
  11. // clang-format off
  12. /*
  13. General Description:
  14. This file is an example configuration (with inline documentation) for the USB
  15. driver. It configures V-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. */
  21. /* ---------------------------- Hardware Config ---------------------------- */
  22. #ifndef USB_CFG_IOPORTNAME
  23. #define USB_CFG_IOPORTNAME D
  24. #endif
  25. /* This is the port where the USB bus is connected. When you configure it to
  26. * "B", the registers PORTB, PINB and DDRB will be used.
  27. */
  28. #ifndef USB_CFG_DMINUS_BIT
  29. #define USB_CFG_DMINUS_BIT 3
  30. #endif
  31. /* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
  32. * This may be any bit in the port.
  33. */
  34. #ifndef USB_CFG_DPLUS_BIT
  35. #define USB_CFG_DPLUS_BIT 2
  36. #endif
  37. /* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
  38. * This may be any bit in the port. Please note that D+ must also be connected
  39. * to interrupt pin INT0! [You can also use other interrupts, see section
  40. * "Optional MCU Description" below, or you can connect D- to the interrupt, as
  41. * it is required if you use the USB_COUNT_SOF feature. If you use D- for the
  42. * interrupt, the USB interrupt will also be triggered at Start-Of-Frame
  43. * markers every millisecond.]
  44. */
  45. #define USB_CFG_CHECK_CRC 0
  46. /* Define this to 1 if you want that the driver checks integrity of incoming
  47. * data packets (CRC checks). CRC checks cost quite a bit of code size and are
  48. * currently only available for 18 MHz crystal clock. You must choose
  49. * USB_CFG_CLOCK_KHZ = 18000 if you enable this option.
  50. */
  51. /* ----------------------- Optional Hardware Config ------------------------ */
  52. /* #define USB_CFG_PULLUP_IOPORTNAME D */
  53. /* If you connect the 1.5k pullup resistor from D- to a port pin instead of
  54. * V+, you can connect and disconnect the device from firmware by calling
  55. * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
  56. * This constant defines the port on which the pullup resistor is connected.
  57. */
  58. /* #define USB_CFG_PULLUP_BIT 4 */
  59. /* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
  60. * above) where the 1.5k pullup resistor is connected. See description
  61. * above for details.
  62. */
  63. /* --------------------------- Functional Range ---------------------------- */
  64. #define USB_CFG_HAVE_INTRIN_ENDPOINT 1
  65. /* Define this to 1 if you want to compile a version with two endpoints: The
  66. * default control endpoint 0 and an interrupt-in endpoint (any other endpoint
  67. * number).
  68. */
  69. #define USB_CFG_HAVE_INTRIN_ENDPOINT3 1
  70. /* Define this to 1 if you want to compile a version with three endpoints: The
  71. * default control endpoint 0, an interrupt-in endpoint 3 (or the number
  72. * configured below) and a catch-all default interrupt-in endpoint as above.
  73. * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
  74. */
  75. #define USB_CFG_EP3_NUMBER 3
  76. /* If the so-called endpoint 3 is used, it can now be configured to any other
  77. * endpoint number (except 0) with this macro. Default if undefined is 3.
  78. */
  79. /* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */
  80. /* The above macro defines the startup condition for data toggling on the
  81. * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
  82. * Since the token is toggled BEFORE sending any data, the first packet is
  83. * sent with the oposite value of this configuration!
  84. */
  85. #define USB_CFG_IMPLEMENT_HALT 0
  86. /* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
  87. * for endpoint 1 (interrupt endpoint). Although you may not need this feature,
  88. * it is required by the standard. We have made it a config option because it
  89. * bloats the code considerably.
  90. */
  91. #define USB_CFG_SUPPRESS_INTR_CODE 0
  92. /* Define this to 1 if you want to declare interrupt-in endpoints, but don't
  93. * want to send any data over them. If this macro is defined to 1, functions
  94. * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if
  95. * you need the interrupt-in endpoints in order to comply to an interface
  96. * (e.g. HID), but never want to send any data. This option saves a couple
  97. * of bytes in flash memory and the transmit buffers in RAM.
  98. */
  99. #define USB_CFG_IS_SELF_POWERED 0
  100. /* Define this to 1 if the device has its own power supply. Set it to 0 if the
  101. * device is powered from the USB bus.
  102. */
  103. #define USB_CFG_IMPLEMENT_FN_WRITE 1
  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 1
  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_DRIVER_FLASH_PAGE 0
  126. /* If the device has more than 64 kBytes of flash, define this to the 64 k page
  127. * where the driver's constants (descriptors) are located. Or in other words:
  128. * Define this to 1 for boot loaders on the ATMega128.
  129. */
  130. #define USB_CFG_LONG_TRANSFERS 0
  131. /* Define this to 1 if you want to send/receive blocks of more than 254 bytes
  132. * in a single control-in or control-out transfer. Note that the capability
  133. * for long transfers increases the driver size.
  134. */
  135. /* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
  136. /* This macro is a hook if you want to do unconventional things. If it is
  137. * defined, it's inserted at the beginning of received message processing.
  138. * If you eat the received message and don't want default processing to
  139. * proceed, do a return after doing your things. One possible application
  140. * (besides debugging) is to flash a status LED on each packet.
  141. */
  142. /* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */
  143. /* This macro is a hook if you need to know when an USB RESET occurs. It has
  144. * one parameter which distinguishes between the start of RESET state and its
  145. * end.
  146. */
  147. /* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */
  148. /* This macro (if defined) is executed when a USB SET_ADDRESS request was
  149. * received.
  150. */
  151. #ifndef USB_COUNT_SOF
  152. #define USB_COUNT_SOF 1
  153. #endif
  154. /* define this macro to 1 if you need the global variable "usbSofCount" which
  155. * counts SOF packets. This feature requires that the hardware interrupt is
  156. * connected to D- instead of D+.
  157. */
  158. /* #ifdef __ASSEMBLER__
  159. * macro myAssemblerMacro
  160. * in YL, TCNT0
  161. * sts timer0Snapshot, YL
  162. * endm
  163. * #endif
  164. * #define USB_SOF_HOOK myAssemblerMacro
  165. * This macro (if defined) is executed in the assembler module when a
  166. * Start Of Frame condition is detected. It is recommended to define it to
  167. * the name of an assembler macro which is defined here as well so that more
  168. * than one assembler instruction can be used. The macro may use the register
  169. * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages
  170. * immediately after an SOF pulse may be lost and must be retried by the host.
  171. * What can you do with this hook? Since the SOF signal occurs exactly every
  172. * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in
  173. * designs running on the internal RC oscillator.
  174. * Please note that Start Of Frame detection works only if D- is wired to the
  175. * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES!
  176. */
  177. #define USB_CFG_CHECK_DATA_TOGGLING 0
  178. /* define this macro to 1 if you want to filter out duplicate data packets
  179. * sent by the host. Duplicates occur only as a consequence of communication
  180. * errors, when the host does not receive an ACK. Please note that you need to
  181. * implement the filtering yourself in usbFunctionWriteOut() and
  182. * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable
  183. * for each control- and out-endpoint to check for duplicate packets.
  184. */
  185. #define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0
  186. /* define this macro to 1 if you want the function usbMeasureFrameLength()
  187. * compiled in. This function can be used to calibrate the AVR's RC oscillator.
  188. */
  189. #define USB_USE_FAST_CRC 0
  190. /* The assembler module has two implementations for the CRC algorithm. One is
  191. * faster, the other is smaller. This CRC routine is only used for transmitted
  192. * messages where timing is not critical. The faster routine needs 31 cycles
  193. * per byte while the smaller one needs 61 to 69 cycles. The faster routine
  194. * may be worth the 32 bytes bigger code size if you transmit lots of data and
  195. * run the AVR close to its limit.
  196. */
  197. /* -------------------------- Device Description --------------------------- */
  198. #define USB_CFG_VENDOR_ID
  199. /* USB vendor ID for the device, low byte first. If you have registered your
  200. * own Vendor ID, define it here. Otherwise you may use one of obdev's free
  201. * shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules!
  202. * *** IMPORTANT NOTE ***
  203. * This template uses obdev's shared VID/PID pair for Vendor Class devices
  204. * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand
  205. * the implications!
  206. */
  207. #define USB_CFG_DEVICE_ID
  208. /* This is the ID of the product, low byte first. It is interpreted in the
  209. * scope of the vendor ID. If you have registered your own VID with usb.org
  210. * or if you have licensed a PID from somebody else, define it here. Otherwise
  211. * you may use one of obdev's free shared VID/PID pairs. See the file
  212. * USB-IDs-for-free.txt for details!
  213. * *** IMPORTANT NOTE ***
  214. * This template uses obdev's shared VID/PID pair for Vendor Class devices
  215. * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand
  216. * the implications!
  217. */
  218. #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 0
  219. /* Define this to the length of the HID report descriptor, if you implement
  220. * an HID device. Otherwise don't define it or define it to 0.
  221. * If you use this define, you must add a PROGMEM character array named
  222. * "usbHidReportDescriptor" to your code which contains the report descriptor.
  223. * Don't forget to keep the array and this define in sync!
  224. */
  225. /* #define USB_PUBLIC static */
  226. /* Use the define above if you #include usbdrv.c instead of linking against it.
  227. * This technique saves a couple of bytes in flash memory.
  228. */
  229. /* ------------------- Fine Control over USB Descriptors ------------------- */
  230. /* If you don't want to use the driver's default USB descriptors, you can
  231. * provide our own. These can be provided as (1) fixed length static data in
  232. * flash memory, (2) fixed length static data in RAM or (3) dynamically at
  233. * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
  234. * information about this function.
  235. * Descriptor handling is configured through the descriptor's properties. If
  236. * no properties are defined or if they are 0, the default descriptor is used.
  237. * Possible properties are:
  238. * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
  239. * at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is
  240. * used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if
  241. * you want RAM pointers.
  242. * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
  243. * in static memory is in RAM, not in flash memory.
  244. * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
  245. * the driver must know the descriptor's length. The descriptor itself is
  246. * found at the address of a well known identifier (see below).
  247. * List of static descriptor names (must be declared PROGMEM if in flash):
  248. * char usbDescriptorDevice[];
  249. * char usbDescriptorConfiguration[];
  250. * char usbDescriptorHidReport[];
  251. * char usbDescriptorString0[];
  252. * int usbDescriptorStringVendor[];
  253. * int usbDescriptorStringDevice[];
  254. * int usbDescriptorStringSerialNumber[];
  255. * Other descriptors can't be provided statically, they must be provided
  256. * dynamically at runtime.
  257. *
  258. * Descriptor properties are or-ed or added together, e.g.:
  259. * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
  260. *
  261. * The following descriptors are defined:
  262. * USB_CFG_DESCR_PROPS_DEVICE
  263. * USB_CFG_DESCR_PROPS_CONFIGURATION
  264. * USB_CFG_DESCR_PROPS_STRINGS
  265. * USB_CFG_DESCR_PROPS_STRING_0
  266. * USB_CFG_DESCR_PROPS_STRING_VENDOR
  267. * USB_CFG_DESCR_PROPS_STRING_PRODUCT
  268. * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
  269. * USB_CFG_DESCR_PROPS_HID
  270. * USB_CFG_DESCR_PROPS_HID_REPORT
  271. * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
  272. *
  273. * Note about string descriptors: String descriptors are not just strings, they
  274. * are Unicode strings prefixed with a 2 byte header. Example:
  275. * int serialNumberDescriptor[] = {
  276. * USB_STRING_DESCRIPTOR_HEADER(6),
  277. * 'S', 'e', 'r', 'i', 'a', 'l'
  278. * };
  279. */
  280. #define USB_CFG_DESCR_PROPS_DEVICE USB_PROP_IS_DYNAMIC
  281. #define USB_CFG_DESCR_PROPS_CONFIGURATION USB_PROP_IS_DYNAMIC
  282. #define USB_CFG_DESCR_PROPS_STRINGS USB_PROP_IS_DYNAMIC
  283. #define USB_CFG_DESCR_PROPS_STRING_0 USB_PROP_IS_DYNAMIC
  284. #define USB_CFG_DESCR_PROPS_STRING_VENDOR USB_PROP_IS_DYNAMIC
  285. #define USB_CFG_DESCR_PROPS_STRING_PRODUCT USB_PROP_IS_DYNAMIC
  286. #define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER USB_PROP_IS_DYNAMIC
  287. #define USB_CFG_DESCR_PROPS_HID USB_PROP_IS_DYNAMIC
  288. #define USB_CFG_DESCR_PROPS_HID_REPORT USB_PROP_IS_DYNAMIC
  289. #define USB_CFG_DESCR_PROPS_UNKNOWN 0
  290. #define usbMsgPtr_t unsigned short
  291. /* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to
  292. * a scalar type here because gcc generates slightly shorter code for scalar
  293. * arithmetics than for pointer arithmetics. Remove this define for backward
  294. * type compatibility or define it to an 8 bit type if you use data in RAM only
  295. * and all RAM is below 256 bytes (tiny memory model in IAR CC).
  296. */
  297. /* ----------------------- Optional MCU Description ------------------------ */
  298. /* The following configurations have working defaults in usbdrv.h. You
  299. * usually don't need to set them explicitly. Only if you want to run
  300. * the driver on a device which is not yet supported or with a compiler
  301. * which is not fully supported (such as IAR C) or if you use a differnt
  302. * interrupt than INT0, you may have to define some of these.
  303. */
  304. /* #define USB_INTR_CFG MCUCR */
  305. /* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */
  306. /* #define USB_INTR_CFG_CLR 0 */
  307. /* #define USB_INTR_ENABLE GIMSK */
  308. /* #define USB_INTR_ENABLE_BIT INT0 */
  309. /* #define USB_INTR_PENDING GIFR */
  310. /* #define USB_INTR_PENDING_BIT INTF0 */
  311. /* #define USB_INTR_VECTOR INT0_vect */
  312. /* Set INT1 for D- falling edge to count SOF */
  313. /* #define USB_INTR_CFG EICRA */
  314. #ifndef USB_INTR_CFG_SET
  315. #define USB_INTR_CFG_SET ((1 << ISC11) | (0 << ISC10))
  316. #endif
  317. /* #define USB_INTR_CFG_CLR 0 */
  318. /* #define USB_INTR_ENABLE EIMSK */
  319. #ifndef USB_INTR_ENABLE_BIT
  320. #define USB_INTR_ENABLE_BIT INT1
  321. #endif
  322. /* #define USB_INTR_PENDING EIFR */
  323. #ifndef USB_INTR_PENDING_BIT
  324. #define USB_INTR_PENDING_BIT INTF1
  325. #endif
  326. #ifndef USB_INTR_VECTOR
  327. #define USB_INTR_VECTOR INT1_vect
  328. #endif