]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorage/MassStorage.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / 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 * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
18 * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
19 * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
20 *
21 * \section Sec_Info USB Information:
22 *
23 * The following table gives a rundown of the USB utilization of this demo.
24 *
25 * <table>
26 * <tr>
27 * <td><b>USB Mode:</b></td>
28 * <td>Device</td>
29 * </tr>
30 * <tr>
31 * <td><b>USB Class:</b></td>
32 * <td>Mass Storage Device</td>
33 * </tr>
34 * <tr>
35 * <td><b>USB Subclass:</b></td>
36 * <td>Bulk-Only Transport</td>
37 * </tr>
38 * <tr>
39 * <td><b>Relevant Standards:</b></td>
40 * <td>USBIF Mass Storage Standard \n
41 * USB Bulk-Only Transport Standard \n
42 * SCSI Primary Commands Specification \n
43 * SCSI Block Commands Specification</td>
44 * </tr>
45 * <tr>
46 * <td><b>Supported USB Speeds:</b></td>
47 * <td>Full Speed Mode</td>
48 * </tr>
49 * </table>
50 *
51 * \section Sec_Description Project Description:
52 *
53 * Mass Storage device demonstration application. This gives a simple
54 * reference application for implementing a USB Mass Storage device using
55 * the basic USB UFI drivers in all modern OSes (i.e. no special drivers
56 * 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.
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 * This demo is not restricted to only a single LUN (logical disk); by changing
68 * the TOTAL_LUNS value in DataflashManager.h, any number of LUNs can be used
69 * (from 1 to 255), with each LUN being allocated an equal portion of the available
70 * Dataflash memory.
71 *
72 * The USB control endpoint is managed entirely by the library using endpoint
73 * interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for
74 * the host to reset the Mass Storage device state during long transfers without
75 * the need for complicated polling logic.
76 *
77 * \section Sec_Options Project Options
78 *
79 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
80 *
81 * <table>
82 * <tr>
83 * <th><b>Define Name:</b></th>
84 * <th><b>Location:</b></th>
85 * <th><b>Description:</b></th>
86 * </tr>
87 * <tr>
88 * <td>TOTAL_LUNS</td>
89 * <td>AppConfig.h</td>
90 * <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -
91 * this can be set to any positive non-zero amount.</td>
92 * </tr>
93 * <tr>
94 * <td>DISK_READ_ONLY</td>
95 * <td>AppConfig.h</td>
96 * <td>Configuration define, indicating if the disk should be write protected or not.</td>
97 * </tr>
98 * </table>
99 */
100
Imprint / Impressum