:orphan:
.. raw:: html
.. dtcompatible:: st,stm32u5-mipi-dsi
.. _dtbinding_st_stm32u5_mipi_dsi:
st,stm32u5-mipi-dsi
###################
.. sidebar:: Overview
:Name: ``st,stm32u5-mipi-dsi``
:Vendor: :ref:`STMicroelectronics N.V. `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=st,stm32u5-mipi-dsi>` using
this compatible
Description
***********
These nodes are "mipi-dsi" bus nodes.
.. code-block:: none
STM32U5 series MIPI DSI controller.
Properties
**********
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``phy-freq-range``
- ``int``
- .. code-block:: none
D-PHY PLL input frequency range. This is used to select the appropriate
frequency range for the D-PHY PLL operation.
0x0 : DSI_DPHY_FRANGE_80MHZ_100MHZ
0x1 : DSI_DPHY_FRANGE_100MHZ_120MHZ
0x2 : DSI_DPHY_FRANGE_120MHZ_160MHZ
0x3 : DSI_DPHY_FRANGE_160MHZ_200MHZ
0x4 : DSI_DPHY_FRANGE_200MHZ_240MHZ
0x5 : DSI_DPHY_FRANGE_240MHZ_320MHZ
0x6 : DSI_DPHY_FRANGE_320MHZ_390MHZ
0x7 : DSI_DPHY_FRANGE_390MHZ_450MHZ
0x8 : DSI_DPHY_FRANGE_450MHZ_510MHZ
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``
* - ``phy-low-power-offset``
- ``int``
- .. code-block:: none
D-PHY low power offset configuration specific to STM32U5 series.
0x0 : PHY_LP_OFFSSET_0_CLKP (0 CLKP)
0x1 : PHY_LP_OFFSSET_1_CLKP (+1 CLKP)
0x2 : PHY_LP_OFFSSET_2_CLKP (+2 CLKP)
0x3 : PHY_LP_OFFSSET_3_CLKP (+3 CLKP)
0x4 : PHY_LP_OFFSSET_4_CLKP (+4 CLKP)
0x5 : PHY_LP_OFFSSET_5_CLKP (+5 CLKP)
0x6 : PHY_LP_OFFSSET_6_CLKP (+6 CLKP)
0x7 : PHY_LP_OFFSSET_7_CLKP (+7 CLKP)
0x8 : PHY_LP_OFFSSET_MINUS_1_CLKP (-1 CLKP)
0x9 : PHY_LP_OFFSSET_MINUS_2_CLKP (-2 CLKP)
0xA : PHY_LP_OFFSSET_MINUS_3_CLKP (-3 CLKP)
0xB : PHY_LP_OFFSSET_MINUS_4_CLKP (-4 CLKP)
0xC : PHY_LP_OFFSSET_MINUS_5_CLKP (-5 CLKP)
0xD : PHY_LP_OFFSSET_MINUS_6_CLKP (-6 CLKP)
0xE : PHY_LP_OFFSSET_MINUS_7_CLKP (-7 CLKP)
0xF : PHY_LP_OFFSSET_MINUS_8_CLKP (-8 CLKP)
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``
* - ``pll-vco-range``
- ``int``
- .. code-block:: none
PLL VCO frequency range configuration for STM32U5 D-PHY.
0x0 : DSI_DPHY_VCO_FRANGE_500MHZ_800MHZ
0x1 : DSI_DPHY_VCO_FRANGE_800MHZ_1GHZ
This property is **required**.
Legal values: ``0``, ``1``
* - ``pll-charge-pump``
- ``int``
- .. code-block:: none
PLL charge pump configuration for STM32U5 D-PHY.
Valid values:
0x0 : DSI_PLL_CHARGE_PUMP_2000HZ_4400HZ
0x1 : DSI_PLL_CHARGE_PUMP_4400HZ_14100HZ
0x0 : DSI_PLL_CHARGE_PUMP_14100HZ_30900HZ
0x3 : DSI_PLL_CHARGE_PUMP_30900HZ_45700HZ
0x2 : DSI_PLL_CHARGE_PUMP_45700HZ_50000HZ
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``pll-tuning``
- ``int``
- .. code-block:: none
PLL tuning parameter (loop filter) for STM32U5 D-PHY.
0x0 : DSI_PLL_LOOP_FILTER_2000HZ_4400HZ
0x1 : DSI_PLL_LOOP_FILTER_4400HZ_30900HZ
0x2 : DSI_PLL_LOOP_FILTER_30900HZ_50000HZ
This property is **required**.
Legal values: ``0``, ``1``, ``2``
* - ``resets``
- ``phandle-array``
- .. code-block:: none
Reset information
This property is **required**.
* - ``hs-active-high``
- ``boolean``
- .. code-block:: none
DSI host horizontal synchronization is active high.
* - ``vs-active-high``
- ``boolean``
- .. code-block:: none
DSI host vertical synchronization is active high.
* - ``de-active-high``
- ``boolean``
- .. code-block:: none
DSI host data enable is active high.
* - ``loosely-packed``
- ``boolean``
- .. code-block:: none
Enable or disable loosely packed stream
(needed only when using 18-bit configuration).
* - ``largest-packet-size``
- ``int``
- .. code-block:: none
The size, in bytes, of the low power largest packet that
can fit in a line during VSA, VBP, VFP and VACT regions
* - ``bta-ack-disable``
- ``boolean``
- .. code-block:: none
Disable frame bus-turn-around acknowledge enable
* - ``non-continuous``
- ``boolean``
- .. code-block:: none
DSI host enable non continuous clock.
* - ``pll-ndiv``
- ``int``
- .. code-block:: none
DSI host dedicated PLL loop division factor.
This property is **required**.
* - ``pll-idf``
- ``int``
- .. code-block:: none
DSI host dedicated PLL input division factor.
This property is **required**.
* - ``pll-odf``
- ``int``
- .. code-block:: none
DSI HOST dedicated PLL output division factor.
This property is **required**.
* - ``active-errors``
- ``int``
- .. code-block:: none
Indicates which error interrupts will be enabled.
This parameter can be any combination of DSI_Error_Data_Type and
defaults to HAL_DSI_ERROR_NONE.
* - ``lp-rx-filter``
- ``int``
- .. code-block:: none
Use Low-Power Reception Filter. Cutoff frequency of low-pass filter at the input of LPRX.
Defaults to 0 which disables the filter.
* - ``host-timeouts``
- ``array``
- .. code-block:: none
DSI HOST timeout parameters.
* - ``phy-timings``
- ``array``
- .. code-block:: none
DSI HOST PHY timing parameters.
* - ``test-pattern``
- ``int``
- .. code-block:: none
Show DSI host color bars, select color bar orientation
0 : Vertical color bars
1 : Horizontal color bars
Legal values: ``0``, ``1``
* - ``phy-clock``
- ``int``
- .. code-block:: none
MIPI PHY clock frequency. Should be set to ensure clock frequency is at least (pixel clock * bits per output pixel) / number of mipi data lanes
* - ``reset-names``
- ``string-array``
- .. code-block:: none
Name of each reset
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
Properties inherited from the base binding file, which defines
common properties that may be set on many nodes. Not all of these
may apply to the "st,stm32u5-mipi-dsi" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``clock-names``
- ``string-array``
- .. code-block:: none
"dsiclk" DSI clock enable.
"dsisrc" DSI clock source.
"refclk" External crystal or oscillator clock.
"pixelclk" LTDC pixel clock.
"refclk" and "pixelclk" are only used to retrieve the frequency for timing calculation.
This property is **required**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
This property is **required**.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
This property is **required**.
Constant value: ``1``
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
This property is **required**.
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" property.
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.