]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Demos/Device/LowLevel/GenericHID/GenericHID.txt
Squashed 'tmk_core/' changes from d5c5ac6..8da1898
[tmk_keyboard.git] / protocol / lufa / LUFA-git / Demos / Device / LowLevel / GenericHID / GenericHID.txt
1 /** \file
2 *
3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
5 */
6
7 /** \mainpage Generic HID Device
8 *
9 * \section Sec_Compat Demo Compatibility:
10 *
11 * The following list indicates what microcontrollers are compatible with this demo.
12 *
13 * \li Series 7 USB AVRs (AT90USBxxx7)
14 * \li Series 6 USB AVRs (AT90USBxxx6)
15 * \li Series 4 USB AVRs (ATMEGAxxU4)
16 * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
17 * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
18 * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
19 * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
20 *
21 * \section Sec_Info USB Information:
22 *
23 * The following table gives a rundown of the USB utilization of this demo.
24 *
25 * <table>
26 * <tr>
27 * <td><b>USB Mode:</b></td>
28 * <td>Device</td>
29 * </tr>
30 * <tr>
31 * <td><b>USB Class:</b></td>
32 * <td>Human Interface Device (HID)</td>
33 * </tr>
34 * <tr>
35 * <td><b>USB Subclass:</b></td>
36 * <td>N/A</td>
37 * </tr>
38 * <tr>
39 * <td><b>Relevant Standards:</b></td>
40 * <td>USBIF HID Specification \n
41 * USBIF HID Usage Tables</td>
42 * </tr>
43 * <tr>
44 * <td><b>Supported USB Speeds:</b></td>
45 * <td>Low Speed Mode \n
46 * Full Speed Mode</td>
47 * </tr>
48 * </table>
49 *
50 * \section Sec_Description Project Description:
51 *
52 * Generic HID device demonstration application. This gives a simple reference application
53 * for implementing a generic HID device, using the basic USB HID drivers in all modern
54 * OSes (i.e. no special drivers required). By default it accepts and sends up to 8 byte reports
55 * to and from a USB Host, and transmits the last sent report back to the host.
56 *
57 * On start-up the system will automatically enumerate and function as a vendor HID device.
58 * When controlled by a custom HID class application, reports can be sent and received by
59 * both the standard data endpoint and control request methods defined in the HID specification.
60 *
61 * \section Sec_Options Project Options
62 *
63 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
64 *
65 * <table>
66 * <tr>
67 * <th><b>Define Name:</b></th>
68 * <th><b>Location:</b></th>
69 * <th><b>Description:</b></th>
70 * </tr>
71 * <tr>
72 * <td>GENERIC_REPORT_SIZE</td>
73 * <td>AppConfig.h</td>
74 * <td>This token defines the size of the device reports, both sent and received (including report ID byte). The value
75 * must be an integer ranging from 1 to 255.</td>
76 * </tr>
77 * </table>
78 */
79
Imprint / Impressum