From 4c637c93ba69e33c77034eef9bd4433252e139fc Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Sat, 11 Oct 2014 16:43:41 +1100
Subject: [PATCH] Add Leonardo compatibility to most bootloaders, run user
application if BOOTRST fuse is set and the last reset cause was not the
/RESET pin.
---
Bootloaders/CDC/BootloaderCDC.c | 35 +++++++++++++------
Bootloaders/CDC/BootloaderCDC.txt | 24 +++++++++++--
Bootloaders/DFU/BootloaderDFU.c | 35 +++++++++++++------
Bootloaders/DFU/BootloaderDFU.txt | 14 ++++++--
.../MassStorage/BootloaderMassStorage.c | 27 ++++++++------
.../MassStorage/BootloaderMassStorage.txt | 14 ++++++--
Bootloaders/Printer/BootloaderPrinter.c | 27 ++++++++------
Bootloaders/Printer/BootloaderPrinter.txt | 24 +++++++++++--
LUFA/DoxygenPages/ChangeLog.txt | 4 ++-
9 files changed, 149 insertions(+), 55 deletions(-)
diff --git a/Bootloaders/CDC/BootloaderCDC.c b/Bootloaders/CDC/BootloaderCDC.c
index c7eeb929a..1f076530d 100644
--- a/Bootloaders/CDC/BootloaderCDC.c
+++ b/Bootloaders/CDC/BootloaderCDC.c
@@ -72,7 +72,17 @@ void Application_Jump_Check(void)
{
bool JumpToApplication = false;
- #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
+ #if (BOARD == BOARD_LEONARDO)
+ /* Enable pull-up on the IO13 pin so we can use it to select the mode */
+ PORTC |= (1 << 7);
+ Delay_MS(10);
+
+ /* If IO13 is not jumpered to ground, start the user application instead */
+ JumpToApplication = ((PINC & (1 << 7)) != 0);
+
+ /* Disable pull-up after the check has completed */
+ PORTC &= ~(1 << 7);
+ #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
/* Disable JTAG debugging */
JTAG_DISABLE();
@@ -81,25 +91,30 @@ void Application_Jump_Check(void)
Delay_MS(10);
/* If the TCK pin is not jumpered to ground, start the user application instead */
- JumpToApplication |= ((PINF & (1 << 4)) != 0);
+ JumpToApplication = ((PINF & (1 << 4)) != 0);
/* Re-enable JTAG debugging */
JTAG_ENABLE();
- #endif
+ #else
+ /* Check if the device's BOOTRST fuse is set */
+ if (boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS) & FUSE_BOOTRST)
+ {
+ /* If the reset source was not an external reset or the key is correct, clear it and jump to the application */
+ if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY))
+ JumpToApplication = true;
- /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
- if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
- JumpToApplication |= true;
+ MCUSR &= ~(1 << EXTRF);
+ }
+ #endif
/* Don't run the user application if the reset vector is blank (no app loaded) */
- if (pgm_read_word_near(0) == 0xFFFF)
- JumpToApplication = false;
+ bool ApplicationValid = (pgm_read_word_near(0) != 0xFFFF);
/* If a request has been made to jump to the user application, honor it */
- if (JumpToApplication)
+ if (JumpToApplication && ApplicationValid)
{
/* Turn off the watchdog */
- MCUSR &= ~(1<<WDRF);
+ MCUSR &= ~(1 << WDRF);
wdt_disable();
/* Clear the boot key and jump to the user application */
diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt
index 55e5e55a4..5f24a16e5 100644
--- a/Bootloaders/CDC/BootloaderCDC.txt
+++ b/Bootloaders/CDC/BootloaderCDC.txt
@@ -59,9 +59,27 @@
*
* \section Sec_Running Running the Bootloader
*
- * This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device
- * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST
- * fuse is cleared.
+ * 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:
+ *
+ * <b>If the device's BOOTRST fuse is set</b>, the bootloader will run any time the system is not 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.
+ *
+ * <b>If the device's BOOTRST fuse is not set</b>, 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.
*
* For board specific exceptions to the above, see below.
*
diff --git a/Bootloaders/DFU/BootloaderDFU.c b/Bootloaders/DFU/BootloaderDFU.c
index 160b9f657..cebc0f433 100644
--- a/Bootloaders/DFU/BootloaderDFU.c
+++ b/Bootloaders/DFU/BootloaderDFU.c
@@ -108,7 +108,17 @@ void Application_Jump_Check(void)
{
bool JumpToApplication = false;
- #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
+ #if (BOARD == BOARD_LEONARDO)
+ /* Enable pull-up on the IO13 pin so we can use it to select the mode */
+ PORTC |= (1 << 7);
+ Delay_MS(10);
+
+ /* If IO13 is not jumpered to ground, start the user application instead */
+ JumpToApplication = ((PINC & (1 << 7)) != 0);
+
+ /* Disable pull-up after the check has completed */
+ PORTC &= ~(1 << 7);
+ #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
/* Disable JTAG debugging */
JTAG_DISABLE();
@@ -117,25 +127,30 @@ void Application_Jump_Check(void)
Delay_MS(10);
/* If the TCK pin is not jumpered to ground, start the user application instead */
- JumpToApplication |= ((PINF & (1 << 4)) != 0);
+ JumpToApplication = ((PINF & (1 << 4)) != 0);
/* Re-enable JTAG debugging */
JTAG_ENABLE();
- #endif
+ #else
+ /* Check if the device's BOOTRST fuse is set */
+ if (boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS) & FUSE_BOOTRST)
+ {
+ /* If the reset source was not an external reset or the key is correct, clear it and jump to the application */
+ if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY))
+ JumpToApplication = true;
- /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
- if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
- JumpToApplication |= true;
+ MCUSR &= ~(1 << EXTRF);
+ }
+ #endif
/* Don't run the user application if the reset vector is blank (no app loaded) */
-
- JumpToApplication = false;
+ bool ApplicationValid = (pgm_read_word_near(0) != 0xFFFF);
/* If a request has been made to jump to the user application, honor it */
- if (JumpToApplication)
+ if (JumpToApplication && ApplicationValid)
{
/* Turn off the watchdog */
- MCUSR &= ~(1<<WDRF);
+ MCUSR &= ~(1 << WDRF);
wdt_disable();
/* Clear the boot key and jump to the user application */
diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt
index e63bcc1f0..d0bb6e120 100644
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@@ -57,9 +57,17 @@
*
* \section Sec_Running Running the Bootloader
*
- * This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device
- * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST
- * fuse is cleared.
+ * 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:
+ *
+ * <b>If the device's BOOTRST fuse is set</b>, the bootloader will run any time the system is not 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.
+ *
+ * <b>If the device's BOOTRST fuse is not set</b>, 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.
*
diff --git a/Bootloaders/MassStorage/BootloaderMassStorage.c b/Bootloaders/MassStorage/BootloaderMassStorage.c
index 191d49efc..afbc25014 100644
--- a/Bootloaders/MassStorage/BootloaderMassStorage.c
+++ b/Bootloaders/MassStorage/BootloaderMassStorage.c
@@ -91,11 +91,11 @@ void Application_Jump_Check(void)
#if (BOARD == BOARD_LEONARDO)
/* Enable pull-up on the IO13 pin so we can use it to select the mode */
- PORTC |= (1 << 7);
+ PORTC |= (1 << 7);
Delay_MS(10);
/* If IO13 is not jumpered to ground, start the user application instead */
- JumpToApplication |= ((PINC & (1 << 7)) != 0);
+ JumpToApplication = ((PINC & (1 << 7)) != 0);
/* Disable pull-up after the check has completed */
PORTC &= ~(1 << 7);
@@ -108,25 +108,30 @@ void Application_Jump_Check(void)
Delay_MS(10);
/* If the TCK pin is not jumpered to ground, start the user application instead */
- JumpToApplication |= ((PINF & (1 << 4)) != 0);
+ JumpToApplication = ((PINF & (1 << 4)) != 0);
/* Re-enable JTAG debugging */
JTAG_ENABLE();
+ #else
+ /* Check if the device's BOOTRST fuse is set */
+ if (boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS) & FUSE_BOOTRST)
+ {
+ /* If the reset source was not an external reset or the key is correct, clear it and jump to the application */
+ if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY))
+ JumpToApplication = true;
+
+ MCUSR &= ~(1 << EXTRF);
+ }
#endif
- /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
- if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
- JumpToApplication |= true;
-
/* Don't run the user application if the reset vector is blank (no app loaded) */
- if (pgm_read_word_near(0) == 0xFFFF)
- JumpToApplication = false;
+ bool ApplicationValid = (pgm_read_word_near(0) != 0xFFFF);
/* If a request has been made to jump to the user application, honor it */
- if (JumpToApplication)
+ if (JumpToApplication && ApplicationValid)
{
/* Turn off the watchdog */
- MCUSR &= ~(1<<WDRF);
+ MCUSR &= ~(1 << WDRF);
wdt_disable();
/* Clear the boot key and jump to the user application */
diff --git a/Bootloaders/MassStorage/BootloaderMassStorage.txt b/Bootloaders/MassStorage/BootloaderMassStorage.txt
index e09484793..467972cc4 100644
--- a/Bootloaders/MassStorage/BootloaderMassStorage.txt
+++ b/Bootloaders/MassStorage/BootloaderMassStorage.txt
@@ -62,9 +62,17 @@
*
* \section Sec_Running Running the Bootloader
*
- * This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device
- * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST
- * fuse is cleared.
+ * 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:
+ *
+ * <b>If the device's BOOTRST fuse is set</b>, the bootloader will run any time the system is not 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.
+ *
+ * <b>If the device's BOOTRST fuse is not set</b>, 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.
*
diff --git a/Bootloaders/Printer/BootloaderPrinter.c b/Bootloaders/Printer/BootloaderPrinter.c
index 716a23a1f..151d16f92 100644
--- a/Bootloaders/Printer/BootloaderPrinter.c
+++ b/Bootloaders/Printer/BootloaderPrinter.c
@@ -123,11 +123,11 @@ void Application_Jump_Check(void)
#if (BOARD == BOARD_LEONARDO)
/* Enable pull-up on the IO13 pin so we can use it to select the mode */
- PORTC |= (1 << 7);
+ PORTC |= (1 << 7);
Delay_MS(10);
/* If IO13 is not jumpered to ground, start the user application instead */
- JumpToApplication |= ((PINC & (1 << 7)) != 0);
+ JumpToApplication = ((PINC & (1 << 7)) != 0);
/* Disable pull-up after the check has completed */
PORTC &= ~(1 << 7);
@@ -140,25 +140,30 @@ void Application_Jump_Check(void)
Delay_MS(10);
/* If the TCK pin is not jumpered to ground, start the user application instead */
- JumpToApplication |= ((PINF & (1 << 4)) != 0);
+ JumpToApplication = ((PINF & (1 << 4)) != 0);
/* Re-enable JTAG debugging */
JTAG_ENABLE();
- #endif
+ #else
+ /* Check if the device's BOOTRST fuse is set */
+ if (boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS) & FUSE_BOOTRST)
+ {
+ /* If the reset source was not an external reset or the key is correct, clear it and jump to the application */
+ if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY))
+ JumpToApplication = true;
- /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
- if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
- JumpToApplication |= true;
+ MCUSR &= ~(1 << EXTRF);
+ }
+ #endif
/* Don't run the user application if the reset vector is blank (no app loaded) */
- if (pgm_read_word_near(0) == 0xFFFF)
- JumpToApplication = false;
+ bool ApplicationValid = (pgm_read_word_near(0) != 0xFFFF);
/* If a request has been made to jump to the user application, honor it */
- if (JumpToApplication)
+ if (JumpToApplication && ApplicationValid)
{
/* Turn off the watchdog */
- MCUSR &= ~(1<<WDRF);
+ MCUSR &= ~(1 << WDRF);
wdt_disable();
/* Clear the boot key and jump to the user application */
diff --git a/Bootloaders/Printer/BootloaderPrinter.txt b/Bootloaders/Printer/BootloaderPrinter.txt
index cfa51d4cf..99dc7d528 100644
--- a/Bootloaders/Printer/BootloaderPrinter.txt
+++ b/Bootloaders/Printer/BootloaderPrinter.txt
@@ -56,9 +56,27 @@
*
* \section Sec_Running Running the Bootloader
*
- * This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device
- * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST
- * fuse is cleared.
+ * 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:
+ *
+ * <b>If the device's BOOTRST fuse is set</b>, the bootloader will run any time the system is not 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.
+ *
+ * <b>If the device's BOOTRST fuse is not set</b>, 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
*
diff --git a/LUFA/DoxygenPages/ChangeLog.txt b/LUFA/DoxygenPages/ChangeLog.txt
index 57277ebee..647f62148 100644
--- a/LUFA/DoxygenPages/ChangeLog.txt
+++ b/LUFA/DoxygenPages/ChangeLog.txt
@@ -14,7 +14,9 @@
* - Library Applications:
* - The CDC, DFU, Mass Storage and Printer class bootloaders will no longer run the user application if the application reset
* vector is blank (thanks to Alex Kazik)
- * - The Printer class bootloader is now compatible with the original Atmel XPLAIN and Arduino Leonardo boards.
+ * - The CDC, DFU and Printer class bootloaders are now compatible with the original Atmel XPLAIN and Arduino Leonardo boards.
+ * - The CDC, DFU, Mass Storage and Printer class bootloaders are not compatible with devices with the BOOTRST fuse set and will
+ * exit automatically unless an external reset was the last reset cause (thanks to Alex Kazik)
*
* <b>Fixed:</b>
* - None.
--
GitLab