DualVirtualSerial.txt 2.73 KB
Newer Older
1
2
3
4
5
/** \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.
 */
6

7
8
/** \mainpage Dual Communications Device Class (Dual Virtual Serial Port) Device
 *
9
 *  \section Sec_Compat Demo Compatibility:
10
11
12
 *
 *  The following list indicates what microcontrollers are compatible with this demo.
 *
13
14
15
 *  \li Series 7 USB AVRs (AT90USBxxx7)
 *  \li Series 6 USB AVRs (AT90USBxxx6)
 *  \li Series 4 USB AVRs (ATMEGAxxU4)
16
 *
17
 *  \section Sec_Info USB Information:
18
19
20
21
22
23
24
25
26
27
28
29
 *
 *  The following table gives a rundown of the USB utilization of this demo.
 *
 *  <table>
 *   <tr>
 *    <td><b>USB Mode:</b></td>
 *    <td>Device</td>
 *   </tr>
 *   <tr>
 *    <td><b>USB Class:</b></td>
 *    <td>Communications Device Class (CDC)</td>
 *   </tr>
30
 *   <tr>
31
32
33
34
35
36
37
38
39
40
41
42
43
 *    <td><b>USB Subclass:</b></td>
 *    <td>Abstract Control Model (ACM)</td>
 *   </tr>
 *   <tr>
 *    <td><b>Relevant Standards:</b></td>
 *    <td>USBIF CDC Class Standard</td>
 *   </tr>
 *   <tr>
 *    <td><b>Relevant Standards:</b></td>
 *    <td>USBIF Interface Association Descriptor ECN \n
 *        USBIF CDC Class Standard</td>
 *   </tr>
 *   <tr>
44
 *    <td><b>Supported USB Speeds:</b></td>
45
46
47
48
 *    <td>Full Speed Mode</td>
 *   </tr>
 *  </table>
 *
49
 *  \section Sec_Description Project Description:
50
51
52
 *
 *  Dual Communications Device Class demonstration application.
 *  This gives a simple reference application for implementing
53
 *  a composite device with dual CDC functions acting as a pair
54
55
56
57
58
 *  of virtual serial ports. This demo uses Interface Association
 *  Descriptors to link together the pair of related CDC
 *  descriptors for each virtual serial port, which may not be
 *  supported in all OSes - Windows Vista is supported, as is
 *  XP (although the latter may need a hotfix to function).
59
 *
60
61
62
 *  Joystick actions are transmitted to the host as strings
 *  through the first serial port. The device does not respond to
 *  serial data sent from the host in the first serial port.
63
 *
64
 *  The second serial port echoes back data sent from the host.
65
 *
66
67
68
69
70
71
72
73
 *  After running this demo for the first time on a new computer,
 *  you will need to supply the .INF file located in this demo
 *  project's directory as the device's driver when running under
 *  Windows. This will enable Windows to use its inbuilt CDC drivers,
 *  negating the need for custom drivers for the device. Other
 *  Operating Systems should automatically use their own inbuilt
 *  CDC-ACM drivers.
 *
74
 *  \section Sec_Options Project Options
75
 *
76
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
77
78
79
80
81
82
83
84
 *
 *  <table>
 *   <tr>
 *    <td>
 *     None
 *    </td>
 *   </tr>
 *  </table>
85
 */
86