onnn,ncp5623 (on i2c bus)

Vendor: ON Semiconductor Corp.

Note

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

Description

NCP5623 Triple Output I2C Controlled RGB LED driver

The LED_SHELL application can be used for testing

The following example defines a single RGB LED in the ncp5623 DT node

ncp5623c@39 {
  compatible = "onnn,ncp5623";
  reg = <0x39>;

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

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

ncp5623c@39 {
  compatible = "onnn,ncp5623";
  reg = <0x39>;

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

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

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

Properties

Top level properties

These property descriptions apply to “onnn,ncp5623” 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.

Child node properties

Name

Type

Details

label

string

Human readable string describing the LED

This property is required.

See Important properties for more information.

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.

This property is required.

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.