LED strip matrix 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:: led-strip-matrix
.. _dtbinding_led_strip_matrix:

led-strip-matrix
################

Vendor: :ref:`Generic or vendor-independent <dt_no_vendor>`

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



.. code-block:: none

   Generic LED strip matrix (LED strip arranged in a grid pattern)

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

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

                Specifies the overall height of the matrix.
                If the matrix consists of multiple modules, it is the sum of their heights.



             This property is **required**.

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

                Specifies the overall width of the matrix.
                If the matrix consists of multiple modules, it is the sum of their widths.



             This property is **required**.

         * - ``circulative``
           - ``boolean``
           - .. code-block:: none

                Use a circulative layout that returns to the left edge of the next row
                after reaching the right edge.
                If not set, turn around and go left in a serpentine layout when it reaches
                the right edge.

                * circulative layout
                  [ 0][ 1][ 2][ 3]
                  [ 4][ 5][ 6][ 7]
                  [ 8][ 9][10][11]
                  [12][13][14][15]

                * serpentine layout
                  [ 0][ 1][ 2][ 3]
                  [ 7][ 6][ 5][ 4]
                  [ 8][ 9][10][11]
                  [15][14][13][12]



         * - ``start-from-right``
           - ``boolean``
           - .. code-block:: none

                Specify if the first LED is at the right.

                * Start from the right with a serpentine layout
                  [ 3][ 2][ 1][ 0]
                  [ 4][ 5][ 6][ 7]
                  [11][10][ 9][ 8]
                  [12][13][14][15]

                * Start from the right with a circulative layout
                  [ 3][ 2][ 1][ 0]
                  [ 7][ 6][ 5][ 4]
                  [11][10][ 9][ 8]
                  [15][14][13][12]



         * - ``start-from-bottom``
           - ``boolean``
           - .. code-block:: none

                Specify if the first LED is at the bottom.

                * Start from the bottom with a circulative layout
                  [12][13][14][15]
                  [ 8][ 9][10][11]
                  [ 4][ 5][ 6][ 7]
                  [ 0][ 1][ 2][ 3]

                * Start from the bottom with a serpentine layout
                  [15][14][13][12]
                  [ 8][ 9][10][11]
                  [ 7][ 6][ 5][ 4]
                  [ 0][ 1][ 2][ 3]



         * - ``horizontal-modules``
           - ``int``
           - .. code-block:: none

                If the display forms with multiple modules,
                specify the horizontal number of modules.
                The number must be able to divide the width value.
                If not set, it controls a single matrix.

                * 8x4 display with 2 serpentine layout modules
                  [ 0][ 1][ 2][ 3]  [16][17][18][19]
                  [ 7][ 6][ 5][ 4]  [23][22][21][20]
                  [ 8][ 9][10][11]  [24][25][26][27]
                  [15][14][13][12]  [31][30][29][28]



             Default value: ``1``

         * - ``vertical-modules``
           - ``int``
           - .. code-block:: none

                If the display forms with multiple modules,
                specify the vertical number of modules.
                The number must be able to divide the height value.
                If not set, it controls a single matrix.

                * 4x8 display with 2 serpentine layout modules
                  [ 0][ 1][ 2][ 3]
                  [ 7][ 6][ 5][ 4]
                  [ 8][ 9][10][11]
                  [15][14][13][12]

                  [16][17][18][19]
                  [23][22][21][20]
                  [24][25][26][27]
                  [31][30][29][28]



             Default value: ``1``

         * - ``modules-circulative``
           - ``boolean``
           - .. code-block:: none

                Specifies that the order of the modules that make up the matrix is circulative.

                * circulative module layout
                  [M0][M1][M2]
                  [M3][M4][M5]
                  [M6][M7][M8]

                * serpentine module layout
                  [M0][M1][M2]
                  [M5][M4][M3]
                  [M6][M7][M8]



         * - ``modules-start-from-right``
           - ``boolean``
           - .. code-block:: none

                Specifies that modules are ordered from right to left.

                * Start from the right with a module serpentine layout
                  [M2][M1][M0]
                  [M3][M4][M5]
                  [M8][M7][M6]

                * Start from the right with a module circulative layout
                  [M2][M1][M0]
                  [M5][M4][M3]
                  [M8][M7][M6]



         * - ``modules-start-from-bottom``
           - ``boolean``
           - .. code-block:: none

                Specifies that modules are ordered from bottom to top.

                * Start from the right with a module serpentine layout
                  [M6][M7][M8]
                  [M5][M4][M3]
                  [M0][M1][M2]

                * Start from the right with a module circulative layout
                  [M6][M7][M8]
                  [M3][M4][M5]
                  [M0][M1][M2]



         * - ``led-strips``
           - ``phandles``
           - .. code-block:: none

                Specify the LED strip that is the substance of the matrix.
                If multiple strips are specified, they are "flattened" and sequentialized.
                For example, if `strip0` and `strip1` with 128 LEDs are specified,
                the first LED of `strip1` will be treated as the 129th LED.
                These LEDs are mapped to coordinates according to the layout rule in order.
                The amount of LEDs must equal the [width * height] value.



             This property is **required**.

         * - ``chain-lengths``
           - ``array``
           - .. code-block:: none

                Specify the number of LEDs for each strip.
                It can omit the value if all strip nodes have a `chain-length` property.
                Each value must be a multiple of the number of LEDs per module
                [(width / horizontal-modules) * (height / vertical-modules)].



         * - ``pixel-format``
           - ``int``
           - .. code-block:: none

                Initial Pixel format.
                See dt-bindings/display/panel.h for a list.
                This property only accepts PANEL_PIXEL_FORMAT_RGB_888 and PANEL_PIXEL_FORMAT_RRGB_8888.
                If this property is not set, use PANEL_PIXEL_FORMAT_RGB_888 as a default.



             Default value: ``1``



   .. 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 "led-strip-matrix" 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().