--- /dev/null
+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2011.\r
+\r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+ Copyright 2011 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 Host mode driver for the library USB Audio Class driver.\r
+ *\r
+ * Host 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 USB module driver\r
+ * dispatch header located in LUFA/Drivers/USB.h.\r
+ */\r
+\r
+/** \ingroup Group_USBClassAudio\r
+ * \defgroup Group_USBClassAudioHost Audio Class Host 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/Host/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>\r
+ *\r
+ * \section Sec_ModDescription Module Description\r
+ * Host Mode USB Class driver framework interface, for the Audio USB Class driver.\r
+ *\r
+ * @{\r
+ */\r
+\r
+#ifndef __AUDIO_CLASS_HOST_H__\r
+#define __AUDIO_CLASS_HOST_H__\r
+\r
+ /* Includes: */\r
+ #include "../../USB.h"\r
+ #include "../Common/Audio.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/USB.h instead.\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Type Defines: */\r
+ /** \brief Audio Class Host Mode Configuration and State Structure.\r
+ *\r
+ * Class state structure. An instance of this structure should be made within the user application,\r
+ * and passed to each of the Audio class driver functions as the \c AudioInterfaceInfo parameter. This\r
+ * stores each Audio interface's configuration and state information.\r
+ */\r
+ typedef struct\r
+ {\r
+ const struct\r
+ {\r
+ uint8_t DataINPipeNumber; /**< Pipe number of the Audio interface's IN data pipe. */\r
+ uint8_t DataOUTPipeNumber; /**< Pipe number of the Audio interface's OUT data pipe. */\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 IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid\r
+ * after \ref Audio_Host_ConfigurePipes() is called and the Host state machine is in the\r
+ * Configured state.\r
+ */\r
+ uint8_t ControlInterfaceNumber; /**< Interface index of the Audio Control interface within the attached device. */\r
+ uint8_t StreamingInterfaceNumber; /**< Interface index of the Audio Streaming interface within the attached device. */\r
+ \r
+ uint8_t EnabledStreamingAltIndex; /**< Alternative setting index of the Audio Streaming interface when the stream is enabled. */\r
+\r
+ uint16_t DataINPipeSize; /**< Size in bytes of the Audio interface's IN data pipe. */\r
+ uint16_t DataOUTPipeSize; /**< Size in bytes of the Audio interface's OUT data pipe. */\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
+ */\r
+ } USB_ClassInfo_Audio_Host_t;\r
+\r
+ /* Enums: */\r
+ /** Enum for the possible error codes returned by the \ref Audio_Host_ConfigurePipes() function. */\r
+ enum AUDIO_Host_EnumerationFailure_ErrorCodes_t\r
+ {\r
+ AUDIO_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully. */\r
+ AUDIO_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor. */\r
+ AUDIO_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible AUDIO interface was not found in the device's Configuration Descriptor. */\r
+ AUDIO_ENUMERROR_PipeConfigurationFailed = 3, /**< One or more pipes for the specified interface could not be configured correctly. */\r
+ };\r
+\r
+ /* Function Prototypes: */\r
+ /** Host interface configuration routine, to configure a given Audio host interface instance using the Configuration\r
+ * Descriptor read from an attached USB device. This function automatically updates the given Audio Host instance's\r
+ * state values and configures the pipes required to communicate with the interface if it is found within the\r
+ * device. This should be called once after the stack has enumerated the attached device, while the host state\r
+ * machine is in the Addressed state.\r
+ *\r
+ * \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other\r
+ * interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes\r
+ * within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.\r
+ * \n\n\r
+ *\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class host configuration and state.\r
+ * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor.\r
+ * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor.\r
+ *\r
+ * \return A value from the \ref AUDIO_Host_EnumerationFailure_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Audio_Host_ConfigurePipes(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ uint16_t ConfigDescriptorSize,\r
+ void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r
+\r
+ /** Starts or stops the audio streaming for the given configured Audio Host interface, allowing for audio samples to be\r
+ * send and/or received.\r
+ *\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class host configuration and state.\r
+ * \param[in] EnableStreaming Boolean true to enable streaming of the specified interface, false to disable\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.\r
+ */\r
+ uint8_t AUDIO_Host_StartStopStreaming(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ bool EnableStreaming);\r
+\r
+ /* Inline Functions: */\r
+ /** General management task for a given Audio host class interface, required for the correct operation of\r
+ * the interface. This should be called frequently in the main program loop, before the master USB management task\r
+ * \ref USB_USBTask().\r
+ *\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class host configuration and state.\r
+ */\r
+ static inline void Audio_Host_USBTask(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo);\r
+ static inline void Audio_Host_USBTask(USB_ClassInfo_Audio_Host_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
+ * IN pipe ready for reading.\r
+ *\r
+ * \pre This function must only be called when the Host state machine is in the \ref HOST_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 \c true if the given Audio interface has a sample to be read, \c false otherwise.\r
+ */\r
+ static inline bool Audio_Host_IsSampleReceived(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline bool Audio_Host_IsSampleReceived(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ {\r
+ if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))\r
+ return false;\r
+\r
+ Pipe_SelectPipe(AudioInterfaceInfo->Config.DataOUTPipeNumber);\r
+ return Pipe_IsINReceived();\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 OUT pipe ready for writing.\r
+ *\r
+ * \pre This function must only be called when the Host state machine is in the \ref HOST_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 \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.\r
+ */\r
+ static inline bool Audio_Host_IsReadyForNextSample(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline bool Audio_Host_IsReadyForNextSample(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ {\r
+ if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))\r
+ return false;\r
+\r
+ Pipe_SelectPipe(AudioInterfaceInfo->Config.DataINPipeNumber);\r
+ return Pipe_IsOUTReady();\r
+ }\r
+\r
+ /** Reads the next 8-bit audio sample from the current audio interface.\r
+ *\r
+ * \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure\r
+ * that the correct pipe 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_Host_ReadSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline int8_t Audio_Host_ReadSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ {\r
+ int8_t Sample;\r
+\r
+ (void)AudioInterfaceInfo;\r
+\r
+ Sample = Pipe_Read_8();\r
+\r
+ if (!(Pipe_BytesInPipe()))\r
+ Pipe_ClearIN();\r
+\r
+ return Sample;\r
+ }\r
+\r
+ /** Reads the next 16-bit audio sample from the current audio interface.\r
+ *\r
+ * \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure\r
+ * that the correct pipe 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_Host_ReadSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline int16_t Audio_Host_ReadSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ {\r
+ int16_t Sample;\r
+\r
+ (void)AudioInterfaceInfo;\r
+\r
+ Sample = (int16_t)Pipe_Read_16_LE();\r
+\r
+ if (!(Pipe_BytesInPipe()))\r
+ Pipe_ClearIN();\r
+\r
+ return Sample;\r
+ }\r
+\r
+ /** Reads the next 24-bit audio sample from the current audio interface.\r
+ *\r
+ * \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure\r
+ * that the correct pipe 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_Host_ReadSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline int32_t Audio_Host_ReadSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)\r
+ {\r
+ int32_t Sample;\r
+\r
+ (void)AudioInterfaceInfo;\r
+\r
+ Sample = (((uint32_t)Pipe_Read_8() << 16) | Pipe_Read_16_LE());\r
+\r
+ if (!(Pipe_BytesInPipe()))\r
+ Pipe_ClearIN();\r
+\r
+ return Sample;\r
+ }\r
+\r
+ /** Writes the next 8-bit audio sample to the current audio interface.\r
+ *\r
+ * \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to\r
+ * ensure that the correct pipe 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_Host_WriteSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline void Audio_Host_WriteSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ const int8_t Sample)\r
+ {\r
+ Pipe_Write_8(Sample);\r
+\r
+ if (Pipe_BytesInPipe() == AudioInterfaceInfo->State.DataINPipeSize)\r
+ Pipe_ClearOUT();\r
+ }\r
+\r
+ /** Writes the next 16-bit audio sample to the current audio interface.\r
+ *\r
+ * \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to\r
+ * ensure that the correct pipe 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_Host_WriteSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline void Audio_Host_WriteSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ const int16_t Sample)\r
+ {\r
+ Pipe_Write_16_LE(Sample);\r
+\r
+ if (Pipe_BytesInPipe() == AudioInterfaceInfo->State.DataINPipeSize)\r
+ Pipe_ClearOUT();\r
+ }\r
+\r
+ /** Writes the next 24-bit audio sample to the current audio interface.\r
+ *\r
+ * \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to\r
+ * ensure that the correct pipe 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_Host_WriteSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;\r
+ static inline void Audio_Host_WriteSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,\r
+ const int32_t Sample)\r
+ {\r
+ Pipe_Write_16_LE(Sample);\r
+ Pipe_Write_8(Sample >> 16);\r
+\r
+ if (Pipe_BytesInPipe() == AudioInterfaceInfo->State.DataINPipeSize)\r
+ Pipe_ClearOUT();\r
+ }\r
+ \r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Function Prototypes: */\r
+ #if defined(__INCLUDE_FROM_AUDIO_HOST_C)\r
+ static uint8_t DComp_NextAudioControlInterface(void* CurrentDescriptor);\r
+ static uint8_t DComp_NextAudioStreamInterface(void* CurrentDescriptor);\r
+ static uint8_t DComp_NextAudioInterfaceDataEndpoint(void* CurrentDescriptor);\r
+ #endif\r
+ #endif\r
+\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+\r
+#endif\r
+\r
+/** @} */\r
+\r
projects / pub / lufa.git / blobdiff