Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / Audio.h
index fd821e9..45e2679 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *  \brief Device mode driver for the library USB Audio Class driver.\r
- *\r
- *  Device mode driver for the library USB Audio Class driver.\r
- *\r
- *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
- *        dispatch header located in LUFA/Drivers/USB/Class/Audio.h.\r
- */\r
-\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
-               #include "../Common/Audio.h"\r
-               \r
-               #include <string.h>\r
-\r
-       /* Enable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       extern "C" {\r
-               #endif\r
-\r
-       /* Preprocessor Checks: */\r
-               #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)\r
-                       #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.\r
-               #endif\r
-\r
-       /* Public Interface - May be used in end-application: */\r
-               /* Type Defines: */\r
-                       /** \brief Audio Class Device Mode Configuration and State Structure.\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 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 incoming Audio Streaming data, if available\r
-                                                                                                       *   (zero if unused)\r
-                                                                                                       */\r
-                                       uint16_t DataINEndpointSize; /**< Size in bytes of the incoming 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
-                               } 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 successfully configured, false otherwise\r
-                        */\r
-                       bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
-                       /** Processes incoming 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
-               /* Inline Functions: */         \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
-                       static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
-                       static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
-                       {\r
-                               (void)AudioInterfaceInfo;\r
-                       }\r
-\r
-                       /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming\r
-                        *  OUT endpoint ready for reading.\r
-                        *\r
-                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
-                        *        the call will fail.\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
-                       static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
-                       {\r
-                               if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))\r
-                                 return false;\r
-                               \r
-                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);      \r
-                               return Endpoint_IsOUTReceived();\r
-                       }\r
-\r
-                       /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects\r
-                        *  the streaming IN endpoint ready for writing.\r
-                        *\r
-                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
-                        *        the call will fail.\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
-                       static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
-                       {\r
-                               if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))\r
-                                 return false;\r
-                               \r
-                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);\r
-                               return Endpoint_IsINReady();\r
-                       }\r
-\r
-                       /** Reads the next 8-bit audio sample from the current audio interface.\r
-                        *\r
-                        *  \note This should be preceded 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
-                       static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;\r
-                       static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
-                       {\r
-                               int8_t Sample;\r
-                               \r
-                               (void)AudioInterfaceInfo;\r
-\r
-                               Sample = Endpoint_Read_Byte();\r
-\r
-                               if (!(Endpoint_BytesInEndpoint()))\r
-                                 Endpoint_ClearOUT();\r
-                               \r
-                               return Sample;\r
-                       }\r
-\r
-                       /** Reads the next 16-bit audio sample from the current audio interface.\r
-                        *\r
-                        *  \note This should be preceded 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
-                       static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;\r
-                       static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
-                       {\r
-                               int16_t Sample;\r
-\r
-                               (void)AudioInterfaceInfo;\r
-\r
-                               Sample = (int16_t)Endpoint_Read_Word_LE();\r
-                                         \r
-                               if (!(Endpoint_BytesInEndpoint()))\r
-                                 Endpoint_ClearOUT();\r
-\r
-                               return Sample;\r
-                       }\r
-\r
-                       /** Reads the next 24-bit audio sample from the current audio interface.\r
-                        *\r
-                        *  \note This should be preceded 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 24-bit audio sample from the audio interface\r
-                        */\r
-                       static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;\r
-                       static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
-                       {\r
-                               int32_t Sample;\r
-\r
-                               (void)AudioInterfaceInfo;\r
-\r
-                               Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());\r
-                                         \r
-                               if (!(Endpoint_BytesInEndpoint()))\r
-                                 Endpoint_ClearOUT();\r
-\r
-                               return Sample;\r
-                       }\r
-\r
-                       /** Writes the next 8-bit audio sample to the current audio interface.\r
-                        *\r
-                        *  \note This should be preceded 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
-                       static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
-                                                                    const int8_t Sample) ATTR_ALWAYS_INLINE;\r
-                       static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
-                                                                    const int8_t Sample)\r
-                       {\r
-                               Endpoint_Write_Byte(Sample);\r
-\r
-                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)\r
-                                 Endpoint_ClearIN();\r
-                       }\r
-\r
-                       /** Writes the next 16-bit audio sample to the current audio interface.\r
-                        *\r
-                        *  \note This should be preceded 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
-                       static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
-                                                                     const int16_t Sample) ATTR_ALWAYS_INLINE;\r
-                       static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
-                                                                     const int16_t Sample)\r
-                       {\r
-                               Endpoint_Write_Word_LE(Sample);\r
-\r
-                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)\r
-                                 Endpoint_ClearIN();\r
-                       }\r
-\r
-                       /** Writes the next 24-bit audio sample to the current audio interface.\r
-                        *\r
-                        *  \note This should be preceded 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
-                       static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
-                                                                     const int32_t Sample) ATTR_ALWAYS_INLINE;\r
-                       static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
-                                                                     const int32_t Sample)\r
-                       {\r
-                               Endpoint_Write_Byte(Sample >> 16);\r
-                               Endpoint_Write_Word_LE(Sample);\r
-\r
-                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)\r
-                                 Endpoint_ClearIN();\r
-                       }\r
-\r
-       /* Disable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       }\r
-               #endif\r
-               \r
-#endif\r
-\r
-/** @} */\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Device mode driver for the library USB Audio Class driver.
+ *
+ *  Device mode driver for the library USB Audio Class driver.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver
+ *        dispatch header located in LUFA/Drivers/USB/Class/Audio.h.
+ */
+
+/** \ingroup Group_USBClassAudio
+ *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Device/Audio.c
+ *
+ *  \section Module Description
+ *  Device Mode USB Class driver framework interface, for the Audio USB Class driver.
+ *
+ *  @{
+ */
+
+#ifndef _AUDIO_CLASS_DEVICE_H_
+#define _AUDIO_CLASS_DEVICE_H_
+
+       /* Includes: */
+               #include "../../USB.h"
+               #include "../Common/Audio.h"
+               
+               #include <string.h>
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.
+               #endif
+
+       /* Public Interface - May be used in end-application: */
+               /* Type Defines: */
+                       /** \brief Audio Class Device Mode Configuration and State Structure.
+                        *
+                        *  Class state structure. An instance of this structure should be made for each Audio interface
+                        *  within the user application, and passed to each of the Audio class driver functions as the
+                        *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
+                        */
+                       typedef struct
+                       {
+                               const struct
+                               {
+                                       uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
+                                                                                                               *   structure controls
+                                                                                                               */
+
+                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available
+                                                                                                       *   (zero if unused)
+                                                                                                       */
+                                       uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available
+                                                                                                 *   (zero if unused)
+                                                                                                 */
+
+                                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
+                                                                                                        *   (zero if unused)
+                                                                                                        */
+                                       uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
+                                                                                                  *   (zero if unused)
+                                                                                                  */                   
+                               } Config; /**< Config data for the USB class interface within the device. All elements in this section
+                                          *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
+                                          */
+                               struct
+                               {
+                                       bool     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
+                                                                                               *   of the Audio Streaming interface.
+                                                                                               */
+                               } State; /**< State data for the USB class interface within the device. All elements in this section
+                                         *   are reset to their defaults when the interface is enumerated.
+                                         */                            
+                       } USB_ClassInfo_Audio_Device_t;
+               
+               /* Function Prototypes: */
+                       /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
+                        *  given Audio interface is selected.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *
+                        *  \return Boolean true if the endpoints were successfully configured, false otherwise
+                        */
+                       bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+                       /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
+                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        */
+                       void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+                       
+               /* Inline Functions: */         
+                       /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        */
+                       static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
+                       static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+                       {
+                               (void)AudioInterfaceInfo;
+                       }
+
+                       /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
+                        *  OUT endpoint ready for reading.
+                        *
+                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *        the call will fail.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *
+                        *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
+                        */             
+                       static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+                       {
+                               if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
+                                 return false;
+                               
+                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);      
+                               return Endpoint_IsOUTReceived();
+                       }
+
+                       /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
+                        *  the streaming IN endpoint ready for writing.
+                        *
+                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *        the call will fail.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *
+                        *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise
+                        */
+                       static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+                       {
+                               if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
+                                 return false;
+                               
+                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
+                               return Endpoint_IsINReady();
+                       }
+
+                       /** Reads the next 8-bit audio sample from the current audio interface.
+                        *
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
+                        *        the correct endpoint is selected and ready for data.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *
+                        *  \return  Signed 8-bit audio sample from the audio interface
+                        */
+                       static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
+                       static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+                       {
+                               int8_t Sample;
+                               
+                               (void)AudioInterfaceInfo;
+
+                               Sample = Endpoint_Read_Byte();
+
+                               if (!(Endpoint_BytesInEndpoint()))
+                                 Endpoint_ClearOUT();
+                               
+                               return Sample;
+                       }
+
+                       /** Reads the next 16-bit audio sample from the current audio interface.
+                        *
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
+                        *        the correct endpoint is selected and ready for data.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *
+                        *  \return  Signed 16-bit audio sample from the audio interface
+                        */
+                       static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
+                       static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+                       {
+                               int16_t Sample;
+
+                               (void)AudioInterfaceInfo;
+
+                               Sample = (int16_t)Endpoint_Read_Word_LE();
+                                         
+                               if (!(Endpoint_BytesInEndpoint()))
+                                 Endpoint_ClearOUT();
+
+                               return Sample;
+                       }
+
+                       /** Reads the next 24-bit audio sample from the current audio interface.
+                        *
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
+                        *        the correct endpoint is selected and ready for data.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *
+                        *  \return  Signed 24-bit audio sample from the audio interface
+                        */
+                       static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
+                       static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+                       {
+                               int32_t Sample;
+
+                               (void)AudioInterfaceInfo;
+
+                               Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
+                                         
+                               if (!(Endpoint_BytesInEndpoint()))
+                                 Endpoint_ClearOUT();
+
+                               return Sample;
+                       }
+
+                       /** Writes the next 8-bit audio sample to the current audio interface.
+                        *
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
+                        *        the correct endpoint is selected and ready for data.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *  \param[in] Sample  Signed 8-bit audio sample
+                        */
+                       static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+                                                                    const int8_t Sample) ATTR_ALWAYS_INLINE;
+                       static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+                                                                    const int8_t Sample)
+                       {
+                               Endpoint_Write_Byte(Sample);
+
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+                                 Endpoint_ClearIN();
+                       }
+
+                       /** Writes the next 16-bit audio sample to the current audio interface.
+                        *
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
+                        *        the correct endpoint is selected and ready for data.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *  \param[in] Sample  Signed 16-bit audio sample
+                        */
+                       static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+                                                                     const int16_t Sample) ATTR_ALWAYS_INLINE;
+                       static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+                                                                     const int16_t Sample)
+                       {
+                               Endpoint_Write_Word_LE(Sample);
+
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+                                 Endpoint_ClearIN();
+                       }
+
+                       /** Writes the next 24-bit audio sample to the current audio interface.
+                        *
+                        *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
+                        *        the correct endpoint is selected and ready for data.
+                        *
+                        *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
+                        *  \param[in] Sample  Signed 24-bit audio sample
+                        */
+                       static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+                                                                     const int32_t Sample) ATTR_ALWAYS_INLINE;
+                       static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
+                                                                     const int32_t Sample)
+                       {
+                               Endpoint_Write_Byte(Sample >> 16);
+                               Endpoint_Write_Word_LE(Sample);
+
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+                                 Endpoint_ClearIN();
+                       }
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+               
+#endif
+
+/** @} */