Demos/Keyboard/Keyboard.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 Keyboard Device Demo
   8  *
   9  *  \section SSec_Info USB Information:
  10  *
  11  *  The following table gives a rundown of the USB utilization of this demo.
  12  *
  13  *  <table>
  14  *   <tr>
  15  *    <td><b>USB Mode:</b></td>
  16  *    <td>Device</td>
  17  *   </tr>
  18  *   <tr>
  19  *    <td><b>USB Class:</b></td>
  20  *    <td>Human Interface Device (HID)</td>
  21  *   </tr>
  22  *   <tr>
  23  *    <td><b>USB Subclass:</b></td>
  24  *    <td>N/A</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>Relevant Standards:</b></td>
  28  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>Usable Speeds:</b></td>
  32  *    <td>Low Speed Mode, Full Speed Mode</td>
  33  *   </tr>
  34  *  </table>
  35  *
  36  *  \section SSec_Description Project Description:
  37  *  Keyboard demonstration application. This gives a simple reference application
  38  *  for implementing a USB Keyboard using the basic USB HID drivers in all modern
  39  *  OSes (i.e. no special drivers required). It is boot protocol compatible, and thus
  40  *  works under compatible BIOS as if it was a native keyboard (e.g. PS/2).
  41  *
  42  *  On startup the system will automatically enumerate and function
  43  *  as a keyboard when the USB connection to a host is present. To use
  44  *  the keyboard example, manipulate the joystick to send the letters
  45  *  a, b, c, d and e. See the USB HID documentation for more information
  46  *  on sending keyboard event and keypresses.
  47  *
  48  *  \section SSec_Options Project Options
  49  *
  50  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  51  *
  52  *  <table>
  53  *   <tr>
  54  *    <td><b>Define Name:</b></td>
  55  *    <td><b>Location:</b></td>
  56  *    <td><b>Description:</b></td>
  57  *   </tr>
  58  *   <tr>
  59  *    <td>INTERRUPT_CONTROL_ENDPOINT</td>
  60  *    <td>Makefile CDEFS</td>
  61  *    <td>When defined, this causes the demo to enable interrupts for the control endpoint,
  62  *        which services control requests from the host. If not defined, the control endpoint
  63  *        is serviced via polling using the task scheduler.</td>
  64  *   </tr>
  65  *   <tr>
  66  *    <td>INTERRUPT_DATA_ENDPOINT</td>
  67  *    <td>Makefile CDEFS</td>
  68  *    <td>When defined, this causes the demo to enable interrupts for the data endpoints,
  69  *        which services incomming LED reports and outgoing key status reports to and from the host.
  70  *        If not defined, the data endpoints are serviced via polling using the task scheduler.</td>
  71  *   </tr>
  72  *  </table>
  73  */