Demos/MassStorage/MassStorage.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 Device Demo
   8  *
   9  *  Dual LUN Mass Storage demonstration application. This gives a simple
  10  *  reference application for implementing a multiple LUN USB Mass Storage
  11  *  device using the basic USB UFI drivers in all modern OSes (i.e. no
  12  *  special drivers required).
  13  *
  14  *  On startup the system will automatically enumerate and function as an
  15  *  external mass storage device with two LUNs (seperate disks) which may
  16  *  be formatted and used in the same manner as commercial USB Mass Storage
  17  *  devices.
  18  *
  19  *  You will need to format the mass storage drives upon first run of this
  20  *  demonstration - as the device acts only as a data block transport between
  21  *  the host and the storage media, it does not matter what file system is used,
  22  *  as the data interpretation is performed by the host and not the USB device.
  23  *
  24  *  This demo is not restricted to only two LUNs; by changing the TOTAL_LUNS
  25  *  value in MassStorageDualLUN.h, any number of LUNs can be used (from 1 to
  26  *  255), with each LUN being allocated an equal portion of the available
  27  *  Dataflash memory.
  28  *
  29  *  <table>
  30  *   <tr>
  31  *    <td><b>USB Mode:</b></td>
  32  *    <td>Device</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>USB Class:</b></td>
  36  *    <td>Mass Storage Device</td>
  37  *   </tr>
  38  *   <tr>
  39  *    <td><b>USB Subclass:</b></td>
  40  *    <td>Bulk-Only Transport</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>Relevant Standards:</b></td>
  44  *    <td>USBIF Mass Storage Standard</td>
  45  *    <td>USB Bulk-Only Transport Standard</td>
  46  *    <td>SCSI Primary Commands Specification</td>
  47  *    <td>SCSI Block Commands Specification</td>
  48  *   </tr>
  49  *   <tr>
  50  *    <td><b>Usable Speeds:</b></td>
  51  *    <td>Full Speed Mode</td>
  52  *   </tr>
  53  *  </table>
  54  */