USBtoSerial.txt 2.8 KB
Newer Older
1
2
3
4
5
6
7
/** \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.
 */
 
/** \mainpage USB to Serial Converter Demo (via CDC-ACM class)
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 *  \section SSec_Compat Demo Compatibility:
 *
 *  The following table indicates what microcontrollers are compatible with this demo.
 *
 *  - AT90USB1287
 *  - AT90USB1286
 *  - AT90USB647
 *  - AT90USB646
 *  - ATMEGA32U6
 *  - ATMEGA32U4
 *  - ATMEGA16U4
 *  - AT90USB162
 *  - AT90USB82
22
 *
23
24
25
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 *
 *  <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>
 *   <tr> 
 *    <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>
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 *
 *  \section SSec_Description Project Description: 
 *
 *  Communications Device Class demonstration application.
 *  This gives a simple reference application for implementing
 *  a USB to Serial converter using the CDC class. Sent and
 *  received data on the serial port is communicated to the USB
 *  host.
 *  
 *  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.
 *
66
67
68
69
70
71
72
 *  On 64 bit versions of Windows, the OS requires all drivers to
 *  be digitally signed before it will allow them to be installed. As
 *  Windows' own CDC driver (which the supplied INF file references)
 *  is not signed, you will need to reboot, press F8 before Windows
 *  begins to load and select "Disable Driver Signature Enforcement"
 *  to allow the CDC driver to install.
 *
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 *  \section SSec_Options Project Options
 *
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 *
 *  <table>
 *   <tr>
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
 *    <td>BUFF_STATICSIZE</td>
 *    <td>RingBuff.h</td>
 *    <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
 *   </tr>
 *  </table>
89
 */