:orphan: .. raw:: html .. dtcompatible:: worldsemi,ws2812-spi .. _dtbinding_worldsemi_ws2812_spi: worldsemi,ws2812-spi (on spi bus) ################################# Vendor: :ref:`Worldsemi Co., Limited ` Description *********** .. code-block:: none Worldsemi WS2812 LED strip, SPI binding Driver bindings for controlling a WS2812 or compatible LED strip with a SPI master. The SPI driver should be usable as long as a zephyr SPI API driver is available for your board. Hardware specific tuning is required using these properties: - spi-max-frequency - spi-zero-frame - spi-one-frame. Use of this driver implies an 8x internal memory overhead (1 byte of driver RAM overhead per bit of pixel data). 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 * - ``spi-one-frame`` - ``int`` - .. code-block:: none 8-bit SPI frame to shift out for a 1 pulse. This property is **required**. * - ``spi-zero-frame`` - ``int`` - .. code-block:: none 8-bit SPI frame to shift out for a 0 pulse. This property is **required**. * - ``spi-max-frequency`` - ``int`` - .. code-block:: none Maximum clock frequency of device's SPI interface in Hz This property is **required**. * - ``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. * - ``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 = ; 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-spi" compatible. .. list-table:: :widths: 1 1 4 :header-rows: 1 * - Name - Type - Details * - ``reg`` - ``array`` - .. code-block:: none register space This property is **required**. See :ref:`zephyr:dt-important-props` for more information. * - ``label`` - ``string`` - .. code-block:: none Human readable string describing the device (used as device_get_binding() argument) This property is **required**. See :ref:`zephyr:dt-important-props` for more information. * - ``status`` - ``string`` - .. code-block:: none indicates the operational status of a device Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'`` See :ref:`zephyr:dt-important-props` for more information. * - ``compatible`` - ``string-array`` - .. code-block:: none compatible strings This property is **required**. See :ref:`zephyr: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:`zephyr: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 * - ``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 * - ``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.