Copy over schedulerless host demos to ClassDrivers directory, for later modification...

[pub/lufa.git] / Demos / Host / ClassDriver / KeyboardHost / KeyboardHost.txt

diff --git a/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt
new file mode 100644 (file)
index 0000000..a3d5f71
--- /dev/null
+++ b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt
@@ -0,0 +1,64 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
+ \r
+/** \mainpage Keyboard Host Demo\r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Host</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Human Interface Device (HID)</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>N/A</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Low Speed Mode, Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  Keyboard host demonstration application. This gives a simple reference\r
+ *  application for implementing a USB keyboard, for USB keyboards using\r
+ *  the standard keyboard HID profile.\r
+ *  \r
+ *  Pressed alpha-numeric, enter or space key is transmitted through the serial\r
+ *  USART at serial settings 9600, 8, N, 1.\r
+ *  \r
+ *  This uses a naive method where the keyboard is set to Boot Protocol mode, so\r
+ *  that the report structure is fixed and known. A better implementation\r
+ *  uses the HID report parser for correct report data processing across\r
+ *  all compatible mice with advanced characteristics, as shown in the\r
+ *  KeyboardHostWithParser demo application.\r
+ *  \r
+ *  Currently only single interface keyboards are supported.\r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td>\r
+ *     None\r
+ *    </td>\r
+ *   </tr>\r
+ *  </table>\r
+ */\r