: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-bflb-wo
.. _dtbinding_worldsemi_ws2812_bflb_wo:

worldsemi,ws2812-bflb-wo
########################

.. sidebar:: Overview

   :Name: ``worldsemi,ws2812-bflb-wo``
   :Vendor: :ref:`Worldsemi Co., Limited <dt_vendor_worldsemi>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=worldsemi,ws2812-bflb-wo>` using
               this compatible
   :Driver: :zephyr_file:`drivers/led_strip/ws2812_bflb_wo.c`

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



.. code-block:: none

   WS2812 and similar on BFLB GPIO FIFO / WO

   Use the Bouffalolab GPIO FIFO / Wire Out to drive addressable RGB leds by producing
   specifications-accurate pulse widths bits.

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

         * - ``time-t0h``
           - ``int``
           - .. code-block:: none

                How long the output signal has to stay high to signify a 0 bit.
                The default is the time for WS2812B (0.4us +/- 150ns).



             Default value: ``400``

         * - ``time-t1h``
           - ``int``
           - .. code-block:: none

                How long the output signal has to stay high to signify a 1 bit.
                The default is the time for WS2812B (0.8us +/- 150ns).



             Default value: ``800``

         * - ``time-total``
           - ``int``
           - .. code-block:: none

                How long a bit, a pulse containing a high and a low part, should be.
                The default is the time for WS2812B (1.25us +/- 600ns).



             Default value: ``1250``

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

                Frequency at which the bits are sent. This or time-total must be defined.



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

                GPIO phandle and specifier for the pin connected to the
                led-strip. Exactly one pin should be given.



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

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



   .. 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-bflb-wo" compatible.

      (None)