forked from mfulz_github/qmk_firmware
1d26e78258
Documented FAST_STREAM_TRANSFERS compile time option. Reduced the TCP window size for the RNDIS demos (Class and LowLevel) to make them compatible with the AT90USB64x.
77 lines
2.2 KiB
Plaintext
77 lines
2.2 KiB
Plaintext
/** \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 Device (Virtual Serial Port)
|
|
*
|
|
* \section SSec_Compat Demo Compatibility:
|
|
*
|
|
* The following table indicates what microcontrollers are compatible with this demo.
|
|
*
|
|
* - AT90USB1287
|
|
* - AT90USB1286
|
|
* - AT90USB647
|
|
* - AT90USB646
|
|
* - ATMEGA32U6
|
|
* - ATMEGA32U4
|
|
* - ATMEGA16U4
|
|
* - AT90USB162
|
|
* - AT90USB82
|
|
*
|
|
* \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>
|
|
*/ |