adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

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

Browse source 
This updates the documentation of all the Analog Devices 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:29:23 +02:00 committed by Carles Cufí
parent 599e0625e3
commit 1b29273248
18 changed files with 25 additions and 122 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
boards/adi/apard32690/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _ad_apard32690_sl:
AD-APARD32690-SL
################
.. zephyr:board:: apard32690
Overview
********
@ -19,10 +16,6 @@ the required power circuitry.
The Zephyr port is running on the MAX32690 MCU.
.. image:: img/apard32690_img.webp
:align: center
:alt: AD-APARD32690-SL Front
Hardware
********

11
boards/adi/eval_adin1110ebz/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adi_eval_adin1110ebz:
ADI EVAL-ADIN1110EVB Evaluation board
#####################################
.. zephyr:board:: adi_eval_adin1110ebz
Overview
********
@ -23,12 +20,6 @@ The SPI interface provides configuration and data access to the ADIN1110.
A small prototyping area and test points are provided for experimentation with alternative cable
connection topologies including isolation transformers and/or power coupling inductors.
.. figure:: img/adi_eval_adin1110ebz.webp
:align: center
:alt: ADI EVAL-ADIN1110EBZ
ADI EVAL-ADIN1110EBZ (Credit: Analog Devices, Inc.)
.. important::
S201 DIP switches are shipped in Open Alliance SPI mode. The current Zephyr

11
boards/adi/eval_adin2111ebz/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adi_eval_adin2111ebz:
ADI EVAL-ADIN2111EVB Evaluation board
#####################################
.. zephyr:board:: adi_eval_adin2111ebz
Overview
********
@ -38,12 +35,6 @@ the 2 PHYs configuration and data exchange between SPI host and ports.
so the S1 DIP switches must be set as ``SPI_CFG0 OFF and SPI_CFG1 OFF``.
An inconsistent S1 DIP switches configuration will halt the boot.
.. figure:: img/adi_eval_adin2111ebz.webp
:align: center
:alt: ADI EVAL-ADIN2111EBZ
ADI EVAL-ADIN2111EBZ (Credit: Analog Devices, Inc.)
Hardware
********

5
boards/adi/max32655evkit/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32655_evkit:
MAX32655EVKIT
#############
.. zephyr:board:: max32655evkit
Overview
********

5
boards/adi/max32655fthr/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32655_fthr:
MAX32655FTHR
############
.. zephyr:board:: max32655fthr
Overview
********

9
boards/adi/max32662evkit/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32662_evkit:
MAX32662EVKIT
#############
.. zephyr:board:: max32662evkit
Overview
********
@ -12,10 +9,6 @@ for battery-powered edge devices.
The Zephyr port is running on the MAX32662 MCU.
.. image:: img/max32662evkit.webp
:align: center
:alt: MAX32662EVKIT
Hardware
********

11
boards/adi/max32666evkit/doc/index.rst
View file

@ -1,21 +1,12 @@
.. _max32666evkit:
MAX32666EVKIT
#############
.. zephyr:board:: max32666evkit
Overview
********
The MAX32666EVKIT provides a platform for evaluating the capabilities of the MAX32665 and MAX32666
high-efficiency Arm® microcontrollers and audio DSP for wearable and hearable device applications.
The Zephyr port is running on the MAX32666 MCU.
.. image:: img/max32666evkit.webp
:align: center
:alt: MAX32666EVKIT Front
Hardware
********

5
boards/adi/max32666fthr/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32666_fthr:
MAX32666FTHR
############
.. zephyr:board:: max32666fthr
Overview
********

9
boards/adi/max32670evkit/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32670_evkit:
MAX32670EVKIT
#############
.. zephyr:board:: max32670evkit
Overview
********
@ -15,10 +12,6 @@ from 8-bit or 16-bit microcontrollers.
The Zephyr port is running on the MAX32670 MCU.
.. image:: img/max32670evkit.webp
:align: center
:alt: MAX32670 EVKIT
Hardware
********

9
boards/adi/max32672evkit/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32672_evkit:
MAX32672EVKIT
#############
.. zephyr:board:: max32672evkit
Overview
********
@ -13,10 +10,6 @@ designs an easy, cost-optimal upgrade path from 8-bit or 16-bit microcontrollers
The Zephyr port is running on the MAX32672 MCU.
.. image:: img/max32672evkit.webp
:align: center
:alt: MAX32672EVKIT
Hardware
********

5
boards/adi/max32672fthr/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32672_fthr:
MAX32672FTHR
############
.. zephyr:board:: max32672fthr
Overview
********

9
boards/adi/max32675evkit/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32675_evkit:
MAX32675EVKIT
#############
.. zephyr:board:: max32675evkit
Overview
********
@ -13,10 +10,6 @@ industrial sensors for configuration and diagnostics.
The Zephyr port is running on the MAX32675 MCU.
.. image:: img/max32675evkit.webp
:align: center
:alt: MAX32675EVKIT
Hardware
********

10
boards/adi/max32680evkit/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32680_evkit:
MAX32680EVKIT
#############
.. zephyr:board:: max32680evkit
Overview
********
@ -17,11 +14,6 @@ the latest generation Bluetooth® 5.2 Low Energy
The Zephyr port is running on the MAX32680 MCU.
.. image:: img/max32680evkit_img1.jpg
:align: center
:alt: MAX32680 EVKIT
Hardware
********

0
boards/adi/max32690evkit/doc/img/max32690evkit_img1.jpg → boards/adi/max32690evkit/doc/img/max32690evkit.jpg
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

7
boards/adi/max32690evkit/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32690_evkit:
MAX32690EVKIT
#############
.. zephyr:board:: max32690evkit
Overview
********
@ -14,7 +11,7 @@ industrial sensors/networks, internet of things (IoT), and asset tracking.
The Zephyr port is running on the MAX32690 MCU.
.. image:: img/max32690evkit_img1.jpg
.. image:: img/max32690evkit.jpg
:align: center
:alt: MAX32690 EVKIT Front

5
boards/adi/max32690fthr/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _max32690_fthr:
MAX32690FTHR
############
.. zephyr:board:: max32690fthr
Overview
********

11
boards/adi/sdp_k1/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _adi_sdp_k1:
ADI SDP-K1
##########
.. zephyr:board:: adi_sdp_k1
Overview
********
@ -24,12 +21,6 @@ ADI components.
- 16MB SDRAM
- Arduino UNO and 120-pin SDP connectors
.. figure:: img/adi_sdp_k1.webp
:align: center
:alt: ADI SDP-K1
ADI SDP-K1 (Credit: Analog Devices, Inc.)
More information about the board can be found on the `ADI SDP-K1 website`_.
Hardware

16
doc/releases/release-notes-3.7.rst
View file

@ -422,14 +422,14 @@ Boards & SoC Support
* Added support for :ref:`ST STEVAL STWINBX1 Development kit <steval_stwinbx1_board>`: ``steval_stwinbx1``.
* Added support for NXP boards: ``frdm_mcxn947``, ``ke17z512``, ``rd_rw612_bga``, ``frdm_rw612``, ``frdm_ke15z``, ``frdm_ke17z``
* Added support for :ref:`Synopsys ARC-V RMX1xx nSIM-based simulation platform <nsim_arc_v>`: ``nsim_arc_v/rmx100``.
* Added support for :ref:`Analog Devices MAX32690EVKIT <max32690_evkit>`: ``max32690evkit``.
* Added support for :ref:`Analog Devices MAX32680EVKIT <max32680_evkit>`: ``max32680evkit``.
* Added support for :ref:`Analog Devices MAX32672EVKIT <max32672_evkit>`: ``max32672evkit``.
* Added support for :ref:`Analog Devices MAX32672FTHR <max32672_fthr>`: ``max32672fthr``.
* Added support for :ref:`Analog Devices MAX32670EVKIT <max32670_evkit>`: ``max32670evkit``.
* Added support for :ref:`Analog Devices MAX32655EVKIT <max32655_evkit>`: ``max32655evkit``.
* Added support for :ref:`Analog Devices MAX32655FTHR <max32655_fthr>`: ``max32655fthr``.
* Added support for :ref:`Analog Devices AD-APARD32690-SL <ad_apard32690_sl>`: ``ad_apard32690_sl``.
* Added support for :zephyr:board:`Analog Devices MAX32690EVKIT <max32690evkit>`: ``max32690evkit``.
* Added support for :zephyr:board:`Analog Devices MAX32680EVKIT <max32680evkit>`: ``max32680evkit``.
* Added support for :zephyr:board:`Analog Devices MAX32672EVKIT <max32672evkit>`: ``max32672evkit``.
* Added support for :zephyr:board:`Analog Devices MAX32672FTHR <max32672fthr>`: ``max32672fthr``.
* Added support for :zephyr:board:`Analog Devices MAX32670EVKIT <max32670evkit>`: ``max32670evkit``.
* Added support for :zephyr:board:`Analog Devices MAX32655EVKIT <max32655evkit>`: ``max32655evkit``.
* Added support for :zephyr:board:`Analog Devices MAX32655FTHR <max32655fthr>`: ``max32655fthr``.
* Added support for :zephyr:board:`Analog Devices AD-APARD32690-SL <apard32690>`: ``ad_apard32690_sl``.
* Added support for :ref:`Infineon Technologies CYW920829M2EVK-02 <cyw920829m2evk_02>`: ``cyw920829m2evk_02``.
* Added support for :ref:`Nuvoton Numaker M2L31KI board <nuvoton_m2l31ki>`: ``numaker_m2l31ki``.
* Added support for :ref:`Espressif ESP32-S2 DevKit-C <esp32s2_devkitc>`: ``esp32s2_devkitc``.