Add missing U2S board definition, update build tests and documentation.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / AudioClassDevice.h

diff --git a/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h b/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h
index dad177e..8c26ca2 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h
+++ b/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

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

-  Copyright 2012  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_USBClassAudioDevice Audio 1.0 Class Device Mode Driver
  *
 /** \ingroup Group_USBClassAudio
  *  \defgroup Group_USBClassAudioDevice Audio 1.0 Class Device Mode Driver
  *

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

  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/AudioClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/AudioClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_USBClassAudioDevice_ModDescription Module Description

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


@@ -79,23 +79,15 @@
                        {
                                struct
                                {
                        {
                                struct
                                {

+                                       uint8_t  ControlInterfaceNumber; /**< Index of the Audio Control interface within the device this
+                                                                         *   structure controls.
+                                                                         */

                                        uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
                                                                                                                *   structure controls.
                                                                                                                */
 
                                        uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
                                                                                                                *   structure controls.
                                                                                                                */
 

-                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available
-                                                                                                       *   (zero if unused).
-                                                                                                       */
-                                       uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available
-                                                                                                 *   (zero if unused).
-                                                                                                 */
-
-                                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
-                                                                                                        *   (zero if unused).
-                                                                                                        */
-                                       uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
-                                                                                                  *   (zero if unused).
-                                                                                                  */
+                                       USB_Endpoint_Table_t DataINEndpoint; /**< Data IN endpoint configuration table. */
+                                       USB_Endpoint_Table_t DataOUTEndpoint; /**< Data OUT endpoint 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.
                                           */


@@ -132,7 +124,7 @@
                         *
                         *  When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
                         *  the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations
                         *
                         *  When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
                         *  the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations

-                        *  to indicate the size of the retreived data.
+                        *  to indicate the size of the retrieved data.

                         *
                         *  \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
                         *        of the \c DataLength parameter.
                         *
                         *  \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
                         *        of the \c DataLength parameter.


@@ -161,7 +153,7 @@
                         *
                         *  When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
                         *  the given entity and should return as fast as possible. When non-NULL, this value may be altered for GET operations
                         *
                         *  When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
                         *  the given entity and should return as fast as possible. When non-NULL, this value may be altered for GET operations

-                        *  to indicate the size of the retreived data.
+                        *  to indicate the size of the retrieved data.

                         *
                         *  \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
                         *        of the \c DataLength parameter.
                         *
                         *  \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
                         *        of the \c DataLength parameter.


@@ -223,7 +215,7 @@
                                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.DataOUTEndpointNumber);
+                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpoint.Address);

                                return Endpoint_IsOUTReceived();
                        }
 
                                return Endpoint_IsOUTReceived();
                        }
 


@@ -244,7 +236,7 @@
                                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);
+                               Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpoint.Address);

                                return Endpoint_IsINReady();
                        }
 
                                return Endpoint_IsINReady();
                        }
 


@@ -338,7 +330,7 @@
                        {
                                Endpoint_Write_8(Sample);
 
                        {
                                Endpoint_Write_8(Sample);
 

-                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpoint.Size)

                                  Endpoint_ClearIN();
                        }
 
                                  Endpoint_ClearIN();
                        }
 


@@ -357,7 +349,7 @@
                        {
                                Endpoint_Write_16_LE(Sample);
 
                        {
                                Endpoint_Write_16_LE(Sample);
 

-                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpoint.Size)

                                  Endpoint_ClearIN();
                        }
 
                                  Endpoint_ClearIN();
                        }
 


@@ -377,7 +369,7 @@
                                Endpoint_Write_16_LE(Sample);
                                Endpoint_Write_8(Sample >> 16);
 
                                Endpoint_Write_16_LE(Sample);
                                Endpoint_Write_8(Sample >> 16);
 

-                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
+                               if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpoint.Size)

                                  Endpoint_ClearIN();
                        }
 
                                  Endpoint_ClearIN();
                        }