]> git.gir.st - tmk_keyboard.git/blob - tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
Merge commit '20b787fc1284176834cbe7ca2134e4b36bec5828'
[tmk_keyboard.git] / tmk_core / protocol / lufa / LUFA-git / Demos / Device / ClassDriver / AudioOutput / AudioOutput.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 Output Device 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 * \li Series 6 USB AVRs (AT90USBxxx6)
15 * \li Series 4 USB AVRs (ATMEGAxxU4)
16 *
17 * \section Sec_Info USB Information:
18 *
19 * The following table gives a rundown of the USB utilization of this demo.
20 *
21 * <table>
22 * <tr>
23 * <td><b>USB Mode:</b></td>
24 * <td>Device</td>
25 * </tr>
26 * <tr>
27 * <td><b>USB Class:</b></td>
28 * <td>Audio Class</td>
29 * </tr>
30 * <tr>
31 * <td><b>USB Subclass:</b></td>
32 * <td>Standard Audio Device</td>
33 * </tr>
34 * <tr>
35 * <td><b>Relevant Standards:</b></td>
36 * <td>USBIF Audio 1.0 Class Specification \n
37 * USBIF Audio 1.0 Class Terminal Types Specification \n
38 * USBIF Audio 1.0 Data Formats Specification</td>
39 * </tr>
40 * <tr>
41 * <td><b>Supported USB Speeds:</b></td>
42 * <td>Full Speed Mode</td>
43 * </tr>
44 * </table>
45 *
46 * \section Sec_Description Project Description:
47 *
48 * Audio demonstration application. This gives a simple reference
49 * application for implementing a USB Audio Output device using the
50 * basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
51 * required).
52 *
53 * On start-up the system will automatically enumerate and function
54 * as a USB speaker. Outgoing audio will output in 8-bit PWM onto
55 * the timer 3 output compare channel A for AUDIO_OUT_MONO mode, on
56 * timer 3 channels A and B for AUDIO_OUT_STEREO and on PORTC as a signed
57 * mono sample for AUDIO_OUT_PORTC. Audio output will also be indicated on
58 * the board LEDs in all modes. Decouple audio outputs with a capacitor and
59 * attach to a speaker to hear the audio.
60 *
61 * Under Windows, if a driver request dialogue pops up, select the option
62 * to automatically install the appropriate drivers.
63 *
64 * \section Sec_Options Project Options
65 *
66 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
67 *
68 * <table>
69 * <tr>
70 * <th><b>Define Name:</b></th>
71 * <th><b>Location:</b></th>
72 * <th><b>Description:</b></th>
73 * </tr>
74 * <tr>
75 * <td>AUDIO_OUT_STEREO</td>
76 * <td>AppConfig.h</td>
77 * <td>When defined, this outputs the audio samples in stereo to the timer output pins of the microcontroller.</td>
78 * </tr>
79 * <tr>
80 * <td>AUDIO_OUT_MONO</td>
81 * <td>AppConfig.h</td>
82 * <td>When defined, this outputs the audio samples in mono to the timer output pin of the microcontroller.</td>
83 * </tr>
84 * <tr>
85 * <td>AUDIO_OUT_PORTC</td>
86 * <td>AppConfig.h</td>
87 * <td>When defined, this outputs the audio samples in mono to port C of the microcontroller, for connection to an
88 * external DAC.</td>
89 * </tr>
90 * </table>
91 */
92
Imprint / Impressum