Remove MIDI ClassDriver device demo's accidental inclusion of the unused ADC peripher...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / MIDI.h

diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h
index 1d76dd3..f71f000 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Host/MIDI.h
@@ -89,10 +89,11 @@
                                           */
                                struct
                                {
-                                       bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
-                                                       *   after \ref MIDI_Host_ConfigurePipes() is called and the Host state machine is in the
-                                                       *   Configured state.
-                                                       */
+                                       bool     IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
+                                                           *   after \ref MIDI_Host_ConfigurePipes() is called and the Host state machine is in the
+                                                           *   Configured state.
+                                                           */
+                                       uint8_t  InterfaceNumber; /**< Interface index of the MIDI interface within the attached device. */
 
                                        uint16_t DataINPipeSize; /**< Size in bytes of the MIDI Streaming Data interface's IN data pipe. */
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the MIDI Streaming Data interface's OUT data pipe. */
@@ -104,12 +105,11 @@
                        
                /* Enums: */
                        /** Enum for the possible error codes returned by the \ref MIDI_Host_ConfigurePipes() function. */
-                       enum MIDIHost_EnumerationFailure_ErrorCodes_t
+                       enum MIDI_Host_EnumerationFailure_ErrorCodes_t
                        {
                                MIDI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
                                MIDI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
-                               MIDI_ENUMERROR_NoStreamingInterfaceFound  = 2, /**< A compatible MIDI interface was not found in the device's Configuration Descriptor. */
-                               MIDI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible MIDI data endpoints were not found in the device's MIDI interface. */
+                               MIDI_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible MIDI interface was not found in the device's Configuration Descriptor. */
                        };
        
                /* Function Prototypes: */
@@ -119,13 +119,18 @@
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
+                        *  \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other
+                        *        interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes
+                        *        within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.
+                        *
                         *  \param[in,out] MIDIInterfaceInfo       Pointer to a structure containing an MIDI Class host configuration and state.
                         *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
                         *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
                         *
-                        *  \return A value from the \ref MIDIHost_EnumerationFailure_ErrorCodes_t enum.
+                        *  \return A value from the \ref MIDI_Host_EnumerationFailure_ErrorCodes_t enum.
                         */
-                       uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, uint16_t ConfigDescriptorSize,
+                       uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
+                                                        uint16_t ConfigDescriptorSize,
                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 
                        /** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded.
@@ -142,7 +147,7 @@
                                                          MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 
                        /** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the
-                        *  \ref MIDI_Host_SendEventPacket() function's packing behavior, to flush queued events. Events are queued into the
+                        *  \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the
                         *  pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI
                         *  events to be packed into a single pipe packet, increasing data throughput.
                         *
@@ -183,9 +188,6 @@
                        #define MIDI_STREAMING_CLASS           0x01
                        #define MIDI_STREAMING_SUBCLASS        0x03
                        #define MIDI_STREAMING_PROTOCOL        0x00
-                       
-                       #define MIDI_FOUND_DATAPIPE_IN           (1 << 0)
-                       #define MIDI_FOUND_DATAPIPE_OUT          (1 << 1)
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_MIDI_CLASS_HOST_C)