scripts: stm32cubeprogrammer: Add possibility to flash a bin file

Add the option to flash a bin file if one is available from the board's
cmake configuration.
Use of elf has prio over this, and bin has prio over hex which remains
the default option.
Also add a parameter to stm32cubeprogrammer runner to specify the download
address.

Signed-off-by: Guillaume Gautier <[email protected]>

Author: gautierg-st

scripts/west_commands/runners/stm32cubeprogrammer.py

@@ -34,6 +34,7 @@ def __init__(
         port: str,
         frequency: int | None,
         reset_mode: str | None,
+        download_address: int | None,
         start_address: int | None,
         conn_modifiers: str | None,
         cli: Path | None,
@@ -46,6 +47,7 @@ def __init__(
 
         self._port = port
         self._frequency = frequency
+        self._download_address = download_address
         self._start_address = start_address
         self._reset_mode = reset_mode
         self._conn_modifiers = conn_modifiers
@@ -149,6 +151,15 @@ def do_add_parser(cls, parser):
             choices=["sw", "hw", "core"],
             help="Reset mode",
         )
+        parser.add_argument(
+            "--download-address",
+            # To accept arguments in hex format, a wrapper lambda around int() must be used.
+            # Wrapping the lambda with functools.wraps() makes it so that 'invalid int value'
+            # is displayed when an invalid value is provided for this argument.
+            type=functools.wraps(int)(lambda s: int(s, base=0)),
+            required=False,
+            help="Address where flashing should be done"
+        )
         parser.add_argument(
             "--start-address",
             # To accept arguments in hex format, a wrapper lambda around int() must be used.
@@ -194,6 +205,7 @@ def do_create(
             port=args.port,
             frequency=args.frequency,
             reset_mode=args.reset_mode,
+            download_address=args.download_address,
             start_address=args.start_address,
             conn_modifiers=args.conn_modifiers,
             cli=args.cli,
@@ -233,13 +245,22 @@ def flash(self, **kwargs) -> None:
             self.check_call(cmd + ["--erase", "all"])
 
         # flash image and run application
-        dl_file = self.cfg.elf_file if self._use_elf else self.cfg.hex_file
+        if self._use_elf:
+            dl_file = self.cfg.elf_file
+        elif self.cfg.bin_file is not None and os.path.isfile(self.cfg.bin_file) and \
+            "zephyr.signed" in self.cfg.bin_file:
+            dl_file = self.cfg.bin_file
+        elif self.cfg.hex_file is not None and os.path.isfile(self.cfg.hex_file):
+            # --user-elf not used and no bin file given, default to hex
+            dl_file = self.cfg.hex_file
         if dl_file is None:
             raise RuntimeError('cannot flash; no download file was specified')
         elif not os.path.isfile(dl_file):
             raise RuntimeError(f'download file {dl_file} does not exist')
 
         flash_and_run_args = ["--download", dl_file]
+        if self._download_address is not None:
+            flash_and_run_args.append(f"0x{self._download_address:X}")
 
         # '--start' is needed to start execution after flash.
         # The default start address is the beggining of the flash,

scripts/west_commands/tests/test_stm32cubeprogrammer.py

@@ -64,6 +64,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -88,6 +89,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": 0x8001000,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -113,6 +115,7 @@
         "port": "swd",
         "frequency": "4000",
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -137,6 +140,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": "hw",
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -161,6 +165,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": "sw",
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -185,6 +190,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": "core",
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -209,6 +215,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": "br=115200 sn=TEST",
         "cli": CLI_PATH,
@@ -233,6 +240,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -257,6 +265,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -282,6 +291,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": CLI_PATH,
@@ -307,6 +317,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": None,
@@ -331,6 +342,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": None,
@@ -355,6 +367,7 @@
         "port": "swd",
         "frequency": None,
         "reset_mode": None,
+        "download_address": None,
         "start_address": None,
         "conn_modifiers": None,
         "cli": None,
@@ -375,6 +388,32 @@
             ],
         ],
     },
+    {
+        "port": "swd",
+        "frequency": None,
+        "reset_mode": None,
+        "download_address": 0x80000000,
+        "start_address": None,
+        "conn_modifiers": None,
+        "cli": CLI_PATH,
+        "use_elf": False,
+        "erase": False,
+        "extload": None,
+        "tool_opt": [],
+        "system": "",
+        "cli_path": str(CLI_PATH),
+        "calls": [
+            [
+                str(CLI_PATH),
+                "--connect",
+                "port=swd",
+                "--download",
+                RC_KERNEL_HEX,
+                "0x80000000",
+                "--start",
+            ],
+        ],
+    },
 )
 """Test cases."""
 
@@ -400,6 +439,7 @@ def test_stm32cubeprogrammer_init(
         port=tc["port"],
         frequency=tc["frequency"],
         reset_mode=tc["reset_mode"],
+        download_address=tc["download_address"],
         start_address=tc["start_address"],
         conn_modifiers=tc["conn_modifiers"],
         cli=tc["cli"],
@@ -436,6 +476,8 @@ def test_stm32cubeprogrammer_create(
         args.extend(["--frequency", tc["frequency"]])
     if tc["reset_mode"]:
         args.extend(["--reset-mode", tc["reset_mode"]])
+    if tc["download_address"]:
+        args.extend(["--download-address", str(tc["download_address"])])
     if tc["start_address"]:
         args.extend(["--start-address", str(tc["start_address"])])
     if tc["conn_modifiers"]: