diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-09 04:30:12 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-09 04:30:12 +0000 |
| commit | 0323e13b39a8a00ede4a3242bddfc6d8343acdaa (patch) | |
| tree | 1fdab18e3ae65a2b90eb496eca46f4cad76f2647 /Demos/Host/ClassDriver/MouseHost/MouseHost.txt | |
| parent | 34f6e0dd33230441b8a91130467b3164e343853e (diff) | |
| download | lufa-0323e13b39a8a00ede4a3242bddfc6d8343acdaa.tar.gz lufa-0323e13b39a8a00ede4a3242bddfc6d8343acdaa.tar.bz2 lufa-0323e13b39a8a00ede4a3242bddfc6d8343acdaa.zip | |
Copy over schedulerless host demos to ClassDrivers directory, for later modification to new Host mode USB class drivers.
Diffstat (limited to 'Demos/Host/ClassDriver/MouseHost/MouseHost.txt')
| -rw-r--r-- | Demos/Host/ClassDriver/MouseHost/MouseHost.txt | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/Demos/Host/ClassDriver/MouseHost/MouseHost.txt b/Demos/Host/ClassDriver/MouseHost/MouseHost.txt new file mode 100644 index 000000000..3838a7011 --- /dev/null +++ b/Demos/Host/ClassDriver/MouseHost/MouseHost.txt @@ -0,0 +1,65 @@ +/** \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 Mouse Host Demo
+ *
+ * \section SSec_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>Host</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Human Interface Device (HID)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF HID Specification, USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Mouse host demonstration application. This gives a simple reference
+ * application for implementing a USB Mouse host, for USB mice using
+ * the standard mouse HID profile.
+ *
+ * Mouse movement and button presses are displayed on the board LEDs,
+ * as well as printed out the serial terminal as formatted dY, dY and
+ * button status information.
+ *
+ * This uses a naive method where the mouse is set to Boot Protocol mode, so
+ * that the report structure is fixed and known. A better implementation
+ * uses the HID report parser for correct report data processing across
+ * all compatible mice with advanced characteristics, as shown in the
+ * MouseHostWithParser demo application.
+ *
+ * Currently only single interface mice are supported.
+ *
+ * \section SSec_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>
+ */
|