: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:: worldsemi,ws2812-i2s
.. _dtbinding_worldsemi_ws2812_i2s:

worldsemi,ws2812-i2s
####################

Vendor: :ref:`Worldsemi Co., Limited <dt_vendor_worldsemi>`

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



.. code-block:: none

   Worldsemi WS2812 LED strip, I2S binding

   Driver bindings for controlling a WS2812 or compatible LED
   strip with an I2S master.

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

         * - ``i2s-dev``
           - ``phandle``
           - .. code-block:: none

                Pointer to the I2S instance.


             This property is **required**.

         * - ``out-active-low``
           - ``boolean``
           - .. code-block:: none

                True if the output pin is active low.


         * - ``nibble-one``
           - ``int``
           - .. code-block:: none

                4-bit value to shift out for a 1 pulse.


             Default value: ``14``

         * - ``nibble-zero``
           - ``int``
           - .. code-block:: none

                4-bit value to shift out for a 0 pulse.


             Default value: ``8``

         * - ``lrck-period``
           - ``int``
           - .. code-block:: none

                LRCK (left/right clock) period in microseconds.


             Default value: ``10``

         * - ``extra-wait-time``
           - ``int``
           - .. code-block:: none

                Extra microseconds to wait for the driver to flush its I2S queue.


             Default value: ``300``

         * - ``chain-length``
           - ``int``
           - .. code-block:: none

                The number of devices in the daisy-chain.



             This property is **required**.

         * - ``color-mapping``
           - ``array``
           - .. code-block:: none

                Channel to color mapping (or pixel order).

                For example a GRB channel to color mapping would be

                   color-mapping = <LED_COLOR_ID_GREEN
                                    LED_COLOR_ID_RED
                                    LED_COLOR_ID_BLUE>;



             This property is **required**.

         * - ``reset-delay``
           - ``int``
           - .. code-block:: none

                Minimum delay to wait (in microseconds) to make sure that the strip has
                latched the signal. If omitted, a default value of 8 microseconds is used.
                This default is good for the WS2812 controllers. Note that despite the
                WS2812 datasheet states that a 50 microseconds delay is required, it seems
                6 microseconds is enough. The default is set to 8 microseconds just to be
                safe.



             Default value: ``8``



   .. 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 "worldsemi,ws2812-i2s" compatible.

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

         * - Name
           - Type
           - Details

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


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