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_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs
  14  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs
  16  *  - Series 2 USB AVRs (Excluding the 8KB FLASH variants)
  17  *
  18  *  \section SSec_Info USB Information:
  19  *
  20  *  The following table gives a rundown of the USB utilization of this demo.
  21  *
  22  * <table>
  23  *  <tr>
  24  *   <td><b>USB Mode:</b></td>
  25  *   <td>Device</td>
  26  *  </tr>
  27  *  <tr>
  28  *   <td><b>USB Class:</b></td>
  29  *   <td>Device Firmware Update Class (DFU)</td>
  30  *  </tr>
  31  *  <tr>
  32  *   <td><b>USB Subclass:</b></td>
  33  *   <td>None</td>
  34  *  </tr>
  35  *  <tr>
  36  *   <td><b>Relevant Standards:</b></td>
  37  *   <td>USBIF DFU Class Standard, Atmel USB Bootloader Datasheet</td>
  38  *  </tr>
  39  *  <tr>
  40  *   <td><b>Usable Speeds:</b></td>
  41  *   <td>Full Speed Mode</td>
  42  *  </tr>
  43  * </table>
  44  *
  45  *  \section SSec_Description Project Description:
  46  *
  47  *  This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
  48  *  software to load firmware onto the AVR.
  49  *
  50  *  This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's
  51  *  DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader. If you are
  52  *  using a 64 bit Windows OS, you will need to either disable the driver signing requirement (see online
  53  *  tutorials for details) or use a digitally signed version of the official Atmel driver provided by a
  54  *  third party AVR user at
  55  *  <a>http://www.avrfreaks.net/index.php?module=Freaks%20Academy&func=viewItem&item_id=2196&item_type=project</a>.
  56  *
  57  *  As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
  58  *  software, available for download at <a>http://sourceforge.net/projects/dfu-programmer/</a>.
  59  *
  60  *  If SECURE_MODE is defined as true, upon start-up the bootloader will be locked, with only the chip erase
  61  *  function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
  62  *  are usable on start-up without the prerequisite firmware erase.
  63  *
  64  *  Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If
  65  *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
  66  *  values in the accompanying makefile.
  67  *
  68  *  <b>NOTE:</b> This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader
  69  *               drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
  70  *               manually change them in Descriptors.c and alter your driver's INF file accordingly.
  71  *
  72  *  \section SSec_Options Project Options
  73  *
  74  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  75  *
  76  *  <table>
  77  *   <tr>
  78  *    <td><b>Define Name:</b></td>
  79  *    <td><b>Location:</b></td>
  80  *    <td><b>Description:</b></td>
  81  *   </tr>
  82  *   <tr>
  83  *    <td>SECURE_MODE</td>
  84  *    <td>BootloaderDFU.h</td>
  85  *    <td>If defined to true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an
  86  *        erase has been performed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
  87  *        being dumped by unauthorized persons.</td>
  88  *   </tr>
  89  *  </table>
  90  */