QMK/lib/lufa/Demos/Device/LowLevel/BulkVendor/BulkVendor.txt

70 lines
1.8 KiB
Plaintext
Raw Normal View History

2020-03-23 10:48:11 +01:00
/** \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 Bulk Vendor Device Demo
*
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* \li Series 7 USB AVRs (AT90USBxxx7)
* \li Series 6 USB AVRs (AT90USBxxx6)
* \li Series 4 USB AVRs (ATMEGAxxU4)
* \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
* \li Series B XMEGA AVRs (ATXMEGAxxxBx)
* \li Series C XMEGA AVRs (ATXMEGAxxxCx)
*
* \section Sec_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>Vendor (no official class)</td>
* </tr>
* <tr>
* <td><b>USB Subclass:</b></td>
* <td>Vendor (no official subclass)</td>
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
* <td>None</td>
* </tr>
* <tr>
* <td><b>Supported USB Speeds:</b></td>
* <td>Full Speed Mode</td>
* </tr>
* </table>
*
* \section Sec_Description Project Description:
*
* Bulk Vendor demonstration application. This gives a simple reference
* application for implementing a USB device that contains read/write bulk type
* endpoints, for implementing custom USB protocols.
*
* On start-up the system will automatically enumerate and echo back packets
* sent from the host.
*
* \section Sec_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>
*/