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  *  This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
  10  *  software to load firmware onto the AVR.
  11  *
  12  *  This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's
  13  *  DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader.
  14  *
  15  *  As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
  16  *  software, available for download at http://sourceforge.net/projects/dfu-programmer/.
  17  *
  18  *  If SECURE_MODE is defined as true, upon startup the bootloader will be locked, with only the chip erase
  19  *  function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
  20  *  are usable on startup without the prerequisite firmware erase.
  21  *
  22  *  Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If
  23  *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
  24  *  values in the accompanying makefile.
  25  *
  26  *  <b>NOTE:</b> This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader
  27  *               drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
  28  *               manually change them in Descriptors.c and alter your driver's INF file accordingly.
  29  *
  30  * <table>
  31  *  <tr>
  32  *   <td><b>USB Mode:</b></td>
  33  *   <td>Device</td>
  34  *  </tr>
  35  *  <tr>
  36  *   <td><b>USB Class:</b></td>
  37  *   <td>Device Firmware Update Class (DFU)</td>
  38  *  </tr>
  39  *  <tr>
  40  *   <td><b>USB Subclass:</b></td>
  41  *   <td>None</td>
  42  *  </tr>
  43  *  <tr>
  44  *   <td><b>Relevant Standards:</b></td>
  45  *   <td>USBIF DFU Class Standard, Atmel USB Bootloader Datasheet</td>
  46  *  </tr>
  47  *  <tr>
  48  *   <td><b>Usable Speeds:</b></td>
  49  *   <td>Full Speed Mode</td>
  50  *  </tr>
  51  * </table>
  52  */