GenericHID.txt 2.32 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/** \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_Compat Demo Compatibility:
 *
 *  The following list indicates what microcontrollers are compatible with this demo.
 *
 *  - Series 7 USB AVRs
 *  - Series 6 USB AVRs
 *  - Series 4 USB AVRs
 *  - Series 2 USB AVRs
 *
 *  \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 \n
 *        USBIF HID Usage Tables</td>
 *   </tr>
 *   <tr>
 *    <td><b>Usable Speeds:</b></td>
 *    <td>Low Speed Mode \n
 *        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). 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 SSec_Options Project Options
 *  
60
 *  The following defines can be found in this demo, which can control the demo behavior when defined, or changed in value.
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 *
 *  <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>
 */