Pull out common options in the StaticAnalysisTest build test makefile into a seperate...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / AudioClassHost.h

diff --git a/LUFA/Drivers/USB/Class/Host/AudioClassHost.h b/LUFA/Drivers/USB/Class/Host/AudioClassHost.h
index 8be5210..a6e425d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/AudioClassHost.h
+++ b/LUFA/Drivers/USB/Class/Host/AudioClassHost.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -42,7 +42,7 @@
  *
  *  \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/Host/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ *    - LUFA/Drivers/USB/Class/Host/AudioClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>

  *
  *  \section Sec_ModDescription Module Description
  *  Host Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
  *
  *  \section Sec_ModDescription Module Description
  *  Host Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.


@@ -77,7 +77,7 @@
                         */
                        typedef struct
                        {
                         */
                        typedef struct
                        {

-                               const struct
+                               struct

                                {
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the Audio interface's IN data pipe. If this interface should not
                                                                    *   bind to an IN endpoint, this may be set to 0 to disable audio input streaming for
                                {
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the Audio interface's IN data pipe. If this interface should not
                                                                    *   bind to an IN endpoint, this may be set to 0 to disable audio input streaming for


@@ -98,7 +98,7 @@
                                                        */
                                        uint8_t ControlInterfaceNumber; /**< Interface index of the Audio Control interface within the attached device. */
                                        uint8_t StreamingInterfaceNumber; /**< Interface index of the Audio Streaming interface within the attached device. */
                                                        */
                                        uint8_t ControlInterfaceNumber; /**< Interface index of the Audio Control interface within the attached device. */
                                        uint8_t StreamingInterfaceNumber; /**< Interface index of the Audio Streaming interface within the attached device. */

-                                       
+

                                        uint8_t EnabledStreamingAltIndex; /**< Alternative setting index of the Audio Streaming interface when the stream is enabled. */
 
                                        uint16_t DataINPipeSize; /**< Size in bytes of the Audio interface's IN data pipe. */
                                        uint8_t EnabledStreamingAltIndex; /**< Alternative setting index of the Audio Streaming interface when the stream is enabled. */
 
                                        uint16_t DataINPipeSize; /**< Size in bytes of the Audio interface's IN data pipe. */


@@ -126,15 +126,15 @@
                         *  device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *
                         *  device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *

-                        *  \param[in,out] AudioInterfaceInfo      Pointer to a structure containing an Audio Class host configuration and state.
-                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
-                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
+                        *  \param[in,out] AudioInterfaceInfo    Pointer to a structure containing an Audio Class host configuration and state.
+                        *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
+                        *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.

                         *
                         *  \return A value from the \ref AUDIO_Host_EnumerationFailure_ErrorCodes_t enum.
                         */
                        uint8_t Audio_Host_ConfigurePipes(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
                                                          uint16_t ConfigDescriptorSize,
                         *
                         *  \return A value from the \ref AUDIO_Host_EnumerationFailure_ErrorCodes_t enum.
                         */
                        uint8_t Audio_Host_ConfigurePipes(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
                                                          uint16_t ConfigDescriptorSize,

-                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
+                                                         void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);

 
                        /** Starts or stops the audio streaming for the given configured Audio Host interface, allowing for audio samples to be
                         *  send and/or received.
 
                        /** Starts or stops the audio streaming for the given configured Audio Host interface, allowing for audio samples to be
                         *  send and/or received.


@@ -331,7 +331,7 @@
                                                                   const int8_t Sample)
                        {
                                (void)AudioInterfaceInfo;
                                                                   const int8_t Sample)
                        {
                                (void)AudioInterfaceInfo;

-                       
+

                                Pipe_Write_8(Sample);
 
                                if (!(Pipe_IsReadWriteAllowed()))
                                Pipe_Write_8(Sample);
 
                                if (!(Pipe_IsReadWriteAllowed()))


@@ -357,7 +357,7 @@
                                                                    const int16_t Sample)
                        {
                                (void)AudioInterfaceInfo;
                                                                    const int16_t Sample)
                        {
                                (void)AudioInterfaceInfo;

-                       
+

                                Pipe_Write_16_LE(Sample);
 
                                if (!(Pipe_IsReadWriteAllowed()))
                                Pipe_Write_16_LE(Sample);
 
                                if (!(Pipe_IsReadWriteAllowed()))


@@ -395,7 +395,7 @@
                                        Pipe_Freeze();
                                }
                        }
                                        Pipe_Freeze();
                                }
                        }

-                       
+

        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */