+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2012.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this\r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in\r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief Common definitions and declarations for the library USB MIDI Class driver.\r
- *\r
- * Common definitions and declarations for the library USB MIDI Class driver.\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the USB module driver\r
- * dispatch header located in LUFA/Drivers/USB.h.\r
- */\r
-\r
-/** \ingroup Group_USBClassMIDI\r
- * \defgroup Group_USBClassMIDICommon Common Class Definitions\r
- *\r
- * \section Sec_ModDescription Module Description\r
- * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
- * MIDI Class.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef _MIDI_CLASS_COMMON_H_\r
-#define _MIDI_CLASS_COMMON_H_\r
-\r
- /* Macros: */\r
- #define __INCLUDE_FROM_AUDIO_DRIVER\r
-\r
- /* Includes: */\r
- #include "../../Core/StdDescriptors.h"\r
- #include "AudioClassCommon.h"\r
-\r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- extern "C" {\r
- #endif\r
-\r
- /* Preprocessor Checks: */\r
- #if !defined(__INCLUDE_FROM_MIDI_DRIVER)\r
- #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.\r
- #endif\r
-\r
- /* Macros: */\r
- /** \name MIDI Command Values */\r
- //@{\r
- /** MIDI command for a note on (activation) event. */\r
- #define MIDI_COMMAND_NOTE_ON 0x90\r
-\r
- /** MIDI command for a note off (deactivation) event. */\r
- #define MIDI_COMMAND_NOTE_OFF 0x80\r
- //@}\r
-\r
- /** Standard key press velocity value used for all note events. */\r
- #define MIDI_STANDARD_VELOCITY 64\r
-\r
- /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel\r
- * addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.\r
- *\r
- * \param[in] channel MIDI channel number to address.\r
- *\r
- * \return Constructed MIDI channel ID.\r
- */\r
- #define MIDI_CHANNEL(channel) ((channel) - 1)\r
- \r
- /** Constructs a MIDI event ID from a given MIDI command and a virtual MIDI cable index. This can then be\r
- * used to create and decode \ref MIDI_EventPacket_t MIDI event packets.\r
- *\r
- * \param[in] virtualcable Index of the virtual MIDI cable the event relates to\r
- * \param[in] command MIDI command to send through the virtual MIDI cable\r
- *\r
- * \return Constructed MIDI event ID.\r
- */\r
- #define MIDI_EVENT(virtualcable, command) ((virtualcable << 4) | (command >> 4))\r
-\r
- /* Enums: */\r
- /** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */\r
- enum MIDI_JackTypes_t\r
- {\r
- MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */\r
- MIDI_JACKTYPE_External = 0x02, /**< MIDI class descriptor jack type value for an external (physical) MIDI input or output jack. */\r
- };\r
-\r
- /* Type Defines: */\r
- /** \brief MIDI class-specific Streaming Interface Descriptor (LUFA naming conventions).\r
- *\r
- * Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host\r
- * how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.\r
- * See the USB Audio specification for more details.\r
- *\r
- * \see \ref USB_MIDI_StdDescriptor_AudioInterface_AS_t for the version of this type with standard element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class\r
- * specification version.\r
- */\r
- uint16_t TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */\r
- } ATTR_PACKED USB_MIDI_Descriptor_AudioInterface_AS_t;\r
-\r
- /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions).\r
- *\r
- * Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host\r
- * how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.\r
- * See the USB Audio specification for more details.\r
- *\r
- * \see \ref USB_MIDI_Descriptor_AudioInterface_AS_t for the version of this type with non-standard LUFA specific\r
- * element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- uint8_t bLength; /**< Size of the descriptor, in bytes. */\r
- uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
- * given by the specific class.\r
- */\r
-\r
- uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. */\r
- uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */\r
- } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t;\r
-\r
- /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions).\r
- *\r
- * Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either\r
- * a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).\r
- *\r
- * \see \ref USB_MIDI_StdDescriptor_InputJack_t for the version of this type with standard element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint8_t JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */\r
- uint8_t JackID; /**< ID value of this jack - must be a unique value within the device. */\r
-\r
- uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */\r
- } ATTR_PACKED USB_MIDI_Descriptor_InputJack_t;\r
-\r
- /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).\r
- *\r
- * Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either\r
- * a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).\r
- *\r
- * \see \ref USB_MIDI_Descriptor_InputJack_t for the version of this type with non-standard LUFA specific\r
- * element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- uint8_t bLength; /**< Size of the descriptor, in bytes. */\r
- uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
- * given by the specific class.\r
- */\r
-\r
- uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint8_t bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */\r
- uint8_t bJackID; /**< ID value of this jack - must be a unique value within the device. */\r
-\r
- uint8_t iJack; /**< Index of a string descriptor describing this descriptor within the device. */\r
- } ATTR_PACKED USB_MIDI_StdDescriptor_InputJack_t;\r
-\r
- /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions).\r
- *\r
- * Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either\r
- * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).\r
- *\r
- * \see \ref USB_MIDI_StdDescriptor_OutputJack_t for the version of this type with standard element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint8_t JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */\r
- uint8_t JackID; /**< ID value of this jack - must be a unique value within the device. */\r
-\r
- uint8_t NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */\r
- uint8_t SourceJackID[1]; /**< ID of each output pin's source data jack. */\r
- uint8_t SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */\r
-\r
- uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */\r
- } ATTR_PACKED USB_MIDI_Descriptor_OutputJack_t;\r
-\r
- /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions).\r
- *\r
- * Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either\r
- * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).\r
- *\r
- * \see \ref USB_MIDI_Descriptor_OutputJack_t for the version of this type with non-standard LUFA specific\r
- * element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- uint8_t bLength; /**< Size of the descriptor, in bytes. */\r
- uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
- * given by the specific class.\r
- */\r
-\r
- uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint8_t bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */\r
- uint8_t bJackID; /**< ID value of this jack - must be a unique value within the device. */\r
-\r
- uint8_t bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */\r
- uint8_t baSourceID[1]; /**< ID of each output pin's source data jack. */\r
- uint8_t baSourcePin[1]; /**< Pin number in the input jack of each output pin's source data. */\r
-\r
- uint8_t iJack; /**< Index of a string descriptor describing this descriptor within the device. */\r
- } ATTR_PACKED USB_MIDI_StdDescriptor_OutputJack_t;\r
-\r
- /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions).\r
- *\r
- * Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information\r
- * on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio\r
- * class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.\r
- *\r
- * \see \ref USB_MIDI_StdDescriptor_Jack_Endpoint_t for the version of this type with standard element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint8_t TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */\r
- uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */\r
- } ATTR_PACKED USB_MIDI_Descriptor_Jack_Endpoint_t;\r
-\r
- /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions).\r
- *\r
- * Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information\r
- * on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio\r
- * class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.\r
- *\r
- * \see \ref USB_MIDI_Descriptor_Jack_Endpoint_t for the version of this type with non-standard LUFA specific\r
- * element names.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- uint8_t bLength; /**< Size of the descriptor, in bytes. */\r
- uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value\r
- * given by the specific class.\r
- */\r
-\r
- uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */\r
-\r
- uint8_t bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */\r
- uint8_t bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */\r
- } ATTR_PACKED USB_MIDI_StdDescriptor_Jack_Endpoint_t;\r
-\r
- /** \brief MIDI Class Driver Event Packet.\r
- *\r
- * Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.\r
- *\r
- * \note Regardless of CPU architecture, these values should be stored as little endian.\r
- */\r
- typedef struct\r
- {\r
- uint8_t Event; /**< MIDI event type, constructed with the \ref MIDI_EVENT() macro. */\r
-\r
- uint8_t Data1; /**< First byte of data in the MIDI event. */\r
- uint8_t Data2; /**< Second byte of data in the MIDI event. */\r
- uint8_t Data3; /**< Third byte of data in the MIDI event. */\r
- } ATTR_PACKED MIDI_EventPacket_t;\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
-\r
-#endif\r
-\r
-/** @} */\r
-\r
projects / qmk_firmware.git / blobdiff