eDesignOSS · Ralim · Aug 27, 2017 · Dec 3, 2017 · Feb 28, 2018 · Aug 9, 2019
diff --git a/.github/workflows/build-firmware.yml b/.github/workflows/build-firmware.yml
@@ -0,0 +1,38 @@
+name: Build Firmware
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Cache Toolchain
+        id: cache-toolchain
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-toolchain
+        with:
+          path: ~/toolchains/
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('util/install-toolchain.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - if: ${{ steps.cache-toolchain.outputs.cache-hit != 'true' }}
+        name: Download toolchain
+        run: ./util/install-toolchain.sh
+
+      - name: Build Firmware
+        run: make -f release.Makefile -k all
+        env:
+          PREFIX: ~/toolchains/gcc-arm-embedded/bin/arm-none-eabi-
+
+      - name: Archive Firmware
+        uses: actions/upload-artifact@v4
+        with:
+          name: firmware-bin
+          path: build/*.bin
diff --git a/README.md b/README.md
@@ -9,16 +9,35 @@ The default target is a generic STM32F103 dev board with an LED on PC13, commonl
 To build other targets, you can override the
 `TARGET` variable when invoking `make`.
 
+    cd src/
     make clean
     make TARGET=STLINK
 
 ### Targets
 
 | Target Name | Description | Link |
 | ----------- | ----------- |----- |
-|`BLUEPILL`   | Cheap dev board | http://wiki.stm32duino.com/index.php?title=Blue_Pill |
-|`MAPLEMINI`  | LeafLabs Maple Mini board and clone derivatives | http://wiki.stm32duino.com/index.php?title=Maple_Mini |
+|`BLUEPILL`   | Cheap dev board | https://stm32duinoforum.com/forum/wiki_subdomain/index_title_Blue_Pill.html |
+|`MAPLEMINI`  | LeafLabs Maple Mini board and clone derivatives | https://stm32duinoforum.com/forum/wiki_subdomain/index_title_Maple_Mini.html |
 |`STLINK`     | STLink/v2 hardware clones | https://wiki.paparazziuav.org/wiki/STLink#Clones |
+|`OLIMEXSTM32H103` | Olimex STM32-H103 | https://www.olimex.com/Products/ARM/ST/STM32-H103/ |
+|`BLUEPILLPLUSSTM32` | Bluepill with USB C | https://github.com/WeActTC/BluePill-Plus/ |
+|`BTTSKRMINIE3V2` | BigTreeTech SKR MINI E3 V2.0 (3D printer motherboard) | https://github.com/bigtreetech/BIGTREETECH-SKR-mini-E3 |
+
+For the above targets there are some potential variants that can be added to the target name based on what the target supports:
+
+| Target Variant | Description                                             |
+| -------------- | ------------------------------------------------------- |
+|` `             | Standard bootloader, using first 8 KiB of flash         |
+|`_HIGH`         | High memory bootloader for 64 KiB chips  (experimental) |
+|`_HIGH_128`     | High memory bootloader for 128 KiB chips (experimental) |
+|`_HIGH_256`     | High memory bootloader for 256 KiB chips (experimental) |
+
+The high memory bootloader is a variation that doesn't require the application to be at an offset, the bootloader resides in the top 7 KiB of ROM and hides its reset and stack vectors inside unused entries of the application vector table. As an example, to compile for a Bluepill board with 128 KiB flash, use:
+
+    make clean
+    make TARGET=BLUEPILL_HIGH_128
+
 
 ## Flash instructions
 The `make flash` target will use openocd to upload the bootloader to an attached board. By default, the Makefile assumes you're using a [CMSIS-DAP](http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php) based probe, but you can override this by overriding `OOCD_INTERFACE` variable. For example:
@@ -33,24 +52,62 @@ Here is an example `local.mk` that changes the default target to the STLink/v2 a
     TARGET ?= STLINK
     OOCD_INTERFACE ?= interface/stlink-v2.cfg
 
+You can also use the env variable `DEFS` to override default configuration for a target, like:
+
+    # Disable LED on BluePill
+    DEFS="-DHAVE_LED=0" make TARGET=BLUEPILL
+
+    # Allow access to all Flash on MapleMini and change the app base address
+    DEFS="-DFLASH_SIZE_OVERRIDE=0x20000 -DAPP_BASE_ADDRESS=0x08004000" make TARGET=MAPLEMINI LDSCRIPT="/some/folder/stm32f103x8-16kb-boot.ld"
+
 ## Using the bootloader
 ### Building for the bootloader
-The bootloader occupies the lower 8KiB of flash, so your application must offset its flash contents by 8KiB. This can be done by modifying your linker script or flags as appropriate.
+The standard bootloader occupies the lower 8KiB of flash, so your application must offset its flash contents by 8KiB. This can be done by modifying your linker script or flags as appropriate.
+
+The high memory bootloaders do not use the lower part of the flash, so you only need to make sure your application leaves 7 KiB of flash free.
 
-See the [highboot branch](https://github.com/devanlai/dapboot/tree/highboot) for an experimental variation that doesn't require the application to be offset.
 
 ### Switching to the bootloader
-The bootloader can be built to look for arbitrary patterns, but the default for the STM32F103 target looks for a magic value stored in the RTC backup registers. Writing the magic value and then resetting will run the bootloader instead of the main application.
+The bootloader can be built to look for arbitrary patterns, but the default looks for a magic value stored in the RTC backup registers. Writing the magic value and then resetting will run the bootloader instead of the main application.
+
+In version v1.11 and earlier, the bootloader for STM32F103 targets looks for `0x544F` in RTC backup register 2 and `0x4F42` in RTC backup register 1 (together they spell "BOOT" in ASCII). From v1.20 on, the bootloader will only use RTC backup register 1 and check for `0x4F42` on targets with 16-bit backup registers and `0x544F4F42` on targets with 32-bit backup registers.
+
+The backup register and bootloader command word can be customized with the `REG_BOOT` and `CMD_BOOT` defines respectively.
+
+You can also use a button to stay in bootloader while booting. It's configured using `HAVE_BUTTON` define. If your button has a debounce capacitor, you can use `BUTTON_SAMPLE_DELAY_CYCLES` define to specify how many cycles to wait before sampling the I/O pin, by default it is approximately 20ms in a 72Mhz MCU.
 
-The bootloader currently looks for `0x544F` in RTC backup register 1 and `0x4F42` in RTC backup register 0 (together they spell "BOOT" in ASCII).
+On the bluepill boards, the default is using the BOOT1 input (available on jumper in the board) to enter the bootloader.
 
 ### WebUSB
 This bootloader implements the draft [WebUSB](https://wicg.github.io/webusb/) specification, which allows web pages to access the bootloader (after presenting the user with a device picker dialog).
 
 For a demo implementing dfu-util features in the browser, see https://devanlai.github.io/webdfu/dfu-util/
 
+To customize the WebUSB landing page, you can use the `LANDING_PAGE_URL` define. To set it from the command line, you can use the `DEFS` environment variable:
+
+    DEFS='-DLANDING_PAGE_URL=\"example.com/dfu-util/\"' make
+
+Note that the URL scheme shoul not be part of the `LANDING_PAGE_URL` string. As of this writing, it is hardcoded to HTTPS. 
+
+### Manifestation behavior
+There are two different manifestation behaviors that can be selected using the `DFU_WILL_DETACH` define. By default, `DFU_WILL_DETACH` is set to 1 for backwards compatibility with existing behavior.
+
+When `DFU_WILL_DETACH` is enabled, the bootloader autonomously reboot into the new firmware after it has been successfully downloaded and passes the basic validation check. This can be helpful on platforms such as Windows where it is not possible to generate a USB bus reset to signal that the bootloader should switch to the application.
+
+When `DFU_WILL_DETACH` is disabled, the bootloader will return to the idle state after validating the firmware. The DFU host application can then perform other operations or reboot the target into the new firmware by issuing a DFU detach request or generating a USB bus reset. (This can be done with `dfu-util` by passing the `-R` flag).
+
 ## USB VID/PID
-The USB VID/PID pair ([1209/DB42](http://pid.codes/1209/DB42/)) is allocated through the [pid.codes](http://pid.codes/) open-source USB PID program.
+The default USB VID/PID pair ([1209/DB42](http://pid.codes/1209/DB42/)) is allocated through the [pid.codes](http://pid.codes/) open-source USB PID program.
+
+To use a custom VID/PID pair, you need to set the macros `USB_VID` and `USB_PID`. One way to do this is by setting the `DEFS` environment variable when compiling:
+
+     DEFS="-DUSB_VID=0x1209 -DUSB_PID=0xCAFE" make
+
+
+## USB Vendor, Product, and Interface strings
+
+To customize the USB vendor, product, and interface strings that DAPBoot reports to the USB host, you may set the macros `USB_VENDOR_STRING`, `USB_PRODUCT_STRING`, and `USB_INTERFACE_STRING`, respectively. You can do this by setting the `DEFS` environment variable or including these macros in your board's `config.h`
+
 
 ## Licensing
 All contents of the dapboot project are licensed under terms that are compatible with the terms of the GNU Lesser General Public License version 3.

diff --git a/circle.yml b/circle.yml
diff --git a/libopencm3 b/libopencm3
diff --git a/release.Makefile b/release.Makefile
@@ -31,7 +31,21 @@ BUILD_DIR      ?= ./build
 
 all: dapboot-bluepill.bin \
      dapboot-maplemini.bin \
-     dapboot-stlink.bin
+     dapboot-stlink.bin \
+     dapboot-olimexstm32h103.bin \
+     dapboot-bluepillplusstm32.bin \
+     dapboot-bttskrminie3v2.bin \
+     dapboot-bluepill-high.bin \
+     dapboot-maplemini-high.bin \
+     dapboot-stlink-high.bin \
+     dapboot-olimexstm32h103-high.bin \
+     dapboot-bluepillplusstm32-high.bin \
+     dapboot-bluepill-high-128.bin \
+     dapboot-maplemini-high-128.bin \
+     dapboot-stlink-high-128.bin \
+     dapboot-olimexstm32h103-high-128.bin \
+     dapboot-bluepillplusstm32-high-128.bin \
+     dapboot-bttskrminie3v2-high-256.bin
 
 clean:
 	$(Q)$(RM) $(BUILD_DIR)/*.bin
@@ -59,3 +73,87 @@ dapboot-maplemini.bin: | $(BUILD_DIR)
 	$(Q)$(MAKE) TARGET=MAPLEMINI -C src/ clean
 	$(Q)$(MAKE) TARGET=MAPLEMINI -C src/
 	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-olimexstm32h103.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=OLIMEXSTM32H103 -C src/ clean
+	$(Q)$(MAKE) TARGET=OLIMEXSTM32H103 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-bluepillplusstm32.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=BLUEPILLPLUSSTM32 -C src/ clean
+	$(Q)$(MAKE) TARGET=BLUEPILLPLUSSTM32 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-bttskrminie3v2.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=BTTSKRMINIE3V2 -C src/ clean
+	$(Q)$(MAKE) TARGET=BTTSKRMINIE3V2 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-bluepill-high.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=BLUEPILL_HIGH -C src/ clean
+	$(Q)$(MAKE) TARGET=BLUEPILL_HIGH -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-stlink-high.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=STLINK_HIGH -C src/ clean
+	$(Q)$(MAKE) TARGET=STLINK_HIGH -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-maplemini-high.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=MAPLEMINI_HIGH -C src/ clean
+	$(Q)$(MAKE) TARGET=MAPLEMINI_HIGH -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-olimexstm32h103-high.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=OLIMEXSTM32H103_HIGH -C src/ clean
+	$(Q)$(MAKE) TARGET=OLIMEXSTM32H103_HIGH -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-bluepillplusstm32-high.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=BLUEPILLPLUSSTM32_HIGH -C src/ clean
+	$(Q)$(MAKE) TARGET=BLUEPILLPLUSSTM32_HIGH -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-bluepill-high-128.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=BLUEPILL_HIGH_128 -C src/ clean
+	$(Q)$(MAKE) TARGET=BLUEPILL_HIGH_128 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-stlink-high-128.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=STLINK_HIGH_128 -C src/ clean
+	$(Q)$(MAKE) TARGET=STLINK_HIGH_128 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-maplemini-high-128.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=MAPLEMINI_HIGH_128 -C src/ clean
+	$(Q)$(MAKE) TARGET=MAPLEMINI_HIGH_128 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-olimexstm32h103-high-128.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=OLIMEXSTM32H103_HIGH_128 -C src/ clean
+	$(Q)$(MAKE) TARGET=OLIMEXSTM32H103_HIGH_128 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-bluepillplusstm32-high-128.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=BLUEPILLPLUSSTM32_HIGH_128 -C src/ clean
+	$(Q)$(MAKE) TARGET=BLUEPILLPLUSSTM32_HIGH_128 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
+
+dapboot-bttskrminie3v2-high-256.bin: | $(BUILD_DIR)
+	@printf "  BUILD $(@)\n"
+	$(Q)$(MAKE) TARGET=BTTSKRMINIE3V2_HIGH_256 -C src/ clean
+	$(Q)$(MAKE) TARGET=BTTSKRMINIE3V2_HIGH_256 -C src/
+	$(Q)cp src/dapboot.bin $(BUILD_DIR)/$(@)
diff --git a/src/Makefile b/src/Makefile
@@ -38,13 +38,16 @@ clean::
 include rules.mk
 
 size: $(OBJS) $(BINARY).elf
-	@$(PREFIX)-size $(OBJS) $(BINARY).elf
+	@$(PREFIX)size $(OBJS) $(BINARY).elf
 
 debug: $(BINARY).elf
 	-$(GDB) --tui --eval "target remote | $(OOCD) -f $(OOCD_INTERFACE) -f $(OOCD_BOARD) -f debug.cfg" $(BINARY).elf
 
 erase:
-	$(OOCD) -f $(OOCD_INTERFACE) -f $(OOCD_BOARD) -c "init" -c "reset init" -c "flash erase_sector 0 0 last" -c "reset" -c "shutdown"
+	$(OOCD) -f $(OOCD_INTERFACE) -f $(OOCD_BOARD) \
+            -c "init" -c "reset init" \
+            -c "stm32f1x unlock 0; reset halt" \
+            -c "flash erase_sector 0 0 last" -c "reset" -c "shutdown"
 
 .PHONY += debug size erase
 

diff --git a/src/dapboot.c b/src/dapboot.c
@@ -21,39 +21,36 @@
 
 #include "dapboot.h"
 #include "target.h"
+#include "config.h"
 #include "usb_conf.h"
 #include "dfu.h"
 #include "webusb.h"
 #include "winusb.h"
-#include "config.h"
 
 static inline void __set_MSP(uint32_t topOfMainStack) {
     asm("msr msp, %0" : : "r" (topOfMainStack));
 }
 
 bool validate_application(void) {
-    if ((*(volatile uint32_t *)APP_BASE_ADDRESS & 0x2FFE0000) == 0x20000000) {
-        return true;
-    }
-    return false;
+    return ((uint32_t)(APP_INITIAL_STACK) & 0x2FFE0000) == 0x20000000;
 }
 
 static void jump_to_application(void) __attribute__ ((noreturn));
 
 static void jump_to_application(void) {
-    vector_table_t* app_vector_table = (vector_table_t*)APP_BASE_ADDRESS;
-
+
     /* Use the application's vector table */
-    target_relocate_vector_table();
+    if (APP_RELOCATE_VECTORS)
+        target_relocate_vector_table();
 
     /* Do any necessary early setup for the application */
     target_pre_main();
 
     /* Initialize the application's stack pointer */
-    __set_MSP((uint32_t)(app_vector_table->initial_sp_value));
+    __set_MSP((uint32_t)(APP_INITIAL_STACK));
 
     /* Jump to the application entry point */
-    app_vector_table->reset();
+    APP_ENTRY_POINT();
 
     while (1);
 }
@@ -75,10 +72,11 @@ int main(void) {
         }
 
         usbd_device* usbd_dev = usb_setup();
-        dfu_setup(usbd_dev, &target_manifest_app, NULL, NULL);
+        dfu_setup(usbd_dev, validate_application, NULL, NULL);
         webusb_setup(usbd_dev);
         winusb_setup(usbd_dev);
-
+        target_post_setup();
+
         while (1) {
             usbd_poll(usbd_dev);
         }

diff --git a/src/dapboot.h b/src/dapboot.h
@@ -21,4 +21,22 @@
 
 extern bool validate_application(void);
 
+#ifdef BOOTLOADER_HIGH
+/* Definitions for high memory bootloader */
+#define APP_INITIAL_STACK    vector_table.reserved_x001c[0]
+#define APP_ENTRY_POINT      vector_table.reserved_x001c[1]
+#define APP_RELOCATE_VECTORS 0
+#define DFU_PATCH_VECTORS    1
+#define BOOTLOADER_OFFSET    0
+
+#else
+/* Definitions for low memory (standard) bootloader */
+#define APP_INITIAL_STACK ((vector_table_t*)APP_BASE_ADDRESS)->initial_sp_value
+#define APP_ENTRY_POINT   ((vector_table_t*)APP_BASE_ADDRESS)->reset
+#define APP_RELOCATE_VECTORS 1
+#define DFU_PATCH_VECTORS    0
+#define BOOTLOADER_OFFSET    0x00002000
+
+#endif
+
 #endif