usbconfig.h 14 KB

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