From 331929833da3e48ac9c43dce90487490d7a77af1 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Wed, 9 Sep 2009 04:22:49 +0000 Subject: [PATCH] Add Host mode Class driver demo summaries. --- Demos/Device/ClassDriver/CDC/CDC.txt | 2 +- Demos/Device/LowLevel/CDC/CDC.txt | 2 +- Demos/Host/ClassDriver/CDCHost/CDCHost.txt | 66 ++++++++++++++++++ .../MassStorageHost/MassStorageHost.txt | 68 +++++++++++++++++++ .../StillImageHost/StillImageHost.txt | 65 ++++++++++++++++++ LUFA.pnproj | 2 +- LUFA/ManPages/FutureChanges.txt | 2 +- 7 files changed, 203 insertions(+), 4 deletions(-) create mode 100644 Demos/Host/ClassDriver/CDCHost/CDCHost.txt create mode 100644 Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt create mode 100644 Demos/Host/ClassDriver/StillImageHost/StillImageHost.txt diff --git a/Demos/Device/ClassDriver/CDC/CDC.txt b/Demos/Device/ClassDriver/CDC/CDC.txt index 397ed361f3..93924c8949 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 397ed361f3..93924c8949 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 0000000000..58469ab457 --- /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. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Host
USB Class:Communications Device Class (CDC)
USB Subclass:Abstract Control Model (ACM)
Relevant Standards:USBIF CDC Class Standard
Usable Speeds:Full Speed Mode
+ * + * \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. + * + * + * + * + * + *
+ * None + *
+ */ diff --git a/Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt b/Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.txt new file mode 100644 index 0000000000..5872d1947f --- /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. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Host
USB Class:Mass Storage Device
USB Subclass:Bulk Only
Relevant Standards:USBIF Mass Storage StandardUSB Bulk-Only Transport StandardSCSI Primary Commands SpecificationSCSI Block Commands Specification
Usable Speeds:Full Speed Mode
+ * + * \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. + * + * + * + * + * + *
+ * None + *
+ */ \ 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 0000000000..776e1a49cf --- /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. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Host
USB Class:Still Image Device
USB Subclass:N/A
Relevant Standards:USBIF Still Image Class SpecificationPIMA 15740 Specification
Usable Speeds:Full Speed Mode
+ * + * \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. + * + * + * + * + * + *
+ * None + *
+ */ \ No newline at end of file diff --git a/LUFA.pnproj b/LUFA.pnproj index 8975d59c72..b3242ba5d6 100644 --- a/LUFA.pnproj +++ b/LUFA.pnproj @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt index 23d3ff883b..425dcb5510 100644 --- a/LUFA/ManPages/FutureChanges.txt +++ b/LUFA/ManPages/FutureChanges.txt @@ -12,7 +12,7 @@ * or post your suggestion as an enhancement request to the project bug tracker. * * Targeted for This Release: - * - Finish HID and Still Image Host Mode Class Drivers, add demo summaries + * - Finish HID Host Mode Class Driver, add demo summaries * * Targeted for Future Releases: * - Add hub support to match Atmel's stack