You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

descriptor.c 21KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571
  1. /*
  2. * Copyright 2012 Jun Wako <[email protected]>
  3. * This file is based on:
  4. * LUFA-120219/Demos/Device/Lowlevel/KeyboardMouse
  5. * LUFA-120219/Demos/Device/Lowlevel/GenericHID
  6. */
  7. /*
  8. LUFA Library
  9. Copyright (C) Dean Camera, 2012.
  10. dean [at] fourwalledcubicle [dot] com
  11. www.lufa-lib.org
  12. */
  13. /*
  14. Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  15. Copyright 2010 Denver Gingerich (denver [at] ossguy [dot] com)
  16. Permission to use, copy, modify, distribute, and sell this
  17. software and its documentation for any purpose is hereby granted
  18. without fee, provided that the above copyright notice appear in
  19. all copies and that both that the copyright notice and this
  20. permission notice and warranty disclaimer appear in supporting
  21. documentation, and that the name of the author not be used in
  22. advertising or publicity pertaining to distribution of the
  23. software without specific, written prior permission.
  24. The author disclaim all warranties with regard to this
  25. software, including all implied warranties of merchantability
  26. and fitness. In no event shall the author be liable for any
  27. special, indirect or consequential damages or any damages
  28. whatsoever resulting from loss of use, data or profits, whether
  29. in an action of contract, negligence or other tortious action,
  30. arising out of or in connection with the use or performance of
  31. this software.
  32. */
  33. #include "util.h"
  34. #include "report.h"
  35. #include "descriptor.h"
  36. /*******************************************************************************
  37. * HID Report Descriptors
  38. ******************************************************************************/
  39. const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
  40. {
  41. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  42. HID_RI_USAGE(8, 0x06), /* Keyboard */
  43. HID_RI_COLLECTION(8, 0x01), /* Application */
  44. HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
  45. HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
  46. HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
  47. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  48. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  49. HID_RI_REPORT_COUNT(8, 0x08),
  50. HID_RI_REPORT_SIZE(8, 0x01),
  51. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  52. HID_RI_REPORT_COUNT(8, 0x01),
  53. HID_RI_REPORT_SIZE(8, 0x08),
  54. HID_RI_INPUT(8, HID_IOF_CONSTANT),
  55. HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
  56. HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
  57. HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
  58. HID_RI_REPORT_COUNT(8, 0x05),
  59. HID_RI_REPORT_SIZE(8, 0x01),
  60. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  61. HID_RI_REPORT_COUNT(8, 0x01),
  62. HID_RI_REPORT_SIZE(8, 0x03),
  63. HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
  64. HID_RI_USAGE_PAGE(8, 0x07), /* Keyboard */
  65. HID_RI_USAGE_MINIMUM(8, 0x00), /* Reserved (no event indicated) */
  66. HID_RI_USAGE_MAXIMUM(8, 0xFF), /* Keyboard Application */
  67. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  68. HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
  69. HID_RI_REPORT_COUNT(8, 0x06),
  70. HID_RI_REPORT_SIZE(8, 0x08),
  71. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  72. HID_RI_END_COLLECTION(0),
  73. };
  74. #ifdef MOUSE_ENABLE
  75. const USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
  76. {
  77. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  78. HID_RI_USAGE(8, 0x02), /* Mouse */
  79. HID_RI_COLLECTION(8, 0x01), /* Application */
  80. HID_RI_USAGE(8, 0x01), /* Pointer */
  81. HID_RI_COLLECTION(8, 0x00), /* Physical */
  82. HID_RI_USAGE_PAGE(8, 0x09), /* Button */
  83. HID_RI_USAGE_MINIMUM(8, 0x01), /* Button 1 */
  84. HID_RI_USAGE_MAXIMUM(8, 0x05), /* Button 5 */
  85. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  86. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  87. HID_RI_REPORT_COUNT(8, 0x05),
  88. HID_RI_REPORT_SIZE(8, 0x01),
  89. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  90. HID_RI_REPORT_COUNT(8, 0x01),
  91. HID_RI_REPORT_SIZE(8, 0x03),
  92. HID_RI_INPUT(8, HID_IOF_CONSTANT),
  93. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  94. HID_RI_USAGE(8, 0x30), /* Usage X */
  95. HID_RI_USAGE(8, 0x31), /* Usage Y */
  96. HID_RI_LOGICAL_MINIMUM(8, -127),
  97. HID_RI_LOGICAL_MAXIMUM(8, 127),
  98. HID_RI_REPORT_COUNT(8, 0x02),
  99. HID_RI_REPORT_SIZE(8, 0x08),
  100. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  101. HID_RI_USAGE(8, 0x38), /* Wheel */
  102. HID_RI_LOGICAL_MINIMUM(8, -127),
  103. HID_RI_LOGICAL_MAXIMUM(8, 127),
  104. HID_RI_REPORT_COUNT(8, 0x01),
  105. HID_RI_REPORT_SIZE(8, 0x08),
  106. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  107. HID_RI_USAGE_PAGE(8, 0x0C), /* Consumer */
  108. HID_RI_USAGE(16, 0x0238), /* AC Pan (Horizontal wheel) */
  109. HID_RI_LOGICAL_MINIMUM(8, -127),
  110. HID_RI_LOGICAL_MAXIMUM(8, 127),
  111. HID_RI_REPORT_COUNT(8, 0x01),
  112. HID_RI_REPORT_SIZE(8, 0x08),
  113. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  114. HID_RI_END_COLLECTION(0),
  115. HID_RI_END_COLLECTION(0),
  116. };
  117. #endif
  118. #ifdef EXTRAKEY_ENABLE
  119. const USB_Descriptor_HIDReport_Datatype_t PROGMEM ExtrakeyReport[] =
  120. {
  121. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  122. HID_RI_USAGE(8, 0x80), /* System Control */
  123. HID_RI_COLLECTION(8, 0x01), /* Application */
  124. HID_RI_REPORT_ID(8, REPORT_ID_SYSTEM),
  125. HID_RI_LOGICAL_MINIMUM(16, 0x0001),
  126. HID_RI_LOGICAL_MAXIMUM(16, 0x00B7),
  127. HID_RI_USAGE_MINIMUM(16, 0x0001), /* System Power Down */
  128. HID_RI_USAGE_MAXIMUM(16, 0x00B7), /* System Display LCD Autoscale */
  129. HID_RI_REPORT_SIZE(8, 16),
  130. HID_RI_REPORT_COUNT(8, 1),
  131. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  132. HID_RI_END_COLLECTION(0),
  133. HID_RI_USAGE_PAGE(8, 0x0C), /* Consumer */
  134. HID_RI_USAGE(8, 0x01), /* Consumer Control */
  135. HID_RI_COLLECTION(8, 0x01), /* Application */
  136. HID_RI_REPORT_ID(8, REPORT_ID_CONSUMER),
  137. HID_RI_LOGICAL_MINIMUM(16, 0x0001),
  138. HID_RI_LOGICAL_MAXIMUM(16, 0x029C),
  139. HID_RI_USAGE_MINIMUM(16, 0x0001), /* +10 */
  140. HID_RI_USAGE_MAXIMUM(16, 0x029C), /* AC Distribute Vertically */
  141. HID_RI_REPORT_SIZE(8, 16),
  142. HID_RI_REPORT_COUNT(8, 1),
  143. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  144. HID_RI_END_COLLECTION(0),
  145. };
  146. #endif
  147. #ifdef CONSOLE_ENABLE
  148. const USB_Descriptor_HIDReport_Datatype_t PROGMEM ConsoleReport[] =
  149. {
  150. HID_RI_USAGE_PAGE(16, 0xFF31), /* Vendor Page(PJRC Teensy compatible) */
  151. HID_RI_USAGE(8, 0x74), /* Vendor Usage(PJRC Teensy compatible) */
  152. HID_RI_COLLECTION(8, 0x01), /* Application */
  153. HID_RI_USAGE(8, 0x75), /* Vendor Usage 0x75 */
  154. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  155. HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
  156. HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
  157. HID_RI_REPORT_SIZE(8, 0x08),
  158. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  159. HID_RI_USAGE(8, 0x76), /* Vendor Usage 0x76 */
  160. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  161. HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
  162. HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
  163. HID_RI_REPORT_SIZE(8, 0x08),
  164. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  165. HID_RI_END_COLLECTION(0),
  166. };
  167. #endif
  168. #ifdef NKRO_ENABLE
  169. const USB_Descriptor_HIDReport_Datatype_t PROGMEM NKROReport[] =
  170. {
  171. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  172. HID_RI_USAGE(8, 0x06), /* Keyboard */
  173. HID_RI_COLLECTION(8, 0x01), /* Application */
  174. HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
  175. HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
  176. HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
  177. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  178. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  179. HID_RI_REPORT_COUNT(8, 0x08),
  180. HID_RI_REPORT_SIZE(8, 0x01),
  181. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  182. HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
  183. HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
  184. HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
  185. HID_RI_REPORT_COUNT(8, 0x05),
  186. HID_RI_REPORT_SIZE(8, 0x01),
  187. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  188. HID_RI_REPORT_COUNT(8, 0x01),
  189. HID_RI_REPORT_SIZE(8, 0x03),
  190. HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
  191. HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
  192. HID_RI_USAGE_MINIMUM(8, 0x00), /* Keyboard 0 */
  193. HID_RI_USAGE_MAXIMUM(8, NKRO_SIZE*8-1), /* Keyboard Right GUI */
  194. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  195. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  196. HID_RI_REPORT_COUNT(8, NKRO_SIZE*8),
  197. HID_RI_REPORT_SIZE(8, 0x01),
  198. };
  199. #endif
  200. /*******************************************************************************
  201. * Device Descriptors
  202. ******************************************************************************/
  203. const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  204. {
  205. .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  206. .USBSpecification = VERSION_BCD(01.10),
  207. .Class = USB_CSCP_NoDeviceClass,
  208. .SubClass = USB_CSCP_NoDeviceSubclass,
  209. .Protocol = USB_CSCP_NoDeviceProtocol,
  210. .Endpoint0Size = 8,
  211. /* specified in config.h */
  212. .VendorID = VENDOR_ID,
  213. .ProductID = PRODUCT_ID,
  214. .ReleaseNumber = DEVICE_VER,
  215. .ManufacturerStrIndex = 0x01,
  216. .ProductStrIndex = 0x02,
  217. .SerialNumStrIndex = NO_DESCRIPTOR,
  218. .NumberOfConfigurations = 1
  219. };
  220. /*******************************************************************************
  221. * Configuration Descriptors
  222. ******************************************************************************/
  223. const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  224. {
  225. .Config =
  226. {
  227. .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  228. .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  229. .TotalInterfaces = TOTAL_INTERFACES,
  230. .ConfigurationNumber = 1,
  231. .ConfigurationStrIndex = NO_DESCRIPTOR,
  232. .ConfigAttributes = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_REMOTEWAKEUP),
  233. .MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
  234. },
  235. /*
  236. * Keyboard
  237. */
  238. .Keyboard_Interface =
  239. {
  240. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  241. .InterfaceNumber = KEYBOARD_INTERFACE,
  242. .AlternateSetting = 0x00,
  243. .TotalEndpoints = 1,
  244. .Class = HID_CSCP_HIDClass,
  245. .SubClass = HID_CSCP_BootSubclass,
  246. .Protocol = HID_CSCP_KeyboardBootProtocol,
  247. .InterfaceStrIndex = NO_DESCRIPTOR
  248. },
  249. .Keyboard_HID =
  250. {
  251. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  252. .HIDSpec = VERSION_BCD(01.11),
  253. .CountryCode = 0x00,
  254. .TotalReportDescriptors = 1,
  255. .HIDReportType = HID_DTYPE_Report,
  256. .HIDReportLength = sizeof(KeyboardReport)
  257. },
  258. .Keyboard_INEndpoint =
  259. {
  260. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  261. .EndpointAddress = (ENDPOINT_DIR_IN | KEYBOARD_IN_EPNUM),
  262. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  263. .EndpointSize = KEYBOARD_EPSIZE,
  264. .PollingIntervalMS = 0x01
  265. },
  266. /*
  267. * Mouse
  268. */
  269. #ifdef MOUSE_ENABLE
  270. .Mouse_Interface =
  271. {
  272. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  273. .InterfaceNumber = MOUSE_INTERFACE,
  274. .AlternateSetting = 0x00,
  275. .TotalEndpoints = 1,
  276. .Class = HID_CSCP_HIDClass,
  277. .SubClass = HID_CSCP_BootSubclass,
  278. .Protocol = HID_CSCP_MouseBootProtocol,
  279. .InterfaceStrIndex = NO_DESCRIPTOR
  280. },
  281. .Mouse_HID =
  282. {
  283. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  284. .HIDSpec = VERSION_BCD(01.11),
  285. .CountryCode = 0x00,
  286. .TotalReportDescriptors = 1,
  287. .HIDReportType = HID_DTYPE_Report,
  288. .HIDReportLength = sizeof(MouseReport)
  289. },
  290. .Mouse_INEndpoint =
  291. {
  292. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  293. .EndpointAddress = (ENDPOINT_DIR_IN | MOUSE_IN_EPNUM),
  294. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  295. .EndpointSize = MOUSE_EPSIZE,
  296. .PollingIntervalMS = 0x01
  297. },
  298. #endif
  299. /*
  300. * Extra
  301. */
  302. #ifdef EXTRAKEY_ENABLE
  303. .Extrakey_Interface =
  304. {
  305. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  306. .InterfaceNumber = EXTRAKEY_INTERFACE,
  307. .AlternateSetting = 0x00,
  308. .TotalEndpoints = 1,
  309. .Class = HID_CSCP_HIDClass,
  310. .SubClass = HID_CSCP_NonBootSubclass,
  311. .Protocol = HID_CSCP_NonBootProtocol,
  312. .InterfaceStrIndex = NO_DESCRIPTOR
  313. },
  314. .Extrakey_HID =
  315. {
  316. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  317. .HIDSpec = VERSION_BCD(01.11),
  318. .CountryCode = 0x00,
  319. .TotalReportDescriptors = 1,
  320. .HIDReportType = HID_DTYPE_Report,
  321. .HIDReportLength = sizeof(ExtrakeyReport)
  322. },
  323. .Extrakey_INEndpoint =
  324. {
  325. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  326. .EndpointAddress = (ENDPOINT_DIR_IN | EXTRAKEY_IN_EPNUM),
  327. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  328. .EndpointSize = EXTRAKEY_EPSIZE,
  329. .PollingIntervalMS = 0x01
  330. },
  331. #endif
  332. /*
  333. * Console
  334. */
  335. #ifdef CONSOLE_ENABLE
  336. .Console_Interface =
  337. {
  338. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  339. .InterfaceNumber = CONSOLE_INTERFACE,
  340. .AlternateSetting = 0x00,
  341. .TotalEndpoints = 2,
  342. .Class = HID_CSCP_HIDClass,
  343. .SubClass = HID_CSCP_NonBootSubclass,
  344. .Protocol = HID_CSCP_NonBootProtocol,
  345. .InterfaceStrIndex = NO_DESCRIPTOR
  346. },
  347. .Console_HID =
  348. {
  349. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  350. .HIDSpec = VERSION_BCD(01.11),
  351. .CountryCode = 0x00,
  352. .TotalReportDescriptors = 1,
  353. .HIDReportType = HID_DTYPE_Report,
  354. .HIDReportLength = sizeof(ConsoleReport)
  355. },
  356. .Console_INEndpoint =
  357. {
  358. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  359. .EndpointAddress = (ENDPOINT_DIR_IN | CONSOLE_IN_EPNUM),
  360. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  361. .EndpointSize = CONSOLE_EPSIZE,
  362. .PollingIntervalMS = 0x01
  363. },
  364. .Console_OUTEndpoint =
  365. {
  366. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  367. .EndpointAddress = (ENDPOINT_DIR_OUT | CONSOLE_OUT_EPNUM),
  368. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  369. .EndpointSize = CONSOLE_EPSIZE,
  370. .PollingIntervalMS = 0x01
  371. },
  372. #endif
  373. };
  374. /*******************************************************************************
  375. * String Descriptors
  376. ******************************************************************************/
  377. const USB_Descriptor_String_t PROGMEM LanguageString =
  378. {
  379. .Header = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
  380. .UnicodeString = {LANGUAGE_ID_ENG}
  381. };
  382. const USB_Descriptor_String_t PROGMEM ManufacturerString =
  383. {
  384. /* subtract 1 for null terminator */
  385. .Header = {.Size = USB_STRING_LEN(sizeof(STR(MANUFACTURER))-1), .Type = DTYPE_String},
  386. .UnicodeString = LSTR(MANUFACTURER)
  387. };
  388. const USB_Descriptor_String_t PROGMEM ProductString =
  389. {
  390. /* subtract 1 for null terminator */
  391. .Header = {.Size = USB_STRING_LEN(sizeof(STR(PRODUCT))-1), .Type = DTYPE_String},
  392. .UnicodeString = LSTR(PRODUCT)
  393. };
  394. /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  395. * documentation) by the application code so that the address and size of a requested descriptor can be given
  396. * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
  397. * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  398. * USB host.
  399. */
  400. uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  401. const uint8_t wIndex,
  402. const void** const DescriptorAddress)
  403. {
  404. const uint8_t DescriptorType = (wValue >> 8);
  405. const uint8_t DescriptorIndex = (wValue & 0xFF);
  406. const void* Address = NULL;
  407. uint16_t Size = NO_DESCRIPTOR;
  408. switch (DescriptorType)
  409. {
  410. case DTYPE_Device:
  411. Address = &DeviceDescriptor;
  412. Size = sizeof(USB_Descriptor_Device_t);
  413. break;
  414. case DTYPE_Configuration:
  415. Address = &ConfigurationDescriptor;
  416. Size = sizeof(USB_Descriptor_Configuration_t);
  417. break;
  418. case DTYPE_String:
  419. switch (DescriptorIndex )
  420. {
  421. case 0x00:
  422. Address = &LanguageString;
  423. Size = pgm_read_byte(&LanguageString.Header.Size);
  424. break;
  425. case 0x01:
  426. Address = &ManufacturerString;
  427. Size = pgm_read_byte(&ManufacturerString.Header.Size);
  428. break;
  429. case 0x02:
  430. Address = &ProductString;
  431. Size = pgm_read_byte(&ProductString.Header.Size);
  432. break;
  433. }
  434. break;
  435. case HID_DTYPE_HID:
  436. switch (wIndex) {
  437. case KEYBOARD_INTERFACE:
  438. Address = &ConfigurationDescriptor.Keyboard_HID;
  439. Size = sizeof(USB_HID_Descriptor_HID_t);
  440. break;
  441. #ifdef MOUSE_ENABLE
  442. case MOUSE_INTERFACE:
  443. Address = &ConfigurationDescriptor.Mouse_HID;
  444. Size = sizeof(USB_HID_Descriptor_HID_t);
  445. break;
  446. #endif
  447. #ifdef EXTRAKEY_ENABLE
  448. case EXTRAKEY_INTERFACE:
  449. Address = &ConfigurationDescriptor.Extrakey_HID;
  450. Size = sizeof(USB_HID_Descriptor_HID_t);
  451. break;
  452. #endif
  453. #ifdef CONSOLE_ENABLE
  454. case CONSOLE_INTERFACE:
  455. Address = &ConfigurationDescriptor.Console_HID;
  456. Size = sizeof(USB_HID_Descriptor_HID_t);
  457. break;
  458. #endif
  459. }
  460. break;
  461. case HID_DTYPE_Report:
  462. switch (wIndex) {
  463. case KEYBOARD_INTERFACE:
  464. Address = &KeyboardReport;
  465. Size = sizeof(KeyboardReport);
  466. break;
  467. #ifdef MOUSE_ENABLE
  468. case MOUSE_INTERFACE:
  469. Address = &MouseReport;
  470. Size = sizeof(MouseReport);
  471. break;
  472. #endif
  473. #ifdef EXTRAKEY_ENABLE
  474. case EXTRAKEY_INTERFACE:
  475. Address = &ExtrakeyReport;
  476. Size = sizeof(ExtrakeyReport);
  477. break;
  478. #endif
  479. #ifdef CONSOLE_ENABLE
  480. case CONSOLE_INTERFACE:
  481. Address = &ConsoleReport;
  482. Size = sizeof(ConsoleReport);
  483. break;
  484. #endif
  485. }
  486. break;
  487. }
  488. *DescriptorAddress = Address;
  489. return Size;
  490. }