From a498ede0d79c10ce8f93c051f5868dbc6499d3ca Mon Sep 17 00:00:00 2001 From: Thomas Stranger Date: Fri, 16 Jul 2021 15:15:21 +0200 Subject: [PATCH] doc: stm32wl and stm32l5 boards: update supported features This commit updates the supported features of stm32l5 and stm32wl boards to match the devicetree configuration. - add link to board defconfig and board.dts - sort supported features table alphabethically by interface. Additionally CRYP peripheral is added as supported feature to the mikroe_mini_m4_for_stm32 board documentation. Signed-off-by: Thomas Stranger --- .../doc/lora_e5_dev_board.rst | 31 +++++++----- .../doc/mikroe_mini_m4_for_stm32.rst | 2 + .../nucleo_l552ze_q/doc/nucleol552ze_q.rst | 46 ++++++++++------- .../arm/nucleo_wl55jc/doc/nucleo_wl55jc.rst | 26 +++++++--- boards/arm/stm32l562e_dk/doc/index.rst | 50 +++++++++++++------ 5 files changed, 104 insertions(+), 51 deletions(-) diff --git a/boards/arm/lora_e5_dev_board/doc/lora_e5_dev_board.rst b/boards/arm/lora_e5_dev_board/doc/lora_e5_dev_board.rst index a3e35fb5855..599de68a04c 100644 --- a/boards/arm/lora_e5_dev_board/doc/lora_e5_dev_board.rst +++ b/boards/arm/lora_e5_dev_board/doc/lora_e5_dev_board.rst @@ -80,35 +80,42 @@ features: +-----------+------------+-------------------------------------+ | Interface | Controller | Driver/Component | +===========+============+=====================================+ -| MPU | on-chip | arm memory protection unit | +| ADC | on-chip | adc | +-----------+------------+-------------------------------------+ -| NVIC | on-chip | nested vector interrupt controller | +| AES | on-chip | crypto | +-----------+------------+-------------------------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | +| COUNTER | on-chip | rtc | +-----------+------------+-------------------------------------+ -| PINMUX | on-chip | pinmux | +| CLOCK | on-chip | reset and clock control | ++-----------+------------+-------------------------------------+ +| FLASH | on-chip | flash | +-----------+------------+-------------------------------------+ | GPIO | on-chip | gpio | +-----------+------------+-------------------------------------+ | I2C | on-chip | i2c | +-----------+------------+-------------------------------------+ +| MPU | on-chip | arch/arm | ++-----------+------------+-------------------------------------+ +| NVIC | on-chip | arch/arm | ++-----------+------------+-------------------------------------+ +| PINMUX | on-chip | pinmux | ++-----------+------------+-------------------------------------+ +| RADIO | on-chip | LoRa | ++-----------+------------+-------------------------------------+ | SPI | on-chip | spi | +-----------+------------+-------------------------------------+ -| CLOCK | on-chip | reset and clock control | -+-----------+------------+-------------------------------------+ -| COUNTER | on-chip | rtc | +| UART | on-chip | serial port-polling; | +| | | serial port-interrupt | +-----------+------------+-------------------------------------+ | WATCHDOG | on-chip | independent watchdog | +-----------+------------+-------------------------------------+ -| ADC | on-chip | adc | -+-----------+------------+-------------------------------------+ Other hardware features are not yet supported on this Zephyr port. The default configuration can be found in the defconfig and dts files: -``boards/arm/lora_e5_dev_board/lora_e5_dev_board_defconfig`` -``boards/arm/lora_e5_dev_board/lora_e5_dev_board.dts`` + +- :zephyr_file:`boards/arm/lora_e5_dev_board/lora_e5_dev_board_defconfig` +- :zephyr_file:`boards/arm/lora_e5_dev_board/lora_e5_dev_board.dts` Connections and IOs diff --git a/boards/arm/mikroe_mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst b/boards/arm/mikroe_mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst index 99c8dcfe811..5ae6fed56c5 100644 --- a/boards/arm/mikroe_mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst +++ b/boards/arm/mikroe_mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst @@ -63,6 +63,8 @@ features: +-----------+------------+----------------------+ | Interface | Controller | Driver/Component | +===========+============+======================+ +| CRYP | on-chip | crypto | ++-----------+------------+----------------------+ | NVIC | on-chip | nested vectored | | | | interrupt controller | +-----------+------------+----------------------+ diff --git a/boards/arm/nucleo_l552ze_q/doc/nucleol552ze_q.rst b/boards/arm/nucleo_l552ze_q/doc/nucleol552ze_q.rst index 9226d0cb101..80b1ccf90d1 100644 --- a/boards/arm/nucleo_l552ze_q/doc/nucleol552ze_q.rst +++ b/boards/arm/nucleo_l552ze_q/doc/nucleol552ze_q.rst @@ -132,43 +132,53 @@ More information about STM32L552ZE can be found here: Supported Features ================== -The Zephyr nucleo_l552ze_q board configuration supports the following hardware features: +The Zephyr nucleo_l552ze_q board configuration supports the following +hardware features: +-----------+------------+-------------------------------------+ | Interface | Controller | Driver/Component | +===========+============+=====================================+ -| NVIC | on-chip | nested vector interrupt controller | +| ADC | on-chip | ADC Controller | +-----------+------------+-------------------------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | +| CLOCK | on-chip | reset and clock control | +-----------+------------+-------------------------------------+ -| PINMUX | on-chip | pinmux | +| DAC | on-chip | DAC Controller | ++-----------+------------+-------------------------------------+ +| DMA | on-chip | Direct Memory Access | +-----------+------------+-------------------------------------+ | GPIO | on-chip | gpio | +-----------+------------+-------------------------------------+ | I2C | on-chip | i2c | +-----------+------------+-------------------------------------+ -| PWM | on-chip | pwm | +| NVIC | on-chip | nested vector interrupt controller | ++-----------+------------+-------------------------------------+ +| PINMUX | on-chip | pinmux | ++-----------+------------+-------------------------------------+ +| RNG | on-chip | entropy | +-----------+------------+-------------------------------------+ | SPI | on-chip | spi | +-----------+------------+-------------------------------------+ | TrustZone | on-chip | Trusted Firmware-M | +-----------+------------+-------------------------------------+ -| RNG | on-chip | True Random Number Generator | -+-----------+------------+-------------------------------------+ -| DAC | on-chip | DAC Controller | -+-----------+------------+-------------------------------------+ -| ADC | on-chip | ADC Controller | -+-----------+------------+-------------------------------------+ -| DMA | on-chip | Direct Memory Access | -+-----------+------------+-------------------------------------+ -| SPI | on-chip | Serial Peripheral Interface | +| UART | on-chip | serial port-polling; | +| | | serial port-interrupt | +-----------+------------+-------------------------------------+ -Other hardware features are not yet supported on this Zephyr port. +The default configuration can be found in the defconfig and dts files: -The default configuration can be found in the defconfig file: -``boards/arm/nucleo_l552ze_q/nucleo_l552ze_q_defconfig`` +- Common: + + - :zephyr_file:`boards/arm/nucleo_l552ze_q/nucleo_l552ze_q-common.dtsi` + +- Secure target: + + - :zephyr_file:`boards/arm/nucleo_l552ze_q/nucleo_l552ze_q_defconfig` + - :zephyr_file:`boards/arm/nucleo_l552ze_q/nucleo_l552ze_q.dts` + +- Non-Secure target: + + - :zephyr_file:`boards/arm/nucleo_l552ze_q/nucleo_l552ze_q_ns_defconfig` + - :zephyr_file:`boards/arm/nucleo_l552ze_q/nucleo_l552ze_q_ns.dts` Connections and IOs diff --git a/boards/arm/nucleo_wl55jc/doc/nucleo_wl55jc.rst b/boards/arm/nucleo_wl55jc/doc/nucleo_wl55jc.rst index 3d6e1a3325b..645cd3901d0 100644 --- a/boards/arm/nucleo_wl55jc/doc/nucleo_wl55jc.rst +++ b/boards/arm/nucleo_wl55jc/doc/nucleo_wl55jc.rst @@ -179,24 +179,38 @@ features: +-----------+------------+-------------------------------------+ | Interface | Controller | Driver/Component | +===========+============+=====================================+ -| NVIC | on-chip | nested vector interrupt controller | +| AES | on-chip | crypto | +-----------+------------+-------------------------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | +| CLOCK | on-chip | reset and clock_control | +-----------+------------+-------------------------------------+ -| PINMUX | on-chip | pinmux | +| FLASH | on-chip | flash | +-----------+------------+-------------------------------------+ | GPIO | on-chip | gpio | +-----------+------------+-------------------------------------+ | I2C | on-chip | i2c | +-----------+------------+-------------------------------------+ +| MPU | on-chip | arch/arm | ++-----------+------------+-------------------------------------+ +| NVIC | on-chip | arch/arm | ++-----------+------------+-------------------------------------+ +| PINMUX | on-chip | pinmux | ++-----------+------------+-------------------------------------+ +| RADIO | on-chip | LoRa | ++-----------+------------+-------------------------------------+ +| RNG | on-chip | entropy | ++-----------+------------+-------------------------------------+ | SPI | on-chip | spi | +-----------+------------+-------------------------------------+ +| UART | on-chip | serial port-polling; | +| | | serial port-interrupt | ++-----------+------------+-------------------------------------+ Other hardware features are not yet supported on this Zephyr port. -The default configuration can be found in the defconfig file: -``boards/arm/nucleo_wl55jc/nucleo_wl55jc_defconfig`` +The default configuration can be found in the defconfig and dts files: + +- :zephyr_file:`boards/arm/nucleo_wl55jc/nucleo_wl55jc_defconfig` +- :zephyr_file:`boards/arm/nucleo_wl55jc/nucleo_wl55jc.dts` Connections and IOs diff --git a/boards/arm/stm32l562e_dk/doc/index.rst b/boards/arm/stm32l562e_dk/doc/index.rst index 00b75c02f18..80b26c73265 100644 --- a/boards/arm/stm32l562e_dk/doc/index.rst +++ b/boards/arm/stm32l562e_dk/doc/index.rst @@ -148,41 +148,61 @@ More information about STM32L562QE can be found here: Supported Features ================== -The Zephyr stm32l562e_dk board configuration supports the following hardware features: +The Zephyr stm32l562e_dk board configuration supports the following +hardware features: +-----------+------------+-------------------------------------+ | Interface | Controller | Driver/Component | +===========+============+=====================================+ -| NVIC | on-chip | nested vector interrupt controller | +| ADC | on-chip | ADC Controller | +-----------+------------+-------------------------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | +| AES | on-chip | crypto | +-----------+------------+-------------------------------------+ -| PINMUX | on-chip | pinmux | +| CLOCK | on-chip | reset and clock control | ++-----------+------------+-------------------------------------+ +| DAC | on-chip | DAC Controller | ++-----------+------------+-------------------------------------+ +| DMA | on-chip | Direct Memory Access | +-----------+------------+-------------------------------------+ | GPIO | on-chip | gpio | +-----------+------------+-------------------------------------+ | I2C | on-chip | i2c | +-----------+------------+-------------------------------------+ +| NVIC | on-chip | nested vector interrupt controller | ++-----------+------------+-------------------------------------+ +| PINMUX | on-chip | pinmux | ++-----------+------------+-------------------------------------+ +| PWM | on-chip | PWM | ++-----------+------------+-------------------------------------+ +| RNG | on-chip | entropy | ++-----------+------------+-------------------------------------+ | SPI | on-chip | spi | +-----------+------------+-------------------------------------+ | TrustZone | on-chip | Trusted Firmware-M | +-----------+------------+-------------------------------------+ -| RNG | on-chip | True Random Number Generator | +| UART | on-chip | serial port-polling; | +| | | serial port-interrupt | +-----------+------------+-------------------------------------+ -| PWM | on-chip | PWM | -+-----------+------------+-------------------------------------+ -| DAC | on-chip | DAC Controller | -+-----------+------------+-------------------------------------+ -| ADC | on-chip | ADC Controller | -+-----------+------------+-------------------------------------+ -| DMA | on-chip | Direct Memory Access | +| WATCHDOG | on-chip | independent watchdog | +-----------+------------+-------------------------------------+ Other hardware features are not yet supported on this Zephyr port. -The default configuration can be found in the defconfig file: -``boards/arm/stm32l562e_dk/stm32l562e_dk_defconfig`` +The default configuration can be found in the defconfig and dts files: + +- Common: + + - :zephyr_file:`boards/arm/stm32l562e_dk/stm32l562e_dk_common.dtsi` + +- Secure target: + + - :zephyr_file:`boards/arm/stm32l562e_dk/stm32l562e_dk_defconfig` + - :zephyr_file:`boards/arm/stm32l562e_dk/stm32l562e_dk.dts` + +- Non-Secure target: + + - :zephyr_file:`boards/arm/stm32l562e_dk/stm32l562e_dk_ns_defconfig` + - :zephyr_file:`boards/arm/stm32l562e_dk/stm32l562e_dk_ns.dts` Connections and IOs