Fix build error in TestApp demo caused by previous commit.

[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 7ce0624..2c91dae 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -31,6 +31,10 @@
 /** \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
@@ -87,8 +91,7 @@
                                                                                                *   of the Audio Streaming interface.\r
                                                                                                */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
-                                         *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
-                                         *   the interface is enumerated.\r
+                                         *   are reset to their defaults when the interface is enumerated.\r
                                          */                            \r
                        } USB_ClassInfo_Audio_Device_t;\r
                \r
@@ -122,54 +125,62 @@
                         *  \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(void);\r
+                       int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\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(void);\r
+                       int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\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(void);\r
+                       int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\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(const int8_t Sample);\r
+                       void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const 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[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(const int16_t Sample);\r
+                       void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const 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[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(const int32_t Sample);\r
+                       void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int32_t Sample);\r
 \r
                        /** Determines if the given audio interface is ready for a sample to be read from it.\r
                         *\r