Changed the RFCOMM-specific ItemProtocolChannel_t type to a more generic ItemProtocol...

[pub/USBasp.git] / 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 3586c33..73c2934 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -135,7 +135,8 @@
                         *
                         *  \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);
+                       static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
+                                                               ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                (void)AudioInterfaceInfo;
                        static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                (void)AudioInterfaceInfo;


@@ -144,13 +145,15 @@
                        /** 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.
                         *
                        /** 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
                         *
                         *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
                         *
                         *  \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)
+                                                                        ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
                        static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))


@@ -163,14 +166,16 @@
                        /** 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.
                         *
                        /** 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
                         *
                         *  \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)
                         *
                         *  \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)

+                                                                            ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
+                       static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)

                        {
                                if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
                                  return false;
                        {
                                if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
                                  return false;


@@ -181,14 +186,15 @@
 
                        /** Reads the next 8-bit audio sample from the current audio interface.
                         *
 
                        /** 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
                         *
                         *  \return  Signed 8-bit audio sample from the audio interface
                         */
                         *
                         *  \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
                         */

-                       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)
+                                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                int8_t Sample;
                        static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                int8_t Sample;


@@ -205,14 +211,15 @@
 
                        /** Reads the next 16-bit audio sample from the current audio interface.
                         *
 
                        /** 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
                         *
                         *  \return  Signed 16-bit audio sample from the audio interface
                         */
                         *
                         *  \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
                         */

-                       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)
+                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                int16_t Sample;
                        static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                int16_t Sample;


@@ -229,14 +236,15 @@
 
                        /** Reads the next 24-bit audio sample from the current audio interface.
                         *
 
                        /** 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
                         *
                         *  \return  Signed 24-bit audio sample from the audio interface
                         */
                         *
                         *  \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
                         */

-                       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)
+                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                int32_t Sample;
                        static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                int32_t Sample;


@@ -253,14 +261,14 @@
 
                        /** Writes the next 8-bit audio sample to the current audio interface.
                         *
 
                        /** 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
                         */
                        static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                         *
                         *  \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_ALWAYS_INLINE;
+                                                                    const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                                                                     const int8_t Sample)
                        {
                        static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                                                                     const int8_t Sample)
                        {


@@ -272,14 +280,14 @@
 
                        /** Writes the next 16-bit audio sample to the current audio interface.
                         *
 
                        /** 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
                         */
                        static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                         *
                         *  \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_ALWAYS_INLINE;
+                                                                     const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                                                                      const int16_t Sample)
                        {
                        static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                                                                      const int16_t Sample)
                        {


@@ -291,14 +299,14 @@
 
                        /** Writes the next 24-bit audio sample to the current audio interface.
                         *
 
                        /** 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
                         */
                        static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                         *
                         *  \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_ALWAYS_INLINE;
+                                                                     const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;

                        static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                                                                      const int32_t Sample)
                        {
                        static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
                                                                      const int32_t Sample)
                        {