From 7cac5e22d7fae140b3ae4167a706d0dc07b9cf3b Mon Sep 17 00:00:00 2001 From: Dean Camera <dean@fourwalledcubicle.com> Date: Thu, 29 Mar 2012 19:35:40 +0000 Subject: [PATCH] Added additional bootloader API data to expose the bootloader start address and class to the DFU and CDC class bootloaders. --- Bootloaders/CDC/BootloaderAPITable.S | 8 +++++-- Bootloaders/CDC/BootloaderCDC.txt | 35 +++++++++++++++++----------- Bootloaders/CDC/makefile | 2 +- Bootloaders/DFU/BootloaderAPITable.S | 8 +++++-- Bootloaders/DFU/BootloaderDFU.txt | 34 +++++++++++++++++---------- Bootloaders/DFU/makefile | 2 +- LUFA/DoxygenPages/ChangeLog.txt | 1 + 7 files changed, 59 insertions(+), 31 deletions(-) diff --git a/Bootloaders/CDC/BootloaderAPITable.S b/Bootloaders/CDC/BootloaderAPITable.S index b1d1b0571..1ad8e28d1 100644 --- a/Bootloaders/CDC/BootloaderAPITable.S +++ b/Bootloaders/CDC/BootloaderAPITable.S @@ -43,6 +43,10 @@ BootloaderAPI_JumpTable: rjmp BootloaderAPI_ReadLock rjmp BootloaderAPI_WriteLock -; Bootloader table signature +; Bootloader table signatures and information +.org 24 + .long BOOT_START_ADDR ; Start address of the bootloader +.org 28 + .word 0xCDC1 ; Signature for the CDC class bootloader, V1 .org 30 - .word 0xDCFB + .word 0xDCFB ; Signature for a LUFA class bootloader diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt index a3027a9f2..d6ab94516 100644 --- a/Bootloaders/CDC/BootloaderCDC.txt +++ b/Bootloaders/CDC/BootloaderCDC.txt @@ -95,22 +95,31 @@ * following layout: * * \code - * #define BOOTLOADER_API_START(Index) (void*)(((FLASHEND - 32) + (2 * Index)) / 2) - * void (*BootloaderAPI_ErasePage)(uint32_t Address) = BOOTLOADER_API_START(0); - * void (*BootloaderAPI_WritePage)(uint32_t Address) = BOOTLOADER_API_START(1); - * void (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_START(2); - * uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_START(3); - * uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address) = BOOTLOADER_API_START(4); - * uint8_t (*BootloaderAPI_ReadLock)(void) = BOOTLOADER_API_START(5); - * void (*BootloaderAPI_WriteLock)(uint8_t LockBits) = BOOTLOADER_API_START(6); - * - * #define BOOTLOADER_SIG_START (FLASHEND - 32) - * #define BOOTLOADER_SIGNATURE 0xDCFB + * #define BOOTLOADER_API_CALL(Index) (void*)(((FLASHEND - 32) + (2 * Index)) / 2) + * + * void (*BootloaderAPI_ErasePage)(uint32_t Address) = BOOTLOADER_API_CALL(0); + * void (*BootloaderAPI_WritePage)(uint32_t Address) = BOOTLOADER_API_CALL(1); + * void (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2); + * uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_CALL(3); + * uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address) = BOOTLOADER_API_CALL(4); + * uint8_t (*BootloaderAPI_ReadLock)(void) = BOOTLOADER_API_CALL(5); + * void (*BootloaderAPI_WriteLock)(uint8_t LockBits) = BOOTLOADER_API_CALL(6); + * + * #define BOOTLOADER_MAGIC_SIGNATURE_START (FLASHEND - 2) + * #define BOOTLOADER_MAGIC_SIGNATURE 0xDCFB + * + * #define BOOTLOADER_CLASS_SIGNATURE_START (FLASHEND - 4) + * #define BOOTLOADER_CDC_SIGNATURE 0xCDC1 + * + * #define BOOTLOADER_ADDRESS_START (FLASHEND - 8) + * #define BOOTLOADER_ADDRESS_LENGTH 4 * \endcode * * Bootloaders reporting a device release revision number of 1.00 or greater are bootloader API enabled. From the application - * the API support of the bootloader can be detected by reading the FLASH memory bytes located at address \c BOOTLOADER_SIG_START - * and comparing them to the value \c BOOTLOADER_SIGNATURE. + * 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 memory starting from address \c BOOTLOADER_ADDRESS_START. * * \section Sec_Options Project Options * diff --git a/Bootloaders/CDC/makefile b/Bootloaders/CDC/makefile index 67f8ec364..9f437d751 100644 --- a/Bootloaders/CDC/makefile +++ b/Bootloaders/CDC/makefile @@ -207,7 +207,7 @@ CDEFS += $(LUFA_OPTS) ADEFS = -DF_CPU=$(F_CPU) ADEFS += -DF_USB=$(F_USB)UL ADEFS += -DBOARD=BOARD_$(BOARD) -ADEFS += -DBOOT_START_ADDR=$(BOOT_START)UL +ADEFS += -DBOOT_START_ADDR=$(BOOT_START) ADEFS += $(LUFA_OPTS) diff --git a/Bootloaders/DFU/BootloaderAPITable.S b/Bootloaders/DFU/BootloaderAPITable.S index b1d1b0571..a7d479a70 100644 --- a/Bootloaders/DFU/BootloaderAPITable.S +++ b/Bootloaders/DFU/BootloaderAPITable.S @@ -43,6 +43,10 @@ BootloaderAPI_JumpTable: rjmp BootloaderAPI_ReadLock rjmp BootloaderAPI_WriteLock -; Bootloader table signature +; Bootloader table signatures and information +.org 24 + .long BOOT_START_ADDR ; Start address of the bootloader +.org 28 + .word 0xDFB1 ; Signature for the DFU class bootloader, V1 .org 30 - .word 0xDCFB + .word 0xDCFB ; Signature for a LUFA class bootloader diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index 110d361b6..d0811b2aa 100644 --- a/Bootloaders/DFU/BootloaderDFU.txt +++ b/Bootloaders/DFU/BootloaderDFU.txt @@ -100,21 +100,31 @@ * following layout: * * \code - * #define BOOTLOADER_API_START(Index) (void*)(((FLASHEND - 32) + (2 * Index)) / 2) - * void (*BootloaderAPI_ErasePage)(uint32_t Address) = BOOTLOADER_API_START(0); - * void (*BootloaderAPI_WritePage)(uint32_t Address) = BOOTLOADER_API_START(1); - * void (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_START(2); - * uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_START(3); - * uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address) = BOOTLOADER_API_START(4); - * uint8_t (*BootloaderAPI_ReadLock)(void) = BOOTLOADER_API_START(5); - * void (*BootloaderAPI_WriteLock)(uint8_t LockBits) = BOOTLOADER_API_START(6); - * - * #define BOOTLOADER_SIG_START (FLASHEND - 32) - * #define BOOTLOADER_SIGNATURE 0xDCFB + * #define BOOTLOADER_API_CALL(Index) (void*)(((FLASHEND - 32) + (2 * Index)) / 2) + * + * void (*BootloaderAPI_ErasePage)(uint32_t Address) = BOOTLOADER_API_CALL(0); + * void (*BootloaderAPI_WritePage)(uint32_t Address) = BOOTLOADER_API_CALL(1); + * void (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2); + * uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_CALL(3); + * uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address) = BOOTLOADER_API_CALL(4); + * uint8_t (*BootloaderAPI_ReadLock)(void) = BOOTLOADER_API_CALL(5); + * void (*BootloaderAPI_WriteLock)(uint8_t LockBits) = BOOTLOADER_API_CALL(6); + * + * #define BOOTLOADER_MAGIC_SIGNATURE_START (FLASHEND - 2) + * #define BOOTLOADER_MAGIC_SIGNATURE 0xDCFB + * + * #define BOOTLOADER_CLASS_SIGNATURE_START (FLASHEND - 4) + * #define BOOTLOADER_DFU_SIGNATURE 0xDFB1 + * + * #define BOOTLOADER_ADDRESS_START (FLASHEND - 8) + * #define BOOTLOADER_ADDRESS_LENGTH 4 * \endcode * * From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address - * \c BOOTLOADER_SIG_START and comparing them to the value \c BOOTLOADER_SIGNATURE. + * \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 + * memory starting from address \c BOOTLOADER_ADDRESS_START. * * \section Sec_Options Project Options * diff --git a/Bootloaders/DFU/makefile b/Bootloaders/DFU/makefile index 56f55ac0f..347103847 100644 --- a/Bootloaders/DFU/makefile +++ b/Bootloaders/DFU/makefile @@ -202,7 +202,7 @@ CDEFS += $(LUFA_OPTS) ADEFS = -DF_CPU=$(F_CPU) ADEFS += -DF_USB=$(F_USB)UL ADEFS += -DBOARD=BOARD_$(BOARD) -ADEFS += -DBOOT_START_ADDR=$(BOOT_START)UL +ADEFS += -DBOOT_START_ADDR=$(BOOT_START) ADEFS += $(LUFA_OPTS) diff --git a/LUFA/DoxygenPages/ChangeLog.txt b/LUFA/DoxygenPages/ChangeLog.txt index 6e818a10e..20b190675 100644 --- a/LUFA/DoxygenPages/ChangeLog.txt +++ b/LUFA/DoxygenPages/ChangeLog.txt @@ -33,6 +33,7 @@ * - Fixed error in the AVRISP-MKII programmer when ISP mode is used at 64KHz (thanks to Ben R. Porter) * - Fixed AVRISP-MKII programmer project failing to compile for the U4 chips when VTARGET_ADC_CHANNEL is defined to an invalid channel and NO_VTARGET_DETECT is * defined (thanks to Steven Morehouse) + * - Added additional bootloader API data to expose the bootloader start address and class to the DFU and CDC class bootloaders * * \section Sec_ChangeLog120219 Version 120219 * <b>New:</b> -- GitLab