From 331929833da3e48ac9c43dce90487490d7a77af1 Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Wed, 9 Sep 2009 04:22:49 +0000
Subject: Add Host mode Class driver demo summaries.

---
 Demos/Host/ClassDriver/CDCHost/CDCHost.txt | 66 ++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 Demos/Host/ClassDriver/CDCHost/CDCHost.txt

(limited to 'Demos/Host/ClassDriver/CDCHost/CDCHost.txt')

diff --git a/Demos/Host/ClassDriver/CDCHost/CDCHost.txt b/Demos/Host/ClassDriver/CDCHost/CDCHost.txt
new file mode 100644
index 000000000..58469ab45
--- /dev/null
+++ b/Demos/Host/ClassDriver/CDCHost/CDCHost.txt
@@ -0,0 +1,66 @@
+/** \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 table indicates what microcontrollers are compatible with this demo.
+ *
+ *  - AT90USB1287
+ *  - AT90USB647
+ *
+ *  \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>
+ */
-- 
cgit v1.2.3