X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/619b0b7b6b44e4422ea9aeb0cde41343bb5dda70..ec537fd84d6ad3fd0dfa1b55efa2c2d554c1db48:/Bootloaders/DFU/BootloaderDFU.txt
diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt
index eb6495e6e..38f83a6f4 100644
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@@ -1,84 +1,91 @@
-/** \file
- *
- * This file contains special DoxyGen information for the generation of the main page and other special
- * documentation pages. It is not a project source file.
- */
-
-/** \mainpage DFU Class USB AVR Bootloader
- *
- * \section SSec_Info USB Information:
- *
- * The following table gives a rundown of the USB utilization of this demo.
- *
- *
- *
- * | USB Mode: |
- * Device |
- *
- *
- * | USB Class: |
- * Device Firmware Update Class (DFU) |
- *
- *
- * | USB Subclass: |
- * None |
- *
- *
- * | Relevant Standards: |
- * USBIF DFU Class Standard, Atmel USB Bootloader Datasheet |
- *
- *
- * | Usable Speeds: |
- * Full Speed Mode |
- *
- *
- *
- * \section SSec_Description Project Description:
- *
- * This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
- * software to load firmware onto the AVR.
- *
- * This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's
- * DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader.
- *
- * As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
- * software, available for download at http://sourceforge.net/projects/dfu-programmer/.
- *
- * If SECURE_MODE is defined as true, upon start-up the bootloader will be locked, with only the chip erase
- * function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
- * are usable on start-up without the prerequisite firmware erase.
- *
- * Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If
- * you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
- * values in the accompanying makefile.
- *
- * NOTE: This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader
- * drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
- * manually change them in Descriptors.c and alter your driver's INF file accordingly.
- *
- * \section SSec_Options Project Options
- *
- * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
- *
- *
- *
- * | Define Name: |
- * Location: |
- * Description: |
- *
- *
- * | SECURE_MODE |
- * BootloaderDFU.h |
- * If defined to true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an
- * erase has been performed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
- * being dumped by unauthorized persons. |
- *
- *
- * | SIGNATURE_0, SIGNATURE_1, SIGNATURE_2 |
- * Makefile CDEFS |
- * AVR part signature bytes. These are normally defined as part of the AVR device header files in recent avr-libc
- * distributions. If your avr-libc library is out of date and does not define these values, you can define them
- * manually in the makefile CDEFS. |
- *
- *
- */
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage DFU Class USB AVR Bootloader
+ *
+ * \section SSec_Compat Demo Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this demo.
+ *
+ * - Series 7 USB AVRs (AT90USBxxx7)
+ * - Series 6 USB AVRs (AT90USBxxx6)
+ * - Series 4 USB AVRs (ATMEGAxxU4)
+ * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
+ *
+ *
+ * | USB Mode: |
+ * Device |
+ *
+ *
+ * | USB Class: |
+ * Device Firmware Update Class (DFU) |
+ *
+ *
+ * | USB Subclass: |
+ * None |
+ *
+ *
+ * | Relevant Standards: |
+ * USBIF DFU Class Standard, Atmel USB Bootloader Datasheet |
+ *
+ *
+ * | Usable Speeds: |
+ * Full Speed Mode |
+ *
+ *
+ *
+ * \section SSec_Description Project Description:
+ *
+ * This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
+ * software to load firmware onto the AVR.
+ *
+ * This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's
+ * DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader. If you are
+ * using a 64 bit Windows OS, you will need to either disable the driver signing requirement (see online
+ * tutorials for details) or use a digitally signed version of the official Atmel driver provided by a
+ * third party AVR user at
+ * http://www.avrfreaks.net/index.php?module=Freaks%20Academy&func=viewItem&item_id=2196&item_type=project.
+ *
+ * As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
+ * software, available for download at http://sourceforge.net/projects/dfu-programmer/.
+ *
+ * If SECURE_MODE is defined as true, upon start-up the bootloader will be locked, with only the chip erase
+ * function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
+ * are usable on start-up without the prerequisite firmware erase.
+ *
+ * Out of the box this bootloader builds for the USB1287, and should fit into 4KB of bootloader space. If
+ * you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
+ * values in the accompanying makefile.
+ *
+ * NOTE: This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader
+ * drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
+ * manually change them in Descriptors.c and alter your driver's INF file accordingly.
+ *
+ * \section SSec_Options Project Options
+ *
+ * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *
+ *
+ * | Define Name: |
+ * Location: |
+ * Description: |
+ *
+ *
+ * | SECURE_MODE |
+ * BootloaderDFU.h |
+ * If defined to true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an
+ * erase has been performed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
+ * being dumped by unauthorized persons. |
+ *
+ *
+ */
+