Bootloaders/CDC/BootloaderCDC.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage CDC Class USB AVR Bootloader
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following table indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - AT90USB1287
  14  *  - AT90USB1286
  15  *  - AT90USB647
  16  *  - AT90USB646
  17  *  - ATMEGA32U6
  18  *  - ATMEGA32U4
  19  *  - ATMEGA16U4
  20  *  - AT90USB162
  21  *
  22  *  \section SSec_Info USB Information:
  23  *
  24  *  The following table gives a rundown of the USB utilization of this demo.
  25  *
  26  * <table>
  27  *  <tr>
  28  *   <td><b>USB Mode:</b></td>
  29  *   <td>Device</td>
  30  *  </tr>
  31  *  <tr>
  32  *   <td><b>USB Class:</b></td>
  33  *   <td>Communications Device Class (CDC)</td>
  34  *  </tr>
  35  *  <tr>
  36  *   <td><b>USB Subclass:</b></td>
  37  *   <td>Abstract Control Model (ACM)</td>
  38  *  </tr>
  39  *  <tr>
  40  *   <td><b>Relevant Standards:</b></td>
  41  *   <td>USBIF CDC Class Standard</td>
  42  *  </tr>
  43  *  <tr>
  44  *   <td><b>Usable Speeds:</b></td>
  45  *   <td>Full Speed Mode</td>
  46  *  </tr>
  47  * </table>
  48  *
  49  *  \section SSec_Description Project Description:
  50  *
  51  * This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
  52  * protocol compatible programming software to load firmware onto the AVR.
  53  *
  54  * Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If
  55  * you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
  56  * values in the accompanying makefile.
  57  *
  58  * This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.
  59  *
  60  *  \section SSec_Options Project Options
  61  *
  62  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  63  *
  64  *  <table>
  65  *   <tr>
  66  *    <td><b>Define Name:</b></td>
  67  *    <td><b>Location:</b></td>
  68  *    <td><b>Description:</b></td>
  69  *   </tr>
  70  *  </table>
  71  */