Blame view

Hardware/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.txt 1.6 KB
ca85a266   gperson   le vrai commit, c...
1
2
3
4
5
6
  /** \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.
   */
  
8b438d9c   root   Harmonisation ava...
7
  /** \mainpage Generic HID Host Demo
ca85a266   gperson   le vrai commit, c...
8
9
10
11
12
13
   *
   *  \section Sec_Compat Demo Compatibility:
   *
   *  The following list indicates what microcontrollers are compatible with this demo.
   *
   *  \li Series 7 USB AVRs (AT90USBxxx7)
ca85a266   gperson   le vrai commit, c...
14
15
16
17
18
19
20
21
   *
   *  \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>
8b438d9c   root   Harmonisation ava...
22
   *    <td>Host</td>
ca85a266   gperson   le vrai commit, c...
23
24
25
26
27
28
29
   *   </tr>
   *   <tr>
   *    <td><b>USB Class:</b></td>
   *    <td>Human Interface Device (HID)</td>
   *   </tr>
   *   <tr>
   *    <td><b>USB Subclass:</b></td>
8b438d9c   root   Harmonisation ava...
30
   *    <td>N/A</td>
ca85a266   gperson   le vrai commit, c...
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
   *   </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:
   *
8b438d9c   root   Harmonisation ava...
46
47
48
   *  Generic HID host demonstration application. This gives a simple reference
   *  application for implementing a Generic HID USB host, for any device implementing
   *  the HID profile.
ca85a266   gperson   le vrai commit, c...
49
   *
8b438d9c   root   Harmonisation ava...
50
   *  Received reports from the attached device are printed to the serial port.
ca85a266   gperson   le vrai commit, c...
51
52
53
54
55
56
57
58
59
60
61
62
63
   *
   *  \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>
   *    <td>
   *     None
   *    </td>
   *   </tr>
   *  </table>
   */