usbconfig.h 18 KB

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