X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/7f9f97c792dee6875fbca9806422bdd7d6c5a657..49b09a2042368947ab34f788f00b710183912285:/LUFA/Drivers/USB/Class/Device/Audio.h?ds=sidebyside diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index fcfd65d72..87fab9889 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -55,6 +55,11 @@ 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 @@ -112,17 +117,13 @@ * \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); - - /** 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 - */ - void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** 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 @@ -132,6 +133,9 @@ /** 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 @@ -139,6 +143,17 @@ bool Audio_Device_IsReadyForNextSample(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(). + * + * \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; + } + /** 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