Merge commit '60b30c036397cb5627fa374bb930794b225daa29' as 'lib/lufa'

[qmk_firmware.git] / lib / lufa / Demos / Device / ClassDriver / MIDI / MIDI.txt

diff --git a/lib/lufa/Demos/Device/ClassDriver/MIDI/MIDI.txt b/lib/lufa/Demos/Device/ClassDriver/MIDI/MIDI.txt
new file mode 100644 (file)
index 0000000..97a92a1
--- /dev/null
+++ b/lib/lufa/Demos/Device/ClassDriver/MIDI/MIDI.txt
@@ -0,0 +1,78 @@
+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+
+/** \mainpage MIDI Input Device Demo
+ *
+ *  \section Sec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 4 USB AVRs (ATMEGAxxU4)
+ *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
+ *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
+ *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
+ *
+ *  \section Sec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Audio Class</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>Standard Audio Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF Audio Class Specification \n
+ *        USB-MIDI Audio Class Extension Specification \n
+ *        General MIDI Specification</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Supported USB Speeds:</b></td>
+ *    <td>Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section Sec_Description Project Description:
+ *
+ *  MIDI demonstration application. This gives a simple reference
+ *  application for implementing the USB-MIDI class in USB devices.
+ *  It is built upon the USB Audio class.
+ *
+ *  Joystick movements are translated into note on/off messages and
+ *  are sent to the host PC as MIDI streams which can be read by any
+ *  MIDI program supporting MIDI IN devices.
+ *
+ *  If the HWB is not pressed, channel 1 (default piano) is used. If
+ *  the HWB is pressed, then channel 10 (default percussion) is selected.
+ *
+ *  This device implements MIDI-THRU mode, with the IN MIDI data being
+ *  generated by the device itself. OUT MIDI data is discarded.
+ *
+ *  \section Sec_Options Project Options
+ *
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td>
+ *     None
+ *    </td>
+ *   </tr>
+ *  </table>
+ */
+