Finished basic documentation of all device mode class drivers.

[pub/lufa.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 08a530a..4be472c 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -145,35 +145,72 @@
                        uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */\r
                } USB_MIDI_Jack_Endpoint_t;\r
 \r
                        uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */\r
                } USB_MIDI_Jack_Endpoint_t;\r
 \r

+               /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */\r

                typedef struct\r
                {\r
                typedef struct\r
                {\r

-                       unsigned char Command     : 4;\r
-                       unsigned char CableNumber : 4;\r
+                       unsigned char Command     : 4; /**< MIDI command being sent or received in the event packet */\r
+                       unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */\r

                        \r
                        \r

-                       uint8_t Data1;\r
-                       uint8_t Data2;\r
-                       uint8_t Data3;                  \r
+                       uint8_t Data1; /**< First byte of data in the MIDI event */\r
+                       uint8_t Data2; /**< Second byte of data in the MIDI event */\r
+                       uint8_t Data3; /**< Third byte of data in the MIDI event */             \r

                } USB_MIDI_EventPacket_t;\r
 \r
                } USB_MIDI_EventPacket_t;\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. The contents of this structure should be set to their correct\r
+                *  values when used, or ommitted to force the library to use default values.\r
+                */\r

                typedef struct\r
                {\r
                typedef struct\r
                {\r

-                       uint8_t  StreamingInterfaceNumber;\r
-\r
-                       uint8_t  DataINEndpointNumber;\r
-                       uint16_t DataINEndpointSize;\r
+                       uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */\r

 \r
 \r

-                       uint8_t  DataOUTEndpointNumber;\r
-                       uint16_t DataOUTEndpointSize;\r
+                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the incomming MIDI data, if available (zero if unused) */\r
+                       uint16_t DataINEndpointSize; /**< Size in bytes of the incomming MIDI data endpoint, if available (zero if unused) */\r

 \r
 \r

-                       bool     InterfaceEnabled;\r
+                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused) */\r
+                       uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused) */\r

                } USB_ClassInfo_MIDI_t;\r
                \r
        /* Function Prototypes: */\r
                } USB_ClassInfo_MIDI_t;\r
                \r
        /* Function Prototypes: */\r

+               /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
+                *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+                *  containing the given MIDI interface is selected.\r
+                *\r
+                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                *\r
+                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                */\r

                bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
                bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r

+               \r
+               /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
+                *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                *\r
+                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                */             \r

                void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
                void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\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
+                *\r
+                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                */\r

                void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
 \r
                void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
 \r

+               /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
+                *\r
+                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                *  \param Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+                */\r

                void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
                void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r

+\r
+               /** Receives a MIDI event packet from the host.\r
+                *\r
+                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                *  \param Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
+                *\r
+                *  \return Boolean true if a MIDI event packet was received, false otherwise\r
+                */\r

                bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r