west: runner: add support for ecpprog

The ecpprog command is an utility written by Greg Davill for flashing
FPGAs such as ECP5 or CrossLink-NX series. Devkits typically have an
FTDI interface chip to access the external flash. FPGA image is
typically at flash offset 0x00000000 flash offset, and the Zephyr
image offset can be set via CONFIG_FLASH_LOAD_OFFSET.

Signed-off-by: Josuah Demangeon <[email protected]>

Author: josuah

boards/common/ecpprog.board.cmake

@@ -0,0 +1,5 @@
+# Copyright (c) 2024 tinyVision.ai Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+board_set_flasher_ifnset(ecpprog)
+board_finalize_runner_args(ecpprog)

scripts/west_commands/runners/__init__.py

@@ -31,6 +31,7 @@ def _import_runner_module(runner_name):
     'canopen_program',
     'dediprog',
     'dfu',
+    'ecpprog',
     'esp32',
     'ezflashcli',
     'gd32isp',

scripts/west_commands/runners/ecpprog.py

@@ -0,0 +1,41 @@
+# Copyright (c) 2024 tinyVision.ai Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Runner for the ecpprog programming tool for Lattice FPGAs."""
+# https://github.com/gregdavill/ecpprog
+
+from runners.core import BuildConfiguration, RunnerCaps, ZephyrBinaryRunner
+
+
+class EcpprogBinaryRunner(ZephyrBinaryRunner):
+    """Runner front-end for programming the FPGA flash at some offset."""
+
+    def __init__(self, cfg, device=None):
+        super().__init__(cfg)
+        self.device = device
+
+    @classmethod
+    def name(cls):
+        return "ecpprog"
+
+    @classmethod
+    def capabilities(cls):
+        return RunnerCaps(commands={"flash"})
+
+    @classmethod
+    def do_add_parser(cls, parser):
+        parser.add_argument(
+            "--device", dest="device", help="Device identifier such as i:<vid>:<pid>"
+        )
+
+    @classmethod
+    def do_create(cls, cfg, args):
+        return EcpprogBinaryRunner(cfg, device=args.device)
+
+    def do_run(self, command, **kwargs):
+        build_conf = BuildConfiguration(self.cfg.build_dir)
+        load_offset = build_conf.get("CONFIG_FLASH_LOAD_OFFSET", 0)
+        command = ("ecpprog", "-o", hex(load_offset), self.cfg.bin_file)
+        self.logger.debug(" ".join(command))
+        self.check_call(command)

scripts/west_commands/tests/test_imports.py

@@ -22,6 +22,7 @@ def test_runner_imports():
         'canopen',
         'dediprog',
         'dfu-util',
+        'ecpprog',
         'esp32',
         'ezflashcli',
         'gd32isp',