Break device mode class driver interfaces into seperate config and state structs...

[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 87aabe1..e2e06b6 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -53,6 +53,45 @@
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r

+               /* Type Define: */\r
+                       /** Configuration information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */\r
+\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
+                               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_Device_Config_t;\r
+       \r
+                       /** Current State information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */\r
+                       typedef struct\r
+                       {\r
+                       \r
+                       } USB_ClassInfo_MIDI_Device_State_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. This stores each MIDI interface's configuration and state information.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               const USB_ClassInfo_MIDI_Device_Config_t Config; /**< Config data for the USB class interface within\r
+                                                                                 *   the device. All elements in this section\r
+                                                                                 *   <b>must</b> be set or the interface will fail\r
+                                                                                 *   to enumerate and operate correctly.\r
+                                                                                 */\r
+                                                                                                                        \r
+                               USB_ClassInfo_MIDI_Device_State_t State; /**< State data for the USB class interface within\r
+                                                                         *   the device. All elements in this section\r
+                                                                         *   <b>may</b> be set to initial values, but may\r
+                                                                         *   also be ignored to default to sane values when\r
+                                                                         *   the interface is enumerated.\r
+                                                                         */\r
+                       } USB_ClassInfo_MIDI_Device_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
                /* 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


@@ -62,28 +101,28 @@
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r

-                       bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+                       bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_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
                        \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 MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+                       void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_Device_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
 \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 MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+                       void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_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
 \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 MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+                       void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r

 \r
                        /** Receives a MIDI event packet from the host.\r
                         *\r
 \r
                        /** Receives a MIDI event packet from the host.\r
                         *\r


@@ -92,7 +131,7 @@
                         *\r
                         *  \return Boolean true if a MIDI event packet was received, false otherwise\r
                         */\r
                         *\r
                         *  \return Boolean true if a MIDI event packet was received, false otherwise\r
                         */\r

-                       bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+                       bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\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