usb_descriptor.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. /*
  2. * Copyright 2012,2013 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. /** \file
  34. *
  35. * Header file for Descriptors.c.
  36. */
  37. #pragma once
  38. #include <LUFA/Drivers/USB/USB.h>
  39. #ifdef PROTOCOL_CHIBIOS
  40. # include <hal.h>
  41. #endif
  42. /*
  43. * USB descriptor structure
  44. */
  45. typedef struct {
  46. USB_Descriptor_Configuration_Header_t Config;
  47. #ifndef KEYBOARD_SHARED_EP
  48. // Keyboard HID Interface
  49. USB_Descriptor_Interface_t Keyboard_Interface;
  50. USB_HID_Descriptor_HID_t Keyboard_HID;
  51. USB_Descriptor_Endpoint_t Keyboard_INEndpoint;
  52. #else
  53. // Shared Interface
  54. USB_Descriptor_Interface_t Shared_Interface;
  55. USB_HID_Descriptor_HID_t Shared_HID;
  56. USB_Descriptor_Endpoint_t Shared_INEndpoint;
  57. #endif
  58. #ifdef RAW_ENABLE
  59. // Raw HID Interface
  60. USB_Descriptor_Interface_t Raw_Interface;
  61. USB_HID_Descriptor_HID_t Raw_HID;
  62. USB_Descriptor_Endpoint_t Raw_INEndpoint;
  63. USB_Descriptor_Endpoint_t Raw_OUTEndpoint;
  64. #endif
  65. #if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
  66. // Mouse HID Interface
  67. USB_Descriptor_Interface_t Mouse_Interface;
  68. USB_HID_Descriptor_HID_t Mouse_HID;
  69. USB_Descriptor_Endpoint_t Mouse_INEndpoint;
  70. #endif
  71. #if defined(SHARED_EP_ENABLE) && !defined(KEYBOARD_SHARED_EP)
  72. // Shared Interface
  73. USB_Descriptor_Interface_t Shared_Interface;
  74. USB_HID_Descriptor_HID_t Shared_HID;
  75. USB_Descriptor_Endpoint_t Shared_INEndpoint;
  76. #endif
  77. #ifdef CONSOLE_ENABLE
  78. // Console HID Interface
  79. USB_Descriptor_Interface_t Console_Interface;
  80. USB_HID_Descriptor_HID_t Console_HID;
  81. USB_Descriptor_Endpoint_t Console_INEndpoint;
  82. USB_Descriptor_Endpoint_t Console_OUTEndpoint;
  83. #endif
  84. #ifdef MIDI_ENABLE
  85. USB_Descriptor_Interface_Association_t Audio_Interface_Association;
  86. // MIDI Audio Control Interface
  87. USB_Descriptor_Interface_t Audio_ControlInterface;
  88. USB_Audio_Descriptor_Interface_AC_t Audio_ControlInterface_SPC;
  89. // MIDI Audio Streaming Interface
  90. USB_Descriptor_Interface_t Audio_StreamInterface;
  91. USB_MIDI_Descriptor_AudioInterface_AS_t Audio_StreamInterface_SPC;
  92. USB_MIDI_Descriptor_InputJack_t MIDI_In_Jack_Emb;
  93. USB_MIDI_Descriptor_InputJack_t MIDI_In_Jack_Ext;
  94. USB_MIDI_Descriptor_OutputJack_t MIDI_Out_Jack_Emb;
  95. USB_MIDI_Descriptor_OutputJack_t MIDI_Out_Jack_Ext;
  96. USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_In_Jack_Endpoint;
  97. USB_MIDI_Descriptor_Jack_Endpoint_t MIDI_In_Jack_Endpoint_SPC;
  98. USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_Out_Jack_Endpoint;
  99. USB_MIDI_Descriptor_Jack_Endpoint_t MIDI_Out_Jack_Endpoint_SPC;
  100. #endif
  101. #ifdef VIRTSER_ENABLE
  102. USB_Descriptor_Interface_Association_t CDC_Interface_Association;
  103. // CDC Control Interface
  104. USB_Descriptor_Interface_t CDC_CCI_Interface;
  105. USB_CDC_Descriptor_FunctionalHeader_t CDC_Functional_Header;
  106. USB_CDC_Descriptor_FunctionalACM_t CDC_Functional_ACM;
  107. USB_CDC_Descriptor_FunctionalUnion_t CDC_Functional_Union;
  108. USB_Descriptor_Endpoint_t CDC_NotificationEndpoint;
  109. // CDC Data Interface
  110. USB_Descriptor_Interface_t CDC_DCI_Interface;
  111. USB_Descriptor_Endpoint_t CDC_DataOutEndpoint;
  112. USB_Descriptor_Endpoint_t CDC_DataInEndpoint;
  113. #endif
  114. #ifdef JOYSTICK_ENABLE
  115. // Joystick HID Interface
  116. USB_Descriptor_Interface_t Joystick_Interface;
  117. USB_HID_Descriptor_HID_t Joystick_HID;
  118. USB_Descriptor_Endpoint_t Joystick_INEndpoint;
  119. #endif
  120. } USB_Descriptor_Configuration_t;
  121. /*
  122. * Interface indexes
  123. */
  124. enum usb_interfaces {
  125. #ifndef KEYBOARD_SHARED_EP
  126. KEYBOARD_INTERFACE,
  127. #else
  128. SHARED_INTERFACE,
  129. # define KEYBOARD_INTERFACE SHARED_INTERFACE
  130. #endif
  131. // It is important that the Raw HID interface is at a constant
  132. // interface number, to support Linux/OSX platforms and chrome.hid
  133. // If Raw HID is enabled, let it be always 1.
  134. #ifdef RAW_ENABLE
  135. RAW_INTERFACE,
  136. #endif
  137. #if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
  138. MOUSE_INTERFACE,
  139. #endif
  140. #if defined(SHARED_EP_ENABLE) && !defined(KEYBOARD_SHARED_EP)
  141. SHARED_INTERFACE,
  142. #endif
  143. #ifdef CONSOLE_ENABLE
  144. CONSOLE_INTERFACE,
  145. #endif
  146. #ifdef MIDI_ENABLE
  147. AC_INTERFACE,
  148. AS_INTERFACE,
  149. #endif
  150. #ifdef VIRTSER_ENABLE
  151. CCI_INTERFACE,
  152. CDI_INTERFACE,
  153. #endif
  154. #if defined(JOYSTICK_ENABLE)
  155. JOYSTICK_INTERFACE,
  156. #endif
  157. TOTAL_INTERFACES
  158. };
  159. #define NEXT_EPNUM __COUNTER__
  160. /*
  161. * Endpoint numbers
  162. */
  163. enum usb_endpoints {
  164. __unused_epnum__ = NEXT_EPNUM, // Endpoint numbering starts at 1
  165. #ifndef KEYBOARD_SHARED_EP
  166. KEYBOARD_IN_EPNUM = NEXT_EPNUM,
  167. #else
  168. # define KEYBOARD_IN_EPNUM SHARED_IN_EPNUM
  169. #endif
  170. #if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
  171. MOUSE_IN_EPNUM = NEXT_EPNUM,
  172. #else
  173. # define MOUSE_IN_EPNUM SHARED_IN_EPNUM
  174. #endif
  175. #ifdef RAW_ENABLE
  176. RAW_IN_EPNUM = NEXT_EPNUM,
  177. # if STM32_USB_USE_OTG1
  178. # define RAW_OUT_EPNUM RAW_IN_EPNUM
  179. # else
  180. RAW_OUT_EPNUM = NEXT_EPNUM,
  181. # endif
  182. #endif
  183. #ifdef SHARED_EP_ENABLE
  184. SHARED_IN_EPNUM = NEXT_EPNUM,
  185. #endif
  186. #ifdef CONSOLE_ENABLE
  187. CONSOLE_IN_EPNUM = NEXT_EPNUM,
  188. # ifdef PROTOCOL_CHIBIOS
  189. // ChibiOS has enough memory and descriptor to actually enable the endpoint
  190. // It could use the same endpoint numbers, as that's supported by ChibiOS
  191. // But the QMK code currently assumes that the endpoint numbers are different
  192. # if STM32_USB_USE_OTG1
  193. # define CONSOLE_OUT_EPNUM CONSOLE_IN_EPNUM
  194. # else
  195. CONSOLE_OUT_EPNUM = NEXT_EPNUM,
  196. # endif
  197. # else
  198. # define CONSOLE_OUT_EPNUM CONSOLE_IN_EPNUM
  199. # endif
  200. #endif
  201. #ifdef MIDI_ENABLE
  202. MIDI_STREAM_IN_EPNUM = NEXT_EPNUM,
  203. # if STM32_USB_USE_OTG1
  204. # define MIDI_STREAM_OUT_EPNUM MIDI_STREAM_IN_EPNUM
  205. # else
  206. MIDI_STREAM_OUT_EPNUM = NEXT_EPNUM,
  207. # endif
  208. #endif
  209. #ifdef VIRTSER_ENABLE
  210. CDC_NOTIFICATION_EPNUM = NEXT_EPNUM,
  211. CDC_IN_EPNUM = NEXT_EPNUM,
  212. # if STM32_USB_USE_OTG1
  213. # define CDC_OUT_EPNUM CDC_IN_EPNUM
  214. # else
  215. CDC_OUT_EPNUM = NEXT_EPNUM,
  216. # endif
  217. #endif
  218. #ifdef JOYSTICK_ENABLE
  219. JOYSTICK_IN_EPNUM = NEXT_EPNUM,
  220. # if STM32_USB_USE_OTG1
  221. JOYSTICK_OUT_EPNUM = JOYSTICK_IN_EPNUM,
  222. # else
  223. JOYSTICK_OUT_EPNUM = NEXT_EPNUM,
  224. # endif
  225. #endif
  226. };
  227. #ifdef PROTOCOL_LUFA
  228. // LUFA tells us total endpoints including control
  229. # define MAX_ENDPOINTS (ENDPOINT_TOTAL_ENDPOINTS - 1)
  230. #elif defined(PROTOCOL_CHIBIOS)
  231. // ChibiOS gives us number of available user endpoints, not control
  232. # define MAX_ENDPOINTS USB_MAX_ENDPOINTS
  233. #endif
  234. // TODO - ARM_ATSAM
  235. #if (NEXT_EPNUM - 1) > MAX_ENDPOINTS
  236. # error There are not enough available endpoints to support all functions. Please disable one or more of the following: Mouse Keys, Extra Keys, Console, NKRO, MIDI, Serial, Steno
  237. #endif
  238. #define KEYBOARD_EPSIZE 8
  239. #define SHARED_EPSIZE 32
  240. #define MOUSE_EPSIZE 8
  241. #define RAW_EPSIZE 32
  242. #define CONSOLE_EPSIZE 32
  243. #define MIDI_STREAM_EPSIZE 64
  244. #define CDC_NOTIFICATION_EPSIZE 8
  245. #define CDC_EPSIZE 16
  246. #define JOYSTICK_EPSIZE 8
  247. uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const void** const DescriptorAddress);