]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / 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 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 Classes:</b></td>
32 * <td>Mass Storage Device \n
33 * Human Interface Device</td>
34 * </tr>
35 * <tr>
36 * <td><b>USB Subclasses:</b></td>
37 * <td>Bulk-Only Transport \n
38 * Keyboard Subclass</td>
39 * </tr>
40 * <tr>
41 * <td><b>Relevant Standards:</b></td>
42 * <td>USBIF Mass Storage Standard \n
43 * USB Bulk-Only Transport Standard \n
44 * SCSI Primary Commands Specification \n
45 * SCSI Block Commands Specification \n
46 * USBIF HID Specification \n
47 * USBIF HID Usage Tables</td>
48 * </tr>
49 * <tr>
50 * <td><b>Supported USB Speeds:</b></td>
51 * <td>Full Speed Mode</td>
52 * </tr>
53 * </table>
54 *
55 * \section Sec_Description Project Description:
56 *
57 * Combined Mass Storage and Keyboard demonstration application. This gives a
58 * simple reference application for implementing a dual class USB Mass Storage
59 * and USB HID Keyboard device using the basic USB UFI and HID drivers in all
60 * modern OSes (i.e. no special drivers required).
61 *
62 * On start-up the system will automatically enumerate and function as an
63 * external mass storage device (which may be formatted and used in the same
64 * manner as commercial USB Mass Storage devices) and a USB keyboard.
65 *
66 * You will need to format the mass storage drive upon first run of this
67 * demonstration - as the device acts only as a data block transport between
68 * the host and the storage media, it does not matter what file system is used,
69 * as the data interpretation is performed by the host and not the USB device.
70 *
71 * Keys on the USB keyboard can be pressed by moving the board's Joystick.
72 *
73 * The USB control endpoint is managed entirely by the library using endpoint
74 * interrupts, as the INTERRUPT_CONTROL_ENDPOINT option is enabled. This allows for
75 * the host to reset the Mass Storage device state during long transfers without
76 * the need for complicated polling logic.
77 *
78 * \section Sec_Options Project Options
79 *
80 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
81 *
82 * <table>
83 * <tr>
84 * <th><b>Define Name:</b></th>
85 * <th><b>Location:</b></th>
86 * <th><b>Description:</b></th>
87 * </tr>
88 * <tr>
89 * <td>TOTAL_LUNS</td>
90 * <td>AppConfig.h</td>
91 * <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -
92 * this can be set to any positive non-zero amount.</td>
93 * </tr>
94 * <tr>
95 * <td>DISK_READ_ONLY</td>
96 * <td>AppConfig.h</td>
97 * <td>Configuration define, indicating if the disk should be write protected or not.</td>
98 * </tr>
99 */
100
Imprint / Impressum