twister: support segger real-time-transfer (rtt) for serial_pty via west #81837

cfriedt · 2024-11-24T18:27:46Z

Add initial support for RTT (Segger Real-time Transfer) for reading console messages with twister via west when testing with hardware.

Note

This support should be considered experimental as transfer speed, buffering, buffer size, and buffer count are all tuneable parameters that can vary per-platform and debug adapter. Physical UARTs or other higher-speed I/O interfaces are certainly still the primary means of capturing test output from twister when connected to hardware.

Tested with:

twister -p nucleo_l496zg --device-testing --flash-before --west-runner openocd --west-flash --device-serial-pty rtt -T samples/hello_world

cat twister-out/nucleo_l496zg_stm32l496xx/samples/hello_world/sample.basic.helloworld/handler.log
*** Booting Zephyr OS build v4.0.0-749-gc9e567da3747 ***
Hello World! nucleo_l496zg/stm32l496xx

This change set also includes updates to jlink and openocd west runners to add an --rtt-quiet option. The new option suppresses the stdout and stderr of subprocesses (e.g. JLinkRTTLogger or openocd), which is the expectation for --device-serial-pty scripts. By suppressing unnecessary output, we can leverage west rtt in an automatically generated shell script (as opposed to importing or duplicating more python code in twister).

Currently, the only other RTT-capable west runner is pyocd.

Additionally, the DeviceHandler.handle() method of handler.py is a bit tricky to work with; I was unsuccessful in making separate methods for _do_flash() and _do_serial() portions of the operation. That would have simplified the --flash-before logic. Python was throwing exceptions claiming that code was attempting to adjust objects shared between processes without synchronization. At some point, the handle() method should probably be refactored, but it was considered beyond what was necessary for the first draft of this PR.

cfriedt · 2024-11-24T18:39:11Z

@topisani - it would be great if you could try this out as well.

cfriedt · 2024-11-24T23:18:52Z

Oh wow - the bot made a lot of review requests 😅

cfriedt · 2024-11-26T17:26:44Z

switched to using the already-resolved runner variable instead of pulling it out of self.options.west_runner exclusively, since the --hardware-map option can also be used to provide the runner

It would be good to also parse the --west-flash argument (if it exists) and the runner_params field of the hardware map file to extract runner arguments.

cfriedt · 2024-11-26T17:32:30Z

replaced self.rtt_port = rtt_quiet with self.rtt_quiet = rtt_quiet in jlink.py

scripts/pylib/twister/twisterlib/environment.py

Add support for the --rtt-quiet argument, which prevents subprocesses from printing to stdout and stderr, so that rtt messages are the only items printed to standard output. This almnost completely silences the 'west rtt' command with the exception of '-- west rtt: using runner openocd' bring printed on the first line of the output. In order to silence that line from west, the top-level '--quiet' argument must be passed to west. E.g. west -qqqq rtt --rtt-quiet ... Signed-off-by: Chris Friedt <[email protected]>

Ensure that --device-serial-pty may be used with --flash-before in order to support capturing test results via RTT console. This is required (at least) for openocd, since the flash (or debug or rtt or any other operation) will fail if an existing process is already in control of the USB device in question. Signed-off-by: Chris Friedt <[email protected]>

Support RTT (Segger Real-time Transfer) for reading console messages with twister when testing with hardware. Tested with: twister -p nucleo_l496zg --device-testing --flash-before \ --west-runner openocd --west-flash --device-serial-pty rtt \ -T samples/hello_world cat twister-out/nucleo_l496zg_stm32l496xx/samples/hello_world/\ sample.basic.helloworld/handler.log *** Booting Zephyr OS build v4.0.0-749-gc9e567da3747 *** Hello World! nucleo_l496zg/stm32l496xx Signed-off-by: Chris Friedt <[email protected]>

cfriedt · 2025-01-10T18:04:12Z

rebased to fix merge conflict

hakehuang

can we update document for this?

nashif · 2025-01-17T14:01:43Z

scripts/pylib/twister/twisterlib/environment.py

@@ -873,6 +873,18 @@ def parse_arguments(
        logger.error("west-flash requires device-testing to be enabled")
        sys.exit(1)

+    if options.device_serial_pty and options.device_serial_pty == "rtt":
+        if options.west_flash is None:
+            logger.error("--device-serial-pty rtt requires --west-flash")


--device-serial-pty accept a script name, can be anything, here you assume that the script name (is this a script?) is always going to be rtt, or asking that if someone want to use this, they have to call their script rtt?

No, in this case rtt is a keyword, and twister simply re-uses west's rtt integration.

Normally, the argument for device-serial-pty is a script through, so that hasn't changed.

nashif · 2025-01-17T14:04:39Z

scripts/pylib/twister/twisterlib/environment.py

+            sys.exit(1)
+
+        # add the following options
+        options.extra_args += ['CONFIG_USE_SEGGER_RTT=y',


not a fan of injecting HW related kconfigs into twister like this, this should be done on the platform/hardware map/ or test level, not in twister. Using a snippet for example is an option.

I've found actually that this works better with a snippet specified in testcase.yml.

I think this can be removed.

nashif · 2025-01-17T14:07:07Z

scripts/pylib/twister/twisterlib/handlers.py

@@ -706,6 +707,23 @@ def _get_serial_device(self, serial_pty, hardware_serial):

        return serial_device, ser_pty_process

+    def _create_serial_pty_script(self, runner):


ok, so you are creating the pty script on the fly, if I understand this correctly, it is an abuse of the --device-serial-pty option, we probably need something else to cover this case.

"abuse" is probably a strong term.

I prefer "reuse" - we're simply reusing west's rtt integration.

device.add_argument("--device-serial-pty", help="""Script for controlling pseudoterminal. Twister believes that it interacts with a terminal when it actually interacts with the script. E.g "twister --device-testing --device-serial-pty <script>

Not using a script here is wrong usage. If you want to use a built-in rtt support you are adding, you need to find another way, maybe yet another option that deals with keywords

nashif · 2025-01-17T18:43:02Z

why close?

cfriedt requested review from fabiobaltieri, pdgendt and nashif November 24, 2024 18:28

cfriedt force-pushed the twister-rtt-support branch 2 times, most recently from f0f5565 to f71d4f1 Compare November 24, 2024 18:35

cfriedt marked this pull request as ready for review November 24, 2024 23:16

zephyrbot added area: West West utility area: Twister Twister labels Nov 24, 2024

zephyrbot requested review from carlescufi, gchwier, golowanow, hakehuang, KamilxPaszkiet, LukaszMrugala, mbolivar-ampere, PerMac and swinslow November 24, 2024 23:16

zephyrbot assigned nashif Nov 24, 2024

cfriedt force-pushed the twister-rtt-support branch from f71d4f1 to 04de997 Compare November 26, 2024 17:22

cfriedt force-pushed the twister-rtt-support branch from 04de997 to 9d346ad Compare November 26, 2024 17:31

cfriedt changed the title ~~twister: support segger real-time-transfer (rtt) for serial_pty~~ twister: support segger real-time-transfer (rtt) for serial_pty via west Nov 30, 2024

cfriedt commented Nov 30, 2024

View reviewed changes

scripts/pylib/twister/twisterlib/environment.py Show resolved Hide resolved

cfriedt added 4 commits January 10, 2025 13:02

cfriedt force-pushed the twister-rtt-support branch from 9d346ad to 5e91f54 Compare January 10, 2025 18:03

zephyrbot requested a review from mbolivar January 10, 2025 18:04

hakehuang approved these changes Jan 13, 2025

View reviewed changes

nashif requested changes Jan 17, 2025

View reviewed changes

cfriedt closed this Jan 17, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

twister: support segger real-time-transfer (rtt) for serial_pty via west #81837

twister: support segger real-time-transfer (rtt) for serial_pty via west #81837

cfriedt commented Nov 24, 2024 •

edited

Loading

cfriedt commented Nov 24, 2024

cfriedt commented Nov 24, 2024

cfriedt commented Nov 26, 2024 •

edited

Loading

cfriedt commented Nov 26, 2024

cfriedt commented Jan 10, 2025

hakehuang left a comment

nashif Jan 17, 2025

cfriedt Jan 17, 2025

nashif Jan 17, 2025

cfriedt Jan 17, 2025

nashif Jan 17, 2025

cfriedt Jan 17, 2025

nashif Jan 17, 2025

nashif commented Jan 17, 2025

		@@ -706,6 +707,23 @@ def _get_serial_device(self, serial_pty, hardware_serial):

		return serial_device, ser_pty_process

		def _create_serial_pty_script(self, runner):

twister: support segger real-time-transfer (rtt) for serial_pty via west #81837

twister: support segger real-time-transfer (rtt) for serial_pty via west #81837

Conversation

cfriedt commented Nov 24, 2024 • edited Loading

cfriedt commented Nov 24, 2024

cfriedt commented Nov 24, 2024

cfriedt commented Nov 26, 2024 • edited Loading

cfriedt commented Nov 26, 2024

cfriedt commented Jan 10, 2025

hakehuang left a comment

Choose a reason for hiding this comment

nashif Jan 17, 2025

Choose a reason for hiding this comment

cfriedt Jan 17, 2025

Choose a reason for hiding this comment

nashif Jan 17, 2025

Choose a reason for hiding this comment

cfriedt Jan 17, 2025

Choose a reason for hiding this comment

nashif Jan 17, 2025

Choose a reason for hiding this comment

cfriedt Jan 17, 2025

Choose a reason for hiding this comment

nashif Jan 17, 2025

Choose a reason for hiding this comment

nashif commented Jan 17, 2025

cfriedt commented Nov 24, 2024 •

edited

Loading

cfriedt commented Nov 26, 2024 •

edited

Loading