boards: custom_plank: Add demo out-of-tree runner

Demonstrate how to use an out-of-tree runner with the custom_plank
board.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>

Author: pdgendt

boards/common/example_runner.board.cmake

@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: Apache-2.0
+
+board_set_sim_runner_ifnset(example)
+board_finalize_runner_args(example) # No default arguments to provide.

boards/vendor/custom_plank/board.cmake

@@ -3,10 +3,12 @@
 
 board_runner_args(jlink "--device=nrf52" "--speed=4000")
 board_runner_args(pyocd "--target=nrf52840" "--frequency=4000000")
+board_runner_args(example "--param=foo")
 
 set(OPENOCD_NRF5_SUBFAMILY "nrf52")
 
 include(${ZEPHYR_BASE}/boards/common/nrfjprog.board.cmake)
 include(${ZEPHYR_BASE}/boards/common/jlink.board.cmake)
 include(${ZEPHYR_BASE}/boards/common/pyocd.board.cmake)
 include(${ZEPHYR_BASE}/boards/common/openocd-nrf5.board.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/../../common/example_runner.board.cmake)

scripts/example_runner.py

@@ -0,0 +1,32 @@
+# Copyright (c) 2024 Basalte bv
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from runners.core import RunnerCaps, ZephyrBinaryRunner
+
+
+class ExampleRunner(ZephyrBinaryRunner):
+    """Dummy example runner."""
+
+    def __init__(self, cfg, param):
+        super().__init__(cfg)
+        self.param = param
+
+    @classmethod
+    def name(cls):
+        return "example"
+
+    @classmethod
+    def capabilities(cls):
+        return RunnerCaps(commands=({"simulate"}))
+
+    @classmethod
+    def do_add_parser(cls, parser):
+        parser.add_argument("--param", action="store", help="An example parameter")
+
+    @classmethod
+    def do_create(cls, cfg, args):
+        return cls(cfg, param=args.param)
+
+    def do_run(self, command, **kwargs):
+        self.logger.info(f"Running {command} on {self.param}")

zephyr/module.yml

@@ -18,3 +18,7 @@ build:
     # `<dts_root>/dts/bindings` for additional dts binding files. The `.` is
     # the root of this repository.
     dts_root: .
+runners:
+  # Additional runners, Zephyr will import these when discovering
+  # subclasses of the `ZephyrBinaryRunner` class.
+  - file: scripts/example_runner.py