diff options
| author | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2009-03-04 08:03:13 +0000 |
|---|---|---|
| committer | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2009-03-04 08:03:13 +0000 |
| commit | 33fabb1f95f9c3867c97fd927fd4a78091d6bf13 (patch) | |
| tree | 7c8d7f6fb75555874b10577e2937e00a3deec284 /Demos/MouseFullInt/MouseFullInt.txt | |
Updated makefiles to reflect new dfu-ee programming target invocations (supplied by Opendous, Inc.).
Renamed the ATTR_ALWAYSINLINE function attribute macro to ATTR_ALWAYS_INLINE to match the style of the other function attribute macro names.
Added ATTR_ALWAYS_INLINE attribute to several inlined library functions, to ensure they are inlined in all circumstances.
Cleanups to Endpoint.h and Pipe.h. Added better documentation for the endpoint and pipe interrupts.
git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@450 d5102386-fcda-11dd-9fdb-3debd5008f28
Diffstat (limited to 'Demos/MouseFullInt/MouseFullInt.txt')
| -rw-r--r-- | Demos/MouseFullInt/MouseFullInt.txt | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/Demos/MouseFullInt/MouseFullInt.txt b/Demos/MouseFullInt/MouseFullInt.txt new file mode 100644 index 00000000..460a8dd7 --- /dev/null +++ b/Demos/MouseFullInt/MouseFullInt.txt @@ -0,0 +1,44 @@ +/** \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 Fully Interrupt Driven Mouse Device Demo
+ *
+ * Mouse demonstration application, using endpoint interrupts for the
+ * exchange of data to the USB host, and control requests on the control
+ * endpoint. This gives a simple reference application for implementing a
+ * USB Mouse using the basic USB HID drivers in all modern OSes (i.e. no
+ * special drivers required). It is boot protocol compatible, and thus works
+ * under compatible BIOS as if it was a native mouse (e.g. PS/2).
+ *
+ * On startup the system will automatically enumerate and function
+ * as a mouse when the USB connection to a host is present. To use
+ * the mouse, move the joystick to move the pointer, and push the
+ * joystick inwards to simulate a left-button click. The HWB serves as
+ * the right mouse button.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Device</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>
+ */
\ No newline at end of file |