usbconfig.h 17 KB

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