dts: stm32: Streamline Devicetree binding descriptions

Ensure consistent (and concise) short descriptions of all the st,*.yaml
bindings

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2025-03-04 16:21:07 +01:00 committed by Benjamin Cabé
parent 90c6eb1da7
commit 2c1538d57e
90 changed files with 130 additions and 92 deletions

View File

@ -2,7 +2,7 @@
# Copyright (c) 2018, Song Qiang <songqiang1304521@gmail.com>
# SPDX-License-Identifier: Apache-2.0
description: ST STM32 family ADC
description: STM32 ADC
compatible: "st,stm32-adc"

View File

@ -3,7 +3,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
ST STM32F1 family ADC
STM32F1 ADC
This compatible stands for all ADC blocks similar to the one on STM32F1,
like STM32F37x.
Remove the st,adc-clock-source and st,adc-prescaler property.

View File

@ -3,7 +3,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
ST STM32F4 family ADC
STM32F4 ADC
This compatible stands for all ADC blocks similar to the one on STM32F4,
like F2, F7 or L1.

View File

@ -3,7 +3,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
ST STM32N6 ADC
STM32N6 ADC
This compatible stands for STM32N6 ADC.
compatible: "st,stm32n6-adc"

View File

@ -1,6 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
description: STM32WB0 series Analog-to-Digital Converter
description: STM32WB0 Analog-to-Digital Converter
compatible: "st,stm32wb0-adc"

View File

@ -1,4 +1,4 @@
description: ST STM32 FDCAN CAN FD controller
description: STM32 FDCAN CAN FD controller
compatible: "st,stm32-fdcan"

View File

@ -1,4 +1,4 @@
description: ST STM32H7 series FDCAN CAN FD controller
description: STM32H7 series FDCAN CAN FD controller
compatible: "st,stm32h7-fdcan"

View File

@ -3,6 +3,7 @@
description: |
STM32 Clock multiplexer
Describes a clock multiplexer, such as per_ck on STM32H7 or
CLK48 on STM32WB.
The only property of this node is to select a clock input.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Reset and Clock controller node.
STM32 RCC (Reset and Clock controller).
This node is in charge of system clock ('SYSCLK') source selection and controlling
clocks for AHB (Advanced High Performance) and APB (Advanced Peripheral) bus domains.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 HSI Clock node description for STM32C0 devices
STM32C0 HSI Clock.
On STM32C0, HSI is a 48MHz fixed clock.
It also produces a HSISYS secondary clk which can be used as system clock

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
Main PLL node binding for STM32F0 and STM32F3 devices.
STM32F0/F3 Main PLL.
Takes one of clk_hse or clk_hsi as input clock.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F0 and G0 Reset and Clock controller node.
STM32F0/G0 RCC (Reset and Clock controller).
For more description confere st,stm32-rcc.yaml
compatible: "st,stm32f0-rcc"

View File

@ -7,7 +7,7 @@
compatible: "st,stm32f1-clock-mco"
description: |
STM32 F1 series Microcontroller Clock Output (MCO)
STM32F1 Microcontroller Clock Output (MCO)
The STM32F1 MCO is similar to other series but has no configurable
prescaler before the output. However, note that certain inputs of

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
Main PLL node binding for low-, medium-, high- and XL-density STM32F1 devices.
STM32F1 Main PLL for low-, medium-, high- and XL-density devices.
Takes one of 'clk_hse', 'clk_hse / 2' (when 'xtpre' is set) or 'clk_hsi / 2'
as input clock.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F1 and STM32F37x Reset and Clock controller node.
STM32F1/F3/7x RCC (Reset and Clock controller).
Adds the ADC prescaler to the standard generic STM32 RCC.
For more description confere st,stm32-rcc.yaml

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
Main PLL node binding for STM32F100 devices
STM32F100 Main PLL.
Takes one of clk_hse or clk_hsi as input clock.
When clk_hsi is used a fixed prescaler is applied. When input clock is hse or

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
Main PLL node binding for Connectivity line devices (STM32F105/STM32F107)
STM32F105/F107 Main PLL.
Takes one of clk_hse, pll2 or clk_hsi as input clock.
When clk_hsi is used a fixed prescaler is applied. When input clock is hse or

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL2 node binding for Connectivity line devices (STM32F105/STM32F107)
STM32F105/F107 PLL2.
Takes clk_hse as input clock, using prediv as prescaler.

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F2 Main PLL node binding:
STM32F2 Main PLL.
Takes one of clk_hse or clk_hsi as input clock.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F3 Reset and Clock controller node.
STM32F3 RCC (Reset and Clock controller).
Adds the STM32F3 ADC prescaler to the standard generic STM32 RCC.
For more description confere st,stm32-rcc.yaml

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F4 Main PLL node binding:
STM32F4 Main PLL.
Takes one of clk_hse or clk_hsi as input clock, with an
input frequency from 1 to 2 MHz. PLLM factor is used to set the input clock

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F4 PLL I2S node binding:
STM32F4 PLL I2S.
Takes same input as Main PLL. PLLM factor and PLL source are common with Main PLL

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F411 PLL I2S node binding:
STM32F411 PLL I2S.
Fully configurable I2S dedicated PLL.

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F7 Main PLL node binding:
STM32F7 Main PLL.
Takes one of clk_hse or clk_hsi as input clock.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 HSI Clock node description for STM32G0 devices
STM32G0 HSI Clock.
On STM32G0, HSI is a 16MHz fixed clock.
It also produces a HSISYS secondary clk which can be used as system clock

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32G0 devices
STM32G0 main PLL.
It can take one of clk_hse or clk_hsi as input clock, with
an input frequency from 2.66 to 16 MHz. PLLM factor is used to set the input

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32G4 devices
STM32G4 main PLL.
It can take one of clk_hse or clk_hsi as input clock, with
an input frequency from 2.66 to 16 MHz. PLLM factor is used to set the input

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32H7 devices
STM32H7 main PLL.
It can be used to describe 3 different PLLs: PLL1 (Main PLL), PLL2 and PLL3.
Only PLL1 and PLL3 are supported for now.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Reset and Clock controller node for STM32H7 devices
STM32H7 RCC (Reset and Clock controller).
This node is in charge of system clock ('SYSCLK') source selection and
System Clock Generation.

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32H7RS devices
STM32H7RS main PLL.
It can be used to describe 3 different PLLs: PLL1 (Main PLL), PLL2 and PLL3.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Reset and Clock controller node for STM32H7RS devices
STM32H7RS RCC (Reset and Clock controller).
This node is in charge of system clock ('SYSCLK') source selection and
System Clock Generation.

View File

@ -1,7 +1,7 @@
# Copyright (c) 2021, Linaro ltd
# SPDX-License-Identifier: Apache-2.0
description: STM32L0 and STM32L1 Multi Speed Internal Clock
description: STM32L0/L1 Multi Speed Internal Clock
compatible: "st,stm32l0-msi-clock"

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32L0 and STM32L1 Main PLL node binding:
STM32L0/L1 Main PLL.
Takes one of clk_hse, clk_hsi or clk_msi as input clock, with an
input frequency from 2 to 24 MHz.

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32L4 and STM32L5 devices
STM32L4/L5 main PLL.
It can be used to describe 3 different PLLs: PLL, PLLSAI1 and PLLSAI2.
Only main PLL is supported for now.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32MP1 Reset and Clock controller node.
STM32MP1 RCC (Reset and Clock controller).
On STM32MP1 platforms, clock control configuration is performed on A9 side.
As a consequence, the only property to be set in devicetree node is the
clock-frequency (mlhclk_ck).

View File

@ -2,9 +2,11 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32N6 CPU Clock
STM32N6 CPU Clock.
Describes the STM32N6 CPU clock multiplexer. On STM32N6, this is the CPU
clock that feeds the SysTick.
For instance:
&cpusw {
clocks = <&rcc STM32_SRC_IC1 CPU_SEL(3)>;

View File

@ -2,8 +2,10 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32N6 Divider IC multiplexer
This node select a clock input and a divider.
STM32N6 Divider IC multiplexer.
This node selects a clock input and a divider.
For instance:
&ic6 {
pll-src = <2>;

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32N6 devices
STM32N6 main PLL.
It can be used to describe 4 different PLLs: PLL1, PLL2, PLL3 and PLL4.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Reset and Clock controller node for STM32N6 devices
STM32N6 RCC (Reset and Clock controller).
This node is in charge of system clock ('SYSCLK') source selection and
System Clock Generation.

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32U0 Main PLL node binding:
STM32U0 Main PLL.
Takes one of clk_hse, clk_hsi or clk_msi as input clock, with
an input frequency from 2.66 to 16 MHz. PLLM factor is used to set the input

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32U5 devices
STM32U5 PLL.
It can be used to describe 3 different PLLs: PLL1, PLL2 and PLL3.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32U5 Reset and Clock controller node.
STM32U5 RCC (Reset and Clock controller).
For more description confere st,stm32-rcc.yaml
compatible: "st,stm32u5-rcc"

View File

@ -3,6 +3,7 @@
description: |
STM32WB Reset and Clock controller node.
For more description confere st,stm32-rcc.yaml
compatible: "st,stm32wb-rcc"

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32WB0 Reset and Clock controller node for STM32WB0 devices
STM32WB0 RCC (Reset and Clock controller).
This node is in charge of the system clock ('SYSCLK') source
selection and generation.

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
PLL node binding for STM32WBA devices
STM32WBA PLL.
It can be used to describe PLL1

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Reset and Clock controller node.
STM32WBA RCC (Reset and Clock controller).
This node is in charge of system clock ('SYSCLK') source selection and controlling
clocks for AHB (Advanced High Performance) and APB (Advanced Peripheral) bus domains.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32WL Reset and Clock controller node.
STM32WL RCC (Reset and Clock controller).
For more description confere st,stm32-rcc.yaml
compatible: "st,stm32wl-rcc"

View File

@ -1,7 +1,7 @@
# Copyright (c) 2020 Libre Solar Technologies GmbH
# SPDX-License-Identifier: Apache-2.0
description: ST STM32 family DAC
description: STM32 family DAC
compatible: "st,stm32-dac"

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 DMA controller for the stm32U5 soc family
STM32U5 DMA controller.
It is present on stm32U5 devices as a GP DMA
This controller includes several channels with different requests.

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
ST STM32H7 Ethernet
STM32H7 Ethernet
This binding file describes the device tree properties required to configure
and use the Ethernet controller on STM32H7 and STM32H5 series microcontrollers.

View File

@ -1,4 +1,4 @@
description: STM32 F1 flash controller
description: STM32F1 flash controller
compatible: "st,stm32f1-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 F2 flash controller
description: STM32F2 flash controller
compatible: "st,stm32f2-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 F4 flash controller
description: STM32F4 flash controller
compatible: "st,stm32f4-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 F7 flash controller
description: STM32F7 flash controller
compatible: "st,stm32f7-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 G0 flash controller
description: STM32G0 flash controller
compatible: "st,stm32g0-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 G4 flash controller
description: STM32G4 flash controller
compatible: "st,stm32g4-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 H7 flash controller
description: STM32H7 flash controller
compatible: "st,stm32h7-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 L4 flash controller
description: STM32L4 flash controller
compatible: "st,stm32l4-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 L5 flash controller
description: STM32L5 flash controller
compatible: "st,stm32l5-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 WB flash controller
description: STM32WB flash controller
compatible: "st,stm32wb-flash-controller"

View File

@ -1,4 +1,4 @@
description: STM32 WBA flash controller
description: STM32WBA flash controller
compatible: "st,stm32wba-flash-controller"

View File

@ -1,7 +1,7 @@
# Copyright (c) 2018, Linaro Limited
# SPDX-License-Identifier: Apache-2.0
description: STM32 GPIO node
description: STM32 GPIO controller
compatible: "st,stm32-gpio"

View File

@ -1,4 +1,4 @@
description: STMicroelectronics STM32 family External Interrupt Controller
description: STM32 External Interrupt Controller
compatible: "st,stm32-exti"

View File

@ -3,7 +3,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 controller
STM32G0 External Interrupt Controller
This compatible stands for all interrupt-controller blocks with two
dedicated Rising and Falling interrupt pending registers.

View File

@ -3,7 +3,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 controller
STM32H7RS External Interrupt Controller
This compatible stands for the stm32H7RS interrupt-controller block
with two dedicated Rising and Falling interrupt pending registers

View File

@ -1,7 +1,7 @@
# Copyright (c) 2021 Fabio Baltieri
# SPDX-License-Identifier: Apache-2.0
description: STM32WL SUBGHZ Radio
description: STM32WL Sub-GHz Radio
compatible: "st,stm32wl-subghz-radio"

View File

@ -2,7 +2,7 @@
# Copyright (c) 2024 Analog Devices Inc.
# SPDX-License-Identifier: Apache-2.0
description: ST MDIO Features
description: STM32 MDIO Controller
compatible: "st,stm32-mdio"

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Flexible Memory Controller (FMC).
STM32H7 Flexible Memory Controller (FMC).
The FMC allows to interface with static-memory mapped external devices such as
SRAM, NOR Flash, NAND Flash, SDRAM...

View File

@ -1,4 +1,4 @@
description: stm32 sdmmc disk access
description: STM32 SDMMC Disk Access
compatible: "st,stm32-sdmmc"

View File

@ -1,7 +1,8 @@
description: |
STM32 flash memory. This binding is for the flash memory itself, not
the flash controller peripheral. For that, see the
"st,stm32-flash-controller" binding.
STM32 flash memory.
This binding is for the flash memory itself, not the flash controller peripheral.
For that, see the "st,stm32-flash-controller" binding.
include: soc-nv-flash.yaml

View File

@ -1,5 +1,5 @@
description: |
ST STM32F4 family flash memory.
STM32F4 flash memory.
include: st,stm32-nv-flash.yaml

View File

@ -1,5 +1,5 @@
description: |
ST STM32L0 family flash memory.
STM32L0 flash memory.
include: st,stm32-nv-flash.yaml

View File

@ -2,8 +2,9 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 OSPI device representation. Enabling a stm32 octospi node in a board
description would typically requires this:
STM32 OSPI Controller.
Enabling a stm32 octospi node in a board description would typically requires this:
&octospi {
pinctrl-0 = <&octospi_clk_pe9 &octospi_ncs_pe10 &octospi_dqs_pe11

View File

@ -3,6 +3,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32U5 OTG HS PHY.
This binding is to be used by the STM32U5xx transceivers which are built-in
with USB HS PHY IP and a configurable HSE clock source.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Pin controller Node
STM32 Pin controller.
Based on pincfg-node.yaml binding.
Note: `bias-disable` and `drive-push-pull` are default pin configurations.

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32F1 Pin controller Node
STM32F1 Pin controller.
Based on pincfg-node.yaml binding.
Note: `bias-disable` and `drive-push-pull` are default pin configurations.

View File

@ -2,8 +2,9 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 QSPI device representation. A stm32 quadspi node would typically
looks to this:
STM32 QSPI Controller.
An stm32 quadspi node would typically look like this:
&quadspi {
pinctrl-0 = <&quadspi_clk_pe10 &quadspi_ncs_pe11

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 Reset and Clock Control (RCC) node.
STM32 Reset and Clock Control (RCC) Controller.
This node is in charge of reset control for AHB (Advanced High Performance)
and APB (Advanced Peripheral) bus domains.

View File

@ -1,7 +1,7 @@
# Copyright (c) 2024, Aurelien Jarno
# SPDX-License-Identifier: Apache-2.0
description: STM32 family Digital Temperature Sensor node
description: STM32 Digital Temperature Sensor.
compatible: "st,stm32-digi-temp"

View File

@ -1,7 +1,7 @@
# Copyright (c) 2021, Eug Krashtan
# SPDX-License-Identifier: Apache-2.0
description: STM32 family TEMP node
description: STM32 Internal Temperature Sensor.
compatible: "st,stm32-temp"

View File

@ -1,7 +1,7 @@
# Copyright (c) 2022 STMicroelectronics
# SPDX-License-Identifier: Apache-2.0
description: STM32 family VBAT node
description: STM32 VBAT
include: sensor-device.yaml

View File

@ -1,7 +1,7 @@
# Copyright (c) 2023 Kenneth J. Miller <ken@miller.ec>
# SPDX-License-Identifier: Apache-2.0
description: STM32 family VREF+ node
description: STM32 VREF+.
compatible: "st,stm32-vref"

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 family TEMP node for production calibrated sensors with a single calibration temperature.
STM32 TEMP for production calibrated sensors with a single calibration temperature.
compatible: "st,stm32c0-temp-cal"

View File

@ -3,6 +3,7 @@
description: |
Host Command version of STM32 SPI controller.
All properties are the same, but a different driver is used.
compatible: "st,stm32-spi-host-cmd"

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32H7 SPI controller
STM32H7 SPI controller.
This compatible stands for all SPI hardware blocks matching the
version available in STM32H7 SoCs.
This version of STM32 SPI hardware block could be identified by the

View File

@ -2,8 +2,9 @@
# SPDX-License-Identifier: Apache-2.0
description: |
ST STM32 family USB Type-C / Power Delivery. The default values were
taken from the LL_UCPD_StructInit function defined in the HAL.
STM32 USB Type-C / Power Delivery.
The default values were taken from the LL_UCPD_StructInit function defined in the HAL.
compatible: "st,stm32-ucpd"

View File

@ -2,7 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 lptim : low power timer
STM32 low-power timer (LPTIM).
The lptim node to be used for counting ticks during lowpower modes
must be named stm32_lp_tick_source in the DTS, as follows:
stm32_lp_tick_source: &lptim1 {

View File

@ -1,7 +1,7 @@
# Copyright (c) 2023 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0
#
description: STM32F4 SoC series OTG_FS DWC2 compatible controller
description: STM32F4 OTG_FS DWC2 compatible controller.
compatible: "st,stm32f4-fsotg"

View File

@ -5,7 +5,8 @@
#
description: |
STMicroelectronics STM32 Digital Camera Memory Interface (DCMI).
STM32 Digital Camera Memory Interface (DCMI).
Example of node configuration at board level:
&dcmi {

View File

@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
description: |
STM32 XSPI device representation. Enabling a stm32 xspi node in a board
STM32 XSPI Controller.
compatible: "st,stm32-xspi"