|
|
|
|
/** \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 CDC Class USB AVR Bootloader
|
|
|
|
|
*
|
|
|
|
|
* \section SSec_Compat Demo Compatibility:
|
|
|
|
|
*
|
|
|
|
|
* The following table indicates what microcontrollers are compatible with this demo.
|
|
|
|
|
*
|
|
|
|
|
* - AT90USB1287
|
|
|
|
|
* - AT90USB1286
|
|
|
|
|
* - AT90USB647
|
|
|
|
|
* - AT90USB646
|
|
|
|
|
* - ATMEGA32U6
|
|
|
|
|
* - ATMEGA32U4
|
|
|
|
|
* - ATMEGA16U4
|
|
|
|
|
* - AT90USB162
|
|
|
|
|
*
|
|
|
|
|
* \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:
|
|
|
|
|
*
|
|
|
|
|
* This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
|
|
|
|
|
* protocol compatible programming software to load firmware onto the AVR.
|
|
|
|
|
*
|
|
|
|
|
* Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If
|
|
|
|
|
* you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
|
|
|
|
|
* values in the accompanying makefile.
|
|
|
|
|
*
|
|
|
|
|
* This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.
|
|
|
|
|
*
|
|
|
|
|
* After running this bootloader for the first time on a new computer, you will need to supply the .INF
|
|
|
|
|
* file located in this bootloader 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.
|
|
|
|
|
*
|
|
|
|
|
* On 64 bit versions of Windows, the OS requires all drivers to be digitally signed before it will allow
|
|
|
|
|
* them to be installed. As Windows' own CDC driver (which the supplied INF file references) is not signed,
|
|
|
|
|
* you will need to reboot, press F8 before Windows begins to load and select "Disable Driver Signature
|
|
|
|
|
* Enforcement" to allow the CDC driver to install.
|
|
|
|
|
*
|
|
|
|
|
* \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>
|
|
|
|
|
* </table>
|
|
|
|
|
*/
|
