Commit f7ad2825 authored by Benjamin Cabé's avatar Benjamin Cabé Committed by Benjamin Cabé
Browse files

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: default avatarBenjamin Cabé <benjamin@zephyrproject.org>
parent e2370dd4

boards/arduino/due/doc/index.rst

+4 −31
Changes for boards/arduino/due/doc/index.rst: 4 added lines, 31 removed lines.
Original line number Diff line number Diff line 
.. _arduino_due:



Arduino Due

###########

.. zephyr:board:: arduino_due



Overview

********
@@ -23,41 +20,17 @@ the processor. 
.. note::

   This configuration is not supported by Arduino.



.. image:: img/arduino_due.jpg

     :align: center

     :alt: Arduino Due



Hardware

********



Supported Features

==================



The arduino_due board configuration supports the following hardware features:



+-----------+------------+----------------------+

| Interface | Controller | Driver/Component     |

+===========+============+======================+

| NVIC      | on-chip    | nested vectored      |

|           |            | interrupt controller |

+-----------+------------+----------------------+

| SYSTICK   | on-chip    | system clock         |

+-----------+------------+----------------------+

| UART      | on-chip    | serial port          |

+-----------+------------+----------------------+

| GPIO      | on-chip    | gpio                 |

+-----------+------------+----------------------+

| I2C       | on-chip    | i2c                  |

+-----------+------------+----------------------+

| Watchdog  | on-chip    | watchdog             |

+-----------+------------+----------------------+



Other hardware features are not currently supported by the Zephyr kernel.

.. zephyr:board-supported-hw::



See `Arduino Due website`_ and `Atmel SAM3X8E Datasheet`_ for a complete

list of Arduino Due board hardware features.



The default configuration can be found in the Kconfig

:zephyr_file:`boards/arduino/due/arduino_due_defconfig`.



.. note::

   For I2C, pull-up resistors are required for using SCL1 and SDA1 (near IO13).

boards/arduino/giga_r1/doc/index.rst

+2 −41
Changes for boards/arduino/giga_r1/doc/index.rst: 2 added lines, 41 removed lines.
Original line number Diff line number Diff line 
.. _arduino_giga_r1_board:



Arduino GIGA R1 WiFi

####################

.. zephyr:board:: arduino_giga_r1



Overview

********
@@ -22,10 +19,6 @@ The board features: 
- Audio jack

- ATECC608A secure element



.. image:: img/arduino_giga_r1.jpg

     :align: center

     :alt: Arduino GIGA R1 WiFi



More information about the board, including the datasheet, pinout and

schematics, can be found at the `Arduino GIGA website`_.
@@ -38,39 +31,7 @@ More information about STM32H747XIH6 can be found here: 
Supported Features

==================



The current Zephyr ``arduino_giga_r1_m7`` board configuration supports the

following hardware features:



+-----------+------------+-------------------------------------+

| Interface | Controller | Driver/Component                    |

+===========+============+=====================================+

| NVIC      | on-chip    | nested vector interrupt controller  |

+-----------+------------+-------------------------------------+

| UART      | on-chip    | serial port-polling;                |

|           |            | serial port-interrupt               |

+-----------+------------+-------------------------------------+

| PINMUX    | on-chip    | pinmux                              |

+-----------+------------+-------------------------------------+

| GPIO      | on-chip    | gpio                                |

+-----------+------------+-------------------------------------+

| FLASH     | on-chip    | flash memory                        |

+-----------+------------+-------------------------------------+

| RNG       | on-chip    | True Random number generator        |

+-----------+------------+-------------------------------------+

| I2C       | on-chip    | i2c                                 |

+-----------+------------+-------------------------------------+

| SPI       | on-chip    | spi                                 |

+-----------+------------+-------------------------------------+

| IPM       | on-chip    | virtual mailbox based on HSEM       |

+-----------+------------+-------------------------------------+

| FMC       | on-chip    | memc (SDRAM)                        |

+-----------+------------+-------------------------------------+

| QSPI      | on-chip    | QSPI flash                          |

+-----------+------------+-------------------------------------+

| RADIO     | Murata 1DX | WiFi and Bluetooth module           |

+-----------+------------+-------------------------------------+



Other hardware features are not yet supported on Zephyr port.

.. zephyr:board-supported-hw::



Fetch Binary Blobs

******************

boards/arduino/mkrzero/doc/index.rst

+2 −48
Changes for boards/arduino/mkrzero/doc/index.rst: 2 added lines, 48 removed lines.
Original line number Diff line number Diff line 
.. _arduino_mkrzero:



Arduino MKR Zero

####################

.. zephyr:board:: arduino_mkrzero



Overview

********
@@ -9,10 +6,6 @@ Overview 
The Arduino MKR Zero built with smaller MKR form factor and powered by Atmel's SAMD21 MCU.

This board come with microSD card holder that allows you to play with music files with no extra hardware.



.. image:: img/arduino_mkrzero.jpg

     :align: center

     :alt: Arduino MKR Zero



Hardware

********
@@ -27,46 +20,7 @@ Hardware 
Supported Features

==================



The arduino_mkrzero board configuration supports the following hardware

features:



+-----------+------------+------------------------------------------+

| Interface | Controller | Driver/Component                         |

+===========+============+==========================================+

| ADC       | on-chip    | Analog to digital converter              |

+-----------+------------+------------------------------------------+

| COUNTER   | on-chip    | Pulse counter                            |

+-----------+------------+------------------------------------------+

| DMA       | on-chip    | Direct memory access unit                |

+-----------+------------+------------------------------------------+

| Flash     | on-chip    | Can be used with LittleFS to store files |

+-----------+------------+------------------------------------------+

| GPIO      | on-chip    | I/O ports                                |

+-----------+------------+------------------------------------------+

| HWINFO    | on-chip    | Hardware info and serial number          |

+-----------+------------+------------------------------------------+

| NVIC      | on-chip    | nested vector interrupt controller       |

+-----------+------------+------------------------------------------+

| PWM       | on-chip    | Pulse Width Modulation                   |

+-----------+------------+------------------------------------------+

| SPI       | on-chip    | Serial Peripheral Interface ports        |

+-----------+------------+------------------------------------------+

| I2C       | on-chip    | Inter-Integrated Circuit ports           |

+-----------+------------+------------------------------------------+

| SYSTICK   | on-chip    | systick                                  |

+-----------+------------+------------------------------------------+

| USART     | on-chip    | Serial ports                             |

+-----------+------------+------------------------------------------+

| USB       | on-chip    | USB device                               |

+-----------+------------+------------------------------------------+

| WDT       | on-chip    | Watchdog                                 |

+-----------+------------+------------------------------------------+





Other hardware features are not currently supported by Zephyr.



The default configuration can be found in the Kconfig

:zephyr_file:`boards/arduino/mkrzero/arduino_mkrzero_defconfig`.

.. zephyr:board-supported-hw::



Connections and IOs

===================

boards/arduino/nano_33_ble/doc/index.rst

+2 −50
Changes for boards/arduino/nano_33_ble/doc/index.rst: 2 added lines, 50 removed lines.
Original line number Diff line number Diff line 
.. _arduino_nano_33_ble:



Arduino Nano 33 BLE (Sense)

#################################

.. zephyr:board:: arduino_nano_33_ble



Overview

********
@@ -11,58 +8,13 @@ nRF52840 ARM Cortex-M4F CPU. Arduino sells 2 variants of the board, the 
plain `BLE`_ type and the `BLE Sense`_ type. The "Sense" variant is distinguished by

the inclusion of more sensors, but otherwise both variants are the same.



.. image:: img/arduino_nano_33_ble_sense.jpg

     :align: center

     :alt: Arduino Nano 33 BLE (Sense variant)



The Sense variant of the board



Hardware

********



Supported Features

==================



The package is configured to support the following hardware:



+-----------+------------+----------------------+

| Interface | Controller | Driver/Component     |

+===========+============+======================+

| ADC       | on-chip    | adc                  |

+-----------+------------+----------------------+

| CLOCK     | on-chip    | clock_control        |

+-----------+------------+----------------------+

| FLASH     | on-chip    | flash                |

+-----------+------------+----------------------+

| GPIO      | on-chip    | gpio                 |

+-----------+------------+----------------------+

| I2C0      | on-chip    | i2c                  |

+-----------+------------+----------------------+

| I2C1      | on-chip    | i2c                  |

+-----------+------------+----------------------+

| MPU       | on-chip    | arch/arm             |

+-----------+------------+----------------------+

| NVIC      | on-chip    | arch/arm             |

+-----------+------------+----------------------+

| PWM       | on-chip    | pwm                  |

+-----------+------------+----------------------+

| RADIO     | on-chip    | Bluetooth,           |

|           |            | ieee802154           |

+-----------+------------+----------------------+

| RTC       | on-chip    | system clock         |

+-----------+------------+----------------------+

| SPI       | on-chip    | spi                  |

+-----------+------------+----------------------+

| UART      | on-chip    | serial               |

+-----------+------------+----------------------+

| USB       | on-chip    | usb                  |

+-----------+------------+----------------------+

| WDT       | on-chip    | watchdog             |

+-----------+------------+----------------------+



Other hardware features have not been enabled yet for this board.



Notably, this includes the PDM (microphone) interface.

.. zephyr:board-supported-hw::



Connections and IOs

===================

boards/arduino/nano_33_iot/doc/index.rst

+2 −45
Changes for boards/arduino/nano_33_iot/doc/index.rst: 2 added lines, 45 removed lines.
Original line number Diff line number Diff line 
.. _arduino_nano_33_iot:



Arduino Nano 33 IOT

###################

.. zephyr:board:: arduino_nano_33_iot



Overview

********
@@ -9,10 +6,6 @@ Overview 
The Arduino Nano 33 IOT is a small form factor development board with USB,

Wifi, Bluetooth, a 6 axis IMU, and secure element.



.. image:: img/nano_33_iot.jpg

     :align: center

     :alt: Arduino Nano 33 IOT



Hardware

********
@@ -28,43 +21,7 @@ Hardware 
Supported Features

==================



The arduino_nano_33_iot board configuration supports the following hardware

features:



+-----------+------------+------------------------------------------+

| Interface | Controller | Driver/Component                         |

+===========+============+==========================================+

| ADC       | on-chip    | Analog to digital converter              |

+-----------+------------+------------------------------------------+

| COUNTER   | on-chip    | Pulse counter                            |

+-----------+------------+------------------------------------------+

| DMA       | on-chip    | Direct memory access unit                |

+-----------+------------+------------------------------------------+

| Flash     | on-chip    | Can be used with LittleFS to store files |

+-----------+------------+------------------------------------------+

| GPIO      | on-chip    | I/O ports                                |

+-----------+------------+------------------------------------------+

| HWINFO    | on-chip    | Hardware info and serial number          |

+-----------+------------+------------------------------------------+

| NVIC      | on-chip    | nested vector interrupt controller       |

+-----------+------------+------------------------------------------+

| PWM       | on-chip    | Pulse Width Modulation                   |

+-----------+------------+------------------------------------------+

| SPI       | on-chip    | Serial Peripheral Interface ports        |

+-----------+------------+------------------------------------------+

| SYSTICK   | on-chip    | systick                                  |

+-----------+------------+------------------------------------------+

| USART     | on-chip    | Serial ports                             |

+-----------+------------+------------------------------------------+

| USB       | on-chip    | USB device                               |

+-----------+------------+------------------------------------------+

| WDT       | on-chip    | Watchdog                                 |

+-----------+------------+------------------------------------------+



Other hardware features are not currently supported by Zephyr.



The default configuration can be found in the Kconfig

:zephyr_file:`boards/arduino/nano_33_iot/arduino_nano_33_iot_defconfig`.

.. zephyr:board-supported-hw::



Connections and IOs

===================

CRA Git | Maintained and supported by SUSTech CRA and CCSE