Keyboard firmwares for Atmel AVR and Cortex-M
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.

descriptor.c 21KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558
  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. const USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
  75. {
  76. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  77. HID_RI_USAGE(8, 0x02), /* Mouse */
  78. HID_RI_COLLECTION(8, 0x01), /* Application */
  79. HID_RI_USAGE(8, 0x01), /* Pointer */
  80. HID_RI_COLLECTION(8, 0x00), /* Physical */
  81. HID_RI_USAGE_PAGE(8, 0x09), /* Button */
  82. HID_RI_USAGE_MINIMUM(8, 0x01), /* Button 1 */
  83. HID_RI_USAGE_MAXIMUM(8, 0x05), /* Button 5 */
  84. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  85. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  86. HID_RI_REPORT_COUNT(8, 0x05),
  87. HID_RI_REPORT_SIZE(8, 0x01),
  88. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  89. HID_RI_REPORT_COUNT(8, 0x01),
  90. HID_RI_REPORT_SIZE(8, 0x03),
  91. HID_RI_INPUT(8, HID_IOF_CONSTANT),
  92. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  93. HID_RI_USAGE(8, 0x30), /* Usage X */
  94. HID_RI_USAGE(8, 0x31), /* Usage Y */
  95. HID_RI_LOGICAL_MINIMUM(8, -127),
  96. HID_RI_LOGICAL_MAXIMUM(8, 127),
  97. HID_RI_REPORT_COUNT(8, 0x02),
  98. HID_RI_REPORT_SIZE(8, 0x08),
  99. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  100. HID_RI_USAGE(8, 0x38), /* Wheel */
  101. HID_RI_LOGICAL_MINIMUM(8, -127),
  102. HID_RI_LOGICAL_MAXIMUM(8, 127),
  103. HID_RI_REPORT_COUNT(8, 0x01),
  104. HID_RI_REPORT_SIZE(8, 0x08),
  105. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  106. HID_RI_USAGE_PAGE(8, 0x0C), /* Consumer */
  107. HID_RI_USAGE(16, 0x0238), /* AC Pan (Horizontal wheel) */
  108. HID_RI_LOGICAL_MINIMUM(8, -127),
  109. HID_RI_LOGICAL_MAXIMUM(8, 127),
  110. HID_RI_REPORT_COUNT(8, 0x01),
  111. HID_RI_REPORT_SIZE(8, 0x08),
  112. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  113. HID_RI_END_COLLECTION(0),
  114. HID_RI_END_COLLECTION(0),
  115. };
  116. const USB_Descriptor_HIDReport_Datatype_t PROGMEM ConsoleReport[] =
  117. {
  118. HID_RI_USAGE_PAGE(16, 0xFF31), /* Vendor Page(PJRC Teensy compatible) */
  119. HID_RI_USAGE(8, 0x74), /* Vendor Usage(PJRC Teensy compatible) */
  120. HID_RI_COLLECTION(8, 0x01), /* Application */
  121. HID_RI_USAGE(8, 0x75), /* Vendor Usage 0x75 */
  122. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  123. HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
  124. HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
  125. HID_RI_REPORT_SIZE(8, 0x08),
  126. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  127. HID_RI_USAGE(8, 0x76), /* Vendor Usage 0x76 */
  128. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  129. HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
  130. HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
  131. HID_RI_REPORT_SIZE(8, 0x08),
  132. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  133. HID_RI_END_COLLECTION(0),
  134. };
  135. #ifdef EXTRAKEY_ENABLE
  136. const USB_Descriptor_HIDReport_Datatype_t PROGMEM ExtraReport[] =
  137. {
  138. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  139. HID_RI_USAGE(8, 0x80), /* System Control */
  140. HID_RI_COLLECTION(8, 0x01), /* Application */
  141. HID_RI_REPORT_ID(8, REPORT_ID_SYSTEM),
  142. HID_RI_LOGICAL_MINIMUM(16, 0x0081),
  143. HID_RI_LOGICAL_MAXIMUM(16, 0x00B7),
  144. HID_RI_USAGE_MINIMUM(16, 0x0081), /* System Power Down */
  145. HID_RI_USAGE_MAXIMUM(16, 0x00B7), /* System Display LCD Autoscale */
  146. HID_RI_REPORT_SIZE(8, 16),
  147. HID_RI_REPORT_COUNT(8, 1),
  148. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  149. HID_RI_END_COLLECTION(0),
  150. HID_RI_USAGE_PAGE(8, 0x0C), /* Consumer */
  151. HID_RI_USAGE(8, 0x01), /* Consumer Control */
  152. HID_RI_COLLECTION(8, 0x01), /* Application */
  153. HID_RI_REPORT_ID(8, REPORT_ID_CONSUMER),
  154. HID_RI_LOGICAL_MINIMUM(16, 0x0010),
  155. HID_RI_LOGICAL_MAXIMUM(16, 0x029C),
  156. HID_RI_USAGE_MINIMUM(16, 0x0010), /* +10 */
  157. HID_RI_USAGE_MAXIMUM(16, 0x029C), /* AC Distribute Vertically */
  158. HID_RI_REPORT_SIZE(8, 16),
  159. HID_RI_REPORT_COUNT(8, 1),
  160. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  161. HID_RI_END_COLLECTION(0),
  162. };
  163. #endif
  164. #ifdef NKRO_ENABLE
  165. const USB_Descriptor_HIDReport_Datatype_t PROGMEM NKROReport[] =
  166. {
  167. HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  168. HID_RI_USAGE(8, 0x06), /* Keyboard */
  169. HID_RI_COLLECTION(8, 0x01), /* Application */
  170. HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
  171. HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
  172. HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
  173. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  174. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  175. HID_RI_REPORT_COUNT(8, 0x08),
  176. HID_RI_REPORT_SIZE(8, 0x01),
  177. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  178. HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
  179. HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
  180. HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
  181. HID_RI_REPORT_COUNT(8, 0x05),
  182. HID_RI_REPORT_SIZE(8, 0x01),
  183. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  184. HID_RI_REPORT_COUNT(8, 0x01),
  185. HID_RI_REPORT_SIZE(8, 0x03),
  186. HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
  187. HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
  188. HID_RI_USAGE_MINIMUM(8, 0x00), /* Keyboard 0 */
  189. HID_RI_USAGE_MAXIMUM(8, NKRO_SIZE*8-1), /* Keyboard Right GUI */
  190. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  191. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  192. HID_RI_REPORT_COUNT(8, NKRO_SIZE*8),
  193. HID_RI_REPORT_SIZE(8, 0x01),
  194. };
  195. #endif
  196. /*******************************************************************************
  197. * Device Descriptors
  198. ******************************************************************************/
  199. const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  200. {
  201. .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  202. .USBSpecification = VERSION_BCD(01.10),
  203. .Class = USB_CSCP_NoDeviceClass,
  204. .SubClass = USB_CSCP_NoDeviceSubclass,
  205. .Protocol = USB_CSCP_NoDeviceProtocol,
  206. .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
  207. .VendorID = VENDOR_ID,
  208. .ProductID = PRODUCT_ID,
  209. .ReleaseNumber = DEVICE_VER,
  210. .ManufacturerStrIndex = 0x01,
  211. .ProductStrIndex = 0x02,
  212. .SerialNumStrIndex = NO_DESCRIPTOR,
  213. .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  214. };
  215. /*******************************************************************************
  216. * Configuration Descriptors
  217. ******************************************************************************/
  218. const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  219. {
  220. .Config =
  221. {
  222. .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  223. .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  224. .TotalInterfaces = TOTAL_INTERFACES,
  225. .ConfigurationNumber = 1,
  226. .ConfigurationStrIndex = NO_DESCRIPTOR,
  227. .ConfigAttributes = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_REMOTEWAKEUP),
  228. .MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
  229. },
  230. /*
  231. * Keyboard
  232. */
  233. .Keyboard_Interface =
  234. {
  235. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  236. .InterfaceNumber = KEYBOARD_INTERFACE,
  237. .AlternateSetting = 0x00,
  238. .TotalEndpoints = 1,
  239. .Class = HID_CSCP_HIDClass,
  240. .SubClass = HID_CSCP_BootSubclass,
  241. .Protocol = HID_CSCP_KeyboardBootProtocol,
  242. .InterfaceStrIndex = NO_DESCRIPTOR
  243. },
  244. .Keyboard_HID =
  245. {
  246. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  247. .HIDSpec = VERSION_BCD(01.11),
  248. .CountryCode = 0x00,
  249. .TotalReportDescriptors = 1,
  250. .HIDReportType = HID_DTYPE_Report,
  251. .HIDReportLength = sizeof(KeyboardReport)
  252. },
  253. .Keyboard_INEndpoint =
  254. {
  255. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  256. .EndpointAddress = (ENDPOINT_DIR_IN | KEYBOARD_IN_EPNUM),
  257. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  258. .EndpointSize = KEYBOARD_EPSIZE,
  259. .PollingIntervalMS = 0x01
  260. },
  261. /*
  262. * Mouse
  263. */
  264. #ifdef MOUSE_ENABLE
  265. .Mouse_Interface =
  266. {
  267. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  268. .InterfaceNumber = MOUSE_INTERFACE,
  269. .AlternateSetting = 0x00,
  270. .TotalEndpoints = 1,
  271. .Class = HID_CSCP_HIDClass,
  272. .SubClass = HID_CSCP_BootSubclass,
  273. .Protocol = HID_CSCP_MouseBootProtocol,
  274. .InterfaceStrIndex = NO_DESCRIPTOR
  275. },
  276. .Mouse_HID =
  277. {
  278. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  279. .HIDSpec = VERSION_BCD(01.11),
  280. .CountryCode = 0x00,
  281. .TotalReportDescriptors = 1,
  282. .HIDReportType = HID_DTYPE_Report,
  283. .HIDReportLength = sizeof(MouseReport)
  284. },
  285. .Mouse_INEndpoint =
  286. {
  287. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  288. .EndpointAddress = (ENDPOINT_DIR_IN | MOUSE_IN_EPNUM),
  289. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  290. .EndpointSize = MOUSE_EPSIZE,
  291. .PollingIntervalMS = 0x01
  292. },
  293. #endif
  294. /*
  295. * Console
  296. */
  297. .Console_Interface =
  298. {
  299. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  300. .InterfaceNumber = CONSOLE_INTERFACE,
  301. .AlternateSetting = 0x00,
  302. .TotalEndpoints = 2,
  303. .Class = HID_CSCP_HIDClass,
  304. .SubClass = HID_CSCP_NonBootSubclass,
  305. .Protocol = HID_CSCP_NonBootProtocol,
  306. .InterfaceStrIndex = NO_DESCRIPTOR
  307. },
  308. .Console_HID =
  309. {
  310. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  311. .HIDSpec = VERSION_BCD(01.11),
  312. .CountryCode = 0x00,
  313. .TotalReportDescriptors = 1,
  314. .HIDReportType = HID_DTYPE_Report,
  315. .HIDReportLength = sizeof(ConsoleReport)
  316. },
  317. .Console_INEndpoint =
  318. {
  319. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  320. .EndpointAddress = (ENDPOINT_DIR_IN | CONSOLE_IN_EPNUM),
  321. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  322. .EndpointSize = CONSOLE_EPSIZE,
  323. .PollingIntervalMS = 0x01
  324. },
  325. .Console_OUTEndpoint =
  326. {
  327. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  328. .EndpointAddress = (ENDPOINT_DIR_OUT | CONSOLE_OUT_EPNUM),
  329. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  330. .EndpointSize = CONSOLE_EPSIZE,
  331. .PollingIntervalMS = 0x01
  332. },
  333. /*
  334. * Extra
  335. */
  336. #ifdef EXTRAKEY_ENABLE
  337. .Extra_Interface =
  338. {
  339. .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  340. .InterfaceNumber = EXTRA_INTERFACE,
  341. .AlternateSetting = 0x00,
  342. .TotalEndpoints = 1,
  343. .Class = HID_CSCP_HIDClass,
  344. .SubClass = HID_CSCP_NonBootSubclass,
  345. .Protocol = HID_CSCP_NonBootProtocol,
  346. .InterfaceStrIndex = NO_DESCRIPTOR
  347. },
  348. .Extra_HID =
  349. {
  350. .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
  351. .HIDSpec = VERSION_BCD(01.11),
  352. .CountryCode = 0x00,
  353. .TotalReportDescriptors = 1,
  354. .HIDReportType = HID_DTYPE_Report,
  355. .HIDReportLength = sizeof(ExtraReport)
  356. },
  357. .Extra_INEndpoint =
  358. {
  359. .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  360. .EndpointAddress = (ENDPOINT_DIR_IN | EXTRA_IN_EPNUM),
  361. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  362. .EndpointSize = EXTRA_EPSIZE,
  363. .PollingIntervalMS = 0x01
  364. },
  365. #endif
  366. };
  367. /*******************************************************************************
  368. * String Descriptors
  369. ******************************************************************************/
  370. const USB_Descriptor_String_t PROGMEM LanguageString =
  371. {
  372. .Header = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
  373. .UnicodeString = {LANGUAGE_ID_ENG}
  374. };
  375. const USB_Descriptor_String_t PROGMEM ManufacturerString =
  376. {
  377. .Header = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
  378. .UnicodeString = LSTR(MANUFACTURER)
  379. };
  380. const USB_Descriptor_String_t PROGMEM ProductString =
  381. {
  382. .Header = {.Size = USB_STRING_LEN(28), .Type = DTYPE_String},
  383. .UnicodeString = LSTR(PRODUCT)
  384. };
  385. /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  386. * documentation) by the application code so that the address and size of a requested descriptor can be given
  387. * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
  388. * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  389. * USB host.
  390. */
  391. uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  392. const uint8_t wIndex,
  393. const void** const DescriptorAddress)
  394. {
  395. const uint8_t DescriptorType = (wValue >> 8);
  396. const uint8_t DescriptorIndex = (wValue & 0xFF);
  397. const void* Address = NULL;
  398. uint16_t Size = NO_DESCRIPTOR;
  399. switch (DescriptorType)
  400. {
  401. case DTYPE_Device:
  402. Address = &DeviceDescriptor;
  403. Size = sizeof(USB_Descriptor_Device_t);
  404. break;
  405. case DTYPE_Configuration:
  406. Address = &ConfigurationDescriptor;
  407. Size = sizeof(USB_Descriptor_Configuration_t);
  408. break;
  409. case DTYPE_String:
  410. switch (DescriptorIndex )
  411. {
  412. case 0x00:
  413. Address = &LanguageString;
  414. Size = pgm_read_byte(&LanguageString.Header.Size);
  415. break;
  416. case 0x01:
  417. Address = &ManufacturerString;
  418. Size = pgm_read_byte(&ManufacturerString.Header.Size);
  419. break;
  420. case 0x02:
  421. Address = &ProductString;
  422. Size = pgm_read_byte(&ProductString.Header.Size);
  423. break;
  424. }
  425. break;
  426. case HID_DTYPE_HID:
  427. switch (wIndex) {
  428. case KEYBOARD_INTERFACE:
  429. Address = &ConfigurationDescriptor.Keyboard_HID;
  430. Size = sizeof(USB_HID_Descriptor_HID_t);
  431. break;
  432. #ifdef MOUSE_ENABLE
  433. case MOUSE_INTERFACE:
  434. Address = &ConfigurationDescriptor.Mouse_HID;
  435. Size = sizeof(USB_HID_Descriptor_HID_t);
  436. break;
  437. #endif
  438. case CONSOLE_INTERFACE:
  439. Address = &ConfigurationDescriptor.Console_HID;
  440. Size = sizeof(USB_HID_Descriptor_HID_t);
  441. break;
  442. #ifdef EXTRAKEY_ENABLE
  443. case EXTRA_INTERFACE:
  444. Address = &ConfigurationDescriptor.Extra_HID;
  445. Size = sizeof(USB_HID_Descriptor_HID_t);
  446. break;
  447. #endif
  448. }
  449. break;
  450. case HID_DTYPE_Report:
  451. switch (wIndex) {
  452. case KEYBOARD_INTERFACE:
  453. Address = &KeyboardReport;
  454. Size = sizeof(KeyboardReport);
  455. break;
  456. #ifdef MOUSE_ENABLE
  457. case MOUSE_INTERFACE:
  458. Address = &MouseReport;
  459. Size = sizeof(MouseReport);
  460. break;
  461. #endif
  462. case CONSOLE_INTERFACE:
  463. Address = &ConsoleReport;
  464. Size = sizeof(ConsoleReport);
  465. break;
  466. #ifdef EXTRAKEY_ENABLE
  467. case EXTRA_INTERFACE:
  468. Address = &ExtraReport;
  469. Size = sizeof(ExtraReport);
  470. break;
  471. #endif
  472. }
  473. break;
  474. }
  475. *DescriptorAddress = Address;
  476. return Size;
  477. }