From e96621983462a8cec68280f6730c6fc2f059202a Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Sat, 21 Aug 2010 11:38:39 +0000
Subject: [PATCH] Clarify in the documentation that the Audio demos and driver
is for the Audio 1.0 specification, not the newer (and more advanced/less
supported) 2.0 specification.
---
Demos/Device/ClassDriver/AudioInput/AudioInput.txt | 8 ++++----
Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt | 8 ++++----
Demos/Device/LowLevel/AudioInput/AudioInput.txt | 8 ++++----
Demos/Device/LowLevel/AudioOutput/AudioOutput.txt | 8 ++++----
LUFA/Drivers/USB/Class/Audio.h | 2 +-
LUFA/Drivers/USB/Class/Common/Audio.h | 6 +++---
LUFA/Drivers/USB/Class/Device/Audio.h | 6 +++---
7 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
index 0033e6a0f..09b6c6fb3 100644
--- a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
+++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
@@ -33,9 +33,9 @@
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
- * <td>USBIF Audio Class Specification \n
- * USBIF Audio Class Terminal Types Specification \n
- * USBIF Audio Data Formats Specification</td>
+ * <td>USBIF Audio 1.0 Class Specification \n
+ * USBIF Audio 1.0 Class Terminal Types Specification \n
+ * USBIF Audio 1.0 Data Formats Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
@@ -47,7 +47,7 @@
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Input device using the
- * basic USB Audio drivers in all modern OSes (i.e. no special drivers
+ * basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
* required).
*
* On start-up the system will automatically enumerate and function
diff --git a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
index f92c91ac2..caf3b484f 100644
--- a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
+++ b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
@@ -33,9 +33,9 @@
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
- * <td>USBIF Audio Class Specification \n
- * USBIF Audio Class Terminal Types Specification \n
- * USBIF Audio Data Formats Specification</td>
+ * <td>USBIF Audio 1.0 Class Specification \n
+ * USBIF Audio 1.0 Class Terminal Types Specification \n
+ * USBIF Audio 1.0 Data Formats Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
@@ -47,7 +47,7 @@
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Output device using the
- * basic USB Audio drivers in all modern OSes (i.e. no special drivers
+ * basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
* required).
*
* On start-up the system will automatically enumerate and function
diff --git a/Demos/Device/LowLevel/AudioInput/AudioInput.txt b/Demos/Device/LowLevel/AudioInput/AudioInput.txt
index 149f8360a..55204a992 100644
--- a/Demos/Device/LowLevel/AudioInput/AudioInput.txt
+++ b/Demos/Device/LowLevel/AudioInput/AudioInput.txt
@@ -33,9 +33,9 @@
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
- * <td>USBIF Audio Class Specification \n
- * USBIF Audio Class Terminal Types Specification \n
- * USBIF Audio Data Formats Specification</td>
+ * <td>USBIF Audio 1.0 Class Specification \n
+ * USBIF Audio 1.0 Class Terminal Types Specification \n
+ * USBIF Audio 1.0 Data Formats Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
@@ -47,7 +47,7 @@
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Input device using the
- * basic USB Audio drivers in all modern OSes (i.e. no special drivers
+ * basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
* required).
*
* On start-up the system will automatically enumerate and function
diff --git a/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt b/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
index f92c91ac2..caf3b484f 100644
--- a/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
+++ b/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
@@ -33,9 +33,9 @@
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
- * <td>USBIF Audio Class Specification \n
- * USBIF Audio Class Terminal Types Specification \n
- * USBIF Audio Data Formats Specification</td>
+ * <td>USBIF Audio 1.0 Class Specification \n
+ * USBIF Audio 1.0 Class Terminal Types Specification \n
+ * USBIF Audio 1.0 Data Formats Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
@@ -47,7 +47,7 @@
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Output device using the
- * basic USB Audio drivers in all modern OSes (i.e. no special drivers
+ * basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
* required).
*
* On start-up the system will automatically enumerate and function
diff --git a/LUFA/Drivers/USB/Class/Audio.h b/LUFA/Drivers/USB/Class/Audio.h
index 1efbaab52..a482dfdc5 100644
--- a/LUFA/Drivers/USB/Class/Audio.h
+++ b/LUFA/Drivers/USB/Class/Audio.h
@@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
- * Audio Class Driver module. This module contains an internal implementation of the USB Audio Class, for Device
+ * Audio Class Driver module. This module contains an internal implementation of the USB Audio 1.0 Class, for Device
* USB mode only. User applications can use this class driver instead of implementing the Audio class manually via
* the low-level LUFA APIs.
*
diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h
index eb2e95b65..99bdb3659 100644
--- a/LUFA/Drivers/USB/Class/Common/Audio.h
+++ b/LUFA/Drivers/USB/Class/Common/Audio.h
@@ -29,9 +29,9 @@
*/
/** \file
- * \brief Common definitions and declarations for the library USB Audio Class driver.
+ * \brief Common definitions and declarations for the library USB Audio 1.0 Class driver.
*
- * Common definitions and declarations for the library USB Audio Class driver.
+ * Common definitions and declarations 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.
@@ -42,7 +42,7 @@
*
* \section Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
- * Audio Class.
+ * Audio 1.0 Class.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index 7fdd8aa1d..caf1fdc68 100644
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -29,9 +29,9 @@
*/
/** \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.
@@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \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.
*
* @{
*/
--
GitLab