usb_descriptor.c 46 KB

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