X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b7049da11b6fe3c37b23d8f7dddfff08ba14f449..f9f1bcc25c17b031029200cd9648d76d4ee39dc4:/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 3591358f9..12a8acdd6 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -31,6 +31,10 @@ /** \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. * @@ -52,100 +56,147 @@ #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 + * 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 incomming 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). + */ + + 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 + * must 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_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 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 */ - bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_t* 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. + * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event. * - * \param 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_t* AudioInterfaceInfo); + void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** 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 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_t* AudioInterfaceInfo); + void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** 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 * 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); + int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** 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 * 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); + int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** 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 * 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); + int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** 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 * the correct endpoint is selected and ready for data. * - * \param Sample Signed 8-bit audio sample + * \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(int8_t Sample); + void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1); /** 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 * the correct endpoint is selected and ready for data. * - * \param Sample Signed 16-bit audio sample + * \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(int16_t Sample); + void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1); /** 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 * the correct endpoint is selected and ready for data. * - * \param Sample Signed 24-bit audio sample + * \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(int32_t Sample); + void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1); /** Determines if the given audio interface is ready for a sample to be read from it. * - * \param 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 given Audio interface has a sample to be read, false otherwise */ - bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo); + bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** Determines if the given audio interface is ready to accept the next sample to be written to it. * - * \param 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 given Audio interface is ready to accept the next sample, false otherwise */ - bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo); + bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus)