aboutsummaryrefslogtreecommitdiffstats
path: root/Demos
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-09-09 04:22:49 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-09-09 04:22:49 +0000
commit331929833da3e48ac9c43dce90487490d7a77af1 (patch)
tree818797c0bfc63d11ea2b249c98a794ce99ec92e2 /Demos
parentd2068d878c2ef6c4a68e85215d9d4a3b376089c2 (diff)
downloadlufa-331929833da3e48ac9c43dce90487490d7a77af1.tar.gz
lufa-331929833da3e48ac9c43dce90487490d7a77af1.tar.bz2
lufa-331929833da3e48ac9c43dce90487490d7a77af1.zip
Add Host mode Class driver demo summaries.
Diffstat (limited to 'Demos')
-rw-r--r--Demos/Device/ClassDriver/CDC/CDC.txt2
-rw-r--r--Demos/Device/LowLevel/CDC/CDC.txt2
-rw-r--r--Demos/Host/ClassDriver/CDCHost/CDCHost.txt66
-rw-r--r--Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt68
-rw-r--r--Demos/Host/ClassDriver/StillImageHost/StillImageHost.txt65
5 files changed, 201 insertions, 2 deletions
diff --git a/Demos/Device/ClassDriver/CDC/CDC.txt b/Demos/Device/ClassDriver/CDC/CDC.txt
index 397ed361f..93924c894 100644
--- a/Demos/Device/ClassDriver/CDC/CDC.txt
+++ b/Demos/Device/ClassDriver/CDC/CDC.txt
@@ -4,7 +4,7 @@
* documentation pages. It is not a project source file.
*/
-/** \mainpage Communications Device Class Device (Virtual Serial Port)
+/** \mainpage Communications Device Class Demo (Virtual Serial Port)
*
* \section SSec_Compat Demo Compatibility:
*
diff --git a/Demos/Device/LowLevel/CDC/CDC.txt b/Demos/Device/LowLevel/CDC/CDC.txt
index 397ed361f..93924c894 100644
--- a/Demos/Device/LowLevel/CDC/CDC.txt
+++ b/Demos/Device/LowLevel/CDC/CDC.txt
@@ -4,7 +4,7 @@
* documentation pages. It is not a project source file.
*/
-/** \mainpage Communications Device Class Device (Virtual Serial Port)
+/** \mainpage Communications Device Class Demo (Virtual Serial Port)
*
* \section SSec_Compat Demo Compatibility:
*
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>
+ */
diff --git a/Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt b/Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt
new file mode 100644
index 000000000..5872d1947
--- /dev/null
+++ b/Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt
@@ -0,0 +1,68 @@
+/** \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 Mass Storage 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>Mass Storage Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>Bulk Only</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF Mass Storage Standard</td>
+ * <td>USB Bulk-Only Transport Standard</td>
+ * <td>SCSI Primary Commands Specification</td>
+ * <td>SCSI Block Commands Specification</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Mass Storage host demonstration application. This gives a simple reference
+ * application for implementing a USB Mass Storage host, for USB storage devices
+ * using the standard Mass Storage USB profile.
+ *
+ * The first 512 bytes (boot sector) of an attached disk's memory will be dumped
+ * out of the serial port in HEX and ASCII form when it is attached to the AT90USB1287
+ * AVR. The device will then wait for HWB to be pressed, whereupon the entire ASCII contents
+ * of the disk will be dumped to the serial port.
+ *
+ * \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
diff --git a/Demos/Host/ClassDriver/StillImageHost/StillImageHost.txt b/Demos/Host/ClassDriver/StillImageHost/StillImageHost.txt
new file mode 100644
index 000000000..776e1a49c
--- /dev/null
+++ b/Demos/Host/ClassDriver/StillImageHost/StillImageHost.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 Still Image 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>Still Image Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF Still Image Class Specification</td>
+ * <td>PIMA 15740 Specification</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Still Image host demonstration application. This gives a simple reference
+ * application for implementing a Still Image host, for USB devices such as
+ * digital cameras.
+ *
+ * This demo will enumerate an attached USB Still Image device, print out its
+ * information structure, open a session with the device and finally close the
+ * session.
+ *
+ * \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