tmk_core/protocol/lufa/descriptor.h

   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 /*
   9              LUFA Library
  10      Copyright (C) Dean Camera, 2012.
  11
  12   dean [at] fourwalledcubicle [dot] com
  13            www.lufa-lib.org
  14 */
  15
  16 /*
  17   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  18   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
  19
  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.
  28
  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
  36   this software.
  37 */
  38
  39 /** \file
  40  *
  41  *  Header file for Descriptors.c.
  42  */
  43
  44 #ifndef _DESCRIPTORS_H_
  45 #define _DESCRIPTORS_H_
  46
  47 #include <LUFA/Drivers/USB/USB.h>
  48 #include <avr/pgmspace.h>
  49
  50
  51 typedef struct
  52 {
  53     USB_Descriptor_Configuration_Header_t Config;
  54
  55     // Keyboard HID Interface
  56     USB_Descriptor_Interface_t            Keyboard_Interface;
  57     USB_HID_Descriptor_HID_t              Keyboard_HID;
  58     USB_Descriptor_Endpoint_t             Keyboard_INEndpoint;
  59
  60 #ifdef MOUSE_ENABLE
  61     // Mouse HID Interface
  62     USB_Descriptor_Interface_t            Mouse_Interface;
  63     USB_HID_Descriptor_HID_t              Mouse_HID;
  64     USB_Descriptor_Endpoint_t             Mouse_INEndpoint;
  65 #endif
  66
  67 #ifdef EXTRAKEY_ENABLE
  68     // Extrakey HID Interface
  69     USB_Descriptor_Interface_t            Extrakey_Interface;
  70     USB_HID_Descriptor_HID_t              Extrakey_HID;
  71     USB_Descriptor_Endpoint_t             Extrakey_INEndpoint;
  72 #endif
  73
  74 #ifdef CONSOLE_ENABLE
  75     // Console HID Interface
  76     USB_Descriptor_Interface_t            Console_Interface;
  77     USB_HID_Descriptor_HID_t              Console_HID;
  78     USB_Descriptor_Endpoint_t             Console_INEndpoint;
  79     USB_Descriptor_Endpoint_t             Console_OUTEndpoint;
  80 #endif
  81
  82 #ifdef NKRO_ENABLE
  83     // NKRO HID Interface
  84     USB_Descriptor_Interface_t            NKRO_Interface;
  85     USB_HID_Descriptor_HID_t              NKRO_HID;
  86     USB_Descriptor_Endpoint_t             NKRO_INEndpoint;
  87 #endif
  88
  89 #ifdef MIDI_ENABLE
  90       // MIDI Audio Control Interface
  91       USB_Descriptor_Interface_t                Audio_ControlInterface;
  92       USB_Audio_Descriptor_Interface_AC_t       Audio_ControlInterface_SPC;
  93
  94       // MIDI Audio Streaming Interface
  95       USB_Descriptor_Interface_t                Audio_StreamInterface;
  96       USB_MIDI_Descriptor_AudioInterface_AS_t   Audio_StreamInterface_SPC;
  97       USB_MIDI_Descriptor_InputJack_t           MIDI_In_Jack_Emb;
  98       USB_MIDI_Descriptor_InputJack_t           MIDI_In_Jack_Ext;
  99       USB_MIDI_Descriptor_OutputJack_t          MIDI_Out_Jack_Emb;
 100       USB_MIDI_Descriptor_OutputJack_t          MIDI_Out_Jack_Ext;
 101       USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_In_Jack_Endpoint;
 102       USB_MIDI_Descriptor_Jack_Endpoint_t       MIDI_In_Jack_Endpoint_SPC;
 103       USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_Out_Jack_Endpoint;
 104       USB_MIDI_Descriptor_Jack_Endpoint_t       MIDI_Out_Jack_Endpoint_SPC;
 105 #endif
 106
 107 } USB_Descriptor_Configuration_t;
 108
 109
 110 /* index of interface */
 111 #define KEYBOARD_INTERFACE          0
 112
 113 #ifdef MOUSE_ENABLE
 114 #   define MOUSE_INTERFACE          (KEYBOARD_INTERFACE + 1)
 115 #else
 116 #   define MOUSE_INTERFACE          KEYBOARD_INTERFACE
 117 #endif
 118
 119 #ifdef EXTRAKEY_ENABLE
 120 #   define EXTRAKEY_INTERFACE       (MOUSE_INTERFACE + 1)
 121 #else
 122 #   define EXTRAKEY_INTERFACE       MOUSE_INTERFACE
 123 #endif
 124
 125 #ifdef CONSOLE_ENABLE
 126 #   define CONSOLE_INTERFACE        (EXTRAKEY_INTERFACE + 1)
 127 #else
 128 #   define CONSOLE_INTERFACE        EXTRAKEY_INTERFACE
 129 #endif
 130
 131 #ifdef NKRO_ENABLE
 132 #   define NKRO_INTERFACE           (CONSOLE_INTERFACE + 1)
 133 #else
 134 #   define NKRO_INTERFACE           CONSOLE_INTERFACE
 135 #endif
 136
 137 #ifdef MIDI_ENABLE
 138 #   define AC_INTERFACE           (NKRO_INTERFACE + 1)
 139 #   define AS_INTERFACE           (NKRO_INTERFACE + 2)
 140 #else
 141 #   define AS_INTERFACE           NKRO_INTERFACE
 142 #endif
 143
 144 /* nubmer of interfaces */
 145 #define TOTAL_INTERFACES            AS_INTERFACE + 1
 146
 147
 148 // Endopoint number and size
 149 #define KEYBOARD_IN_EPNUM           1
 150
 151 #ifdef MOUSE_ENABLE
 152 #   define MOUSE_IN_EPNUM           (KEYBOARD_IN_EPNUM + 1)
 153 #else
 154 #   define MOUSE_IN_EPNUM           KEYBOARD_IN_EPNUM
 155 #endif
 156
 157 #ifdef EXTRAKEY_ENABLE
 158 #   define EXTRAKEY_IN_EPNUM        (MOUSE_IN_EPNUM + 1)
 159 #else
 160 #   define EXTRAKEY_IN_EPNUM        MOUSE_IN_EPNUM
 161 #endif
 162
 163 #ifdef CONSOLE_ENABLE
 164 #   define CONSOLE_IN_EPNUM         (EXTRAKEY_IN_EPNUM + 1)
 165 #   define CONSOLE_OUT_EPNUM        (EXTRAKEY_IN_EPNUM + 1)
 166 //#   define CONSOLE_OUT_EPNUM        (EXTRAKEY_IN_EPNUM + 2)
 167 #else
 168 #   define CONSOLE_OUT_EPNUM        EXTRAKEY_IN_EPNUM
 169 #endif
 170
 171 #ifdef NKRO_ENABLE
 172 #   define NKRO_IN_EPNUM            (CONSOLE_OUT_EPNUM + 1)
 173 #else
 174 #   define NKRO_IN_EPNUM            CONSOLE_OUT_EPNUM
 175 #endif
 176
 177 #ifdef MIDI_ENABLE
 178 #   define MIDI_STREAM_IN_EPNUM     (NKRO_IN_EPNUM + 1)
 179 // #   define MIDI_STREAM_OUT_EPNUM    (NKRO_IN_EPNUM + 1)
 180 #   define MIDI_STREAM_OUT_EPNUM    (NKRO_IN_EPNUM + 2)
 181 #   define MIDI_STREAM_IN_EPADDR    (ENDPOINT_DIR_IN | MIDI_STREAM_IN_EPNUM)
 182 #   define MIDI_STREAM_OUT_EPADDR   (ENDPOINT_DIR_OUT | MIDI_STREAM_OUT_EPNUM)
 183 #endif
 184
 185
 186 #if defined(__AVR_ATmega32U2__) && MIDI_STREAM_OUT_EPADDR > 4
 187 # error "Endpoints are not available enough to support all functions. Remove some in Makefile.(MOUSEKEY, EXTRAKEY, CONSOLE, NKRO, MIDI)"
 188 #endif
 189
 190 #define KEYBOARD_EPSIZE             8
 191 #define MOUSE_EPSIZE                8
 192 #define EXTRAKEY_EPSIZE             8
 193 #define CONSOLE_EPSIZE              32
 194 #define NKRO_EPSIZE                 16
 195 #define MIDI_STREAM_EPSIZE          64
 196
 197
 198 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 199                                     const uint8_t wIndex,
 200                                     const void** const DescriptorAddress)
 201                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 202
 203
 204 /* new API */
 205 #if LUFA_VERSION_INTEGER < 0x140302
 206     #undef VERSION_BCD
 207     #define VERSION_BCD(Major, Minor, Revision) \
 208                                               CPU_TO_LE16( ((Major & 0xFF) << 8) | \
 209                                                            ((Minor & 0x0F) << 4) | \
 210                                                            (Revision & 0x0F) )
 211 #endif
 212
 213 #endif