Bootloaders/DFU/BootloaderDFU.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 DFU 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>Device Firmware Update Class (DFU)</td>
  21  *  </tr>
  22  *  <tr>
  23  *   <td><b>USB Subclass:</b></td>
  24  *   <td>None</td>
  25  *  </tr>
  26  *  <tr>
  27  *   <td><b>Relevant Standards:</b></td>
  28  *   <td>USBIF DFU Class Standard, Atmel USB Bootloader Datasheet</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 DFU Class device, allowing for DFU-compatible programming
  39  *  software to load firmware onto the AVR.
  40  *
  41  *  This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's
  42  *  DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader.
  43  *
  44  *  As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
  45  *  software, available for download at http://sourceforge.net/projects/dfu-programmer/.
  46  *
  47  *  If SECURE_MODE is defined as true, upon start-up the bootloader will be locked, with only the chip erase
  48  *  function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
  49  *  are usable on start-up without the prerequisite firmware erase.
  50  *
  51  *  Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If
  52  *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
  53  *  values in the accompanying makefile.
  54  *
  55  *  <b>NOTE:</b> This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader
  56  *               drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
  57  *               manually change them in Descriptors.c and alter your driver's INF file accordingly.
  58  *
  59  *  \section SSec_Options Project Options
  60  *
  61  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  62  *
  63  *  <table>
  64  *   <tr>
  65  *    <td><b>Define Name:</b></td>
  66  *    <td><b>Location:</b></td>
  67  *    <td><b>Description:</b></td>
  68  *   </tr>
  69  *   <tr>
  70  *    <td>SECURE_MODE</td>
  71  *    <td>BootloaderDFU.h</td>
  72  *    <td>If defined to true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an
  73  *        erase has been performed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
  74  *        being dumped by unauthorized persons.</td>
  75  *   </tr>
  76  *   <tr>
  77  *    <td>SIGNATURE_0, SIGNATURE_1, SIGNATURE_2</td>
  78  *    <td>Makefile CDEFS</td>
  79  *    <td>AVR part signature bytes. These are normally defined as part of the AVR device header files in recent avr-libc
  80  *        distributions. If your avr-libc library is out of date and does not define these values, you can define them
  81  *        manually in the makefile CDEFS.</td>
  82  *   </tr>
  83  *  </table>
  84  */