diff options
Diffstat (limited to 'lib/lufa/Demos/Device/ClassDriver/GenericHID/GenericHID.txt')
-rw-r--r-- | lib/lufa/Demos/Device/ClassDriver/GenericHID/GenericHID.txt | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/lib/lufa/Demos/Device/ClassDriver/GenericHID/GenericHID.txt b/lib/lufa/Demos/Device/ClassDriver/GenericHID/GenericHID.txt new file mode 100644 index 000000000..0d780f49d --- /dev/null +++ b/lib/lufa/Demos/Device/ClassDriver/GenericHID/GenericHID.txt @@ -0,0 +1,79 @@ +/** \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 Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * \li Series 6 USB AVRs (AT90USBxxx6) + * \li Series 4 USB AVRs (ATMEGAxxU4) + * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) + * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU) + * \li Series B XMEGA AVRs (ATXMEGAxxxBx) + * \li Series C XMEGA AVRs (ATXMEGAxxxCx) + * + * \section Sec_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 \n + * USBIF HID Usage Tables</td> + * </tr> + * <tr> + * <td><b>Supported USB Speeds:</b></td> + * <td>Low Speed Mode \n + * Full Speed Mode</td> + * </tr> + * </table> + * + * \section Sec_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). By default it accepts and sends up to 8 byte reports + * to and from a USB Host, and 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 Sec_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> + * <th><b>Define Name:</b></th> + * <th><b>Location:</b></th> + * <th><b>Description:</b></th> + * </tr> + * <tr> + * <td>GENERIC_REPORT_SIZE</td> + * <td>AppConfig.h</td> + * <td>This token defines the size of the device reports, both sent and received (including report ID byte). The value + * must be an integer ranging from 1 to 255.</td> + * </tr> + * </table> + */ + |