tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/AudioInput/AudioInput.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 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 Input 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 as a
  54  *  USB microphone. By default, the demo will produce a square wave test tone
  55  *  when the board button is pressed. If USE_TEST_TONE is not defined in the
  56  *  project makefile, incoming audio from the ADC channel 1 will be sampled
  57  *  and sent to the host computer instead.
  58  *
  59  *  When in microphone mode, connect a microphone to the ADC channel 2.
  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>MIC_IN_ADC_CHANNEL</td>
  76  *    <td>AppConfig.h</td>
  77  *    <td>Sets the ADC channel used by the demo for the input audio samples from an attached microphone.</td>
  78  *   </tr>
  79  *   <tr>
  80  *    <td>USE_TEST_TONE</td>
  81  *    <td>AppConfig.h</td>
  82  *    <td>When defined, this alters the demo to produce a square wave test tone when the first board button is pressed
  83  *        instead of sampling the board microphone.</td>
  84  *   </tr>
  85  *   <tr>
  86  *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
  87  *    <td>AppConfig.h</td>
  88  *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
  89  *   </tr>
  90  *  </table>
  91  */
  92