projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Move RNDISConstants.h into the RNDIS class driver common definition header.
[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..1657c7e 100644 (file)
--- 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, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
-              
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   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 
+  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
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -29,12 +29,12 @@
 */
 
 /** \file
 */
 
 /** \file
- *  \brief Device mode driver for the library USB Audio Class driver.
+ *  \brief Device mode driver for the library USB Audio 1.0 Class driver.
  *
  *
- *  Device mode driver for the library USB Audio Class driver.
+ *  Device mode driver for the library USB Audio 1.0 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.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.
  */
 
 /** \ingroup Group_USBClassAudio
  */
 
 /** \ingroup Group_USBClassAudio
@@ -42,10 +42,10 @@
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *
  *  \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 <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
  *  \section Module Description
  *
  *  \section Module Description
- *  Device Mode USB Class driver framework interface, for the Audio USB Class driver.
+ *  Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
  *
  *  @{
  */
  *
  *  @{
  */
@@ -56,7 +56,7 @@
        /* Includes: */
                #include "../../USB.h"
                #include "../Common/Audio.h"
        /* Includes: */
                #include "../../USB.h"
                #include "../Common/Audio.h"
-               
+
                #include <string.h>
 
        /* Enable C linkage for C++ Compilers: */
                #include <string.h>
 
        /* Enable C linkage for C++ Compilers: */
@@ -66,7 +66,11 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
-                       #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
+               #endif
+
+               #if defined(__INCLUDE_FROM_AUDIO_DEVICE_C) && defined(NO_STREAM_CALLBACKS)
+                       #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
                #endif
 
        /* Public Interface - May be used in end-application: */
                #endif
 
        /* Public Interface - May be used in end-application: */
@@ -82,22 +86,22 @@
                                const struct
                                {
                                        uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
                                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
                                                                                                                */
 
                                        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
                                                                                                        */
                                        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
                                                                                                  */
 
                                        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
                                                                                                         */
                                        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
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
                                           */
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
                                           */
@@ -108,34 +112,39 @@
                                                                                                */
                                } 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.
                                                                                                */
                                } 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;
                        } 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_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
                         *  given Audio interface is selected.
                         *
                /* Function Prototypes: */
                        /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
                         *  \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
+                        *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
+                        *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
+                        *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
+                        *
+                        *  \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.
                         *
                         */
                        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);
                         */
                        void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
-                       
-               /* Inline Functions: */         
+
+               /* 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().
                         *
                        /** 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);
+                       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,75 +153,81 @@
                        /** 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 \ref 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;
                        static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
                        {
                                if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
                                  return false;
                        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);      
+
+                               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.
                         *
                                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.
+                        *  \pre This function must only be called when the Device state machine is in the \ref 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)
                         */
                        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;
-                               
+
                                Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
                                return Endpoint_IsINReady();
                        }
 
                        /** Reads the next 8-bit audio sample from the current audio interface.
                         *
                                Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
                                return Endpoint_IsINReady();
                        }
 
                        /** 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_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;
-                               
+
                                (void)AudioInterfaceInfo;
 
                                Sample = Endpoint_Read_Byte();
 
                                if (!(Endpoint_BytesInEndpoint()))
                                  Endpoint_ClearOUT();
                                (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.
                         *
                                return Sample;
                        }
 
                        /** 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_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;
@@ -220,7 +235,7 @@
                                (void)AudioInterfaceInfo;
 
                                Sample = (int16_t)Endpoint_Read_Word_LE();
                                (void)AudioInterfaceInfo;
 
                                Sample = (int16_t)Endpoint_Read_Word_LE();
-                                         
+
                                if (!(Endpoint_BytesInEndpoint()))
                                  Endpoint_ClearOUT();
 
                                if (!(Endpoint_BytesInEndpoint()))
                                  Endpoint_ClearOUT();
 
@@ -229,14 +244,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
+                        *  \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_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;
@@ -244,7 +260,7 @@
                                (void)AudioInterfaceInfo;
 
                                Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
                                (void)AudioInterfaceInfo;
 
                                Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
-                                         
+
                                if (!(Endpoint_BytesInEndpoint()))
                                  Endpoint_ClearOUT();
 
                                if (!(Endpoint_BytesInEndpoint()))
                                  Endpoint_ClearOUT();
 
@@ -253,14 +269,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
+                        *  \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,
                         */
                        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 +288,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
+                        *  \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,
                         */
                        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 +307,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
+                        *  \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,
                         */
                        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)
                        {
@@ -313,7 +329,8 @@
                #if defined(__cplusplus)
                        }
                #endif
                #if defined(__cplusplus)
                        }
                #endif
-               
+
 #endif
 
 /** @} */
 #endif
 
 /** @} */
+
USB isp AVR programmer