Skip to content

Documentation: document pyOCD CI termination after SDS playback #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReinhardKeil merged 1 commit into from
Jul 23, 2026
Merged

Documentation: document pyOCD CI termination after SDS playback #290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion documentation/sdsio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,9 @@ python sdsio-server.py -c myproject.sdsio.yml

**How it works:**

pyOCD does not required a connect message. Instead the RTT channel configuration is part of the `*.cbuild-run.yml` file that also specifies project files and other hardware related parameters. Refer to [CMSIS-Toolbox - Run and Debug Configuration](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview/#run-and-debug-configuration) for further information.
pyOCD does not require a connect message. Instead the RTT channel configuration is part of the `*.cbuild-run.yml` file that also specifies project files and other hardware related parameters. Refer to [CMSIS-Toolbox - Run and Debug Configuration](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview/#run-and-debug-configuration) for further information.

For CI runs that should stop automatically after SDS playback, start pyOCD with `--eot` and run SDSIO-Server with `--playback --exit-after-playback`. After playback completes, SDSIO-Server sets `SDS_FLAG_TERMINATE`. The target application can then write EOT (`0x04`). pyOCD can terminate on this character only when it receives the target standard output stream, for example through semihosting or RTT stdio. If standard output is retargeted directly to UART, the character bypasses pyOCD and `--eot` will not stop the pyOCD run.

## Layer: sdsio_fs

Expand Down
2 changes: 2 additions & 0 deletions documentation/utilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,8 @@ Then reload rules with `sudo udevadm control --reload && sudo udevadm trigger`.

The SDSIO-Server can be used in CI systems. When combined with the [pyOCD Debugger](https://open-cmsis-pack.github.io/cmsis-toolbox/pyOCD-Debugger/) fully automated HIL tests can be configured.

When `sdsio-server` runs with `--playback --exit-after-playback`, playback completion requests CI termination by setting `SDS_FLAG_TERMINATE` in the flags sent to the target. If the target application writes EOT (`0x04`) to standard output retargeted through a pyOCD-managed channel, such as semihosting or RTT stdio, pyOCD can detect it when started with `--eot` and exit. If standard output is retargeted directly to UART, pyOCD does not see that character, so `--eot` will not terminate pyOCD. Keep `--timelimit` as a fallback in case the target application does not reach the termination state or EOT is not routed through pyOCD.

This example contains the relevant steps in a GitHub workflow:

```
Expand Down
Loading