cbuild_run: rename cbuild_run.telnet options to singular form

Author: DavidLesnjak

pyocd/core/options.py

@@ -1,5 +1,5 @@
 # pyOCD debugger
-# Copyright (c) 2018-2020,2025 Arm Limited
+# Copyright (c) 2018-2020,2025-2026 Arm Limited
 # Copyright (c) 2020 Patrick Huesmann
 # Copyright (c) 2022 Chris Reed
 # SPDX-License-Identifier: Apache-2.0
@@ -205,15 +205,15 @@ class OptionInfo(NamedTuple):
         "Replace software breakpoints with hardware breakpoints."),
 
     # Internal cbuild-run session options
-    OptionInfo('cbuild_run.gdbserver_ports', tuple, None,
+    OptionInfo('cbuild_run.gdbserver_port', tuple, None,
         "List of TCP ports for the gdbserver."),
-    OptionInfo('cbuild_run.telnet_ports', tuple, None,
+    OptionInfo('cbuild_run.telnet_port', tuple, None,
         "List of TCP ports for telnet server."),
-    OptionInfo('cbuild_run.telnet_modes', tuple, None,
+    OptionInfo('cbuild_run.telnet_mode', tuple, None,
         "List of telnet modes for each core."),
-    OptionInfo('cbuild_run.telnet_files_in', tuple, None,
+    OptionInfo('cbuild_run.telnet_file_in', tuple, None,
         "List of telnet input file paths for each core."),
-    OptionInfo('cbuild_run.telnet_files_out', tuple, None,
+    OptionInfo('cbuild_run.telnet_file_out', tuple, None,
         "List of telnet output file paths for each core."),
     ]
 

pyocd/core/session.py

@@ -1,5 +1,5 @@
 # pyOCD debugger
-# Copyright (c) 2018-2020,2025 Arm Limited
+# Copyright (c) 2018-2020,2025-2026 Arm Limited
 # Copyright (c) 2021-2023 Chris Reed
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -287,17 +287,17 @@ def _get_cbuild_run_config(self, command: Optional[str]) -> Dict[str, Any]:
 
         # Only set gdbserver_port if it wasn't already set in options (command line).
         if not self.options.is_set('gdbserver_port'):
-            debugger_options['cbuild_run.gdbserver_ports'] = self.cbuild_run.gdbserver_ports
+            debugger_options['cbuild_run.gdbserver_port'] = self.cbuild_run.gdbserver_port
 
         # Only set telnet_port if it wasn't already set in options (command line).
         if not self.options.is_set('telnet_port'):
-            debugger_options['cbuild_run.telnet_ports'] = self.cbuild_run.telnet_ports
+            debugger_options['cbuild_run.telnet_port'] = self.cbuild_run.telnet_port
 
         if not self.options.is_set('semihost_console_type'):
-            debugger_options['cbuild_run.telnet_modes'] = self.cbuild_run.telnet_modes
-            telnet_files = self.cbuild_run.telnet_files
-            debugger_options['cbuild_run.telnet_files_in'] = telnet_files.get('in')
-            debugger_options['cbuild_run.telnet_files_out'] = telnet_files.get('out')
+            debugger_options['cbuild_run.telnet_mode'] = self.cbuild_run.telnet_mode
+            telnet_file = self.cbuild_run.telnet_file
+            debugger_options['cbuild_run.telnet_file_in'] = telnet_file.get('in')
+            debugger_options['cbuild_run.telnet_file_out'] = telnet_file.get('out')
 
         # Set reset types for load operations.
         debugger_options['load.pre_reset'] = self.cbuild_run.pre_reset

pyocd/gdbserver/gdbserver.py

@@ -1,5 +1,5 @@
 # pyOCD debugger
-# Copyright (c) 2006-2020,2025 Arm Limited
+# Copyright (c) 2006-2020,2025-2026 Arm Limited
 # Copyright (c) 2021-2022 Chris Reed
 # Copyright (c) 2022 Clay McClure
 # SPDX-License-Identifier: Apache-2.0
@@ -301,9 +301,9 @@ def __init__(self, session, core=None):
             self.target = self.board.target.cores[core]
         self.name = "gdb-server-core%d" % self.core
 
-        if session.options.is_set('cbuild_run.gdbserver_ports'):
+        if session.options.is_set('cbuild_run.gdbserver_port'):
             # Per-core gdbserver ports configured.
-            _port = session.options.get('cbuild_run.gdbserver_ports')[self.core]
+            _port = session.options.get('cbuild_run.gdbserver_port')[self.core]
             # Check if no port was configured for this core, use 0 in that case.
             self.port = _port if _port is not None else 0
         else:

pyocd/target/pack/cbuild_run.py

@@ -1,5 +1,5 @@
 # pyOCD debugger
-# Copyright (c) 2025 Arm Limited
+# Copyright (c) 2025-2026 Arm Limited
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -577,21 +577,21 @@ def connect_mode(self) -> str:
         return connect
 
     @property
-    def gdbserver_ports(self) -> Optional[Tuple]:
+    def gdbserver_port(self) -> Optional[Tuple]:
         """@brief GDB server port assignments from debugger section.
             The method will not be called frequently, so performance is not critical.
         """
-        return self._get_server_ports('gdbserver')
+        return self._get_server_port('gdbserver')
 
     @property
-    def telnet_ports(self) -> Optional[Tuple]:
+    def telnet_port(self) -> Optional[Tuple]:
         """@brief Telnet server port assignments from debugger section.
             The method will not be called frequently, so performance is not critical.
         """
-        return self._get_server_ports('telnet')
+        return self._get_server_port('telnet')
 
     @property
-    def telnet_modes(self) -> Tuple:
+    def telnet_mode(self) -> Tuple:
         """@brief Telnet server mode assignments from debugger section.
             The method will not be called frequently, so performance is not critical.
         """
@@ -607,7 +607,7 @@ def telnet_modes(self) -> Tuple:
         global_mode = next((t.get('mode') for t in telnet_config if 'pname' not in t), 'off')
         global_mode = MODE_ALIASES.get(global_mode, global_mode)
         # Build list of telnet modes for each core
-        telnet_modes = []
+        telnet_mode = []
         for core in self.sorted_processors:
             mode = next((t.get('mode') for t in telnet_config if t.get('pname') == core.name), global_mode)
             mode = MODE_ALIASES.get(mode, mode)
@@ -616,20 +616,20 @@ def telnet_modes(self) -> Tuple:
                     LOG.warning("Invalid telnet mode '%s' for core '%s' in cbuild-run, defaulting to '%s'",
                             mode, core.name, global_mode)
                 mode = global_mode
-            telnet_modes.append(mode)
+            telnet_mode.append(mode)
 
-        return tuple(telnet_modes)
+        return tuple(telnet_mode)
 
     @property
-    def telnet_files(self) -> Dict[str, Optional[Tuple]]:
+    def telnet_file(self) -> Dict[str, Optional[Tuple]]:
         """@brief Telnet file path assignments from debugger section.
             The method will not be called frequently, so performance is not critical.
         """
         # Get telnet configuration from debugger section
         telnet_config = self.debugger.get('telnet') or []
-        telnet_modes = self.telnet_modes
+        telnet_mode = self.telnet_mode
 
-        if not any(mode == 'file' for mode in telnet_modes):
+        if not any(mode == 'file' for mode in telnet_mode):
             # No telnet file paths needed
             return {'in': None, 'out': None}
 
@@ -651,7 +651,7 @@ def _resolve_path(file_path: Optional[str], strict: bool = False) -> Optional[st
 
         if config_by_pname:
             # Build config per pname
-            for proc_info, mode in zip(self.sorted_processors, telnet_modes):
+            for proc_info, mode in zip(self.sorted_processors, telnet_mode):
                 if mode != 'file':
                     in_files.append(None)
                     out_files.append(None)
@@ -672,7 +672,7 @@ def _resolve_path(file_path: Optional[str], strict: bool = False) -> Optional[st
             if config is not None:
                 if len(self.sorted_processors) > 1:
                     LOG.warning("Ignoring invalid telnet file configuration for multicore target in cbuild-run")
-                    for proc_info, mode in zip(self.sorted_processors, telnet_modes):
+                    for proc_info, mode in zip(self.sorted_processors, telnet_mode):
                         if mode != 'file':
                             in_files.append(None)
                             out_files.append(None)
@@ -716,7 +716,7 @@ def populate_target(self, target: Optional[str] = None) -> None:
         })
         TARGET[target] = tgt
 
-    def _get_server_ports(self, server_type: str) -> Optional[Tuple]:
+    def _get_server_port(self, server_type: str) -> Optional[Tuple]:
         """@brief Generic method to get server port assignments from debugger section."""
         server_config = self.debugger.get(server_type, [])
         if not server_config:

pyocd/utility/stdio.py

@@ -58,9 +58,9 @@ class StdioTelnet(StdioBase):
     """STDIO backend that uses a telnet server for reading from and writing to stdin/stdout."""
 
     def __init__(self, session: Session, core: int = 0) -> None:
-        if session.options.is_set('cbuild_run.telnet_ports'):
+        if session.options.is_set('cbuild_run.telnet_port'):
             # Per-core telnet ports configured.
-            telnet_port = session.options.get('cbuild_run.telnet_ports')[core]
+            telnet_port = session.options.get('cbuild_run.telnet_port')[core]
             if telnet_port is None:
                 LOG.info("Telnet port for core %d is not specified and will be auto-assigned", core)
                 telnet_port = 0
@@ -119,15 +119,15 @@ class StdioFile(StdioBase):
 
     def __init__(self, session: Session, core: int = 0) -> None:
         # Get file paths from session options
-        if session.options.is_set('cbuild_run.telnet_files_out'):
-            telnet_file_out = session.options.get('cbuild_run.telnet_files_out')[core]
+        if session.options.is_set('cbuild_run.telnet_file_out'):
+            telnet_file_out = session.options.get('cbuild_run.telnet_file_out')[core]
             if telnet_file_out is None:
                 raise ValueError(f"STDIO file for core {core} requires a valid output file path")
         else:
             raise ValueError(f"STDIO file for core {core} requires a valid output file path")
 
-        if session.options.is_set('cbuild_run.telnet_files_in'):
-            telnet_file_in = session.options.get('cbuild_run.telnet_files_in')[core]
+        if session.options.is_set('cbuild_run.telnet_file_in'):
+            telnet_file_in = session.options.get('cbuild_run.telnet_file_in')[core]
         else:
             telnet_file_in = None
 
@@ -285,9 +285,9 @@ class StdioHandler(StdioBase):
 
     def __init__(self, session: Session, core: int = 0, eot_enabled: bool = False) -> None:
 
-        if session.options.is_set('cbuild_run.telnet_modes'):
+        if session.options.is_set('cbuild_run.telnet_mode'):
             # Per-core telnet modes configured.
-            stdio_mode = session.options.get('cbuild_run.telnet_modes')[core]
+            stdio_mode = session.options.get('cbuild_run.telnet_mode')[core]
         else:
             stdio_mode = session.options.get('semihost_console_type')