usb_descriptor.c 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265
  1. /*
  2. * Copyright 2012 Jun Wako <wakojun@gmail.com>
  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 "usb_descriptor.h"
  36. #include "usb_descriptor_common.h"
  37. #ifdef JOYSTICK_ENABLE
  38. # include "joystick.h"
  39. #endif
  40. #ifdef OS_DETECTION_ENABLE
  41. # include "os_detection.h"
  42. #endif
  43. // clang-format off
  44. /*
  45. * HID report descriptors
  46. */
  47. #ifdef KEYBOARD_SHARED_EP
  48. const USB_Descriptor_HIDReport_Datatype_t PROGMEM SharedReport[] = {
  49. # define SHARED_REPORT_STARTED
  50. #else
  51. const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] = {
  52. #endif
  53. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  54. HID_RI_USAGE(8, 0x06), // Keyboard
  55. HID_RI_COLLECTION(8, 0x01), // Application
  56. #ifdef KEYBOARD_SHARED_EP
  57. HID_RI_REPORT_ID(8, REPORT_ID_KEYBOARD),
  58. #endif
  59. // Modifiers (8 bits)
  60. HID_RI_USAGE_PAGE(8, 0x07), // Keyboard/Keypad
  61. HID_RI_USAGE_MINIMUM(8, 0xE0), // Keyboard Left Control
  62. HID_RI_USAGE_MAXIMUM(8, 0xE7), // Keyboard Right GUI
  63. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  64. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  65. HID_RI_REPORT_COUNT(8, 0x08),
  66. HID_RI_REPORT_SIZE(8, 0x01),
  67. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  68. // Reserved (1 byte)
  69. HID_RI_REPORT_COUNT(8, 0x01),
  70. HID_RI_REPORT_SIZE(8, 0x08),
  71. HID_RI_INPUT(8, HID_IOF_CONSTANT),
  72. // Keycodes (6 bytes)
  73. HID_RI_USAGE_PAGE(8, 0x07), // Keyboard/Keypad
  74. HID_RI_USAGE_MINIMUM(8, 0x00),
  75. HID_RI_USAGE_MAXIMUM(8, 0xFF),
  76. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  77. HID_RI_LOGICAL_MAXIMUM(16, 0x00FF),
  78. HID_RI_REPORT_COUNT(8, 0x06),
  79. HID_RI_REPORT_SIZE(8, 0x08),
  80. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  81. // Status LEDs (5 bits)
  82. HID_RI_USAGE_PAGE(8, 0x08), // LED
  83. HID_RI_USAGE_MINIMUM(8, 0x01), // Num Lock
  84. HID_RI_USAGE_MAXIMUM(8, 0x05), // Kana
  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_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  90. // LED padding (3 bits)
  91. HID_RI_REPORT_COUNT(8, 0x01),
  92. HID_RI_REPORT_SIZE(8, 0x03),
  93. HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
  94. HID_RI_END_COLLECTION(0),
  95. #ifndef KEYBOARD_SHARED_EP
  96. };
  97. #endif
  98. #ifdef MOUSE_ENABLE
  99. # ifndef MOUSE_SHARED_EP
  100. const USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] = {
  101. # elif !defined(SHARED_REPORT_STARTED)
  102. const USB_Descriptor_HIDReport_Datatype_t PROGMEM SharedReport[] = {
  103. # define SHARED_REPORT_STARTED
  104. # endif
  105. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  106. HID_RI_USAGE(8, 0x02), // Mouse
  107. HID_RI_COLLECTION(8, 0x01), // Application
  108. # ifdef MOUSE_SHARED_EP
  109. HID_RI_REPORT_ID(8, REPORT_ID_MOUSE),
  110. # endif
  111. HID_RI_USAGE(8, 0x01), // Pointer
  112. HID_RI_COLLECTION(8, 0x00), // Physical
  113. // Buttons (8 bits)
  114. HID_RI_USAGE_PAGE(8, 0x09), // Button
  115. HID_RI_USAGE_MINIMUM(8, 0x01), // Button 1
  116. HID_RI_USAGE_MAXIMUM(8, 0x08), // Button 8
  117. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  118. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  119. HID_RI_REPORT_COUNT(8, 0x08),
  120. HID_RI_REPORT_SIZE(8, 0x01),
  121. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  122. # ifdef MOUSE_EXTENDED_REPORT
  123. // Boot protocol XY ignored in Report protocol
  124. HID_RI_REPORT_COUNT(8, 0x02),
  125. HID_RI_REPORT_SIZE(8, 0x08),
  126. HID_RI_INPUT(8, HID_IOF_CONSTANT),
  127. # endif
  128. // X/Y position (2 or 4 bytes)
  129. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  130. HID_RI_USAGE(8, 0x30), // X
  131. HID_RI_USAGE(8, 0x31), // Y
  132. # ifndef MOUSE_EXTENDED_REPORT
  133. HID_RI_LOGICAL_MINIMUM(8, -127),
  134. HID_RI_LOGICAL_MAXIMUM(8, 127),
  135. HID_RI_REPORT_COUNT(8, 0x02),
  136. HID_RI_REPORT_SIZE(8, 0x08),
  137. # else
  138. HID_RI_LOGICAL_MINIMUM(16, -32767),
  139. HID_RI_LOGICAL_MAXIMUM(16, 32767),
  140. HID_RI_REPORT_COUNT(8, 0x02),
  141. HID_RI_REPORT_SIZE(8, 0x10),
  142. # endif
  143. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  144. // Vertical wheel (1 byte)
  145. HID_RI_USAGE(8, 0x38), // Wheel
  146. HID_RI_LOGICAL_MINIMUM(8, -127),
  147. HID_RI_LOGICAL_MAXIMUM(8, 127),
  148. HID_RI_REPORT_COUNT(8, 0x01),
  149. HID_RI_REPORT_SIZE(8, 0x08),
  150. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  151. // Horizontal wheel (1 byte)
  152. HID_RI_USAGE_PAGE(8, 0x0C), // Consumer
  153. HID_RI_USAGE(16, 0x0238), // AC Pan
  154. HID_RI_LOGICAL_MINIMUM(8, -127),
  155. HID_RI_LOGICAL_MAXIMUM(8, 127),
  156. HID_RI_REPORT_COUNT(8, 0x01),
  157. HID_RI_REPORT_SIZE(8, 0x08),
  158. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  159. HID_RI_END_COLLECTION(0),
  160. HID_RI_END_COLLECTION(0),
  161. # ifndef MOUSE_SHARED_EP
  162. };
  163. # endif
  164. #endif
  165. #ifdef JOYSTICK_ENABLE
  166. # ifndef JOYSTICK_SHARED_EP
  167. const USB_Descriptor_HIDReport_Datatype_t PROGMEM JoystickReport[] = {
  168. # elif !defined(SHARED_REPORT_STARTED)
  169. const USB_Descriptor_HIDReport_Datatype_t PROGMEM SharedReport[] = {
  170. # define SHARED_REPORT_STARTED
  171. # endif
  172. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  173. HID_RI_USAGE(8, 0x04), // Joystick
  174. HID_RI_COLLECTION(8, 0x01), // Application
  175. # ifdef JOYSTICK_SHARED_EP
  176. HID_RI_REPORT_ID(8, REPORT_ID_JOYSTICK),
  177. # endif
  178. HID_RI_COLLECTION(8, 0x00), // Physical
  179. # if JOYSTICK_AXIS_COUNT > 0
  180. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  181. HID_RI_USAGE(8, 0x30), // X
  182. # if JOYSTICK_AXIS_COUNT > 1
  183. HID_RI_USAGE(8, 0x31), // Y
  184. # endif
  185. # if JOYSTICK_AXIS_COUNT > 2
  186. HID_RI_USAGE(8, 0x32), // Z
  187. # endif
  188. # if JOYSTICK_AXIS_COUNT > 3
  189. HID_RI_USAGE(8, 0x33), // Rx
  190. # endif
  191. # if JOYSTICK_AXIS_COUNT > 4
  192. HID_RI_USAGE(8, 0x34), // Ry
  193. # endif
  194. # if JOYSTICK_AXIS_COUNT > 5
  195. HID_RI_USAGE(8, 0x35), // Rz
  196. # endif
  197. # if JOYSTICK_AXIS_RESOLUTION == 8
  198. HID_RI_LOGICAL_MINIMUM(8, -JOYSTICK_MAX_VALUE),
  199. HID_RI_LOGICAL_MAXIMUM(8, JOYSTICK_MAX_VALUE),
  200. HID_RI_REPORT_COUNT(8, JOYSTICK_AXIS_COUNT),
  201. HID_RI_REPORT_SIZE(8, 0x08),
  202. # else
  203. HID_RI_LOGICAL_MINIMUM(16, -JOYSTICK_MAX_VALUE),
  204. HID_RI_LOGICAL_MAXIMUM(16, JOYSTICK_MAX_VALUE),
  205. HID_RI_REPORT_COUNT(8, JOYSTICK_AXIS_COUNT),
  206. HID_RI_REPORT_SIZE(8, 0x10),
  207. # endif
  208. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  209. # endif
  210. # if JOYSTICK_BUTTON_COUNT > 0
  211. HID_RI_USAGE_PAGE(8, 0x09), // Button
  212. HID_RI_USAGE_MINIMUM(8, 0x01),
  213. HID_RI_USAGE_MAXIMUM(8, JOYSTICK_BUTTON_COUNT),
  214. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  215. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  216. HID_RI_REPORT_COUNT(8, JOYSTICK_BUTTON_COUNT),
  217. HID_RI_REPORT_SIZE(8, 0x01),
  218. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  219. # if (JOYSTICK_BUTTON_COUNT % 8) != 0
  220. HID_RI_REPORT_COUNT(8, 8 - (JOYSTICK_BUTTON_COUNT % 8)),
  221. HID_RI_REPORT_SIZE(8, 0x01),
  222. HID_RI_INPUT(8, HID_IOF_CONSTANT),
  223. # endif
  224. # endif
  225. HID_RI_END_COLLECTION(0),
  226. HID_RI_END_COLLECTION(0),
  227. # ifndef JOYSTICK_SHARED_EP
  228. };
  229. # endif
  230. #endif
  231. #ifdef DIGITIZER_ENABLE
  232. # ifndef DIGITIZER_SHARED_EP
  233. const USB_Descriptor_HIDReport_Datatype_t PROGMEM DigitizerReport[] = {
  234. # elif !defined(SHARED_REPORT_STARTED)
  235. const USB_Descriptor_HIDReport_Datatype_t PROGMEM SharedReport[] = {
  236. # define SHARED_REPORT_STARTED
  237. # endif
  238. HID_RI_USAGE_PAGE(8, 0x0D), // Digitizers
  239. HID_RI_USAGE(8, 0x01), // Digitizer
  240. HID_RI_COLLECTION(8, 0x01), // Application
  241. # ifdef DIGITIZER_SHARED_EP
  242. HID_RI_REPORT_ID(8, REPORT_ID_DIGITIZER),
  243. # endif
  244. HID_RI_USAGE(8, 0x20), // Stylus
  245. HID_RI_COLLECTION(8, 0x00), // Physical
  246. // In Range, Tip Switch & Barrel Switch (3 bits)
  247. HID_RI_USAGE(8, 0x32), // In Range
  248. HID_RI_USAGE(8, 0x42), // Tip Switch
  249. HID_RI_USAGE(8, 0x44), // Barrel Switch
  250. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  251. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  252. HID_RI_REPORT_COUNT(8, 0x03),
  253. HID_RI_REPORT_SIZE(8, 0x01),
  254. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  255. // Padding (5 bits)
  256. HID_RI_REPORT_COUNT(8, 0x05),
  257. HID_RI_INPUT(8, HID_IOF_CONSTANT),
  258. // X/Y Position (4 bytes)
  259. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  260. HID_RI_USAGE(8, 0x30), // X
  261. HID_RI_USAGE(8, 0x31), // Y
  262. HID_RI_LOGICAL_MAXIMUM(16, 0x7FFF),
  263. HID_RI_REPORT_COUNT(8, 0x02),
  264. HID_RI_REPORT_SIZE(8, 0x10),
  265. HID_RI_UNIT(8, 0x33), // Inch, English Linear
  266. HID_RI_UNIT_EXPONENT(8, 0x0E), // -2
  267. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  268. HID_RI_END_COLLECTION(0),
  269. HID_RI_END_COLLECTION(0),
  270. # ifndef DIGITIZER_SHARED_EP
  271. };
  272. # endif
  273. #endif
  274. #if defined(SHARED_EP_ENABLE) && !defined(SHARED_REPORT_STARTED)
  275. const USB_Descriptor_HIDReport_Datatype_t PROGMEM SharedReport[] = {
  276. #endif
  277. #ifdef EXTRAKEY_ENABLE
  278. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  279. HID_RI_USAGE(8, 0x80), // System Control
  280. HID_RI_COLLECTION(8, 0x01), // Application
  281. HID_RI_REPORT_ID(8, REPORT_ID_SYSTEM),
  282. HID_RI_USAGE_MINIMUM(8, 0x01), // Pointer
  283. HID_RI_USAGE_MAXIMUM(16, 0x00B7), // System Display LCD Autoscale
  284. HID_RI_LOGICAL_MINIMUM(8, 0x01),
  285. HID_RI_LOGICAL_MAXIMUM(16, 0x00B7),
  286. HID_RI_REPORT_COUNT(8, 1),
  287. HID_RI_REPORT_SIZE(8, 16),
  288. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  289. HID_RI_END_COLLECTION(0),
  290. HID_RI_USAGE_PAGE(8, 0x0C), // Consumer
  291. HID_RI_USAGE(8, 0x01), // Consumer Control
  292. HID_RI_COLLECTION(8, 0x01), // Application
  293. HID_RI_REPORT_ID(8, REPORT_ID_CONSUMER),
  294. HID_RI_USAGE_MINIMUM(8, 0x01), // Consumer Control
  295. HID_RI_USAGE_MAXIMUM(16, 0x02A0), // AC Desktop Show All Applications
  296. HID_RI_LOGICAL_MINIMUM(8, 0x01),
  297. HID_RI_LOGICAL_MAXIMUM(16, 0x02A0),
  298. HID_RI_REPORT_COUNT(8, 1),
  299. HID_RI_REPORT_SIZE(8, 16),
  300. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
  301. HID_RI_END_COLLECTION(0),
  302. #endif
  303. #ifdef PROGRAMMABLE_BUTTON_ENABLE
  304. HID_RI_USAGE_PAGE(8, 0x0C), // Consumer
  305. HID_RI_USAGE(8, 0x01), // Consumer Control
  306. HID_RI_COLLECTION(8, 0x01), // Application
  307. HID_RI_REPORT_ID(8, REPORT_ID_PROGRAMMABLE_BUTTON),
  308. HID_RI_USAGE(8, 0x03), // Programmable Buttons
  309. HID_RI_COLLECTION(8, 0x04), // Named Array
  310. HID_RI_USAGE_PAGE(8, 0x09), // Button
  311. HID_RI_USAGE_MINIMUM(8, 0x01), // Button 1
  312. HID_RI_USAGE_MAXIMUM(8, 0x20), // Button 32
  313. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  314. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  315. HID_RI_REPORT_COUNT(8, 32),
  316. HID_RI_REPORT_SIZE(8, 1),
  317. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  318. HID_RI_END_COLLECTION(0),
  319. HID_RI_END_COLLECTION(0),
  320. #endif
  321. #ifdef NKRO_ENABLE
  322. HID_RI_USAGE_PAGE(8, 0x01), // Generic Desktop
  323. HID_RI_USAGE(8, 0x06), // Keyboard
  324. HID_RI_COLLECTION(8, 0x01), // Application
  325. HID_RI_REPORT_ID(8, REPORT_ID_NKRO),
  326. // Modifiers (8 bits)
  327. HID_RI_USAGE_PAGE(8, 0x07), // Keyboard/Keypad
  328. HID_RI_USAGE_MINIMUM(8, 0xE0), // Keyboard Left Control
  329. HID_RI_USAGE_MAXIMUM(8, 0xE7), // Keyboard Right GUI
  330. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  331. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  332. HID_RI_REPORT_COUNT(8, 0x08),
  333. HID_RI_REPORT_SIZE(8, 0x01),
  334. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  335. // Keycodes
  336. HID_RI_USAGE_PAGE(8, 0x07), // Keyboard/Keypad
  337. HID_RI_USAGE_MINIMUM(8, 0x00),
  338. HID_RI_USAGE_MAXIMUM(8, NKRO_REPORT_BITS * 8 - 1),
  339. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  340. HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  341. HID_RI_REPORT_COUNT(8, NKRO_REPORT_BITS * 8),
  342. HID_RI_REPORT_SIZE(8, 0x01),
  343. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  344. // Status LEDs (5 bits)
  345. HID_RI_USAGE_PAGE(8, 0x08), // LED
  346. HID_RI_USAGE_MINIMUM(8, 0x01), // Num Lock
  347. HID_RI_USAGE_MAXIMUM(8, 0x05), // Kana
  348. HID_RI_REPORT_COUNT(8, 0x05),
  349. HID_RI_REPORT_SIZE(8, 0x01),
  350. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  351. // LED padding (3 bits)
  352. HID_RI_REPORT_COUNT(8, 0x01),
  353. HID_RI_REPORT_SIZE(8, 0x03),
  354. HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
  355. HID_RI_END_COLLECTION(0),
  356. #endif
  357. #ifdef SHARED_EP_ENABLE
  358. };
  359. #endif
  360. #ifdef RAW_ENABLE
  361. const USB_Descriptor_HIDReport_Datatype_t PROGMEM RawReport[] = {
  362. HID_RI_USAGE_PAGE(16, RAW_USAGE_PAGE), // Vendor Defined
  363. HID_RI_USAGE(8, RAW_USAGE_ID), // Vendor Defined
  364. HID_RI_COLLECTION(8, 0x01), // Application
  365. // Data to host
  366. HID_RI_USAGE(8, 0x62), // Vendor Defined
  367. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  368. HID_RI_LOGICAL_MAXIMUM(16, 0x00FF),
  369. HID_RI_REPORT_COUNT(8, RAW_EPSIZE),
  370. HID_RI_REPORT_SIZE(8, 0x08),
  371. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  372. // Data from host
  373. HID_RI_USAGE(8, 0x63), // Vendor Defined
  374. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  375. HID_RI_LOGICAL_MAXIMUM(16, 0x00FF),
  376. HID_RI_REPORT_COUNT(8, RAW_EPSIZE),
  377. HID_RI_REPORT_SIZE(8, 0x08),
  378. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  379. HID_RI_END_COLLECTION(0),
  380. };
  381. #endif
  382. #ifdef CONSOLE_ENABLE
  383. const USB_Descriptor_HIDReport_Datatype_t PROGMEM ConsoleReport[] = {
  384. HID_RI_USAGE_PAGE(16, 0xFF31), // Vendor Defined (PJRC Teensy compatible)
  385. HID_RI_USAGE(8, 0x74), // Vendor Defined (PJRC Teensy compatible)
  386. HID_RI_COLLECTION(8, 0x01), // Application
  387. // Data to host
  388. HID_RI_USAGE(8, 0x75), // Vendor Defined
  389. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  390. HID_RI_LOGICAL_MAXIMUM(16, 0x00FF),
  391. HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
  392. HID_RI_REPORT_SIZE(8, 0x08),
  393. HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  394. // Data from host
  395. HID_RI_USAGE(8, 0x76), // Vendor Defined
  396. HID_RI_LOGICAL_MINIMUM(8, 0x00),
  397. HID_RI_LOGICAL_MAXIMUM(16, 0x00FF),
  398. HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
  399. HID_RI_REPORT_SIZE(8, 0x08),
  400. HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  401. HID_RI_END_COLLECTION(0),
  402. };
  403. #endif
  404. /*
  405. * Device descriptor
  406. */
  407. const USB_Descriptor_Device_t PROGMEM DeviceDescriptor = {
  408. .Header = {
  409. .Size = sizeof(USB_Descriptor_Device_t),
  410. .Type = DTYPE_Device
  411. },
  412. .USBSpecification = VERSION_BCD(2, 0, 0),
  413. #if VIRTSER_ENABLE
  414. .Class = USB_CSCP_IADDeviceClass,
  415. .SubClass = USB_CSCP_IADDeviceSubclass,
  416. .Protocol = USB_CSCP_IADDeviceProtocol,
  417. #else
  418. .Class = USB_CSCP_NoDeviceClass,
  419. .SubClass = USB_CSCP_NoDeviceSubclass,
  420. .Protocol = USB_CSCP_NoDeviceProtocol,
  421. #endif
  422. .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
  423. // Specified in config.h
  424. .VendorID = VENDOR_ID,
  425. .ProductID = PRODUCT_ID,
  426. .ReleaseNumber = DEVICE_VER,
  427. .ManufacturerStrIndex = 0x01,
  428. .ProductStrIndex = 0x02,
  429. #if defined(SERIAL_NUMBER)
  430. .SerialNumStrIndex = 0x03,
  431. #else
  432. .SerialNumStrIndex = 0x00,
  433. #endif
  434. .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  435. };
  436. #ifndef USB_MAX_POWER_CONSUMPTION
  437. # define USB_MAX_POWER_CONSUMPTION 500
  438. #endif
  439. #ifndef USB_POLLING_INTERVAL_MS
  440. # define USB_POLLING_INTERVAL_MS 1
  441. #endif
  442. /*
  443. * Configuration descriptors
  444. */
  445. const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor = {
  446. .Config = {
  447. .Header = {
  448. .Size = sizeof(USB_Descriptor_Configuration_Header_t),
  449. .Type = DTYPE_Configuration
  450. },
  451. .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  452. .TotalInterfaces = TOTAL_INTERFACES,
  453. .ConfigurationNumber = 1,
  454. .ConfigurationStrIndex = NO_DESCRIPTOR,
  455. .ConfigAttributes = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_REMOTEWAKEUP),
  456. .MaxPowerConsumption = USB_CONFIG_POWER_MA(USB_MAX_POWER_CONSUMPTION)
  457. },
  458. #ifndef KEYBOARD_SHARED_EP
  459. /*
  460. * Keyboard
  461. */
  462. .Keyboard_Interface = {
  463. .Header = {
  464. .Size = sizeof(USB_Descriptor_Interface_t),
  465. .Type = DTYPE_Interface
  466. },
  467. .InterfaceNumber = KEYBOARD_INTERFACE,
  468. .AlternateSetting = 0x00,
  469. .TotalEndpoints = 1,
  470. .Class = HID_CSCP_HIDClass,
  471. .SubClass = HID_CSCP_BootSubclass,
  472. .Protocol = HID_CSCP_KeyboardBootProtocol,
  473. .InterfaceStrIndex = NO_DESCRIPTOR
  474. },
  475. .Keyboard_HID = {
  476. .Header = {
  477. .Size = sizeof(USB_HID_Descriptor_HID_t),
  478. .Type = HID_DTYPE_HID
  479. },
  480. .HIDSpec = VERSION_BCD(1, 1, 1),
  481. .CountryCode = 0x00,
  482. .TotalReportDescriptors = 1,
  483. .HIDReportType = HID_DTYPE_Report,
  484. .HIDReportLength = sizeof(KeyboardReport)
  485. },
  486. .Keyboard_INEndpoint = {
  487. .Header = {
  488. .Size = sizeof(USB_Descriptor_Endpoint_t),
  489. .Type = DTYPE_Endpoint
  490. },
  491. .EndpointAddress = (ENDPOINT_DIR_IN | KEYBOARD_IN_EPNUM),
  492. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  493. .EndpointSize = KEYBOARD_EPSIZE,
  494. .PollingIntervalMS = USB_POLLING_INTERVAL_MS
  495. },
  496. #endif
  497. #ifdef RAW_ENABLE
  498. /*
  499. * Raw HID
  500. */
  501. .Raw_Interface = {
  502. .Header = {
  503. .Size = sizeof(USB_Descriptor_Interface_t),
  504. .Type = DTYPE_Interface
  505. },
  506. .InterfaceNumber = RAW_INTERFACE,
  507. .AlternateSetting = 0x00,
  508. .TotalEndpoints = 2,
  509. .Class = HID_CSCP_HIDClass,
  510. .SubClass = HID_CSCP_NonBootSubclass,
  511. .Protocol = HID_CSCP_NonBootProtocol,
  512. .InterfaceStrIndex = NO_DESCRIPTOR
  513. },
  514. .Raw_HID = {
  515. .Header = {
  516. .Size = sizeof(USB_HID_Descriptor_HID_t),
  517. .Type = HID_DTYPE_HID
  518. },
  519. .HIDSpec = VERSION_BCD(1, 1, 1),
  520. .CountryCode = 0x00,
  521. .TotalReportDescriptors = 1,
  522. .HIDReportType = HID_DTYPE_Report,
  523. .HIDReportLength = sizeof(RawReport)
  524. },
  525. .Raw_INEndpoint = {
  526. .Header = {
  527. .Size = sizeof(USB_Descriptor_Endpoint_t),
  528. .Type = DTYPE_Endpoint
  529. },
  530. .EndpointAddress = (ENDPOINT_DIR_IN | RAW_IN_EPNUM),
  531. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  532. .EndpointSize = RAW_EPSIZE,
  533. .PollingIntervalMS = 0x01
  534. },
  535. .Raw_OUTEndpoint = {
  536. .Header = {
  537. .Size = sizeof(USB_Descriptor_Endpoint_t),
  538. .Type = DTYPE_Endpoint
  539. },
  540. .EndpointAddress = (ENDPOINT_DIR_OUT | RAW_OUT_EPNUM),
  541. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  542. .EndpointSize = RAW_EPSIZE,
  543. .PollingIntervalMS = 0x01
  544. },
  545. #endif
  546. #if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
  547. /*
  548. * Mouse
  549. */
  550. .Mouse_Interface = {
  551. .Header = {
  552. .Size = sizeof(USB_Descriptor_Interface_t),
  553. .Type = DTYPE_Interface
  554. },
  555. .InterfaceNumber = MOUSE_INTERFACE,
  556. .AlternateSetting = 0x00,
  557. .TotalEndpoints = 1,
  558. .Class = HID_CSCP_HIDClass,
  559. .SubClass = HID_CSCP_BootSubclass,
  560. .Protocol = HID_CSCP_MouseBootProtocol,
  561. .InterfaceStrIndex = NO_DESCRIPTOR
  562. },
  563. .Mouse_HID = {
  564. .Header = {
  565. .Size = sizeof(USB_HID_Descriptor_HID_t),
  566. .Type = HID_DTYPE_HID
  567. },
  568. .HIDSpec = VERSION_BCD(1, 1, 1),
  569. .CountryCode = 0x00,
  570. .TotalReportDescriptors = 1,
  571. .HIDReportType = HID_DTYPE_Report,
  572. .HIDReportLength = sizeof(MouseReport)
  573. },
  574. .Mouse_INEndpoint = {
  575. .Header = {
  576. .Size = sizeof(USB_Descriptor_Endpoint_t),
  577. .Type = DTYPE_Endpoint
  578. },
  579. .EndpointAddress = (ENDPOINT_DIR_IN | MOUSE_IN_EPNUM),
  580. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  581. .EndpointSize = MOUSE_EPSIZE,
  582. .PollingIntervalMS = USB_POLLING_INTERVAL_MS
  583. },
  584. #endif
  585. #ifdef SHARED_EP_ENABLE
  586. /*
  587. * Shared
  588. */
  589. .Shared_Interface = {
  590. .Header = {
  591. .Size = sizeof(USB_Descriptor_Interface_t),
  592. .Type = DTYPE_Interface
  593. },
  594. .InterfaceNumber = SHARED_INTERFACE,
  595. .AlternateSetting = 0x00,
  596. .TotalEndpoints = 1,
  597. .Class = HID_CSCP_HIDClass,
  598. # ifdef KEYBOARD_SHARED_EP
  599. .SubClass = HID_CSCP_BootSubclass,
  600. .Protocol = HID_CSCP_KeyboardBootProtocol,
  601. # else
  602. .SubClass = HID_CSCP_NonBootSubclass,
  603. .Protocol = HID_CSCP_NonBootProtocol,
  604. # endif
  605. .InterfaceStrIndex = NO_DESCRIPTOR
  606. },
  607. .Shared_HID = {
  608. .Header = {
  609. .Size = sizeof(USB_HID_Descriptor_HID_t),
  610. .Type = HID_DTYPE_HID
  611. },
  612. .HIDSpec = VERSION_BCD(1, 1, 1),
  613. .CountryCode = 0x00,
  614. .TotalReportDescriptors = 1,
  615. .HIDReportType = HID_DTYPE_Report,
  616. .HIDReportLength = sizeof(SharedReport)
  617. },
  618. .Shared_INEndpoint = {
  619. .Header = {
  620. .Size = sizeof(USB_Descriptor_Endpoint_t),
  621. .Type = DTYPE_Endpoint
  622. },
  623. .EndpointAddress = (ENDPOINT_DIR_IN | SHARED_IN_EPNUM),
  624. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  625. .EndpointSize = SHARED_EPSIZE,
  626. .PollingIntervalMS = USB_POLLING_INTERVAL_MS
  627. },
  628. #endif
  629. #ifdef CONSOLE_ENABLE
  630. /*
  631. * Console
  632. */
  633. .Console_Interface = {
  634. .Header = {
  635. .Size = sizeof(USB_Descriptor_Interface_t),
  636. .Type = DTYPE_Interface
  637. },
  638. .InterfaceNumber = CONSOLE_INTERFACE,
  639. .AlternateSetting = 0x00,
  640. .TotalEndpoints = 2,
  641. .Class = HID_CSCP_HIDClass,
  642. .SubClass = HID_CSCP_NonBootSubclass,
  643. .Protocol = HID_CSCP_NonBootProtocol,
  644. .InterfaceStrIndex = NO_DESCRIPTOR
  645. },
  646. .Console_HID = {
  647. .Header = {
  648. .Size = sizeof(USB_HID_Descriptor_HID_t),
  649. .Type = HID_DTYPE_HID
  650. },
  651. .HIDSpec = VERSION_BCD(1, 1, 1),
  652. .CountryCode = 0x00,
  653. .TotalReportDescriptors = 1,
  654. .HIDReportType = HID_DTYPE_Report,
  655. .HIDReportLength = sizeof(ConsoleReport)
  656. },
  657. .Console_INEndpoint = {
  658. .Header = {
  659. .Size = sizeof(USB_Descriptor_Endpoint_t),
  660. .Type = DTYPE_Endpoint
  661. },
  662. .EndpointAddress = (ENDPOINT_DIR_IN | CONSOLE_IN_EPNUM),
  663. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  664. .EndpointSize = CONSOLE_EPSIZE,
  665. .PollingIntervalMS = 0x01
  666. },
  667. .Console_OUTEndpoint = {
  668. .Header = {
  669. .Size = sizeof(USB_Descriptor_Endpoint_t),
  670. .Type = DTYPE_Endpoint
  671. },
  672. .EndpointAddress = (ENDPOINT_DIR_OUT | CONSOLE_OUT_EPNUM),
  673. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  674. .EndpointSize = CONSOLE_EPSIZE,
  675. .PollingIntervalMS = 0x01
  676. },
  677. #endif
  678. #ifdef MIDI_ENABLE
  679. /*
  680. * MIDI
  681. */
  682. .Audio_Interface_Association = {
  683. .Header = {
  684. .Size = sizeof(USB_Descriptor_Interface_Association_t),
  685. .Type = DTYPE_InterfaceAssociation
  686. },
  687. .FirstInterfaceIndex = AC_INTERFACE,
  688. .TotalInterfaces = 2,
  689. .Class = AUDIO_CSCP_AudioClass,
  690. .SubClass = AUDIO_CSCP_ControlSubclass,
  691. .Protocol = AUDIO_CSCP_ControlProtocol,
  692. .IADStrIndex = NO_DESCRIPTOR,
  693. },
  694. .Audio_ControlInterface = {
  695. .Header = {
  696. .Size = sizeof(USB_Descriptor_Interface_t),
  697. .Type = DTYPE_Interface
  698. },
  699. .InterfaceNumber = AC_INTERFACE,
  700. .AlternateSetting = 0,
  701. .TotalEndpoints = 0,
  702. .Class = AUDIO_CSCP_AudioClass,
  703. .SubClass = AUDIO_CSCP_ControlSubclass,
  704. .Protocol = AUDIO_CSCP_ControlProtocol,
  705. .InterfaceStrIndex = NO_DESCRIPTOR
  706. },
  707. .Audio_ControlInterface_SPC = {
  708. .Header = {
  709. .Size = sizeof(USB_Audio_Descriptor_Interface_AC_t),
  710. .Type = AUDIO_DTYPE_CSInterface
  711. },
  712. .Subtype = AUDIO_DSUBTYPE_CSInterface_Header,
  713. .ACSpecification = VERSION_BCD(1, 0, 0),
  714. .TotalLength = sizeof(USB_Audio_Descriptor_Interface_AC_t),
  715. .InCollection = 1,
  716. .InterfaceNumber = AS_INTERFACE,
  717. },
  718. .Audio_StreamInterface = {
  719. .Header = {
  720. .Size = sizeof(USB_Descriptor_Interface_t),
  721. .Type = DTYPE_Interface
  722. },
  723. .InterfaceNumber = AS_INTERFACE,
  724. .AlternateSetting = 0,
  725. .TotalEndpoints = 2,
  726. .Class = AUDIO_CSCP_AudioClass,
  727. .SubClass = AUDIO_CSCP_MIDIStreamingSubclass,
  728. .Protocol = AUDIO_CSCP_StreamingProtocol,
  729. .InterfaceStrIndex = NO_DESCRIPTOR
  730. },
  731. .Audio_StreamInterface_SPC = {
  732. .Header = {
  733. .Size = sizeof(USB_MIDI_Descriptor_AudioInterface_AS_t),
  734. .Type = AUDIO_DTYPE_CSInterface
  735. },
  736. .Subtype = AUDIO_DSUBTYPE_CSInterface_General,
  737. .AudioSpecification = VERSION_BCD(1, 0, 0),
  738. .TotalLength = offsetof(USB_Descriptor_Configuration_t, MIDI_Out_Jack_Endpoint_SPC) + sizeof(USB_MIDI_Descriptor_Jack_Endpoint_t) - offsetof(USB_Descriptor_Configuration_t, Audio_StreamInterface_SPC)
  739. },
  740. .MIDI_In_Jack_Emb = {
  741. .Header = {
  742. .Size = sizeof(USB_MIDI_Descriptor_InputJack_t),
  743. .Type = AUDIO_DTYPE_CSInterface
  744. },
  745. .Subtype = AUDIO_DSUBTYPE_CSInterface_InputTerminal,
  746. .JackType = MIDI_JACKTYPE_Embedded,
  747. .JackID = 0x01,
  748. .JackStrIndex = NO_DESCRIPTOR
  749. },
  750. .MIDI_In_Jack_Ext = {
  751. .Header = {
  752. .Size = sizeof(USB_MIDI_Descriptor_InputJack_t),
  753. .Type = AUDIO_DTYPE_CSInterface
  754. },
  755. .Subtype = AUDIO_DSUBTYPE_CSInterface_InputTerminal,
  756. .JackType = MIDI_JACKTYPE_External,
  757. .JackID = 0x02,
  758. .JackStrIndex = NO_DESCRIPTOR
  759. },
  760. .MIDI_Out_Jack_Emb = {
  761. .Header = {
  762. .Size = sizeof(USB_MIDI_Descriptor_OutputJack_t),
  763. .Type = AUDIO_DTYPE_CSInterface
  764. },
  765. .Subtype = AUDIO_DSUBTYPE_CSInterface_OutputTerminal,
  766. .JackType = MIDI_JACKTYPE_Embedded,
  767. .JackID = 0x03,
  768. .NumberOfPins = 1,
  769. .SourceJackID = {0x02},
  770. .SourcePinID = {0x01},
  771. .JackStrIndex = NO_DESCRIPTOR
  772. },
  773. .MIDI_Out_Jack_Ext = {
  774. .Header = {
  775. .Size = sizeof(USB_MIDI_Descriptor_OutputJack_t),
  776. .Type = AUDIO_DTYPE_CSInterface
  777. },
  778. .Subtype = AUDIO_DSUBTYPE_CSInterface_OutputTerminal,
  779. .JackType = MIDI_JACKTYPE_External,
  780. .JackID = 0x04,
  781. .NumberOfPins = 1,
  782. .SourceJackID = {0x01},
  783. .SourcePinID = {0x01},
  784. .JackStrIndex = NO_DESCRIPTOR
  785. },
  786. .MIDI_In_Jack_Endpoint = {
  787. .Endpoint = {
  788. .Header = {
  789. .Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t),
  790. .Type = DTYPE_Endpoint
  791. },
  792. .EndpointAddress = (ENDPOINT_DIR_OUT | MIDI_STREAM_OUT_EPNUM),
  793. .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  794. .EndpointSize = MIDI_STREAM_EPSIZE,
  795. .PollingIntervalMS = 0x05
  796. },
  797. .Refresh = 0,
  798. .SyncEndpointNumber = 0
  799. },
  800. .MIDI_In_Jack_Endpoint_SPC = {
  801. .Header = {
  802. .Size = sizeof(USB_MIDI_Descriptor_Jack_Endpoint_t),
  803. .Type = AUDIO_DTYPE_CSEndpoint
  804. },
  805. .Subtype = AUDIO_DSUBTYPE_CSEndpoint_General,
  806. .TotalEmbeddedJacks = 0x01,
  807. .AssociatedJackID = {0x01}
  808. },
  809. .MIDI_Out_Jack_Endpoint = {
  810. .Endpoint = {
  811. .Header = {
  812. .Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t),
  813. .Type = DTYPE_Endpoint
  814. },
  815. .EndpointAddress = (ENDPOINT_DIR_IN | MIDI_STREAM_IN_EPNUM),
  816. .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  817. .EndpointSize = MIDI_STREAM_EPSIZE,
  818. .PollingIntervalMS = 0x05
  819. },
  820. .Refresh = 0,
  821. .SyncEndpointNumber = 0
  822. },
  823. .MIDI_Out_Jack_Endpoint_SPC = {
  824. .Header = {
  825. .Size = sizeof(USB_MIDI_Descriptor_Jack_Endpoint_t),
  826. .Type = AUDIO_DTYPE_CSEndpoint
  827. },
  828. .Subtype = AUDIO_DSUBTYPE_CSEndpoint_General,
  829. .TotalEmbeddedJacks = 0x01,
  830. .AssociatedJackID = {0x03}
  831. },
  832. #endif
  833. #ifdef VIRTSER_ENABLE
  834. /*
  835. * Virtual Serial
  836. */
  837. .CDC_Interface_Association = {
  838. .Header = {
  839. .Size = sizeof(USB_Descriptor_Interface_Association_t),
  840. .Type = DTYPE_InterfaceAssociation
  841. },
  842. .FirstInterfaceIndex = CCI_INTERFACE,
  843. .TotalInterfaces = 2,
  844. .Class = CDC_CSCP_CDCClass,
  845. .SubClass = CDC_CSCP_ACMSubclass,
  846. .Protocol = CDC_CSCP_ATCommandProtocol,
  847. .IADStrIndex = NO_DESCRIPTOR,
  848. },
  849. .CDC_CCI_Interface = {
  850. .Header = {
  851. .Size = sizeof(USB_Descriptor_Interface_t),
  852. .Type = DTYPE_Interface
  853. },
  854. .InterfaceNumber = CCI_INTERFACE,
  855. .AlternateSetting = 0,
  856. .TotalEndpoints = 1,
  857. .Class = CDC_CSCP_CDCClass,
  858. .SubClass = CDC_CSCP_ACMSubclass,
  859. .Protocol = CDC_CSCP_ATCommandProtocol,
  860. .InterfaceStrIndex = NO_DESCRIPTOR
  861. },
  862. .CDC_Functional_Header = {
  863. .Header = {
  864. .Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t),
  865. .Type = CDC_DTYPE_CSInterface
  866. },
  867. .Subtype = 0x00,
  868. .CDCSpecification = VERSION_BCD(1, 1, 0),
  869. },
  870. .CDC_Functional_ACM = {
  871. .Header = {
  872. .Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t),
  873. .Type = CDC_DTYPE_CSInterface
  874. },
  875. .Subtype = 0x02,
  876. .Capabilities = 0x02,
  877. },
  878. .CDC_Functional_Union = {
  879. .Header = {
  880. .Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t),
  881. .Type = CDC_DTYPE_CSInterface
  882. },
  883. .Subtype = 0x06,
  884. .MasterInterfaceNumber = CCI_INTERFACE,
  885. .SlaveInterfaceNumber = CDI_INTERFACE,
  886. },
  887. .CDC_NotificationEndpoint = {
  888. .Header = {
  889. .Size = sizeof(USB_Descriptor_Endpoint_t),
  890. .Type = DTYPE_Endpoint
  891. },
  892. .EndpointAddress = (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM),
  893. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  894. .EndpointSize = CDC_NOTIFICATION_EPSIZE,
  895. .PollingIntervalMS = 0xFF
  896. },
  897. .CDC_DCI_Interface = {
  898. .Header = {
  899. .Size = sizeof(USB_Descriptor_Interface_t),
  900. .Type = DTYPE_Interface
  901. },
  902. .InterfaceNumber = CDI_INTERFACE,
  903. .AlternateSetting = 0,
  904. .TotalEndpoints = 2,
  905. .Class = CDC_CSCP_CDCDataClass,
  906. .SubClass = CDC_CSCP_NoDataSubclass,
  907. .Protocol = CDC_CSCP_NoDataProtocol,
  908. .InterfaceStrIndex = NO_DESCRIPTOR
  909. },
  910. .CDC_DataOutEndpoint = {
  911. .Header = {
  912. .Size = sizeof(USB_Descriptor_Endpoint_t),
  913. .Type = DTYPE_Endpoint
  914. },
  915. .EndpointAddress = (ENDPOINT_DIR_OUT | CDC_OUT_EPNUM),
  916. .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  917. .EndpointSize = CDC_EPSIZE,
  918. .PollingIntervalMS = 0x05
  919. },
  920. .CDC_DataInEndpoint = {
  921. .Header = {
  922. .Size = sizeof(USB_Descriptor_Endpoint_t),
  923. .Type = DTYPE_Endpoint
  924. },
  925. .EndpointAddress = (ENDPOINT_DIR_IN | CDC_IN_EPNUM),
  926. .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  927. .EndpointSize = CDC_EPSIZE,
  928. .PollingIntervalMS = 0x05
  929. },
  930. #endif
  931. #if defined(JOYSTICK_ENABLE) && !defined(JOYSTICK_SHARED_EP)
  932. /*
  933. * Joystick
  934. */
  935. .Joystick_Interface = {
  936. .Header = {
  937. .Size = sizeof(USB_Descriptor_Interface_t),
  938. .Type = DTYPE_Interface
  939. },
  940. .InterfaceNumber = JOYSTICK_INTERFACE,
  941. .AlternateSetting = 0x00,
  942. .TotalEndpoints = 1,
  943. .Class = HID_CSCP_HIDClass,
  944. .SubClass = HID_CSCP_NonBootSubclass,
  945. .Protocol = HID_CSCP_NonBootProtocol,
  946. .InterfaceStrIndex = NO_DESCRIPTOR
  947. },
  948. .Joystick_HID = {
  949. .Header = {
  950. .Size = sizeof(USB_HID_Descriptor_HID_t),
  951. .Type = HID_DTYPE_HID
  952. },
  953. .HIDSpec = VERSION_BCD(1, 1, 1),
  954. .CountryCode = 0x00,
  955. .TotalReportDescriptors = 1,
  956. .HIDReportType = HID_DTYPE_Report,
  957. .HIDReportLength = sizeof(JoystickReport)
  958. },
  959. .Joystick_INEndpoint = {
  960. .Header = {
  961. .Size = sizeof(USB_Descriptor_Endpoint_t),
  962. .Type = DTYPE_Endpoint
  963. },
  964. .EndpointAddress = (ENDPOINT_DIR_IN | JOYSTICK_IN_EPNUM),
  965. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  966. .EndpointSize = JOYSTICK_EPSIZE,
  967. .PollingIntervalMS = USB_POLLING_INTERVAL_MS
  968. }
  969. #endif
  970. #if defined(DIGITIZER_ENABLE) && !defined(DIGITIZER_SHARED_EP)
  971. /*
  972. * Digitizer
  973. */
  974. .Digitizer_Interface = {
  975. .Header = {
  976. .Size = sizeof(USB_Descriptor_Interface_t),
  977. .Type = DTYPE_Interface
  978. },
  979. .InterfaceNumber = DIGITIZER_INTERFACE,
  980. .AlternateSetting = 0x00,
  981. .TotalEndpoints = 1,
  982. .Class = HID_CSCP_HIDClass,
  983. .SubClass = HID_CSCP_NonBootSubclass,
  984. .Protocol = HID_CSCP_NonBootProtocol,
  985. .InterfaceStrIndex = NO_DESCRIPTOR
  986. },
  987. .Digitizer_HID = {
  988. .Header = {
  989. .Size = sizeof(USB_HID_Descriptor_HID_t),
  990. .Type = HID_DTYPE_HID
  991. },
  992. .HIDSpec = VERSION_BCD(1, 1, 1),
  993. .CountryCode = 0x00,
  994. .TotalReportDescriptors = 1,
  995. .HIDReportType = HID_DTYPE_Report,
  996. .HIDReportLength = sizeof(DigitizerReport)
  997. },
  998. .Digitizer_INEndpoint = {
  999. .Header = {
  1000. .Size = sizeof(USB_Descriptor_Endpoint_t),
  1001. .Type = DTYPE_Endpoint
  1002. },
  1003. .EndpointAddress = (ENDPOINT_DIR_IN | DIGITIZER_IN_EPNUM),
  1004. .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  1005. .EndpointSize = DIGITIZER_EPSIZE,
  1006. .PollingIntervalMS = USB_POLLING_INTERVAL_MS
  1007. },
  1008. #endif
  1009. };
  1010. /*
  1011. * String descriptors
  1012. */
  1013. const USB_Descriptor_String_t PROGMEM LanguageString = {
  1014. .Header = {
  1015. .Size = 4,
  1016. .Type = DTYPE_String
  1017. },
  1018. .UnicodeString = {LANGUAGE_ID_ENG}
  1019. };
  1020. const USB_Descriptor_String_t PROGMEM ManufacturerString = {
  1021. .Header = {
  1022. .Size = sizeof(USBSTR(MANUFACTURER)),
  1023. .Type = DTYPE_String
  1024. },
  1025. .UnicodeString = USBSTR(MANUFACTURER)
  1026. };
  1027. const USB_Descriptor_String_t PROGMEM ProductString = {
  1028. .Header = {
  1029. .Size = sizeof(USBSTR(PRODUCT)),
  1030. .Type = DTYPE_String
  1031. },
  1032. .UnicodeString = USBSTR(PRODUCT)
  1033. };
  1034. #if defined(SERIAL_NUMBER)
  1035. const USB_Descriptor_String_t PROGMEM SerialNumberString = {
  1036. .Header = {
  1037. .Size = sizeof(USBSTR(SERIAL_NUMBER)),
  1038. .Type = DTYPE_String
  1039. },
  1040. .UnicodeString = USBSTR(SERIAL_NUMBER)
  1041. };
  1042. #endif
  1043. // clang-format on
  1044. /**
  1045. * This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  1046. * documentation) by the application code so that the address and size of a requested descriptor can be given
  1047. * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
  1048. * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  1049. * USB host.
  1050. */
  1051. uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const uint16_t wLength, const void** const DescriptorAddress) {
  1052. const uint8_t DescriptorType = (wValue >> 8);
  1053. const uint8_t DescriptorIndex = (wValue & 0xFF);
  1054. const void* Address = NULL;
  1055. uint16_t Size = NO_DESCRIPTOR;
  1056. switch (DescriptorType) {
  1057. case DTYPE_Device:
  1058. Address = &DeviceDescriptor;
  1059. Size = sizeof(USB_Descriptor_Device_t);
  1060. break;
  1061. case DTYPE_Configuration:
  1062. Address = &ConfigurationDescriptor;
  1063. Size = sizeof(USB_Descriptor_Configuration_t);
  1064. break;
  1065. case DTYPE_String:
  1066. switch (DescriptorIndex) {
  1067. case 0x00:
  1068. Address = &LanguageString;
  1069. Size = pgm_read_byte(&LanguageString.Header.Size);
  1070. break;
  1071. case 0x01:
  1072. Address = &ManufacturerString;
  1073. Size = pgm_read_byte(&ManufacturerString.Header.Size);
  1074. break;
  1075. case 0x02:
  1076. Address = &ProductString;
  1077. Size = pgm_read_byte(&ProductString.Header.Size);
  1078. break;
  1079. #if defined(SERIAL_NUMBER)
  1080. case 0x03:
  1081. Address = &SerialNumberString;
  1082. Size = pgm_read_byte(&SerialNumberString.Header.Size);
  1083. break;
  1084. #endif
  1085. }
  1086. #ifdef OS_DETECTION_ENABLE
  1087. process_wlength(wLength);
  1088. #endif
  1089. break;
  1090. case HID_DTYPE_HID:
  1091. switch (wIndex) {
  1092. #ifndef KEYBOARD_SHARED_EP
  1093. case KEYBOARD_INTERFACE:
  1094. Address = &ConfigurationDescriptor.Keyboard_HID;
  1095. Size = sizeof(USB_HID_Descriptor_HID_t);
  1096. break;
  1097. #endif
  1098. #if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
  1099. case MOUSE_INTERFACE:
  1100. Address = &ConfigurationDescriptor.Mouse_HID;
  1101. Size = sizeof(USB_HID_Descriptor_HID_t);
  1102. break;
  1103. #endif
  1104. #ifdef SHARED_EP_ENABLE
  1105. case SHARED_INTERFACE:
  1106. Address = &ConfigurationDescriptor.Shared_HID;
  1107. Size = sizeof(USB_HID_Descriptor_HID_t);
  1108. break;
  1109. #endif
  1110. #ifdef RAW_ENABLE
  1111. case RAW_INTERFACE:
  1112. Address = &ConfigurationDescriptor.Raw_HID;
  1113. Size = sizeof(USB_HID_Descriptor_HID_t);
  1114. break;
  1115. #endif
  1116. #ifdef CONSOLE_ENABLE
  1117. case CONSOLE_INTERFACE:
  1118. Address = &ConfigurationDescriptor.Console_HID;
  1119. Size = sizeof(USB_HID_Descriptor_HID_t);
  1120. break;
  1121. #endif
  1122. #if defined(JOYSTICK_ENABLE) && !defined(JOYSTICK_SHARED_EP)
  1123. case JOYSTICK_INTERFACE:
  1124. Address = &ConfigurationDescriptor.Joystick_HID;
  1125. Size = sizeof(USB_HID_Descriptor_HID_t);
  1126. break;
  1127. #endif
  1128. #if defined(DIGITIZER_ENABLE) && !defined(DIGITIZER_SHARED_EP)
  1129. case DIGITIZER_INTERFACE:
  1130. Address = &ConfigurationDescriptor.Digitizer_HID;
  1131. Size = sizeof(USB_HID_Descriptor_HID_t);
  1132. break;
  1133. #endif
  1134. }
  1135. break;
  1136. case HID_DTYPE_Report:
  1137. switch (wIndex) {
  1138. #ifndef KEYBOARD_SHARED_EP
  1139. case KEYBOARD_INTERFACE:
  1140. Address = &KeyboardReport;
  1141. Size = sizeof(KeyboardReport);
  1142. break;
  1143. #endif
  1144. #if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
  1145. case MOUSE_INTERFACE:
  1146. Address = &MouseReport;
  1147. Size = sizeof(MouseReport);
  1148. break;
  1149. #endif
  1150. #ifdef SHARED_EP_ENABLE
  1151. case SHARED_INTERFACE:
  1152. Address = &SharedReport;
  1153. Size = sizeof(SharedReport);
  1154. break;
  1155. #endif
  1156. #ifdef RAW_ENABLE
  1157. case RAW_INTERFACE:
  1158. Address = &RawReport;
  1159. Size = sizeof(RawReport);
  1160. break;
  1161. #endif
  1162. #ifdef CONSOLE_ENABLE
  1163. case CONSOLE_INTERFACE:
  1164. Address = &ConsoleReport;
  1165. Size = sizeof(ConsoleReport);
  1166. break;
  1167. #endif
  1168. #if defined(JOYSTICK_ENABLE) && !defined(JOYSTICK_SHARED_EP)
  1169. case JOYSTICK_INTERFACE:
  1170. Address = &JoystickReport;
  1171. Size = sizeof(JoystickReport);
  1172. break;
  1173. #endif
  1174. #if defined(DIGITIZER_ENABLE) && !defined(DIGITIZER_SHARED_EP)
  1175. case DIGITIZER_INTERFACE:
  1176. Address = &DigitizerReport;
  1177. Size = sizeof(DigitizerReport);
  1178. break;
  1179. #endif
  1180. }
  1181. break;
  1182. }
  1183. *DescriptorAddress = Address;
  1184. return Size;
  1185. }