Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.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 Combined Mass Storage and Keyboard Device Demo
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs
  14  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs
  16  *  - Series 2 USB AVRs
  17  *
  18  *  \section SSec_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 Classes:</b></td>
  29  *    <td>Mass Storage Device \n
  30  *        Human Interface Device</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Subclasses:</b></td>
  34  *    <td>Bulk-Only Transport \n
  35  *        Keyboard Subclass</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Relevant Standards:</b></td>
  39  *    <td>USBIF Mass Storage Standard \n
  40  *        USB Bulk-Only Transport Standard \n
  41  *        SCSI Primary Commands Specification \n
  42  *        SCSI Block Commands Specification \n
  43  *        USBIF HID Specification \n
  44  *        USBIF HID Usage Tables</td>
  45  *   </tr>
  46  *   <tr>
  47  *    <td><b>Usable Speeds:</b></td>
  48  *    <td>Full Speed Mode</td>
  49  *   </tr>
  50  *  </table>
  51  *
  52  *  \section SSec_Description Project Description:
  53  *
  54  *  Combined Mass Storage and Keyboard demonstration application. This gives a
  55  *  simple reference application for implementing a dual class USB Mass Storage
  56  *  and USB HID Keyboard device using the basic USB UFI and HID drivers in all
  57  *  modern OSes (i.e. no special drivers required).
  58  *
  59  *  On start-up the system will automatically enumerate and function as an
  60  *  external mass storage device (which may be formatted and used in the same
  61  *  manner as commercial USB Mass Storage devices) and a USB keyboard.
  62  *
  63  *  You will need to format the mass storage drive upon first run of this
  64  *  demonstration - as the device acts only as a data block transport between
  65  *  the host and the storage media, it does not matter what file system is used,
  66  *  as the data interpretation is performed by the host and not the USB device.
  67  *
  68  *  Keys on the USB keyboard can be pressed by moving the board's Joystick.
  69  *
  70  *  The USB control endpoint is managed entirely by the library using endpoint
  71  *  interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for
  72  *  the host to reset the Mass Storage device state during long transfers without
  73  *  the need for complicated polling logic.
  74  *
  75  *  \section SSec_Options Project Options
  76  *
  77  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  78  *
  79  *  <table>
  80  *   <tr>
  81  *    <td><b>Define Name:</b></td>
  82  *    <td><b>Location:</b></td>
  83  *    <td><b>Description:</b></td>
  84  *   </tr>
  85  *   <tr>
  86  *    <td>TOTAL_LUNS</td>
  87  *    <td>MassStorage.h</td>
  88  *    <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive
  89  *        - this can be set to any positive non-zero amount.</td>
  90  *   </tr>
  91  *  </table>
  92  */