LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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  *  \brief Common definitions and declarations for the library USB MIDI Class driver.
  33  *
  34  *  Common definitions and declarations for the library USB MIDI Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassMIDI
  41  *  \defgroup Group_USBClassMIDICommon  Common Class Definitions
  42  *
  43  *  \section Sec_ModDescription Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  MIDI Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _MIDI_CLASS_COMMON_H_
  51 #define _MIDI_CLASS_COMMON_H_
  52
  53         /* Macros: */
  54                 #define __INCLUDE_FROM_AUDIO_DRIVER
  55
  56         /* Includes: */
  57                 #include "../../Core/StdDescriptors.h"
  58                 #include "AudioClassCommon.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_MIDI_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  68                 #endif
  69
  70         /* Macros: */
  71                 /** \name MIDI Command Values */
  72                 //@{
  73                 /** MIDI command for a note on (activation) event. */
  74                 #define MIDI_COMMAND_NOTE_ON        0x90
  75
  76                 /** MIDI command for a note off (deactivation) event. */
  77                 #define MIDI_COMMAND_NOTE_OFF       0x80
  78                 //@}
  79
  80                 /** Standard key press velocity value used for all note events. */
  81                 #define MIDI_STANDARD_VELOCITY      64
  82
  83                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
  84                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
  85                  *
  86                  *  \param[in] channel  MIDI channel number to address.
  87                  */
  88                 #define MIDI_CHANNEL(channel)        ((channel) - 1)
  89
  90         /* Enums: */
  91                 /** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */
  92                 enum MIDI_JackTypes_t
  93                 {
  94                         MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  95                         MIDI_JACKTYPE_External = 0x02, /**< MIDI class descriptor jack type value for an external (physical) MIDI input or output jack. */
  96                 };
  97
  98         /* Type Defines: */
  99                 /** \brief MIDI class-specific Streaming Interface Descriptor (LUFA naming conventions).
 100                  *
 101                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 102                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 103                  *  See the USB Audio specification for more details.
 104                  *
 105                  *  \see \ref USB_MIDI_StdDescriptor_AudioInterface_AS_t for the version of this type with standard element names.
 106                  *
 107                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 108                  */
 109                 typedef struct
 110                 {
 111                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 112                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 113
 114                         uint16_t                AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class
 115                                                                      *   specification version.
 116                                                                      */
 117                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 118                 } ATTR_PACKED USB_MIDI_Descriptor_AudioInterface_AS_t;
 119
 120                 /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions).
 121                  *
 122                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 123                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 124                  *  See the USB Audio specification for more details.
 125                  *
 126                  *  \see \ref USB_MIDI_Descriptor_AudioInterface_AS_t for the version of this type with non-standard LUFA specific
 127                  *       element names.
 128                  *
 129                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 130                  */
 131                 typedef struct
 132                 {
 133                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 134                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 135                                                    *   given by the specific class.
 136                                                    */
 137
 138                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 139
 140                         uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. */
 141                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 142                 } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t;
 143
 144                 /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions).
 145                  *
 146                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 147                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 148                  *
 149                  *  \see \ref USB_MIDI_StdDescriptor_InputJack_t for the version of this type with standard element names.
 150                  *
 151                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 152                  */
 153                 typedef struct
 154                 {
 155                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 156                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 157
 158                         uint8_t                 JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 159                         uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 160
 161                         uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 162                 } ATTR_PACKED USB_MIDI_Descriptor_InputJack_t;
 163
 164                 /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).
 165                  *
 166                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 167                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 168                  *
 169                  *  \see \ref USB_MIDI_Descriptor_InputJack_t for the version of this type with non-standard LUFA specific
 170                  *       element names.
 171                  *
 172                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 173                  */
 174                 typedef struct
 175                 {
 176                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 177                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 178                                                    *   given by the specific class.
 179                                                    */
 180
 181                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 182
 183                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 184                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 185
 186                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 187                 } ATTR_PACKED USB_MIDI_StdDescriptor_InputJack_t;
 188
 189                 /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions).
 190                  *
 191                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 192                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 193                  *
 194                  *  \see \ref USB_MIDI_StdDescriptor_OutputJack_t for the version of this type with standard element names.
 195                  *
 196                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 197                  */
 198                 typedef struct
 199                 {
 200                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 201                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 202
 203                         uint8_t                   JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 204                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 205
 206                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */
 207                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack. */
 208                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */
 209
 210                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 211                 } ATTR_PACKED USB_MIDI_Descriptor_OutputJack_t;
 212
 213                 /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions).
 214                  *
 215                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 216                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 217                  *
 218                  *  \see \ref USB_MIDI_Descriptor_OutputJack_t for the version of this type with non-standard LUFA specific
 219                  *       element names.
 220                  *
 221                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 222                  */
 223                 typedef struct
 224                 {
 225                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 226                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 227                                                    *   given by the specific class.
 228                                                    */
 229
 230                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 231
 232                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 233                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 234
 235                         uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */
 236                         uint8_t  baSourceID[1]; /**< ID of each output pin's source data jack. */
 237                         uint8_t  baSourcePin[1]; /**< Pin number in the input jack of each output pin's source data. */
 238
 239                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 240                 } ATTR_PACKED USB_MIDI_StdDescriptor_OutputJack_t;
 241
 242                 /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions).
 243                  *
 244                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 245                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 246                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 247                  *
 248                  *  \see \ref USB_MIDI_StdDescriptor_Jack_Endpoint_t for the version of this type with standard element names.
 249                  *
 250                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 251                  */
 252                 typedef struct
 253                 {
 254                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 255                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 256
 257                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */
 258                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */
 259                 } ATTR_PACKED USB_MIDI_Descriptor_Jack_Endpoint_t;
 260
 261                 /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions).
 262                  *
 263                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 264                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 265                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 266                  *
 267                  *  \see \ref USB_MIDI_Descriptor_Jack_Endpoint_t for the version of this type with non-standard LUFA specific
 268                  *       element names.
 269                  *
 270                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 271                  */
 272                 typedef struct
 273                 {
 274                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 275                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 276                                                    *   given by the specific class.
 277                                                    */
 278
 279                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 280
 281                         uint8_t  bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */
 282                         uint8_t  bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */
 283                 } ATTR_PACKED USB_MIDI_StdDescriptor_Jack_Endpoint_t;
 284
 285                 /** \brief MIDI Class Driver Event Packet.
 286                  *
 287                  *  Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
 288                  *
 289                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 290                  */
 291                 typedef struct
 292                 {
 293                         unsigned Command     : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet. */
 294                         unsigned CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface. */
 295
 296                         uint8_t  Data1; /**< First byte of data in the MIDI event. */
 297                         uint8_t  Data2; /**< Second byte of data in the MIDI event. */
 298                         uint8_t  Data3; /**< Third byte of data in the MIDI event. */
 299                 } ATTR_PACKED MIDI_EventPacket_t;
 300
 301         /* Disable C linkage for C++ Compilers: */
 302                 #if defined(__cplusplus)
 303                         }
 304                 #endif
 305
 306 #endif
 307
 308 /** @} */
 309