Commit b2c87f5e authored by Rob Herring (Arm)'s avatar Rob Herring (Arm) Committed by Lee Jones
Browse files

dt-bindings: leds: Convert ti,lm3697 to DT schema



Convert the TI LM3697 LED driver binding to DT schema format. It's a
straight-forward conversion.

Signed-off-by: default avatarRob Herring (Arm) <robh@kernel.org>
Link: https://patch.msgid.link/20260121235746.370607-1-robh@kernel.org


Signed-off-by: default avatarLee Jones <lee@kernel.org>
parent c7dd343a
Loading
Loading
Loading
Loading
+0 −73
Original line number Diff line number Diff line
* Texas Instruments - LM3697 Highly Efficient White LED Driver

The LM3697 11-bit LED driver provides high-
performance backlight dimming for 1, 2, or 3 series
LED strings while delivering up to 90% efficiency.

This device is suitable for display and keypad lighting

Required properties:
	- compatible:
		"ti,lm3697"
	- reg :  I2C slave address
	- #address-cells : 1
	- #size-cells : 0

Optional properties:
	- enable-gpios : GPIO pin to enable/disable the device
	- vled-supply : LED supply

Required child properties:
	- reg : 0 - LED is Controlled by bank A
		1 - LED is Controlled by bank B
	- led-sources : Indicates which HVLED string is associated to which
			control bank.  This is a zero based property so
			HVLED1 = 0, HVLED2 = 1, HVLED3 = 2.
			Additional information is contained
			in Documentation/devicetree/bindings/leds/common.txt

Optional child properties:
	- ti,brightness-resolution - see Documentation/devicetree/bindings/mfd/ti-lmu.txt
	- ramp-up-us: see Documentation/devicetree/bindings/mfd/ti-lmu.txt
	- ramp-down-us: see Documentation/devicetree/bindings/mfd/ti-lmu.txt
	- label : see Documentation/devicetree/bindings/leds/common.txt
	- linux,default-trigger :
	   see Documentation/devicetree/bindings/leds/common.txt

Example:

HVLED string 1 and 3 are controlled by control bank A and HVLED 2 string is
controlled by control bank B.

led-controller@36 {
	compatible = "ti,lm3697";
	#address-cells = <1>;
	#size-cells = <0>;
	reg = <0x36>;

	enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
	vled-supply = <&vbatt>;

	led@0 {
		reg = <0>;
		led-sources = <0 2>;
		ti,brightness-resolution = <2047>;
		ramp-up-us = <5000>;
		ramp-down-us = <1000>;
		label = "white:first_backlight_cluster";
		linux,default-trigger = "backlight";
	};

	led@1 {
		reg = <1>;
		led-sources = <1>;
		ti,brightness-resolution = <255>;
		ramp-up-us = <500>;
		ramp-down-us = <1000>;
		label = "white:second_backlight_cluster";
		linux,default-trigger = "backlight";
	};
}

For more product information please see the link below:
https://www.ti.com/lit/ds/symlink/lm3697.pdf
+125 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/leds/ti,lm3697.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: TI LM3697 Highly Efficient White LED Driver

maintainers:
  - Dan Murphy <dmurphy@ti.com>

description: >
  The LM3697 11-bit LED driver provides high-performance backlight dimming for
  1, 2, or 3 series LED strings while delivering up to 90% efficiency.

  This device is suitable for display and keypad lighting.

properties:
  compatible:
    const: ti,lm3697

  reg:
    maxItems: 1

  '#address-cells':
    const: 1

  '#size-cells':
    const: 0

  enable-gpios:
    description: GPIO pin to enable or disable the device.
    maxItems: 1

  vled-supply:
    description: LED supply for the device.

patternProperties:
  '^led@[01]$':
    description: LED control bank nodes.
    $ref: common.yaml#
    unevaluatedProperties: false

    properties:
      reg:
        description: Control bank selection (0 = bank A, 1 = bank B).
        maximum: 1

      led-sources:
        description: >
          HVLED strings associated with this control bank:

            0 - HVLED1
            1 - HVLED2
            2 - HVLED3
        minItems: 1
        maxItems: 3
        items:
          maximum: 2

      ti,brightness-resolution:
        description: Brightness resolution for the LED string.
        $ref: /schemas/types.yaml#/definitions/uint32
        maximum: 2047

      ramp-up-us:
        description: Ramp-up time in microseconds.
        minimum: 117
        maximum: 2048

      ramp-down-us:
        description: Ramp-down time in microseconds.
        minimum: 117
        maximum: 2048

    required:
      - reg
      - led-sources

required:
  - compatible
  - reg
  - '#address-cells'
  - '#size-cells'

additionalProperties: false

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

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

        led-controller@36 {
            compatible = "ti,lm3697";
            #address-cells = <1>;
            #size-cells = <0>;
            reg = <0x36>;

            enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
            vled-supply = <&vbatt>;

            led@0 {
                reg = <0>;
                led-sources = <0 2>;
                ti,brightness-resolution = <2047>;
                ramp-up-us = <500>;
                ramp-down-us = <1000>;
                label = "white:first_backlight_cluster";
                linux,default-trigger = "backlight";
            };

            led@1 {
                reg = <1>;
                led-sources = <1>;
                ti,brightness-resolution = <255>;
                ramp-up-us = <500>;
                ramp-down-us = <1000>;
                label = "white:second_backlight_cluster";
                linux,default-trigger = "backlight";
            };
        };
    };