diff options
Diffstat (limited to 'lib/lufa/Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.txt')
| -rw-r--r-- | lib/lufa/Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.txt | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/lib/lufa/Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.txt b/lib/lufa/Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.txt new file mode 100644 index 000000000..fb763b7a2 --- /dev/null +++ b/lib/lufa/Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.txt @@ -0,0 +1,89 @@ +/** \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 Dual Communications Device Class (Dual Virtual Serial Port) Device + * + * \section Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * \li Series 6 USB AVRs (AT90USBxxx6) + * \li Series 4 USB AVRs (ATMEGAxxU4) + * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU) + * \li Series B XMEGA AVRs (ATXMEGAxxxBx) + * \li Series C XMEGA AVRs (ATXMEGAxxxCx) + * + * \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>Device</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>Relevant Standards:</b></td> + * <td>USBIF Interface Association Descriptor ECN \n + * 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: + * + * Dual Communications Device Class demonstration application. + * This gives a simple reference application for implementing + * a compound device with dual CDC functions acting as a pair + * of virtual serial ports. This demo uses Interface Association + * Descriptors to link together the pair of related CDC + * descriptors for each virtual serial port, which may not be + * supported in all OSes - Windows Vista is supported, as is + * XP (although the latter may need a hotfix to function). + * + * Joystick actions are transmitted to the host as strings + * through the first serial port. The device does not respond to + * serial data sent from the host in the first serial port. + * + * The second serial port echoes back data sent from the host. + * + * After running this demo for the first time on a new computer, + * you will need to supply the .INF file located in this demo + * project's directory as the device's driver when running under + * Windows. This will enable Windows to use its inbuilt CDC drivers, + * negating the need for custom drivers for the device. Other + * Operating Systems should automatically use their own inbuilt + * CDC-ACM drivers. + * + * \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> + */ + |