]> git.gir.st - tmk_keyboard.git/blob - tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.txt
Merge commit '20b787fc1284176834cbe7ca2134e4b36bec5828'
[tmk_keyboard.git] / tmk_core / protocol / lufa / LUFA-git / Demos / Device / LowLevel / DualVirtualSerial / DualVirtualSerial.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 Dual Communications Device Class (Dual Virtual Serial Port) Device
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)</td>
32 * </tr>
33 * <tr>
34 * <td><b>USB Subclass:</b></td>
35 * <td>Abstract Control Model (ACM)</td>
36 * </tr>
37 * <tr>
38 * <td><b>Relevant Standards:</b></td>
39 * <td>USBIF CDC Class Standard</td>
40 * </tr>
41 * <tr>
42 * <td><b>Relevant Standards:</b></td>
43 * <td>USBIF Interface Association Descriptor ECN \n
44 * USBIF CDC Class Standard</td>
45 * </tr>
46 * <tr>
47 * <td><b>Supported USB Speeds:</b></td>
48 * <td>Full Speed Mode</td>
49 * </tr>
50 * </table>
51 *
52 * \section Sec_Description Project Description:
53 *
54 * Dual Communications Device Class demonstration application.
55 * This gives a simple reference application for implementing
56 * a compound device with dual CDC functions acting as a pair
57 * of virtual serial ports. This demo uses Interface Association
58 * Descriptors to link together the pair of related CDC
59 * descriptors for each virtual serial port, which may not be
60 * supported in all OSes - Windows Vista is supported, as is
61 * XP (although the latter may need a hotfix to function).
62 *
63 * Joystick actions are transmitted to the host as strings
64 * through the first serial port. The device does not respond to
65 * serial data sent from the host in the first serial port.
66 *
67 * The second serial port echoes back data sent from the host.
68 *
69 * After running this demo for the first time on a new computer,
70 * you will need to supply the .INF file located in this demo
71 * project's directory as the device's driver when running under
72 * Windows. This will enable Windows to use its inbuilt CDC drivers,
73 * negating the need for custom drivers for the device. Other
74 * Operating Systems should automatically use their own inbuilt
75 * CDC-ACM drivers.
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 * <td>
84 * None
85 * </td>
86 * </tr>
87 * </table>
88 */
89
Imprint / Impressum