usbconfig_new.c 17 KB

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