scripts: runners: Add cvi-fiptool

The SOPHGO CVI series SoCs load the RTOS kernel for the 2nd core from a
`fip.bin` located in the main storage.

This commit introduced a convenient script for updating the `fip.bin` on
the external storage mounted to the host, with the newly built
`zephyr.bin`.

Path to the `fiptool.py` from the official SDK should be provided.

Signed-off-by: Chen Xingyu <[email protected]>

Author: xingrz

boards/common/cvi-fiptool.board.cmake

@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: Apache-2.0
+
+board_set_flasher_ifnset(cvi-fiptool)
+board_finalize_runner_args(cvi-fiptool)

scripts/west_commands/runners/__init__.py

@@ -30,6 +30,7 @@ def _import_runner_module(runner_name):
     'blackmagicprobe',
     'bossac',
     'canopen_program',
+    'cvi-fiptool',
     'dediprog',
     'dfu',
     'ecpprog',

scripts/west_commands/runners/cvi-fiptool.py

@@ -0,0 +1,60 @@
+# Copyright (c) 2024 Chen Xingyu <[email protected]>
+# SPDX-License-Identifier: Apache-2.0
+
+'''SOPHGO CVI specific flash only runner.'''
+
+import sys
+import time
+from os import path
+
+from runners.core import RunnerCaps, ZephyrBinaryRunner
+
+
+class CviFiptoolBinaryRunner(ZephyrBinaryRunner):
+    '''Runner front-end for the SOPHGO CVI boards, using fiptool.py from SDK.'''
+
+    def __init__(self, cfg, fiptool_py, fip_bin):
+        super().__init__(cfg)
+        self.fiptool_py = fiptool_py
+        self.fip_bin = fip_bin
+        self.bin_name = cfg.bin_file
+
+    @classmethod
+    def name(cls):
+        return 'cvi-fiptool'
+
+    @classmethod
+    def capabilities(cls):
+        return RunnerCaps(commands={'flash'})
+
+    @classmethod
+    def do_add_parser(cls, parser):
+        parser.add_argument('--fiptool', required=True, help='path to fiptool.py script from SDK')
+        parser.add_argument('--fip-bin', required=True, help='path to fip.bin file to be updated')
+
+    @classmethod
+    def do_create(cls, cfg, args):
+        return CviFiptoolBinaryRunner(cfg, args.fiptool, args.fip_bin)
+
+    def do_run(self, command, **kwargs):
+        self.require(self.fiptool_py)
+
+        fip_dir = path.dirname(self.fip_bin)
+        if not path.exists(fip_dir):
+            print(f'Waiting for {fip_dir} to be present...')
+            while not path.exists(fip_dir):
+                time.sleep(1)
+
+        if not path.exists(self.fip_bin):
+            raise RuntimeError(f'File {self.fip_bin} not found')
+
+        cmd_flash = [sys.executable, self.fiptool_py]
+
+        cmd_flash.extend(['-v', 'genfip', self.fip_bin])
+        cmd_flash.extend(['--OLD_FIP', self.fip_bin])
+        cmd_flash.extend(['--BLCP_2ND', self.bin_name])
+
+        self.check_call(cmd_flash)
+
+        print('')
+        print('fip.bin updated. Remember to eject the drive before unplugging.')

scripts/west_commands/tests/test_imports.py

@@ -21,6 +21,7 @@ def test_runner_imports():
         'blackmagicprobe',
         'bossac',
         'canopen',
+        'cvi-fiptool',
         'dediprog',
         'dfu-util',
         'ecpprog',