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 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
+ #include "../Common/Audio.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
- /* Enums: */\r
+ /* Public Interface - May be used in end-application: */\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
+ * given Audio interface is selected.\r
+ *\r
+ * \param 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_t* AudioInterfaceInfo);\r
\r
- /* Type Defines: */\r
- typedef struct\r
- {\r
- uint8_t InterfaceNumber;\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
\r
- uint8_t DataINEndpointNumber;\r
- uint16_t DataINEndpointSize;\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
+ \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
+ * \return Signed 8-bit audio sample from the audio interface\r
+ */\r
+ int8_t Audio_Device_ReadSample8(void);\r
\r
- uint8_t DataOUTEndpointNumber;\r
- uint16_t DataOUTEndpointSize;\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
+ * \return Signed 16-bit audio sample from the audio interface\r
+ */\r
+ int16_t Audio_Device_ReadSample16(void);\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
+ /** 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
+ * \return Signed 24-bit audio sample from the audio interface\r
+ */\r
+ int32_t Audio_Device_ReadSample24(void);\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 Sample Signed 8-bit audio sample\r
+ */\r
+ void Audio_Device_WriteSample8(int8_t Sample);\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 Sample Signed 16-bit audio sample\r
+ */\r
+ void Audio_Device_WriteSample16(int16_t Sample);\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 Sample Signed 24-bit audio sample\r
+ */\r
+ void Audio_Device_WriteSample24(int32_t Sample);\r
+\r
+ /** Determines if the given audio interface is ready for a sample to be read from it.\r
+ *\r
+ * \param 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_t* AudioInterfaceInfo);\r
+\r
+ /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
+ *\r
+ * \param 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_t* AudioInterfaceInfo);\r
+\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\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
+\r
+/** @} */\r
projects / pub / USBasp.git / blobdiff