:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: st,stm32-mipi-dsi
.. _dtbinding_st_stm32_mipi_dsi:

st,stm32-mipi-dsi
#################

Vendor: :ref:`STMicroelectronics <dt_vendor_st>`

Description
***********

These nodes are "mipi-dsi" bus nodes.

.. code-block:: none

   STM32 MIPI DSI host

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

         * - ``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,stm32-mipi-dsi" compatible.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


             This property is **required**.

         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                "dsiclk" DSI clock enable.
                "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**.

         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                number of address cells in reg property


             This property is **required**.

             Constant value: ``1``

         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                number of size cells in reg property


             This property is **required**.

         * - ``status``
           - ``string``
           - .. code-block:: none

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`dt-important-props` for more information.

         * - ``reg``
           - ``array``
           - .. code-block:: none

                register space


             See :ref:`dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             See :ref:`dt-important-props` for more information.

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                phandle to interrupt controller node


         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device (used as device_get_binding() argument)



             See :ref:`dt-important-props` for more information.

             This property is **deprecated**.

         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channels specifiers


         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of DMA channel specifiers


         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channels specifiers


         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of IO channel specifiers


         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                mailbox / IPM channels specifiers


         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of mailbox / IPM channel specifiers


         * - ``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.



         * - ``power-domain``
           - ``phandle``
           - .. code-block:: none


                Power domain the device belongs to.

                The device will be notified when the power domain it belongs to is either
                suspended or resumed.



         * - ``zephyr,pm-device-runtime-auto``
           - ``boolean``
           - .. code-block:: none

                Automatically configure the device for runtime power management after the
                init function runs.