: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-ltdc
.. _dtbinding_st_stm32_ltdc:

st,stm32-ltdc
#############

Vendor: :ref:`STMicroelectronics <dt_vendor_st>`

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



.. code-block:: none

   STM32 LCD-TFT display 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

         * - ``disp-on-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Display on/off GPIO pin.
                Configure the GPIO polarity (active high/active low) according to LCD datasheet.



         * - ``bl-ctrl-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Backlight on/off GPIO pin.
                Configure the GPIO polarity (active high/active low) according to LCD datasheet.



         * - ``ext-sdram``
           - ``phandle``
           - .. code-block:: none

                External SDRAM in which frame buffer will be stored.
                If not defined, internal RAM will be used.



         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



             This property is **required**.

         * - ``hsync-pol``
           - ``int``
           - .. code-block:: none

                Horizontal synchronization pulse polarity.
                If HSYNC is active low, use STM32_LTDC_HSPOL_ACTIVE_LOW,
                otherwise use STM32_LTDC_HSPOL_ACTIVE_HIGH.



             This property is **required**.

         * - ``vsync-pol``
           - ``int``
           - .. code-block:: none

                Vertical synchronization pulse polarity.
                If VSYNC is active low, use STM32_LTDC_VSPOL_ACTIVE_LOW,
                otherwise use STM32_LTDC_VSPOL_ACTIVE_HIGH.



             This property is **required**.

         * - ``de-pol``
           - ``int``
           - .. code-block:: none

                Data enable pulse polarity.
                If DE is active low, use STM32_LTDC_DEPOL_ACTIVE_LOW,
                otherwise use STM32_LTDC_DEPOL_ACTIVE_HIGH.



             This property is **required**.

         * - ``pclk-pol``
           - ``int``
           - .. code-block:: none

                Pixel clock polarity.
                If RGB data is sampled on falling edge of PCLK, use STM32_LTDC_PCPOL_ACTIVE_LOW,
                otherwise use STM32_LTDC_PCPOL_ACTIVE_HIGH.



             This property is **required**.

         * - ``hsync-duration``
           - ``int``
           - .. code-block:: none

                Horizontal synchronization pulse duration, in pixels


             This property is **required**.

         * - ``vsync-duration``
           - ``int``
           - .. code-block:: none

                Vertical synchronization pulse duration, in lines


             This property is **required**.

         * - ``hbp-duration``
           - ``int``
           - .. code-block:: none

                Horizontal back-porch duration, in pixels


             This property is **required**.

         * - ``vbp-duration``
           - ``int``
           - .. code-block:: none

                Vertical back-porch duration, in lines


             This property is **required**.

         * - ``hfp-duration``
           - ``int``
           - .. code-block:: none

                Horizontal front porch duration, in pixels


             This property is **required**.

         * - ``vfp-duration``
           - ``int``
           - .. code-block:: none

                Vertical front porch duration, in lines


             This property is **required**.

         * - ``def-back-color-red``
           - ``int``
           - .. code-block:: none

                Default display background color - red


         * - ``def-back-color-green``
           - ``int``
           - .. code-block:: none

                Default display background color - green


         * - ``def-back-color-blue``
           - ``int``
           - .. code-block:: none

                Default display background color - blue


         * - ``height``
           - ``int``
           - .. code-block:: none

                Height of the panel driven by the controller, with the units in pixels.



             This property is **required**.

         * - ``width``
           - ``int``
           - .. code-block:: none

                Width of the panel driven by the controller, with the units in pixels.



             This property is **required**.

         * - ``pinctrl-1``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the second state. See pinctrl-0.



         * - ``pinctrl-2``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the third state. See pinctrl-0.



         * - ``pinctrl-3``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fourth state. See pinctrl-0.



         * - ``pinctrl-4``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fifth state. See pinctrl-0.



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

                Names for the provided states. The number of names needs to match the
                number of states.





   .. 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-ltdc" 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**.

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

                interrupts for device


             This property is **required**.

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

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

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


             This property is **required**.

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

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

                indicates the operational status of a device


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

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

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

                compatible strings


             This property is **required**.

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

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

                register space


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

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

                name of each register space


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


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

                name of each clock


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

                number of address cells in reg property


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

                number of size cells in reg property


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