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 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  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  17  *
  18  *  \section Sec_Info USB Information:
  19  *
  20  *  The following table gives a rundown of the USB utilization of this demo.
  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>Mass Storage Device</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>Bulk-Only Transport</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF Mass Storage Standard \n
  38  *        USB Bulk-Only Transport Standard \n
  39  *        SCSI Primary Commands Specification \n
  40  *        SCSI Block Commands Specification</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>Supported USB Speeds:</b></td>
  44  *    <td>Full Speed Mode</td>
  45  *   </tr>
  46  *  </table>
  47  *
  48  *  \section Sec_Description Project Description:
  49  *
  50  *  Mass Storage device demonstration application. This gives a simple
  51  *  reference application for implementing a USB Mass Storage device using
  52  *  the basic USB UFI drivers in all modern OSes (i.e. no special drivers
  53  *  required).
  54  *
  55  *  On start-up the system will automatically enumerate and function as an
  56  *  external mass storage device which may be formatted and used in the same
  57  *  manner as commercial USB Mass Storage devices.
  58  *
  59  *  You will need to format the mass storage drive upon first run of this
  60  *  demonstration - as the device acts only as a data block transport between
  61  *  the host and the storage media, it does not matter what file system is used,
  62  *  as the data interpretation is performed by the host and not the USB device.
  63  *
  64  *  This demo is not restricted to only a single LUN (logical disk); by changing
  65  *  the TOTAL_LUNS value in DataflashManager.h, any number of LUNs can be used
  66  *  (from 1 to 255), with each LUN being allocated an equal portion of the available
  67  *  Dataflash memory.
  68  *
  69  *  The USB control endpoint is managed entirely by the library using endpoint
  70  *  interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for
  71  *  the host to reset the Mass Storage device state during long transfers without
  72  *  the need for complicated polling logic.
  73  *
  74  *  \section Sec_Options Project Options
  75  *
  76  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  77  *
  78  *  <table>
  79  *   <tr>
  80  *    <td><b>Define Name:</b></td>
  81  *    <td><b>Location:</b></td>
  82  *    <td><b>Description:</b></td>
  83  *   </tr>
  84  *   <tr>
  85  *    <td>TOTAL_LUNS</td>
  86  *    <td>AppConfig.h</td>
  87  *    <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -
  88  *        this can be set to any positive non-zero amount.</td>
  89  *   </tr>
  90  *   <tr>
  91  *    <td>DISK_READ_ONLY</td>
  92  *    <td>AppConfig.h</td>
  93  *    <td>Configuration define, indicating if the disk should be write protected or not.</td>
  94  *   </tr>
  95  *  </table>
  96  */
  97