summaryrefslogtreecommitdiffstats
path: root/tmk_core/protocol/usb_descriptor.h
diff options
context:
space:
mode:
Diffstat (limited to 'tmk_core/protocol/usb_descriptor.h')
-rw-r--r--tmk_core/protocol/usb_descriptor.h261
1 files changed, 134 insertions, 127 deletions
diff --git a/tmk_core/protocol/usb_descriptor.h b/tmk_core/protocol/usb_descriptor.h
index 3ca0c00b34..b2423fa7e6 100644
--- a/tmk_core/protocol/usb_descriptor.h
+++ b/tmk_core/protocol/usb_descriptor.h
@@ -6,95 +6,97 @@
*/
/*
- LUFA Library
- Copyright (C) Dean Camera, 2012.
+ LUFA Library
+ Copyright (C) Dean Camera, 2012.
- dean [at] fourwalledcubicle [dot] com
- www.lufa-lib.org
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
*/
/*
- Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
- Copyright 2010 Denver Gingerich (denver [at] ossguy [dot] com)
-
- Permission to use, copy, modify, distribute, and sell this
- software and its documentation for any purpose is hereby granted
- without fee, provided that the above copyright notice appear in
- all copies and that both that the copyright notice and this
- permission notice and warranty disclaimer appear in supporting
- documentation, and that the name of the author not be used in
- advertising or publicity pertaining to distribution of the
- software without specific, written prior permission.
-
- The author disclaim all warranties with regard to this
- software, including all implied warranties of merchantability
- and fitness. In no event shall the author be liable for any
- special, indirect or consequential damages or any damages
- whatsoever resulting from loss of use, data or profits, whether
- in an action of contract, negligence or other tortious action,
- arising out of or in connection with the use or performance of
- this software.
+ Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+ Copyright 2010 Denver Gingerich (denver [at] ossguy [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
*/
/** \file
*
* Header file for Descriptors.c.
*/
-
#ifndef _DESCRIPTORS_H_
#define _DESCRIPTORS_H_
#include <LUFA/Drivers/USB/USB.h>
+
#ifdef PROTOCOL_CHIBIOS
-#include "hal.h"
+# include "hal.h"
#endif
-typedef struct
-{
+/*
+ * USB descriptor structure
+ */
+typedef struct {
USB_Descriptor_Configuration_Header_t Config;
#ifndef KEYBOARD_SHARED_EP
// Keyboard HID Interface
- USB_Descriptor_Interface_t Keyboard_Interface;
- USB_HID_Descriptor_HID_t Keyboard_HID;
- USB_Descriptor_Endpoint_t Keyboard_INEndpoint;
+ USB_Descriptor_Interface_t Keyboard_Interface;
+ USB_HID_Descriptor_HID_t Keyboard_HID;
+ USB_Descriptor_Endpoint_t Keyboard_INEndpoint;
#endif
-#if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
- // Mouse HID Interface
- USB_Descriptor_Interface_t Mouse_Interface;
- USB_HID_Descriptor_HID_t Mouse_HID;
- USB_Descriptor_Endpoint_t Mouse_INEndpoint;
+#ifdef RAW_ENABLE
+ // Raw HID Interface
+ USB_Descriptor_Interface_t Raw_Interface;
+ USB_HID_Descriptor_HID_t Raw_HID;
+ USB_Descriptor_Endpoint_t Raw_INEndpoint;
+ USB_Descriptor_Endpoint_t Raw_OUTEndpoint;
#endif
-#if defined(SHARED_EP_ENABLE)
- USB_Descriptor_Interface_t Shared_Interface;
- USB_HID_Descriptor_HID_t Shared_HID;
- USB_Descriptor_Endpoint_t Shared_INEndpoint;
+#if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
+ // Mouse HID Interface
+ USB_Descriptor_Interface_t Mouse_Interface;
+ USB_HID_Descriptor_HID_t Mouse_HID;
+ USB_Descriptor_Endpoint_t Mouse_INEndpoint;
#endif
-#if defined(RAW_ENABLE)
- // Raw HID Interface
- USB_Descriptor_Interface_t Raw_Interface;
- USB_HID_Descriptor_HID_t Raw_HID;
- USB_Descriptor_Endpoint_t Raw_INEndpoint;
- USB_Descriptor_Endpoint_t Raw_OUTEndpoint;
+#ifdef SHARED_EP_ENABLE
+ // Shared Interface
+ USB_Descriptor_Interface_t Shared_Interface;
+ USB_HID_Descriptor_HID_t Shared_HID;
+ USB_Descriptor_Endpoint_t Shared_INEndpoint;
#endif
#ifdef CONSOLE_ENABLE
// Console HID Interface
- USB_Descriptor_Interface_t Console_Interface;
- USB_HID_Descriptor_HID_t Console_HID;
- USB_Descriptor_Endpoint_t Console_INEndpoint;
- USB_Descriptor_Endpoint_t Console_OUTEndpoint;
+ USB_Descriptor_Interface_t Console_Interface;
+ USB_HID_Descriptor_HID_t Console_HID;
+ USB_Descriptor_Endpoint_t Console_INEndpoint;
+ USB_Descriptor_Endpoint_t Console_OUTEndpoint;
#endif
#ifdef MIDI_ENABLE
- USB_Descriptor_Interface_Association_t Audio_Interface_Association;
+ USB_Descriptor_Interface_Association_t Audio_Interface_Association;
// MIDI Audio Control Interface
- USB_Descriptor_Interface_t Audio_ControlInterface;
- USB_Audio_Descriptor_Interface_AC_t Audio_ControlInterface_SPC;
-
+ USB_Descriptor_Interface_t Audio_ControlInterface;
+ USB_Audio_Descriptor_Interface_AC_t Audio_ControlInterface_SPC;
// MIDI Audio Streaming Interface
USB_Descriptor_Interface_t Audio_StreamInterface;
USB_MIDI_Descriptor_AudioInterface_AS_t Audio_StreamInterface_SPC;
@@ -109,138 +111,143 @@ typedef struct
#endif
#ifdef VIRTSER_ENABLE
- USB_Descriptor_Interface_Association_t CDC_Interface_Association;
-
- // CDC Control Interface
- USB_Descriptor_Interface_t CDC_CCI_Interface;
- USB_CDC_Descriptor_FunctionalHeader_t CDC_Functional_Header;
- USB_CDC_Descriptor_FunctionalACM_t CDC_Functional_ACM;
- USB_CDC_Descriptor_FunctionalUnion_t CDC_Functional_Union;
- USB_Descriptor_Endpoint_t CDC_NotificationEndpoint;
-
- // CDC Data Interface
- USB_Descriptor_Interface_t CDC_DCI_Interface;
- USB_Descriptor_Endpoint_t CDC_DataOutEndpoint;
- USB_Descriptor_Endpoint_t CDC_DataInEndpoint;
+ USB_Descriptor_Interface_Association_t CDC_Interface_Association;
+ // CDC Control Interface
+ USB_Descriptor_Interface_t CDC_CCI_Interface;
+ USB_CDC_Descriptor_FunctionalHeader_t CDC_Functional_Header;
+ USB_CDC_Descriptor_FunctionalACM_t CDC_Functional_ACM;
+ USB_CDC_Descriptor_FunctionalUnion_t CDC_Functional_Union;
+ USB_Descriptor_Endpoint_t CDC_NotificationEndpoint;
+ // CDC Data Interface
+ USB_Descriptor_Interface_t CDC_DCI_Interface;
+ USB_Descriptor_Endpoint_t CDC_DataOutEndpoint;
+ USB_Descriptor_Endpoint_t CDC_DataInEndpoint;
#endif
} USB_Descriptor_Configuration_t;
-
-/* index of interface */
+/*
+ * Interface indexes
+ */
enum usb_interfaces {
-#if !defined(KEYBOARD_SHARED_EP)
+#ifndef KEYBOARD_SHARED_EP
KEYBOARD_INTERFACE,
#else
-# define KEYBOARD_INTERFACE SHARED_INTERFACE
+# define KEYBOARD_INTERFACE SHARED_INTERFACE
#endif
+
// It is important that the Raw HID interface is at a constant
// interface number, to support Linux/OSX platforms and chrome.hid
// If Raw HID is enabled, let it be always 1.
-#if defined(RAW_ENABLE)
+#ifdef RAW_ENABLE
RAW_INTERFACE,
#endif
+
#if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
MOUSE_INTERFACE,
#endif
-#if defined(SHARED_EP_ENABLE)
+
+#ifdef SHARED_EP_ENABLE
SHARED_INTERFACE,
#endif
-#if defined(CONSOLE_ENABLE)
+
+#ifdef CONSOLE_ENABLE
CONSOLE_INTERFACE,
#endif
-#if defined(MIDI_ENABLE)
+
+#ifdef MIDI_ENABLE
AC_INTERFACE,
AS_INTERFACE,
#endif
-#if defined(VIRTSER_ENABLE)
+
+#ifdef VIRTSER_ENABLE
CCI_INTERFACE,
CDI_INTERFACE,
#endif
+
TOTAL_INTERFACES
};
#define NEXT_EPNUM __COUNTER__
+/*
+ * Endpoint numbers
+ */
enum usb_endpoints {
- __unused_epnum__ = NEXT_EPNUM, /* EP numbering starts at 1 */
-#if !defined(KEYBOARD_SHARED_EP)
+ __unused_epnum__ = NEXT_EPNUM, // Endpoint numbering starts at 1
+
+#ifndef KEYBOARD_SHARED_EP
KEYBOARD_IN_EPNUM = NEXT_EPNUM,
#else
-# define KEYBOARD_IN_EPNUM SHARED_IN_EPNUM
+# define KEYBOARD_IN_EPNUM SHARED_IN_EPNUM
#endif
+
#if defined(MOUSE_ENABLE) && !defined(MOUSE_SHARED_EP)
MOUSE_IN_EPNUM = NEXT_EPNUM,
#else
-# define MOUSE_IN_EPNUM SHARED_IN_EPNUM
+# define MOUSE_IN_EPNUM SHARED_IN_EPNUM
#endif
-#if defined(RAW_ENABLE)
- RAW_IN_EPNUM = NEXT_EPNUM,
+
+#ifdef RAW_ENABLE
+ RAW_IN_EPNUM = NEXT_EPNUM,
RAW_OUT_EPNUM = NEXT_EPNUM,
#endif
-#if defined(SHARED_EP_ENABLE)
+
+#ifdef SHARED_EP_ENABLE
SHARED_IN_EPNUM = NEXT_EPNUM,
#endif
-#if defined(CONSOLE_ENABLE)
+
+#ifdef CONSOLE_ENABLE
CONSOLE_IN_EPNUM = NEXT_EPNUM,
-#ifdef PROTOCOL_CHIBIOS
-// ChibiOS has enough memory and descriptor to actually enable the endpoint
-// It could use the same endpoint numbers, as that's supported by ChibiOS
-// But the QMK code currently assumes that the endpoint numbers are different
+
+# ifdef PROTOCOL_CHIBIOS
+ // ChibiOS has enough memory and descriptor to actually enable the endpoint
+ // It could use the same endpoint numbers, as that's supported by ChibiOS
+ // But the QMK code currently assumes that the endpoint numbers are different
CONSOLE_OUT_EPNUM = NEXT_EPNUM,
-#else
-#define CONSOLE_OUT_EPNUM CONSOLE_IN_EPNUM
-#endif
+# else
+# define CONSOLE_OUT_EPNUM CONSOLE_IN_EPNUM
+# endif
#endif
+
#ifdef MIDI_ENABLE
- MIDI_STREAM_IN_EPNUM = NEXT_EPNUM,
+ MIDI_STREAM_IN_EPNUM = NEXT_EPNUM,
MIDI_STREAM_OUT_EPNUM = NEXT_EPNUM,
-# define MIDI_STREAM_IN_EPADDR (ENDPOINT_DIR_IN | MIDI_STREAM_IN_EPNUM)
-# define MIDI_STREAM_OUT_EPADDR (ENDPOINT_DIR_OUT | MIDI_STREAM_OUT_EPNUM)
+# define MIDI_STREAM_IN_EPADDR (ENDPOINT_DIR_IN | MIDI_STREAM_IN_EPNUM)
+# define MIDI_STREAM_OUT_EPADDR (ENDPOINT_DIR_OUT | MIDI_STREAM_OUT_EPNUM)
#endif
+
#ifdef VIRTSER_ENABLE
CDC_NOTIFICATION_EPNUM = NEXT_EPNUM,
- CDC_IN_EPNUM = NEXT_EPNUM,
- CDC_OUT_EPNUM = NEXT_EPNUM,
-# define CDC_NOTIFICATION_EPADDR (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM)
-# define CDC_IN_EPADDR (ENDPOINT_DIR_IN | CDC_IN_EPNUM)
-# define CDC_OUT_EPADDR (ENDPOINT_DIR_OUT | CDC_OUT_EPNUM)
+ CDC_IN_EPNUM = NEXT_EPNUM,
+ CDC_OUT_EPNUM = NEXT_EPNUM,
+# define CDC_NOTIFICATION_EPADDR (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM)
+# define CDC_IN_EPADDR (ENDPOINT_DIR_IN | CDC_IN_EPNUM)
+# define CDC_OUT_EPADDR (ENDPOINT_DIR_OUT | CDC_OUT_EPNUM)
#endif
};
-#if defined(PROTOCOL_LUFA)
-/* LUFA tells us total endpoints including control */
-#define MAX_ENDPOINTS (ENDPOINT_TOTAL_ENDPOINTS - 1)
+#ifdef PROTOCOL_LUFA
+// LUFA tells us total endpoints including control
+# define MAX_ENDPOINTS (ENDPOINT_TOTAL_ENDPOINTS - 1)
#elif defined(PROTOCOL_CHIBIOS)
-/* ChibiOS gives us number of available user endpoints, not control */
-#define MAX_ENDPOINTS USB_MAX_ENDPOINTS
+// ChibiOS gives us number of available user endpoints, not control
+# define MAX_ENDPOINTS USB_MAX_ENDPOINTS
#endif
-/* TODO - ARM_ATSAM */
+// TODO - ARM_ATSAM
#if (NEXT_EPNUM - 1) > MAX_ENDPOINTS
-# 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)
+# 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
#endif
-#define KEYBOARD_EPSIZE 8
-#define SHARED_EPSIZE 32
-#define MOUSE_EPSIZE 8
-#define RAW_EPSIZE 32
-#define CONSOLE_EPSIZE 32
-#define MIDI_STREAM_EPSIZE 64
-#define CDC_NOTIFICATION_EPSIZE 8
-#define CDC_EPSIZE 16
-
-uint16_t get_usb_descriptor(const uint16_t wValue,
- const uint16_t wIndex,
- const void** const DescriptorAddress);
-
-/* new API */
-#if LUFA_VERSION_INTEGER < 0x140302
- #undef VERSION_BCD
- #define VERSION_BCD(Major, Minor, Revision) \
- CPU_TO_LE16( ((Major & 0xFF) << 8) | \
- ((Minor & 0x0F) << 4) | \
- (Revision & 0x0F) )
-#endif
+#define KEYBOARD_EPSIZE 8
+#define SHARED_EPSIZE 32
+#define MOUSE_EPSIZE 8
+#define RAW_EPSIZE 32
+#define CONSOLE_EPSIZE 32
+#define MIDI_STREAM_EPSIZE 64
+#define CDC_NOTIFICATION_EPSIZE 8
+#define CDC_EPSIZE 16
+uint16_t get_usb_descriptor(const uint16_t wValue, const uint16_t wIndex, const void** const DescriptorAddress);
#endif
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-28 19:59:25 +0000