[PATCH v9 1/4] dt-bindings: leds: add TI/National Semiconductor LP5812 LED Driver

Nam Tran posted 4 patches 4 months ago
There is a newer version of this series
[PATCH v9 1/4] dt-bindings: leds: add TI/National Semiconductor LP5812 LED Driver
Posted by Nam Tran 4 months ago
The LP5812 is a 4×3 RGB LED driver with an autonomous animation
engine and time-cross-multiplexing (TCM) support for up to 12 LEDs
or 4 RGB LEDs. It supports both analog (256 levels) and PWM (8-bit)
dimming, including exponential PWM for smooth brightness control.

Signed-off-by: Nam Tran <trannamatk@gmail.com>
---
 .../devicetree/bindings/leds/ti,lp5812.yaml   | 264 ++++++++++++++++++
 MAINTAINERS                                   |   6 +
 2 files changed, 270 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/ti,lp5812.yaml

diff --git a/Documentation/devicetree/bindings/leds/ti,lp5812.yaml b/Documentation/devicetree/bindings/leds/ti,lp5812.yaml
new file mode 100644
index 000000000000..bbb4e293dac3
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/ti,lp5812.yaml
@@ -0,0 +1,264 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/ti,lp5812.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI LP5812 4×3 Matrix RGB LED Driver with Autonomous Control
+
+maintainers:
+  - Nam Tran <trannamatk@gmail.com>
+
+description: |
+  The LP5812 is a 4×3 matrix RGB LED driver with I2C interface
+  and autonomous animation engine control.
+  For more product information please see the link below:
+  https://www.ti.com/product/LP5812#tech-docs
+
+properties:
+  compatible:
+    const: ti,lp5812
+
+  reg:
+    maxItems: 1
+
+  vcc-supply:
+    description: Regulator providing power to the 'VCC' pin.
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 0
+
+patternProperties:
+  "^led@[0-3]$":
+    type: object
+    $ref: common.yaml#
+    unevaluatedProperties: false
+
+    properties:
+      led-cur:
+        $ref: /schemas/types.yaml#/definitions/uint8
+        description: |
+          LED current in 0.1 mA steps (e.g., 150 = 15.0 mA; 0 if not connected)
+        minimum: 0
+        maximum: 255
+
+      max-cur:
+        $ref: /schemas/types.yaml#/definitions/uint8
+        description: Maximum allowed current in 0.1 mA steps
+
+      reg:
+        minimum: 0
+        maximum: 3
+
+  '^multi-led@[4-7]$':
+    type: object
+    $ref: leds-class-multicolor.yaml#
+    unevaluatedProperties: false
+
+    properties:
+      reg:
+        minimum: 4
+        maximum: 7
+
+      '#address-cells':
+        const: 1
+
+      '#size-cells':
+        const: 0
+
+    patternProperties:
+      "^led@[4-9a-f]$":
+        type: object
+        $ref: common.yaml#
+        unevaluatedProperties: false
+
+        properties:
+          led-cur:
+            $ref: /schemas/types.yaml#/definitions/uint8
+            description: |
+              LED current in 0.1 mA steps (e.g., 150 = 15.0 mA; 0 if not connected)
+            minimum: 0
+            maximum: 255
+
+          max-cur:
+            $ref: /schemas/types.yaml#/definitions/uint8
+            description: Maximum allowed current in 0.1 mA steps
+
+          reg:
+            minimum: 4
+            maximum: 15
+
+        required:
+          - reg
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        led-controller@1b {
+            #address-cells = <1>;
+            #size-cells = <0>;
+            compatible = "ti,lp5812";
+            reg = <0x1b>;
+            vcc-supply = <&vdd_3v3_reg>;
+
+            led@0 {
+              reg = <0x0>;
+              label = "LED0";
+              led-cur = /bits/ 8 <0x96>;
+              max-cur = /bits/ 8 <0xff>;
+            };
+
+            led@1 {
+              reg = <0x1>;
+              label = "LED1";
+              led-cur = /bits/ 8 <0x96>;
+              max-cur = /bits/ 8 <0xff>;
+            };
+
+            led@2 {
+              reg = <0x2>;
+              label = "LED2";
+              led-cur = /bits/ 8 <0x96>;
+              max-cur = /bits/ 8 <0xff>;
+            };
+
+            led@3 {
+              reg = <0x3>;
+              label = "LED3";
+              led-cur = /bits/ 8 <0x96>;
+              max-cur = /bits/ 8 <0xff>;
+            };
+
+            multi-led@4 {
+              #address-cells = <1>;
+              #size-cells = <0>;
+              reg = <0x4>;
+              color = <LED_COLOR_ID_RGB>;
+              label = "LED_A";
+
+              led@4 {
+                reg = <0x4>;
+                color = <LED_COLOR_ID_GREEN>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@5 {
+                reg = <0x5>;
+                color = <LED_COLOR_ID_RED>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@6 {
+                reg = <0x6>;
+                color = <LED_COLOR_ID_BLUE>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+            };
+
+            multi-led@5 {
+              #address-cells = <1>;
+              #size-cells = <0>;
+              reg = <0x5>;
+              color = <LED_COLOR_ID_RGB>;
+              label = "LED_B";
+
+              led@7 {
+                reg = <0x7>;
+                color = <LED_COLOR_ID_GREEN>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@8 {
+                reg = <0x8>;
+                color = <LED_COLOR_ID_RED>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@9 {
+                reg = <0x9>;
+                color = <LED_COLOR_ID_BLUE>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+            };
+
+            multi-led@6 {
+              #address-cells = <1>;
+              #size-cells = <0>;
+              reg = <0x6>;
+              color = <LED_COLOR_ID_RGB>;
+              label = "LED_C";
+
+              led@a {
+                reg = <0xa>;
+                color = <LED_COLOR_ID_GREEN>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@b {
+                reg = <0xb>;
+                color = <LED_COLOR_ID_RED>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@c {
+                reg = <0xc>;
+                color = <LED_COLOR_ID_BLUE>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+            };
+
+            multi-led@7 {
+              #address-cells = <1>;
+              #size-cells = <0>;
+              reg = <0x7>;
+              color = <LED_COLOR_ID_RGB>;
+              label = "LED_D";
+
+              led@d {
+                reg = <0xd>;
+                color = <LED_COLOR_ID_GREEN>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@e {
+                reg = <0xe>;
+                color = <LED_COLOR_ID_RED>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+
+              led@f {
+                reg = <0xf>;
+                color = <LED_COLOR_ID_BLUE>;
+                led-cur = /bits/ 8 <0x96>;
+                max-cur = /bits/ 8 <0xff>;
+              };
+            };
+        };
+    };
+
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index a92290fffa16..83a779dc9bcd 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -24561,6 +24561,12 @@ S:	Supported
 F:	Documentation/devicetree/bindings/iio/dac/ti,dac7612.yaml
 F:	drivers/iio/dac/ti-dac7612.c
 
+TEXAS INSTRUMENTS' LP5812 RGB LED DRIVER
+M:	Nam Tran <trannamatk@gmail.com>
+L:	linux-leds@vger.kernel.org
+S:	Maintained
+F:	Documentation/devicetree/bindings/leds/ti,lp5812.yaml
+
 TEXAS INSTRUMENTS' LB8864 LED BACKLIGHT DRIVER
 M:	Alexander Sverdlin <alexander.sverdlin@siemens.com>
 L:	linux-leds@vger.kernel.org
-- 
2.25.1

Re: [PATCH v9 1/4] dt-bindings: leds: add TI/National Semiconductor LP5812 LED Driver
Posted by Krzysztof Kozlowski 4 months ago
On Wed, Jun 11, 2025 at 12:43:15AM GMT, Nam Tran wrote:
> +patternProperties:
> +  "^led@[0-3]$":
> +    type: object
> +    $ref: common.yaml#
> +    unevaluatedProperties: false
> +
> +    properties:
> +      led-cur:
> +        $ref: /schemas/types.yaml#/definitions/uint8
> +        description: |
> +          LED current in 0.1 mA steps (e.g., 150 = 15.0 mA; 0 if not connected)
> +        minimum: 0
> +        maximum: 255
> +
> +      max-cur:
> +        $ref: /schemas/types.yaml#/definitions/uint8
> +        description: Maximum allowed current in 0.1 mA steps
> +
> +      reg:
> +        minimum: 0
> +        maximum: 3

Place properties according to DTS coding style.

> +
> +  '^multi-led@[4-7]$':
> +    type: object
> +    $ref: leds-class-multicolor.yaml#
> +    unevaluatedProperties: false
> +
> +    properties:
> +      reg:
> +        minimum: 4
> +        maximum: 7
> +
> +      '#address-cells':

Don't mix quotes. Either ' or "

> +        const: 1
> +
> +      '#size-cells':
> +        const: 0
> +
> +    patternProperties:
> +      "^led@[4-9a-f]$":
> +        type: object
> +        $ref: common.yaml#
> +        unevaluatedProperties: false
> +
> +        properties:
> +          led-cur:
> +            $ref: /schemas/types.yaml#/definitions/uint8

No, use existing led common properties. Also observe the units - this is
not uint8 but a defined type for microamp, see property-units in
dtschema.

> +            description: |
> +              LED current in 0.1 mA steps (e.g., 150 = 15.0 mA; 0 if not connected)
> +            minimum: 0
> +            maximum: 255
> +
> +          max-cur:
> +            $ref: /schemas/types.yaml#/definitions/uint8

No, use existing led common properties. Same everywhere.

> +            description: Maximum allowed current in 0.1 mA steps
> +
> +          reg:
> +            minimum: 4
> +            maximum: 15
> +
> +        required:
> +          - reg
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/leds/common.h>
> +
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        led-controller@1b {
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +            compatible = "ti,lp5812";
> +            reg = <0x1b>;
> +            vcc-supply = <&vdd_3v3_reg>;
> +
> +            led@0 {
> +              reg = <0x0>;


Messed/mixed indentation.

BTW, such significant binding change at v9, invalidting reviews and
rewriting the binding completely, is surprising.

Best regards,
Krzysztof
Re: [PATCH v9 1/4] dt-bindings: leds: add TI/National Semiconductor LP5812 LED Driver
Posted by Nam Tran 3 months, 3 weeks ago
On Wed, 11 Jun 2025, Krzysztof Kozlowski wrote:

> > +patternProperties:
> > +  "^led@[0-3]$":
> > +    type: object
> > +    $ref: common.yaml#
> > +    unevaluatedProperties: false
> > +
> > +    properties:
> > +      led-cur:
> > +        $ref: /schemas/types.yaml#/definitions/uint8
> > +        description: |
> > +          LED current in 0.1 mA steps (e.g., 150 = 15.0 mA; 0 if not connected)
> > +        minimum: 0
> > +        maximum: 255
> > +
> > +      max-cur:
> > +        $ref: /schemas/types.yaml#/definitions/uint8
> > +        description: Maximum allowed current in 0.1 mA steps
> > +
> > +      reg:
> > +        minimum: 0
> > +        maximum: 3
> 
> Place properties according to DTS coding style.

Got it! I'll update the property order accordingly.

> > +  '^multi-led@[4-7]$':
> > +    type: object
> > +    $ref: leds-class-multicolor.yaml#
> > +    unevaluatedProperties: false
> > +
> > +    properties:
> > +      reg:
> > +        minimum: 4
> > +        maximum: 7
> > +
> > +      '#address-cells':
> 
> Don't mix quotes. Either ' or "

I'll use consistent ".

> > +        const: 1
> > +
> > +      '#size-cells':
> > +        const: 0
> > +
> > +    patternProperties:
> > +      "^led@[4-9a-f]$":
> > +        type: object
> > +        $ref: common.yaml#
> > +        unevaluatedProperties: false
> > +
> > +        properties:
> > +          led-cur:
> > +            $ref: /schemas/types.yaml#/definitions/uint8
> 
> No, use existing led common properties. Also observe the units - this is
> not uint8 but a defined type for microamp, see property-units in
> dtschema.
> 
> > +            description: |
> > +              LED current in 0.1 mA steps (e.g., 150 = 15.0 mA; 0 if not connected)
> > +            minimum: 0
> > +            maximum: 255
> > +
> > +          max-cur:
> > +            $ref: /schemas/types.yaml#/definitions/uint8
> 
> No, use existing led common properties. Same everywhere.

I'll replace max-cur with the standard led-max-microamp.
I'll remove led-cur as there's no equivalent LED common property to represent it.
The LED current can be configured runtime via the led_current sysfs.

> > +examples:
> > +  - |
> > +    #include <dt-bindings/leds/common.h>
> > +
> > +    i2c {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        led-controller@1b {
> > +            #address-cells = <1>;
> > +            #size-cells = <0>;
> > +            compatible = "ti,lp5812";
> > +            reg = <0x1b>;
> > +            vcc-supply = <&vdd_3v3_reg>;
> > +
> > +            led@0 {
> > +              reg = <0x0>;
> 
> 
> Messed/mixed indentation.

I'll fix it.

> BTW, such significant binding change at v9, invalidting reviews and
> rewriting the binding completely, is surprising.

Understood. I restructured the binding in v9 to align with leds-class-multicolor.yaml
and better represent the LP5812 hierarchy.
I'll make sure to highlight such major changes more clearly in future revisions.

Appreciate your time and feedback.

Best regards,
Nam Tran