Merge pull request #128 from adafruit/self-uf2

Major upgrade to bootloader to decouple SoftDevice and self upgrade with uf2

Author: hathach

.github/workflows/githubci.yml

@@ -23,10 +23,7 @@ jobs:
 
     - name: Install Toolchains
       run: |
-        pip3 install adafruit-nrfutil uritemplate requests
-        wget https://www.nordicsemi.com/api/sitecore/Products/DownloadPlatform --post-data=fileid=8F19D314130548209E75EFFADD9348DB -O cli-tools.tar
-        tar -xv -f cli-tools.tar
-        echo "::add-path::$GITHUB_WORKSPACE/mergehex"
+        pip3 install adafruit-nrfutil uritemplate requests intelhex
         npm install --global xpm
         xpm install --global @xpack-dev-tools/arm-none-eabi-gcc@latest
         echo "::add-path::`echo $HOME/opt/xPacks/@xpack-dev-tools/arm-none-eabi-gcc/*/.content/bin`"

.gitignore

@@ -51,10 +51,11 @@ Module.symvers
 Mkfile.old
 dkms.conf
 
-src/segger/Output
-_build-*/
+segger/Output
+_build/
 bin/
 *.emSession
 *.jlink
+.idea/
 
 TAGS

.gitmodules

@@ -1,6 +1,10 @@
-[submodule "tinyusb"]
+[submodule "lib/tinyusb"]
 	path = lib/tinyusb
 	url = https://github.com/hathach/tinyusb.git
 [submodule "lib/nrfx"]
 	path = lib/nrfx
 	url = https://github.com/NordicSemiconductor/nrfx.git
+[submodule "lib/uf2"]
+	path = lib/uf2
+	url = https://github.com/microsoft/uf2.git
+

Makefile

@@ -17,8 +17,10 @@ SD_VERSION   = 6.1.1
 SD_FILENAME  = $(SD_NAME)_nrf52_$(SD_VERSION)
 SD_HEX       = $(SD_PATH)/$(SD_FILENAME)_softdevice.hex
 
-# linker by MCU and SoftDevice eg. nrf52840_s140_v6.ld
-LD_FILE      = linker/$(MCU_SUB_VARIANT)_$(SD_NAME)_v$(word 1, $(subst ., ,$(SD_VERSION))).ld
+MBR_HEX			 = lib/softdevice/mbr/hex/mbr_nrf52_2.4.1_mbr.hex
+
+# linker by MCU eg. nrf52840.ld
+LD_FILE      = linker/$(MCU_SUB_VARIANT).ld
 
 GIT_VERSION = $(shell git describe --dirty --always --tags)
 GIT_SUBMODULE_VERSIONS = $(shell git submodule status | cut -d' ' -f3,4 | paste -s -d" " -)
@@ -93,6 +95,9 @@ endif
 # all files in src
 C_SRC += $(wildcard src/*.c)
 
+# all files in boards
+C_SRC += $(wildcard src/boards/*.c)
+
 # all sources files in specific board
 C_SRC += $(wildcard src/boards/$(BOARD)/*.c)
 
@@ -162,11 +167,10 @@ ASM_SRC = $(NRFX_PATH)/mdk/gcc_startup_$(MCU_SUB_VARIANT).S
 
 # src
 IPATH += src
+IPATH += src/boards
 IPATH += src/boards/$(BOARD)
-
 IPATH += src/cmsis/include
 IPATH += src/usb
-IPATH += src/boards
 IPATH += $(TUSB_PATH)
 
 # nrfx
@@ -196,17 +200,17 @@ IPATH += $(SDK_PATH)/drivers_nrf/delay
 IPATH += $(SD_PATH)/$(SD_FILENAME)_API/include
 IPATH += $(SD_PATH)/$(SD_FILENAME)_API/include/nrf52
 
-INC_PATHS = $(addprefix -I,$(IPATH))
-
 #------------------------------------------------------------------------------
 # Compiler Flags
 #------------------------------------------------------------------------------
 
-# Debugging/Optimization
+# Debug option use RTT for printf
 ifeq ($(DEBUG), 1)
-	CFLAGS += -Og -ggdb
-else
-	CFLAGS += -Os
+	RTT_SRC = lib/SEGGER_RTT
+	
+	CFLAGS += -ggdb -DCFG_DEBUG -DSEGGER_RTT_MODE_DEFAULT=SEGGER_RTT_MODE_BLOCK_IF_FIFO_FULL
+	IPATH += $(RTT_SRC)/RTT
+  C_SRC += $(RTT_SRC)/RTT/SEGGER_RTT.c
 endif
 
 #flags common to all targets
@@ -216,6 +220,7 @@ CFLAGS += \
 	-mcpu=cortex-m4 \
 	-mfloat-abi=hard \
 	-mfpu=fpv4-sp-d16 \
+	-Os \
 	-ffunction-sections \
 	-fdata-sections \
 	-fno-builtin \
@@ -249,7 +254,7 @@ CFLAGS += -DCONFIG_NFCT_PINS_AS_GPIOS
 CFLAGS += -DSOFTDEVICE_PRESENT
 CFLAGS += -DDFU_APP_DATA_RESERVED=7*4096
 
-CFLAGS += -DUF2_VERSION='"$(GIT_VERSION) $(GIT_SUBMODULE_VERSIONS) $(SD_NAME) $(SD_VERSION)"'
+CFLAGS += -DUF2_VERSION='"$(GIT_VERSION) $(GIT_SUBMODULE_VERSIONS)"'
 CFLAGS += -DBLEDIS_FW_VERSION='"$(GIT_VERSION) $(SD_NAME) $(SD_VERSION)"'
 
 _VER = $(subst ., ,$(word 1, $(subst -, ,$(GIT_VERSION))))
@@ -289,6 +294,8 @@ vpath %.S $(ASM_PATHS)
 
 OBJECTS = $(C_OBJECTS) $(ASM_OBJECTS)
 
+INC_PATHS = $(addprefix -I,$(IPATH))
+
 #------------------------------------------------------------------------------
 # BUILD TARGETS
 #------------------------------------------------------------------------------
@@ -306,40 +313,11 @@ endif
 .PHONY: all clean flash dfu-flash sd gdbflash gdb
 
 # default target to build
-all: $(BUILD)/$(OUT_FILE)-nosd.out $(BUILD)/$(MERGED_FILE).hex
-
-#------------------- Flash target -------------------
-
-check_defined = \
-    $(strip $(foreach 1,$1, \
-    $(call __check_defined,$1,$(strip $(value 2)))))
-__check_defined = \
-    $(if $(value $1),, \
-    $(error Undefined make flag: $1$(if $2, ($2))))
-
-# Flash the compiled
-flash: $(BUILD)/$(OUT_FILE)-nosd.hex
-	@echo Flashing: $<
-	$(NRFJPROG) --program $< --sectoranduicrerase -f nrf52 --reset
-
-dfu-flash: $(BUILD)/$(MERGED_FILE).zip
-	@:$(call check_defined, SERIAL, example: SERIAL=/dev/ttyACM0)
-	$(NRFUTIL) --verbose dfu serial --package $< -p $(SERIAL) -b 115200 --singlebank --touch 1200
-
-sd:
-	@echo Flashing: $(SD_HEX)
-	$(NRFJPROG) --program $(SD_HEX) -f nrf52 --chiperase  --reset
-
-gdbflash: $(BUILD)/$(MERGED_FILE).hex
-	@echo Flashing: $<
-	@$(GDB_BMP) -nx --batch -ex 'load $<' -ex 'compare-sections' -ex 'kill'
-
-gdb: $(BUILD)/$(OUT_FILE)-nosd.out
-	$(GDB_BMP) $<
+all: $(BUILD)/$(OUT_FILE).out $(BUILD)/$(OUT_FILE)-nosd.hex $(BUILD)/$(OUT_FILE)-nosd.uf2 $(BUILD)/$(MERGED_FILE).hex $(BUILD)/$(MERGED_FILE).zip
 
 #------------------- Compile rules -------------------
 
-## Create build directories
+# Create build directories
 $(BUILD):
 	@$(MK) $@
 
@@ -357,26 +335,73 @@ $(BUILD)/%.o: %.S
 	@$(CC) -x assembler-with-cpp $(ASFLAGS) $(INC_PATHS) -c -o $@ $<
 
 # Link
-$(BUILD)/$(OUT_FILE)-nosd.out: $(BUILD) $(OBJECTS)
-	@echo LD $(OUT_FILE)-nosd.out
+$(BUILD)/$(OUT_FILE).out: $(BUILD) $(OBJECTS)
+	@echo LD $(notdir $@)
 	@$(CC) -o $@ $(LDFLAGS) $(OBJECTS) -Wl,--start-group $(LIBS) -Wl,--end-group
 	@$(SIZE) $@
 
 #------------------- Binary generator -------------------
 
-## Create binary .hex file from the .out file
-$(BUILD)/$(OUT_FILE)-nosd.hex: $(BUILD)/$(OUT_FILE)-nosd.out
-	@echo CR $(OUT_FILE)-nosd.hex
+# Create hex file (no sd, no mbr)
+$(BUILD)/$(OUT_FILE).hex: $(BUILD)/$(OUT_FILE).out
+	@echo Create $(notdir $@)
 	@$(OBJCOPY) -O ihex $< $@
 
-# merge bootloader and sd hex together
-$(BUILD)/$(MERGED_FILE).hex: $(BUILD)/$(OUT_FILE)-nosd.hex
-	@echo CR $(MERGED_FILE).hex
-	@mergehex -q -m $< $(SD_HEX) -o $@
+# Hex file with mbr (still no SD)
+$(BUILD)/$(OUT_FILE)-nosd.hex: $(BUILD)/$(OUT_FILE).hex
+	@echo Create $(notdir $@)
+	@python3 tools/hexmerge.py --overlap=replace -o $@ $< $(MBR_HEX)
 
-## Create pkg zip file for bootloader+SD combo to use with DFU Serial
-.PHONY: genpkg
-genpkg: $(BUILD)/$(MERGED_FILE).zip
+# Bootolader only uf2
+$(BUILD)/$(OUT_FILE)-nosd.uf2: $(BUILD)/$(OUT_FILE)-nosd.hex
+	@echo Create $(notdir $@)
+	@python3 lib/uf2/utils/uf2conv.py -f 0xd663823c -c -o $@ $^
 
-$(BUILD)/$(MERGED_FILE).zip: $(BUILD)/$(OUT_FILE)-nosd.hex
+# merge bootloader and sd hex together
+$(BUILD)/$(MERGED_FILE).hex: $(BUILD)/$(OUT_FILE).hex
+	@echo Create $(notdir $@)
+	@python3 tools/hexmerge.py -o $@ $< $(SD_HEX)
+
+# Create pkg zip file for bootloader+SD combo to use with DFU CDC
+$(BUILD)/$(MERGED_FILE).zip: $(BUILD)/$(OUT_FILE).hex
 	@$(NRFUTIL) dfu genpkg --dev-type 0x0052 --dev-revision $(DFU_DEV_REV) --bootloader $< --softdevice $(SD_HEX) $@
+
+#------------------- Flash target -------------------
+
+check_defined = \
+    $(strip $(foreach 1,$1, \
+    $(call __check_defined,$1,$(strip $(value 2)))))
+__check_defined = \
+    $(if $(value $1),, \
+    $(error Undefined make flag: $1$(if $2, ($2))))
+
+# Flash the compiled
+flash: $(BUILD)/$(OUT_FILE)-nosd.hex
+	@echo Flashing: $(notdir $<)
+	$(NRFJPROG) --program $< --sectoranduicrerase -f nrf52 --reset
+
+# dfu using CDC interface
+dfu-flash: $(BUILD)/$(MERGED_FILE).zip
+	@:$(call check_defined, SERIAL, example: SERIAL=/dev/ttyACM0)
+	$(NRFUTIL) --verbose dfu serial --package $< -p $(SERIAL) -b 115200 --singlebank --touch 1200
+
+erase:
+	@echo Erasing flash
+	$(NRFJPROG) -f nrf52 --eraseall
+
+# flash SD only
+sd:
+	@echo Flashing: $(SD_HEX)
+	$(NRFJPROG) --program $(SD_HEX) -f nrf52 --sectorerase --reset
+
+# flash MBR only
+mbr:
+	@echo Flashing: $(MBR_HEX)
+	$(NRFJPROG) --program $(MBR_HEX) -f nrf52 --sectorerase --reset
+
+gdbflash: $(BUILD)/$(MERGED_FILE).hex
+	@echo Flashing: $<
+	@$(GDB_BMP) -nx --batch -ex 'load $<' -ex 'compare-sections' -ex 'kill'
+
+gdb: $(BUILD)/$(OUT_FILE).out
+	$(GDB_BMP) $<

README.md

@@ -20,33 +20,20 @@ This is a CDC/DFU/UF2 bootloader for nRF52 boards.
 - Particle Xenon
 
 UF2 is an easy-to-use bootloader that appears as a flash drive. You can just copy `.uf2`-format
-application images to the flash drive to load new firmware.
-See https://github.com/Microsoft/uf2 and https://github.com/adafruit/uf2-samdx1
-for more information.
+application images to the flash drive to load new firmware. See https://github.com/Microsoft/uf2 and https://github.com/adafruit/uf2-samdx1 for more information.
 
-[adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil),
-a modified version of [Nordic nrfutil](https://github.com/NordicSemiconductor/pc-nrfutil),
-is required to perform DFU.
-Install `python3` if it is not installed already and run this command to install adafruit-nrfutil from PyPi:
+[adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil), a modified version of [Nordic nrfutil](https://github.com/NordicSemiconductor/pc-nrfutil), is required to perform DFU. Install `python3` if it is not installed already and run this command to install adafruit-nrfutil from PyPi:
 
 ```
 $ pip3 install --user adafruit-nrfutil
 ```
 
-This repository depends on the following submodules:
-
-- [tinyusb](https://github.com/hathach/tinyusb)
-- [nrfx](https://github.com/NordicSemiconductor/nrfx)
-
-Note that `tinyusb` also includes `nrfx` as a submodule, so you need
-to initialize and update  submodules with the `--recursive`` flag.
-
 Clone this repo with following commands, or fork it for your own development
 
 ```
 git clone https://github.com/adafruit/Adafruit_nRF52_Bootloader
 cd Adafruit_nRF52_Bootloader
-git submodule update --init --recursive
+git submodule update --init
 ```
 
 ## Features
@@ -63,7 +50,7 @@ There are two pins, `DFU` and `FRST` that bootloader will check upon reset/power
 - `Double Reset` Reset twice within 500 ms will enter DFU with UF2 and CDC support (only works with nRF52840)
 - `DFU = LOW` and `FRST = HIGH`: Enter bootloader with UF2 and CDC support
 - `DFU = LOW` and `FRST = LOW`: Enter bootloader with OTA, to upgrade with a mobile application such as Nordic nrfConnect/Toolbox
-- `DFU = HIGH` and `FRST = LOW`: Factory Reset mode: erase firmware application and its data
+- <s>`DFU = HIGH` and `FRST = LOW`: Factory Reset mode: erase firmware application and its data</s>
 - `DFU = HIGH` and `FRST = HIGH`: Go to application code if it is present, otherwise enter DFU with UF2
 - The `GPREGRET` register can also be set to force the bootloader can enter any of above modes (plus a CDC-only mode for Arduino).
 `GPREGRET` is set by the application before performing a soft reset.
@@ -92,6 +79,12 @@ To create a UF2 image from a .hex file:
 uf2conv.py firmware.hex -c -f 0xADA52840
 ```
 
+To create a UF2 image for bootloader from a .hex file using separated family of **0xd663823c**
+
+```
+uf2conv.py bootloader.hex -c -f 0xd663823c
+```
+
 ## Burn & Upgrade with pre-built binaries
 
 You can burn and/or upgrade the bootloader with either a J-link or DFU (serial) to a specific pre-built binary version
@@ -111,6 +104,7 @@ Prerequisites
 
 - ARM GCC
 - Nordic's [nRF5x Command Line Tools](https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools)
+- [Python IntelHex](https://pypi.org/project/IntelHex/)
 
 To build:
 
@@ -164,10 +158,17 @@ the variable `CROSS_COMPILE` as below:
 $ make CROSS_COMPILE=/opt/gcc-arm-none-eabi-9-2019-q4-major/bin/arm-none-eabi- BOARD=feather_nrf52832 all
 ```
 
-#### 2. `mergehex: No such file or directory`
+#### 2. `ModuleNotFoundError: No module named 'intelhex'`
+
+Install python-intelhex with
+
+```
+pip install intelhex
+```
+
+
+
 
-Make sure that `mergehex` is available from the command-line. This binary is
-part of Nordic's nRF5x Command Line Tools.
 
 #### 3. `make: nrfjprog: No such file or directory`
 

lib/SEGGER_RTT/License.txt

@@ -0,0 +1,34 @@
+Important - Read carefully:
+
+SEGGER RTT - Real Time Transfer for embedded targets
+
+All rights reserved.
+
+SEGGER strongly recommends to not make any changes
+to or modify the source code of this software in order to stay
+compatible with the RTT protocol and J-Link.
+
+Redistribution and use in source and binary forms, with or
+without modification, are permitted provided that the following
+condition is met:
+
+o Redistributions of source code must retain the above copyright
+  notice, this condition and the following disclaimer.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL SEGGER Microcontroller BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.
+
+
+(c) 2014 - 2016  SEGGER Microcontroller GmbH
+www.segger.com

lib/SEGGER_RTT/README.txt

@@ -0,0 +1,20 @@
+README.txt for the SEGGER RTT Implementation Pack.
+
+Included files:
+===============
+Root Directory
+  - Examples
+    - Main_RTT_InputEchoApp.c    - Sample application which echoes input on Channel 0.
+    - Main_RTT_MenuApp.c         - Sample application to demonstrate RTT bi-directional functionality.
+    - Main_RTT_PrintfTest.c      - Sample application to test RTT small printf implementation.
+    - Main_RTT_SpeedTestApp.c    - Sample application for measuring RTT performance. embOS needed.
+  - RTT
+    - SEGGER_RTT.c                - The RTT implementation.
+    - SEGGER_RTT.h                - Header for RTT implementation.
+    - SEGGER_RTT_Conf.h           - Pre-processor configuration for the RTT implementation.
+    - SEGGER_RTT_Printf.c         - Simple implementation of printf to write formatted strings via RTT.
+  - Syscalls
+    - RTT_Syscalls_GCC.c          - Low-level syscalls to retarget printf() to RTT with GCC / Newlib.
+    - RTT_Syscalls_IAR.c          - Low-level syscalls to retarget printf() to RTT with IAR compiler.
+    - RTT_Syscalls_KEIL.c         - Low-level syscalls to retarget printf() to RTT with KEIL/uVision compiler.
+    - RTT_Syscalls_SES.c          - Low-level syscalls to retarget printf() to RTT with SEGGER Embedded Studio.