scripts: west_commands: runners: remove '--dt-flash' option

Most runners that support the '--dt-flash' option set it to True by
default. When the option is not set, runners either produce errors, or
default to a value of 0, which doesn't make much sense.
Only the 'spi_burn' runner appears to have two legitimate behaviors
depending on whether '--dt-flash' is set to True or not.

Removes the '--dt-flash' option from all runners where
it doesn't make sense.
Moves the handling of the option to the spi_burn runner.

Signed-off-by: Miguel Gazquez <[email protected]>

Author: miggazElquez

boards/common/jlink.board.cmake

@@ -2,4 +2,4 @@
 
 board_set_flasher_ifnset(jlink)
 board_set_debugger_ifnset(jlink)
-board_finalize_runner_args(jlink "--dt-flash=y")
+board_finalize_runner_args(jlink)

boards/common/linkserver.board.cmake

@@ -3,4 +3,4 @@
 
 board_set_flasher_ifnset(linkserver)
 board_set_debugger_ifnset(linkserver)
-board_finalize_runner_args(linkserver "--dt-flash=y")
+board_finalize_runner_args(linkserver)

boards/common/pyocd.board.cmake

@@ -5,4 +5,4 @@ board_set_debugger_ifnset(pyocd)
 if(CONFIG_SEMIHOST_CONSOLE)
     board_runner_args(pyocd "--tool-opt=-S")
 endif()
-board_finalize_runner_args(pyocd "--dt-flash=y")
+board_finalize_runner_args(pyocd)

boards/common/silabs_commander.board.cmake

@@ -1,4 +1,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
 board_set_flasher_ifnset(silabs_commander)
-board_finalize_runner_args(silabs_commander "--dt-flash=y")
+board_finalize_runner_args(silabs_commander)

scripts/west_commands/runners/core.py

@@ -268,10 +268,6 @@ class RunnerCaps:
       connected to a single computer, in order to select which one will be used
       with the command provided.
 
-    - flash_addr: whether the runner supports flashing to an
-      arbitrary address. Default is False. If true, the runner
-      must honor the --dt-flash option.
-
     - erase: whether the runner supports an --erase option, which
       does a mass-erase of the entire addressable flash on the target
       before flashing. On multi-core SoCs, this may only erase portions of
@@ -356,19 +352,6 @@ class RunnerConfig(NamedTuple):
     openocd_search: list[str] = []  # add these paths to the openocd search path
     rtt_address: int | None = None # address of the rtt control block
 
-
-_YN_CHOICES = ['Y', 'y', 'N', 'n', 'yes', 'no', 'YES', 'NO']
-
-
-class _DTFlashAction(argparse.Action):
-
-    def __call__(self, parser, namespace, values, option_string=None):
-        if values.lower().startswith('y'):
-            namespace.dt_flash = True
-        else:
-            namespace.dt_flash = False
-
-
 class _ToggleAction(argparse.Action):
 
     def __call__(self, parser, args, ignored, option):
@@ -527,10 +510,6 @@ def add_parser(cls, parser):
         argparse module. For more details, refer to the documentation
         for argparse.ArgumentParser.add_subparsers().
 
-        The lone common optional argument is:
-
-        * --dt-flash (if the runner capabilities includes flash_addr)
-
         Runner-specific options are added through the do_add_parser()
         hook.'''
         # Unfortunately, the parser argument's type is not documented
@@ -549,15 +528,6 @@ def add_parser(cls, parser):
         else:
             parser.add_argument('-i', '--dev-id', help=argparse.SUPPRESS)
 
-        if caps.flash_addr:
-            parser.add_argument('--dt-flash', default=False, choices=_YN_CHOICES,
-                                action=_DTFlashAction,
-                                help='''If 'yes', try to use flash address
-                                information from devicetree when flash
-                                addresses are unknown (e.g. when flashing a .bin)''')
-        else:
-            parser.add_argument('--dt-flash', help=argparse.SUPPRESS)
-
         if caps.file:
             parser.add_argument('-f', '--file',
                                 dest='file',
@@ -650,8 +620,6 @@ def create(cls, cfg: RunnerConfig,
         caps = cls.capabilities()
         if args.dev_id and not caps.dev_id:
             _missing_cap(cls, '--dev-id')
-        if args.dt_flash and not caps.flash_addr:
-            _missing_cap(cls, '--dt-flash')
         if args.erase and not caps.erase:
             _missing_cap(cls, '--erase')
         if args.reset and not caps.reset:
@@ -682,22 +650,6 @@ def do_create(cls, cfg: RunnerConfig,
                   args: argparse.Namespace) -> 'ZephyrBinaryRunner':
         '''Hook for instance creation from command line arguments.'''
 
-    @staticmethod
-    def get_flash_address(args: argparse.Namespace,
-                          build_conf: BuildConfiguration,
-                          default: int = 0x0) -> int:
-        '''Helper method for extracting a flash address.
-
-        If args.dt_flash is true, returns the address obtained from
-        ZephyrBinaryRunner.flash_address_from_build_conf(build_conf).
-
-        Otherwise (when args.dt_flash is False), the default value is
-        returned.'''
-        if args.dt_flash:
-            return ZephyrBinaryRunner.flash_address_from_build_conf(build_conf)
-        else:
-            return default
-
     @staticmethod
     def flash_address_from_build_conf(build_conf: BuildConfiguration):
         '''If CONFIG_HAS_FLASH_LOAD_OFFSET is n in build_conf,

scripts/west_commands/runners/dfu.py

@@ -42,7 +42,7 @@ def name(cls):
 
     @classmethod
     def capabilities(cls):
-        return RunnerCaps(commands={'flash'}, dev_id=True, flash_addr=True)
+        return RunnerCaps(commands={'flash'}, dev_id=True)
 
     @classmethod
     def dev_id_help(cls) -> str:
@@ -82,9 +82,8 @@ def do_create(cls, cfg, args):
             args.img = cfg.bin_file
 
         if args.dfuse:
-            args.dt_flash = True  # --dfuse implies --dt-flash.
             build_conf = BuildConfiguration(cfg.build_dir)
-            dcfg = DfuSeConfig(address=cls.get_flash_address(args, build_conf),
+            dcfg = DfuSeConfig(address=cls.flash_address_from_build_conf(build_conf),
                                options=args.dfuse_modifiers)
         else:
             dcfg = None

scripts/west_commands/runners/jlink.py

@@ -82,7 +82,7 @@ class JLinkBinaryRunner(ZephyrBinaryRunner):
 
     def __init__(self, cfg, device, dev_id=None,
                  commander=DEFAULT_JLINK_EXE,
-                 dt_flash=True, erase=True, reset=False,
+                 erase=True, reset=False,
                  iface='swd', speed='auto', flash_script = None,
                  loader=None,
                  gdbserver='JLinkGDBServer',
@@ -101,7 +101,6 @@ def __init__(self, cfg, device, dev_id=None,
         self.dev_id = dev_id
         self.commander = commander
         self.flash_script = flash_script
-        self.dt_flash = dt_flash
         self.erase = erase
         self.reset = reset
         self.gdbserver = gdbserver
@@ -125,7 +124,7 @@ def name(cls):
     @classmethod
     def capabilities(cls):
         return RunnerCaps(commands={'flash', 'debug', 'debugserver', 'attach', 'rtt'},
-                          dev_id=True, flash_addr=True, erase=True, reset=True,
+                          dev_id=True, erase=True, reset=True,
                           tool_opt=True, file=True, rtt=True)
 
     @classmethod
@@ -182,7 +181,6 @@ def do_create(cls, cfg, args):
         return JLinkBinaryRunner(cfg, args.device,
                                  dev_id=args.dev_id,
                                  commander=args.commander,
-                                 dt_flash=args.dt_flash,
                                  erase=args.erase,
                                  reset=args.reset,
                                  iface=args.iface, speed=args.speed,
@@ -386,10 +384,7 @@ def get_default_flash_commands(self):
             if self.file_type == FileType.HEX:
                 flash_cmd = f'loadfile "{self.file}"'
             elif self.file_type == FileType.BIN:
-                if self.dt_flash:
-                    flash_addr = self.flash_address_from_build_conf(self.build_conf)
-                else:
-                    flash_addr = 0
+                flash_addr = self.flash_address_from_build_conf(self.build_conf)
                 flash_cmd = f'loadfile "{self.file}" 0x{flash_addr:x}'
             else:
                 err = 'Cannot flash; jlink runner only supports hex and bin files'
@@ -403,10 +398,7 @@ def get_default_flash_commands(self):
                 flash_cmd = f'loadfile "{self.hex_name}"'
             # Preferring .bin over .elf
             elif self.bin_name is not None and os.path.isfile(self.bin_name):
-                if self.dt_flash:
-                    flash_addr = self.flash_address_from_build_conf(self.build_conf)
-                else:
-                    flash_addr = 0
+                flash_addr = self.flash_address_from_build_conf(self.build_conf)
                 flash_file = self.bin_name
                 flash_cmd = f'loadfile "{self.bin_name}" 0x{flash_addr:x}'
             elif self.elf_name is not None and os.path.isfile(self.elf_name):

scripts/west_commands/runners/linkserver.py

@@ -23,7 +23,7 @@ class LinkServerBinaryRunner(ZephyrBinaryRunner):
     '''Runner front-end for NXP Linkserver'''
     def __init__(self, cfg, device, core,
                  linkserver=DEFAULT_LINKSERVER_EXE,
-                 dt_flash=True, erase=True,
+                 erase=True,
                  probe='#1',
                  gdb_host='',
                  gdb_port=DEFAULT_LINKSERVER_GDB_PORT,
@@ -40,7 +40,6 @@ def __init__(self, cfg, device, core,
         self.device = device
         self.core = core
         self.linkserver = linkserver
-        self.dt_flash = dt_flash
         self.erase = erase
         self.probe = probe
         self.gdb_host = gdb_host
@@ -62,8 +61,7 @@ def name(cls):
     @classmethod
     def capabilities(cls):
         return RunnerCaps(commands={'flash', 'debug', 'debugserver', 'attach'},
-                          dev_id=True, flash_addr=True, erase=True,
-                          tool_opt=True, file=True)
+                          dev_id=True, erase=True, tool_opt=True, file=True)
 
     @classmethod
     def do_add_parser(cls, parser):
@@ -98,7 +96,6 @@ def do_create(cls, cfg, args):
         print(f"RUNNER - gdb_port = {args.gdb_port}, semih port = {args.semihost_port}")
         return LinkServerBinaryRunner(cfg, args.device, args.core,
                                  linkserver=args.linkserver,
-                                 dt_flash=args.dt_flash,
                                  erase=args.erase,
                                  probe=args.probe,
                                  semihost_port=args.semihost_port,
@@ -198,12 +195,7 @@ def flash(self, **kwargs):
             flash_cmd = (["load", self.hex_name])
         # Preferring .bin over .elf
         elif self.bin_name is not None and os.path.isfile(self.bin_name):
-            if self.dt_flash:
-                load_addr = self.flash_address_from_build_conf(self.build_conf)
-            else:
-                self.logger.critical("no load flash address could be found...")
-                raise RuntimeError("no load flash address could be found...")
-
+            load_addr = self.flash_address_from_build_conf(self.build_conf)
             flash_cmd = (["load", "--addr", str(load_addr), self.bin_name])
         elif self.elf_name is not None and os.path.isfile(self.elf_name):
             flash_cmd = (["load", self.elf_name])

scripts/west_commands/runners/minichlink.py

@@ -18,15 +18,13 @@ def __init__(
         minichlink: str,
         erase: bool,
         reset: bool,
-        dt_flash: bool,
         terminal: bool,
     ):
         super().__init__(cfg)
 
         self.minichlink = minichlink
         self.erase = erase
         self.reset = reset
-        self.dt_flash = dt_flash
         self.terminal = terminal
 
     @classmethod
@@ -35,7 +33,7 @@ def name(cls):
 
     @classmethod
     def capabilities(cls) -> RunnerCaps:
-        return RunnerCaps(commands={"flash"}, flash_addr=True, erase=True, reset=True)
+        return RunnerCaps(commands={"flash"}, erase=True, reset=True)
 
     @classmethod
     def do_add_parser(cls, parser: argparse.ArgumentParser):
@@ -57,7 +55,6 @@ def do_create(cls, cfg: RunnerConfig, args: argparse.Namespace):
             minichlink=args.minichlink,
             erase=args.erase,
             reset=args.reset,
-            dt_flash=args.dt_flash,
             terminal=args.terminal,
         )
 
@@ -77,9 +74,7 @@ def flash(self):
         if self.erase:
             cmd.append("-E")
 
-        flash_addr = 0
-        if self.dt_flash:
-            flash_addr = self.flash_address_from_build_conf(self.build_conf)
+        flash_addr = self.flash_address_from_build_conf(self.build_conf)
 
         cmd.extend(["-w", self.cfg.bin_file or "", f"0x{flash_addr:x}"])
 

scripts/west_commands/runners/pyocd.py

@@ -77,8 +77,7 @@ def name(cls):
     @classmethod
     def capabilities(cls):
         return RunnerCaps(commands={'flash', 'debug', 'debugserver', 'attach', 'rtt'},
-                          dev_id=True, flash_addr=True, erase=True,
-                          tool_opt=True, rtt=True)
+                          dev_id=True, erase=True, tool_opt=True, rtt=True)
 
     @classmethod
     def dev_id_help(cls) -> str:
@@ -116,7 +115,7 @@ def tool_opt_help(cls) -> str:
     @classmethod
     def do_create(cls, cfg, args):
         build_conf = BuildConfiguration(cfg.build_dir)
-        flash_addr = cls.get_flash_address(args, build_conf)
+        flash_addr = cls.flash_address_from_build_conf(build_conf)
 
         ret = PyOcdBinaryRunner(
             cfg, args.target,

scripts/west_commands/runners/silabs_commander.py

@@ -18,7 +18,7 @@
 
 
 class SiLabsCommanderBinaryRunner(ZephyrBinaryRunner):
-    def __init__(self, cfg, device, dev_id, commander, dt_flash, erase, speed, tool_opt):
+    def __init__(self, cfg, device, dev_id, commander, erase, speed, tool_opt):
         super().__init__(cfg)
         self.file = cfg.file
         self.file_type = cfg.file_type
@@ -28,7 +28,6 @@ def __init__(self, cfg, device, dev_id, commander, dt_flash, erase, speed, tool_
         self.device = device
         self.dev_id = dev_id
         self.commander = commander
-        self.dt_flash = dt_flash
         self.erase = erase
         self.speed = speed
 
@@ -43,8 +42,7 @@ def name(cls):
     @classmethod
     def capabilities(cls):
         return RunnerCaps(commands={'flash'},
-                          dev_id=True, flash_addr=True, erase=True,
-                          tool_opt=True, file=True)
+                          dev_id=True, erase=True, tool_opt=True, file=True)
 
     @classmethod
     def dev_id_help(cls) -> str:
@@ -73,7 +71,6 @@ def do_create(cls, cfg, args):
                 cfg, args.device,
                 dev_id=args.dev_id,
                 commander=args.commander,
-                dt_flash=args.dt_flash,
                 erase=args.erase,
                 speed=args.speed,
                 tool_opt=args.tool_opt)
@@ -91,10 +88,7 @@ def do_run(self, command, **kwargs):
 
         # Get the build artifact to flash
 
-        if self.dt_flash:
-            flash_addr = self.flash_address_from_build_conf(self.build_conf)
-        else:
-            flash_addr = 0
+        flash_addr = self.flash_address_from_build_conf(self.build_conf)
 
         if self.file is not None:
             # use file provided by the user

scripts/west_commands/runners/spi_burn.py

@@ -2,13 +2,23 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+import argparse
 import os
 import re
 import subprocess
 import time
 
 from runners.core import BuildConfiguration, RunnerCaps, ZephyrBinaryRunner
 
+_YN_CHOICES = ['Y', 'y', 'N', 'n', 'yes', 'no', 'YES', 'NO']
+
+class _DTFlashAction(argparse.Action):
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        if values.lower().startswith('y'):
+            namespace.dt_flash = True
+        else:
+            namespace.dt_flash = False
 
 class SpiBurnBinaryRunner(ZephyrBinaryRunner):
     '''Runner front-end for SPI_burn.'''
@@ -30,12 +40,18 @@ def name(cls):
 
     @classmethod
     def capabilities(cls):
-        return RunnerCaps(commands={'flash', 'debug'}, erase=True, flash_addr=True)
+        return RunnerCaps(commands={'flash', 'debug'}, erase=True)
 
     @classmethod
     def do_add_parser(cls, parser):
         parser.add_argument('--addr', default='0x0',
                             help='start flash address to write')
+        parser.add_argument('--dt-flash', default=False, choices=_YN_CHOICES,
+                            action=_DTFlashAction,
+                            help='''If 'yes', try to use flash address
+                            information from devicetree when flash
+                            addresses are unknown (e.g. when flashing a .bin)''')
+
         parser.add_argument('--timeout', default=10,
                             help='ICEman connection establishing timeout in seconds')
         parser.add_argument('--telink-tools-path', help='path to Telink flash tools')