diff options
author | Jack Humbert <jack.humb@gmail.com> | 2015-10-27 14:52:18 -0400 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2015-10-27 14:52:18 -0400 |
commit | d311fd8d1a0af3b767d26b520d399bf0db22f058 (patch) | |
tree | b9de5704143ac205b4e26222f9d7551e9b161924 /tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorage/MassStorage.txt | |
parent | a766918d5c48204375f4c207b30bbbf1389df14f (diff) | |
parent | 6f3141965e88c4ee0ebf7c18a243e4c2d9c5021b (diff) |
Merge pull request #34 from jackhumbert/tmk-master
merging from tmk, new_project script and template
Diffstat (limited to 'tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorage/MassStorage.txt')
-rw-r--r-- | tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorage/MassStorage.txt | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorage/MassStorage.txt b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorage/MassStorage.txt new file mode 100644 index 0000000000..31779e9c02 --- /dev/null +++ b/tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorage/MassStorage.txt @@ -0,0 +1,100 @@ +/** \file + * + * This file contains special DoxyGen information for the generation of the main page and other special + * documentation pages. It is not a project source file. + */ + +/** \mainpage Mass Storage Device Demo + * + * \section Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * \li Series 6 USB AVRs (AT90USBxxx6) + * \li Series 4 USB AVRs (ATMEGAxxU4) + * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) + * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU) + * \li Series B XMEGA AVRs (ATXMEGAxxxBxU) + * \li Series C XMEGA AVRs (ATXMEGAxxxCxU) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this demo. + * + * <table> + * <tr> + * <td><b>USB Mode:</b></td> + * <td>Device</td> + * </tr> + * <tr> + * <td><b>USB Class:</b></td> + * <td>Mass Storage Device</td> + * </tr> + * <tr> + * <td><b>USB Subclass:</b></td> + * <td>Bulk-Only Transport</td> + * </tr> + * <tr> + * <td><b>Relevant Standards:</b></td> + * <td>USBIF Mass Storage Standard \n + * USB Bulk-Only Transport Standard \n + * SCSI Primary Commands Specification \n + * SCSI Block Commands Specification</td> + * </tr> + * <tr> + * <td><b>Supported USB Speeds:</b></td> + * <td>Full Speed Mode</td> + * </tr> + * </table> + * + * \section Sec_Description Project Description: + * + * Mass Storage device demonstration application. This gives a simple + * reference application for implementing a USB Mass Storage device using + * the basic USB UFI drivers in all modern OSes (i.e. no special drivers + * required). + * + * On start-up the system will automatically enumerate and function as an + * external mass storage device which may be formatted and used in the same + * manner as commercial USB Mass Storage devices. + * + * You will need to format the mass storage drive upon first run of this + * demonstration - as the device acts only as a data block transport between + * the host and the storage media, it does not matter what file system is used, + * as the data interpretation is performed by the host and not the USB device. + * + * This demo is not restricted to only a single LUN (logical disk); by changing + * the TOTAL_LUNS value in DataflashManager.h, any number of LUNs can be used + * (from 1 to 255), with each LUN being allocated an equal portion of the available + * Dataflash memory. + * + * The USB control endpoint is managed entirely by the library using endpoint + * interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for + * the host to reset the Mass Storage device state during long transfers without + * the need for complicated polling logic. + * + * \section Sec_Options Project Options + * + * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. + * + * <table> + * <tr> + * <th><b>Define Name:</b></th> + * <th><b>Location:</b></th> + * <th><b>Description:</b></th> + * </tr> + * <tr> + * <td>TOTAL_LUNS</td> + * <td>AppConfig.h</td> + * <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive - + * this can be set to any positive non-zero amount.</td> + * </tr> + * <tr> + * <td>DISK_READ_ONLY</td> + * <td>AppConfig.h</td> + * <td>Configuration define, indicating if the disk should be write protected or not.</td> + * </tr> + * </table> + */ + |