Remove old OTG demo directory with useless TestApp demo. Add new DualRole directory...

[pub/lufa.git] / Demos / DualRole / ClassDriver / MouseHostDevice / MouseHostDevice.txt

diff --git a/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt b/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt
new file mode 100644 (file)
index 0000000..db8695c
--- /dev/null
+++ b/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt
@@ -0,0 +1,80 @@
+/** \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 Mouse Host/Device Dual Role Demo\r
+ *\r
+ *  \section SSec_Compat Demo Compatibility:\r
+ *\r
+ *  The following table indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - AT90USB1287\r
+ *  - AT90USB647\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/Device</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
+ *  Mouse host/device dual role demonstration application. This gives a simple\r
+ *  reference application for implementing a dual role USB Mouse, for USB mice\r
+ *  using the standard mouse boot protocol HID profile.\r
+ *  \r
+ *  <b>When in host mode:</b>\r
+ *  Mouse movement and button presses are displayed on the board LEDs,\r
+ *  as well as printed out the serial terminal as formatted dY, dY and\r
+ *  button status information.\r
+ *  \r
+ *  This uses a naive method where the mouse 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
+ *  MouseHostWithParser Host demo application.\r
+ *  \r
+ *  Currently only single interface mice are supported.        \r
+ *\r
+ *  <b>When in device mode:</b>\r
+ *  Upon enumeration the system will automatically enumerate and function\r
+ *  as a mouse when the USB connection to a host is present. To use\r
+ *  the mouse, move the joystick to move the pointer, and push the\r
+ *  joystick inwards to simulate a left-button click. The HWB serves as\r
+ *  the right mouse button.\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