Demos/Device/ClassDriver/DualMIDI/DualMIDI.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 MIDI Dual 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  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  17  *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  18  *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
  19  *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
  20  *
  21  *  \section Sec_Info USB Information:
  22  *
  23  *  The following table gives a rundown of the USB utilization of this demo.
  24  *
  25  *  <table>
  26  *   <tr>
  27  *    <td><b>USB Mode:</b></td>
  28  *    <td>Device</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Class:</b></td>
  32  *    <td>Audio Class</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>USB Subclass:</b></td>
  36  *    <td>Standard Audio Device</td>
  37  *   </tr>
  38  *   <tr>
  39  *    <td><b>Relevant Standards:</b></td>
  40  *    <td>USBIF Audio Class Specification \n
  41  *        USB-MIDI Audio Class Extension Specification \n
  42  *        General MIDI Specification</td>
  43  *   </tr>
  44  *   <tr>
  45  *    <td><b>Supported USB Speeds:</b></td>
  46  *    <td>Full Speed Mode</td>
  47  *   </tr>
  48  *  </table>
  49  *
  50  *  \section Sec_Description Project Description:
  51  *
  52  *  Dual MIDI demonstration application. This gives a simple reference
  53  *  application for implementing the USB-MIDI class in USB devices.
  54  *  It is built upon the USB Audio class.
  55  *
  56  *  Joystick movements are translated into note on/off messages and
  57  *  are sent to the host PC as MIDI streams which can be read by any
  58  *  MIDI program supporting MIDI IN devices.
  59  *
  60  *  If the HWB is not pressed, the first virtual MIDI cable to the host is
  61  *  used. If the HWB is pressed, then the second virtual cable is selected.
  62  *
  63  *  This device implements MIDI-THRU mode, with the IN MIDI data being
  64  *  generated by the device itself. OUT MIDI data is discarded.
  65  *
  66  *  \section Sec_Options Project Options
  67  *
  68  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  69  *
  70  *  <table>
  71  *   <tr>
  72  *    <td>
  73  *     None
  74  *    </td>
  75  *   </tr>
  76  *  </table>
  77  */
  78