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

[pub/lufa.git] / LUFA / Drivers / USB / Class / Device / Audio.h

diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index 3591358..cc3e984 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -52,6 +52,57 @@
                #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 Defines: */\r
+                       /** Configuration information structure for \ref USB_ClassInfo_Audio_Device_t Audio device interface structures. */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this\r
+                                                                   *   structure controls.\r
+                                                                   */\r
+\r
+                               uint8_t  DataINEndpointNumber; /**< Endpoint number of the incomming Audio Streaming data, if available\r
+                                                               *   (zero if unused).\r
+                                                               */\r
+                               uint16_t DataINEndpointSize; /**< Size in bytes of the incomming Audio Streaming data endpoint, if available\r
+                                                             *   (zero if unused).\r
+                                                             */\r
+\r
+                               uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available\r
+                                                                *   (zero if unused).\r
+                                                                */\r
+                               uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available\r
+                                                              *   (zero if unused).\r
+                                                              */                       \r
+                       } USB_ClassInfo_Audio_Device_Config_t;\r
+                       \r
+                       /** Current State information structure for \ref USB_ClassInfo_Audio_Device_t Audio device interface structures. */\r
+                       typedef struct\r
+                       {\r
+                               bool     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints\r
+                                                                                       *   of the Audio Streaming interface.\r
+                                                                                       */\r
+                       } USB_ClassInfo_Audio_Device_State_t;\r
+               \r
+                       /** Class state structure. An instance of this structure should be made for each Audio interface\r
+                        *  within the user application, and passed to each of the Audio class driver functions as the\r
+                        *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               const USB_ClassInfo_Audio_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_Audio_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_Audio_Device_t;\r
+               \r

                /* Function Prototypes: */\r
                        /** Configures the endpoints of a given Audio 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 containing the\r
                /* Function Prototypes: */\r
                        /** Configures the endpoints of a given Audio 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 containing the\r


@@ -61,21 +112,21 @@
                         *\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 Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+                       bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r

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

-                       void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+                       void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r

 \r
                        /** General management task for a given Audio 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 AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
                         */\r
 \r
                        /** General management task for a given Audio 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 AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
                         */\r

-                       void Audio_Device_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+                       void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r

                        \r
                        /** Reads the next 8-bit audio sample from the current audio interface.\r
                         *\r
                        \r
                        /** Reads the next 8-bit audio sample from the current audio interface.\r
                         *\r


@@ -137,7 +188,7 @@
                         *\r
                         *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
                         */\r
                         *\r
                         *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
                         */\r

-                       bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+                       bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r

 \r
                        /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
                         *\r
 \r
                        /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
                         *\r


@@ -145,7 +196,7 @@
                         *\r
                         *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
                         */\r
                         *\r
                         *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
                         */\r

-                       bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
+                       bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\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