diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-01 07:21:45 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-01 07:21:45 +0000 |
| commit | 6198289b388e4122afe4913f899b37a8e7cd8af4 (patch) | |
| tree | 178377f080f369a8b0bee80f1520f7ac087d0b84 /Demos/Host/GenericHIDHost/GenericHIDHost.txt | |
| parent | 74496a947eef42b416a8a0cb11b7415ac6fa103b (diff) | |
| download | lufa-6198289b388e4122afe4913f899b37a8e7cd8af4.tar.gz lufa-6198289b388e4122afe4913f899b37a8e7cd8af4.tar.bz2 lufa-6198289b388e4122afe4913f899b37a8e7cd8af4.zip | |
Added new GenericHIDHost demo.
Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use.
Diffstat (limited to 'Demos/Host/GenericHIDHost/GenericHIDHost.txt')
| -rw-r--r-- | Demos/Host/GenericHIDHost/GenericHIDHost.txt | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/Demos/Host/GenericHIDHost/GenericHIDHost.txt b/Demos/Host/GenericHIDHost/GenericHIDHost.txt new file mode 100644 index 000000000..0b70bfa28 --- /dev/null +++ b/Demos/Host/GenericHIDHost/GenericHIDHost.txt @@ -0,0 +1,62 @@ +/** \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 Generic HID 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:
+ *
+ * Generic HID host demonstration application. This gives a simple reference
+ * application for implementing a Genric HID USB host, for any device implementing
+ * the HID profile.
+ *
+ * Received reports from the attached device are printed to the serial port.
+ *
+ * \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_DATA_ENDPOINT</td>
+ * <td>Makefile CDEFS</td>
+ * <td>When defined, this causes the demo to enable interrupts for the data IN pipe,
+ * which services reports from the device. If not defined, the data pipe is
+ * serviced via polling using the task scheduler.</td>
+ * </tr>
+ * </table>
+ */
\ No newline at end of file |