Demos/Device/ClassDriver/Mouse/Mouse.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 Mouse 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  *
  38  *  Mouse demonstration application. This gives a simple reference
  39  *  application for implementing a USB Mouse using the basic USB HID
  40  *  drivers in all modern OSes (i.e. no special drivers required). It is
  41  *  boot protocol compatible, and thus works under compatible BIOS as if
  42  *  it was a native mouse (e.g. PS/2).
  43  *
  44  *  On start-up the system will automatically enumerate and function
  45  *  as a mouse when the USB connection to a host is present. To use
  46  *  the mouse, move the joystick to move the pointer, and push the
  47  *  joystick inwards to simulate a left-button click. The HWB serves as
  48  *  the right mouse button.
  49  *
  50  *  \section SSec_Options Project Options
  51  *
  52  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  53  *
  54  *  <table>
  55  *   <tr>
  56  *    <td>
  57  *     None
  58  *    </td>
  59  *   </tr>
  60  *  </table>
  61  */