mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-06-11 19:34:17 +00:00
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.
82 lines
2.4 KiB
Plaintext
82 lines
2.4 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 USB to Serial Converter Demo (via CDC-ACM class)
|
|
*
|
|
* \section SSec_Compat Demo Compatibility:
|
|
*
|
|
* This demo is known to be compatible with the following microcontrollers:
|
|
*
|
|
* - 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 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>
|
|
*/ |