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