forked from mfulz_github/qmk_firmware

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.
69 lines
2.0 KiB
Plaintext
69 lines
2.0 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 Mouse Host With HID Descriptor Parser Demo
|
|
*
|
|
* \section SSec_Compat Demo Compatibility:
|
|
*
|
|
* The following table indicates what microcontrollers are compatible with this demo.
|
|
*
|
|
* - AT90USB1287
|
|
* - AT90USB1286
|
|
*
|
|
* \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>Host</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td><b>USB Class:</b></td>
|
|
* <td>Human Interface Device (HID)</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td><b>USB Subclass:</b></td>
|
|
* <td>N/A</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td><b>Relevant Standards:</b></td>
|
|
* <td>USBIF HID Specification, USBIF HID Usage Tables</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td><b>Usable Speeds:</b></td>
|
|
* <td>Low Speed Mode, Full Speed Mode</td>
|
|
* </tr>
|
|
* </table>
|
|
*
|
|
* \section SSec_Description Project Description:
|
|
*
|
|
* Mouse host demonstration application. This gives a simple reference
|
|
* application for implementing a USB Mouse host, for USB mice using
|
|
* the standard mouse HID profile. It uses a HID parser for the HID
|
|
* reports, allowing for correct operation across all USB mice. This
|
|
* demo supports mice with a single HID report.
|
|
*
|
|
* Mouse movement and button presses are displayed on the board LEDs.
|
|
* On connection to a USB mouse, the report items will be processed and
|
|
* printed as a formatted list through the USART before the mouse is
|
|
* fully enumerated.
|
|
*
|
|
* Currently only single interface mice are supported.
|
|
*
|
|
* \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>
|
|
*/ |