Demos/Host/LowLevel/MassStorageHost/MassStorageHost.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 Mass Storage Host Demo
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following table indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - AT90USB1287
  14  *  - AT90USB1286
  15  *
  16  *  \section SSec_Info USB Information:
  17  *
  18  *  The following table gives a rundown of the USB utilization of this demo.
  19  *
  20  *  <table>
  21  *   <tr>
  22  *    <td><b>USB Mode:</b></td>
  23  *    <td>Host</td>
  24  *   </tr>
  25  *   <tr>
  26  *    <td><b>USB Class:</b></td>
  27  *    <td>Mass Storage Device</td>
  28  *   </tr>
  29  *   <tr>
  30  *    <td><b>USB Subclass:</b></td>
  31  *    <td>Bulk Only</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>Relevant Standards:</b></td>
  35  *    <td>USBIF Mass Storage Standard</td>
  36  *    <td>USB Bulk-Only Transport Standard</td>
  37  *    <td>SCSI Primary Commands Specification</td>
  38  *    <td>SCSI Block Commands Specification</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Usable Speeds:</b></td>
  42  *    <td>Full Speed Mode</td>
  43  *   </tr>
  44  *  </table>
  45  *
  46  *  \section SSec_Description Project Description:
  47  *
  48  *  Mass Storage host demonstration application. This gives a simple reference
  49  *  application for implementing a USB Mass Storage host, for USB storage devices
  50  *  using the standard Mass Storage USB profile.
  51  *
  52  *  The first 512 bytes (boot sector) of an attached disk's memory will be dumped
  53  *  out of the serial port in HEX and ASCII form when it is attached to the AT90USB1287
  54  *  AVR. The device will then wait for HWB to be pressed, whereupon the entire ASCII contents
  55  *  of the disk will be dumped to the serial port.
  56  *
  57  *  \section SSec_Options Project Options
  58  *
  59  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  60  *
  61  *  <table>
  62  *   <tr>
  63  *    <td>
  64  *     None
  65  *    </td>
  66  *   </tr>
  67  *  </table>
  68  */