Commit Graph

24 Commits

Author SHA1 Message Date
Mathieu Choplain
19fe604aef scripts: west_commands: runners: add ST-LINK GDB server
Add the ST-Link GDB server (part of the STM32CubeCLT) as west runner.

The STM32CubeCLT is an all-in-one multi-OS command-line toolset, which is
part of the STM32Cube ecosystem, and notably includes a GDB server for
debugging using ST-Link probes.

This runner supports the "attach", "debug" and "debugserver" commands.

Documentation: https://www.st.com/en/development-tools/stm32cubeclt.html
Signed-off-by: Mathieu Choplain <mathieu.choplain@st.com>
2025-06-23 15:47:17 +01:00
TOKITA Hiroshi
aaa9d705a9 doc: develop: flash_debug: Add descs about blackmagicprobe and uf2
Add description about blackmagicprobe(host-tools and probes) and
uf2(host-tools only).

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
Co-authored-by: Benjamin Cabé <kartben@gmail.com>
Co-authored-by: Andrew Featherstone <andrew.featherstone@gmail.com>
2025-05-21 08:01:36 +02:00
Benjamin Cabé
f06c26a6d0 doc: extensions: boards: add zephyr:board-supported-runners directive
Use runners.yaml from build metadata to gather info regarding board
supported runners, store the info in the board catalog, and allow
to display it as a table in a board's doc page using the
.. zephyr:board-supported-runner:: directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-04-03 21:05:39 +02:00
Peter Johanson
4399d9e3a2 west: runners: rfp: Add Reneses Flash Programmer runner
Add a basic RFP runner that supports the `flash` command targettting
the Renesas Standard Boot Firmware.

Signed-off-by: Peter Johanson <peter@peterjohanson.com>
2025-03-31 19:49:22 -04:00
Benjamin Cabé
f7ad282504 boards: arduino: doc: Adopt Sphinx custom board directives
Adds zephyr:board and zephyr:board-supported-hw directives to the
Arduino docs in order to generate more of the boards' documentation
automatically.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-18 16:40:59 +01:00
Peter Johanson
27615a7cf1 west: runners: bossac: Honor --erase flag
Instead of unconditionally erasing the whole target, add
support for using the common --erase flag.

Signed-off-by: Peter Johanson <peter@peterjohanson.com>
2024-12-22 18:20:30 +00:00
Benjamin Cabé
97ba4ca553 boards: atmel: adopt new zephyr:board directive and role
This updates the documentation of all the Atmel boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
Benjamin Cabé
599e0625e3 boards: adafruit: adopt new zephyr:board directive and role
This updates the documentation of all the Adafruit boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
Abderrahmane Jarmouni
f8bac1ac1b doc: develop: flash_debug: host-tools: fix typo
Fix registred trademark typo

Signed-off-by: Abderrahmane Jarmouni <git@jarmouni.me>
2024-09-30 17:11:04 +01:00
Abderrahmane Jarmouni
b42549f071 doc: flash_debug: document stm32cubeprogrammer
Document STM32CubeProgrammer installation & usage with Zephyr.

Signed-off-by: Abderrahmane Jarmouni <git@jarmouni.me>
2024-09-09 15:25:31 +03:00
Chen Xingyu
0095c224fa scripts: west_commands: runners: Add support for probe-rs
probe-rs is a new programming and debugging tool written in Rust, supports
many probes and targets.

This commit introduces initial support for probe-rs to Zephyr.

Signed-off-by: Chen Xingyu <hi@xingrz.me>
2024-08-01 12:39:28 +02:00
Daniel DeGrasse
7150877801 doc: develop: flash_debug: add note for LinkServer breakpoints
LinkServer does not set a breakpoint at reset by default when debugging
platforms, so if the user single steps after loading an application they
will likely step through ROM code for the target. Add a note clarifying
that users need to set a breakpoint at the reset handler or "main" in
order to pause their application there.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-04-25 08:59:44 -04:00
Derek Snell
9260c5b6b2 doc: linkserver: update PATH
Added details to update PATH environment variable for linkserver

Signed-off-by: Derek Snell <derek.snell@nxp.com>
2024-02-02 09:09:20 +01:00
Derek Snell
117dc55233 doc: linkserver: update installer link
Updates link to MCUXpresso Installer

Signed-off-by: Derek Snell <derek.snell@nxp.com>
2024-01-23 22:11:02 -05:00
Andrej Butok
a21076bbf3 doc: pyocd: Add CMSIS DAP Onboard Debug Probe support
Add the CMSIS DAP Onboard Debug Probes to the list
of supported probes by pyOCD.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-01-12 15:57:32 -05:00
Manuel Argüelles
006a650690 doc: flash_debug: add NXP S32 debug probe docs
Document needed steps to download, install and setup the debug host
tools for NXP S32 Debug Probe.

Signed-off-by: Manuel Argüelles <manuel.arguelles@nxp.com>
2023-10-25 18:14:51 -07:00
Yves Vandervennet
1477865a7a linkserver: doc: updates for NXP's mimxrt1170
This commit adds the documentation details for the linkserver support
on rt1170.

Signed-off-by: Yves Vandervennet <yves.vandervennet@nxp.com>
2023-09-06 09:35:24 +02:00
Andreas Deininger
571f8591b9 documentation: Fix several typos
Correcting typos in various documentation files

Signed-off-by: Andreas Deininger <andreas@deininger.net>
2023-08-07 13:07:50 +02:00
Yves Vandervennet
58e4df6460 west: runner: add support for NXP's linkserver
Linkserver is a utility for launching and managing GDB servers for NXP
debug probes, which also provides a command-line target flash programming
capabilities. Linkserver can be used with NXP MCUXpresso for Visual Studio
Code.

For more information about LinkServer, please visit the LinkServer web
page (link [1] below).

This commit adds a runner to west, supporting debug and flash commands.

Documentation is also added.

[1] - LinkServer web page:
    https://www.nxp.com/design/software/development-software/mcuxpresso-software-and-tools-/linkserver-for-microcontrollers:LINKERSERVER

Signed-off-by: Yves Vandervennet <yves.vandervennet@nxp.com>
2023-07-21 14:57:25 -05:00
Daniel DeGrasse
8a686cac53 docs: flash_debug: host_tools: Fix reference to jlink host tools
Fix reference to JLink host tools to be located in correct section, so
that output documentation fills in the correct header name when this
section is referenced.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2023-07-11 13:15:06 -04:00
João Dullius
79d9f45296 scripts: runners: bossac: Enable BOSSAC to run on Windows (native)
Fixes #37538 by correctly detecting WSL and blocking bossac from running
on that platform, but allowing it to run on Windows native.

Signed-off-by: João Dullius <joaodullius@bpmrep.com.br>
2023-03-06 13:17:09 -08:00
Manuel Arguelles
31b3993d58 scripts: west: introduce Lauterbach TRACE32 runner
This patch introduces a West runner for flashing and debugging with
Lauterbach TRACE32 debuggers. The runner consists of a wrapper around
TRACE32 software, and allows a Zephyr board to execute a custom start-up
script (Practice Script) for the different commands supported, including
the ability to pass extra arguments from CMake. Is up to the board using
this runner to define the actions performed on each command.

The `debug` command launches TRACE32 GUI to allow debug the Zephyr
application, while the `flash` command hides the GUI and executes the
start-up script in a background process.

Signed-off-by: Manuel Arguelles <manuel.arguelles@nxp.com>
2022-10-14 09:51:14 +02:00
Stephanos Ioannidis
cf400c6c63 doc: flash_debug: Update OpenOCD and pyOCD links
This commit updates the outdated links for OpenOCD and pyOCD.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Anas Nashif
0ee7e42ef0 doc: move flashing/debugging section to developing with zephyr
This section belongs in the intro about developing with Zephyr.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00