bzr branch
http://bzr.ed.am/elec/audio-switcher
|
1
by Tim Marston
initial commit |
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 Communications Device Class (Virtual Serial Port) 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 |
* |
|
18 |
* \section Sec_Info USB Information: |
|
19 |
* |
|
20 |
* The following table gives a rundown of the USB utilization of this demo. |
|
21 |
* |
|
22 |
* <table> |
|
23 |
* <tr> |
|
24 |
* <td><b>USB Mode:</b></td> |
|
25 |
* <td>Device</td> |
|
26 |
* </tr> |
|
27 |
* <tr> |
|
28 |
* <td><b>USB Class:</b></td> |
|
29 |
* <td>Communications Device Class (CDC)</td> |
|
30 |
* </tr> |
|
31 |
* <tr> |
|
32 |
* <td><b>USB Subclass:</b></td> |
|
33 |
* <td>Abstract Control Model (ACM)</td> |
|
34 |
* </tr> |
|
35 |
* <tr> |
|
36 |
* <td><b>Relevant Standards:</b></td> |
|
37 |
* <td>USBIF CDC Class Standard</td> |
|
38 |
* </tr> |
|
39 |
* <tr> |
|
40 |
* <td><b>Supported USB Speeds:</b></td> |
|
41 |
* <td>Full Speed Mode</td> |
|
42 |
* </tr> |
|
43 |
* </table> |
|
44 |
* |
|
45 |
* \section Sec_Description Project Description: |
|
46 |
* |
|
47 |
* Communications Device Class demonstration application. |
|
48 |
* This gives a simple reference application for implementing |
|
49 |
* a CDC device acting as a virtual serial port. Joystick |
|
50 |
* actions are transmitted to the host as strings. The device |
|
51 |
* does not respond to serial data sent from the host. |
|
52 |
* |
|
53 |
* After running this demo for the first time on a new computer, |
|
54 |
* you will need to supply the .INF file located in this demo |
|
55 |
* project's directory as the device's driver when running under |
|
56 |
* Windows. This will enable Windows to use its inbuilt CDC drivers, |
|
57 |
* negating the need for custom drivers for the device. Other |
|
58 |
* Operating Systems should automatically use their own inbuilt |
|
59 |
* CDC-ACM drivers. |
|
60 |
* |
|
61 |
* \section Sec_Options Project Options |
|
62 |
* |
|
63 |
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. |
|
64 |
* |
|
65 |
* <table> |
|
66 |
* <tr> |
|
67 |
* <td> |
|
68 |
* None |
|
69 |
* </td> |
|
70 |
* </tr> |
|
71 |
* </table> |
|
72 |
*/ |
|
73 |