]> git.gir.st - tmk_keyboard.git/blob - tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/AudioInputHost/AudioInputHost.txt
Merge commit '20b787fc1284176834cbe7ca2134e4b36bec5828'
[tmk_keyboard.git] / tmk_core / protocol / lufa / LUFA-git / Demos / Host / ClassDriver / AudioInputHost / AudioInputHost.txt
1 /** \file
2 *
3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
5 */
6
7 /** \mainpage Audio Input Host Demo
8 *
9 * \section Sec_Compat Demo Compatibility:
10 *
11 * The following list indicates what microcontrollers are compatible with this demo.
12 *
13 * \li Series 7 USB AVRs (AT90USBxxx7)
14 *
15 * \section Sec_Info USB Information:
16 *
17 * The following table gives a rundown of the USB utilization of this demo.
18 *
19 * <table>
20 * <tr>
21 * <td><b>USB Mode:</b></td>
22 * <td>Host</td>
23 * </tr>
24 * <tr>
25 * <td><b>USB Class:</b></td>
26 * <td>Audio Class</td>
27 * </tr>
28 * <tr>
29 * <td><b>USB Subclass:</b></td>
30 * <td>Standard Audio Device</td>
31 * </tr>
32 * <tr>
33 * <td><b>Relevant Standards:</b></td>
34 * <td>USBIF Audio 1.0 Class Specification \n
35 * USBIF Audio 1.0 Class Terminal Types Specification \n
36 * USBIF Audio 1.0 Data Formats Specification</td>
37 * </tr>
38 * <tr>
39 * <td><b>Supported USB Speeds:</b></td>
40 * <td>Full Speed Mode</td>
41 * </tr>
42 * </table>
43 *
44 * \section Sec_Description Project Description:
45 *
46 * Audio Input host demonstration application. This gives a simple reference
47 * application for implementing a USB Audio host, for USB Audio devices using
48 * the USB Audio 1.0 class profile.
49 *
50 * Incoming audio will output in 8-bit PWM onto the timer 3 output compare
51 * channel A, and will also be indicated on the board LEDs. Decouple the PWM
52 * output with a capacitor and attach to a speaker to hear the audio.
53 *
54 * \section Sec_Options Project Options
55 *
56 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
57 *
58 * <table>
59 * <tr>
60 * <td>
61 * None
62 * </td>
63 * </tr>
64 * </table>
65 */
66
Imprint / Impressum