runners: pyocd: Convert to -i/--dev-id

Remove the previous pyocd-specific --board-id option and switch to
the common -i/--dev-id one.

Signed-off-by: Carles Cufi <[email protected]>

Author: carlescufi

scripts/west_commands/runners/pyocd.py

@@ -19,11 +19,11 @@ class PyOcdBinaryRunner(ZephyrBinaryRunner):
 
     def __init__(self, cfg, target,
                  pyocd='pyocd',
-                 flash_addr=0x0, erase=False, flash_opts=None,
+                 dev_id=None, flash_addr=0x0, erase=False, flash_opts=None,
                  gdb_port=DEFAULT_PYOCD_GDB_PORT,
                  telnet_port=DEFAULT_PYOCD_TELNET_PORT, tui=False,
                  pyocd_config=None,
-                 board_id=None, daparg=None, frequency=None, tool_opt=None):
+                 daparg=None, frequency=None, tool_opt=None):
         super().__init__(cfg)
 
         default = path.join(cfg.board_dir, 'support', 'pyocd.yaml')
@@ -53,8 +53,8 @@ def __init__(self, cfg, target,
         self.pyocd_config_args = pyocd_config_args
 
         board_args = []
-        if board_id is not None:
-            board_args = ['-u', board_id]
+        if dev_id is not None:
+            board_args = ['-u', dev_id]
         self.board_args = board_args
 
         daparg_args = []
@@ -81,7 +81,12 @@ def name(cls):
     @classmethod
     def capabilities(cls):
         return RunnerCaps(commands={'flash', 'debug', 'debugserver', 'attach'},
-                          flash_addr=True, erase=True)
+                          dev_id=True, flash_addr=True, erase=True)
+
+    @classmethod
+    def dev_id_help(cls) -> str:
+        return '''Device identifier. Use it to select the probe's unique ID
+                  or substring thereof.'''
 
     @classmethod
     def do_add_parser(cls, parser):
@@ -105,8 +110,8 @@ def do_add_parser(cls, parser):
                                 DEFAULT_PYOCD_TELNET_PORT))
         parser.add_argument('--tui', default=False, action='store_true',
                             help='if given, GDB uses -tui')
-        parser.add_argument('--board-id',
-                            help='ID of board to flash, default is to prompt')
+        parser.add_argument('--board-id', dest='dev_id',
+                            help='Deprecated: use -i/--dev-id instead')
         parser.add_argument('--tool-opt',
                             help='''Additional options for pyocd Commander,
                             e.g. \'--script=user.py\' ''')
@@ -121,7 +126,7 @@ def do_create(cls, cfg, args):
             pyocd=args.pyocd,
             flash_addr=flash_addr, erase=args.erase, flash_opts=args.flash_opt,
             gdb_port=args.gdb_port, telnet_port=args.telnet_port, tui=args.tui,
-            board_id=args.board_id, daparg=args.daparg,
+            dev_id=args.dev_id, daparg=args.daparg,
             frequency=args.frequency,
             tool_opt=args.tool_opt)
 

scripts/west_commands/tests/test_pyocd.py

@@ -18,7 +18,7 @@
 
 TEST_PYOCD = 'test-pyocd'
 TEST_ADDR = 0xadd
-TEST_BOARD_ID = 'test-board-id'
+TEST_DEV_ID = 'test-dev-id'
 TEST_FREQUENCY = 'test-frequency'
 TEST_DAPARG = 'test-daparg'
 TEST_TARGET = 'test-target'
@@ -34,7 +34,7 @@
     'gdb_port': TEST_GDB_PORT,
     'telnet_port': TEST_TELNET_PORT,
     'tui': False,
-    'board_id': TEST_BOARD_ID,
+    'dev_id': TEST_DEV_ID,
     'frequency': TEST_FREQUENCY,
     'daparg': TEST_DAPARG,
     'tool_opt': TEST_TOOL_OPT,
@@ -49,7 +49,7 @@
                     TEST_FLASH_OPTS] +
                    ['--gdb-port', str(TEST_GDB_PORT),
                     '--telnet-port', str(TEST_TELNET_PORT),
-                    '--board-id', TEST_BOARD_ID,
+                    '--dev-id', TEST_DEV_ID,
                     '--frequency', str(TEST_FREQUENCY),
                     '--tool-opt', TEST_TOOL_OPT])
 
@@ -71,7 +71,7 @@
                             'flash',
                             '-e', 'sector',
                             '-a', hex(TEST_ADDR), '-da', TEST_DAPARG,
-                            '-t', TEST_TARGET, '-u', TEST_BOARD_ID,
+                            '-t', TEST_TARGET, '-u', TEST_DEV_ID,
                             '-f', TEST_FREQUENCY,
                             TEST_TOOL_OPT] +
                            TEST_FLASH_OPTS +
@@ -86,7 +86,7 @@
                              '-p', str(TEST_GDB_PORT),
                              '-T', str(TEST_TELNET_PORT),
                              '-t', TEST_TARGET,
-                             '-u', TEST_BOARD_ID,
+                             '-u', TEST_DEV_ID,
                              '-f', TEST_FREQUENCY,
                              TEST_TOOL_OPT]
 DEBUG_ALL_EXPECTED_CLIENT = [RC_GDB, RC_KERNEL_ELF,
@@ -112,7 +112,7 @@
                                  '-p', str(TEST_GDB_PORT),
                                  '-T', str(TEST_TELNET_PORT),
                                  '-t', TEST_TARGET,
-                                 '-u', TEST_BOARD_ID,
+                                 '-u', TEST_DEV_ID,
                                  '-f', TEST_FREQUENCY,
                                  TEST_TOOL_OPT]
 DEBUGSERVER_DEF_EXPECTED_CALL = ['pyocd',