Oops - with new changes to the way the device Configuration Descriptor is retrieved...

[pub/USBasp.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 aa7b406..12a8acd 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -28,43 +28,181 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-#ifndef _AUDIO_CLASS_H_\r
-#define _AUDIO_CLASS_H_\r
+/** \ingroup Group_USBClassAudio\r
+ *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Device/Audio.c\r
+ *\r
+ *  \section Module Description\r
+ *  Device Mode USB Class driver framework interface, for the Audio USB Class driver.\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef _AUDIO_CLASS_DEVICE_H_\r
+#define _AUDIO_CLASS_DEVICE_H_\r

 \r
        /* Includes: */\r
                #include "../../USB.h"\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r

-\r
+               #include "../Common/Audio.h"\r
+               \r

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

-       /* Macros: */\r
+       /* Enable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       extern "C" {\r
+               #endif\r

 \r
 \r

-       /* Enums: */\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Type Defines: */             \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 struct\r
+                               {\r
+                                       uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this\r
+                                                                                                               *   structure controls.\r
+                                                                                                               */\r

 \r
 \r

-       /* Type Defines: */\r
-               typedef struct\r
-               {\r
-                       uint8_t  InterfaceNumber;\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
 \r

-                       uint8_t  DataINEndpointNumber;\r
-                       uint16_t DataINEndpointSize;\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
+                               } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+                                          *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+                                          */\r
+                               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
+                               } State; /**< State data for the USB class interface within the device. All elements in this section\r
+                                         *   are reset to their defaults when 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_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
+                        *  given Audio interface is selected.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        *\r
+                        *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                        */\r
+                       bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-                       uint8_t  DataOUTEndpointNumber;\r
-                       uint16_t DataOUTEndpointSize;\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_Device_UnhandledControlRequest() event.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        */\r
+                       void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-                       bool     InterfaceEnabled;\r
-               } USB_ClassInfo_Audio_t;\r
-               \r
-       /* Function Prototypes: */\r
-               bool     USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-               void     USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-               void     USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\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[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        */\r
+                       void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Reads the next 8-bit audio sample from the current audio interface.\r
+                        *\r
+                        *  \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        *\r
+                        *  \return  Signed 8-bit audio sample from the audio interface\r
+                        */\r
+                       int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Reads the next 16-bit audio sample from the current audio interface.\r
+                        *\r
+                        *  \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        *\r
+                        *  \return  Signed 16-bit audio sample from the audio interface\r
+                        */\r
+                       int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Reads the next 24-bit audio sample from the current audio interface.\r
+                        *\r
+                        *  \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        *  \return  Signed 24-bit audio sample from the audio interface\r
+                        */\r
+                       int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Writes the next 8-bit audio sample to the current audio interface.\r
+                        *\r
+                        *  \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        *  \param[in] Sample  Signed 8-bit audio sample\r
+                        */\r
+                       void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Writes the next 16-bit audio sample to the current audio interface.\r
+                        *\r
+                        *  \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        *  \param[in] Sample  Signed 16-bit audio sample\r
+                        */\r
+                       void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Writes the next 24-bit audio sample to the current audio interface.\r
+                        *\r
+                        *  \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+                        *        the correct endpoint is selected and ready for data.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
+                        *  \param[in] Sample  Signed 24-bit audio sample\r
+                        */\r
+                       void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Determines if the given audio interface is ready for a sample to be read from it.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\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_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
+                        *\r
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\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_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r

                \r
                \r

-               int8_t   USB_Audio_ReadSample8(void);\r
-               int16_t  USB_Audio_ReadSample16(void);\r
-               int32_t  USB_Audio_ReadSample24(void);\r
-               void     USB_Audio_WriteSample8(int8_t Sample);\r
-               void     USB_Audio_WriteSample16(int16_t Sample);\r
-               void     USB_Audio_WriteSample24(int32_t Sample);\r
-               bool     USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r
-               bool     USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);\r

 #endif\r
 #endif\r

+\r
+/** @} */\r