Update UC3 platform driver support to use the bitmasks defined in the header files...

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

diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h
index ec700a4..45a7561 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -38,7 +38,7 @@
  */
 
 /** \ingroup Group_USBClassMIDI
- *  @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver
+ *  \defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
@@ -57,8 +57,6 @@
                #include "../../USB.h"
                #include "../Common/MIDI.h"
 
-               #include <string.h>
-
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
@@ -69,17 +67,13 @@
                        #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
                #endif
 
-               #if defined(__INCLUDE_FROM_MIDI_DEVICE_C) && defined(NO_STREAM_CALLBACKS)
-                       #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
-               #endif
-
        /* Public Interface - May be used in end-application: */
                /* Type Define: */
                        /** \brief MIDI Class Device Mode Configuration and State Structure.
                         *
                         *  Class state structure. An instance of this structure should be made for each MIDI interface
                         *  within the user application, and passed to each of the MIDI class driver functions as the
-                        *  MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.
+                        *  \c MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.
                         */
                        typedef struct
                        {
@@ -87,16 +81,17 @@
                                {
                                        uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */
 
-                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused). */
-                                       uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused). */
+                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming MIDI IN data, if available (zero if unused). */
+                                       uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI IN data endpoint, if available (zero if unused). */
                                        bool     DataINEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */
 
-                                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused). */
-                                       uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused). */
-                                       bool     DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */
+                                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI OUT data, if available (zero if unused). */
+                                       uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI OUT data endpoint, if available (zero if unused). */
+                                       bool     DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's OUT data endpoint should use double banking. */
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
                                           */
+                               
                                struct
                                {
                                        // No state information for this class
@@ -110,13 +105,9 @@
                         *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
                         *  containing the given MIDI interface is selected.
                         *
-                        *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
-                        *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
-                        *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
-                        *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
                         *
-                        *  \return Boolean true if the endpoints were successfully configured, false otherwise.
+                        *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
                         */
                        bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
@@ -161,7 +152,7 @@
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
                         *  \param[out]    Event              Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed.
                         *
-                        *  \return Boolean true if a MIDI event packet was received, false otherwise.
+                        *  \return Boolean \c true if a MIDI event packet was received, \c false otherwise.
                         */
                        bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,
                                                            MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);