X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/f1076ac4d6e56bff7fb6d2126746af1108211370..fc31973daffea3506051ce51a5f79383ce0867d6:/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 7ce062437..fd821e90c 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) - - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, 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 + 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 @@ -28,9 +28,22 @@ 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. * @@ -51,9 +64,16 @@ 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: */ - /** Class state structure. An instance of this structure should be made for each Audio interface + /* 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. */ @@ -62,21 +82,21 @@ const struct { uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this - * structure controls. + * structure controls */ - uint8_t DataINEndpointNumber; /**< Endpoint number of the incomming Audio Streaming data, if available - * (zero if unused). + uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available + * (zero if unused) */ - uint16_t DataINEndpointSize; /**< Size in bytes of the incomming Audio Streaming data endpoint, 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). + * (zero if unused) */ uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available - * (zero if unused). + * (zero if unused) */ } Config; /**< Config data for the USB class interface within the device. All elements in this section * must be set or the interface will fail to enumerate and operate correctly. @@ -87,105 +107,207 @@ * of the Audio Streaming interface. */ } State; /**< State data for the USB class interface within the device. All elements in this section - * may be set to initial values, but may also be ignored to default to sane values when - * the interface is enumerated. + * 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_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the + * \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. + * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * - * \return Boolean true if the endpoints were sucessfully configured, false otherwise + * \return Boolean true if the endpoints were successfully configured, false otherwise */ - bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo); + bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); - /** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be - * linked to the library \ref EVENT_USB_UnhandledControlPacket() event. + /** 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. + * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state */ - void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo); - + 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. + * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state */ - void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo); - + 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 preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that + * \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 */ - int8_t Audio_Device_ReadSample8(void); + 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 preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that + * \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 */ - int16_t Audio_Device_ReadSample16(void); + 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 preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that + * \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 */ - int32_t Audio_Device_ReadSample24(void); + 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 preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that + * \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 */ - void Audio_Device_WriteSample8(const int8_t 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 preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that + * \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 */ - void Audio_Device_WriteSample16(const int16_t 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 preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that + * \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 */ - void Audio_Device_WriteSample24(const int32_t Sample); - - /** Determines if the given audio interface is ready for a sample to be read from it. - * - * \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 - */ - bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo); + 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); - /** Determines if the given audio interface is ready to accept the next sample to be written to it. - * - * \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 - */ - bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo); + if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize) + Endpoint_ClearIN(); + } /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus)