issi,is31fl3194 (on i2c bus)

Vendor: Integrated Silicon Solutions Inc.

Note

An implementation of a driver matching this compatible is available in drivers/led/is31fl3194.c.

Description

IS31FL3194 3-channel LED driver with programmable pattern sequencing

This driver supports single-channel and RGB LEDs. For single channel LEDs,
the led_set_brightness() API can be used to set the brightness of each LED.
For RGB LEDs, the led_set_color() API can be used to set the red, green and
blue components; the driver takes care of routing to the outputs described
by the color-mapping property.

The LED_SHELL application can be used for testing.

The following defines a single RGB LED in the is31fl3194 DT node:

  is31fl3194@53 {
    compatible = "issi,is31fl3194";
    reg = <0x53>;

    led_0 {
      label = "RGB LED";
      color-mapping =
        <LED_COLOR_ID_RED>,
        <LED_COLOR_ID_GREEN>,
        <LED_COLOR_ID_BLUE>;
    };
  };

The following example defines three single-channel LEDs in the is31fl3194 DT node:

  is31fl3194@53 {
    compatible = "issi,is31fl3194";
    reg = <0x53>;

    led_0 {
      label = "RED LED";
      color-mapping = <LED_COLOR_ID_RED>;
    };

    led_1 {
      label = "GREEN LED";
      color-mapping = <LED_COLOR_ID_GREEN>;
    };

    led_2 {
      label = "BLUE LED";
      color-mapping = <LED_COLOR_ID_BLUE>;
    };
  };

Properties

Top level properties

These property descriptions apply to “issi,is31fl3194” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

Name

Type

Details

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.

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 “issi,is31fl3194” compatible.

Name	Type	Details
`reg`	`array`	device address on i2c bus This property is required. See Important properties for more information.
`status`	`string`	indicates the operational status of a device Legal values: `'ok'`, `'okay'`, `'disabled'`, `'reserved'`, `'fail'`, `'fail-sss'` See Important properties for more information.
`compatible`	`string-array`	compatible strings This property is required. See Important properties for more information.
`reg-names`	`string-array`	name of each register space
`interrupts`	`array`	interrupts for device See Important properties for more information.
`interrupts-extended`	`compound`	extended interrupt specifier for device
`interrupt-names`	`string-array`	name of each interrupt
`interrupt-parent`	`phandle`	phandle to interrupt controller node
`label`	`string`	No description provided for this label See Important properties for more information.
`clocks`	`phandle-array`	Clock gate information
`clock-names`	`string-array`	name of each clock
`#address-cells`	`int`	number of address cells in reg property
`#size-cells`	`int`	number of size cells in reg property
`dmas`	`phandle-array`	DMA channels specifiers
`dma-names`	`string-array`	Provided names of DMA channel specifiers
`io-channels`	`phandle-array`	IO channels specifiers
`io-channel-names`	`string-array`	Provided names of IO channel specifiers
`mboxes`	`phandle-array`	mailbox / IPM channels specifiers
`mbox-names`	`string-array`	Provided names of mailbox / IPM channel specifiers
`power-domains`	`phandle-array`	Power domain specifiers
`power-domain-names`	`string-array`	Provided names of power domain specifiers
`#power-domain-cells`	`int`	Number of cells in power-domains property
`zephyr,deferred-init`	`boolean`	Do not initialize device automatically on boot. Device should be manually initialized using device_init().
`wakeup-source`	`boolean`	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.
`zephyr,pm-device-runtime-auto`	`boolean`	Automatically configure the device for runtime power management after the init function runs.
`zephyr,disabling-power-states`	`phandles`	List of power states that will disable this device power.

Child node properties

Name	Type	Details
`label`	`string`	Human readable string describing the LED This property is required. See Important properties for more information.
`color-mapping`	`array`	Channel to color mapping of a multicolor LED. If a LED supports several colors, then the color-mapping property can be used to describe how the hardware channels and the colors are mapped. For example the channel to color mapping of RGB LEDs would be color-mapping = <LED_COLOR_ID_RED>, <LED_COLOR_ID_GREEN>, <LED_COLOR_ID_BLUE>; This property is required.
`current-limit`	`int`	The current limit for the LED in mA. This property is required. Legal values: `10`, `20`, `30`, `40`
`index`	`int`	Index of the LED on a controller. It can be used by drivers or applications to map a logical LED to its real position on the controller. For example, this allows to handle boards where the LEDs in an array/strip are not wired following the LED order of the controller.