Hitachi HD44780 LCD binding

: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:: hit,hd44780
.. _dtbinding_hit_hd44780:

hit,hd44780
###########

Vendor: :ref:`Hitachi Ltd. <dt_vendor_hit>`

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



.. code-block:: none

   Hitachi HD44780 LCD

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

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

                Number of text columns that the display has


             This property is **required**.

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

                Number of text rows that the display has


             This property is **required**.

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

                Operating mode of display, 8-bit or 4 for 4-bit mode


             This property is **required**.

             Legal values: ``4``, ``8``

         * - ``register-select-gpios``
           - ``phandle-array``
           - .. code-block:: none

                GPIO connected to Register Select (RS) of LCD


             This property is **required**.

         * - ``read-write-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Optional GPIO used for selecting read or write mode


         * - ``enable-gpios``
           - ``phandle-array``
           - .. code-block:: none

                GPIO used for enabling commands to be sent


             This property is **required**.

         * - ``data-bus-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Array of GPIOs connected to the DB lines of the display, this must
                contain 8 entries ascending from DB0 to DB7, for 4-bit interface
                displays, the first 4 must be set as `<0>`



             This property is **required**.

         * - ``brightness-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Optional GPIO used for controlling the brightness (contrast)


         * - ``backlight-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Optional GPIO used for enabling the backlight


         * - ``line-addresses``
           - ``uint8-array``
           - .. code-block:: none

                Array of addresses for each row, will use defaults if not provided.
                Default is as per Hitachi HD44780 specification.



             Default value: ``[0, 64, 20, 84]``

         * - ``enable-line-rise-delay-us``
           - ``int``
           - .. code-block:: none

                Delay time (in us) to wait after enable line rises before setting low.
                Default is as per Hitachi HD44780 specification.



             Default value: ``800``

         * - ``enable-line-fall-delay-us``
           - ``int``
           - .. code-block:: none

                Delay time (in us) to wait after enable line falls before sending
                another command. Default is as per Hitachi HD44780 specification.



             Default value: ``100``

         * - ``clear-command-delay-us``
           - ``int``
           - .. code-block:: none

                Delay time (in us) to wait after issuing a clear command before sending
                another command. Default is as per Hitachi HD44780 specification.



             Default value: ``5000``

         * - ``boot-delay-ms``
           - ``int``
           - .. code-block:: none

                Delay time (in ms) to wait at boot time before sending a command (note:
                this will delay startup of the whole application by this time, this
                should only be used when time is needed for the display device to be
                ready before it can be configured which without any delay would cause
                the display to not function properly).





   .. 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 "hit,hd44780" compatible.

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

         * - Name
           - Type
           - Details

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



         * - ``zephyr,disabling-power-states``
           - ``phandles``
           - .. code-block:: none

                List of power states that will disable this device power.



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

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

                Clock gate information


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


         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().