diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-20 06:34:41 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-03-20 06:34:41 +0000 |
| commit | ed031c1df2f5b053b9cd9f48c63e66a42b7c049e (patch) | |
| tree | 8e49d639484d53a6e00700b20e2b804e9775242f /Demos/Host/CDCHost/CDCHost.txt | |
| parent | ecf7538430c01b95104682f0f7493e57b9168125 (diff) | |
| download | lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.tar.gz lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.tar.bz2 lufa-ed031c1df2f5b053b9cd9f48c63e66a42b7c049e.zip | |
Seperated out OTG, Device and Host mode demos into seperate folders for clarity. Adjusted makefiles so that the path to the LUFA library can be set in one place.
Diffstat (limited to 'Demos/Host/CDCHost/CDCHost.txt')
| -rw-r--r-- | Demos/Host/CDCHost/CDCHost.txt | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/Demos/Host/CDCHost/CDCHost.txt b/Demos/Host/CDCHost/CDCHost.txt new file mode 100644 index 000000000..39e2357ba --- /dev/null +++ b/Demos/Host/CDCHost/CDCHost.txt @@ -0,0 +1,59 @@ +/** \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_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-specfic class/subclass/protocol codes to force
+ * the user to use specialized drivers. This demo is not compaible 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>
+ */
\ No newline at end of file |