From 60b30c036397cb5627fa374bb930794b225daa29 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Fri, 7 Jul 2017 11:55:23 -0400 Subject: Squashed 'lib/lufa/' content from commit 385d40300 git-subtree-dir: lib/lufa git-subtree-split: 385d4030035dbaf41591309dbde47653bd03841b --- .../Device/ClassDriver/MassStorage/MassStorage.txt | 100 +++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 Demos/Device/ClassDriver/MassStorage/MassStorage.txt (limited to 'Demos/Device/ClassDriver/MassStorage/MassStorage.txt') diff --git a/Demos/Device/ClassDriver/MassStorage/MassStorage.txt b/Demos/Device/ClassDriver/MassStorage/MassStorage.txt new file mode 100644 index 0000000000..5759efa6b4 --- /dev/null +++ b/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 (ATXMEGAxxxBx) + * \li Series C XMEGA AVRs (ATXMEGAxxxCx) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this demo. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Device
USB Class:Mass Storage Device
USB Subclass:Bulk-Only Transport
Relevant Standards:USBIF Mass Storage Standard \n + * USB Bulk-Only Transport Standard \n + * SCSI Primary Commands Specification \n + * SCSI Block Commands Specification
Supported USB Speeds:Full Speed Mode
+ * + * \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. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Define Name:Location:Description:
TOTAL_LUNSAppConfig.hTotal 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.
DISK_READ_ONLYAppConfig.hConfiguration define, indicating if the disk should be write protected or not.
+ */ + -- cgit v1.2.3