Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

[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 2a64dc0..0cd99bc 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Host/MIDI.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Host mode driver for the library USB MIDI Class driver.\r
+ *\r
+ *  Host mode driver 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 class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassMIDI\r
  *  @defgroup Group_USBClassMIDIHost MIDI Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassMIDI\r
  *  @defgroup Group_USBClassMIDIHost MIDI Class Host Mode Driver\r
  *\r


@@ -53,9 +62,16 @@
                        extern "C" {\r
                #endif\r
 \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/Class/MIDI.h instead.\r
+               #endif\r
+               \r

        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r

-                       /** Class state structure. An instance of this structure should be made within the user application,\r
+                       /** \brief MIDI Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r

                         *  and passed to each of the MIDI class driver functions as the MIDIInterfaceInfo parameter. This\r
                         *  stores each MIDI interface's configuration and state information.\r
                         */\r
                         *  and passed to each of the MIDI class driver functions as the MIDIInterfaceInfo parameter. This\r
                         *  stores each MIDI interface's configuration and state information.\r
                         */\r


@@ -97,13 +113,6 @@
                        };\r
        \r
                /* Function Prototypes: */\r
                        };\r
        \r
                /* Function Prototypes: */\r

-                       /** General management task for a given MIDI host class interface, required for the correct operation of the interface. This should\r
-                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
-                        *\r
-                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing an MIDI Class host configuration and state\r
-                        */\r
-                       void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-                       \r

                        /** Host interface configuration routine, to configure a given MIDI host interface instance using the Configuration\r
                         *  Descriptor read from an attached USB device. This function automatically updates the given MIDI Host instance's\r
                         *  state values and configures the pipes required to communicate with the interface if it is found within the device.\r
                        /** Host interface configuration routine, to configure a given MIDI host interface instance using the Configuration\r
                         *  Descriptor read from an attached USB device. This function automatically updates the given MIDI Host instance's\r
                         *  state values and configures the pipes required to communicate with the interface if it is found within the device.\r


@@ -132,6 +141,17 @@
                        uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,\r
                                                          MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
 \r
                        uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,\r
                                                          MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
 \r

+                       /** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the\r
+                        *  \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the\r
+                        *  pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI\r
+                        *  events to be packed into a single pipe packet, increasing data throughput.\r
+                        *\r
+                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                        uint8_t MIDI_Host_Flush(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo);\r
+                        \r

                        /** Receives a MIDI event packet from the device.\r
                         *\r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
                        /** Receives a MIDI event packet from the device.\r
                         *\r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r


@@ -144,7 +164,19 @@
                         */\r
                        bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,\r
                                                          MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
                         */\r
                        bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,\r
                                                          MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r

-                                                                                               \r
+\r
+               /* Inline Functions: */\r
+                       /** General management task for a given MIDI host class interface, required for the correct operation of the interface. This should\r
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing an MIDI Class host configuration and state\r
+                        */\r
+                       static inline void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo);\r
+                       static inline void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo)\r
+                       {\r
+                               (void)MIDIInterfaceInfo;\r
+                       }\r
+\r

        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r


@@ -156,7 +188,7 @@
                        #define MIDI_FOUND_DATAPIPE_OUT          (1 << 1)\r
 \r
                /* Function Prototypes: */\r
                        #define MIDI_FOUND_DATAPIPE_OUT          (1 << 1)\r
 \r
                /* Function Prototypes: */\r

-                       #if defined(INCLUDE_FROM_MIDI_CLASS_HOST_C)\r
+                       #if defined(__INCLUDE_FROM_MIDI_CLASS_HOST_C)\r

                                static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
                                static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
                        #endif  \r
                                static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
                                static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
                        #endif  \r