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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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                  *  \return Constructed MIDI channel ID.
  89                  */
  90                 #define MIDI_CHANNEL(channel)        ((channel) - 1)
  91
  92                 /** Constructs a MIDI event ID from a given MIDI command and a virtual MIDI cable index. This can then be
  93                  *  used to create and decode \ref MIDI_EventPacket_t MIDI event packets.
  94                  *
  95                  *  \param[in] virtualcable  Index of the virtual MIDI cable the event relates to
  96                  *  \param[in] command       MIDI command to send through the virtual MIDI cable
  97                  *
  98                  *  \return Constructed MIDI event ID.
  99                  */
 100                 #define MIDI_EVENT(virtualcable, command) ((virtualcable << 4) | (command >> 4))
 101
 102         /* Enums: */
 103                 /** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */
 104                 enum MIDI_JackTypes_t
 105                 {
 106                         MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
 107                         MIDI_JACKTYPE_External = 0x02, /**< MIDI class descriptor jack type value for an external (physical) MIDI input or output jack. */
 108                 };
 109
 110         /* Type Defines: */
 111                 /** \brief MIDI class-specific Streaming Interface Descriptor (LUFA naming conventions).
 112                  *
 113                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 114                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 115                  *  See the USB Audio specification for more details.
 116                  *
 117                  *  \see \ref USB_MIDI_StdDescriptor_AudioInterface_AS_t for the version of this type with standard element names.
 118                  *
 119                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 120                  */
 121                 typedef struct
 122                 {
 123                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 124                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 125
 126                         uint16_t                AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class
 127                                                                      *   specification version.
 128                                                                      */
 129                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 130                 } ATTR_PACKED USB_MIDI_Descriptor_AudioInterface_AS_t;
 131
 132                 /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions).
 133                  *
 134                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 135                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 136                  *  See the USB Audio specification for more details.
 137                  *
 138                  *  \see \ref USB_MIDI_Descriptor_AudioInterface_AS_t for the version of this type with non-standard LUFA specific
 139                  *       element names.
 140                  *
 141                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 142                  */
 143                 typedef struct
 144                 {
 145                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 146                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 147                                                    *   given by the specific class.
 148                                                    */
 149
 150                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 151
 152                         uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. */
 153                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 154                 } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t;
 155
 156                 /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions).
 157                  *
 158                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 159                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 160                  *
 161                  *  \see \ref USB_MIDI_StdDescriptor_InputJack_t for the version of this type with standard element names.
 162                  *
 163                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 164                  */
 165                 typedef struct
 166                 {
 167                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 168                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 169
 170                         uint8_t                 JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 171                         uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 172
 173                         uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 174                 } ATTR_PACKED USB_MIDI_Descriptor_InputJack_t;
 175
 176                 /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).
 177                  *
 178                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 179                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 180                  *
 181                  *  \see \ref USB_MIDI_Descriptor_InputJack_t for the version of this type with non-standard LUFA specific
 182                  *       element names.
 183                  *
 184                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 185                  */
 186                 typedef struct
 187                 {
 188                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 189                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 190                                                    *   given by the specific class.
 191                                                    */
 192
 193                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 194
 195                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 196                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 197
 198                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 199                 } ATTR_PACKED USB_MIDI_StdDescriptor_InputJack_t;
 200
 201                 /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions).
 202                  *
 203                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 204                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 205                  *
 206                  *  \see \ref USB_MIDI_StdDescriptor_OutputJack_t for the version of this type with standard element names.
 207                  *
 208                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 209                  */
 210                 typedef struct
 211                 {
 212                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 213                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 214
 215                         uint8_t                   JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 216                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 217
 218                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */
 219                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack. */
 220                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */
 221
 222                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 223                 } ATTR_PACKED USB_MIDI_Descriptor_OutputJack_t;
 224
 225                 /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions).
 226                  *
 227                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 228                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 229                  *
 230                  *  \see \ref USB_MIDI_Descriptor_OutputJack_t for the version of this type with non-standard LUFA specific
 231                  *       element names.
 232                  *
 233                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 234                  */
 235                 typedef struct
 236                 {
 237                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 238                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 239                                                    *   given by the specific class.
 240                                                    */
 241
 242                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 243
 244                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 245                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 246
 247                         uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */
 248                         uint8_t  baSourceID[1]; /**< ID of each output pin's source data jack. */
 249                         uint8_t  baSourcePin[1]; /**< Pin number in the input jack of each output pin's source data. */
 250
 251                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 252                 } ATTR_PACKED USB_MIDI_StdDescriptor_OutputJack_t;
 253
 254                 /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions).
 255                  *
 256                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 257                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 258                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 259                  *
 260                  *  \see \ref USB_MIDI_StdDescriptor_Jack_Endpoint_t for the version of this type with standard element names.
 261                  *
 262                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 263                  */
 264                 typedef struct
 265                 {
 266                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 267                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 268
 269                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */
 270                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */
 271                 } ATTR_PACKED USB_MIDI_Descriptor_Jack_Endpoint_t;
 272
 273                 /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions).
 274                  *
 275                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 276                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 277                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 278                  *
 279                  *  \see \ref USB_MIDI_Descriptor_Jack_Endpoint_t for the version of this type with non-standard LUFA specific
 280                  *       element names.
 281                  *
 282                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 283                  */
 284                 typedef struct
 285                 {
 286                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 287                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 288                                                    *   given by the specific class.
 289                                                    */
 290
 291                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 292
 293                         uint8_t  bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */
 294                         uint8_t  bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */
 295                 } ATTR_PACKED USB_MIDI_StdDescriptor_Jack_Endpoint_t;
 296
 297                 /** \brief MIDI Class Driver Event Packet.
 298                  *
 299                  *  Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
 300                  *
 301                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 302                  */
 303                 typedef struct
 304                 {
 305                         uint8_t Event; /**< MIDI event type, constructed with the \ref MIDI_EVENT() macro. */
 306
 307                         uint8_t  Data1; /**< First byte of data in the MIDI event. */
 308                         uint8_t  Data2; /**< Second byte of data in the MIDI event. */
 309                         uint8_t  Data3; /**< Third byte of data in the MIDI event. */
 310                 } ATTR_PACKED MIDI_EventPacket_t;
 311
 312         /* Disable C linkage for C++ Compilers: */
 313                 #if defined(__cplusplus)
 314                         }
 315                 #endif
 316
 317 #endif
 318
 319 /** @} */
 320