runners: stm32cubeprogrammer: add support for --dev-id

Add support for the standard `--dev-id` argument used to select
target ST-Link debug probe based on serial number. Note that this
could already be achieved using custom argument `--conn-modifiers`.
(`--dev-id <XXX>` is equivalent to `--conn-modifiers sn=<XXX>`)

Signed-off-by: Mathieu Choplain <[email protected]>

Author: mathieuchopstm

scripts/west_commands/runners/stm32cubeprogrammer.py

@@ -32,6 +32,7 @@ def __init__(
         self,
         cfg: RunnerConfig,
         port: str,
+        dev_id: str | None,
         frequency: int | None,
         reset_mode: str | None,
         download_address: int | None,
@@ -48,6 +49,7 @@ def __init__(
         super().__init__(cfg)
 
         self._port = port
+        self._dev_id = dev_id
         self._frequency = frequency
 
         self._download_address = download_address
@@ -146,7 +148,7 @@ def name(cls):
 
     @classmethod
     def capabilities(cls):
-        return RunnerCaps(commands={"flash"}, erase=True, extload=True, tool_opt=True)
+        return RunnerCaps(commands={"flash"}, dev_id=True, erase=True, extload=True, tool_opt=True)
 
     @classmethod
     def do_add_parser(cls, parser):
@@ -230,6 +232,7 @@ def do_create(
         return STM32CubeProgrammerBinaryRunner(
             cfg,
             port=args.port,
+            dev_id=args.dev_id,
             frequency=args.frequency,
             reset_mode=args.reset_mode,
             download_address=args.download_address,
@@ -262,6 +265,8 @@ def flash(self, **kwargs) -> None:
             connect_opts += f" reset={reset_mode}"
         if self._conn_modifiers:
             connect_opts += f" {self._conn_modifiers}"
+        if self._dev_id:
+            connect_opts += f" sn={self._dev_id}"
 
         cmd += ["--connect", connect_opts]
         cmd += self._tool_opt

scripts/west_commands/tests/test_stm32cubeprogrammer.py

@@ -62,6 +62,7 @@
 TEST_CASES = (
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -89,6 +90,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -117,6 +119,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": "4000",
         "reset_mode": None,
         "download_address": None,
@@ -144,6 +147,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": "hw",
         "download_address": None,
@@ -171,6 +175,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": "sw",
         "download_address": None,
@@ -198,6 +203,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": "core",
         "download_address": None,
@@ -225,11 +231,12 @@
     },
     {
         "port": "swd",
+        "dev_id": "TEST",
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
         "start_address": None,
-        "conn_modifiers": "br=115200 sn=TEST",
+        "conn_modifiers": "br=115200",
         "start_modifiers": [],
         "download_modifiers": [],
         "cli": CLI_PATH,
@@ -252,6 +259,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -279,6 +287,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -307,6 +316,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -335,6 +345,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -362,6 +373,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -389,6 +401,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": None,
@@ -416,6 +429,7 @@
     },
     {
         "port": "swd",
+        "dev_id": None,
         "frequency": None,
         "reset_mode": None,
         "download_address": 0x80000000,
@@ -475,6 +489,7 @@ def test_stm32cubeprogrammer_init(
     runner = STM32CubeProgrammerBinaryRunner(
         cfg=runner_config,
         port=tc["port"],
+        dev_id=tc["dev_id"],
         frequency=tc["frequency"],
         reset_mode=tc["reset_mode"],
         download_address=tc["download_address"],
@@ -514,6 +529,8 @@ def test_stm32cubeprogrammer_create(
     system.return_value = tc["system"]
 
     args = ["--port", tc["port"]]
+    if tc["dev_id"]:
+        args.extend(["--dev-id", tc["dev_id"]])
     if tc["frequency"]:
         args.extend(["--frequency", tc["frequency"]])
     if tc["reset_mode"]: