Demos/Device/ClassDriver/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  *  \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>Mass Storage Device</td>
  21  *   </tr>
  22  *   <tr>
  23  *    <td><b>USB Subclass:</b></td>
  24  *    <td>Bulk-Only Transport</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>Relevant Standards:</b></td>
  28  *    <td>USBIF Mass Storage Standard</td>
  29  *    <td>USB Bulk-Only Transport Standard</td>
  30  *    <td>SCSI Primary Commands Specification</td>
  31  *    <td>SCSI Block Commands Specification</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>Usable Speeds:</b></td>
  35  *    <td>Full Speed Mode</td>
  36  *   </tr>
  37  *  </table>
  38  *
  39  *  \section SSec_Description Project Description:
  40  *
  41  *  Dual LUN Mass Storage demonstration application. This gives a simple
  42  *  reference application for implementing a multiple LUN USB Mass Storage
  43  *  device using the basic USB UFI drivers in all modern OSes (i.e. no
  44  *  special drivers required).
  45  *
  46  *  On start-up the system will automatically enumerate and function as an
  47  *  external mass storage device with two LUNs (separate disks) which may
  48  *  be formatted and used in the same manner as commercial USB Mass Storage
  49  *  devices.
  50  *
  51  *  You will need to format the mass storage drives upon first run of this
  52  *  demonstration - as the device acts only as a data block transport between
  53  *  the host and the storage media, it does not matter what file system is used,
  54  *  as the data interpretation is performed by the host and not the USB device.
  55  *
  56  *  This demo is not restricted to only two LUNs; by changing the TOTAL_LUNS
  57  *  value in MassStorageDualLUN.h, any number of LUNs can be used (from 1 to
  58  *  255), with each LUN being allocated an equal portion of the available
  59  *  Dataflash memory.
  60  *
  61  *  The USB control endpoint is managed entirely by the library using endpoint
  62  *  interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for
  63  *  the host to reset the Mass Storage device state during long transfers without
  64  *  the need for complicated polling logic.
  65  *
  66  *  \section SSec_Options Project Options
  67  *
  68  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  69  *
  70  *  <table>
  71  *   <tr>
  72  *    <td><b>Define Name:</b></td>
  73  *    <td><b>Location:</b></td>
  74  *    <td><b>Description:</b></td>
  75  *   </tr>
  76  *   <tr>
  77  *    <td>TOTAL_LUNS</td>
  78  *    <td>MassStorage.h</td>
  79  *    <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive
  80  *        - this can be set to any positive non-zero amount.</td>
  81  *   </tr>
  82  *  </table>
  83  */