From 3f282da22ddae4d2b178994ae9950e57a2bd3119 Mon Sep 17 00:00:00 2001
From: John Whittington <git@jbrengineering.co.uk>
Date: Wed, 24 Jan 2024 13:45:08 +0100
Subject: [PATCH] west: runners: blackmagicprobe: elf_file fallback

Building the HEX file is optional (CONFIG_BUILD_OUTPUT_HEX), so
`bmp_flash` will fallback to elf_file if missing. Additionally, to
maintain section names the HEX is only used if it is signed.

Signed-off-by: John Whittington <git@jbrengineering.co.uk>
---
 .../west_commands/runners/blackmagicprobe.py  | 24 +++++++++++++++----
 .../tests/test_blackmagicprobe.py             |  4 ++--
 2 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/scripts/west_commands/runners/blackmagicprobe.py b/scripts/west_commands/runners/blackmagicprobe.py
index 95cb6e2efd8..1c2c8fa0d6a 100644
--- a/scripts/west_commands/runners/blackmagicprobe.py
+++ b/scripts/west_commands/runners/blackmagicprobe.py
@@ -116,8 +116,10 @@ class BlackMagicProbeRunner(ZephyrBinaryRunner):
         #
         # https://github.com/zephyrproject-rtos/zephyr/issues/50789
         self.elf_file = Path(cfg.elf_file).as_posix()
-        # hex_file for flash signed image
-        self.hex_file = Path(cfg.hex_file).as_posix()
+        if cfg.hex_file is not None:
+            self.hex_file = Path(cfg.hex_file).as_posix()
+        else:
+            self.hex_file = None
         self.gdb_serial = blackmagicprobe_gdb_serial(gdb_serial)
         self.logger.info(f'using GDB serial: {self.gdb_serial}')
         if connect_rst:
@@ -152,8 +154,20 @@ class BlackMagicProbeRunner(ZephyrBinaryRunner):
                             help='Assert SRST during connect? (default: no)')
 
     def bmp_flash(self, command, **kwargs):
-        if self.hex_file is None:
-            raise ValueError('Cannot flash; hex file is missing')
+        # if hex file is present and signed, use it else use elf file
+        if self.hex_file:
+            split = self.hex_file.split('.')
+            # eg zephyr.signed.hex
+            if len(split) >= 3 and split[-2] == 'signed':
+                flash_file = self.hex_file
+            else:
+                flash_file = self.elf_file
+        else:
+            flash_file = self.elf_file
+
+        if flash_file is None:
+            raise ValueError('Cannot flash; elf file is missing')
+
         command = (self.gdb +
                    ['-ex', "set confirm off",
                     '-ex', "target extended-remote {}".format(
@@ -161,7 +175,7 @@ class BlackMagicProbeRunner(ZephyrBinaryRunner):
                     self.connect_rst_enable_arg +
                    ['-ex', "monitor swdp_scan",
                     '-ex', "attach 1",
-                    '-ex', "load {}".format(self.hex_file),
+                    '-ex', "load {}".format(flash_file),
                     '-ex', "kill",
                     '-ex', "quit",
                     '-silent'])
diff --git a/scripts/west_commands/tests/test_blackmagicprobe.py b/scripts/west_commands/tests/test_blackmagicprobe.py
index 3ee50def406..6e083d87c96 100644
--- a/scripts/west_commands/tests/test_blackmagicprobe.py
+++ b/scripts/west_commands/tests/test_blackmagicprobe.py
@@ -11,7 +11,7 @@ import pytest
 
 from runners import blackmagicprobe
 from runners.blackmagicprobe import BlackMagicProbeRunner
-from conftest import RC_KERNEL_ELF, RC_KERNEL_HEX, RC_GDB
+from conftest import RC_KERNEL_ELF, RC_GDB
 import serial.tools.list_ports
 
 TEST_GDB_SERIAL = 'test-gdb-serial'
@@ -41,7 +41,7 @@ EXPECTED_COMMANDS = {
       '-ex', "target extended-remote {}".format(TEST_GDB_SERIAL),
       '-ex', "monitor swdp_scan",
       '-ex', "attach 1",
-      '-ex', "load {}".format(RC_KERNEL_HEX),
+      '-ex', "load {}".format(RC_KERNEL_ELF),
       '-ex', "kill",
       '-ex', "quit",
       '-silent'],),