UltraChip UC8175 EPD 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:: ultrachip,uc8175
.. _dtbinding_ultrachip_uc8175:

ultrachip,uc8175 (on mipi-dbi bus)
##################################

Vendor: :ref:`UltraChip Inc. <dt_vendor_ultrachip>`

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



.. code-block:: none

   UltraChip UC8175 EPD controller

Properties
**********

Top level properties
====================


These property descriptions apply to "ultrachip,uc8175"
nodes themselves. This page also describes child node
properties in the following sections.

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

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

                GPIO specifier that controls power to the device.

                This property should be provided when the device has a dedicated
                switch that controls power to the device.  The supply state is
                entirely the responsibility of the device driver.

                Contrast with vin-supply.



         * - ``vin-supply``
           - ``phandle``
           - .. code-block:: none

                Reference to the regulator that controls power to the device.
                The referenced devicetree node must have a regulator compatible.

                This property should be provided when device power is supplied
                by a shared regulator.  The supply state is dependent on the
                request status of all devices fed by the regulator.

                Contrast with supply-gpios.  If both properties are provided
                then the regulator must be requested before the supply GPIOS is
                set to an active state, and the supply GPIOS must be set to an
                inactive state before releasing the regulator.



         * - ``mipi-max-frequency``
           - ``int``
           - .. code-block:: none

                Maximum clock frequency of device's MIPI interface in Hz


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

                MIPI DBI mode in use. Use the macros, not the actual enum value. Here is
                the concordance list (see dt-bindings/mipi_dbi/mipi_dbi.h)
                  1     MIPI_DBI_MODE_SPI_3WIRE
                  2     MIPI_DBI_MODE_SPI_4WIRE
                  3     MIPI_DBI_MODE_6800_BUS_16_BIT
                  4     MIPI_DBI_MODE_6800_BUS_9_BIT
                  5     MIPI_DBI_MODE_6800_BUS_8_BIT
                  6     MIPI_DBI_MODE_8080_BUS_16_BIT
                  7     MIPI_DBI_MODE_8080_BUS_9_BIT
                  8     MIPI_DBI_MODE_8080_BUS_8_BIT



             Legal values: ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``

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

                SPI Duplex mode, full or half. By default it's always full duplex thus 0
                as this is, by far, the most common mode.
                Selecting half duplex allows to use SPI MOSI as a bidirectional line,
                typically used when only one data line is connected.
                Use the macros not the actual enum value, here is the concordance
                list (see dt-bindings/spi/spi.h)
                  0    SPI_FULL_DUPLEX
                  2048 SPI_HALF_DUPLEX



         * - ``mipi-cpol``
           - ``boolean``
           - .. code-block:: none

                SPI clock polarity which indicates the clock idle state.
                If it is used, the clock idle state is logic high; otherwise, low.



         * - ``mipi-cpha``
           - ``boolean``
           - .. code-block:: none

                SPI clock phase that indicates on which edge data is sampled.
                If it is used, data is sampled on the second edge; otherwise, on the first edge.



         * - ``mipi-hold-cs``
           - ``boolean``
           - .. code-block:: none

                In some cases, it is necessary for the master to manage SPI chip select
                under software control, so that multiple spi transactions can be performed
                without releasing it. A typical use case is variable length SPI packets
                where the first spi transaction reads the length and the second spi transaction
                reads length bytes.



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

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

                BUSY pin.
                The BUSY pin of UC81xx is active low. If connected directly the MCU pin should be configured as active low.


             This property is **required**.

         * - ``softstart``
           - ``uint8-array``
           - .. code-block:: none

                Booster Soft Start (BTST) values




   .. 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 "ultrachip,uc8175" 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().






Child node properties
=====================

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

   * - Name
     - Type
     - Details

   * - ``pwr``
     - ``uint8-array``
     - .. code-block:: none

          Power Setting (PWR) values


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

          VCOM and data interval value. This value is optional but must
          be provided to enable border refresh control.



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

          TCON setting value


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

          PLL / frame rate control


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

          VCOM DC settings


   * - ``lutc``
     - ``uint8-array``
     - .. code-block:: none

          VCOM LUT


   * - ``lutww``
     - ``uint8-array``
     - .. code-block:: none

          White-to-white LUT


   * - ``lutkw``
     - ``uint8-array``
     - .. code-block:: none

          Black-to-white LUT


   * - ``lutwk``
     - ``uint8-array``
     - .. code-block:: none

          White-to-black LUT


   * - ``lutkk``
     - ``uint8-array``
     - .. code-block:: none

          White-to-black LUT


   * - ``lutbd``
     - ``uint8-array``
     - .. code-block:: none

          Border LUT