worldsemi,ws2812-spi (on spi bus)

Vendor: Unknown vendor

Description

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

Properties not inherited from the base binding file.

Name

Type

Details

spi-one-frame

int

 
8-bit SPI frame to shift out for a 1 pulse.

This property is required.

spi-zero-frame

int

 
8-bit SPI frame to shift out for a 0 pulse.

This property is required.

spi-max-frequency

int

 
Maximum clock frequency of device's SPI interface in Hz

This property is required.

supply-gpios

phandle-array

 
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

 
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

 
The number of devices in the daisy-chain.

This property is required.

has-white-channel

boolean

 
If true, the device has a white channel. This is not supported
by the led_strip.h API, so the white data on the wire will be
zero if set.