worldsemi,ws2812-i2s (on i2s bus)

Vendor: Worldsemi Co., Limited

Note

An implementation of a driver matching this compatible is available in drivers/led_strip/ws2812_i2s.c.

Description

Worldsemi WS2812 LED strip, I2S binding

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

Properties

Properties not inherited from the base binding file.

Name

Type

Details

out-active-low

boolean

 
True if the output pin is active low.

nibble-one

int

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

Default value: 14

nibble-zero

int

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

Default value: 8

lrck-period

int

 
LRCK (left/right clock) period in microseconds.

Default value: 10

extra-wait-time

int

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

Default value: 300

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.

reset-delay

int

 
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

 
The number of devices in the daisy-chain.

This property is required.

color-mapping

array

 
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.