]> git.gir.st - tmk_keyboard.git/blob - tmk_core/protocol/lufa/LUFA-git/Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt
Merge commit '20b787fc1284176834cbe7ca2134e4b36bec5828'
[tmk_keyboard.git] / tmk_core / protocol / lufa / LUFA-git / Demos / Device / ClassDriver / VirtualSerialMassStorage / VirtualSerialMassStorage.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 Communications Device Class (Virtual Serial Port) and Mass Storage 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 AU XMEGA AVRs (ATXMEGAxxxAxU)
17 * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
18 * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
19 *
20 * \section Sec_Info USB Information:
21 *
22 * The following table gives a rundown of the USB utilization of this demo.
23 *
24 * <table>
25 * <tr>
26 * <td><b>USB Mode:</b></td>
27 * <td>Device</td>
28 * </tr>
29 * <tr>
30 * <td><b>USB Class:</b></td>
31 * <td>Communications Device Class (CDC) \n
32 * Mass Storage Device</td>
33 * </tr>
34 * <tr>
35 * <td><b>USB Subclass:</b></td>
36 * <td>Abstract Control Model (ACM) \n
37 * Bulk-Only Transport</td>
38 * </tr>
39 * <tr>
40 * <td><b>Relevant Standards:</b></td>
41 * <td>USBIF CDC Class Standard \n
42 * USBIF Mass Storage Standard \n
43 * USB Bulk-Only Transport Standard \n
44 * SCSI Primary Commands Specification \n
45 * SCSI Block Commands Specification</td>
46 * </tr>
47 * <tr>
48 * <td><b>Supported USB Speeds:</b></td>
49 * <td>Full Speed Mode</td>
50 * </tr>
51 * </table>
52 *
53 * \section Sec_Description Project Description:
54 *
55 * Combined Communications Device Class/Mass Storage demonstration application.
56 * This gives a simple reference application for implementing a combined
57 * CDC and Mass Storage device acting as a both a virtual serial port and a flash
58 * drive. Joystick actions are transmitted to the host as strings, and data can be
59 * written to or read from the exposed flash drive interface in the same manner as
60 * other USB flash drives. The device does not respond to serial data sent from the
61 * host.
62 *
63 * After running this demo for the first time on a new computer,
64 * you will need to supply the .INF file located in this demo
65 * project's directory as the device's driver when running under
66 * Windows. This will enable Windows to use its inbuilt CDC drivers,
67 * negating the need for custom drivers for the device. Other
68 * Operating Systems should automatically use their own inbuilt
69 * CDC-ACM drivers.
70 *
71 * \section Sec_Options Project Options
72 *
73 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
74 *
75 * <table>
76 * <tr>
77 * <th><b>Define Name:</b></th>
78 * <th><b>Location:</b></th>
79 * <th><b>Description:</b></th>
80 * </tr>
81 * <tr>
82 * <td>TOTAL_LUNS</td>
83 * <td>AppConfig.h</td>
84 * <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -
85 * this can be set to any positive non-zero amount.</td>
86 * </tr>
87 * <tr>
88 * <td>DISK_READ_ONLY</td>
89 * <td>AppConfig.h</td>
90 * <td>Configuration define, indicating if the disk should be write protected or not.</td>
91 * </tr>
92 */
93
Imprint / Impressum