Finished preliminary AVRISP project - all V2 protocol commands now work correctly...

[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 767f754..b1c5046 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -91,14 +91,13 @@
                                                                                                *   of the Audio Streaming interface.\r
                                                                                                */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\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

-                                         *   <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
                /* Function Prototypes: */\r
                        /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library\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
+                        *  \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
                         *  given Audio interface is selected.\r
                         *\r
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r


@@ -108,11 +107,11 @@
                        bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
 \r
                        /** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be\r
                        bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const 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
+                        *  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
                         *\r
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.\r
                         */\r

-                       void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
+                       void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const 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
                        /** 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


@@ -126,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
                         *  \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
                         *  \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
 \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
                         *  \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
 \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
                         *  \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
 \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
                         *  \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
 \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
                         *  \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
 \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
                         *  \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
 \r
                        /** Determines if the given audio interface is ready for a sample to be read from it.\r
                         *\r