Fix outdated filename references in the LUFA documentation.

[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..02a79aa 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, 2013.

 
   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 2013  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


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -40,11 +40,11 @@
 /** \ingroup Group_USBClassAudio
  *  \defgroup Group_USBClassAudioHost Audio 1.0 Class Host Mode Driver
  *
 /** \ingroup Group_USBClassAudio
  *  \defgroup Group_USBClassAudioHost Audio 1.0 Class Host Mode Driver
  *

- *  \section Sec_Dependencies Module Source Dependencies
+ *  \section Sec_USBClassAudioHost_Dependencies Module Source Dependencies

  *  The following files must be built with any user project that uses this module:
  *  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
+ *  \section Sec_USBClassAudioHost_ModDescription Module Description

  *  Host Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
  *
  *  @{
  *  Host Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
  *
  *  @{


@@ -77,16 +77,10 @@
                         */
                        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
-                                                                   *   this driver instance.
-                                                                   */
-                                       uint8_t  DataOUTPipeNumber; /**< Pipe number of the Audio interface's OUT data pipe. If this interface should not
-                                                                   *   bind to an OUT endpoint, this may be set to 0 to disable audio output streaming for
-                                                                   *   this driver instance.
-                                                                   */
+                                       USB_Pipe_Table_t DataINPipe; /**< Data IN Pipe configuration table. */
+                                       USB_Pipe_Table_t DataOUTPipe; /**< Data OUT Pipe configuration table. */

                                } 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.
                                           */


@@ -98,11 +92,8 @@
                                                        */
                                        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. */
-                                       uint16_t DataOUTPipeSize;  /**< Size in bytes of the Audio interface's OUT data pipe. */
+                                       uint8_t EnabledStreamingAltIndex; /**< Alternative setting index of the Audio Streaming interface when the stream is enabled. */

                                } State; /**< State data for the USB class interface within the device. All elements in this section
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
                                                  *   the interface is enumerated.
                                } State; /**< State data for the USB class interface within the device. All elements in this section
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
                                                  *   the interface is enumerated.


@@ -126,21 +117,21 @@
                         *  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.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class host configuration and state.
 
                        /** Starts or stops the audio streaming for the given configured Audio Host interface, allowing for audio samples to be
                         *  send and/or received.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class host configuration and state.

-                        *  \param[in]     EnableStreaming     Boolean true to enable streaming of the specified interface, false to disable
+                        *  \param[in]     EnableStreaming     Boolean true to enable streaming of the specified interface, \c false to disable

                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
                         */


@@ -201,7 +192,7 @@
 
                                bool SampleReceived = false;
 
 
                                bool SampleReceived = false;
 

-                               Pipe_SelectPipe(AudioInterfaceInfo->Config.DataINPipeNumber);
+                               Pipe_SelectPipe(AudioInterfaceInfo->Config.DataINPipe.Address);

                                Pipe_Unfreeze();
                                SampleReceived = Pipe_IsINReceived();
                                Pipe_Freeze();
                                Pipe_Unfreeze();
                                SampleReceived = Pipe_IsINReceived();
                                Pipe_Freeze();


@@ -226,7 +217,7 @@
                                if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))
                                  return false;
 
                                if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))
                                  return false;
 

-                               Pipe_SelectPipe(AudioInterfaceInfo->Config.DataOUTPipeNumber);
+                               Pipe_SelectPipe(AudioInterfaceInfo->Config.DataOUTPipe.Address);

                                return Pipe_IsOUTReady();
                        }
 
                                return Pipe_IsOUTReady();
                        }
 


@@ -331,7 +322,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 +348,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 +386,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: */