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