Browse Source

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

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

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
pull/80294/head
Benjamin Cabé 9 months ago committed by Carles Cufí
parent
commit
0af1a9946b
  1. 9
      boards/snps/em_starterkit/doc/index.rst
  2. 9
      boards/snps/emsdp/doc/index.rst
  3. 9
      boards/snps/hsdk/doc/index.rst
  4. 11
      boards/snps/hsdk4xd/doc/index.rst
  5. 9
      boards/snps/iotdk/doc/index.rst
  6. 5
      boards/snps/nsim/arc_classic/doc/index.rst
  7. 5
      boards/snps/nsim/arc_v/doc/index.rst
  8. 2
      doc/releases/release-notes-3.7.rst

9
boards/snps/em_starterkit/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _em_starterkit:
DesignWare(R) ARC(R) EM Starter Kit
###################################
.. zephyr:board:: em_starterkit
Overview
********
@ -12,10 +9,6 @@ for the ARC EM Family of processors. The EM Family includes the EM4, EM6, @@ -12,10 +9,6 @@ for the ARC EM Family of processors. The EM Family includes the EM4, EM6,
EM5D, EM7D, EM9D, and EM11D cores. The Zephyr RTOS can be used with the
EM Starter Kit.
.. image:: em_starterkit.jpg
:align: center
:alt: DesignWare(R) ARC(R) EM Starter Kit (synopsys.com)
The ARC EM Starter Kit consists of a hardware platform, including pre-installed
FPGA images of different ARC EM processor configurations with peripherals.
Documentation for this board can be found at `embARC website`_.

9
boards/snps/emsdp/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _emsdp:
DesignWare(R) ARC(R) EM Software Development Platform
#####################################################
.. zephyr:board:: emsdp
Overview
********
@ -12,10 +9,6 @@ to accelerate software development and debug of ARC EM processors and subsystems @@ -12,10 +9,6 @@ to accelerate software development and debug of ARC EM processors and subsystems
a wide range of ultra-low power embedded applications such as IoT, sensor fusion,
and voice applications.
.. image:: emsdp.jpg
:align: center
:alt: DesignWare(R) ARC(R) EM Software Development Platform (synopsys.com)
For details about the board, see: `DesignWare ARC EM Software Development Platform
(EM SDP) <https://www.synopsys.com/dw/ipdir.php?ds=arc-em-software-development-platform>`__

9
boards/snps/hsdk/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _hsdk:
DesignWare(R) ARC(R) HS Development Kit
########################################
.. zephyr:board:: hsdk
Overview
********
@ -14,10 +11,6 @@ UART, I2S, ADC, PWM and GPIO. A Vivante GPU is also contained in the ARC @@ -14,10 +11,6 @@ UART, I2S, ADC, PWM and GPIO. A Vivante GPU is also contained in the ARC
Development System SoC. This allows developers to build and debug complex
software on a comprehensive hardware platform
.. image:: hsdk.jpg
:align: center
:alt: DesignWare(R) ARC(R) HS Development Kit (synopsys.com)
For details about the board, see: `ARC HS Development Kit
(HSDK) <https://www.synopsys.com/dw/ipdir.php?ds=arc-hs-development-kit>`__

11
boards/snps/hsdk4xd/doc/index.rst

@ -1,20 +1,13 @@ @@ -1,20 +1,13 @@
.. _hsdk4xd:
DesignWare(R) ARC(R) HS4x/HS4xD Development Kit
###############################################
.. zephyr:board:: hsdk4xd
Overview
********
The ARC HS4x/HS4xD Development Kit is the next revision of :ref:`Synopsys HSDK board <hsdk>`.
The ARC HS4x/HS4xD Development Kit is the next revision of :zephyr:board:`Synopsys HSDK board <hsdk>`.
It includes a multicore ARC HS4xD-based chip that integrates a wide range of interfaces
including Ethernet, HDMI, WiFi, Bluetooth, USB, SDIO, I2C, SPI, UART, I2S, ADC, PWM and GPIO,
as well as a Think Silicon GPU.
.. image:: hsdk4xd.jpg
:align: center
:alt: DesignWare(R) ARC(R) HS4x/HS4xD Development Kit (synopsys.com)
For details about the board, see: `ARC HS4x/HS4xD Development Kit
(HSDK4xD) <https://www.synopsys.com/dw/ipdir.php?ds=arc-hs-development-kit>`__

9
boards/snps/iotdk/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _iotdk:
DesignWare(R) ARC(R) IoT Development Kit
########################################
.. zephyr:board:: iotdk
Overview
********
@ -14,10 +11,6 @@ implementation of the ARC Data Fusion IP Subsystem running at 144 MHz on @@ -14,10 +11,6 @@ implementation of the ARC Data Fusion IP Subsystem running at 144 MHz on
SMIC's 55-nm ultra-low power process, and a rich set of peripherals commonly
used in IoT designs such as USB, UART, SPI, I2C, PWM, SDIO, and ADCs.
.. image:: iotdk.jpg
:align: center
:alt: DesignWare(R) ARC(R)IoT Development Kit (synopsys.com)
For details about the board, see: `ARC IoT Development Kit
(IoTDK) <https://www.synopsys.com/dw/ipdir.php?ds=arc_iot_development_kit>`__

5
boards/snps/nsim/arc_classic/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _nsim:
DesignWare ARC nSIM and HAPS FPGA boards
########################################
.. zephyr:board:: nsim
Overview
********

5
boards/snps/nsim/arc_v/doc/index.rst

@ -1,7 +1,4 @@ @@ -1,7 +1,4 @@
.. _nsim_arc_v:
DesignWare RISC-V nSIM and HAPS FPGA boards
###########################################
.. zephyr:board:: nsim_arc_v
Overview
********

2
doc/releases/release-notes-3.7.rst

@ -421,7 +421,7 @@ Boards & SoC Support @@ -421,7 +421,7 @@ Boards & SoC Support
* Added support for :zephyr:board:`ST STM32L152CDISCOVERY board <stm32l1_disco>`: ``stm32l152c_disco``.
* Added support for :zephyr:board:`ST STEVAL STWINBX1 Development kit <steval_stwinbx1>`: ``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 :zephyr:board:`Synopsys ARC-V RMX1xx nSIM-based simulation platform <nsim_arc_v>`: ``nsim_arc_v/rmx100``.
* 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``.

Loading…
Cancel
Save