Added new Host mode Audio Class driver.

Added new EVENT_Audio_StreamStartStopChange() event to the Audio Device Class driver to detect stream start/stop events.

6 files changed, 601 insertions, 7 deletions

diff --git a/LUFA/Drivers/USB/Class/Audio.h b/LUFA/Drivers/USB/Class/Audio.h
index e2f88d16a..ad0150f65 100644
--- a/LUFA/Drivers/USB/Class/Audio.h
+++ b/LUFA/Drivers/USB/Class/Audio.h
@@ -43,11 +43,12 @@
  *  \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 <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ *    - LUFA/Drivers/USB/Class/Host/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
  *  \section Sec_ModDescription Module Description
- *  Audio Class Driver module. This module contains an internal implementation of the USB Audio 1.0 Class, for Device
- *  USB mode only. User applications can use this class driver instead of implementing the Audio class manually via
- *  the low-level LUFA APIs.
+ *  Audio Class Driver module. This module contains an internal implementation of the USB Audio 1.0 Class, for both
+ *  Device and Host USB modes. User applications can use this class driver instead of implementing the Audio class
+ *  manually via the low-level LUFA APIs.
  *
  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  *  Hosts or Devices using the USB Audio Class.
@@ -69,6 +70,10 @@
 			#include "Device/Audio.h"
 		#endif
 
+		#if defined(USB_CAN_BE_HOST)
+			#include "Host/Audio.h"
+		#endif
+
 #endif
 
 /** @} */
diff --git a/LUFA/Drivers/USB/Class/Device/Audio.c b/LUFA/Drivers/USB/Class/Device/Audio.c
index dbf62dae2..60c091e7f 100644
--- a/LUFA/Drivers/USB/Class/Device/Audio.c
+++ b/LUFA/Drivers/USB/Class/Device/Audio.c
@@ -70,6 +70,7 @@ void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const Audi
 				Endpoint_ClearStatusStage();
 
 				AudioInterfaceInfo->State.InterfaceEnabled = ((USB_ControlRequest.wValue & 0xFF) != 0);
+				EVENT_Audio_StreamStartStopChange(AudioInterfaceInfo);
 			}
 
 			break;
@@ -164,4 +165,9 @@ bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioIn
 	return true;
 }
 
+void Audio_Device_Event_Stub(void)
+{
+
+}
+
 #endif
diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index cad87f3b6..7e7dad88d 100644
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -101,9 +101,9 @@
 				           */
 				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.
-												*/
+					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.
 				          */
@@ -160,6 +160,14 @@
 			                                           uint16_t* const DataLength,
 			                                           uint8_t* Data);
 
+			/** Audio class driver event for an Audio Stream start/stop change. This event fires each time the device receives a stream enable or
+			 *  disable control request from the host, to start and stop the audio stream. The current state of the stream can be determined by the
+			 *  State.InterfaceEnabled value inside the Audio interface structure passed as a parameter.
+			 *
+			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
+			 */
+			void EVENT_Audio_StreamStartStopChange(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
+
 		/* 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().
@@ -348,6 +356,18 @@
 				  Endpoint_ClearIN();
 			}
 
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Function Prototypes: */
+			#if defined(__INCLUDE_FROM_AUDIO_DEVICE_C)
+				void Audio_Device_Event_Stub(void) ATTR_CONST;
+				
+				void EVENT_Audio_StreamStartStopChange(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+				                                       ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(Audio_Device_Event_Stub);
+			#endif
+
+	#endif	
+
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			}
diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index 6f78a24dd..7dc565c82 100644
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -177,7 +177,7 @@
 			/** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
 			 *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
 			 *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
-			 *  are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
+			 *  are available in the State.ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
 			 *  a mask of CDC_CONTROL_LINE_OUT_* masks.
 			 *
 			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
diff --git a/LUFA/Drivers/USB/Class/Host/Audio.c b/LUFA/Drivers/USB/Class/Host/Audio.c
new file mode 100644
index 000000000..7397ef986
--- /dev/null
+++ b/LUFA/Drivers/USB/Class/Host/Audio.c
@@ -0,0 +1,208 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2011.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  Copyright 2011  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.

+*/

+

+#define  __INCLUDE_FROM_USB_DRIVER

+#include "../../Core/USBMode.h"

+

+#if defined(USB_CAN_BE_HOST)

+

+#define  __INCLUDE_FROM_AUDIO_DRIVER

+#define  __INCLUDE_FROM_AUDIO_HOST_C

+#include "Audio.h"

+

+uint8_t Audio_Host_ConfigurePipes(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+                                  uint16_t ConfigDescriptorSize,

+                                  void* ConfigDescriptorData)

+{

+	USB_Descriptor_Endpoint_t*  DataINEndpoint          = NULL;

+	USB_Descriptor_Endpoint_t*  DataOUTEndpoint         = NULL;

+	USB_Descriptor_Interface_t* AudioControlInterface   = NULL;

+	USB_Descriptor_Interface_t* AudioStreamingInterface = NULL;

+

+	memset(&AudioInterfaceInfo->State, 0x00, sizeof(AudioInterfaceInfo->State));

+

+	if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)

+	  return AUDIO_ENUMERROR_InvalidConfigDescriptor;

+

+	while (!(DataINEndpoint) || !(DataOUTEndpoint))

+	{

+		if (!(AudioControlInterface) ||

+		    USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,

+		                              DComp_NextAudioInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)

+		{

+			if (!(AudioControlInterface) ||

+			    USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,

+			                              DComp_NextAudioStreamInterface) != DESCRIPTOR_SEARCH_COMP_Found)

+			{

+				if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,

+											  DComp_NextAudioControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)

+				{

+					return AUDIO_ENUMERROR_NoCompatibleInterfaceFound;

+				}

+

+				AudioControlInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);			

+

+				if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,

+										  DComp_NextAudioStreamInterface) != DESCRIPTOR_SEARCH_COMP_Found)

+				{

+					return AUDIO_ENUMERROR_NoCompatibleInterfaceFound;

+				}

+			}

+

+			AudioStreamingInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);

+

+			continue;

+		}

+

+		USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);

+

+		if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)

+		  DataINEndpoint  = EndpointData;

+		else

+		  DataOUTEndpoint = EndpointData;

+	}

+

+	for (uint8_t PipeNum = 1; PipeNum < PIPE_TOTAL_PIPES; PipeNum++)

+	{

+		uint16_t Size;

+		uint8_t  Type;

+		uint8_t  Token;

+		uint8_t  EndpointAddress;

+		bool     DoubleBanked;

+

+		if (PipeNum == AudioInterfaceInfo->Config.DataINPipeNumber)

+		{

+			Size            = DataINEndpoint->EndpointSize;

+			EndpointAddress = DataINEndpoint->EndpointAddress;

+			Token           = PIPE_TOKEN_IN;

+			Type            = EP_TYPE_BULK;

+			DoubleBanked    = true;

+

+			AudioInterfaceInfo->State.DataINPipeSize = DataINEndpoint->EndpointSize;

+		}

+		else if (PipeNum == AudioInterfaceInfo->Config.DataOUTPipeNumber)

+		{

+			Size            = DataOUTEndpoint->EndpointSize;

+			EndpointAddress = DataOUTEndpoint->EndpointAddress;

+			Token           = PIPE_TOKEN_OUT;

+			Type            = EP_TYPE_ISOCHRONOUS;

+			DoubleBanked    = true;

+

+			AudioInterfaceInfo->State.DataOUTPipeSize = DataOUTEndpoint->EndpointSize;

+		}

+		else

+		{

+			continue;

+		}

+		

+		if (!(Pipe_ConfigurePipe(PipeNum, Type, Token, EndpointAddress, Size,

+		                         DoubleBanked ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE)))

+		{

+			return AUDIO_ENUMERROR_PipeConfigurationFailed;

+		}

+	}

+

+	AudioInterfaceInfo->State.ControlInterfaceNumber    = AudioControlInterface->InterfaceNumber;

+	AudioInterfaceInfo->State.StreamingInterfaceNumber  = AudioStreamingInterface->InterfaceNumber;

+	AudioInterfaceInfo->State.EnabledStreamingAltIndex  = AudioStreamingInterface->AlternateSetting;

+	AudioInterfaceInfo->State.IsActive = true;

+	

+	return AUDIO_ENUMERROR_NoError;

+}

+

+static uint8_t DComp_NextAudioControlInterface(void* CurrentDescriptor)

+{

+	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);

+

+	if (Header->Type == DTYPE_Interface)

+	{

+		USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);

+

+		if ((Interface->Class    == AUDIO_CSCP_AudioClass) &&

+		    (Interface->SubClass == AUDIO_CSCP_ControlSubclass) &&

+		    (Interface->Protocol == AUDIO_CSCP_ControlProtocol))

+		{

+			return DESCRIPTOR_SEARCH_Found;

+		}

+	}

+

+	return DESCRIPTOR_SEARCH_NotFound;

+}

+

+static uint8_t DComp_NextAudioStreamInterface(void* CurrentDescriptor)

+{

+	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);

+

+	if (Header->Type == DTYPE_Interface)

+	{

+		USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);

+

+		if ((Interface->Class    == AUDIO_CSCP_AudioClass) &&

+		    (Interface->SubClass == AUDIO_CSCP_AudioStreamingSubclass) &&

+		    (Interface->Protocol == AUDIO_CSCP_StreamingProtocol))

+		{

+			return DESCRIPTOR_SEARCH_Found;

+		}

+	}

+

+	return DESCRIPTOR_SEARCH_NotFound;

+}

+

+static uint8_t DComp_NextAudioInterfaceDataEndpoint(void* CurrentDescriptor)

+{

+	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);

+

+	if (Header->Type == DTYPE_Endpoint)

+	{

+		USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);

+

+		if ((Endpoint->Attributes & EP_TYPE_MASK) == EP_TYPE_ISOCHRONOUS)

+		  return DESCRIPTOR_SEARCH_Found;

+	}

+	else if (Header->Type == DTYPE_Interface)

+	{

+		return DESCRIPTOR_SEARCH_Fail;

+	}

+

+	return DESCRIPTOR_SEARCH_NotFound;

+}

+

+uint8_t AUDIO_Host_StartStopStreaming(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                          bool EnableStreaming)

+{

+	if (!(AudioInterfaceInfo->State.IsActive))

+	  return HOST_SENDCONTROL_DeviceDisconnected;

+

+	return USB_Host_SetInterfaceAltSetting(AudioInterfaceInfo->State.StreamingInterfaceNumber,

+	                                       EnableStreaming ? AudioInterfaceInfo->State.EnabledStreamingAltIndex : 0);

+}

+

+#endif

+

diff --git a/LUFA/Drivers/USB/Class/Host/Audio.h b/LUFA/Drivers/USB/Class/Host/Audio.h
new file mode 100644
index 000000000..23523144b
--- /dev/null
+++ b/LUFA/Drivers/USB/Class/Host/Audio.h
@@ -0,0 +1,355 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2011.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  Copyright 2011  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 Host mode driver for the library USB Audio Class driver.

+ *

+ *  Host 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 USB module driver

+ *        dispatch header located in LUFA/Drivers/USB.h.

+ */

+

+/** \ingroup Group_USBClassAudio

+ *  \defgroup Group_USBClassAudioHost Audio Class Host 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/Host/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>

+ *

+ *  \section Sec_ModDescription Module Description

+ *  Host Mode USB Class driver framework interface, for the Audio USB Class driver.

+ *

+ *  @{

+ */

+

+#ifndef __AUDIO_CLASS_HOST_H__

+#define __AUDIO_CLASS_HOST_H__

+

+	/* Includes: */

+		#include "../../USB.h"

+		#include "../Common/Audio.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/USB.h instead.

+		#endif

+

+	/* Public Interface - May be used in end-application: */

+		/* Type Defines: */

+			/** \brief Audio Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

+			 *  and passed to each of the Audio class driver functions as the \c AudioInterfaceInfo parameter. This

+			 *  stores each Audio interface's configuration and state information.

+			 */

+			typedef struct

+			{

+				const struct

+				{

+					uint8_t  DataINPipeNumber; /**< Pipe number of the Audio interface's IN data pipe. */

+					uint8_t  DataOUTPipeNumber; /**< Pipe number of the Audio interface's OUT data pipe. */

+				} 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 IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid

+					                *   after \ref Audio_Host_ConfigurePipes() is called and the Host state machine is in the

+					                *   Configured state.

+					                */

+					uint8_t ControlInterfaceNumber; /**< Interface index of the Audio Control interface within the attached device. */

+					uint8_t StreamingInterfaceNumber; /**< Interface index of the Audio Streaming interface within the attached device. */

+					

+					uint8_t EnabledStreamingAltIndex; /**< Alternative setting index of the Audio Streaming interface when the stream is enabled. */

+

+					uint16_t DataINPipeSize; /**< Size in bytes of the Audio interface's IN data pipe. */

+					uint16_t DataOUTPipeSize;  /**< Size in bytes of the Audio interface's OUT data pipe. */

+				} State; /**< State data for the USB class interface within the device. All elements in this section

+						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when

+						  *   the interface is enumerated.

+						  */

+			} USB_ClassInfo_Audio_Host_t;

+

+		/* Enums: */

+			/** Enum for the possible error codes returned by the \ref Audio_Host_ConfigurePipes() function. */

+			enum AUDIO_Host_EnumerationFailure_ErrorCodes_t

+			{

+				AUDIO_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */

+				AUDIO_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */

+				AUDIO_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible AUDIO interface was not found in the device's Configuration Descriptor. */

+				AUDIO_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */

+			};

+

+		/* Function Prototypes: */

+			/** Host interface configuration routine, to configure a given Audio host interface instance using the Configuration

+			 *  Descriptor read from an attached USB device. This function automatically updates the given Audio Host instance's

+			 *  state values and configures the pipes required to communicate with the interface if it is found within the

+			 *  device. This should be called once after the stack has enumerated the attached device, while the host state

+			 *  machine is in the Addressed state.

+			 *

+			 *  \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other

+			 *        interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes

+			 *        within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.

+			 *        \n\n

+			 *

+			 *  \param[in,out] AudioInterfaceInfo      Pointer to a structure containing an Audio Class host configuration and state.

+			 *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.

+			 *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.

+			 *

+			 *  \return A value from the \ref AUDIO_Host_EnumerationFailure_ErrorCodes_t enum.

+			 */

+			uint8_t Audio_Host_ConfigurePipes(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                  uint16_t ConfigDescriptorSize,

+			                                  void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);

+

+			/** Starts or stops the audio streaming for the given configured Audio Host interface, allowing for audio samples to be

+			 *  send and/or received.

+			 *

+			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class host configuration and state.

+			 *  \param[in]     EnableStreaming     Boolean true to enable streaming of the specified interface, false to disable

+			 *

+			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.

+			 */

+			uint8_t AUDIO_Host_StartStopStreaming(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                      bool EnableStreaming);

+

+		/* Inline Functions: */

+			/** General management task for a given Audio host 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 host configuration and state.

+			 */

+			static inline void Audio_Host_USBTask(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo);

+			static inline void Audio_Host_USBTask(USB_ClassInfo_Audio_Host_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

+			 *  IN pipe ready for reading.

+			 *

+			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_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 \c true if the given Audio interface has a sample to be read, \c false otherwise.

+			 */

+			static inline bool Audio_Host_IsSampleReceived(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			                                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline bool Audio_Host_IsSampleReceived(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			{

+				if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))

+				  return false;

+

+				Pipe_SelectPipe(AudioInterfaceInfo->Config.DataOUTPipeNumber);

+				return Pipe_IsINReceived();

+			}

+

+			/** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects

+			 *  the streaming OUT pipe ready for writing.

+			 *

+			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_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 \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.

+			 */

+			static inline bool Audio_Host_IsReadyForNextSample(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline bool Audio_Host_IsReadyForNextSample(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			{

+				if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))

+				  return false;

+

+				Pipe_SelectPipe(AudioInterfaceInfo->Config.DataINPipeNumber);

+				return Pipe_IsOUTReady();

+			}

+

+			/** Reads the next 8-bit audio sample from the current audio interface.

+			 *

+			 *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure

+			 *       that the correct pipe 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_Host_ReadSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			                                              ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline int8_t Audio_Host_ReadSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			{

+				int8_t Sample;

+

+				(void)AudioInterfaceInfo;

+

+				Sample = Pipe_Read_8();

+

+				if (!(Pipe_BytesInPipe()))

+				  Pipe_ClearIN();

+

+				return Sample;

+			}

+

+			/** Reads the next 16-bit audio sample from the current audio interface.

+			 *

+			 *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure

+			 *       that the correct pipe 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_Host_ReadSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			                                                ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline int16_t Audio_Host_ReadSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			{

+				int16_t Sample;

+

+				(void)AudioInterfaceInfo;

+

+				Sample = (int16_t)Pipe_Read_16_LE();

+

+				if (!(Pipe_BytesInPipe()))

+				  Pipe_ClearIN();

+

+				return Sample;

+			}

+

+			/** Reads the next 24-bit audio sample from the current audio interface.

+			 *

+			 *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure

+			 *       that the correct pipe 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_Host_ReadSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			                                                ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline int32_t Audio_Host_ReadSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)

+			{

+				int32_t Sample;

+

+				(void)AudioInterfaceInfo;

+

+				Sample = (((uint32_t)Pipe_Read_8() << 16) | Pipe_Read_16_LE());

+

+				if (!(Pipe_BytesInPipe()))

+				  Pipe_ClearIN();

+

+				return Sample;

+			}

+

+			/** Writes the next 8-bit audio sample to the current audio interface.

+			 *

+			 *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to

+			 *       ensure that the correct pipe 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_Host_WriteSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                             const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline void Audio_Host_WriteSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                             const int8_t Sample)

+			{

+				Pipe_Write_8(Sample);

+

+				if (Pipe_BytesInPipe() == AudioInterfaceInfo->State.DataINPipeSize)

+				  Pipe_ClearOUT();

+			}

+

+			/** Writes the next 16-bit audio sample to the current audio interface.

+			 *

+			 *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to

+			 *       ensure that the correct pipe 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_Host_WriteSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                              const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline void Audio_Host_WriteSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                              const int16_t Sample)

+			{

+				Pipe_Write_16_LE(Sample);

+

+				if (Pipe_BytesInPipe() == AudioInterfaceInfo->State.DataINPipeSize)

+				  Pipe_ClearOUT();

+			}

+

+			/** Writes the next 24-bit audio sample to the current audio interface.

+			 *

+			 *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to

+			 *       ensure that the correct pipe 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_Host_WriteSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                              const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

+			static inline void Audio_Host_WriteSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,

+			                                              const int32_t Sample)

+			{

+				Pipe_Write_16_LE(Sample);

+				Pipe_Write_8(Sample >> 16);

+

+				if (Pipe_BytesInPipe() == AudioInterfaceInfo->State.DataINPipeSize)

+				  Pipe_ClearOUT();

+			}

+			

+	/* Private Interface - For use in library only: */

+	#if !defined(__DOXYGEN__)

+		/* Function Prototypes: */

+			#if defined(__INCLUDE_FROM_AUDIO_HOST_C)

+				static uint8_t DComp_NextAudioControlInterface(void* CurrentDescriptor);

+				static uint8_t DComp_NextAudioStreamInterface(void* CurrentDescriptor);

+				static uint8_t DComp_NextAudioInterfaceDataEndpoint(void* CurrentDescriptor);

+			#endif

+	#endif

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+

+#endif

+

+/** @} */

+