boards: ezurio: adopt new zephyr:board directive and role

This updates the documentation of all the Ezurio boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-10-18 17:21:17 +02:00 committed by Carles Cufí
parent f0ec6ada1d
commit 0ff3f0d364
17 changed files with 21 additions and 120 deletions

View file

@ -1,7 +1,4 @@
.. _bl5340_dvk: .. zephyr:board:: bl5340_dvk
Ezurio BL5340 DVK
#################
Overview Overview
******** ********
@ -43,12 +40,6 @@ This development kit has the following features:
* :abbr:`USB (Universal Serial Bus)` * :abbr:`USB (Universal Serial Bus)`
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
.. figure:: img/bl5340_dvk_top.jpg
:align: center
:alt: BL5340 DVK
BL5340 DVK (Credit: Ezurio)
More information about the module can be found on the More information about the module can be found on the
`BL5340 homepage`_. `BL5340 homepage`_.

View file

@ -1,7 +1,4 @@
.. _bl652_dvk: .. zephyr:board:: bl652_dvk
Ezurio BL652 DVK
################
Overview Overview
******** ********
@ -31,12 +28,6 @@ Available BL652 DVK part numbers:
* DVK-BL652-SA * DVK-BL652-SA
* DVK-BL652-SC * DVK-BL652-SC
.. figure:: img/bl652_dvk.jpg
:align: center
:alt: BL652 DVK
BL652 DVK Board
.. figure:: img/BL652-SA_DVK_BoxContents.jpg .. figure:: img/BL652-SA_DVK_BoxContents.jpg
:align: center :align: center
:alt: BL652-SA DVK Box Contents :alt: BL652-SA DVK Box Contents

View file

@ -1,7 +1,4 @@
.. _bl653_dvk: .. zephyr:board:: bl653_dvk
Ezurio BL653 DVK
################
Overview Overview
******** ********
@ -27,12 +24,6 @@ This development kit has the following features:
* :abbr:`USB (Universal Serial Bus)` * :abbr:`USB (Universal Serial Bus)`
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
.. figure:: img/bl653_dvk.jpg
:align: center
:alt: BL653 Development Kit
BL653 Development Kit Board
More information about the board can be found at the More information about the board can be found at the
`BL653 website`_. `BL653 website`_.

View file

@ -1,7 +1,4 @@
.. _bl654_dvk: .. zephyr:board:: bl654_dvk
Ezurio BL654 DVK
################
Overview Overview
******** ********
@ -32,12 +29,6 @@ This development kit has the following features:
* :abbr:`USB (Universal Serial Bus)` * :abbr:`USB (Universal Serial Bus)`
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
.. figure:: img/bl654_dvk.jpg
:align: center
:alt: BL654 Development Kit
BL654 Development Kit Board
.. figure:: img/455-00001_BoxContents.jpg .. figure:: img/455-00001_BoxContents.jpg
:align: center :align: center
:alt: 455-00001 Box Contents :alt: 455-00001 Box Contents

View file

@ -1,7 +1,4 @@
.. _bl654_sensor_board: .. zephyr:board:: bl654_sensor_board
Ezurio BL654 Sensor Board
#########################
Overview Overview
******** ********
@ -27,12 +24,6 @@ This sensor board has the following features:
* :abbr:`UART (Universal asynchronous receiver-transmitter)` * :abbr:`UART (Universal asynchronous receiver-transmitter)`
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
.. figure:: img/bl654_sensor_board.jpg
:align: center
:alt: BL654 Sensor Board front and back
BL654 Sensor Board front and back
.. figure:: img/bl654_sensor_board_usb_swd_programmer.jpg .. figure:: img/bl654_sensor_board_usb_swd_programmer.jpg
:align: center :align: center
:alt: BL654 Sensor Board connected to USB-SWD Programmer (UART and SWD access) :alt: BL654 Sensor Board connected to USB-SWD Programmer (UART and SWD access)

View file

@ -1,7 +1,4 @@
.. _bl654_usb: .. zephyr:board:: bl654_usb
Ezurio BL654 USB (451-00004)
############################
Overview Overview
******** ********
@ -23,12 +20,6 @@ This USB adapter has the following features:
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
* :abbr:`RTC (nRF RTC System Clock)` * :abbr:`RTC (nRF RTC System Clock)`
.. figure:: img/bl654_usb.jpg
:align: center
:alt: BL654 USB adapter
BL654 USB Adapter
.. figure:: img/bl654_usb_pcb.jpg .. figure:: img/bl654_usb_pcb.jpg
:align: center :align: center
:alt: 451-00004 Box Contents :alt: 451-00004 Box Contents
@ -104,7 +95,7 @@ Programming and Debugging
Applications for the ``bl654_usb`` board configuration can be Applications for the ``bl654_usb`` board configuration can be
built in the usual way (see :ref:`build_an_application` for more details). The built in the usual way (see :ref:`build_an_application` for more details). The
``bl654_usb`` board cannot be used for debugging. The compatible BL654 DVK ``bl654_usb`` board cannot be used for debugging. The compatible BL654 DVK
board can be used for development. Documentation can be found at the :ref:`bl654_dvk` board can be used for development. Documentation can be found at the :zephyr:board:`bl654_dvk`
site and :zephyr_file:`boards/ezurio/bl654_dvk/doc/bl654_dvk.rst` site and :zephyr_file:`boards/ezurio/bl654_dvk/doc/bl654_dvk.rst`
Flashing Flashing

View file

@ -1,7 +1,4 @@
.. _bt510: .. zephyr:board:: bt510
Ezurio Sentrius BT510 Sensor
############################
Overview Overview
******** ********
@ -24,12 +21,6 @@ The sensor has the following features:
* :abbr:`UART (Universal Asynchronous Receiver-Transmitter)` * :abbr:`UART (Universal Asynchronous Receiver-Transmitter)`
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
.. figure:: img/bt510.jpg
:align: center
:alt: Sentrius BT510 Sensor, front view
Sentrius BT510 Sensor, front view
.. figure:: img/bt510_back.jpg .. figure:: img/bt510_back.jpg
:align: center :align: center
:alt: Sentrius BT510 Sensor, rear view :alt: Sentrius BT510 Sensor, rear view

View file

@ -1,7 +1,4 @@
.. _bt610: .. zephyr:board:: bt610
Ezurio Sentrius BT610 Sensor
############################
Overview Overview
******** ********
@ -28,12 +25,6 @@ The sensor has the following features:
* :abbr:`UART (Universal Asynchronous Receiver-Transmitter)` * :abbr:`UART (Universal Asynchronous Receiver-Transmitter)`
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
.. figure:: img/bt610_front.jpg
:align: center
:alt: Sentrius BT610 Sensor, front view
Sentrius BT610 Sensor, front view
.. figure:: img/bt610_back.jpg .. figure:: img/bt610_back.jpg
:align: center :align: center
:alt: Sentrius BT610 Sensor, rear view :alt: Sentrius BT610 Sensor, rear view

View file

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View file

@ -1,7 +1,4 @@
.. _mg100: .. zephyr:board:: mg100
Ezurio Sentrius™ MG100 Gateway
##############################
Overview Overview
******** ********
@ -46,12 +43,6 @@ and the following devices:
* :abbr:`HL7800 (Sierra Wireless HL7800 LTE-M1/NB-IoT modem)` * :abbr:`HL7800 (Sierra Wireless HL7800 LTE-M1/NB-IoT modem)`
* :abbr:`SD Card` * :abbr:`SD Card`
.. figure:: img/mg100.jpg
:align: center
:alt: MG100
MG100 (450-00054-K1)
Hardware Hardware
******** ********

View file

@ -1,7 +1,4 @@
.. _pinnacle_100_dvk: .. zephyr:board:: pinnacle_100_dvk
Ezurio Pinnacle 100 DVK
#######################
Overview Overview
******** ********
@ -49,12 +46,6 @@ and the following devices:
* :abbr:`BME680 (Bosch Sensortec BME680 environmental sensor)` * :abbr:`BME680 (Bosch Sensortec BME680 environmental sensor)`
* :abbr:`HL7800 (Sierra Wireless HL7800 LTE-M1/NB-IoT modem)` * :abbr:`HL7800 (Sierra Wireless HL7800 LTE-M1/NB-IoT modem)`
.. figure:: img/pinnacle_100_dvk.jpg
:align: center
:alt: Pinnacle 100 DVK
Pinnacle 100 DVK (453-00010-K1)
Hardware Hardware
******** ********

View file

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

View file

@ -1,7 +1,4 @@
.. _rm1xx_dvk: .. zephyr:board:: rm1xx_dvk
Ezurio RM1xx DVK
################
Overview Overview
******** ********
@ -28,12 +25,6 @@ This development kit has the following features:
* :abbr:`UART (Universal asynchronous receiver-transmitter)` * :abbr:`UART (Universal asynchronous receiver-transmitter)`
* :abbr:`WDT (Watchdog Timer)` * :abbr:`WDT (Watchdog Timer)`
.. figure:: img/RM186-DVK.jpg
:align: center
:alt: RM1xx development kit (DVK)
RM1xx development kit (DVK) (Credit: Ezurio)
.. figure:: img/RM186-SM.jpg .. figure:: img/RM186-SM.jpg
:align: center :align: center
:alt: RM1xx module :alt: RM1xx module

View file

@ -123,7 +123,7 @@ This section focuses on the terminology used around hardware support, and in
particular when defining and working with boards and SoCs. particular when defining and working with boards and SoCs.
The overall set of terms used around the concept of board in Zephyr is depicted The overall set of terms used around the concept of board in Zephyr is depicted
in the image below, which uses the :ref:`bl5340_dvk` board as reference. in the image below, which uses the :zephyr:board:`bl5340_dvk` board as reference.
.. figure:: board/board-terminology.svg .. figure:: board/board-terminology.svg
:width: 500px :width: 500px
@ -152,7 +152,7 @@ qualifiers, the board name can be used as a board target. Conversely, if
board qualifiers are part of the board definition, then the SoC can be omitted board qualifiers are part of the board definition, then the SoC can be omitted
by leaving it out but including the corresponding forward-slashes: ``//``. by leaving it out but including the corresponding forward-slashes: ``//``.
Continuing with the example above, The board :ref:`bl5340_dvk` is a single SoC Continuing with the example above, The board :zephyr:board:`bl5340_dvk` is a single SoC
board where the SoC defines two CPU clusters: ``cpuapp`` and ``cpunet``. One of board where the SoC defines two CPU clusters: ``cpuapp`` and ``cpunet``. One of
the CPU clusters, ``cpuapp``, additionally defines a non-secure board variant, the CPU clusters, ``cpuapp``, additionally defines a non-secure board variant,
``ns``. ``ns``.

View file

@ -12,7 +12,7 @@ The following are some of the boards that can be used with TF-M:
- ``mps2_an521_ns`` (qemu supported) - ``mps2_an521_ns`` (qemu supported)
* - :ref:`mps3_an547_board` * - :ref:`mps3_an547_board`
- ``mps3_an547_ns`` (qemu supported) - ``mps3_an547_ns`` (qemu supported)
* - :ref:`bl5340_dvk` * - :zephyr:board:`bl5340_dvk`
- ``bl5340_dvk/nrf5340/cpuapp/ns`` - ``bl5340_dvk/nrf5340/cpuapp/ns``
* - :ref:`lpcxpresso55s69` * - :ref:`lpcxpresso55s69`
- ``lpcxpresso55s69_ns`` - ``lpcxpresso55s69_ns``

View file

@ -126,7 +126,7 @@ Building and Running for BL652
============================== ==============================
The BL652 DVK PCB contains a footprint for a MCP4725 to use as an external The BL652 DVK PCB contains a footprint for a MCP4725 to use as an external
DAC. Note this is not populated by default. The sample can be built and DAC. Note this is not populated by default. The sample can be built and
executed for the :ref:`bl652_dvk` as follows: executed for the :zephyr:board:`bl652_dvk` as follows:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/drivers/dac :zephyr-app: samples/drivers/dac
@ -140,7 +140,7 @@ Building and Running for BL653
============================== ==============================
The BL653 DVK PCB contains a footprint for a MCP4725 to use as an external The BL653 DVK PCB contains a footprint for a MCP4725 to use as an external
DAC. Note this is not populated by default. The sample can be built and DAC. Note this is not populated by default. The sample can be built and
executed for the :ref:`bl653_dvk` as follows: executed for the :zephyr:board:`bl653_dvk` as follows:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/drivers/dac :zephyr-app: samples/drivers/dac
@ -154,7 +154,7 @@ Building and Running for BL654
============================== ==============================
The BL654 DVK PCB contains a footprint for a MCP4725 to use as an external The BL654 DVK PCB contains a footprint for a MCP4725 to use as an external
DAC. Note this is not populated by default. The sample can be built and DAC. Note this is not populated by default. The sample can be built and
executed for the :ref:`bl654_dvk` as follows: executed for the :zephyr:board:`bl654_dvk` as follows:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/drivers/dac :zephyr-app: samples/drivers/dac
@ -167,7 +167,7 @@ DAC output is available on pin 1 of the MCP4725.
Building and Running for BL5340 Building and Running for BL5340
=============================== ===============================
The BL5340 DVK PCB contains a MCP4725 to use as a DAC. The sample can be The BL5340 DVK PCB contains a MCP4725 to use as a DAC. The sample can be
built and executed for the :ref:`bl5340_dvk` as follows: built and executed for the :zephyr:board:`bl5340_dvk` as follows:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/drivers/dac :zephyr-app: samples/drivers/dac

View file

@ -26,12 +26,12 @@ Building and Running
The SM351LT (or compatible) sensors are available on the following boards: The SM351LT (or compatible) sensors are available on the following boards:
* :ref:`bt510` * :zephyr:board:`bt510`
Building on bt510 Building on bt510
================== ==================
:ref:`bt510` includes a Honeywell SM351LT magnetoresistive sensor. :zephyr:board:`bt510` includes a Honeywell SM351LT magnetoresistive sensor.
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/sensor/sm351lt :zephyr-app: samples/sensor/sm351lt