X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/5ce3f0b17bc927513bd980e8710f588564fe1dcc..ac0ece0141fe9470539380fb5e5f069a0ff701ff:/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 b76abf663..7fdd8aa1d 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -42,7 +42,7 @@ * * \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 + * - LUFA/Drivers/USB/Class/Device/Audio.c (Makefile source module name: LUFA_SRC_USBCLASS) * * \section Module Description * Device Mode USB Class driver framework interface, for the Audio USB Class driver. @@ -82,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 incoming Audio Streaming data, if available - * (zero if unused) + * (zero if unused). */ uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available - * (zero if unused) + * (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. @@ -116,16 +116,16 @@ * \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 successfully 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) ATTR_NON_NULL_PTR_ARG(1); /** 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_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -133,7 +133,7 @@ /** 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. */ static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -145,12 +145,12 @@ /** 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. + * \pre 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 + * \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 + * \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) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -166,12 +166,12 @@ /** 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. + * \pre 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 + * \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 + * \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) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -186,12 +186,12 @@ /** Reads the next 8-bit audio sample from the current audio interface. * - * \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure - * ensure the correct endpoint is selected and ready for data. + * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure + * ensure 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,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * - * \return Signed 8-bit audio sample from the audio interface + * \return Signed 8-bit audio sample from the audio interface. */ static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -211,12 +211,12 @@ /** Reads the next 16-bit audio sample from the current audio interface. * - * \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure - * that the correct endpoint is selected and ready for data. + * \pre This should be preceded immediately by a call to the \ref Audio_Device_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 + * \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 + * \return Signed 16-bit audio sample from the audio interface. */ static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -236,12 +236,12 @@ /** Reads the next 24-bit audio sample from the current audio interface. * - * \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure - * that the correct endpoint is selected and ready for data. + * \pre This should be preceded immediately by a call to the \ref Audio_Device_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 + * \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 + * \return Signed 24-bit audio sample from the audio interface. */ static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -261,11 +261,11 @@ /** Writes the next 8-bit audio sample to the current audio interface. * - * \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to - * ensure that the correct endpoint is selected and ready for data. + * \pre This should be preceded immediately by a call to the \ref Audio_Device_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 + * \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_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -280,11 +280,11 @@ /** Writes the next 16-bit audio sample to the current audio interface. * - * \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to - * ensure that the correct endpoint is selected and ready for data. + * \pre This should be preceded immediately by a call to the \ref Audio_Device_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 + * \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_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE; @@ -299,11 +299,11 @@ /** Writes the next 24-bit audio sample to the current audio interface. * - * \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to - * ensure that the correct endpoint is selected and ready for data. + * \pre This should be preceded immediately by a call to the \ref Audio_Device_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 + * \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_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;