VirtualSerialHost.txt 1.86 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 CDC Host Demo
 *
9
 *  \section Sec_Compat Demo Compatibility:
10
11
12
 *
 *  The following list indicates what microcontrollers are compatible with this demo.
 *
13
 *  - Series 7 USB AVRs (AT90USBxxx7)
14
 *
15
 *  \section Sec_Info USB Information:
16
17
18
19
20
21
22
23
24
25
26
27
 *
 *  The following table gives a rundown of the USB utilization of this demo.
 *
 *  <table>
 *   <tr>
 *    <td><b>USB Mode:</b></td>
 *    <td>Host</td>
 *   </tr>
 *   <tr>
 *    <td><b>USB Class:</b></td>
 *    <td>Communications Device Class (CDC)</td>
 *   </tr>
28
 *   <tr>
29
30
31
32
33
34
35
36
37
38
39
40
41
 *    <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>Usable Speeds:</b></td>
 *    <td>Full Speed Mode</td>
 *   </tr>
 *  </table>
 *
42
 *  \section Sec_Description Project Description:
43
44
45
 *
 *  CDC host demonstration application. This gives a simple reference application
 *  for implementing a USB CDC host, for CDC devices using the standard ACM profile.
46
 *
47
 *  This demo prints out received CDC data through the serial port.
48
 *
49
 *  Note that this demo is only compatible with devices which report the correct CDC
50
51
52
53
 *  and ACM class, subclass and protocol values. Most USB-Serial cables have vendor
 *  specific features, thus use vendor-specific class/subclass/protocol codes to force
 *  the user to use specialized drivers. This demo is not compatible with such devices.
 *
54
 *  \section Sec_Options Project Options
55
 *
56
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
57
58
59
60
61
62
63
64
65
 *
 *  <table>
 *   <tr>
 *    <td>
 *     None
 *    </td>
 *   </tr>
 *  </table>
 */
66