mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-17 05:02:07 +00:00
61ff4824a9
Fix Benito documentation indicating erronously that the project used the HID USB class instead of the CDC class.
101 lines
3.0 KiB
Plaintext
101 lines
3.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 Benito Arduino Programmer Project
|
|
*
|
|
* \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>
|
|
* <td>Arduino Bootloader Specification</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td><b>Usable Speeds:</b></td>
|
|
* <td>Full Speed Mode</td>
|
|
* </tr>
|
|
* </table>
|
|
*
|
|
* \section SSec_Description Project Description:
|
|
*
|
|
* Firmware for a USB AVR powered programmer for Arduino boards using the official Arduino bootloader. This
|
|
* project acts like a regular USB to Serial bridge, except that asserting the DTR line will cause a pulse
|
|
* to appear on a given port pin, to control the target's /RESET pin.
|
|
*
|
|
* This is primarily designed to fit the Benito board from www.dorkbotpdx.org, but will suit all USB AVRs.
|
|
*
|
|
* \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>AVR_RESET_LINE_PORT</td>
|
|
* <td>Makefile CDEFS</td>
|
|
* <td>Indicates the PORT register of the pin used to generate the target /RESET line pulse.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td>AVR_RESET_LINE_DDR</td>
|
|
* <td>Makefile CDEFS</td>
|
|
* <td>Indicates the DDR register of the pin used to generate the target /RESET line pulse.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td>AVR_RESET_LINE_MASK</td>
|
|
* <td>Makefile CDEFS</td>
|
|
* <td>Indicates the mask of the pin used to generate the target /RESET line pulse.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td>AVR_RESET_PULSE_MS</td>
|
|
* <td>Makefile CDEFS</td>
|
|
* <td>Pulse length in milliseconds for the target /RESET pulse.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td>TX_RX_LED_PULSE_MS</td>
|
|
* <td>Makefile CDEFS</td>
|
|
* <td>Pulse length in milliseconds for the activity Tx/Rx LEDs.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td>PING_PONG_LED_PULSE_MS</td>
|
|
* <td>Makefile CDEFS</td>
|
|
* <td>Pulse length in milliseconds for the enumeration LED ping-poning between toggles.</td>
|
|
* </tr>
|
|
* </table>
|
|
*/
|