diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-12-07 04:35:59 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-12-07 04:35:59 +0000 |
| commit | cf22a744ec0da3b68c4ffdb14c6fa43f2e07542f (patch) | |
| tree | e61fa3c8f3f1911a8200b988f106774a1b6780c8 /Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt | |
| parent | 7a9b3d3641e1bc97d2826b4865b3cedb11099e62 (diff) | |
| download | lufa-cf22a744ec0da3b68c4ffdb14c6fa43f2e07542f.tar.gz lufa-cf22a744ec0da3b68c4ffdb14c6fa43f2e07542f.tar.bz2 lufa-cf22a744ec0da3b68c4ffdb14c6fa43f2e07542f.zip | |
Additional file renames and modifications to change CDC demos to VirtualSerial.
Diffstat (limited to 'Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt')
| -rw-r--r-- | Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt b/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt new file mode 100644 index 000000000..49837354c --- /dev/null +++ b/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt @@ -0,0 +1,72 @@ +/** \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 Communications Device Class (Virtual Serial Port) Demo
+ *
+ * \section SSec_Compat Demo Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this demo.
+ *
+ * - Series 7 USB AVRs
+ * - Series 6 USB AVRs
+ * - Series 4 USB AVRs
+ * - Series 2 USB AVRs
+ *
+ * \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>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>Usable Speeds:</b></td>
+ * <td>Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Communications Device Class demonstration application.
+ * This gives a simple reference application for implementing
+ * a CDC device acting as a virtual serial port. Joystick
+ * actions are transmitted to the host as strings. The device
+ * does not respond to serial 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 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 |