X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/c31fdbd03eee95660d65adb0f1bf7c0c397fd435..refs/heads/master:/Bootloaders/DFU/BootloaderDFU.txt diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index 13dd05b63..b2540a5b6 100644 --- a/Bootloaders/DFU/BootloaderDFU.txt +++ b/Bootloaders/DFU/BootloaderDFU.txt @@ -12,8 +12,8 @@ * * \li Series 7 USB AVRs (AT90USBxxx7) * \li Series 6 USB AVRs (AT90USBxxx6) - * \li Series 4 USB AVRs (ATMEGAxxU4) - * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) + * \li Series 4 USB AVRs (ATMEGAxxU4) - See \ref SSec_Aux_Space + * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - See \ref SSec_Aux_Space * * \section Sec_Info USB Information: * @@ -38,7 +38,8 @@ * * * Supported USB Speeds: - * Full Speed Mode + * Low Speed Mode \n + * Full Speed Mode * * * @@ -54,6 +55,30 @@ * When the bootloader is running, the board's LED(s) will flash at regular intervals to distinguish the * bootloader from the normal user application. * + * \section Sec_Running Running the Bootloader + * + * On the USB AVR8 devices, setting the \c HWBE device fuse will cause the bootloader to run if the \c HWB pin of + * the AVR is grounded when the device is reset. + * + * The are two behaviours of this bootloader, depending on the device's fuses: + * + * If the device's BOOTRST fuse is set, the bootloader will run any time the system is reset from + * the external reset pin, unless no valid user application has been loaded. To initiate the bootloader, the + * device's external reset pin should be grounded momentarily. + * + * If the device's BOOTRST fuse is not set, the bootloader will run only if initiated via a software + * jump, or if the \c HWB pin was low during the last device reset (if the \c HWBE fuse is set). + * + * For board specific exceptions to the above, see below. + * + * \subsection SSec_XPLAIN Atmel Xplain Board + * Ground the USB AVR JTAG's \c TCK pin to ground when powering on the board to start the bootloader. This assumes the + * \c HWBE fuse is cleared and the \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * + * \subsection SSec_Leonardo Arduino Leonardo Board + * Ground \c IO13 when powering the board to start the bootloader. This assumes the \c HWBE fuse is cleared and the + * \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * * \section Sec_Installation Driver Installation * * This bootloader is designed to be compatible with Atmel's provided Windows DFU class drivers. You will need to @@ -67,7 +92,7 @@ * manually change them in Descriptors.c and alter your driver's INF file accordingly. * * \section Sec_HostApp Host Controller Application - * + * * This bootloader is compatible with Atmel's FLIP utility on Windows machines, and dfu-programmer on Linux machines. * * \subsection SSec_FLIP FLIP (Windows) @@ -116,7 +141,7 @@ * #define BOOTLOADER_MAGIC_SIGNATURE 0xDCFB * * #define BOOTLOADER_CLASS_SIGNATURE_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4)) - * #define BOOTLOADER_CDC_SIGNATURE 0xDFB1 + * #define BOOTLOADER_DFU_SIGNATURE 0xDF10 * * #define BOOTLOADER_ADDRESS_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8)) * #define BOOTLOADER_ADDRESS_LENGTH 4 @@ -125,7 +150,7 @@ * From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address * \c BOOTLOADER_MAGIC_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader * can be determined by reading the FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them - * to the value \c BOOTLOADER_CDC_SIGNATURE. The start address of the bootloader can be retrieved by reading the bytes of FLASH + * to the value \c BOOTLOADER_DFU_SIGNATURE. The start address of the bootloader can be retrieved by reading the bytes of FLASH * memory starting from address \c BOOTLOADER_ADDRESS_START. * * \subsection SSec_API_MemLayout Device Memory Map @@ -149,6 +174,16 @@ * | | * | | * | | + * | | + * +----------------------------+ FLASHEND - BOOT_AUX_SECTION_SIZE + * | Booloader Start Trampoline | + * | (Not User App. Accessible) | + * +----------------------------+ FLASHEND - (BOOT_AUX_SECTION_SIZE - 4) + * | | + * | Auxillery Bootloader | + * | Space for Smaller Devices | + * | (Not User App. Accessible) | + * | | * +----------------------------+ FLASHEND - BOOT_SECTION_SIZE * | | * | Bootloader Application | @@ -166,22 +201,34 @@ * +----------------------------+ FLASHEND * \endverbatim * + * \subsection SSec_Aux_Space Auxiliary Bootloader Section + * To make the bootloader function on smaller devices (those with a physical + * bootloader section of smaller than 6KB) + * + * \section Sec_KnownIssues Known Issues: + * + * \par On Linux machines, the DFU bootloader is inaccessible. + * On many Linux systems, non-root users do not have automatic access to newly + * inserted DFU devices. Root privileges or a UDEV rule is required to gain + * access. + * See here for resolution steps. + * * \section Sec_Options Project Options * * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * * * - * - * - * + * + * + * * * * - * - * + * + * being dumped by unauthorized persons. When false, all memory operations are allowed at any time. * *
Define Name:Location:Description:Define Name:Location:Description:
SECURE_MODEBootloaderDFU.hIf defined to true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an + * AppConfig.hIf defined to \c 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.
*/