You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
77 lines
2.4 KiB
77 lines
2.4 KiB
16 years ago
|
/** \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)
|
||
|
16 years ago
|
*
|
||
|
|
* \section SSec_Compat Demo Compatibility:
|
||
|
|
*
|
||
|
15 years ago
|
* 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
|
||
|
16 years ago
|
*
|
||
|
16 years ago
|
* \section SSec_Info USB Information:
|
||
|
|
*
|
||
|
|
* The following table gives a rundown of the USB utilization of this demo.
|
||
|
16 years ago
|
*
|
||
|
|
* <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>
|
||
|
16 years ago
|
*
|
||
|
|
* \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>
|
||
|
16 years ago
|
*/
|