diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-05 07:16:33 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-05 07:16:33 +0000 |
| commit | b9b03aadb219d06fbad9d110e508db93e45461af (patch) | |
| tree | 95a91a07c07953009e71613b320c20d1954be3fc /Demos/Device/LowLevel/USBtoSerial/USBtoSerial.txt | |
| parent | 6a7c298c0f7119e44e18de15d714cd8b938e3bef (diff) | |
| download | lufa-b9b03aadb219d06fbad9d110e508db93e45461af.tar.gz lufa-b9b03aadb219d06fbad9d110e508db93e45461af.tar.bz2 lufa-b9b03aadb219d06fbad9d110e508db93e45461af.zip | |
Move new Class Driver powered demos to a new ClassDriver subdirectory, re-add old low level demos to a LowLevel subdirectory.
Diffstat (limited to 'Demos/Device/LowLevel/USBtoSerial/USBtoSerial.txt')
| -rw-r--r-- | Demos/Device/LowLevel/USBtoSerial/USBtoSerial.txt | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.txt b/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.txt new file mode 100644 index 000000000..e33467217 --- /dev/null +++ b/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.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 USB to Serial Converter Demo (via CDC-ACM class)
+ *
+ * \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 USB to Serial converter using the CDC class. Sent and
+ * received data on the serial port is communicated to the USB
+ * 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><b>Define Name:</b></td>
+ * <td><b>Location:</b></td>
+ * <td><b>Description:</b></td>
+ * </tr>
+ * <tr>
+ * <td>BUFF_STATICSIZE</td>
+ * <td>RingBuff.h</td>
+ * <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
+ * </tr>
+ * </table>
+ */
\ No newline at end of file |