diff options
Diffstat (limited to 'lib/lufa/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt')
| -rw-r--r-- | lib/lufa/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/lib/lufa/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt b/lib/lufa/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt new file mode 100644 index 0000000000..1e1f9f1ae2 --- /dev/null +++ b/lib/lufa/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.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 Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * + * \section Sec_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>Supported USB Speeds:</b></td> + * <td>Full Speed Mode</td> + * </tr> + * </table> + * + * \section Sec_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. + * + * Note 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 Sec_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> + */ + |