scripts: west: flash: Add support for scripts to flash using the RFP tool.

Add support for scripts to flash using the RFP tool.

Signed-off-by: Hau Ho <hau.ho.xc@bp.renesas.com>

Author: Hau Ho

scripts/west_commands/runners/rfp.py

@@ -8,14 +8,17 @@
 
 import platform
 import re
+from pathlib import Path
 
 from runners.core import RunnerCaps, ZephyrBinaryRunner
 
-if platform.system() == 'Darwin':
+if platform.system() == 'Darwin' or 'Windows':
     DEFAULT_RFP_PORT = None
 else:
     DEFAULT_RFP_PORT = '/dev/ttyACM0'
 
+RFP_CLI_EXE = 'rfp-cli'
+
 
 def to_num(number):
     dev_match = re.search(r"^\d*\+dev", number)
@@ -41,6 +44,8 @@ def __init__(
         erase=False,
         verify=False,
         port=DEFAULT_RFP_PORT,
+        tool=None,
+        interface=None,
         speed=None,
     ):
         super().__init__(cfg)
@@ -49,6 +54,8 @@ def __init__(
         self.verify = verify
         self.erase = erase
         self.port = port
+        self.tool = tool
+        self.interface = interface
         self.device = device
         self.speed = speed
 
@@ -62,14 +69,25 @@ def capabilities(cls):
 
     @classmethod
     def do_add_parser(cls, parser):
+        # Find the default efp-cli executable
+        cls.default_rfp()
+
         parser.add_argument(
-            '--rfp-cli', default='rfp-cli', help='path to rfp-cli, default is rfp-cli'
+            '--rfp-cli', default=RFP_CLI_EXE, help='path to rfp-cli, default is rfp-cli'
         )
         parser.add_argument(
             '--port',
             default=DEFAULT_RFP_PORT,
             help='serial port to use, default is ' + str(DEFAULT_RFP_PORT),
         )
+        parser.add_argument(
+            '--tool',
+            help='emulator hardware to use (e2, e2l, jlink) when port is not set',
+        )
+        parser.add_argument(
+            '--interface',
+            help='selects the communications interface (uart, swd)',
+        )
         parser.add_argument('--device', help='Specify the device type to pass to rfp-cli')
         parser.add_argument('--verify', action='store_true', help='if given, verify after flash')
         parser.add_argument('--speed', help='Specify the serial port speed')
@@ -81,18 +99,39 @@ def do_create(cls, cfg, args):
             rfp_cli=args.rfp_cli,
             device=args.device,
             port=args.port,
+            tool=args.tool,
+            interface=args.interface,
             erase=args.erase,
             speed=args.speed,
             verify=args.verify,
         )
 
+    @staticmethod
+    def default_rfp():
+        global RFP_CLI_EXE
+
+        if platform.system() == 'Windows':
+            try:
+                import winreg
+
+                registry = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
+                key = winreg.OpenKey(registry, r"SOFTWARE\Classes\rpjfile\shell\Open\command")
+                val = winreg.QueryValue(key, None)
+                match = re.match(r'"(.*?)".*', val)[1]
+                RFP_CLI_EXE = str(Path(match).parent / 'rfp-cli.exe')
+            except Exception:
+                RFP_CLI_EXE = 'rfp-cli.exe'
+        else:
+            RFP_CLI_EXE = 'rfp-cli'
+
     def do_run(self, command, **kwargs):
         if command == 'flash':
             self.do_flash(**kwargs)
         else:
             self.logger.error("Unsuppported command")
 
     def do_flash(self, **kwargs):
+        self.require(self.rfp_cmd[0])
         self.ensure_output('hex')
 
         hex_name = self.cfg.hex_file
@@ -111,10 +150,18 @@ def do_flash(self, **kwargs):
         # Load image
         load_image += ['-p', '-file', hex_name]
 
-        port = ['-port', self.port]
+        if self.tool is None:
+            connection = ['-port', self.port]
+        else:
+            connection = ['-tool', self.tool]
+
+        if self.interface:
+            connection += ['-interface', self.interface]
+
         if self.speed:
-            port += ['-s', self.speed]
+            connection += ['-s', self.speed]
+
         device = ['-device', self.device]
 
-        cmd = self.rfp_cmd + port + device + load_image
+        cmd = self.rfp_cmd + connection + device + load_image
         self.check_call(cmd)

scripts/west_commands/tests/test_rfp.py

@@ -95,7 +95,7 @@
 
 
 def require_patch(program):
-    assert program in ['rfp']
+    assert program in ['rfp', 'rfp-cli', TEST_RFP_USR_LOCAL_RFP_CLI]
 
 
 os_path_isfile = os.path.isfile
@@ -109,7 +109,8 @@ def os_path_isfile_patch(filename):
 
 @patch('runners.core.ZephyrBinaryRunner.require', side_effect=require_patch)
 @patch('runners.core.ZephyrBinaryRunner.check_call')
-def test_rfp_init(cc, req, runner_config, tmpdir):
+@patch('runners.rfp.RfpBinaryRunner.default_rfp')
+def test_rfp_init(dr, cc, req, runner_config, tmpdir):
     """
     Test commands using a runner created by constructor.
 
@@ -129,7 +130,8 @@ def test_rfp_init(cc, req, runner_config, tmpdir):
 
 @patch('runners.core.ZephyrBinaryRunner.require', side_effect=require_patch)
 @patch('runners.core.ZephyrBinaryRunner.check_call')
-def test_rfp_create(cc, req, runner_config, tmpdir):
+@patch('runners.rfp.RfpBinaryRunner.default_rfp')
+def test_rfp_create(dr, cc, req, runner_config, tmpdir):
     """
     Test commands using a runner created from command line parameters.
 
@@ -154,7 +156,8 @@ def test_rfp_create(cc, req, runner_config, tmpdir):
 
 @patch('runners.core.ZephyrBinaryRunner.require', side_effect=require_patch)
 @patch('runners.core.ZephyrBinaryRunner.check_call')
-def test_rfp_create_with_speed(cc, req, runner_config, tmpdir):
+@patch('runners.rfp.RfpBinaryRunner.default_rfp')
+def test_rfp_create_with_speed(dr, cc, req, runner_config, tmpdir):
     """
     Test commands using a runner created from command line parameters.
 
@@ -185,7 +188,8 @@ def test_rfp_create_with_speed(cc, req, runner_config, tmpdir):
 
 @patch('runners.core.ZephyrBinaryRunner.require', side_effect=require_patch)
 @patch('runners.core.ZephyrBinaryRunner.check_call')
-def test_rfp_create_with_erase(cc, req, runner_config, tmpdir):
+@patch('runners.rfp.RfpBinaryRunner.default_rfp')
+def test_rfp_create_with_erase(dr, cc, req, runner_config, tmpdir):
     """
     Test commands using a runner created from command line parameters.
 
@@ -207,7 +211,8 @@ def test_rfp_create_with_erase(cc, req, runner_config, tmpdir):
 
 @patch('runners.core.ZephyrBinaryRunner.require', side_effect=require_patch)
 @patch('runners.core.ZephyrBinaryRunner.check_call')
-def test_rfp_create_with_verify(cc, req, runner_config, tmpdir):
+@patch('runners.rfp.RfpBinaryRunner.default_rfp')
+def test_rfp_create_with_verify(dr, cc, req, runner_config, tmpdir):
     """
     Test commands using a runner created from command line parameters.
 
@@ -229,7 +234,8 @@ def test_rfp_create_with_verify(cc, req, runner_config, tmpdir):
 
 @patch('runners.core.ZephyrBinaryRunner.require', side_effect=require_patch)
 @patch('runners.core.ZephyrBinaryRunner.check_call')
-def test_rfp_create_with_rfp_cli(cc, req, runner_config, tmpdir):
+@patch('runners.rfp.RfpBinaryRunner.default_rfp')
+def test_rfp_create_with_rfp_cli(dr, cc, req, runner_config, tmpdir):
     """
     Test commands using a runner created from command line parameters.