Cleanup USBMode.h to simplify preprocessor logic.

[pub/lufa.git] / Bootloaders / DFU / BootloaderDFU.txt

diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt
index 091ce40..ca2f165 100644 (file)
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@@ -5,27 +5,23 @@
  */\r
  \r
 /** \mainpage DFU Class USB AVR Bootloader\r
- *  \r
- *  This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming\r
- *  software to load firmware onto the AVR.\r
- *  \r
- *  This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's\r
- *  DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader.\r
- *  \r
- *  As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer\r
- *  software, available for download at http://sourceforge.net/projects/dfu-programmer/.\r
- *  \r
- *  If SECURE_MODE is defined as true, upon startup the bootloader will be locked, with only the chip erase\r
- *  function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions \r
- *  are usable on startup without the prerequisite firmware erase.\r
- *  \r
- *  Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If\r
- *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU\r
- *  values in the accompanying makefile.\r
- *  \r
- *  <b>NOTE:</b> This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader\r
- *               drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please\r
- *               manually change them in Descriptors.c and alter your driver's INF file accordingly.\r
+ *\r
+ *  \section SSec_Compat Demo Compatibility:\r
+ *\r
+ *  The following table indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - AT90USB1287\r
+ *  - AT90USB1286\r
+ *  - AT90USB647\r
+ *  - AT90USB646\r
+ *  - ATMEGA32U6\r
+ *  - ATMEGA32U4\r
+ *  - ATMEGA16U4\r
+ *  - AT90USB162\r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
  *\r
  * <table>\r
  *  <tr>\r
@@ -49,4 +45,46 @@
  *   <td>Full Speed Mode</td>\r
  *  </tr>\r
  * </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
+ *  This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming\r
+ *  software to load firmware onto the AVR.\r
+ *  \r
+ *  This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's\r
+ *  DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader.\r
+ *  \r
+ *  As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer\r
+ *  software, available for download at http://sourceforge.net/projects/dfu-programmer/.\r
+ *  \r
+ *  If SECURE_MODE is defined as true, upon start-up the bootloader will be locked, with only the chip erase\r
+ *  function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions \r
+ *  are usable on start-up without the prerequisite firmware erase.\r
+ *  \r
+ *  Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If\r
+ *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU\r
+ *  values in the accompanying makefile.\r
+ *  \r
+ *  <b>NOTE:</b> This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader\r
+ *               drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please\r
+ *               manually change them in Descriptors.c and alter your driver's INF file accordingly.\r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>SECURE_MODE</td>\r
+ *    <td>BootloaderDFU.h</td>\r
+ *    <td>If defined to true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an\r
+ *        erase has been performed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from\r
+ *        being dumped by unauthorized persons.</td>\r
+ *   </tr>\r
+ *  </table>\r
  */\r