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                 /** Audio class descriptor subtype value for a Audio class specific header descriptor. */
  46                 #define DSUBTYPE_AudioHeader        0x01
  47
  48                 /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */
  49                 #define DSUBTYPE_InputJack          0x02
  50
  51                 /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */
  52                 #define DSUBTYPE_OutputJack         0x03
  53
  54                 /** Audio class descriptor subtype value for a general Audio class specific descriptor. */
  55                 #define DSUBTYPE_General            0x01
  56
  57                 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  58                 #define JACKTYPE_EMBEDDED           0x01
  59
  60                 /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */
  61                 #define JACKTYPE_EXTERNAL           0x02
  62
  63                 /** Endpoint number of the MIDI streaming data OUT endpoint, for host-to-device data transfers. */
  64                 #define MIDI_STREAM_OUT_EPNUM       1
  65
  66                 /** Endpoint number of the MIDI streaming data IN endpoint, for device-to-host data transfers. */
  67                 #define MIDI_STREAM_IN_EPNUM        2
  68
  69                 /** Endpoint size in bytes of the Audio isochronous streaming data IN and OUT endpoints. */
  70                 #define MIDI_STREAM_EPSIZE          64
  71
  72         /* Type Defines: */
  73                 /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to
  74                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
  75                  *  details.
  76                  */
  77                 typedef struct
  78                 {
  79                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
  80                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
  81
  82                         uint16_t                  ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
  83                         uint16_t                  TotalLength; /**< Total length of the Audio class specific control descriptors, including this descriptor */
  84
  85                         uint8_t                   InCollection; /**< Total number of audio class interfaces within this device */
  86                         uint8_t                   InterfaceNumbers[1]; /**< Interface numbers of each audio interface */
  87                 } USB_Audio_Interface_AC_t;
  88
  89                 /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
  90                  *  how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
  91                  *  See the USB Audio specification for more details.
  92                  */
  93                 typedef struct
  94                 {
  95                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
  96                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
  97
  98                         uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
  99                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 100                 } USB_Audio_Interface_MIDI_AS_t;
 101
 102                 /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint
 103                  *  descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.
 104                  */
 105                 typedef struct
 106                 {
 107                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */
 108
 109                         uint8_t                   Refresh; /**< Always set to zero */
 110                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise) */
 111                 } USB_Audio_StreamEndpoint_Std_t;
 112
 113                 /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
 114                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 115                  */
 116                 typedef struct
 117                 {
 118                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 119                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 120
 121                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 122                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 123
 124                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 125                 } USB_MIDI_In_Jack_t;
 126
 127                 /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 128                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 129                  */
 130                 typedef struct
 131                 {
 132                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 133                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 134
 135                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 136                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 137
 138                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */
 139                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */
 140                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */
 141
 142                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 143                 } USB_MIDI_Out_Jack_t;
 144
 145                 /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
 146                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 147                  *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 148                  */
 149                 typedef struct
 150                 {
 151                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 152                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 153
 154                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */
 155                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
 156                 } USB_MIDI_Jack_Endpoint_t;
 157
 158                 /** Type define for the device configuration descriptor structure. This must be defined in the
 159                  *  application code, as the configuration descriptor contains several sub-descriptors which
 160                  *  vary between devices, and which describe the device's usage to the host.
 161                  */
 162                 typedef struct
 163                 {
 164                         USB_Descriptor_Configuration_Header_t Config;
 165                         USB_Descriptor_Interface_t            Audio_ControlInterface;
 166                         USB_Audio_Interface_AC_t              Audio_ControlInterface_SPC;
 167                         USB_Descriptor_Interface_t            Audio_StreamInterface;
 168                         USB_Audio_Interface_MIDI_AS_t         Audio_StreamInterface_SPC;
 169                         USB_MIDI_In_Jack_t                    MIDI_In_Jack_Emb;
 170                         USB_MIDI_In_Jack_t                    MIDI_In_Jack_Ext;
 171                         USB_MIDI_Out_Jack_t                   MIDI_Out_Jack_Emb;
 172                         USB_MIDI_Out_Jack_t                   MIDI_Out_Jack_Ext;
 173                         USB_Audio_StreamEndpoint_Std_t        MIDI_In_Jack_Endpoint;
 174                         USB_MIDI_Jack_Endpoint_t              MIDI_In_Jack_Endpoint_SPC;
 175                         USB_Audio_StreamEndpoint_Std_t        MIDI_Out_Jack_Endpoint;
 176                         USB_MIDI_Jack_Endpoint_t              MIDI_Out_Jack_Endpoint_SPC;
 177                 } USB_Descriptor_Configuration_t;
 178
 179         /* Function Prototypes: */
 180                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 181                                                     const uint8_t wIndex,
 182                                                     const void** const DescriptorAddress)
 183                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 184
 185 #endif