diff options
Diffstat (limited to 'Demos/CDCHost/CDCHost.txt')
-rw-r--r-- | Demos/CDCHost/CDCHost.txt | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/Demos/CDCHost/CDCHost.txt b/Demos/CDCHost/CDCHost.txt new file mode 100644 index 000000000..5f8dc8cc0 --- /dev/null +++ b/Demos/CDCHost/CDCHost.txt @@ -0,0 +1,42 @@ +/** \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
+ *
+ * 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-specfic class/subclass/protocol codes to force
+ * the user to use specialized drivers. This demo is not compaible with such devices.
+ *
+ *
+ * <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>
+ */
\ No newline at end of file |