diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-12-07 04:18:07 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-12-07 04:18:07 +0000 |
| commit | 7a9b3d3641e1bc97d2826b4865b3cedb11099e62 (patch) | |
| tree | 4a51ef80dfea5921150b308d3fe4e7f8e69c908c /Demos/Host/LowLevel/VirtualSerialHost/CDCHost.txt | |
| parent | c1fa2306181924ebd8b36b0e3910b7904143beb8 (diff) | |
| download | lufa-7a9b3d3641e1bc97d2826b4865b3cedb11099e62.tar.gz lufa-7a9b3d3641e1bc97d2826b4865b3cedb11099e62.tar.bz2 lufa-7a9b3d3641e1bc97d2826b4865b3cedb11099e62.zip | |
Rename CDC demos to VirtualSerial.
Diffstat (limited to 'Demos/Host/LowLevel/VirtualSerialHost/CDCHost.txt')
| -rw-r--r-- | Demos/Host/LowLevel/VirtualSerialHost/CDCHost.txt | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/Demos/Host/LowLevel/VirtualSerialHost/CDCHost.txt b/Demos/Host/LowLevel/VirtualSerialHost/CDCHost.txt new file mode 100644 index 000000000..65999926c --- /dev/null +++ b/Demos/Host/LowLevel/VirtualSerialHost/CDCHost.txt @@ -0,0 +1,65 @@ +/** \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 CDC Host Demo
+ *
+ * \section SSec_Compat Demo Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this demo.
+ *
+ * - Series 7 USB AVRs
+ *
+ * \section SSec_Info USB Information:
+ *
+ * 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>
+ * <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>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * CDC host demonstration application. This gives a simple reference application
+ * for implementing a USB CDC host, for CDC devices using the standard ACM profile.
+ *
+ * This demo prints out received CDC data through the serial port.
+ *
+ * Not that this demo is only compatible with devices which report the correct CDC
+ * 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.
+ *
+ * \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>
+ * None
+ * </td>
+ * </tr>
+ * </table>
+ */
|