Change AVRISP project's timeout to be interrupt based again, but make the interrupt...

[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 b72e518..11a05bf 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Device mode driver for the library USB MIDI Class driver.\r
+ *\r
+ *  Device 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_USBClassMIDIDevice MIDI Class Device Mode Driver\r
  *\r
 /** \ingroup Group_USBClassMIDI\r
  *  @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver\r
  *\r


@@ -47,7 +56,6 @@
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/MIDI.h"\r
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/MIDI.h"\r

-               #include "Audio.h"\r

 \r
                #include <string.h>\r
 \r
 \r
                #include <string.h>\r
 \r


@@ -56,9 +64,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 Define: */\r
        /* Public Interface - May be used in end-application: */\r
                /* Type Define: */\r

-                       /** Class state structure. An instance of this structure should be made for each MIDI interface\r
+                       /** \brief MIDI Class Device Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made for each MIDI interface\r

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


@@ -104,14 +119,12 @@
                         */             \r
                        void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         */             \r
                        void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
 \r

-                       /** General management task for a given MIDI 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
+                       /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. Events are queued into the\r
+                        *  endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple\r
+                        *  MIDI events to be packed into a single endpoint packet, increasing data throughput.\r

                         *\r
                         *\r

-                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state\r
-                        */\r
-                       void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
-                       /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
+                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+                        *        the call will fail.\r

                         *\r
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state\r
                         *  \param[in] Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
                         *\r
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state\r
                         *  \param[in] Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r


@@ -119,9 +132,23 @@
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum                   \r
                         */\r
                        uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum                   \r
                         */\r
                        uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r

-                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+\r

 \r
 \r

-                       /** Receives a MIDI event packet from the host.\r
+                       /** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the\r
+                        *  \ref MIDI_Device_SendEventPacket() function's packing behaviour, to flush queued events.\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 Endpoint_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t MIDI_Device_Flush(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo);\r
+\r
+                       /** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains\r
+                        *  multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.\r
+                        *\r
+                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+                        *        the call will fail.\r

                         *\r
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state\r
                         *  \param[out] Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
                         *\r
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state\r
                         *  \param[out] Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r


@@ -129,7 +156,19 @@
                         *  \return Boolean true if a MIDI event packet was received, false otherwise\r
                         */\r
                        bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r
                         *  \return Boolean true if a MIDI event packet was received, false otherwise\r
                         */\r
                        bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r

-                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+\r
+               /* Inline Functions: */\r
+                       /** General management task for a given MIDI 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 a MIDI Class configuration and state\r
+                        */\r
+                       static inline void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo);\r
+                       static inline void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo)\r
+                       {\r
+                               (void)MIDIInterfaceInfo;\r
+                       }               \r

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