Demos/Device/LowLevel/MIDI/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for Descriptors.c.
  34  */
  35
  36 #ifndef _DESCRIPTORS_H_
  37 #define _DESCRIPTORS_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42                 #include <avr/pgmspace.h>
  43
  44         /* Macros: */
  45                 /** Descriptor header constant to indicate a Audio class interface descriptor. */
  46                 #define DTYPE_AudioInterface        0x24
  47
  48                 /** Descriptor header constant to indicate a Audio class endpoint descriptor. */
  49                 #define DTYPE_AudioEndpoint         0x25
  50
  51                 /** Audio class descriptor subtype value for a Audio class specific header descriptor. */
  52                 #define DSUBTYPE_Header             0x01
  53
  54                 /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */
  55                 #define DSUBTYPE_InputJack          0x02
  56
  57                 /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */
  58                 #define DSUBTYPE_OutputJack         0x03
  59
  60                 /** Audio class descriptor subtype value for a general Audio class specific descriptor. */
  61                 #define DSUBTYPE_General            0x01
  62
  63                 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  64                 #define JACKTYPE_EMBEDDED           0x01
  65
  66                 /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */
  67                 #define JACKTYPE_EXTERNAL           0x02
  68
  69                 /** Endpoint number of the MIDI streaming data OUT endpoint, for host-to-device data transfers. */
  70                 #define MIDI_STREAM_OUT_EPNUM       1
  71
  72                 /** Endpoint number of the MIDI streaming data IN endpoint, for device-to-host data transfers. */
  73                 #define MIDI_STREAM_IN_EPNUM        2
  74
  75                 /** Endpoint size in bytes of the Audio isochronous streaming data IN and OUT endpoints. */
  76                 #define MIDI_STREAM_EPSIZE          64
  77
  78         /* Type Defines: */
  79                 /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
  80                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
  81                  *  details.
  82                  */
  83                 typedef struct
  84                 {
  85                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
  86                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
  87
  88                         uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
  89                         uint16_t                  TotalLength; /**< Total length of the Audio class specific control descriptors, including this descriptor */
  90
  91                         uint8_t                   InCollection; /**< Total number of audio class interfaces within this device */
  92                         uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
  93                 } USB_Audio_Interface_AC_t;
  94
  95                 /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
  96                  *  how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
  97                  *  See the USB Audio specification for more details.
  98                  */
  99                 typedef struct
 100                 {
 101                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 102                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 103
 104                         uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
 105                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 106                 } USB_Audio_Interface_MIDI_AS_t;
 107
 108                 /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
 109                  *  descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
 110                  */
 111                 typedef struct
 112                 {
 113                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */
 114
 115                         uint8_t                   Refresh; /**< Always set to zero */
 116                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */
 117                 } USB_Audio_StreamEndpoint_Std_t;
 118
 119                 /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
 120                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 121                  */
 122                 typedef struct
 123                 {
 124                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 125                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 126
 127                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 128                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 129
 130                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 131                 } USB_MIDI_In_Jack_t;
 132
 133                 /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 134                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 135                  */
 136                 typedef struct
 137                 {
 138                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 139                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 140
 141                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 142                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 143
 144                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */
 145                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */
 146                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */
 147
 148                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 149                 } USB_MIDI_Out_Jack_t;
 150
 151                 /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
 152                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 153                  *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 154                  */
 155                 typedef struct
 156                 {
 157                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 158                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 159
 160                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */
 161                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
 162                 } USB_MIDI_Jack_Endpoint_t;
 163
 164                 /** Type define for the device configuration descriptor structure. This must be defined in the
 165                  *  application code, as the configuration descriptor contains several sub-descriptors which
 166                  *  vary between devices, and which describe the device's usage to the host.
 167                  */
 168                 typedef struct
 169                 {
 170                         USB_Descriptor_Configuration_Header_t Config;
 171                         USB_Descriptor_Interface_t            Audio_ControlInterface;
 172                         USB_Audio_Interface_AC_t              Audio_ControlInterface_SPC;
 173                         USB_Descriptor_Interface_t            Audio_StreamInterface;
 174                         USB_Audio_Interface_MIDI_AS_t         Audio_StreamInterface_SPC;
 175                         USB_MIDI_In_Jack_t                    MIDI_In_Jack_Emb;
 176                         USB_MIDI_In_Jack_t                    MIDI_In_Jack_Ext;
 177                         USB_MIDI_Out_Jack_t                   MIDI_Out_Jack_Emb;
 178                         USB_MIDI_Out_Jack_t                   MIDI_Out_Jack_Ext;
 179                         USB_Audio_StreamEndpoint_Std_t        MIDI_In_Jack_Endpoint;
 180                         USB_MIDI_Jack_Endpoint_t              MIDI_In_Jack_Endpoint_SPC;
 181                         USB_Audio_StreamEndpoint_Std_t        MIDI_Out_Jack_Endpoint;
 182                         USB_MIDI_Jack_Endpoint_t              MIDI_Out_Jack_Endpoint_SPC;
 183                 } USB_Descriptor_Configuration_t;
 184
 185         /* Function Prototypes: */
 186                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 187                                                                                         ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 188
 189 #endif