Multicolor FW v8 update

Add a documentation of LED Multicolor LED class specific sysfs attributes.

Signed-off-by Dan Murphy <[email protected]>

---
 .../ABI/testing/sysfs-class-led-multicolor    | 43 +++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor

Documentation/ABI/testing/sysfs-class-led-multicolor new file +0 -0

new file mode 100644
index 000000000000..39fc73becfec

Dan,

Quoted 15 lines · Dan Murphy

Add a documentation of LED Multicolor LED class specific sysfs attributes.

Signed-off-by Dan Murphy <[email protected]>

---
  .../ABI/testing/sysfs-class-led-multicolor    | 43 +++++++++++++++++++
  1 file changed, 43 insertions(+)

create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor

Documentation/ABI/testing/sysfs-class-led-multicolor new file +0 -0

new file mode 100644
index 000000000000..39fc73becfec

Documentation/ABI/testing/sysfs-class-led-multicolor line 10

Quoted 10 lines

Documentation/ABI/testing/sysfs-class-led-multicolor new file +10 -0

@@ -0,0 +1,43 @@
+What:		/sys/class/leds/<led>/brightness
+Date:		Sept 2019
+KernelVersion:	5.5
+Contact:	Dan Murphy <[email protected]>
+Description:	read/write
+		Writing to this file will update all LEDs within the group to a
+		calculated percentage of what each color LED intensity is set
+		to. The percentage is calculated via the equation below:
+
+		led_brightness = requested_value * led_color_intensity/led_color_max_intensity

How about:

led_brightness = brightness * <color>_intensity/<color>_max_intensity

Documentation/ABI/testing/sysfs-class-led-multicolor line 18

Quoted 8 lines

Documentation/ABI/testing/sysfs-class-led-multicolor new file +8 -0

+
+		For additional details please refer to
+		Documentation/leds/leds-class-multicolor.rst.
+
+		The value of the color is from 0 to
+		/sys/class/leds/<led>/max_brightness.
+
+What:		/sys/class/leds/<led>/colors/<led_color>_intensity

s/led_color/color/

Documentation/ABI/testing/sysfs-class-led-multicolor line 29

Quoted 11 lines

Documentation/ABI/testing/sysfs-class-led-multicolor new file +11 -0

+Date:		Sept 2019
+KernelVersion:	5.5
+Contact:	Dan Murphy <[email protected]>
+Description:	read/write
+		The led_color directory is dynamically created based on the
+		colors defined by the registrar of the class.
+		The value for the led_color is defined in the
+		include/dt-bindings/leds/common.h. There is one directory per
+		color presented.  The intensity file is created under each
+		led_color directory and controls the individual LED color
+		setting.

We no longer have led_color directories so this description needs to be adjusted.

And I'd not mention where the colors are defined. This is documentation for the user, who does not need to know about implementation details.

Quoted 5 lines

Documentation/ABI/testing/sysfs-class-led-multicolor new file +5 -0

+
+		The value of the color is from 0 to
+		/sys/class/leds/<led>/colors/<led_color>_max_intensity.
+
+What:		/sys/class/leds/<led>/colors/<led_color>_max_intensity

Documentation/ABI/testing/sysfs-class-led-multicolor line 40

Quoted 6 lines

Documentation/ABI/testing/sysfs-class-led-multicolor new file +6 -0

+Date:		Sept 2019
+KernelVersion:	5.5
+Contact:	Dan Murphy <[email protected]>
+Description:	read only
+		Maximum intensity level for the LED color, default is
+		255 (LED_FULL).

Mentioning the default value here is pointless IMO. Userspace cannot change it anyway.

Documentation/ABI/testing/sysfs-class-led-multicolor line 43

Quoted 4 lines

Documentation/ABI/testing/sysfs-class-led-multicolor new file +3 -0

+
+		If the LED does not support different intensity levels, this
+		should be 1.

This is less relevant for MC class, and also it is rather obvious. I'd skip this sentence.

Add the support documentation on the multicolor LED framework. This document defines the directores and file generated by the

multicolor framework. It also documents usage.

Signed-off-by Dan Murphy <[email protected]>

---
 Documentation/leds/index.rst                 |  1 +
 Documentation/leds/leds-class-multicolor.rst | 91 ++++++++++++++++++++
 2 files changed, 92 insertions(+)
 create mode 100644 Documentation/leds/leds-class-multicolor.rst

Documentation/leds/index.rst +1 -0

index 060f4e485897..bc70c6aa7138 100644
@@ -9,6 +9,7 @@ LEDs
 
    leds-class
    leds-class-flash
+   leds-class-multicolor
    ledtrig-oneshot
    ledtrig-transient
    ledtrig-usbport

Documentation/leds/leds-class-multicolor.rst new file +0 -0

new file mode 100644
index 000000000000..063c9a411a1d

Color LEDs that are grouped
+can be presented under a single LED node with individual color control.

+The multicolor class groups these LEDs and allows dynamically setting the value

Documentation/leds/leds-class-multicolor.rst new file +10 -0

+one of LED_COLOR_ID_* definitions from the header
+include/dt-bindings/leds/common.h.
+
+Directory Layout Example
+========================
+root:/sys/class/leds/rgb:grouped_leds# ls -lR colors/
+-rw-rwxr-- 1 root root 4096 Jul 7 03:10 red_max_intensity
+--w--wx-w- 1 root root 4096 Jul 7 03:10 red_intensity
+-rw-rwxr-- 1 root root 4096 Jul 7 03:10 green_max_intensity
+--w--wx-w- 1 root root 4096 Jul 7 03:10 green_intensity

Documentation/leds/leds-class-multicolor.rst new file +35 -0

+
+Example:
+Three LEDs are present in the group as defined in "Directory Layout Example"
+within this document.
+
+A user first writes the color LED brightness file with the brightness level that
+is necessary to achieve a blueish violet output from the RGB LED group.
+
+echo 138 > /sys/class/leds/rgb:grouped_leds/red_intensity
+echo 43 > /sys/class/leds/rgb:grouped_leds/green_intensity
+echo 226 > /sys/class/leds/rgb:grouped_leds/blue_intensity
+
+red -
+	intensity = 138
+	max_intensity = 255
+green -
+	intensity = 43
+	max_intensity = 255
+blue -
+	intensity = 226
+	max_intensity = 255
+
+The user can control the brightness of that RGB group by writing the parent
+'brightness' control.  Assuming a parent max_brightness of 255 the user may want
+to dim the LED color group to half.  The user would write a value of 128 to the
+parent brightness file then the values written to each LED will be adjusted
+base on this value
+
+cat /sys/class/leds/rgb:grouped_leds/max_brightness
+255
+echo 128 > /sys/class/leds/rgb:grouped_leds/brightness
+
+adjusted_red_value = 128 * 138/255 = 69
+adjusted_green_value = 128 * 43/255 = 21
+adjusted_blue_value = 128 * 226/255 = 113

+128

Dan,

Quoted 2 lines · Dan Murphy

Add the support documentation on the multicolor LED framework. This document defines the directores and file generated by the

Now there will be one directory created.

Apart from that - all documentation should go in the same patch as the feature being added. So patches 1,2 and 3 should be melded together.

Quoted 34 lines

multicolor framework. It also documents usage.

Signed-off-by Dan Murphy <[email protected]>

---
  Documentation/leds/index.rst                 |  1 +
  Documentation/leds/leds-class-multicolor.rst | 91 ++++++++++++++++++++
  2 files changed, 92 insertions(+)

create mode 100644 Documentation/leds/leds-class-multicolor.rst

Documentation/leds/index.rst +1 -0

index 060f4e485897..bc70c6aa7138 100644
@@ -9,6 +9,7 @@ LEDs
 
     leds-class
     leds-class-flash
+   leds-class-multicolor
     ledtrig-oneshot
     ledtrig-transient
     ledtrig-usbport

Documentation/leds/leds-class-multicolor.rst new file +6 -0

new file mode 100644
index 000000000000..063c9a411a1d
@@ -0,0 +1,91 @@
+====================================
+Multi Color LED handling under Linux
+====================================
+
+Description
+===========

Documentation/leds/leds-class-multicolor.rst

Quoted 3 lines

Documentation/leds/leds-class-multicolor.rst new file +3 -0

+There are varying monochrome LED colors available for application.  These
+LEDs can be used as a single use case LED or can be mixed with other color
+LEDs to produce the full spectrum of color.

I'd say it won't be the most frequent use case. We can expect rather compound RGB, RGBA[UV] etc. LED elements being connected to iouts of multi color LED controllers like LP50xx. TI mentions RGB LEDs in its application notes for instance. I'd mention that in the first place and leave what you have above as another use case.

Quoted 2 lines

Color LEDs that are grouped
+can be presented under a single LED node with individual color control.

Let's skip "with individual color control". This is rather a means for keeping backward compatibility. Main goal of the MC class is multi color control. We can elaborate on how individual control can be achieved, namely one needs to set brightness to max and then can use the whole 0-<color>_max_intensity intensity scale for given iout. But his can be implied from the information provided below.

Quoted 1 line

+The multicolor class groups these LEDs and allows dynamically setting the value

What does "dynamically" stand for here? I assume you thought of altering colors without changing global brightness, but now it is not the case.

Documentation/leds/leds-class-multicolor.rst line 13

Quoted 2 lines

Documentation/leds/leds-class-multicolor.rst new file +2 -0

+of a single LED or setting the intensity values of the LEDs in the group and
+updating the LEDs virtually simultaneously.

I propose below instead of the above three lines:

The multi color class groups these LEDs and allows controlling two aspects of the final combined color: hue and lightness. The former is controlled via <color>_intensity files and the latter is controlled via brightness file.

For more details on hue and lightness notions please refer to
https://en.wikipedia.org/wiki/CIECAM02.

Note that intensity files only cache the written value and the actual change of hardware state occurs upon writing brightness file. This allows for changing many factors of the perceived color in a virtually unnoticeable way for the human observer.

Documentation/leds/leds-class-multicolor.rst line 23

Quoted 9 lines

Documentation/leds/leds-class-multicolor.rst new file +9 -0

+Multicolor Class Control
+========================
+The multicolor class presents the LED groups under a directory called "colors".
+This directory is a child under the LED parent node created by the led_class
+framework.  The led_class framework is documented in led-class.rst within this
+documentation directory.
+
+Each colored LED will have two files created under the colors directory
+<led_color>_intensity and <led_color>_max_intensity. These files will contain

s/led_color/color/

Quoted 14 lines

Documentation/leds/leds-class-multicolor.rst new file +13 -0

+one of LED_COLOR_ID_* definitions from the header
+include/dt-bindings/leds/common.h.
+
+Directory Layout Example
+========================
+root:/sys/class/leds/rgb:grouped_leds# ls -lR colors/
+-rw-rwxr-- 1 root root 4096 Jul 7 03:10 red_max_intensity
+--w--wx-w- 1 root root 4096 Jul 7 03:10 red_intensity
+-rw-rwxr-- 1 root root 4096 Jul 7 03:10 green_max_intensity
+--w--wx-w- 1 root root 4096 Jul 7 03:10 green_intensity
+-rw-rwxr-- 1 root root 4096 Jul 7 03:10 blue_max_intensity
+--w--wx-w- 1 root root 4096 Jul 7 03:10 blue_intensity
+

Documentation/leds/leds-class-multicolor.rst line 43

Quoted 7 lines

Documentation/leds/leds-class-multicolor.rst new file +7 -0

+Multicolor Class Brightness Control
+===================================
+The multiclor class framework will calculate each monochrome LEDs intensity.
+
+The brightness level for each LED is calculated based on the color LED
+intensity setting divided by the color LED max intensity setting multiplied by
+the requested value.

s/value/brightness/

Documentation/leds/leds-class-multicolor.rst

Quoted 2 lines

Documentation/leds/leds-class-multicolor.rst new file +2 -0

+
+led_brightness = requested_value * led_color_intensity/led_color_max_intensity

led_brightness = brightness * <color>_intensity/<color>_max_intensity

Quoted 38 lines

Documentation/leds/leds-class-multicolor.rst new file +38 -0

+
+Example:
+Three LEDs are present in the group as defined in "Directory Layout Example"
+within this document.
+
+A user first writes the color LED brightness file with the brightness level that
+is necessary to achieve a blueish violet output from the RGB LED group.
+
+echo 138 > /sys/class/leds/rgb:grouped_leds/red_intensity
+echo 43 > /sys/class/leds/rgb:grouped_leds/green_intensity
+echo 226 > /sys/class/leds/rgb:grouped_leds/blue_intensity
+
+red -
+	intensity = 138
+	max_intensity = 255
+green -
+	intensity = 43
+	max_intensity = 255
+blue -
+	intensity = 226
+	max_intensity = 255
+
+The user can control the brightness of that RGB group by writing the parent
+'brightness' control.  Assuming a parent max_brightness of 255 the user may want
+to dim the LED color group to half.  The user would write a value of 128 to the
+parent brightness file then the values written to each LED will be adjusted
+base on this value
+
+cat /sys/class/leds/rgb:grouped_leds/max_brightness
+255
+echo 128 > /sys/class/leds/rgb:grouped_leds/brightness
+
+adjusted_red_value = 128 * 138/255 = 69
+adjusted_green_value = 128 * 43/255 = 21
+adjusted_blue_value = 128 * 226/255 = 113
+
+Reading the parent brightness file will return the current brightness value of
+the color LED group.

Documentation/leds/leds-class-multicolor.rst line 90

Quoted 7 lines

Documentation/leds/leds-class-multicolor.rst new file +7 -0

+
+cat /sys/class/leds/rgb:grouped_leds/max_brightness
+255
+
+echo 128 > /sys/class/leds/rgb:grouped_leds/brightness
+
+cat /sys/class/leds/rgb:grouped_leds/max_brightness

s/max_brightness/brightness/

Quoted 2 lines

+128

Jacek

Thanks for the review

Quoted 7 lines · Jacek Anaszewski

Dan,

Quoted 2 lines · Dan Murphy

Add the support documentation on the multicolor LED framework. This document defines the directores and file generated by the

Now there will be one directory created.

Quoted 3 lines

Apart from that - all documentation should go in the same patch as the feature being added. So patches 1,2 and 3 should be melded together.

I think only patches 1 & 2 should be squashed into a single patch.

Patch 3 are the dt-bindings which should be separated

Quoted 35 lines

Quoted 35 lines

multicolor framework.  It also documents usage.

Signed-off-by Dan Murphy <[email protected]>

---
  Documentation/leds/index.rst                 |  1 + Documentation/leds/leds-class-multicolor.rst | 91 ++++++++++++++++++++

  2 files changed, 92 insertions(+)

  create mode 100644 Documentation/leds/leds-class-multicolor.rst

Documentation/leds/index.rst +0 -0

index 060f4e485897..bc70c6aa7138 100644
@@ -9,6 +9,7 @@ LEDs

       leds-class
     leds-class-flash
+   leds-class-multicolor
     ledtrig-oneshot
     ledtrig-transient
     ledtrig-usbport

Documentation/leds/leds-class-multicolor.rst new file +7 -0

new file mode 100644
index 000000000000..063c9a411a1d
@@ -0,0 +1,91 @@
+====================================
+Multi Color LED handling under Linux
+====================================
+
+Description
+===========
+There are varying monochrome LED colors available for application. 

These

Quoted 8 lines

Quoted 3 lines

+LEDs can be used as a single use case LED or can be mixed with other color
+LEDs to produce the full spectrum of color.

I'd say it won't be the most frequent use case. We can expect rather compound RGB, RGBA[UV] etc. LED elements being connected to iouts of multi color LED controllers like LP50xx. TI mentions RGB LEDs in its application notes for instance. I'd mention that in the first place and leave what you have above as another use case.

Which application notes are you referring to?

Add DT bindings for the LEDs multicolor class framework.

Signed-off-by Dan Murphy <[email protected]>

---
 .../bindings/leds/leds-class-multicolor.txt   | 95 +++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.txt

Documentation/devicetree/bindings/leds/leds-class-multicolor.txt new file +0 -0

new file mode 100644
index 000000000000..215d3c90f351

Documentation/devicetree/bindings/leds/leds-class-multicolor.txt new file +91 -0

+
+The nodes and properties defined in this document are unique to the multicolor
+LED class.  Common LED nodes and properties are inherited from the common.txt
+within this documentation directory.
+
+Required LED Child properties:
+	- color : For multicolor LED support this property should be defined as
+		  LED_COLOR_ID_MULTI and further definition can be found in
+		  include/linux/leds/common.h.
+
+led-controller@30 {
+	#address-cells = <1>;
+	#size-cells = <0>;
+	compatible = "ti,lp5024";
+	reg = <0x29>;
+
+	multi-led@1 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <1>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_STATUS;
+
+
+		led@3 {
+			reg = <3>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@4 {
+			reg = <4>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@5 {
+			reg = <5>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+
+	multi-led@2 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_ACTIVITY;
+		reg = <2>;
+		ti,led-bank = <2 3 5>;
+
+		led@6 {
+			reg = <0x6>;
+			color = <LED_COLOR_ID_RED>;
+			led-sources = <6 9 15>;
+		};
+
+		led@7 {
+			reg = <0x7>;
+			color = <LED_COLOR_ID_GREEN>;
+			led-sources = <7 10 16>;
+		};
+
+		led@8 {
+			reg = <0x8>;
+			color = <LED_COLOR_ID_BLUE>;
+			led-sources = <8 11 17>;
+		};
+	};
+
+	multi-led@4 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <4>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_ACTIVITY;
+
+		led@12 {
+			reg = <12>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@13 {
+			reg = <13>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@14 {
+			reg = <14>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+
+};

Dan,

Quoted 14 lines · Dan Murphy

Add DT bindings for the LEDs multicolor class framework.

Signed-off-by Dan Murphy <[email protected]>

---
  .../bindings/leds/leds-class-multicolor.txt   | 95 +++++++++++++++++++
  1 file changed, 95 insertions(+)

create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.txt

Documentation/devicetree/bindings/leds/leds-class-multicolor.txt new file +0 -0

new file mode 100644
index 000000000000..215d3c90f351

Documentation/devicetree/bindings/leds/leds-class-multicolor.txt line 4

Quoted 4 lines

Documentation/devicetree/bindings/leds/leds-class-multicolor.txt new file +4 -0

@@ -0,0 +1,95 @@
+* Multicolor LED properties
+
+Monochrome LEDs can grouped into LED clusters.  These clusters can provide a
+visible output that have a wide range of colors and intensities.

Here is the same issue as I spotted in a review for the patch 2/9 from this set:

"
I'd say it won't be the most frequent use case. We can expect rather compound RGB, RGBA[UV] etc. LED elements being connected to iouts of multi color LED controllers like LP50xx.
"

How about:

Bindings for multi color LEDs show how to describe current outputs of either integrated multi-color LED elements (like RGB, RGBW, RGBWA-UV etc.) or standalone LEDs, to achieve logically grouped multi-color LED modules. This is achieved by adding multi-led nodes layer to the monochrome LED bindings.

Quoted 92 lines

Documentation/devicetree/bindings/leds/leds-class-multicolor.txt new file +91 -0

+
+The nodes and properties defined in this document are unique to the multicolor
+LED class.  Common LED nodes and properties are inherited from the common.txt
+within this documentation directory.
+
+Required LED Child properties:
+	- color : For multicolor LED support this property should be defined as
+		  LED_COLOR_ID_MULTI and further definition can be found in
+		  include/linux/leds/common.h.
+
+led-controller@30 {
+	#address-cells = <1>;
+	#size-cells = <0>;
+	compatible = "ti,lp5024";
+	reg = <0x29>;
+
+	multi-led@1 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <1>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_STATUS;
+
+
+		led@3 {
+			reg = <3>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@4 {
+			reg = <4>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@5 {
+			reg = <5>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+
+	multi-led@2 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_ACTIVITY;
+		reg = <2>;
+		ti,led-bank = <2 3 5>;
+
+		led@6 {
+			reg = <0x6>;
+			color = <LED_COLOR_ID_RED>;
+			led-sources = <6 9 15>;
+		};
+
+		led@7 {
+			reg = <0x7>;
+			color = <LED_COLOR_ID_GREEN>;
+			led-sources = <7 10 16>;
+		};
+
+		led@8 {
+			reg = <0x8>;
+			color = <LED_COLOR_ID_BLUE>;
+			led-sources = <8 11 17>;
+		};
+	};
+
+	multi-led@4 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <4>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_ACTIVITY;
+
+		led@12 {
+			reg = <12>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@13 {
+			reg = <13>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@14 {
+			reg = <14>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+
+};

Add a new color ID that is declared as MULTICOLOR as with the multicolor framework declaring a definitive color is not accurate as the node can contain multiple colors.

Signed-off-by Dan Murphy <[email protected]>

---
 include/dt-bindings/leds/common.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

include/dt-bindings/leds/common.h +0 -0

index 9e1256a7c1bf..7006d15f71e8 100644

Add a new color ID that is declared as MULTICOLOR as with the multicolor framework declaring a definitive color is not accurate as the node can contain multiple colors.

Signed-off-by Dan Murphy <[email protected]>

---
 drivers/leds/led-core.c | 1 +
 1 file changed, 1 insertion(+)

drivers/leds/led-core.c +0 -0

index f1f718dbe0f8..846248a0693d 100644

Introduce a multicolor class that groups colored LEDs within a LED node.

The framework allows for dynamically setting individual LEDs or setting brightness levels of LEDs and updating them virtually simultaneously.

Signed-off-by Dan Murphy <[email protected]>

---
 drivers/leds/Kconfig                 |  10 +
 drivers/leds/Makefile                |   1 +
 drivers/leds/led-class-multicolor.c  | 316 +++++++++++++++++++++++++++
 include/linux/led-class-multicolor.h |  76 +++++++
 4 files changed, 403 insertions(+)
 create mode 100644 drivers/leds/led-class-multicolor.c
 create mode 100644 include/linux/led-class-multicolor.h

drivers/leds/Kconfig +10 -0

index 6e7703fd03d0..cfb1ebb6517f 100644
@@ -30,6 +30,16 @@ config LEDS_CLASS_FLASH
 	  for the flash related features of a LED device. It can be built
 	  as a module.
 
+config LEDS_CLASS_MULTI_COLOR
+	tristate "LED Mulit Color LED Class Support"
+	depends on LEDS_CLASS
+	help
+	  This option enables the multicolor LED sysfs class in /sys/class/leds.
+	  It wraps LED class and adds multicolor LED specific sysfs attributes
+	  and kernel internal API to it. You'll need this to provide support
+	  for multicolor LEDs that are grouped together. This class is not
+	  intended for single color LEDs. It can be built as a module.
+
 config LEDS_BRIGHTNESS_HW_CHANGED
 	bool "LED Class brightness_hw_changed attribute support"
 	depends on LEDS_CLASS

drivers/leds/Makefile +1 -0

index 2da39e896ce8..841038cfe35b 100644
@@ -4,6 +4,7 @@
 obj-$(CONFIG_NEW_LEDS)			+= led-core.o
 obj-$(CONFIG_LEDS_CLASS)		+= led-class.o
 obj-$(CONFIG_LEDS_CLASS_FLASH)		+= led-class-flash.o
+obj-$(CONFIG_LEDS_CLASS_MULTI_COLOR)	+= led-class-multicolor.o
 obj-$(CONFIG_LEDS_TRIGGERS)		+= led-triggers.o
 
 # LED Platform Drivers

drivers/leds/led-class-multicolor.c new file +63 -0

new file mode 100644
index 000000000000..5e0e3fce482b
@@ -0,0 +1,316 @@
+// SPDX-License-Identifier: GPL-2.0
+// LED Multi Color class interface
+// Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/
+
+#include <linux/device.h>
+#include <linux/init.h>
+#include <linux/led-class-multicolor.h>
+#include <linux/module.h>
+#include <linux/slab.h>
+#include <linux/uaccess.h>
+
+#include "leds.h"
+
+#define INTENSITY_NAME		"_intensity"
+#define MAX_INTENSITY_NAME	"_max_intensity"
+
+struct led_mc_color_entry {
+	struct led_classdev_mc *mcled_cdev;
+
+	struct device_attribute max_intensity_attr;
+	struct device_attribute intensity_attr;
+
+	enum led_brightness max_intensity;
+	enum led_brightness intensity;
+
+	struct list_head list;
+
+	int led_color_id;
+};
+
+void led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+			    enum led_brightness brightness,
+			    int brightness_val[])
+{
+	struct led_classdev_mc_data *data = mcled_cdev->data;
+	struct led_mc_color_entry *priv;
+	int i = 0;
+
+	list_for_each_entry(priv, &data->color_list, list) {
+		brightness_val[i] = brightness *
+				    priv->intensity / priv->max_intensity;
+		i++;
+	}
+}
+EXPORT_SYMBOL_GPL(led_mc_calc_brightness);
+
+static ssize_t intensity_store(struct device *dev,
+				struct device_attribute *intensity_attr,
+				const char *buf, size_t size)
+{
+	struct led_mc_color_entry *priv = container_of(intensity_attr,
+						    struct led_mc_color_entry,
+						      intensity_attr);
+	struct led_classdev_mc_data *data = priv->mcled_cdev->data;
+	struct led_classdev_mc *mcled_cdev = data->mcled_cdev;
+	struct led_classdev *led_cdev = priv->mcled_cdev->led_cdev;
+	unsigned long value;
+	ssize_t ret;
+
+	mutex_lock(&led_cdev->led_access);
+
+	ret = kstrtoul(buf, 10, &value);
+	if (ret)

drivers/leds/led-class-multicolor.c new file +59 -0

+		ret = mcled_cdev->set_color_brightness(mcled_cdev,
+						       priv->led_color_id,
+						       priv->intensity);
+		if (ret)
+			goto unlock;
+	}
+
+	ret = size;
+
+unlock:
+	mutex_unlock(&led_cdev->led_access);
+	return ret;
+}
+
+static ssize_t intensity_show(struct device *dev,
+			      struct device_attribute *intensity_attr,
+			      char *buf)
+{
+	struct led_mc_color_entry *priv = container_of(intensity_attr,
+						    struct led_mc_color_entry,
+						      intensity_attr);
+
+	return sprintf(buf, "%d\n", priv->intensity);
+}
+
+static ssize_t max_intensity_show(struct device *dev,
+				   struct device_attribute *max_intensity_attr,
+				   char *buf)
+{
+	struct led_mc_color_entry *priv = container_of(max_intensity_attr,
+						    struct led_mc_color_entry,
+						      max_intensity_attr);
+
+	return sprintf(buf, "%d\n", priv->max_intensity);
+}
+
+static struct attribute *led_color_attrs[] = {
+	NULL,
+};
+
+static struct attribute_group led_color_group = {
+	.name = "colors",
+	.attrs = led_color_attrs,
+};
+
+static int led_multicolor_init_color(struct led_classdev_mc_data *data,
+				     struct led_classdev_mc *mcled_cdev,
+				     int color_id, int color_index)
+{
+	struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+	struct led_mc_color_entry *mc_priv;
+	char *intensity_file_name;
+	char *max_intensity_file_name;
+	size_t len;
+	int ret;
+
+	mc_priv = devm_kzalloc(led_cdev->dev, sizeof(*mc_priv), GFP_KERNEL);
+	if (!mc_priv)
+		return -ENOMEM;

drivers/leds/led-class-multicolor.c new file +50 -0

+	}
+
+	snprintf(intensity_file_name, len, "%s%s",
+		 led_colors[color_id], INTENSITY_NAME);
+	mc_priv->intensity_attr.attr.name = intensity_file_name;
+	mc_priv->intensity_attr.attr.mode = 644;
+	mc_priv->intensity_attr.store = intensity_store;
+	mc_priv->intensity_attr.show = intensity_show;
+	ret = sysfs_add_file_to_group(&led_cdev->dev->kobj,
+				      &mc_priv->intensity_attr.attr,
+				      led_color_group.name);
+	if (ret)
+		goto intensity_err_out;
+
+	sysfs_attr_init(&mc_priv->max_intensity_attr.attr);
+	len = strlen(led_colors[color_id]) + strlen(MAX_INTENSITY_NAME) + 1;
+	max_intensity_file_name = kzalloc(len, GFP_KERNEL);
+	if (!max_intensity_file_name) {
+		ret = -ENOMEM;
+		goto intensity_err_out;
+	}
+
+	snprintf(max_intensity_file_name, len, "%s%s",
+		 led_colors[color_id], MAX_INTENSITY_NAME);
+	mc_priv->max_intensity_attr.attr.name = max_intensity_file_name;
+	mc_priv->max_intensity_attr.attr.mode = 444;
+	mc_priv->max_intensity_attr.show = max_intensity_show;
+	ret = sysfs_add_file_to_group(&led_cdev->dev->kobj,
+				      &mc_priv->max_intensity_attr.attr,
+				      led_color_group.name);
+	if (ret)
+		goto max_intensity_err_out;
+
+	mc_priv->max_intensity = LED_FULL;
+	list_add_tail(&mc_priv->list, &data->color_list);
+
+max_intensity_err_out:
+	kfree(max_intensity_file_name);
+intensity_err_out:
+	kfree(intensity_file_name);
+err_out:
+	return ret;
+}
+
+static int led_multicolor_init_color_dir(struct led_classdev_mc_data *data,
+					 struct led_classdev_mc *mcled_cdev)
+{
+	struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+	u32 color_id;
+	int ret;

drivers/leds/led-class-multicolor.c new file +44 -0

+	}
+
+	return ret;
+}
+
+int led_classdev_multicolor_register_ext(struct device *parent,
+				     struct led_classdev_mc *mcled_cdev,
+				     struct led_init_data *init_data)
+{
+	struct led_classdev *led_cdev;
+	struct led_classdev_mc_data *data;
+	int ret;
+
+	if (!mcled_cdev)
+		return -EINVAL;
+
+	data = kzalloc(sizeof(*data), GFP_KERNEL);
+	if (!data)
+		return -ENOMEM;
+
+	mcled_cdev->data = data;
+	led_cdev = mcled_cdev->led_cdev;
+	INIT_LIST_HEAD(&data->color_list);
+
+	/* Register led class device */
+	ret = led_classdev_register_ext(parent, led_cdev, init_data);
+	if (ret)
+		return ret;
+
+	return led_multicolor_init_color_dir(data, mcled_cdev);
+}
+EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext);
+
+void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev)
+{
+	if (!mcled_cdev)
+		return;
+
+	sysfs_remove_group(&mcled_cdev->led_cdev->dev->kobj, &led_color_group);
+	led_classdev_unregister(mcled_cdev->led_cdev);
+}
+EXPORT_SYMBOL_GPL(led_classdev_multicolor_unregister);
+
+static void devm_led_classdev_multicolor_release(struct device *dev, void *res)

drivers/leds/led-class-multicolor.c new file +51 -0

+{
+	struct led_classdev_mc **dr;
+	int ret;
+
+	dr = devres_alloc(devm_led_classdev_multicolor_release,
+			  sizeof(*dr), GFP_KERNEL);
+	if (!dr)
+		return -ENOMEM;
+
+	ret = led_classdev_multicolor_register(parent, mcled_cdev);
+	if (ret) {
+		devres_free(dr);
+		return ret;
+	}
+
+	*dr = mcled_cdev;
+	devres_add(parent, dr);
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_register);
+
+static int devm_led_classdev_multicolor_match(struct device *dev,
+					      void *res, void *data)
+{
+	struct mcled_cdev **p = res;
+
+	if (WARN_ON(!p || !*p))
+		return 0;
+
+	return *p == data;
+}
+
+/**
+ * devm_led_classdev_multicolor_unregister() - resource managed
+ *					led_classdev_multicolor_unregister()
+ * @parent: The device to unregister.
+ * @mcled_cdev: the led_classdev_mc structure for this device.
+ */
+void devm_led_classdev_multicolor_unregister(struct device *dev,
+				  struct led_classdev_mc *mcled_cdev)
+{
+	WARN_ON(devres_release(dev,
+			       devm_led_classdev_multicolor_release,
+			       devm_led_classdev_multicolor_match, mcled_cdev));
+}
+EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_unregister);
+
+MODULE_AUTHOR("Dan Murphy <[email protected]>");
+MODULE_DESCRIPTION("Multi Color LED class interface");
+MODULE_LICENSE("GPL v2");

include/linux/led-class-multicolor.h new file +38 -0

new file mode 100644
index 000000000000..afcaf429fba5
@@ -0,0 +1,76 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/* LED Multicolor class interface
+ * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/
+ */
+
+#ifndef __LINUX_MULTICOLOR_LEDS_H_INCLUDED
+#define __LINUX_MULTICOLOR_LEDS_H_INCLUDED
+
+#include <linux/leds.h>
+#include <dt-bindings/leds/common.h>
+
+struct led_classdev_mc;
+
+struct led_classdev_mc_data {
+	struct led_classdev_mc *mcled_cdev;
+	struct list_head color_list;
+};
+
+struct led_classdev_mc {
+	/* led class device */
+	struct led_classdev *led_cdev;
+
+	/* Set brightness for a specific color id */
+	int (*set_color_brightness)(struct led_classdev_mc *mcled_cdev,
+				    int color_id, int value);
+
+	struct led_classdev_mc_data *data;
+
+	unsigned long available_colors;
+	int num_leds;
+};
+
+static inline struct led_classdev_mc *lcdev_to_mccdev(
+						struct led_classdev *lcdev)
+{
+	return container_of(lcdev, struct led_classdev_mc, led_cdev);
+}
+

include/linux/led-class-multicolor.h new file +28 -0

+					    struct led_classdev_mc *mcled_cdev,
+					    struct led_init_data *init_data);
+
+#define led_classdev_multicolor_register(parent, mcled_cdev)		\
+	led_classdev_multicolor_register_ext(parent, mcled_cdev, NULL)
+
+/**
+ * led_classdev_multicolor_unregister - unregisters an object of led_classdev
+ *					class with support for multicolor LEDs
+ * @mcled_cdev: the multicolor LED to unregister
+ *
+ * Unregister a previously registered via led_classdev_multicolor_register
+ * object
+ */
+extern void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);
+
+extern int devm_led_classdev_multicolor_register(struct device *parent,
+					struct led_classdev_mc *mcled_cdev);
+
+extern void devm_led_classdev_multicolor_unregister(struct device *parent,
+					   struct led_classdev_mc *mcled_cdev);
+
+/* Set brightness for the monochrome LED cluster */
+extern void led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+			    enum led_brightness brightness,
+			    int brightness_val[]);
+
+#endif	/* __LINUX_MULTICOLOR_LEDS_H_INCLUDED */

Dan,

Quoted 6 lines · Dan Murphy

Introduce a multicolor class that groups colored LEDs within a LED node.

The framework allows for dynamically setting individual LEDs or setting brightness levels of LEDs and updating them virtually simultaneously.

Let's update this to the corresponding changed fragment from the documentation after we finally agree upon it.

Quoted 116 lines

Signed-off-by Dan Murphy <[email protected]>

---
  drivers/leds/Kconfig                 |  10 +
  drivers/leds/Makefile                |   1 +
  drivers/leds/led-class-multicolor.c  | 316 +++++++++++++++++++++++++++
  include/linux/led-class-multicolor.h |  76 +++++++
  4 files changed, 403 insertions(+)

create mode 100644 drivers/leds/led-class-multicolor.c create mode 100644 include/linux/led-class-multicolor.h

drivers/leds/Kconfig +10 -0

index 6e7703fd03d0..cfb1ebb6517f 100644
@@ -30,6 +30,16 @@ config LEDS_CLASS_FLASH
  	  for the flash related features of a LED device. It can be built
  	  as a module.
 
+config LEDS_CLASS_MULTI_COLOR
+	tristate "LED Mulit Color LED Class Support"
+	depends on LEDS_CLASS
+	help
+	  This option enables the multicolor LED sysfs class in /sys/class/leds.
+	  It wraps LED class and adds multicolor LED specific sysfs attributes
+	  and kernel internal API to it. You'll need this to provide support
+	  for multicolor LEDs that are grouped together. This class is not
+	  intended for single color LEDs. It can be built as a module.
+
  config LEDS_BRIGHTNESS_HW_CHANGED
  	bool "LED Class brightness_hw_changed attribute support"
  	depends on LEDS_CLASS

drivers/leds/Makefile +1 -0

index 2da39e896ce8..841038cfe35b 100644
@@ -4,6 +4,7 @@
  obj-$(CONFIG_NEW_LEDS)			+= led-core.o
  obj-$(CONFIG_LEDS_CLASS)		+= led-class.o
  obj-$(CONFIG_LEDS_CLASS_FLASH)		+= led-class-flash.o
+obj-$(CONFIG_LEDS_CLASS_MULTI_COLOR)	+= led-class-multicolor.o
  obj-$(CONFIG_LEDS_TRIGGERS)		+= led-triggers.o
 
  # LED Platform Drivers

drivers/leds/led-class-multicolor.c new file +66 -0

new file mode 100644
index 000000000000..5e0e3fce482b
@@ -0,0 +1,316 @@
+// SPDX-License-Identifier: GPL-2.0
+// LED Multi Color class interface
+// Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/
+
+#include <linux/device.h>
+#include <linux/init.h>
+#include <linux/led-class-multicolor.h>
+#include <linux/module.h>
+#include <linux/slab.h>
+#include <linux/uaccess.h>
+
+#include "leds.h"
+
+#define INTENSITY_NAME		"_intensity"
+#define MAX_INTENSITY_NAME	"_max_intensity"
+
+struct led_mc_color_entry {
+	struct led_classdev_mc *mcled_cdev;
+
+	struct device_attribute max_intensity_attr;
+	struct device_attribute intensity_attr;
+
+	enum led_brightness max_intensity;
+	enum led_brightness intensity;
+
+	struct list_head list;
+
+	int led_color_id;
+};
+
+void led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+			    enum led_brightness brightness,
+			    int brightness_val[])
+{
+	struct led_classdev_mc_data *data = mcled_cdev->data;
+	struct led_mc_color_entry *priv;
+	int i = 0;
+
+	list_for_each_entry(priv, &data->color_list, list) {
+		brightness_val[i] = brightness *
+				    priv->intensity / priv->max_intensity;
+		i++;
+	}
+}
+EXPORT_SYMBOL_GPL(led_mc_calc_brightness);
+
+static ssize_t intensity_store(struct device *dev,
+				struct device_attribute *intensity_attr,
+				const char *buf, size_t size)
+{
+	struct led_mc_color_entry *priv = container_of(intensity_attr,
+						    struct led_mc_color_entry,
+						      intensity_attr);
+	struct led_classdev_mc_data *data = priv->mcled_cdev->data;
+	struct led_classdev_mc *mcled_cdev = data->mcled_cdev;
+	struct led_classdev *led_cdev = priv->mcled_cdev->led_cdev;
+	unsigned long value;
+	ssize_t ret;
+
+	mutex_lock(&led_cdev->led_access);
+
+	ret = kstrtoul(buf, 10, &value);
+	if (ret)
+		goto unlock;
+
+	if (value > priv->max_intensity) {

drivers/leds/led-class-multicolor.c line 73

Quoted 7 lines

drivers/leds/led-class-multicolor.c new file +7 -0

+		ret = -EINVAL;
+		goto unlock;
+	}
+
+	priv->intensity = value;
+
+	if (mcled_cdev->set_color_brightness) {

We will not have this, as discussed.

Quoted 63 lines

drivers/leds/led-class-multicolor.c new file +62 -0

+		ret = mcled_cdev->set_color_brightness(mcled_cdev,
+						       priv->led_color_id,
+						       priv->intensity);
+		if (ret)
+			goto unlock;
+	}
+
+	ret = size;
+
+unlock:
+	mutex_unlock(&led_cdev->led_access);
+	return ret;
+}
+
+static ssize_t intensity_show(struct device *dev,
+			      struct device_attribute *intensity_attr,
+			      char *buf)
+{
+	struct led_mc_color_entry *priv = container_of(intensity_attr,
+						    struct led_mc_color_entry,
+						      intensity_attr);
+
+	return sprintf(buf, "%d\n", priv->intensity);
+}
+
+static ssize_t max_intensity_show(struct device *dev,
+				   struct device_attribute *max_intensity_attr,
+				   char *buf)
+{
+	struct led_mc_color_entry *priv = container_of(max_intensity_attr,
+						    struct led_mc_color_entry,
+						      max_intensity_attr);
+
+	return sprintf(buf, "%d\n", priv->max_intensity);
+}
+
+static struct attribute *led_color_attrs[] = {
+	NULL,
+};
+
+static struct attribute_group led_color_group = {
+	.name = "colors",
+	.attrs = led_color_attrs,
+};
+
+static int led_multicolor_init_color(struct led_classdev_mc_data *data,
+				     struct led_classdev_mc *mcled_cdev,
+				     int color_id, int color_index)
+{
+	struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+	struct led_mc_color_entry *mc_priv;
+	char *intensity_file_name;
+	char *max_intensity_file_name;
+	size_t len;
+	int ret;
+
+	mc_priv = devm_kzalloc(led_cdev->dev, sizeof(*mc_priv), GFP_KERNEL);
+	if (!mc_priv)
+		return -ENOMEM;
+
+	mc_priv->led_color_id = color_id;
+	mc_priv->mcled_cdev = mcled_cdev;

drivers/leds/led-class-multicolor.c line 142

Quoted 7 lines

drivers/leds/led-class-multicolor.c new file +7 -0

+
+	sysfs_attr_init(&mc_priv->intensity_attr.attr);
+	len = strlen(led_colors[color_id]) + strlen(INTENSITY_NAME) + 1;
+	intensity_file_name = kzalloc(len, GFP_KERNEL);
+	if (!intensity_file_name) {
+		ret = -ENOMEM;
+		goto err_out;

Just return -ENOMEM. No need for err_out label.

Quoted 51 lines

drivers/leds/led-class-multicolor.c new file +50 -0

+	}
+
+	snprintf(intensity_file_name, len, "%s%s",
+		 led_colors[color_id], INTENSITY_NAME);
+	mc_priv->intensity_attr.attr.name = intensity_file_name;
+	mc_priv->intensity_attr.attr.mode = 644;
+	mc_priv->intensity_attr.store = intensity_store;
+	mc_priv->intensity_attr.show = intensity_show;
+	ret = sysfs_add_file_to_group(&led_cdev->dev->kobj,
+				      &mc_priv->intensity_attr.attr,
+				      led_color_group.name);
+	if (ret)
+		goto intensity_err_out;
+
+	sysfs_attr_init(&mc_priv->max_intensity_attr.attr);
+	len = strlen(led_colors[color_id]) + strlen(MAX_INTENSITY_NAME) + 1;
+	max_intensity_file_name = kzalloc(len, GFP_KERNEL);
+	if (!max_intensity_file_name) {
+		ret = -ENOMEM;
+		goto intensity_err_out;
+	}
+
+	snprintf(max_intensity_file_name, len, "%s%s",
+		 led_colors[color_id], MAX_INTENSITY_NAME);
+	mc_priv->max_intensity_attr.attr.name = max_intensity_file_name;
+	mc_priv->max_intensity_attr.attr.mode = 444;
+	mc_priv->max_intensity_attr.show = max_intensity_show;
+	ret = sysfs_add_file_to_group(&led_cdev->dev->kobj,
+				      &mc_priv->max_intensity_attr.attr,
+				      led_color_group.name);
+	if (ret)
+		goto max_intensity_err_out;
+
+	mc_priv->max_intensity = LED_FULL;
+	list_add_tail(&mc_priv->list, &data->color_list);
+
+max_intensity_err_out:
+	kfree(max_intensity_file_name);
+intensity_err_out:
+	kfree(intensity_file_name);
+err_out:
+	return ret;
+}
+
+static int led_multicolor_init_color_dir(struct led_classdev_mc_data *data,
+					 struct led_classdev_mc *mcled_cdev)
+{
+	struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+	u32 color_id;
+	int ret;

drivers/leds/led-class-multicolor.c line 202

Quoted 10 lines

drivers/leds/led-class-multicolor.c new file +10 -0

+	int i, j = 0;
+
+	data->mcled_cdev = mcled_cdev;
+
+	ret = sysfs_create_group(&led_cdev->dev->kobj, &led_color_group);
+	if (ret)
+		return ret;
+
+	for (i = 0; i < LED_COLOR_ID_MAX; i++) {
+		color_id = (mcled_cdev->available_colors & (1 << i));

This is nitpicking but for me it would look cleaner if we had color_mask variable:

color_id = (mcled_cdev->available_colors & color_mask);

drivers/leds/led-class-multicolor.c line 209

Quoted 7 lines

drivers/leds/led-class-multicolor.c new file +7 -0

+		if (color_id) {
+			ret = led_multicolor_init_color(data, mcled_cdev, i, j);
+			if (ret)
+				break;
+
+			j++;
+		}

And do the shifting here:

		color_mask <<= 1;

Quoted 49 lines

drivers/leds/led-class-multicolor.c new file +48 -0

+	}
+
+	return ret;
+}
+
+int led_classdev_multicolor_register_ext(struct device *parent,
+				     struct led_classdev_mc *mcled_cdev,
+				     struct led_init_data *init_data)
+{
+	struct led_classdev *led_cdev;
+	struct led_classdev_mc_data *data;
+	int ret;
+
+	if (!mcled_cdev)
+		return -EINVAL;
+
+	data = kzalloc(sizeof(*data), GFP_KERNEL);
+	if (!data)
+		return -ENOMEM;
+
+	mcled_cdev->data = data;
+	led_cdev = mcled_cdev->led_cdev;
+	INIT_LIST_HEAD(&data->color_list);
+
+	/* Register led class device */
+	ret = led_classdev_register_ext(parent, led_cdev, init_data);
+	if (ret)
+		return ret;
+
+	return led_multicolor_init_color_dir(data, mcled_cdev);
+}
+EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext);
+
+void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev)
+{
+	if (!mcled_cdev)
+		return;
+
+	sysfs_remove_group(&mcled_cdev->led_cdev->dev->kobj, &led_color_group);
+	led_classdev_unregister(mcled_cdev->led_cdev);
+}
+EXPORT_SYMBOL_GPL(led_classdev_multicolor_unregister);
+
+static void devm_led_classdev_multicolor_release(struct device *dev, void *res)
+{
+	led_classdev_multicolor_unregister(*(struct led_classdev_mc **)res);
+}
+

drivers/leds/led-class-multicolor.c line 263

Quoted 6 lines

drivers/leds/led-class-multicolor.c new file +6 -0

+/**
+ * devm_of_led_classdev_register - resource managed led_classdev_register()
+ *
+ * @parent: parent of LED device
+ * @led_cdev: the led_classdev structure for this device.
+ */

Let's move documentation to the header. We should to the same with the existing led-class.c API one day.

drivers/leds/led-class-multicolor.c line 265

Quoted 2 lines

drivers/leds/led-class-multicolor.c new file +2 -0

+int devm_led_classdev_multicolor_register(struct device *parent,
+					  struct led_classdev_mc *mcled_cdev)

We don't need non-ext version for a new API.

Quoted 100 lines

drivers/leds/led-class-multicolor.c new file +51 -0

+{
+	struct led_classdev_mc **dr;
+	int ret;
+
+	dr = devres_alloc(devm_led_classdev_multicolor_release,
+			  sizeof(*dr), GFP_KERNEL);
+	if (!dr)
+		return -ENOMEM;
+
+	ret = led_classdev_multicolor_register(parent, mcled_cdev);
+	if (ret) {
+		devres_free(dr);
+		return ret;
+	}
+
+	*dr = mcled_cdev;
+	devres_add(parent, dr);
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_register);
+
+static int devm_led_classdev_multicolor_match(struct device *dev,
+					      void *res, void *data)
+{
+	struct mcled_cdev **p = res;
+
+	if (WARN_ON(!p || !*p))
+		return 0;
+
+	return *p == data;
+}
+
+/**
+ * devm_led_classdev_multicolor_unregister() - resource managed
+ *					led_classdev_multicolor_unregister()
+ * @parent: The device to unregister.
+ * @mcled_cdev: the led_classdev_mc structure for this device.
+ */
+void devm_led_classdev_multicolor_unregister(struct device *dev,
+				  struct led_classdev_mc *mcled_cdev)
+{
+	WARN_ON(devres_release(dev,
+			       devm_led_classdev_multicolor_release,
+			       devm_led_classdev_multicolor_match, mcled_cdev));
+}
+EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_unregister);
+
+MODULE_AUTHOR("Dan Murphy <[email protected]>");
+MODULE_DESCRIPTION("Multi Color LED class interface");
+MODULE_LICENSE("GPL v2");

include/linux/led-class-multicolor.h new file +42 -0

new file mode 100644
index 000000000000..afcaf429fba5
@@ -0,0 +1,76 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/* LED Multicolor class interface
+ * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/
+ */
+
+#ifndef __LINUX_MULTICOLOR_LEDS_H_INCLUDED
+#define __LINUX_MULTICOLOR_LEDS_H_INCLUDED
+
+#include <linux/leds.h>
+#include <dt-bindings/leds/common.h>
+
+struct led_classdev_mc;
+
+struct led_classdev_mc_data {
+	struct led_classdev_mc *mcled_cdev;
+	struct list_head color_list;
+};
+
+struct led_classdev_mc {
+	/* led class device */
+	struct led_classdev *led_cdev;
+
+	/* Set brightness for a specific color id */
+	int (*set_color_brightness)(struct led_classdev_mc *mcled_cdev,
+				    int color_id, int value);
+
+	struct led_classdev_mc_data *data;
+
+	unsigned long available_colors;
+	int num_leds;
+};
+
+static inline struct led_classdev_mc *lcdev_to_mccdev(
+						struct led_classdev *lcdev)
+{
+	return container_of(lcdev, struct led_classdev_mc, led_cdev);
+}
+
+/**
+ * led_classdev_multicolor_register_ext - register a new object of led_classdev
+ *				      class with support for multicolor LEDs
+ * @parent: the multicolor LED to register

include/linux/led-class-multicolor.h line 48

Quoted 6 lines

include/linux/led-class-multicolor.h new file +6 -0

+ * @mcled_cdev: the led_classdev_mc structure for this device
+ * @init_data: the LED class Multi color device initialization data
+ *
+ * Returns: 0 on success or negative error value on failure
+ */
+extern int led_classdev_multicolor_register_ext(struct device *parent,

extern is implied by default for functions. We need also to do this cleanup in leds.h soem day.

Quoted 29 lines

include/linux/led-class-multicolor.h new file +28 -0

+					    struct led_classdev_mc *mcled_cdev,
+					    struct led_init_data *init_data);
+
+#define led_classdev_multicolor_register(parent, mcled_cdev)		\
+	led_classdev_multicolor_register_ext(parent, mcled_cdev, NULL)
+
+/**
+ * led_classdev_multicolor_unregister - unregisters an object of led_classdev
+ *					class with support for multicolor LEDs
+ * @mcled_cdev: the multicolor LED to unregister
+ *
+ * Unregister a previously registered via led_classdev_multicolor_register
+ * object
+ */
+extern void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);
+
+extern int devm_led_classdev_multicolor_register(struct device *parent,
+					struct led_classdev_mc *mcled_cdev);
+
+extern void devm_led_classdev_multicolor_unregister(struct device *parent,
+					   struct led_classdev_mc *mcled_cdev);
+
+/* Set brightness for the monochrome LED cluster */
+extern void led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+			    enum led_brightness brightness,
+			    int brightness_val[]);
+
+#endif	/* __LINUX_MULTICOLOR_LEDS_H_INCLUDED */

Jacek

Quoted 11 lines · Jacek Anaszewski

Dan,

Quoted 6 lines · Dan Murphy

Introduce a multicolor class that groups colored LEDs within a LED node.

The framework allows for dynamically setting individual LEDs or setting brightness levels of LEDs and updating them virtually simultaneously.

Let's update this to the corresponding changed fragment from the documentation after we finally agree upon it.

Quoted 29 lines

Quoted 7 lines

+static int led_multicolor_init_color_dir(struct led_classdev_mc_data *data,
+                     struct led_classdev_mc *mcled_cdev)

drivers/leds/led-class-multicolor.c new file +4 -0

+{
+    struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+    u32 color_id;
+    int ret;

drivers/leds/led-class-multicolor.c line 202

Quoted 10 lines

drivers/leds/led-class-multicolor.c new file +10 -0

+    int i, j = 0;
+
+    data->mcled_cdev = mcled_cdev;
+
+    ret = sysfs_create_group(&led_cdev->dev->kobj, &led_color_group);
+    if (ret)
+        return ret;
+
+    for (i = 0; i < LED_COLOR_ID_MAX; i++) {
+        color_id = (mcled_cdev->available_colors & (1 << i));

This is nitpicking but for me it would look cleaner if we had color_mask variable:

color_id = (mcled_cdev->available_colors & color_mask);

Quoted 7 lines

+        if (color_id) {
+            ret = led_multicolor_init_color(data, mcled_cdev, i, j); +            if (ret)
+                break;
+
+            j++;
+        }

Quoted 3 lines

And do the shifting here:

        color_mask <<= 1;

Ack but responded to your follow up email on using bit ops.

Quoted 53 lines

Quoted 53 lines

+    }

drivers/leds/led-class-multicolor.c new file +33 -0

+
+    return ret;
+}
+
+int led_classdev_multicolor_register_ext(struct device *parent,
+                     struct led_classdev_mc *mcled_cdev,
+                     struct led_init_data *init_data)
+{
+    struct led_classdev *led_cdev;
+    struct led_classdev_mc_data *data;
+    int ret;
+
+    if (!mcled_cdev)
+        return -EINVAL;
+
+    data = kzalloc(sizeof(*data), GFP_KERNEL);
+    if (!data)
+        return -ENOMEM;
+
+    mcled_cdev->data = data;
+    led_cdev = mcled_cdev->led_cdev;
+    INIT_LIST_HEAD(&data->color_list);
+
+    /* Register led class device */
+    ret = led_classdev_register_ext(parent, led_cdev, init_data);
+    if (ret)
+        return ret;
+
+    return led_multicolor_init_color_dir(data, mcled_cdev);
+}
+EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext);
+
+void led_classdev_multicolor_unregister(struct led_classdev_mc

*mcled_cdev)

drivers/leds/led-class-multicolor.c new file +5 -0

+{
+    if (!mcled_cdev)
+        return;
+
+    sysfs_remove_group(&mcled_cdev->led_cdev->dev->kobj,

&led_color_group);
+    led_classdev_unregister(mcled_cdev->led_cdev);

drivers/leds/led-class-multicolor.c new file +4 -0

+}
+EXPORT_SYMBOL_GPL(led_classdev_multicolor_unregister);
+
+static void devm_led_classdev_multicolor_release(struct device *dev,

void *res)
+{
+    led_classdev_multicolor_unregister(*(struct led_classdev_mc **)res);

drivers/leds/led-class-multicolor.c new file +3 -0

+}
+
+/**

Quoted 8 lines

Quoted 6 lines

+ * devm_of_led_classdev_register - resource managed led_classdev_register()
+ *
+ * @parent: parent of LED device
+ * @led_cdev: the led_classdev structure for this device.
+ */

Let's move documentation to the header. We should to the same with the existing led-class.c API one day.

Well this will go away if we remove the non-ext function.

And this documentation needs to be updated anyway.

Quoted 3 lines

Quoted 2 lines

+int devm_led_classdev_multicolor_register(struct device *parent, +                      struct led_classdev_mc *mcled_cdev)

We don't need non-ext version for a new API.

So we only need the ext version like in the flash class?

Quoted 102 lines

Quoted 102 lines

drivers/leds/led-class-multicolor.c new file +51 -0

+{
+    struct led_classdev_mc **dr;
+    int ret;
+
+    dr = devres_alloc(devm_led_classdev_multicolor_release,
+              sizeof(*dr), GFP_KERNEL);
+    if (!dr)
+        return -ENOMEM;
+
+    ret = led_classdev_multicolor_register(parent, mcled_cdev);
+    if (ret) {
+        devres_free(dr);
+        return ret;
+    }
+
+    *dr = mcled_cdev;
+    devres_add(parent, dr);
+
+    return 0;
+}
+EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_register);
+
+static int devm_led_classdev_multicolor_match(struct device *dev,
+                          void *res, void *data)
+{
+    struct mcled_cdev **p = res;
+
+    if (WARN_ON(!p || !*p))
+        return 0;
+
+    return *p == data;
+}
+
+/**
+ * devm_led_classdev_multicolor_unregister() - resource managed
+ *                    led_classdev_multicolor_unregister()
+ * @parent: The device to unregister.
+ * @mcled_cdev: the led_classdev_mc structure for this device.
+ */
+void devm_led_classdev_multicolor_unregister(struct device *dev,
+                  struct led_classdev_mc *mcled_cdev)
+{
+    WARN_ON(devres_release(dev,
+                   devm_led_classdev_multicolor_release,
+                   devm_led_classdev_multicolor_match, mcled_cdev));
+}
+EXPORT_SYMBOL_GPL(devm_led_classdev_multicolor_unregister);
+
+MODULE_AUTHOR("Dan Murphy <[email protected]>");
+MODULE_DESCRIPTION("Multi Color LED class interface");
+MODULE_LICENSE("GPL v2");

include/linux/led-class-multicolor.h new file +3 -0

new file mode 100644
index 000000000000..afcaf429fba5
@@ -0,0 +1,76 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/* LED Multicolor class interface
+ * Copyright (C) 2019 Texas Instruments Incorporated -

http://www.ti.com/
+ */

include/linux/led-class-multicolor.h new file +36 -0

+
+#ifndef __LINUX_MULTICOLOR_LEDS_H_INCLUDED
+#define __LINUX_MULTICOLOR_LEDS_H_INCLUDED
+
+#include <linux/leds.h>
+#include <dt-bindings/leds/common.h>
+
+struct led_classdev_mc;
+
+struct led_classdev_mc_data {
+    struct led_classdev_mc *mcled_cdev;
+    struct list_head color_list;
+};
+
+struct led_classdev_mc {
+    /* led class device */
+    struct led_classdev *led_cdev;
+
+    /* Set brightness for a specific color id */
+    int (*set_color_brightness)(struct led_classdev_mc *mcled_cdev,
+                    int color_id, int value);
+
+    struct led_classdev_mc_data *data;
+
+    unsigned long available_colors;
+    int num_leds;
+};
+
+static inline struct led_classdev_mc *lcdev_to_mccdev(
+                        struct led_classdev *lcdev)
+{
+    return container_of(lcdev, struct led_classdev_mc, led_cdev);
+}
+
+/**
+ * led_classdev_multicolor_register_ext - register a new object of

led_classdev
+ *                      class with support for multicolor LEDs
+ * @parent: the multicolor LED to register

Quoted 8 lines

Quoted 6 lines

+ * @mcled_cdev: the led_classdev_mc structure for this device
+ * @init_data: the LED class Multi color device initialization data
+ *
+ * Returns: 0 on success or negative error value on failure
+ */
+extern int led_classdev_multicolor_register_ext(struct device *parent,

extern is implied by default for functions. We need also to do this cleanup in leds.h soem day.

For clarity we can remove extern from all the APIs in the header?

Quoted 33 lines

Quoted 33 lines

+                        struct led_classdev_mc *mcled_cdev, +                        struct led_init_data *init_data);

include/linux/led-class-multicolor.h new file +6 -0

+
+#define led_classdev_multicolor_register(parent, mcled_cdev)        \
+    led_classdev_multicolor_register_ext(parent, mcled_cdev, NULL)
+
+/**
+ * led_classdev_multicolor_unregister - unregisters an object of

led_classdev
+ *                    class with support for multicolor LEDs
+ * @mcled_cdev: the multicolor LED to unregister
+ *
+ * Unregister a previously registered via led_classdev_multicolor_register
+ * object
+ */
+extern void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);

include/linux/led-class-multicolor.h new file +5 -0

+
+extern int devm_led_classdev_multicolor_register(struct device *parent,
+                    struct led_classdev_mc *mcled_cdev);
+
+extern void devm_led_classdev_multicolor_unregister(struct device

*parent,
+                       struct led_classdev_mc *mcled_cdev);

include/linux/led-class-multicolor.h new file +7 -0

+
+/* Set brightness for the monochrome LED cluster */
+extern void led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+                enum led_brightness brightness,
+                int brightness_val[]);
+
+#endif    /* __LINUX_MULTICOLOR_LEDS_H_INCLUDED */

Introduce a multicolor class that groups colored LEDs within a LED node.

The framework allows for dynamically setting individual LEDs or setting brightness levels of LEDs and updating them virtually simultaneously.

Signed-off-by Dan Murphy <[email protected]>

---
 drivers/leds/Kconfig                 |  10 +
 drivers/leds/Makefile                |   1 +
 drivers/leds/led-class-multicolor.c  | 316 +++++++++++++++++++++++++++
 include/linux/led-class-multicolor.h |  76 +++++++
 4 files changed, 403 insertions(+)
 create mode 100644 drivers/leds/led-class-multicolor.c
 create mode 100644 include/linux/led-class-multicolor.h

drivers/leds/Kconfig +0 -0

index 6e7703fd03d0..cfb1ebb6517f 100644
@@ -30,6 +30,16 @@ config LEDS_CLASS_FLASH

drivers/leds/Kconfig +6 -0

+static int led_multicolor_init_color_dir(struct led_classdev_mc_data *data,
+					 struct led_classdev_mc *mcled_cdev)
+{
+	struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+	u32 color_id;
+	int ret;

drivers/leds/Kconfig +10 -0

+			ret = led_multicolor_init_color(data, mcled_cdev, i, j);
+			if (ret)
+				break;
+
+			j++;
+		}
+	}
+
+	return ret;
+}

Dan,

One more remark below.

Quoted 22 lines · Dan Murphy

Introduce a multicolor class that groups colored LEDs within a LED node.

The framework allows for dynamically setting individual LEDs or setting brightness levels of LEDs and updating them virtually simultaneously.

Signed-off-by Dan Murphy <[email protected]>

---
  drivers/leds/Kconfig                 |  10 +
  drivers/leds/Makefile                |   1 +
  drivers/leds/led-class-multicolor.c  | 316 +++++++++++++++++++++++++++
  include/linux/led-class-multicolor.h |  76 +++++++
  4 files changed, 403 insertions(+)

create mode 100644 drivers/leds/led-class-multicolor.c create mode 100644 include/linux/led-class-multicolor.h

drivers/leds/Kconfig +0 -0

index 6e7703fd03d0..cfb1ebb6517f 100644
@@ -30,6 +30,16 @@ config LEDS_CLASS_FLASH

[...]

Quoted 6 lines

drivers/leds/Kconfig +6 -0

+static int led_multicolor_init_color_dir(struct led_classdev_mc_data *data,
+					 struct led_classdev_mc *mcled_cdev)
+{
+	struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+	u32 color_id;
+	int ret;

drivers/leds/Kconfig

Quoted 10 lines

drivers/leds/Kconfig +10 -0

+	int i, j = 0;
+
+	data->mcled_cdev = mcled_cdev;
+
+	ret = sysfs_create_group(&led_cdev->dev->kobj, &led_color_group);
+	if (ret)
+		return ret;
+
+	for (i = 0; i < LED_COLOR_ID_MAX; i++) {
+		color_id = (mcled_cdev->available_colors & (1 << i));

Please use bitops for accessing available_colors.

drivers/leds/Kconfig

Quoted 1 line

drivers/leds/Kconfig +1 -0

+		if (color_id) {

Here you need: if (test_bit(i, &mcled_cdev->available_colors))

Quoted 10 lines

drivers/leds/Kconfig +10 -0

+			ret = led_multicolor_init_color(data, mcled_cdev, i, j);
+			if (ret)
+				break;
+
+			j++;
+		}
+	}
+
+	return ret;
+}

Introduce the bindings for the Texas Instruments LP5036, LP5030, LP5024, LP5018, LP5012 and LP5009 RGB LED device driver. The LP5036/30/24/18/12/9 can control RGB LEDs individually or as part of a control bank group. These devices have the ability to adjust the mixing control for the RGB LEDs to obtain different colors independent of the overall brightness of the LED grouping.

Datasheet:
http://www.ti.com/lit/ds/symlink/lp5012.pdf
http://www.ti.com/lit/ds/symlink/lp5024.pdf
http://www.ti.com/lit/ds/symlink/lp5036.pdf

Signed-off-by Dan Murphy <[email protected]>

---
 .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
 1 file changed, 148 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-lp50xx.txt

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +38 -0

new file mode 100644
index 000000000000..9d05f43042e0
@@ -0,0 +1,148 @@
+* Texas Instruments - LP5009/12/18/24/30/36 RGB LED driver
+
+The LP50XX is multi-channel, I2C RGB LED Drivers that can group RGB LEDs into
+a LED group or control them individually.
+
+The difference in these RGB LED drivers is the number of supported RGB modules.
+
+Required parent properties:
+	- compatible:
+		"ti,lp5009"
+		"ti,lp5012"
+		"ti,lp5018"
+		"ti,lp5024"
+		"ti,lp5030"
+		"ti,lp5036"
+	- reg :  I2C slave address
+		lp5009/12 - 0x28
+		lp5018/24 - 0x28
+		lp5030/36 - 0x30
+	- #address-cells : 1
+	- #size-cells : 0
+
+Optional parent properties:
+	- enable-gpios : gpio pin to enable/disable the device.
+	- vled-supply : LED supply
+
+Required child properties:
+	- #address-cells : 1
+	- #size-cells : 0
+	- reg : This is the LED module number.
+	- color : see Documentation/devicetree/bindings/leds/common.txt
+	- function : see Documentation/devicetree/bindings/leds/common.txt
+
+Required child properties only is LED modules will be banked:
+	- ti,led-bank : This property denotes the LED module numbers that will
+			be controlled as a single RGB cluster.  Each LED module
+			number will be controlled by a single LED class instance.
+			There can only be one instance of the ti,led-bank

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +100 -0

+
+LP5009 - 2 Total RGB cluster LED outputs 0-1
+LP5012 - 4 Total RGB cluster LED outputs 0-3
+LP5018 - 6 Total RGB cluster LED outputs 0-5
+LP5024 - 8 Total RGB cluster LED outputs 0-7
+LP5030 - 10 Total RGB cluster LED outputs 0-9
+LP5036 - 12 Total RGB cluster LED outputs 0-11
+
+Optional child properties:
+	- label : see Documentation/devicetree/bindings/leds/common.txt
+	- linux,default-trigger :
+	   see Documentation/devicetree/bindings/leds/common.txt
+
+Examples:
+led-controller@29 {
+	#address-cells = <1>;
+	#size-cells = <0>;
+	compatible = "ti,lp5024";
+	reg = <0x29>;
+	enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
+	vled-supply = <&vmmcsd_fixed>;
+
+	multi-led@1 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <1>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_STATUS;
+
+		led@3 {
+			reg = <3>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@4 {
+			reg = <4>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@5 {
+			reg = <5>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+
+	multi-led@2 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <2>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_STANDBY;
+		ti,led-bank = <2 3 5>;
+
+		led@6 {
+			reg = <0x6>;
+			color = <LED_COLOR_ID_RED>;
+			led-sources = <6 9 15>;
+		};
+
+		led@7 {
+			reg = <0x7>;
+			color = <LED_COLOR_ID_GREEN>;
+			led-sources = <7 10 16>;
+		};
+
+		led@8 {
+			reg = <0x8>;
+			color = <LED_COLOR_ID_BLUE>;
+			led-sources = <8 11 17>;
+		};
+	};
+
+	multi-led@4 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <4>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_ACTIVITY;
+
+		led@12 {
+			reg = <12>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@13 {
+			reg = <13>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@14 {
+			reg = <14>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+};
+
+For more product information please see the link below:
+http://www.ti.com/lit/ds/symlink/lp5012.pdf
+http://www.ti.com/lit/ds/symlink/lp5024.pdf
+http://www.ti.com/lit/ds/symlink/lp5036.pdf

Dan,

Quoted 65 lines · Dan Murphy

Introduce the bindings for the Texas Instruments LP5036, LP5030, LP5024, LP5018, LP5012 and LP5009 RGB LED device driver. The LP5036/30/24/18/12/9 can control RGB LEDs individually or as part of a control bank group. These devices have the ability to adjust the mixing control for the RGB LEDs to obtain different colors independent of the overall brightness of the LED grouping.

Datasheet:
http://www.ti.com/lit/ds/symlink/lp5012.pdf
http://www.ti.com/lit/ds/symlink/lp5024.pdf
http://www.ti.com/lit/ds/symlink/lp5036.pdf

Signed-off-by Dan Murphy <[email protected]>

---
  .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
  1 file changed, 148 insertions(+)

create mode 100644 Documentation/devicetree/bindings/leds/leds-lp50xx.txt

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +41 -0

new file mode 100644
index 000000000000..9d05f43042e0
@@ -0,0 +1,148 @@
+* Texas Instruments - LP5009/12/18/24/30/36 RGB LED driver
+
+The LP50XX is multi-channel, I2C RGB LED Drivers that can group RGB LEDs into
+a LED group or control them individually.
+
+The difference in these RGB LED drivers is the number of supported RGB modules.
+
+Required parent properties:
+	- compatible:
+		"ti,lp5009"
+		"ti,lp5012"
+		"ti,lp5018"
+		"ti,lp5024"
+		"ti,lp5030"
+		"ti,lp5036"
+	- reg :  I2C slave address
+		lp5009/12 - 0x28
+		lp5018/24 - 0x28
+		lp5030/36 - 0x30
+	- #address-cells : 1
+	- #size-cells : 0
+
+Optional parent properties:
+	- enable-gpios : gpio pin to enable/disable the device.
+	- vled-supply : LED supply
+
+Required child properties:
+	- #address-cells : 1
+	- #size-cells : 0
+	- reg : This is the LED module number.
+	- color : see Documentation/devicetree/bindings/leds/common.txt
+	- function : see Documentation/devicetree/bindings/leds/common.txt
+
+Required child properties only is LED modules will be banked:
+	- ti,led-bank : This property denotes the LED module numbers that will
+			be controlled as a single RGB cluster.  Each LED module
+			number will be controlled by a single LED class instance.
+			There can only be one instance of the ti,led-bank
+			property for each device node.
+
+Required grandchildren properties:

Documentation/devicetree/bindings/leds/leds-lp50xx.txt line 48

Quoted 7 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +7 -0

+	- reg : A single entry denoting the LED module that controls
+		the RGB cluster.
+	- color : see Documentation/devicetree/bindings/leds/leds-multicolor.txt
+	- led-sources : see Documentation/devicetree/bindings/leds/common.txt
+
+The LED outputs associated with the LED modules are defined in Table 1 of the
+corresponding data sheets.

We must enclose this information here.

Documentation/devicetree/bindings/leds/leds-lp50xx.txt line 50

Quoted 3 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +2 -0

+
+LP5009 - 2 Total RGB cluster LED outputs 0-1

Quoted 99 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +98 -0

+LP5012 - 4 Total RGB cluster LED outputs 0-3
+LP5018 - 6 Total RGB cluster LED outputs 0-5
+LP5024 - 8 Total RGB cluster LED outputs 0-7
+LP5030 - 10 Total RGB cluster LED outputs 0-9
+LP5036 - 12 Total RGB cluster LED outputs 0-11
+
+Optional child properties:
+	- label : see Documentation/devicetree/bindings/leds/common.txt
+	- linux,default-trigger :
+	   see Documentation/devicetree/bindings/leds/common.txt
+
+Examples:
+led-controller@29 {
+	#address-cells = <1>;
+	#size-cells = <0>;
+	compatible = "ti,lp5024";
+	reg = <0x29>;
+	enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
+	vled-supply = <&vmmcsd_fixed>;
+
+	multi-led@1 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <1>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_STATUS;
+
+		led@3 {
+			reg = <3>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@4 {
+			reg = <4>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@5 {
+			reg = <5>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+
+	multi-led@2 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <2>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_STANDBY;
+		ti,led-bank = <2 3 5>;
+
+		led@6 {
+			reg = <0x6>;
+			color = <LED_COLOR_ID_RED>;
+			led-sources = <6 9 15>;
+		};
+
+		led@7 {
+			reg = <0x7>;
+			color = <LED_COLOR_ID_GREEN>;
+			led-sources = <7 10 16>;
+		};
+
+		led@8 {
+			reg = <0x8>;
+			color = <LED_COLOR_ID_BLUE>;
+			led-sources = <8 11 17>;
+		};
+	};
+
+	multi-led@4 {
+		#address-cells = <1>;
+		#size-cells = <0>;
+		reg = <4>;
+		color = <LED_COLOR_ID_MULTI>;
+		function = LED_FUNCTION_ACTIVITY;
+
+		led@12 {
+			reg = <12>;
+			color = <LED_COLOR_ID_RED>;
+		};
+
+		led@13 {
+			reg = <13>;
+			color = <LED_COLOR_ID_GREEN>;
+		};
+
+		led@14 {
+			reg = <14>;
+			color = <LED_COLOR_ID_BLUE>;
+		};
+	};
+};
+
+For more product information please see the link below:
+http://www.ti.com/lit/ds/symlink/lp5012.pdf
+http://www.ti.com/lit/ds/symlink/lp5024.pdf
+http://www.ti.com/lit/ds/symlink/lp5036.pdf

Jacek

Quoted 77 lines · Jacek Anaszewski

Dan,

Quoted 74 lines · Dan Murphy

Introduce the bindings for the Texas Instruments LP5036, LP5030, LP5024, LP5018, LP5012 and LP5009 RGB LED device driver.  The LP5036/30/24/18/12/9
can control RGB LEDs individually or as part of a control bank group. These devices have the ability to adjust the mixing control for the RGB LEDs to obtain different colors independent of the overall brightness of the LED grouping.

Datasheet:
http://www.ti.com/lit/ds/symlink/lp5012.pdf
http://www.ti.com/lit/ds/symlink/lp5024.pdf
http://www.ti.com/lit/ds/symlink/lp5036.pdf

Signed-off-by Dan Murphy <[email protected]>

---
  .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++

  1 file changed, 148 insertions(+)

  create mode 100644 Documentation/devicetree/bindings/leds/leds-lp50xx.txt

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +3 -0

new file mode 100644
index 000000000000..9d05f43042e0
@@ -0,0 +1,148 @@
+* Texas Instruments - LP5009/12/18/24/30/36 RGB LED driver
+
+The LP50XX is multi-channel, I2C RGB LED Drivers that can group RGB

LEDs into

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +3 -0

+a LED group or control them individually.
+
+The difference in these RGB LED drivers is the number of supported

RGB modules.

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +29 -0

+
+Required parent properties:
+    - compatible:
+        "ti,lp5009"
+        "ti,lp5012"
+        "ti,lp5018"
+        "ti,lp5024"
+        "ti,lp5030"
+        "ti,lp5036"
+    - reg :  I2C slave address
+        lp5009/12 - 0x28
+        lp5018/24 - 0x28
+        lp5030/36 - 0x30
+    - #address-cells : 1
+    - #size-cells : 0
+
+Optional parent properties:
+    - enable-gpios : gpio pin to enable/disable the device.
+    - vled-supply : LED supply
+
+Required child properties:
+    - #address-cells : 1
+    - #size-cells : 0
+    - reg : This is the LED module number.
+    - color : see Documentation/devicetree/bindings/leds/common.txt
+    - function : see Documentation/devicetree/bindings/leds/common.txt
+
+Required child properties only is LED modules will be banked:
+    - ti,led-bank : This property denotes the LED module numbers

that will
+            be controlled as a single RGB cluster.  Each LED module +            number will be controlled by a single LED class instance. +            There can only be one instance of the ti,led-bank +            property for each device node.

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +5 -0

+
+Required grandchildren properties:
+    - reg : A single entry denoting the LED module that controls
+        the RGB cluster.
+    - color : see

Quoted 8 lines

Quoted 7 lines

Documentation/devicetree/bindings/leds/leds-multicolor.txt +    - led-sources : see Documentation/devicetree/bindings/leds/common.txt

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +2 -0

+
+The LED outputs associated with the LED modules are defined in Table

1 of the
+corresponding data sheets.

We must enclose this information here.

That will make this doc pretty messy especially with the LP5036 entries.

I would have to do ascii art to make it understandable and basically there is not a delta in the lesser devices in the outputs

I don't see value in reproducing this data sheet contents in the dt-bindings.

For example (LP5012) and then for the LP5036 multiply this by 3

Table 1.

Bank Number and LED Number Assignment
OUT NUMBER BANK NUMBER  RGB LED MODULE NUMBER OUT0                    Bank A
OUT1                    Bank B                        LED0 OUT2                    Bank C

OUT3                    Bank A
OUT4                    Bank B                        LED1 OUT5                    Bank C

OUT6                    Bank A
OUT7                    Bank B                        LED2 OUT8                    Bank C

OUT9 (LP5012 only) Bank A
OUT10 (LP5012 only) Bank B                  LED3
OUT11 (LP5012 only) Bank C

Quoted 2 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt

Quoted 2 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +2 -0

+
+LP5009 - 2 Total RGB cluster LED outputs 0-1

This should be 3 total not 2

Dan

Quoted 99 lines

Quoted 99 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +98 -0

+LP5012 - 4 Total RGB cluster LED outputs 0-3
+LP5018 - 6 Total RGB cluster LED outputs 0-5
+LP5024 - 8 Total RGB cluster LED outputs 0-7
+LP5030 - 10 Total RGB cluster LED outputs 0-9
+LP5036 - 12 Total RGB cluster LED outputs 0-11
+
+Optional child properties:
+    - label : see Documentation/devicetree/bindings/leds/common.txt
+    - linux,default-trigger :
+       see Documentation/devicetree/bindings/leds/common.txt
+
+Examples:
+led-controller@29 {
+    #address-cells = <1>;
+    #size-cells = <0>;
+    compatible = "ti,lp5024";
+    reg = <0x29>;
+    enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
+    vled-supply = <&vmmcsd_fixed>;
+
+    multi-led@1 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        reg = <1>;
+        color = <LED_COLOR_ID_MULTI>;
+        function = LED_FUNCTION_STATUS;
+
+        led@3 {
+            reg = <3>;
+            color = <LED_COLOR_ID_RED>;
+        };
+
+        led@4 {
+            reg = <4>;
+            color = <LED_COLOR_ID_GREEN>;
+        };
+
+        led@5 {
+            reg = <5>;
+            color = <LED_COLOR_ID_BLUE>;
+        };
+    };
+
+    multi-led@2 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        reg = <2>;
+        color = <LED_COLOR_ID_MULTI>;
+        function = LED_FUNCTION_STANDBY;
+        ti,led-bank = <2 3 5>;
+
+        led@6 {
+            reg = <0x6>;
+            color = <LED_COLOR_ID_RED>;
+            led-sources = <6 9 15>;
+        };
+
+        led@7 {
+            reg = <0x7>;
+            color = <LED_COLOR_ID_GREEN>;
+            led-sources = <7 10 16>;
+        };
+
+        led@8 {
+            reg = <0x8>;
+            color = <LED_COLOR_ID_BLUE>;
+            led-sources = <8 11 17>;
+        };
+    };
+
+    multi-led@4 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        reg = <4>;
+        color = <LED_COLOR_ID_MULTI>;
+        function = LED_FUNCTION_ACTIVITY;
+
+        led@12 {
+            reg = <12>;
+            color = <LED_COLOR_ID_RED>;
+        };
+
+        led@13 {
+            reg = <13>;
+            color = <LED_COLOR_ID_GREEN>;
+        };
+
+        led@14 {
+            reg = <14>;
+            color = <LED_COLOR_ID_BLUE>;
+        };
+    };
+};
+
+For more product information please see the link below:
+http://www.ti.com/lit/ds/symlink/lp5012.pdf
+http://www.ti.com/lit/ds/symlink/lp5024.pdf
+http://www.ti.com/lit/ds/symlink/lp5036.pdf

Dan,

Quoted 88 lines · Dan Murphy

Jacek

Quoted 77 lines · Jacek Anaszewski

Dan,

Quoted 74 lines · Dan Murphy

Introduce the bindings for the Texas Instruments LP5036, LP5030, LP5024, LP5018, LP5012 and LP5009 RGB LED device driver.  The LP5036/30/24/18/12/9
can control RGB LEDs individually or as part of a control bank group. These devices have the ability to adjust the mixing control for the RGB LEDs to obtain different colors independent of the overall brightness of the LED grouping.

Datasheet:
http://www.ti.com/lit/ds/symlink/lp5012.pdf
http://www.ti.com/lit/ds/symlink/lp5024.pdf
http://www.ti.com/lit/ds/symlink/lp5036.pdf

Signed-off-by Dan Murphy <[email protected]>

---
   .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
   1 file changed, 148 insertions(+)

  create mode 100644
Documentation/devicetree/bindings/leds/leds-lp50xx.txt

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +3 -0

new file mode 100644
index 000000000000..9d05f43042e0
@@ -0,0 +1,148 @@
+* Texas Instruments - LP5009/12/18/24/30/36 RGB LED driver
+
+The LP50XX is multi-channel, I2C RGB LED Drivers that can group RGB

LEDs into

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +3 -0

+a LED group or control them individually.
+
+The difference in these RGB LED drivers is the number of supported

RGB modules.

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +29 -0

+
+Required parent properties:
+    - compatible:
+        "ti,lp5009"
+        "ti,lp5012"
+        "ti,lp5018"
+        "ti,lp5024"
+        "ti,lp5030"
+        "ti,lp5036"
+    - reg :  I2C slave address
+        lp5009/12 - 0x28
+        lp5018/24 - 0x28
+        lp5030/36 - 0x30
+    - #address-cells : 1
+    - #size-cells : 0
+
+Optional parent properties:
+    - enable-gpios : gpio pin to enable/disable the device.
+    - vled-supply : LED supply
+
+Required child properties:
+    - #address-cells : 1
+    - #size-cells : 0
+    - reg : This is the LED module number.
+    - color : see Documentation/devicetree/bindings/leds/common.txt
+    - function : see Documentation/devicetree/bindings/leds/common.txt
+
+Required child properties only is LED modules will be banked:
+    - ti,led-bank : This property denotes the LED module numbers

that will
+            be controlled as a single RGB cluster.  Each LED module +            number will be controlled by a single LED class instance. +            There can only be one instance of the ti,led-bank +            property for each device node.

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +5 -0

+
+Required grandchildren properties:
+    - reg : A single entry denoting the LED module that controls
+        the RGB cluster.
+    - color : see

Quoted 8 lines

Quoted 7 lines

Documentation/devicetree/bindings/leds/leds-multicolor.txt +    - led-sources : see Documentation/devicetree/bindings/leds/common.txt

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +2 -0

+
+The LED outputs associated with the LED modules are defined in Table

1 of the
+corresponding data sheets.

We must enclose this information here.

Quoted 7 lines

That will make this doc pretty messy especially with the LP5036 entries.

I would have to do ascii art to make it understandable and basically there is not a delta in the lesser devices in the outputs

I don't see value in reproducing this data sheet contents in the dt-bindings.

IMO DT bindings should be self-contained. We cannot assume that user will always have Internet access.

Quoted 18 lines

For example (LP5012) and then for the LP5036 multiply this by 3

Table 1.

Bank Number and LED Number Assignment
OUT NUMBER BANK NUMBER  RGB LED MODULE NUMBER OUT0                    Bank A
OUT1                    Bank B                        LED0 OUT2                    Bank C

OUT3                    Bank A
OUT4                    Bank B                        LED1 OUT5                    Bank C

OUT6                    Bank A
OUT7                    Bank B                        LED2 OUT8                    Bank C

Quoted 3 lines

OUT9 (LP5012 only) Bank A
OUT10 (LP5012 only) Bank B                  LED3
OUT11 (LP5012 only) Bank C

I'd say it is required. But let's wait for DT guys' opinion.

Quoted 105 lines

Quoted 2 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt

Quoted 2 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +2 -0

+
+LP5009 - 2 Total RGB cluster LED outputs 0-1

This should be 3 total not 2

Dan

Quoted 99 lines

Quoted 99 lines

Documentation/devicetree/bindings/leds/leds-lp50xx.txt new file +98 -0

+LP5012 - 4 Total RGB cluster LED outputs 0-3
+LP5018 - 6 Total RGB cluster LED outputs 0-5
+LP5024 - 8 Total RGB cluster LED outputs 0-7
+LP5030 - 10 Total RGB cluster LED outputs 0-9
+LP5036 - 12 Total RGB cluster LED outputs 0-11
+
+Optional child properties:
+    - label : see Documentation/devicetree/bindings/leds/common.txt
+    - linux,default-trigger :
+       see Documentation/devicetree/bindings/leds/common.txt
+
+Examples:
+led-controller@29 {
+    #address-cells = <1>;
+    #size-cells = <0>;
+    compatible = "ti,lp5024";
+    reg = <0x29>;
+    enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
+    vled-supply = <&vmmcsd_fixed>;
+
+    multi-led@1 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        reg = <1>;
+        color = <LED_COLOR_ID_MULTI>;
+        function = LED_FUNCTION_STATUS;
+
+        led@3 {
+            reg = <3>;
+            color = <LED_COLOR_ID_RED>;
+        };
+
+        led@4 {
+            reg = <4>;
+            color = <LED_COLOR_ID_GREEN>;
+        };
+
+        led@5 {
+            reg = <5>;
+            color = <LED_COLOR_ID_BLUE>;
+        };
+    };
+
+    multi-led@2 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        reg = <2>;
+        color = <LED_COLOR_ID_MULTI>;
+        function = LED_FUNCTION_STANDBY;
+        ti,led-bank = <2 3 5>;
+
+        led@6 {
+            reg = <0x6>;
+            color = <LED_COLOR_ID_RED>;
+            led-sources = <6 9 15>;
+        };
+
+        led@7 {
+            reg = <0x7>;
+            color = <LED_COLOR_ID_GREEN>;
+            led-sources = <7 10 16>;
+        };
+
+        led@8 {
+            reg = <0x8>;
+            color = <LED_COLOR_ID_BLUE>;
+            led-sources = <8 11 17>;
+        };
+    };
+
+    multi-led@4 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        reg = <4>;
+        color = <LED_COLOR_ID_MULTI>;
+        function = LED_FUNCTION_ACTIVITY;
+
+        led@12 {
+            reg = <12>;
+            color = <LED_COLOR_ID_RED>;
+        };
+
+        led@13 {
+            reg = <13>;
+            color = <LED_COLOR_ID_GREEN>;
+        };
+
+        led@14 {
+            reg = <14>;
+            color = <LED_COLOR_ID_BLUE>;
+        };
+    };
+};
+
+For more product information please see the link below:
+http://www.ti.com/lit/ds/symlink/lp5012.pdf
+http://www.ti.com/lit/ds/symlink/lp5024.pdf
+http://www.ti.com/lit/ds/symlink/lp5036.pdf

Introduce the LP5036/30/24/18/12/9 RGB LED driver. The difference in these parts are the number of LED outputs where the:

LP5036 can control 36 LEDs
LP5030 can control 30 LEDs
LP5024 can control 24 LEDs
LP5018 can control 18 LEDs
LP5012 can control 12 LEDs
LP509 can control 9 LEDs

The device has the ability to group LED output into control banks so that multiple LED banks can be controlled with the same mixing and brightness. Inversely the LEDs can also be controlled independently.

Signed-off-by Dan Murphy <[email protected]>

---
 drivers/leds/Kconfig       |   7 +
 drivers/leds/Makefile      |   1 +
 drivers/leds/leds-lp50xx.c | 785 +++++++++++++++++++++++++++++++++++++
 3 files changed, 793 insertions(+)
 create mode 100644 drivers/leds/leds-lp50xx.c

drivers/leds/Kconfig +0 -0

index cfb1ebb6517f..1c0cacb100e6 100644

drivers/leds/Kconfig +1 -0

+
 config LEDS_LP55XX_COMMON
 	tristate "Common Driver for TI/National LP5521/5523/55231/5562/8501"
 	depends on LEDS_LP5521 || LEDS_LP5523 || LEDS_LP5562 || LEDS_LP8501

drivers/leds/Makefile +1 -0

index 841038cfe35b..7a208a0f7b84 100644
@@ -34,6 +34,7 @@ obj-$(CONFIG_LEDS_GPIO_REGISTER)	+= leds-gpio-register.o
 obj-$(CONFIG_LEDS_GPIO)			+= leds-gpio.o
 obj-$(CONFIG_LEDS_LP3944)		+= leds-lp3944.o
 obj-$(CONFIG_LEDS_LP3952)		+= leds-lp3952.o
+obj-$(CONFIG_LEDS_LP50XX)		+= leds-lp50xx.o
 obj-$(CONFIG_LEDS_LP55XX_COMMON)	+= leds-lp55xx-common.o
 obj-$(CONFIG_LEDS_LP5521)		+= leds-lp5521.o
 obj-$(CONFIG_LEDS_LP5523)		+= leds-lp5523.o

drivers/leds/leds-lp50xx.c new file +149 -0

new file mode 100644
index 000000000000..3ddc14f53eae
@@ -0,0 +1,785 @@
+// SPDX-License-Identifier: GPL-2.0
+// TI LP50XX LED chip family driver
+// Copyright (C) 2018 Texas Instruments Incorporated - http://www.ti.com/
+
+#include <linux/gpio/consumer.h>
+#include <linux/i2c.h>
+#include <linux/init.h>
+#include <linux/leds.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/of.h>
+#include <linux/of_gpio.h>
+#include <linux/regmap.h>
+#include <linux/regulator/consumer.h>
+#include <linux/slab.h>
+#include <uapi/linux/uleds.h>
+
+#include <linux/led-class-multicolor.h>
+
+#define LP50XX_DEV_CFG0		0x00
+#define LP50XX_DEV_CFG1		0x01
+#define LP50XX_LED_CFG0		0x02
+
+/* LP5009 and LP5012 registers */
+#define LP5012_BNK_BRT		0x03
+#define LP5012_BNKA_CLR		0x04
+#define LP5012_BNKB_CLR		0x05
+#define LP5012_BNKC_CLR		0x06
+#define LP5012_LED0_BRT		0x07
+#define LP5012_LED1_BRT		0x08
+#define LP5012_LED2_BRT		0x09
+#define LP5012_LED3_BRT		0x0a
+#define LP5012_OUT0_CLR		0x0b
+#define LP5012_OUT1_CLR		0x0c
+#define LP5012_OUT2_CLR		0x0d
+#define LP5012_OUT3_CLR		0x0e
+#define LP5012_OUT4_CLR		0x0f
+#define LP5012_OUT5_CLR		0x10
+#define LP5012_OUT6_CLR		0x11
+#define LP5012_OUT7_CLR		0x12
+#define LP5012_OUT8_CLR		0x13
+#define LP5012_OUT9_CLR		0x14
+#define LP5012_OUT10_CLR	0x15
+#define LP5012_OUT11_CLR	0x16
+#define LP5012_RESET		0x17
+
+/* LP5018 and LP5024 registers */
+#define LP5024_BNK_BRT		0x03
+#define LP5024_BNKA_CLR		0x04
+#define LP5024_BNKB_CLR		0x05
+#define LP5024_BNKC_CLR		0x06
+#define LP5024_LED0_BRT		0x07
+#define LP5024_LED1_BRT		0x08
+#define LP5024_LED2_BRT		0x09
+#define LP5024_LED3_BRT		0x0a
+#define LP5024_LED4_BRT		0x0b
+#define LP5024_LED5_BRT		0x0c
+#define LP5024_LED6_BRT		0x0d
+#define LP5024_LED7_BRT		0x0e
+
+#define LP5024_OUT0_CLR		0x0f
+#define LP5024_OUT1_CLR		0x10
+#define LP5024_OUT2_CLR		0x11
+#define LP5024_OUT3_CLR		0x12
+#define LP5024_OUT4_CLR		0x13
+#define LP5024_OUT5_CLR		0x14
+#define LP5024_OUT6_CLR		0x15
+#define LP5024_OUT7_CLR		0x16
+#define LP5024_OUT8_CLR		0x17
+#define LP5024_OUT9_CLR		0x18
+#define LP5024_OUT10_CLR	0x19
+#define LP5024_OUT11_CLR	0x1a
+#define LP5024_OUT12_CLR	0x1b
+#define LP5024_OUT13_CLR	0x1c
+#define LP5024_OUT14_CLR	0x1d
+#define LP5024_OUT15_CLR	0x1e
+#define LP5024_OUT16_CLR	0x1f
+#define LP5024_OUT17_CLR	0x20
+#define LP5024_OUT18_CLR	0x21
+#define LP5024_OUT19_CLR	0x22
+#define LP5024_OUT20_CLR	0x23
+#define LP5024_OUT21_CLR	0x24
+#define LP5024_OUT22_CLR	0x25
+#define LP5024_OUT23_CLR	0x26
+#define LP5024_RESET		0x27
+
+/* LP5030 and LP5036 registers */
+#define LP5036_LED_CFG1		0x03
+#define LP5036_BNK_BRT		0x04
+#define LP5036_BNKA_CLR		0x05
+#define LP5036_BNKB_CLR		0x06
+#define LP5036_BNKC_CLR		0x07
+#define LP5036_LED0_BRT		0x08
+#define LP5036_LED1_BRT		0x09
+#define LP5036_LED2_BRT		0x0a
+#define LP5036_LED3_BRT		0x0b
+#define LP5036_LED4_BRT		0x0c
+#define LP5036_LED5_BRT		0x0d
+#define LP5036_LED6_BRT		0x0e
+#define LP5036_LED7_BRT		0x0f
+#define LP5036_LED8_BRT		0x10
+#define LP5036_LED9_BRT		0x11
+#define LP5036_LED10_BRT	0x12
+#define LP5036_LED11_BRT	0x13
+
+#define LP5036_OUT0_CLR		0x14
+#define LP5036_OUT1_CLR		0x15
+#define LP5036_OUT2_CLR		0x16
+#define LP5036_OUT3_CLR		0x17
+#define LP5036_OUT4_CLR		0x18
+#define LP5036_OUT5_CLR		0x19
+#define LP5036_OUT6_CLR		0x1a
+#define LP5036_OUT7_CLR		0x1b
+#define LP5036_OUT8_CLR		0x1c
+#define LP5036_OUT9_CLR		0x1d
+#define LP5036_OUT10_CLR	0x1e
+#define LP5036_OUT11_CLR	0x1f
+#define LP5036_OUT12_CLR	0x20
+#define LP5036_OUT13_CLR	0x21
+#define LP5036_OUT14_CLR	0x22
+#define LP5036_OUT15_CLR	0x23
+#define LP5036_OUT16_CLR	0x24
+#define LP5036_OUT17_CLR	0x25
+#define LP5036_OUT18_CLR	0x26
+#define LP5036_OUT19_CLR	0x27
+#define LP5036_OUT20_CLR	0x28
+#define LP5036_OUT21_CLR	0x29
+#define LP5036_OUT22_CLR	0x2a
+#define LP5036_OUT23_CLR	0x2b
+#define LP5036_OUT24_CLR	0x2c
+#define LP5036_OUT25_CLR	0x2d
+#define LP5036_OUT26_CLR	0x2e
+#define LP5036_OUT27_CLR	0x2f
+#define LP5036_OUT28_CLR	0x30
+#define LP5036_OUT29_CLR	0x31
+#define LP5036_OUT30_CLR	0x32
+#define LP5036_OUT31_CLR	0x33
+#define LP5036_OUT32_CLR	0x34
+#define LP5036_OUT33_CLR	0x35
+#define LP5036_OUT34_CLR	0x36
+#define LP5036_OUT35_CLR	0x37
+#define LP5036_RESET		0x38
+
+#define LP50XX_SW_RESET		0xff
+#define LP50XX_CHIP_EN		BIT(6)
+
+#define LP5009_MAX_LED_MODULES	2
+#define LP5012_MAX_LED_MODULES	4
+#define LP5018_MAX_LED_MODULES	6

drivers/leds/leds-lp50xx.c new file +183 -0

+ * @dev: Pointer to the devices device struct
+ * @lock: Lock for reading/writing the device
+ * @chip_info: chip specific information (ie num_leds)
+ * @num_of_banked_leds: holds the number of banked LEDs
+ * @leds: Array of LED strings
+ */
+struct lp50xx {
+	struct gpio_desc *enable_gpio;
+	struct regulator *regulator;
+	struct i2c_client *client;
+	struct regmap *regmap;
+	struct device *dev;
+	struct mutex lock;
+	const struct lp50xx_chip_info *chip_info;
+	int num_of_banked_leds;
+
+	/* This needs to be at the end of the struct */
+	struct lp50xx_led leds[];
+};
+
+static const struct reg_default lp5012_reg_defs[] = {
+	{LP50XX_DEV_CFG0, 0x0},
+	{LP50XX_DEV_CFG1, 0x3c},
+	{LP50XX_LED_CFG0, 0x0},
+	{LP5012_BNK_BRT, 0xff},
+	{LP5012_BNKA_CLR, 0x0f},
+	{LP5012_BNKB_CLR, 0x0f},
+	{LP5012_BNKC_CLR, 0x0f},
+	{LP5012_LED0_BRT, 0x0f},
+	{LP5012_LED1_BRT, 0xff},
+	{LP5012_LED2_BRT, 0xff},
+	{LP5012_LED3_BRT, 0xff},
+	{LP5012_OUT0_CLR, 0x0f},
+	{LP5012_OUT1_CLR, 0x00},
+	{LP5012_OUT2_CLR, 0x00},
+	{LP5012_OUT3_CLR, 0x00},
+	{LP5012_OUT4_CLR, 0x00},
+	{LP5012_OUT5_CLR, 0x00},
+	{LP5012_OUT6_CLR, 0x00},
+	{LP5012_OUT7_CLR, 0x00},
+	{LP5012_OUT8_CLR, 0x00},
+	{LP5012_OUT9_CLR, 0x00},
+	{LP5012_OUT10_CLR, 0x00},
+	{LP5012_OUT11_CLR, 0x00},
+	{LP5012_RESET, 0x00}
+};
+
+static const struct reg_default lp5024_reg_defs[] = {
+	{LP50XX_DEV_CFG0, 0x0},
+	{LP50XX_DEV_CFG1, 0x3c},
+	{LP50XX_LED_CFG0, 0x0},
+	{LP5024_BNK_BRT, 0xff},
+	{LP5024_BNKA_CLR, 0x0f},
+	{LP5024_BNKB_CLR, 0x0f},
+	{LP5024_BNKC_CLR, 0x0f},
+	{LP5024_LED0_BRT, 0x0f},
+	{LP5024_LED1_BRT, 0xff},
+	{LP5024_LED2_BRT, 0xff},
+	{LP5024_LED3_BRT, 0xff},
+	{LP5024_LED4_BRT, 0xff},
+	{LP5024_LED5_BRT, 0xff},
+	{LP5024_LED6_BRT, 0xff},
+	{LP5024_LED7_BRT, 0xff},
+	{LP5024_OUT0_CLR, 0x0f},
+	{LP5024_OUT1_CLR, 0x00},
+	{LP5024_OUT2_CLR, 0x00},
+	{LP5024_OUT3_CLR, 0x00},
+	{LP5024_OUT4_CLR, 0x00},
+	{LP5024_OUT5_CLR, 0x00},
+	{LP5024_OUT6_CLR, 0x00},
+	{LP5024_OUT7_CLR, 0x00},
+	{LP5024_OUT8_CLR, 0x00},
+	{LP5024_OUT9_CLR, 0x00},
+	{LP5024_OUT10_CLR, 0x00},
+	{LP5024_OUT11_CLR, 0x00},
+	{LP5024_OUT12_CLR, 0x00},
+	{LP5024_OUT13_CLR, 0x00},
+	{LP5024_OUT14_CLR, 0x00},
+	{LP5024_OUT15_CLR, 0x00},
+	{LP5024_OUT16_CLR, 0x00},
+	{LP5024_OUT17_CLR, 0x00},
+	{LP5024_OUT18_CLR, 0x00},
+	{LP5024_OUT19_CLR, 0x00},
+	{LP5024_OUT20_CLR, 0x00},
+	{LP5024_OUT21_CLR, 0x00},
+	{LP5024_OUT22_CLR, 0x00},
+	{LP5024_OUT23_CLR, 0x00},
+	{LP5024_RESET, 0x00}
+};
+
+static const struct reg_default lp5036_reg_defs[] = {
+	{LP50XX_DEV_CFG0, 0x0},
+	{LP50XX_DEV_CFG1, 0x3c},
+	{LP50XX_LED_CFG0, 0x0},
+	{LP5036_LED_CFG1, 0x0},
+	{LP5036_BNK_BRT, 0xff},
+	{LP5036_BNKA_CLR, 0x0f},
+	{LP5036_BNKB_CLR, 0x0f},
+	{LP5036_BNKC_CLR, 0x0f},
+	{LP5036_LED0_BRT, 0x0f},
+	{LP5036_LED1_BRT, 0xff},
+	{LP5036_LED2_BRT, 0xff},
+	{LP5036_LED3_BRT, 0xff},
+	{LP5036_LED4_BRT, 0xff},
+	{LP5036_LED5_BRT, 0xff},
+	{LP5036_LED6_BRT, 0xff},
+	{LP5036_LED7_BRT, 0xff},
+	{LP5036_OUT0_CLR, 0x0f},
+	{LP5036_OUT1_CLR, 0x00},
+	{LP5036_OUT2_CLR, 0x00},
+	{LP5036_OUT3_CLR, 0x00},
+	{LP5036_OUT4_CLR, 0x00},
+	{LP5036_OUT5_CLR, 0x00},
+	{LP5036_OUT6_CLR, 0x00},
+	{LP5036_OUT7_CLR, 0x00},
+	{LP5036_OUT8_CLR, 0x00},
+	{LP5036_OUT9_CLR, 0x00},
+	{LP5036_OUT10_CLR, 0x00},
+	{LP5036_OUT11_CLR, 0x00},
+	{LP5036_OUT12_CLR, 0x00},
+	{LP5036_OUT13_CLR, 0x00},
+	{LP5036_OUT14_CLR, 0x00},
+	{LP5036_OUT15_CLR, 0x00},
+	{LP5036_OUT16_CLR, 0x00},
+	{LP5036_OUT17_CLR, 0x00},
+	{LP5036_OUT18_CLR, 0x00},
+	{LP5036_OUT19_CLR, 0x00},
+	{LP5036_OUT20_CLR, 0x00},
+	{LP5036_OUT21_CLR, 0x00},
+	{LP5036_OUT22_CLR, 0x00},
+	{LP5036_OUT23_CLR, 0x00},
+	{LP5036_OUT24_CLR, 0x00},
+	{LP5036_OUT25_CLR, 0x00},
+	{LP5036_OUT26_CLR, 0x00},
+	{LP5036_OUT27_CLR, 0x00},
+	{LP5036_OUT28_CLR, 0x00},
+	{LP5036_OUT29_CLR, 0x00},
+	{LP5036_OUT30_CLR, 0x00},
+	{LP5036_OUT31_CLR, 0x00},
+	{LP5036_OUT32_CLR, 0x00},
+	{LP5036_OUT33_CLR, 0x00},
+	{LP5036_OUT34_CLR, 0x00},
+	{LP5036_OUT35_CLR, 0x00},
+	{LP5036_RESET, 0x00}
+};
+
+static const struct regmap_config lp5012_regmap_config = {
+	.reg_bits = 8,
+	.val_bits = 8,
+
+	.max_register = LP5012_RESET,
+	.reg_defaults = lp5012_reg_defs,
+	.num_reg_defaults = ARRAY_SIZE(lp5012_reg_defs),
+	.cache_type = REGCACHE_RBTREE,
+};
+
+static const struct regmap_config lp5024_regmap_config = {
+	.reg_bits = 8,
+	.val_bits = 8,
+
+	.max_register = LP5024_RESET,
+	.reg_defaults = lp5024_reg_defs,
+	.num_reg_defaults = ARRAY_SIZE(lp5024_reg_defs),
+	.cache_type = REGCACHE_RBTREE,
+};
+
+static const struct regmap_config lp5036_regmap_config = {
+	.reg_bits = 8,
+	.val_bits = 8,
+
+	.max_register = LP5036_RESET,
+	.reg_defaults = lp5036_reg_defs,
+	.num_reg_defaults = ARRAY_SIZE(lp5036_reg_defs),
+	.cache_type = REGCACHE_RBTREE,
+};
+
+enum lp50xx_model {
+	LP5009,
+	LP5012,
+	LP5018,
+	LP5024,
+	LP5030,
+	LP5036,

drivers/leds/leds-lp50xx.c new file +67 -0

+ */
+struct lp50xx_chip_info {
+	struct regmap_config lp50xx_regmap_config;
+	u8 num_leds;
+	u8 led_brightness0_reg;
+	u8 mix_out0_reg;
+	u8 bank_brt_reg;
+	u8 bank_mix_reg;
+	u8 reset_reg;
+};
+
+static const struct lp50xx_chip_info lp50xx_chip_info_tbl[] = {
+	[LP5009] = {
+		.num_leds = LP5009_MAX_LED_MODULES,
+		.led_brightness0_reg = LP5012_LED0_BRT,
+		.mix_out0_reg = LP5012_OUT0_CLR,
+		.bank_brt_reg = LP5012_BNK_BRT,
+		.bank_mix_reg = LP5012_BNKA_CLR,
+		.reset_reg = LP5012_RESET,
+		.lp50xx_regmap_config = lp5012_regmap_config,
+	},
+	[LP5012] = {
+		.num_leds = LP5012_MAX_LED_MODULES,
+		.led_brightness0_reg = LP5012_LED0_BRT,
+		.mix_out0_reg = LP5012_OUT0_CLR,
+		.bank_brt_reg = LP5012_BNK_BRT,
+		.bank_mix_reg = LP5012_BNKA_CLR,
+		.reset_reg = LP5012_RESET,
+		.lp50xx_regmap_config = lp5012_regmap_config,
+	},
+	[LP5018] = {
+		.num_leds = LP5018_MAX_LED_MODULES,
+		.led_brightness0_reg = LP5024_LED0_BRT,
+		.mix_out0_reg = LP5024_OUT0_CLR,
+		.bank_brt_reg = LP5024_BNK_BRT,
+		.bank_mix_reg = LP5024_BNKA_CLR,
+		.reset_reg = LP5024_RESET,
+		.lp50xx_regmap_config = lp5024_regmap_config,
+	},
+	[LP5024] = {
+		.num_leds = LP5024_MAX_LED_MODULES,
+		.led_brightness0_reg = LP5024_LED0_BRT,
+		.mix_out0_reg = LP5024_OUT0_CLR,
+		.bank_brt_reg = LP5024_BNK_BRT,
+		.bank_mix_reg = LP5024_BNKA_CLR,
+		.reset_reg = LP5024_RESET,
+		.lp50xx_regmap_config = lp5024_regmap_config,
+	},
+	[LP5030] = {
+		.num_leds = LP5030_MAX_LED_MODULES,
+		.led_brightness0_reg = LP5036_LED0_BRT,
+		.mix_out0_reg = LP5036_OUT0_CLR,
+		.bank_brt_reg = LP5036_BNK_BRT,
+		.bank_mix_reg = LP5036_BNKA_CLR,
+		.reset_reg = LP5036_RESET,
+		.lp50xx_regmap_config = lp5036_regmap_config,
+	},
+	[LP5036] = {
+		.num_leds = LP5036_MAX_LED_MODULES,
+		.led_brightness0_reg = LP5036_LED0_BRT,
+		.mix_out0_reg = LP5036_OUT0_CLR,
+		.bank_brt_reg = LP5036_BNK_BRT,
+		.bank_mix_reg = LP5036_BNKA_CLR,
+		.reset_reg = LP5036_RESET,
+		.lp50xx_regmap_config = lp5036_regmap_config,
+	},
+};

drivers/leds/leds-lp50xx.c new file +49 -0

+	int i, ret = -EINVAL;
+
+	for (i = 0; i <= LED_COLOR_ID_MAX; i++) {
+		if (!test_bit(i, &led->mc_cdev.available_colors))
+			continue;
+
+		if (i == LED_COLOR_ID_RED)
+			reg_color_off = 0;
+		else if (i == LED_COLOR_ID_GREEN)
+			reg_color_off = 1;
+		else if (i == LED_COLOR_ID_BLUE)
+			reg_color_off = 2;
+		else
+			continue;
+
+		if (led->ctrl_bank_enabled) {
+			reg_number = priv->chip_info->bank_mix_reg + reg_color_off;
+		} else {
+			led_offset = (led->led_number * 3)  + reg_color_off;
+			reg_number = priv->chip_info->mix_out0_reg + led_offset;
+		}
+
+		ret = regmap_write(priv->regmap, reg_number,
+				   led->led_intensity[i]);
+		if (ret) {
+			dev_err(&priv->client->dev, "Cannot write LED value\n");
+			goto out;
+		}
+	}
+out:
+	return ret;
+}
+
+static int lp50xx_brightness_set(struct led_classdev *cdev,
+			     enum led_brightness brightness)
+{
+	struct lp50xx_led *led = container_of(cdev, struct lp50xx_led, led_dev);
+	int ret = 0;
+	u8 reg_val;
+
+	mutex_lock(&led->priv->lock);
+
+	if (led->ctrl_bank_enabled)
+		reg_val = led->priv->chip_info->bank_brt_reg;
+	else
+		reg_val = led->priv->chip_info->led_brightness0_reg +
+			  led->led_number;
+
+	ret = regmap_write(led->priv->regmap, reg_val, brightness);