mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-06-09 18:34:15 +00:00
dc68de15b6
Fix up demo documentation device compatibility list to be as general as possible to reduce changes required as Atmel releases more devices within the same USB AVR series.
68 lines
2.1 KiB
Plaintext
68 lines
2.1 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 Keyboard Host With HID Descriptor Parser Demo
|
|
*
|
|
* \section SSec_Compat Demo Compatibility:
|
|
*
|
|
* The following list indicates what microcontrollers are compatible with this demo.
|
|
*
|
|
* - Series 7 USB AVRs
|
|
*
|
|
* \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:
|
|
*
|
|
* Keyboard host demonstration application. This gives a simple reference
|
|
* application for implementing a USB Keyboard host, for USB keyboards using
|
|
* the standard Keyboard HID profile. It uses a HID parser for the HID reports,
|
|
* allowing for correct operation across all USB keyboards. This demo supports
|
|
* keyboards with a single HID report.
|
|
*
|
|
* Pressed alpha-numeric, enter or space key is transmitted through the serial
|
|
* USART at serial settings 9600, 8, N, 1. On connection to a USB keyboard, the
|
|
* report items will be processed and printed as a formatted list through the
|
|
* USART before the keyboard is fully enumerated.
|
|
*
|
|
* Currently only single interface keyboards 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>
|
|
*/ |