diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-19 14:16:12 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-19 14:16:12 +0000 |
| commit | 88051e78a281f5776538558aec113ff2b66e056c (patch) | |
| tree | cfdd65c067c9c660b7e3d3f6edcefe25596f5f6f /Demos/Mouse/Mouse.txt | |
| parent | 48400df13c7f9f4f0fd8e7f841d49f9502557cb1 (diff) | |
| download | lufa-88051e78a281f5776538558aec113ff2b66e056c.tar.gz lufa-88051e78a281f5776538558aec113ff2b66e056c.tar.bz2 lufa-88051e78a281f5776538558aec113ff2b66e056c.zip | |
Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.
Corrections to Keyboard demo.
Removed AVRISP_Programmer project due to code quality concerns.
Diffstat (limited to 'Demos/Mouse/Mouse.txt')
| -rw-r--r-- | Demos/Mouse/Mouse.txt | 54 |
1 files changed, 43 insertions, 11 deletions
diff --git a/Demos/Mouse/Mouse.txt b/Demos/Mouse/Mouse.txt index 7b7360f0e..6764275ce 100644 --- a/Demos/Mouse/Mouse.txt +++ b/Demos/Mouse/Mouse.txt @@ -6,17 +6,9 @@ /** \mainpage Mouse Device Demo
*
- * Mouse demonstration application. 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.
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -40,4 +32,44 @@ * <td>Low Speed Mode, Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Mouse demonstration application. 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.
+ *
+ * \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><b>Define Name:</b></td>
+ * <td><b>Location:</b></td>
+ * <td><b>Description:</b></td>
+ * </tr>
+ * <tr>
+ * <td>INTERRUPT_CONTROL_ENDPOINT</td>
+ * <td>Makefile CDEFS</td>
+ * <td>When defined, this causes the demo to enable interrupts for the control endpoint,
+ * which services control requests from the host. If not defined, the control endpoint
+ * is serviced via polling using the task scheduler.</td>
+ * </tr>
+ * <tr>
+ * <td>INTERRUPT_DATA_ENDPOINT</td>
+ * <td>Makefile CDEFS</td>
+ * <td>When defined, this causes the demo to enable interrupts for the data endpoint,
+ * which services outgoing mouse button and movement reports to the host. If not defined,
+ * the data endpoint is serviced via polling using the task scheduler.</td>
+ * </tr>
+ * </table>
*/
\ No newline at end of file |