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_Info USB Information:
  10  *
  11  *  The following table gives a rundown of the USB utilization of this demo.
  12  *
  13  * <table>
  14  *  <tr>
  15  *   <td><b>USB Mode:</b></td>
  16  *   <td>Device</td>
  17  *  </tr>
  18  *  <tr>
  19  *   <td><b>USB Class:</b></td>
  20  *   <td>Communications Device Class (CDC)</td>
  21  *  </tr>
  22  *  <tr>
  23  *   <td><b>USB Subclass:</b></td>
  24  *   <td>Abstract Control Model (ACM)</td>
  25  *  </tr>
  26  *  <tr>
  27  *   <td><b>Relevant Standards:</b></td>
  28  *   <td>USBIF CDC Class Standard</td>
  29  *  </tr>
  30  *  <tr>
  31  *   <td><b>Usable Speeds:</b></td>
  32  *   <td>Full Speed Mode</td>
  33  *  </tr>
  34  * </table>
  35  *
  36  *  \section SSec_Description Project Description:
  37  *
  38  * This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
  39  * protocol compatible programming software to load firmware onto the AVR.
  40  *
  41  * Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If
  42  * you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
  43  * values in the accompanying makefile.
  44  *
  45  * This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.
  46  *
  47  *  \section SSec_Options Project Options
  48  *
  49  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  50  *
  51  *  <table>
  52  *   <tr>
  53  *    <td><b>Define Name:</b></td>
  54  *    <td><b>Location:</b></td>
  55  *    <td><b>Description:</b></td>
  56  *   </tr>
  57  *   <tr>
  58  *    <td>SIGNATURE_0, SIGNATURE_1, SIGNATURE_2</td>
  59  *    <td>Makefile CDEFS</td>
  60  *    <td>AVR part signature bytes. These are normally defined as part of the AVR device header files in recent avr-libc
  61  *        distributions. If your avr-libc library is out of date and does not define these values, you can define them
  62  *        manually in the makefile CDEFS.</td>
  63  *   </tr>
  64  *  </table>
  65  */