xref: /freebsd/sys/contrib/device-tree/Bindings/leds/ti,lp8860.yaml (revision 2846c90520eb4cc74e24d586a0ea0f4a0006bc73)

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/leds/ti,lp8860.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Texas Instruments - lp8860 4-Channel LED Driver

maintainers:
  - Andrew Davis <afd@ti.com>

description: |
  The LP8860-Q1 is an high-efficiency LED driver with boost controller.
  It has 4 high-precision current sinks that can be controlled by a PWM input
  signal, a SPI/I2C master, or both.

  For more product information please see the link below:
    https://www.ti.com/product/lp8860-q1

properties:
  compatible:
    const: ti,lp8860

  reg:
    maxItems: 1
    description: I2C slave address

  "#address-cells":
    const: 1

  "#size-cells":
    const: 0

  enable-gpios:
    maxItems: 1
    description: GPIO pin to enable (active high) / disable the device

  vled-supply:
    description: LED supply

patternProperties:
  "^led(@[0-3])?$":
    type: object
    $ref: common.yaml#
    unevaluatedProperties: false

    properties:
      reg:
        description:
          Index of the LED.
        maxItems: 1

      function: true
      color: true
      label: true
      linux,default-trigger: true

required:
  - compatible
  - reg

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>
    #include <dt-bindings/leds/common.h>

    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        led-controller@2d {
            compatible = "ti,lp8860";
            #address-cells = <1>;
            #size-cells = <0>;
            reg = <0x2d>;
            enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
            vled-supply = <&vbatt>;

            led@0 {
                reg = <0>;
                function = LED_FUNCTION_BACKLIGHT;
                color = <LED_COLOR_ID_WHITE>;
                linux,default-trigger = "backlight";
            };
        };
    };

...