X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/c166dfc64ea10903a43a429709a92dc7ef9ee9dc..77a9df36a77d2523dd2bc24fa17f9f04c6c175c5:/LUFA/Drivers/USB/Class/Common/MIDI.h diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index 0c6223b5b..a273589e4 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. - + Copyright (C) Dean Camera, 2011. + dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com + www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, distribute, and sell this + Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted - without fee, provided that the above copyright notice appear in + without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the + permission notice and warranty disclaimer appear in supporting + documentation, and that the name of the author not be used in + advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -33,14 +33,14 @@ * * Common definitions and declarations for the library USB MIDI Class driver. * - * \note This file should not be included directly. It is automatically included as needed by the class driver - * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + * \note This file should not be included directly. It is automatically included as needed by the USB module driver + * dispatch header located in LUFA/Drivers/USB.h. */ /** \ingroup Group_USBClassMIDI - * @defgroup Group_USBClassMIDICommon Common Class Definitions + * \defgroup Group_USBClassMIDICommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * MIDI Class. * @@ -54,11 +54,9 @@ #define __INCLUDE_FROM_AUDIO_DRIVER /* Includes: */ - #include "../../USB.h" + #include "../../Core/StdDescriptors.h" #include "Audio.h" - #include - /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { @@ -66,38 +64,37 @@ /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_MIDI_DRIVER) - #error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead. + #error Do not include this file directly. Include LUFA/Drivers/USB.h instead. #endif - - /* Macros: */ - /** Audio class descriptor subtype value for a Audio class-specific MIDI input jack descriptor. */ - #define DSUBTYPE_InputJack 0x02 - - /** Audio class descriptor subtype value for a Audio class-specific MIDI output jack descriptor. */ - #define DSUBTYPE_OutputJack 0x03 - - /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */ - #define MIDI_JACKTYPE_EMBEDDED 0x01 - - /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */ - #define MIDI_JACKTYPE_EXTERNAL 0x02 + /* Macros: */ + /** \name MIDI Command Values */ + //@{ /** MIDI command for a note on (activation) event. */ #define MIDI_COMMAND_NOTE_ON 0x90 /** MIDI command for a note off (deactivation) event. */ #define MIDI_COMMAND_NOTE_OFF 0x80 + //@} /** Standard key press velocity value used for all note events. */ #define MIDI_STANDARD_VELOCITY 64 - + /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel * addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address. * * \param[in] channel MIDI channel number to address. */ #define MIDI_CHANNEL(channel) ((channel) - 1) - + + /* Enums: */ + /** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */ + enum MIDI_JackTypes_t + { + MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */ + MIDI_JACKTYPE_External = 0x02, /**< MIDI class descriptor jack type value for an external (physical) MIDI input or output jack. */ + }; + /* Type Defines: */ /** \brief MIDI class-specific Streaming Interface Descriptor (LUFA naming conventions). * @@ -106,18 +103,20 @@ * See the USB Audio specification for more details. * * \see \ref USB_MIDI_StdDescriptor_AudioInterface_AS_t for the version of this type with standard element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - + uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class - * specification version. - */ + * specification version. + */ uint16_t TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */ - } USB_MIDI_Descriptor_AudioInterface_AS_t; - + } ATTR_PACKED USB_MIDI_Descriptor_AudioInterface_AS_t; + /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions). * * Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host @@ -126,19 +125,21 @@ * * \see \ref USB_MIDI_Descriptor_AudioInterface_AS_t for the version of this type with non-standard LUFA specific * element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value - * given by the specific class. - */ + * given by the specific class. + */ uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - + uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. */ uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */ - } USB_MIDI_StdDescriptor_AudioInterface_AS_t; + } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t; /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions). * @@ -146,18 +147,19 @@ * a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint). * * \see \ref USB_MIDI_StdDescriptor_InputJack_t for the version of this type with standard element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */ uint8_t JackID; /**< ID value of this jack - must be a unique value within the device. */ - - uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_MIDI_Descriptor_InputJack_t; + uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ + } ATTR_PACKED USB_MIDI_Descriptor_InputJack_t; /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions). * @@ -166,21 +168,23 @@ * * \see \ref USB_MIDI_Descriptor_InputJack_t for the version of this type with non-standard LUFA specific * element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value - * given by the specific class. - */ + * given by the specific class. + */ uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */ uint8_t bJackID; /**< ID value of this jack - must be a unique value within the device. */ - + uint8_t iJack; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_MIDI_StdDescriptor_InputJack_t; + } ATTR_PACKED USB_MIDI_StdDescriptor_InputJack_t; /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions). * @@ -188,22 +192,24 @@ * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint). * * \see \ref USB_MIDI_StdDescriptor_OutputJack_t for the version of this type with standard element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ uint8_t Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */ uint8_t JackID; /**< ID value of this jack - must be a unique value within the device. */ - + uint8_t NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */ uint8_t SourceJackID[1]; /**< ID of each output pin's source data jack. */ uint8_t SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */ - + uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_MIDI_Descriptor_OutputJack_t; - + } ATTR_PACKED USB_MIDI_Descriptor_OutputJack_t; + /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions). * * Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either @@ -211,25 +217,27 @@ * * \see \ref USB_MIDI_Descriptor_OutputJack_t for the version of this type with non-standard LUFA specific * element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value - * given by the specific class. - */ + * given by the specific class. + */ uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint8_t bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */ + uint8_t bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */ uint8_t bJackID; /**< ID value of this jack - must be a unique value within the device. */ - + uint8_t bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */ uint8_t baSourceID[1]; /**< ID of each output pin's source data jack. */ uint8_t baSourcePin[1]; /**< Pin number in the input jack of each output pin's source data. */ - + uint8_t iJack; /**< Index of a string descriptor describing this descriptor within the device. */ - } USB_MIDI_StdDescriptor_OutputJack_t; + } ATTR_PACKED USB_MIDI_StdDescriptor_OutputJack_t; /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions). * @@ -238,6 +246,8 @@ * class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details. * * \see \ref USB_MIDI_StdDescriptor_Jack_Endpoint_t for the version of this type with standard element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { @@ -246,7 +256,7 @@ uint8_t TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */ uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */ - } USB_MIDI_Descriptor_Jack_Endpoint_t; + } ATTR_PACKED USB_MIDI_Descriptor_Jack_Endpoint_t; /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions). * @@ -256,39 +266,44 @@ * * \see \ref USB_MIDI_Descriptor_Jack_Endpoint_t for the version of this type with non-standard LUFA specific * element names. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { uint8_t bLength; /**< Size of the descriptor, in bytes. */ uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value - * given by the specific class. - */ + * given by the specific class. + */ uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ uint8_t bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */ uint8_t bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */ - } USB_MIDI_StdDescriptor_Jack_Endpoint_t; + } ATTR_PACKED USB_MIDI_StdDescriptor_Jack_Endpoint_t; /** \brief MIDI Class Driver Event Packet. * * Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. + * + * \note Regardless of CPU architecture, these values should be stored as little endian. */ typedef struct { - unsigned char Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet. */ - unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface. */ - - uint8_t Data1; /**< First byte of data in the MIDI event. */ - uint8_t Data2; /**< Second byte of data in the MIDI event. */ - uint8_t Data3; /**< Third byte of data in the MIDI event. */ - } MIDI_EventPacket_t; + unsigned Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet. */ + unsigned CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface. */ + + uint8_t Data1; /**< First byte of data in the MIDI event. */ + uint8_t Data2; /**< Second byte of data in the MIDI event. */ + uint8_t Data3; /**< Third byte of data in the MIDI event. */ + } ATTR_PACKED MIDI_EventPacket_t; /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif - + #endif /** @} */ +