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
10 Copyright (C) Dean Camera, 2012.
12 dean [at] fourwalledcubicle [dot] com
17 Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
18 Copyright 2010 Denver Gingerich (denver [at] ossguy [dot] com)
20 Permission to use, copy, modify, distribute, and sell this
21 software and its documentation for any purpose is hereby granted
22 without fee, provided that the above copyright notice appear in
23 all copies and that both that the copyright notice and this
24 permission notice and warranty disclaimer appear in supporting
25 documentation, and that the name of the author not be used in
26 advertising or publicity pertaining to distribution of the
27 software without specific, written prior permission.
29 The author disclaim all warranties with regard to this
30 software, including all implied warranties of merchantability
31 and fitness. In no event shall the author be liable for any
32 special, indirect or consequential damages or any damages
33 whatsoever resulting from loss of use, data or profits, whether
34 in an action of contract, negligence or other tortious action,
35 arising out of or in connection with the use or performance of
41 * Header file for Descriptors.c.
44 #ifndef _DESCRIPTORS_H_
45 #define _DESCRIPTORS_H_
47 #include <LUFA/Drivers/USB/USB.h>
48 #ifdef PROTOCOL_CHIBIOS
54 USB_Descriptor_Configuration_Header_t Config;
56 // Keyboard HID Interface
57 USB_Descriptor_Interface_t Keyboard_Interface;
58 USB_HID_Descriptor_HID_t Keyboard_HID;
59 USB_Descriptor_Endpoint_t Keyboard_INEndpoint;
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;
68 #ifdef EXTRAKEY_ENABLE
69 // Extrakey HID Interface
70 USB_Descriptor_Interface_t Extrakey_Interface;
71 USB_HID_Descriptor_HID_t Extrakey_HID;
72 USB_Descriptor_Endpoint_t Extrakey_INEndpoint;
77 USB_Descriptor_Interface_t Raw_Interface;
78 USB_HID_Descriptor_HID_t Raw_HID;
79 USB_Descriptor_Endpoint_t Raw_INEndpoint;
80 USB_Descriptor_Endpoint_t Raw_OUTEndpoint;
84 // Console HID Interface
85 USB_Descriptor_Interface_t Console_Interface;
86 USB_HID_Descriptor_HID_t Console_HID;
87 USB_Descriptor_Endpoint_t Console_INEndpoint;
88 USB_Descriptor_Endpoint_t Console_OUTEndpoint;
93 USB_Descriptor_Interface_t NKRO_Interface;
94 USB_HID_Descriptor_HID_t NKRO_HID;
95 USB_Descriptor_Endpoint_t NKRO_INEndpoint;
99 USB_Descriptor_Interface_Association_t Audio_Interface_Association;
100 // MIDI Audio Control Interface
101 USB_Descriptor_Interface_t Audio_ControlInterface;
102 USB_Audio_Descriptor_Interface_AC_t Audio_ControlInterface_SPC;
104 // MIDI Audio Streaming Interface
105 USB_Descriptor_Interface_t Audio_StreamInterface;
106 USB_MIDI_Descriptor_AudioInterface_AS_t Audio_StreamInterface_SPC;
107 USB_MIDI_Descriptor_InputJack_t MIDI_In_Jack_Emb;
108 USB_MIDI_Descriptor_InputJack_t MIDI_In_Jack_Ext;
109 USB_MIDI_Descriptor_OutputJack_t MIDI_Out_Jack_Emb;
110 USB_MIDI_Descriptor_OutputJack_t MIDI_Out_Jack_Ext;
111 USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_In_Jack_Endpoint;
112 USB_MIDI_Descriptor_Jack_Endpoint_t MIDI_In_Jack_Endpoint_SPC;
113 USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_Out_Jack_Endpoint;
114 USB_MIDI_Descriptor_Jack_Endpoint_t MIDI_Out_Jack_Endpoint_SPC;
117 #ifdef VIRTSER_ENABLE
118 USB_Descriptor_Interface_Association_t CDC_Interface_Association;
120 // CDC Control Interface
121 USB_Descriptor_Interface_t CDC_CCI_Interface;
122 USB_CDC_Descriptor_FunctionalHeader_t CDC_Functional_Header;
123 USB_CDC_Descriptor_FunctionalACM_t CDC_Functional_ACM;
124 USB_CDC_Descriptor_FunctionalUnion_t CDC_Functional_Union;
125 USB_Descriptor_Endpoint_t CDC_NotificationEndpoint;
127 // CDC Data Interface
128 USB_Descriptor_Interface_t CDC_DCI_Interface;
129 USB_Descriptor_Endpoint_t CDC_DataOutEndpoint;
130 USB_Descriptor_Endpoint_t CDC_DataInEndpoint;
132 } USB_Descriptor_Configuration_t;
135 /* index of interface */
136 #define KEYBOARD_INTERFACE 0
138 // It is important that the Raw HID interface is at a constant
139 // interface number, to support Linux/OSX platforms and chrome.hid
140 // If Raw HID is enabled, let it be always 1.
142 # define RAW_INTERFACE (KEYBOARD_INTERFACE + 1)
144 # define RAW_INTERFACE KEYBOARD_INTERFACE
148 # define MOUSE_INTERFACE (RAW_INTERFACE + 1)
150 # define MOUSE_INTERFACE RAW_INTERFACE
153 #ifdef EXTRAKEY_ENABLE
154 # define EXTRAKEY_INTERFACE (MOUSE_INTERFACE + 1)
156 # define EXTRAKEY_INTERFACE MOUSE_INTERFACE
159 #ifdef CONSOLE_ENABLE
160 # define CONSOLE_INTERFACE (EXTRAKEY_INTERFACE + 1)
162 # define CONSOLE_INTERFACE EXTRAKEY_INTERFACE
166 # define NKRO_INTERFACE (CONSOLE_INTERFACE + 1)
168 # define NKRO_INTERFACE CONSOLE_INTERFACE
172 # define AC_INTERFACE (NKRO_INTERFACE + 1)
173 # define AS_INTERFACE (NKRO_INTERFACE + 2)
175 # define AS_INTERFACE NKRO_INTERFACE
178 #ifdef VIRTSER_ENABLE
179 # define CCI_INTERFACE (AS_INTERFACE + 1)
180 # define CDI_INTERFACE (AS_INTERFACE + 2)
182 # define CDI_INTERFACE AS_INTERFACE
185 /* nubmer of interfaces */
186 #define TOTAL_INTERFACES (CDI_INTERFACE + 1)
189 // Endopoint number and size
190 #define KEYBOARD_IN_EPNUM 1
193 # define MOUSE_IN_EPNUM (KEYBOARD_IN_EPNUM + 1)
195 # define MOUSE_IN_EPNUM KEYBOARD_IN_EPNUM
198 #ifdef EXTRAKEY_ENABLE
199 # define EXTRAKEY_IN_EPNUM (MOUSE_IN_EPNUM + 1)
201 # define EXTRAKEY_IN_EPNUM MOUSE_IN_EPNUM
205 # define RAW_IN_EPNUM (EXTRAKEY_IN_EPNUM + 1)
206 # define RAW_OUT_EPNUM (EXTRAKEY_IN_EPNUM + 2)
208 # define RAW_OUT_EPNUM EXTRAKEY_IN_EPNUM
211 #ifdef CONSOLE_ENABLE
212 # define CONSOLE_IN_EPNUM (RAW_OUT_EPNUM + 1)
213 #ifdef PROTOCOL_CHIBIOS
214 // ChibiOS has enough memory and descriptor to actually enable the endpoint
215 // It could use the same endpoint numbers, as that's supported by ChibiOS
216 // But the QMK code currently assumes that the endpoint numbers are different
217 # define CONSOLE_OUT_EPNUM (RAW_OUT_EPNUM + 2)
219 # define CONSOLE_OUT_EPNUM (RAW_OUT_EPNUM + 1)
222 # define CONSOLE_OUT_EPNUM RAW_OUT_EPNUM
226 # define NKRO_IN_EPNUM (CONSOLE_OUT_EPNUM + 1)
228 # define NKRO_IN_EPNUM CONSOLE_OUT_EPNUM
232 # define MIDI_STREAM_IN_EPNUM (NKRO_IN_EPNUM + 1)
233 // # define MIDI_STREAM_OUT_EPNUM (NKRO_IN_EPNUM + 1)
234 # define MIDI_STREAM_OUT_EPNUM (NKRO_IN_EPNUM + 2)
235 # define MIDI_STREAM_IN_EPADDR (ENDPOINT_DIR_IN | MIDI_STREAM_IN_EPNUM)
236 # define MIDI_STREAM_OUT_EPADDR (ENDPOINT_DIR_OUT | MIDI_STREAM_OUT_EPNUM)
238 # define MIDI_STREAM_OUT_EPNUM NKRO_IN_EPNUM
241 #ifdef VIRTSER_ENABLE
242 # define CDC_NOTIFICATION_EPNUM (MIDI_STREAM_OUT_EPNUM + 1)
243 # define CDC_IN_EPNUM (MIDI_STREAM_OUT_EPNUM + 2)
244 # define CDC_OUT_EPNUM (MIDI_STREAM_OUT_EPNUM + 3)
245 # define CDC_NOTIFICATION_EPADDR (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM)
246 # define CDC_IN_EPADDR (ENDPOINT_DIR_IN | CDC_IN_EPNUM)
247 # define CDC_OUT_EPADDR (ENDPOINT_DIR_OUT | CDC_OUT_EPNUM)
249 # define CDC_OUT_EPNUM MIDI_STREAM_OUT_EPNUM
252 #if (defined(PROTOCOL_LUFA) && CDC_OUT_EPNUM > (ENDPOINT_TOTAL_ENDPOINTS - 1)) || \
253 (defined(PROTOCOL_CHIBIOS) && CDC_OUT_EPNUM > USB_MAX_ENDPOINTS)
254 # error "There are not enough available endpoints to support all functions. Remove some in the rules.mk file.(MOUSEKEY, EXTRAKEY, CONSOLE, NKRO, MIDI, SERIAL, STENO)"
257 #define KEYBOARD_EPSIZE 8
258 #define MOUSE_EPSIZE 8
259 #define EXTRAKEY_EPSIZE 8
260 #define RAW_EPSIZE 32
261 #define CONSOLE_EPSIZE 32
262 #define NKRO_EPSIZE 32
263 #define MIDI_STREAM_EPSIZE 64
264 #define CDC_NOTIFICATION_EPSIZE 8
265 #define CDC_EPSIZE 16
267 uint16_t get_usb_descriptor(const uint16_t wValue,
268 const uint16_t wIndex,
269 const void** const DescriptorAddress);
272 #if LUFA_VERSION_INTEGER < 0x140302
274 #define VERSION_BCD(Major, Minor, Revision) \
275 CPU_TO_LE16( ((Major & 0xFF) << 8) | \
276 ((Minor & 0x0F) << 4) | \