boards: doc: adopt zephyr:board-supported-runners directive

Add .. zephyr:board-supported-runners:: to the Programming and Debugging
section of the documentation for each board that has one such section,
as this is the most natural place to put it.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2025-03-31 18:36:14 +02:00 committed by Benjamin Cabé
commit de13103f0b
572 changed files with 1160 additions and 10 deletions

View file

@ -67,6 +67,8 @@ retrieve those files.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Standalone application
======================

View file

@ -61,6 +61,8 @@ pinouts and the schematic.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Prerequisites
=============

View file

@ -54,6 +54,8 @@ pinouts and the schematic.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Prerequisites
=============

View file

@ -48,6 +48,8 @@ including pinouts and the schematic.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Prerequisites
=============

View file

@ -86,6 +86,8 @@ board including `pinouts`_ and the `schematic`_.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Prerequisites
=============

View file

@ -89,6 +89,8 @@ the board including `pinouts`_ and the `schematic`_.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Prerequisites
=============

View file

@ -68,6 +68,8 @@ serial port that echos characters back to the host PC.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Adafruit Feather M0 Basic Proto ships with a BOSSA compatible
SAM-BA bootloader. The bootloader can be entered by quickly tapping
the reset button twice.

View file

@ -75,6 +75,8 @@ version, 433MHz or 900MHz is supported.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Adafruit Feather M0 with LoRa ships with a BOSSA compatible
SAM-BA bootloader. The bootloader can be entered by quickly tapping
the reset button twice.

View file

@ -73,6 +73,8 @@ serial port that echos characters back to the host PC.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Feather ships with a the BOSSA compatible UF2 bootloader. The
bootloader can be entered by quickly tapping the reset button twice.

View file

@ -93,6 +93,8 @@ Push buttons
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -64,6 +64,8 @@ dedicated to the 2 MB SPI Flash chip.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
DFU-Util programming is supported through Zephyr by default. Set up
of the built in DFU-Util bootloader is possible by following the
`instructions on the Learn website`_.

View file

@ -65,6 +65,8 @@ serial port that echos characters back to the host PC.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Grand Central ships with a BOSSA compatible UF2 bootloader.
The bootloader can be entered by quickly tapping the reset button twice.

View file

@ -86,6 +86,9 @@ your board. The button and LED definitions can be found in
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The ItsyBitsy ships with the BOSSA compatible UF2 bootloader. The
bootloader can be entered by quickly tapping the reset button twice.

View file

@ -72,6 +72,8 @@ serial port that echos characters back to the host PC.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The ItsyBitsy ships with a the BOSSA compatible UF2 bootloader. The
bootloader can be entered by quickly tapping the reset button twice.

View file

@ -52,6 +52,8 @@ Default Zephyr Peripheral Mapping:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -35,6 +35,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``adafruit_macropad_rp2040`` board target can be built and
flashed in the usual way (see :ref:`build_an_application` and
:ref:`application_run` for more details).

View file

@ -58,6 +58,8 @@ Push buttons
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The ``nrf52_adafruit_feather`` board is available in two different versions:
- `Adafruit Feather nRF52 Pro with myNewt Bootloader`_

View file

@ -51,6 +51,8 @@ command below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -54,6 +54,8 @@ Default Zephyr Peripheral Mapping:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -70,6 +70,8 @@ serial port that echos characters back to the host PC.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Trinket M0 ships the BOSSA compatible UF2 bootloader. The
bootloader can be entered by quickly tapping the reset button twice.

View file

@ -74,6 +74,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========
The MAX32650 MCU can be flashed by connecting an external debug probe to the

View file

@ -157,6 +157,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -83,6 +83,8 @@ to a FT232, so available through Micro USB connector. Default settings are 11520
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -88,6 +88,8 @@ Same UART1 TX and RX cmos signals are available before the FT232, at P9 connecto
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -70,6 +70,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========
The MAX32650 MCU can be flashed by connecting an external debug probe to the

View file

@ -69,6 +69,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========
The MAX32650 MCU can be flashed by connecting an external debug probe to the

View file

@ -127,6 +127,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -152,6 +152,8 @@ used as a user LED.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -76,6 +76,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -169,6 +169,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -255,6 +255,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -174,6 +174,8 @@ JH4 Pinout
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -148,6 +148,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -279,12 +279,10 @@ The I2C ports can independently pulled up to V_AUX (3.3V default) through JP4 (I
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The IC can be reset by pushbutton SW1.
Programming and Debugging
*************************
Flashing
========

View file

@ -164,6 +164,8 @@ J7 Pinout
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -344,6 +344,8 @@ respectively. If the pushbutton is pressed, the attached port pin is pulled low.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -287,6 +287,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -241,6 +241,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -68,6 +68,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -235,6 +235,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -138,6 +138,8 @@ J4 Pinout
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -408,6 +408,8 @@ Connections and IOs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -103,6 +103,8 @@ Default Zephyr Peripheral Mapping:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The ADI SDP-K1 be programmed over USB using the DAPLink firmware running on an
embedded NXP Freescale microcontroller or a 10-pin ``DEBUG`` header connected
to a STLINK debugger.

View file

@ -121,6 +121,8 @@ Default settings are 115200 8N1.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -130,6 +130,8 @@ in the SDK:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -69,6 +69,8 @@ The bottom three variables are specific to acp_6_0.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Building
========

View file

@ -55,6 +55,8 @@ The following platform features are unsupported:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Currently the best way to run this sample is by loading it through remoteproc
from the APU, running Linux, to the RPU, assuming the target board has a compatible
Linux kernel.

View file

@ -52,6 +52,8 @@ The following platform features are unsupported:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Build and flash in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::

View file

@ -170,6 +170,8 @@ settings are 115200 8N1.
Programming and debugging
*************************
.. zephyr:board-supported-runners::
For debugging zephyr applications or burning them into a flash, you will need to
connect Andes ICE from host computer to ADP-XC7K board and execute the
Andes ICE management software, ICEman, on this host computer.

View file

@ -172,6 +172,8 @@ settings are 115200 8N1.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``myra_sip_baseboard`` board target can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details).
Flashing

View file

@ -104,6 +104,8 @@ default, is utilizing this controller.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -63,6 +63,8 @@ two cores. This is done in 3 ways:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``arduino_giga_r1`` board should be built per core target,
using either ``arduino_giga_r1/stm32h747xx/m7`` or ``arduino_giga_r1/stm32h747xx/m4`` as the target.

View file

@ -78,6 +78,8 @@ Arduino MKR Zero, the DAC is available on pin A0.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Arduino MKR Zero ships the BOSSA compatible bootloader. The
bootloader can be entered by quickly tapping the reset button twice.

View file

@ -29,6 +29,8 @@ as ``pull-up-gpios``.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
This board requires the Arduino variant of bossac. You will not
be able to flash with the bossac included with the zephyr-sdk, or
using shumatech's mainline build.

View file

@ -66,6 +66,8 @@ serial port that echos characters back to the host PC.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Nano 33 IOT ships the BOSSA compatible UF2 bootloader. The
bootloader can be entered by quickly tapping the reset button twice.

View file

@ -48,6 +48,8 @@ For more details please refer to the `datasheet`_, `full pinout`_ and the `schem
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``arduino_nicla_sense_me`` board configuration can be built and
flashed in the usual way (see :ref:`build_an_application` and
:ref:`application_run` for more details).

View file

@ -67,6 +67,8 @@ two cores. This is done in 3 ways:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``arduino_nicla_vision`` board should be built per core target,
using either ``arduino_nicla_vision/stm32h747xx/m7`` or ``arduino_nicla_vision/stm32h747xx/m4`` as the target.

View file

@ -98,6 +98,8 @@ two cores. This is done in 3 ways:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``arduino_opta`` use the regular Zephyr build commands.
See :ref:`build_an_application` for more information about application builds.

View file

@ -66,7 +66,9 @@ two cores. This is done in 3 ways:
to avoid potential concurrent access issues.
Building and Flashing
*************************
*********************
.. zephyr:board-supported-runners::
Applications for the ``arduino_portenta_h7`` board should be built per core target,
using either ``arduino_portenta_h7_m7`` or ``arduino_portenta_h7_m4`` as the target.

View file

@ -25,6 +25,8 @@ Supported Features
Programming and debugging
*************************
.. zephyr:board-supported-runners::
Debug adapter
=============

View file

@ -74,6 +74,8 @@ Arduino Zero, the DAC is available on pin A0.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The Arduino Zero comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAMD21 chip and is supported by
OpenOCD.

View file

@ -48,6 +48,8 @@ UART5 is configured for serial logs. The default serial setup is 115200 8N1.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
This board comes with a JTAG port which facilitates debugging using a single physical connection.
Flashing

View file

@ -51,6 +51,8 @@ chip.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing the Zephyr project onto SAM4E MCU requires the `OpenOCD tool`_.
By default a factory new SAM4E chip will boot SAM-BA boot loader located in
the ROM, not the flashed image. This is determined by the value of GPNVM1

View file

@ -73,6 +73,8 @@ between all others headers and RS-485 port.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM4L-EK board have a Segger Embedded Debugger Unit
`J-Link OB <https://www.segger.com/jlink-ob.html>`_. This provides a debug
interface to the SAM4LC4C chip. You can use Ozone or JLink to communicate with

View file

@ -48,6 +48,8 @@ The section flashing uses the UART from the Segger USB debug connection.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM4S Xplained board comes with Segger
`J-Link OB <https://www.segger.com/jlink-ob.html>`_. This provides a debug
interface to the SAM4S16C chip. You can use Ozone or JLink to communicate with

View file

@ -50,6 +50,8 @@ chip.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing the Zephyr project onto SAM E70 MCU requires the `OpenOCD tool`_.
Support for Atmel SAM E microcontroller series was added in OpenOCD release
0.10.0, which was added in Zephyr SDK 0.9.2.

View file

@ -56,6 +56,8 @@ for the console and is available as a Virtual COM Port via EDBG USB chip.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing the Zephyr project onto SAM V71 MCU requires the `OpenOCD tool`_.
By default a factory new SAM V71 chip will boot the `SAM-BA`_ boot loader
located in the ROM, not the flashed image. This is determined by the value

View file

@ -83,6 +83,8 @@ driven by TCC2 instead of by GPIO.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM C21N Xplained Pro comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAMC21 chip and is supported by
OpenOCD.

View file

@ -53,6 +53,8 @@ SERCOM0 is available on the EXT1 connector.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM D20 Xplained Pro comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAMD20 chip and is supported by
OpenOCD.

View file

@ -88,6 +88,8 @@ SERCOM5 is connected to an 8 megabit SPI flash.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM D21 Xplained Pro comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAMD21 chip and is supported by
OpenOCD.

View file

@ -111,6 +111,8 @@ Authentication device.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM E54 Xplained Pro comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAME54 chip and is supported by
OpenOCD.

View file

@ -93,6 +93,8 @@ The SAML21 MCU has 6 SERCOM based SPIs, with two configured as SPI in this BSP.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM L21 Xplained Pro comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAML21 chip and is supported by
OpenOCD.

View file

@ -134,6 +134,8 @@ echo demo. More information at :zephyr:code-sample:`sockets-echo-server` and
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM R21 Xplained Pro comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAMR21 chip and is supported by
OpenOCD.

View file

@ -94,6 +94,8 @@ The SAMR34 MCU has 6 SERCOM based SPIs, with two configured as SPI in this BSP.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The SAM R34 Xplained Pro comes with a Atmel Embedded Debugger (EDBG). This
provides a debug interface to the SAMR34 chip and is supported by
OpenOCD.

View file

@ -37,6 +37,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -38,6 +38,8 @@ Supported Features
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -72,6 +72,8 @@ NFC
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``blueclover_plt_demo_v2/nrf52832`` board configuration
can be built and flashed in the usual way (see :ref:`build_an_application`
and :ref:`application_run` for more details).

View file

@ -121,6 +121,8 @@ CC1352 reset is connected to AM62 GPIO0_14.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -159,6 +159,8 @@ assigned to LPUART. Default settings are 115200 8N1.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Connect Swan to your host computer using the USB port.
Then build and flash an application. Here is an example for the
:zephyr:code-sample:`hello_world` application.

View file

@ -95,6 +95,8 @@ External GPS Antenna @ J3
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========
The byteSENSI-L board can be flashed with the SEGGER JLink programmer.

View file

@ -44,6 +44,8 @@ features.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``contextualelectronics_abc`` board configuration can be
built and flashed in the usual way (see :ref:`build_an_application`
and :ref:`application_run` for more details).

View file

@ -76,6 +76,8 @@ Digital Inputs
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``croxel_cx1825/nrf52840`` board configuration
can be built and flashed in the usual way (see :ref:`build_an_application`
and :ref:`application_run` for more details).

View file

@ -81,6 +81,8 @@ nRF9161:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for ``ctcc`` boards can be
built in the usual way (see :ref:`build_an_application` for more details).

View file

@ -140,6 +140,8 @@ To get the OpenOCD package, it is required that you
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The CY8CKIT-062-BLE includes an onboard programmer/debugger (KitProg2) with
mass storage programming to provide debugging, flash programming, and serial
communication over USB. There are also PSOC 6 program and debug headers J11

View file

@ -127,6 +127,8 @@ To get the OpenOCD package, it is required that you
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The CY8CKIT-062-WiFi-BT includes an onboard programmer/debugger (KitProg2) with
mass storage programming to provide debugging, flash programming, and serial
communication over USB. There are also PSOC 6 program and debug headers J11

View file

@ -77,6 +77,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -113,6 +113,8 @@ Default settings are 115200 8N1.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``dragino_lsn50`` board configuration can be built and
flashed in the usual way (see :ref:`build_an_application` and
:ref:`application_run` for more details).

View file

@ -112,6 +112,8 @@ Default settings are 115200 8N1.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``dragino_nbsn95`` board configuration can be built and
flashed in the usual way (see :ref:`build_an_application` and
:ref:`application_run` for more details).

View file

@ -135,6 +135,8 @@ NFC_ANT
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -80,6 +80,8 @@ MicroSD is connected to these pins, and CS pin is connected to P0.17.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``nrf52840_blip`` board configuration can be
built and flashed in the usual way (see :ref:`build_an_application`
and :ref:`application_run` for more details); The onboard Black Magic

View file

@ -89,6 +89,8 @@ Other pins used by the e-paper display are:
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``nrf52840_papyr`` board configuration can be
built and flashed in the usual way (see :ref:`build_an_application`
and :ref:`application_run` for more details); Black Magic

View file

@ -110,6 +110,8 @@ the number 6 is used in the mikroBUS connector.
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
The WaRP7 doesn't have QSPI flash for the M4 and it needs to be started by
the A7 core. The A7 core is responsible to load the M4 binary application into
the RAM, put the M4 in reset, set the M4 Program Counter and Stack Pointer, and

View file

@ -33,6 +33,8 @@ See Processor clock control register (refer 5.1 General Configuration)
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Flashing
========

View file

@ -72,6 +72,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -72,6 +72,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -432,6 +432,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -64,6 +64,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -64,6 +64,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -109,6 +109,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

View file

@ -106,6 +106,8 @@ below to retrieve those files.
Building & Flashing
*******************
.. zephyr:board-supported-runners::
Simple boot
===========

Some files were not shown because too many files have changed in this diff Show more