[build] Add ELF2UF2 convertion tool

Author: andryblack

tools/build_script_generator/make/module.lb

@@ -52,6 +52,9 @@ def post_build(env):
     if subs["core"].startswith("cortex-m"):
         # get memory information
         subs["memories"] = env.query("::memories")
+        subs["uf2mem"] = ["0x{}:0x{}:{}".format(hex(m["start"]), hex(m["start"] + m["size"]),
+                          "CONTENTS" if "flash" in m["name"] else "NO_CONTENTS")
+                          for m in subs["memories"]]
     else:
         subs["memories"] = []
     # Add SCons specific data

tools/build_script_generator/make/module.md

@@ -485,6 +485,23 @@ Hex File······· {debug|release}/blink.hex
 ```
 
 
+#### make uf2
+
+```
+make uf2 profile={debug|release} [firmware={hash or file}]
+```
+
+Creates a UF2 compatible file of your executable. UF2 is a
+[bootloader by Microsoft](https://github.com/microsoft/uf2).
+
+```
+ $ make uf2
+UF2 File······· {debug|release}/blink.uf2
+```
+
+(\* *only ARM Cortex-M targets*)
+
+
 ## Information Tool
 
 This tool generates a set of header files containing information about the

tools/build_script_generator/make/resources/Makefile.in

@@ -108,6 +108,15 @@ delay?=5
 program-dfu: bin
 	@dfu-util -v -E$(delay) -R -i 0 -a 0 -s 0x08000000:leave -D $(BIN_FILE)
 
+.PHONY: uf2
+uf2: build
+	@echo "UF2 File·······" $(UF2_FILE)
+	@python3 $(MODM_PATH)/modm_tools/elf2uf2.py $(ELF_FILE) -o $(UF2_FILE) \
+			--target $(CONFIG_DEVICE_NAME) \
+%% for range in uf2mem
+			--range {{range}}{% if not loop.last %} \{% endif %}
+%% endfor
+%#
 %% if platform in ["sam"]
 .PHONY: program-bossac
 program-bossac: bin

tools/build_script_generator/make/resources/config.mk.in

@@ -16,6 +16,7 @@ BIN_FILE := $(BUILDPATH)/$(MODM_PROJECT_NAME).bin
 HEX_FILE := $(BUILDPATH)/$(MODM_PROJECT_NAME).hex
 LSS_FILE := $(BUILDPATH)/$(MODM_PROJECT_NAME).lss
 MAP_FILE := $(BUILDPATH)/$(MODM_PROJECT_NAME).map
+UF2_FILE := $(BUILDPATH)/$(MODM_PROJECT_NAME).uf2
 CLEAN_FILES += $(BUILDPATH)
 
 # Device configuration

tools/build_script_generator/module.lb

@@ -206,7 +206,7 @@ def build(env):
         tools.add("unit_test")
     if is_cortex_m:
         tools.update({"bmp", "openocd", "crashdebug", "gdb", "backend",
-                      "log", "build_id", "size"})
+                      "log", "build_id", "size", "elf2uf2"})
         if platform in ["sam"]:
             tools.update({"bossac"})
     elif platform in ["avr"]:

tools/build_script_generator/scons/module.lb

@@ -102,7 +102,7 @@ def build(env):
     device = env.query("::device")
     if device["core"].startswith("cortex-m"):
         tools.update({"size", "log_cortex", "artifact", "openocd",
-                     "openocd_remote", "bmp", "crashdebug", "dfu"})
+                      "elf2uf2", "openocd_remote", "bmp", "crashdebug", "dfu"})
         if device["platform"] in ["sam"]:
             tools.update({"bossac"})
     elif device["core"].startswith("avr"):

tools/build_script_generator/scons/module.md

@@ -557,6 +557,23 @@ Hex File······· {debug|release}/blink.hex
 ```
 
 
+#### scons uf2
+
+```
+scons uf2 profile={debug|release} [firmware={hash or file}]
+```
+
+Creates a UF2 compatible file of your executable. UF2 is a
+[bootloader by Microsoft](https://github.com/microsoft/uf2).
+
+```
+ $ scons uf2
+UF2 File······· {debug|release}/blink.uf2
+```
+
+(\* *only ARM Cortex-M targets*)
+
+
 #### scons artifact
 
 ```

tools/build_script_generator/scons/resources/build_target.py.in

@@ -20,6 +20,7 @@ def build_target(env, sources):
 	env.Clean(program, join(env["BUILDPATH"], env["CONFIG_PROJECT_NAME"]+".bin"))
 	env.Clean(program, join(env["BUILDPATH"], env["CONFIG_PROJECT_NAME"]+".hex"))
 	env.Clean(program, join(env["BUILDPATH"], env["CONFIG_PROJECT_NAME"]+".lss"))
+	env.Clean(program, join(env["BUILDPATH"], env["CONFIG_PROJECT_NAME"]+".uf2"))
 
 %% if with_compilation_db
 	env.Command("compile_commands.json", sources,
@@ -42,6 +43,8 @@ def build_target(env, sources):
 	env.Depends(target=program, dependency="{{ linkerscript }}")
 	env.Alias("size", env.Size(chosen_program))
 	%% if core.startswith("cortex-m")
+	env.Alias("uf2", env.UF2(chosen_program))
+
 	env.Alias("log-itm", env.LogItmOpenOcd())
 	env.Alias("log-rtt", env.LogRttOpenOcd())
 

tools/build_script_generator/scons/site_tools/comstr.py

@@ -70,6 +70,7 @@ def generate(env, **kw):
         env['HEXCOMSTR'] =      "%sHex File······· %s$TARGET%s" % default
         env['BINCOMSTR'] =      "%sBinary File···· %s$TARGET%s" % default
         env['LSSCOMSTR'] =      "%sListing········ %s$TARGET%s" % default
+        env['UF2COMSTR'] =      "%sUF2 File······· %s$TARGET%s" % default
 
         # modm tools format strings
         env['BITMAPCOMSTR'] =   "%sBitmap········· %s${str(TARGET).replace(BUILDPATH,CONFIG_PROFILE)}%s" % default

tools/build_script_generator/scons/site_tools/elf2uf2.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016-2017, German Aerospace Center (DLR)
+# Copyright (c) 2018, Niklas Hauser
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Authors:
+# - 2022, Andrey Kunitsyn
+
+import os
+
+from SCons.Script import *
+from modm_tools import elf2uf2
+
+def elf2uf2_action(target, source, env):
+    memranges = [{
+        "start": m["start"],
+        "end": m["start"] + m["size"],
+        "type": "CONTENTS" if "flash" in m["name"] else "NO_CONTENTS"
+    }
+    for m in env["CONFIG_DEVICE_MEMORY"]]
+    elf2uf2.convert(str(source[0]),
+                    str(target[0]),
+                    env["CONFIG_DEVICE_NAME"],
+                    memranges)
+
+def generate(env, **kw):
+    builder_elf2uf2 = Builder(
+        action=Action(elf2uf2_action, cmdstr="$UF2COMSTR"),
+        suffix=".uf2",
+        src_suffix=".elf")
+
+    env.Append(BUILDERS={
+        "UF2": builder_elf2uf2,
+    })
+
+
+def exists(env):
+    return True
+