Demos/MouseViaInt/MouseViaInt.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 Partially Interrupt Driven Mouse Device Demo
   8  *
   9  *  Mouse demonstration application, using endpoint interrupts for the
  10  *  exchange of data to the USB host. This gives a simple reference
  11  *  application for implementing a USB Mouse using the basic USB HID
  12  *  drivers in all modern OSes (i.e. no special drivers required). It is
  13  *  boot protocol compatible, and thus works under compatible BIOS as if
  14  *  it was a native mouse (e.g. PS/2).
  15  *
  16  *  On startup the system will automatically enumerate and function
  17  *  as a mouse when the USB connection to a host is present. To use
  18  *  the mouse, move the joystick to move the pointer, and push the
  19  *  joystick inwards to simulate a left-button click. The HWB serves as
  20  *  the right mouse button.
  21  *
  22  *  <table>
  23  *   <tr>
  24  *    <td><b>USB Mode:</b></td>
  25  *    <td>Device</td>
  26  *   </tr>
  27  *   <tr>
  28  *    <td><b>USB Class:</b></td>
  29  *    <td>Human Interface Device (HID)</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>N/A</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  38  *   </tr>
  39  *   <tr>
  40  *    <td><b>Usable Speeds:</b></td>
  41  *    <td>Low Speed Mode, Full Speed Mode</td>
  42  *   </tr>
  43  *  </table>
  44  */