usb_descriptor.h 7.6 KB

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