diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-05 07:16:33 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-05 07:16:33 +0000 |
| commit | b9b03aadb219d06fbad9d110e508db93e45461af (patch) | |
| tree | 95a91a07c07953009e71613b320c20d1954be3fc /Demos/Device/ClassDriver/GenericHID/GenericHID.txt | |
| parent | 6a7c298c0f7119e44e18de15d714cd8b938e3bef (diff) | |
| download | lufa-b9b03aadb219d06fbad9d110e508db93e45461af.tar.gz lufa-b9b03aadb219d06fbad9d110e508db93e45461af.tar.bz2 lufa-b9b03aadb219d06fbad9d110e508db93e45461af.zip | |
Move new Class Driver powered demos to a new ClassDriver subdirectory, re-add old low level demos to a LowLevel subdirectory.
Diffstat (limited to 'Demos/Device/ClassDriver/GenericHID/GenericHID.txt')
| -rw-r--r-- | Demos/Device/ClassDriver/GenericHID/GenericHID.txt | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/Demos/Device/ClassDriver/GenericHID/GenericHID.txt b/Demos/Device/ClassDriver/GenericHID/GenericHID.txt new file mode 100644 index 000000000..a40b78b1f --- /dev/null +++ b/Demos/Device/ClassDriver/GenericHID/GenericHID.txt @@ -0,0 +1,64 @@ +/** \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 Device
+ *
+ * \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>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>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Generic HID device demonstration application. This gives a simple reference application
+ * for implementing a generic HID device, using the basic USB HID drivers in all modern
+ * OSes (i.e. no special drivers required). It accepts and sends up to 255 byte reports to
+ * and from a USB Host, and by default transmits the last sent report back to the host.
+ *
+ * On start-up the system will automatically enumerate and function as a vendor HID device.
+ * When controlled by a custom HID class application, reports can be sent and received by
+ * both the standard data endpoint and control request methods defined in the HID specification.
+ *
+ * \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>GENERIC_REPORT_SIZE</td>
+ * <td>Descriptors.h</td>
+ * <td>This token defines the size of the device reports, both sent and received. The value must be an
+ * integer ranging from 1 to 255.</td>
+ * </tr>
+ * </table>
+ */
|