add audio example readme

timvideos · Jan 7, 2020 · 0a46528 · 0a46528
1 parent 3b409b0
commit 0a46528
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 7 deletions.
diff --git a/examples/audio/README.md b/examples/audio/README.md
@@ -0,0 +1,16 @@
+# USB audio example
+
+This is an example application implementing USB audio class (UAC) (see: [Universal Serial Bus Device Class Definition for Audio Devices](https://usb.org/)).
+
+Device descriptor uses class/subclass/protocol compatible with Interface Association Descriptors
+(see: [USB Interface Association Descriptor Device Class Code and Use Model, 1.0](https://www.usb.org/sites/default/files/iadclasscode_r10.pdf)).
+
+There are two interfaces:
+
+* Audio control interface: 0 endpoints - no need for interrupt endpoint
+
+* Audio streaming interface (with alternate settings 0 and 1)
+    * alternate setting 0: no endpoints, host can use it to disable audio in case of bandwidth problems
+    * alternate setting 1: single isochronous endpoint
+
+The application provides simple audio topology consisting of a single input terminal and single output terminal.
diff --git a/examples/common/uac.d b/examples/common/uac.d