diff options
| author |  tmk <hasu@tmk-kbd.com> | 2015-05-13 11:13:10 +0900 |
|---|---|---|
| committer | tmk <hasu@tmk-kbd.com> | 2015-05-13 11:13:10 +0900 |
| commit | f6d56675f9f981c5464f0ca7a1fbb0162154e8c5 (patch) | |
| tree | 57c9d4b3808a26116ae0ee7956fc00b84841aa2b /protocol/lufa/LUFA-git/Demos/Device/ClassDriver/GenericHID/GenericHID.txt | |
| parent | 4d116a04e94cf0d19317d5b44e4fa9f34a3e5594 (diff) | |
| download | qmk_firmware-f6d56675f9f981c5464f0ca7a1fbb0162154e8c5.tar.gz | |
dc0e46e Rename LUFA to LUFA-git
3bfa7fa Remove LUFA-120730
215b764 Merge commit 'afa0f22a9299686fd88f58ce09c5b521ac917e8f' as 'protocol/lufa/LUFA'
afa0f22 Squashed 'protocol/lufa/LUFA/' content from commit def7fca
c0c42fa Remove submodule of LUFA
30f897d Merge commit '87ced33feb74e79c3281dda36eb6d6d153399b41' as 'protocol/usb_hid/USB_Host_Shield_2.0'
87ced33 Squashed 'protocol/usb_hid/USB_Host_Shield_2.0/' content from commit aab4a69
14f6d49 Remove submodule of USB_Host_Shield_2.0
git-subtree-dir: tmk_core
git-subtree-split: dc0e46eaa4367d4e218f8816e3c117895820f07c
Diffstat (limited to 'protocol/lufa/LUFA-git/Demos/Device/ClassDriver/GenericHID/GenericHID.txt')
| -rw-r--r-- | protocol/lufa/LUFA-git/Demos/Device/ClassDriver/GenericHID/GenericHID.txt | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/GenericHID/GenericHID.txt b/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/GenericHID/GenericHID.txt new file mode 100644 index 000000000..649fc62ce --- /dev/null +++ b/protocol/lufa/LUFA-git/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 (ATXMEGAxxxBxU) + * \li Series C XMEGA AVRs (ATXMEGAxxxCxU) + * + * \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> + */ + |