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</td>
  30  *    <td>Human Interface Device</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Subclasses:</b></td>
  34  *    <td>Bulk-Only Transport</td>
  35  *    <td>Keyboard Subclass</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Relevant Standards:</b></td>
  39  *    <td>USBIF Mass Storage Standard</td>
  40  *    <td>USB Bulk-Only Transport Standard</td>
  41  *    <td>SCSI Primary Commands Specification</td>
  42  *    <td>SCSI Block Commands Specification</td>
  43  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  44  *   </tr>
  45  *   <tr>
  46  *    <td><b>Usable Speeds:</b></td>
  47  *    <td>Full Speed Mode</td>
  48  *   </tr>
  49  *  </table>
  50  *
  51  *  \section SSec_Description Project Description:
  52  *
  53  *  Combined Mass Storage and Keyboard demonstration application. This gives a
  54  *  simple reference application for implementing a dual class USB Mass Storage
  55  *  and USB HID Keyboard device using the basic USB UFI and HID drivers in all
  56  *  modern OSes (i.e. no special drivers required).
  57  *
  58  *  On start-up the system will automatically enumerate and function as an
  59  *  external mass storage device (which may be formatted and used in the same
  60  *  manner as commercial USB Mass Storage devices) and a USB keyboard.
  61  *
  62  *  You will need to format the mass storage drive upon first run of this
  63  *  demonstration - as the device acts only as a data block transport between
  64  *  the host and the storage media, it does not matter what file system is used,
  65  *  as the data interpretation is performed by the host and not the USB device.
  66  *
  67  *  Keys on the USB keyboard can be pressed by moving the board's Joystick.
  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 SSec_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>MassStorage.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  *  </table>
  91  */