Oops - Bootloader optimizations to GetDescriptor() don't work, as the Configuration...

[pub/USBasp.git] / 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 22e3247..2525ccf 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Common/MIDI.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.

 
   dean [at] fourwalledcubicle [dot] com
 
   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
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -38,9 +38,9 @@
  */
 
 /** \ingroup Group_USBClassMIDI
  */
 
 /** \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.
  *
  *  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: */
                #define __INCLUDE_FROM_AUDIO_DRIVER
 
        /* Includes: */

-               #include "../../HighLevel/StdDescriptors.h"
+               #include "../../Core/StdDescriptors.h"

                #include "Audio.h"
 
                #include "Audio.h"
 

-               #include <string.h>
-

        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {


@@ -70,11 +68,14 @@
                #endif
 
        /* Macros: */
                #endif
 
        /* 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
                /** 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
 
                /** Standard key press velocity value used for all note events. */
                #define MIDI_STANDARD_VELOCITY      64


@@ -87,6 +88,7 @@
                #define MIDI_CHANNEL(channel)        ((channel) - 1)
 
        /* Enums: */
                #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. */
                enum MIDI_JackTypes_t
                {
                        MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */


@@ -111,7 +113,7 @@
                                                                     *   specification version.
                                                                     */
                        uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
                                                                     *   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).
                 *
 
                /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions).
                 *


@@ -133,7 +135,7 @@
 
                        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. */
 
                        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).
                 *
 
                /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions).
                 *


@@ -147,11 +149,11 @@
                        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. */
 
                        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. */
                        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;
+               } ATTR_PACKED USB_MIDI_Descriptor_InputJack_t;

 
                /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).
                 *
 
                /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).
                 *


@@ -170,11 +172,11 @@
 
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
 
                        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. */
                        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).
                 *
 
                /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions).
                 *


@@ -188,7 +190,7 @@
                        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. */
 
                        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                   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. */


@@ -196,7 +198,7 @@
                        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. */
                        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).
                 *
 
                /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions).
                 *


@@ -215,7 +217,7 @@
 
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
 
                        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  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. */


@@ -223,7 +225,7 @@
                        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. */
                        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).
                 *
 
                /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions).
                 *


@@ -240,7 +242,7 @@
 
                        uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */
                        uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */
 
                        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).
                 *
 
                /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions).
                 *


@@ -262,7 +264,7 @@
 
                        uint8_t  bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */
                        uint8_t  bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */
 
                        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.
                 *
 
                /** \brief MIDI Class Driver Event Packet.
                 *


@@ -276,7 +278,7 @@
                        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. */
                        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;
+               } ATTR_PACKED MIDI_EventPacket_t;

 
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
 
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)