[PATCH v8 0/9] Multicolor FW v8 update

[PATCH v8 0/9] Multicolor FW v8 update

[Dan Murphy]

Hello

Per request I removed the ops structure.  But there is a potential need for some
device drivers to have a call back that sets the intesity of the LED color
without modifying the hardware register.  The hardware registers are only updated
when the brightness_set<op> is called.  The need arises with the LP50xx chip
series where the chip has 2 control knobs to modify the output current to the
LED.  In most cases drivers only have a single brightness register for a given
iOUT pin.  But the LP50xx has a brightness register that controls cluster
brightness and individual registers to control the monochrome LED intensity.

The set_color_brightness call back has been simplified in the LP50xx device
driver so that it can cache the LED intensity in it's stack for a specific color
as opposed to having to call back into the MC FW for the current intensity which
made the driver complex.
Once the set_brightness<op> is called the driver can set the brightness and then
set the LED intensity registers if the driver has that ability.

Dan

Dan Murphy (9):
  leds: multicolor: Add sysfs interface definition
  documention: leds: Add multicolor class documentation
  dt: bindings: Add multicolor class dt bindings documention
  dt-bindings: leds: Add multicolor ID to the color ID list
  leds: Add multicolor ID to the color ID list
  leds: multicolor: Introduce a multicolor class definition
  dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers
  leds: lp50xx: Add the LP50XX family of the RGB LED driver
  leds: Update the lp55xx to use the multi color framework

 .../ABI/testing/sysfs-class-led-multicolor    |  43 +
 .../bindings/leds/leds-class-multicolor.txt   |  95 +++
 .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++
 Documentation/leds/index.rst                  |   1 +
 Documentation/leds/leds-class-multicolor.rst  |  91 ++
 drivers/leds/Kconfig                          |  17 +
 drivers/leds/Makefile                         |   2 +
 drivers/leds/led-class-multicolor.c           | 316 +++++++
 drivers/leds/led-core.c                       |   1 +
 drivers/leds/leds-lp50xx.c                    | 785 ++++++++++++++++++
 drivers/leds/leds-lp5523.c                    |  13 +
 drivers/leds/leds-lp55xx-common.c             | 131 ++-
 drivers/leds/leds-lp55xx-common.h             |   9 +
 include/dt-bindings/leds/common.h             |   3 +-
 include/linux/led-class-multicolor.h          |  76 ++
 include/linux/platform_data/leds-lp55xx.h     |   6 +
 16 files changed, 1714 insertions(+), 23 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor
 create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
 create mode 100644 Documentation/devicetree/bindings/leds/leds-lp50xx.txt
 create mode 100644 Documentation/leds/leds-class-multicolor.rst
 create mode 100644 drivers/leds/led-class-multicolor.c
 create mode 100644 drivers/leds/leds-lp50xx.c
 create mode 100644 include/linux/led-class-multicolor.h

-- 
2.22.0.214.g8dca754b1e

[PATCH v8 1/9] leds: multicolor: Add sysfs interface definition

[Dan Murphy]

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

Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
 .../ABI/testing/sysfs-class-led-multicolor    | 43 +++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor

diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
new file mode 100644
index 000000000000..39fc73becfec
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
@@ -0,0 +1,43 @@
+What:		/sys/class/leds/<led>/brightness
+Date:		Sept 2019
+KernelVersion:	5.5
+Contact:	Dan Murphy <dmurphy@ti.com>
+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
+
+		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
+Date:		Sept 2019
+KernelVersion:	5.5
+Contact:	Dan Murphy <dmurphy@ti.com>
+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.
+
+		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
+Date:		Sept 2019
+KernelVersion:	5.5
+Contact:	Dan Murphy <dmurphy@ti.com>
+Description:	read only
+		Maximum intensity level for the LED color, default is
+		255 (LED_FULL).
+
+		If the LED does not support different intensity levels, this
+		should be 1.
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 1/9] leds: multicolor: Add sysfs interface definition

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> Add a documentation of LED Multicolor LED class specific
> sysfs attributes.
> 
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  .../ABI/testing/sysfs-class-led-multicolor    | 43 +++++++++++++++++++
>  1 file changed, 43 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
> new file mode 100644
> index 000000000000..39fc73becfec
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
> @@ -0,0 +1,43 @@
> +What:		/sys/class/leds/<led>/brightness
> +Date:		Sept 2019
> +KernelVersion:	5.5
> +Contact:	Dan Murphy <dmurphy@ti.com>
> +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

> +
> +		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/

> +Date:		Sept 2019
> +KernelVersion:	5.5
> +Contact:	Dan Murphy <dmurphy@ti.com>
> +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.

> +
> +		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
> +Date:		Sept 2019
> +KernelVersion:	5.5
> +Contact:	Dan Murphy <dmurphy@ti.com>
> +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.

> +
> +		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.

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 1/9] leds: multicolor: Add sysfs interface definition

[Dan Murphy]

Jacek

Thanks for the review

On 9/21/19 5:55 AM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/20/19 7:41 PM, Dan Murphy wrote:
>> Add a documentation of LED Multicolor LED class specific
>> sysfs attributes.
>>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>>   .../ABI/testing/sysfs-class-led-multicolor    | 43 +++++++++++++++++++
>>   1 file changed, 43 insertions(+)
>>   create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor
>>
>> diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
>> new file mode 100644
>> index 000000000000..39fc73becfec
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
>> @@ -0,0 +1,43 @@
>> +What:		/sys/class/leds/<led>/brightness
>> +Date:		Sept 2019
>> +KernelVersion:	5.5
>> +Contact:	Dan Murphy <dmurphy@ti.com>
>> +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

Ack


>> +
>> +		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/

Ack


>> +Date:		Sept 2019
>> +KernelVersion:	5.5
>> +Contact:	Dan Murphy <dmurphy@ti.com>
>> +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.

I thought I updated this but I will re-write this

Ack


>> +
>> +		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
>> +Date:		Sept 2019
>> +KernelVersion:	5.5
>> +Contact:	Dan Murphy <dmurphy@ti.com>
>> +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.
>
Ack


>> +
>> +		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.
>
Ack


Dan

[PATCH v8 2/9] documention: leds: Add multicolor class documentation

[Dan Murphy]

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 <dmurphy@ti.com>
---
 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

diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
index 060f4e485897..bc70c6aa7138 100644
--- a/Documentation/leds/index.rst
+++ b/Documentation/leds/index.rst
@@ -9,6 +9,7 @@ LEDs
 
    leds-class
    leds-class-flash
+   leds-class-multicolor
    ledtrig-oneshot
    ledtrig-transient
    ledtrig-usbport
diff --git a/Documentation/leds/leds-class-multicolor.rst b/Documentation/leds/leds-class-multicolor.rst
new file mode 100644
index 000000000000..063c9a411a1d
--- /dev/null
+++ b/Documentation/leds/leds-class-multicolor.rst
@@ -0,0 +1,91 @@
+====================================
+Multi Color LED handling under Linux
+====================================
+
+Description
+===========
+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.  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
+of a single LED or setting the intensity values of the LEDs in the group and
+updating the LEDs virtually simultaneously.
+
+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
+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
+
+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.
+
+led_brightness = requested_value * led_color_intensity/led_color_max_intensity
+
+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.
+
+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
+128
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 2/9] documention: leds: Add multicolor class documentation

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> 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.

> multicolor framework.  It also documents usage.
> 
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  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
> 
> diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
> index 060f4e485897..bc70c6aa7138 100644
> --- a/Documentation/leds/index.rst
> +++ b/Documentation/leds/index.rst
> @@ -9,6 +9,7 @@ LEDs
>  
>     leds-class
>     leds-class-flash
> +   leds-class-multicolor
>     ledtrig-oneshot
>     ledtrig-transient
>     ledtrig-usbport
> diff --git a/Documentation/leds/leds-class-multicolor.rst b/Documentation/leds/leds-class-multicolor.rst
> new file mode 100644
> index 000000000000..063c9a411a1d
> --- /dev/null
> +++ b/Documentation/leds/leds-class-multicolor.rst
> @@ -0,0 +1,91 @@
> +====================================
> +Multi Color LED handling under Linux
> +====================================
> +
> +Description
> +===========
> +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.

> 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.

> +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.

> +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.

> +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/

> +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
> +
> +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/

> +
> +led_brightness = requested_value * led_color_intensity/led_color_max_intensity

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

> +
> +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.
> +
> +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/

> +128
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 2/9] documention: leds: Add multicolor class documentation

[Dan Murphy]

Jacek

Thanks for the review

On 9/21/19 7:28 AM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/20/19 7:41 PM, Dan Murphy wrote:
>> 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.

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

Patch 3 are the dt-bindings which should be separated


>
>> multicolor framework.  It also documents usage.
>>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>>   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
>>
>> diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
>> index 060f4e485897..bc70c6aa7138 100644
>> --- a/Documentation/leds/index.rst
>> +++ b/Documentation/leds/index.rst
>> @@ -9,6 +9,7 @@ LEDs
>>   
>>      leds-class
>>      leds-class-flash
>> +   leds-class-multicolor
>>      ledtrig-oneshot
>>      ledtrig-transient
>>      ledtrig-usbport
>> diff --git a/Documentation/leds/leds-class-multicolor.rst b/Documentation/leds/leds-class-multicolor.rst
>> new file mode 100644
>> index 000000000000..063c9a411a1d
>> --- /dev/null
>> +++ b/Documentation/leds/leds-class-multicolor.rst
>> @@ -0,0 +1,91 @@
>> +====================================
>> +Multi Color LED handling under Linux
>> +====================================
>> +
>> +Description
>> +===========
>> +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.

Which application notes are you referring to?


>> 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.

Ack


>> +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.

I updated this from what you said below


>> +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.

Ack


>> +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/
Ack
>
>> +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
>> +
>> +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/

Ack


>> +
>> +led_brightness = requested_value * led_color_intensity/led_color_max_intensity
> led_brightness = brightness * <color>_intensity/<color>_max_intensity

Ack


>> +
>> +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.
>> +
>> +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/
>
Ack

Dan

>> +128
>>

Re: [PATCH v8 2/9] documention: leds: Add multicolor class documentation

[Jacek Anaszewski]

Dan,

On 9/23/19 4:50 PM, Dan Murphy wrote:
> Jacek
> 
> Thanks for the review
> 
> On 9/21/19 7:28 AM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 9/20/19 7:41 PM, Dan Murphy wrote:
>>> 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.
> 
> I think only patches 1 & 2 should be squashed into a single patch.
> 
> Patch 3 are the dt-bindings which should be separated

Right.

>>> multicolor framework.  It also documents usage.
>>>
>>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>>> ---
>>>   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
>>>
>>> diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
>>> index 060f4e485897..bc70c6aa7138 100644
>>> --- a/Documentation/leds/index.rst
>>> +++ b/Documentation/leds/index.rst
>>> @@ -9,6 +9,7 @@ LEDs
>>>        leds-class
>>>      leds-class-flash
>>> +   leds-class-multicolor
>>>      ledtrig-oneshot
>>>      ledtrig-transient
>>>      ledtrig-usbport
>>> diff --git a/Documentation/leds/leds-class-multicolor.rst
>>> b/Documentation/leds/leds-class-multicolor.rst
>>> new file mode 100644
>>> index 000000000000..063c9a411a1d
>>> --- /dev/null
>>> +++ b/Documentation/leds/leds-class-multicolor.rst
>>> @@ -0,0 +1,91 @@
>>> +====================================
>>> +Multi Color LED handling under Linux
>>> +====================================
>>> +
>>> +Description
>>> +===========
>>> +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.
> 
> Which application notes are you referring to?

I don't remember if it was titled exactly AN, but I do remember a sample
PCB design using RGB LEDs mounted circle-wise to achieve the demo
sample shown in the TI LP50xx presentation videos we were discussing
somewhere in last Jan/Feb/March.

-- 
Best regards,
Jacek Anaszewski

[PATCH v8 3/9] dt: bindings: Add multicolor class dt bindings documention

[Dan Murphy]

Add DT bindings for the LEDs multicolor class framework.

Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
 .../bindings/leds/leds-class-multicolor.txt   | 95 +++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.txt

diff --git a/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
new file mode 100644
index 000000000000..215d3c90f351
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
@@ -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.
+
+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>;
+		};
+	};
+
+};
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 3/9] dt: bindings: Add multicolor class dt bindings documention

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> Add DT bindings for the LEDs multicolor class framework.
> 
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  .../bindings/leds/leds-class-multicolor.txt   | 95 +++++++++++++++++++
>  1 file changed, 95 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
> 
> diff --git a/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
> new file mode 100644
> index 000000000000..215d3c90f351
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
> @@ -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.

> +
> +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>;
> +		};
> +	};
> +
> +};
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 3/9] dt: bindings: Add multicolor class dt bindings documention

[Dan Murphy]

Jacek

On 9/21/19 7:57 AM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/20/19 7:41 PM, Dan Murphy wrote:
>> Add DT bindings for the LEDs multicolor class framework.
>>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>>   .../bindings/leds/leds-class-multicolor.txt   | 95 +++++++++++++++++++
>>   1 file changed, 95 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
>>
>> diff --git a/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
>> new file mode 100644
>> index 000000000000..215d3c90f351
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
>> @@ -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.

Ack

Dan

>> +
>> +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>;
>> +		};
>> +	};
>> +
>> +};
>>

[PATCH v8 4/9] dt-bindings: leds: Add multicolor ID to the color ID list

[Dan Murphy]

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 <dmurphy@ti.com>
---
 include/dt-bindings/leds/common.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/dt-bindings/leds/common.h b/include/dt-bindings/leds/common.h
index 9e1256a7c1bf..7006d15f71e8 100644
--- a/include/dt-bindings/leds/common.h
+++ b/include/dt-bindings/leds/common.h
@@ -29,7 +29,8 @@
 #define LED_COLOR_ID_VIOLET	5
 #define LED_COLOR_ID_YELLOW	6
 #define LED_COLOR_ID_IR		7
-#define LED_COLOR_ID_MAX	8
+#define LED_COLOR_ID_MULTI	8
+#define LED_COLOR_ID_MAX	9
 
 /* Standard LED functions */
 #define LED_FUNCTION_ACTIVITY "activity"
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 4/9] dt-bindings: leds: Add multicolor ID to the color ID list

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> 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 <dmurphy@ti.com>
> ---
>  include/dt-bindings/leds/common.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/include/dt-bindings/leds/common.h b/include/dt-bindings/leds/common.h
> index 9e1256a7c1bf..7006d15f71e8 100644
> --- a/include/dt-bindings/leds/common.h
> +++ b/include/dt-bindings/leds/common.h
> @@ -29,7 +29,8 @@
>  #define LED_COLOR_ID_VIOLET	5
>  #define LED_COLOR_ID_YELLOW	6
>  #define LED_COLOR_ID_IR		7
> -#define LED_COLOR_ID_MAX	8
> +#define LED_COLOR_ID_MULTI	8
> +#define LED_COLOR_ID_MAX	9
>  
>  /* Standard LED functions */
>  #define LED_FUNCTION_ACTIVITY "activity"
> 

ack.

-- 
Best regards,
Jacek Anaszewski

[PATCH v8 5/9] leds: Add multicolor ID to the color ID list

[Dan Murphy]

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 <dmurphy@ti.com>
---
 drivers/leds/led-core.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/leds/led-core.c b/drivers/leds/led-core.c
index f1f718dbe0f8..846248a0693d 100644
--- a/drivers/leds/led-core.c
+++ b/drivers/leds/led-core.c
@@ -34,6 +34,7 @@ const char * const led_colors[LED_COLOR_ID_MAX] = {
 	[LED_COLOR_ID_VIOLET] = "violet",
 	[LED_COLOR_ID_YELLOW] = "yellow",
 	[LED_COLOR_ID_IR] = "ir",
+	[LED_COLOR_ID_MULTI] = "multicolor",
 };
 EXPORT_SYMBOL_GPL(led_colors);
 
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 5/9] leds: Add multicolor ID to the color ID list

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> 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 <dmurphy@ti.com>
> ---
>  drivers/leds/led-core.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/leds/led-core.c b/drivers/leds/led-core.c
> index f1f718dbe0f8..846248a0693d 100644
> --- a/drivers/leds/led-core.c
> +++ b/drivers/leds/led-core.c
> @@ -34,6 +34,7 @@ const char * const led_colors[LED_COLOR_ID_MAX] = {
>  	[LED_COLOR_ID_VIOLET] = "violet",
>  	[LED_COLOR_ID_YELLOW] = "yellow",
>  	[LED_COLOR_ID_IR] = "ir",
> +	[LED_COLOR_ID_MULTI] = "multicolor",
>  };
>  EXPORT_SYMBOL_GPL(led_colors);
>  
> 

ack.

-- 
Best regards,
Jacek Anaszewski

[PATCH v8 6/9] leds: multicolor: Introduce a multicolor class definition

[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 <dmurphy@ti.com>
---
 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

diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
index 6e7703fd03d0..cfb1ebb6517f 100644
--- a/drivers/leds/Kconfig
+++ b/drivers/leds/Kconfig
@@ -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
diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
index 2da39e896ce8..841038cfe35b 100644
--- a/drivers/leds/Makefile
+++ b/drivers/leds/Makefile
@@ -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
diff --git a/drivers/leds/led-class-multicolor.c b/drivers/leds/led-class-multicolor.c
new file mode 100644
index 000000000000..5e0e3fce482b
--- /dev/null
+++ b/drivers/leds/led-class-multicolor.c
@@ -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) {
+		ret = -EINVAL;
+		goto unlock;
+	}
+
+	priv->intensity = value;
+
+	if (mcled_cdev->set_color_brightness) {
+		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;
+
+	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;
+	}
+
+	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;
+	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));
+		if (color_id) {
+			ret = led_multicolor_init_color(data, mcled_cdev, i, j);
+			if (ret)
+				break;
+
+			j++;
+		}
+	}
+
+	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);
+}
+
+/**
+ * devm_of_led_classdev_register - resource managed led_classdev_register()
+ *
+ * @parent: parent of LED device
+ * @led_cdev: the led_classdev structure for this device.
+ */
+int devm_led_classdev_multicolor_register(struct device *parent,
+					  struct led_classdev_mc *mcled_cdev)
+{
+	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 <dmurphy@ti.com>");
+MODULE_DESCRIPTION("Multi Color LED class interface");
+MODULE_LICENSE("GPL v2");
diff --git a/include/linux/led-class-multicolor.h b/include/linux/led-class-multicolor.h
new file mode 100644
index 000000000000..afcaf429fba5
--- /dev/null
+++ b/include/linux/led-class-multicolor.h
@@ -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
+ * @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,
+					    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 */
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 6/9] leds: multicolor: Introduce a multicolor class definition

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> 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.

> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  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
> 
> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
> index 6e7703fd03d0..cfb1ebb6517f 100644
> --- a/drivers/leds/Kconfig
> +++ b/drivers/leds/Kconfig
> @@ -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
> diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
> index 2da39e896ce8..841038cfe35b 100644
> --- a/drivers/leds/Makefile
> +++ b/drivers/leds/Makefile
> @@ -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
> diff --git a/drivers/leds/led-class-multicolor.c b/drivers/leds/led-class-multicolor.c
> new file mode 100644
> index 000000000000..5e0e3fce482b
> --- /dev/null
> +++ b/drivers/leds/led-class-multicolor.c
> @@ -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) {
> +		ret = -EINVAL;
> +		goto unlock;
> +	}
> +
> +	priv->intensity = value;
> +
> +	if (mcled_cdev->set_color_brightness) {

We will not have this, as discussed.

> +		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;
> +
> +	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.

> +	}
> +
> +	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;
> +	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);

> +		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;

> +	}
> +
> +	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);
> +}
> +
> +/**
> + * 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.

> +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.

> +{
> +	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 <dmurphy@ti.com>");
> +MODULE_DESCRIPTION("Multi Color LED class interface");
> +MODULE_LICENSE("GPL v2");
> diff --git a/include/linux/led-class-multicolor.h b/include/linux/led-class-multicolor.h
> new file mode 100644
> index 000000000000..afcaf429fba5
> --- /dev/null
> +++ b/include/linux/led-class-multicolor.h
> @@ -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
> + * @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.

> +					    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 */
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 6/9] leds: multicolor: Introduce a multicolor class definition

[Dan Murphy]

Jacek

On 9/21/19 8:30 AM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/20/19 7:41 PM, Dan Murphy wrote:
>> 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.

Ack


>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>>   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
>>
>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
>> index 6e7703fd03d0..cfb1ebb6517f 100644
>> --- a/drivers/leds/Kconfig
>> +++ b/drivers/leds/Kconfig
>> @@ -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
>> diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
>> index 2da39e896ce8..841038cfe35b 100644
>> --- a/drivers/leds/Makefile
>> +++ b/drivers/leds/Makefile
>> @@ -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
>> diff --git a/drivers/leds/led-class-multicolor.c b/drivers/leds/led-class-multicolor.c
>> new file mode 100644
>> index 000000000000..5e0e3fce482b
>> --- /dev/null
>> +++ b/drivers/leds/led-class-multicolor.c
>> @@ -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) {
>> +		ret = -EINVAL;
>> +		goto unlock;
>> +	}
>> +
>> +	priv->intensity = value;
>> +
>> +	if (mcled_cdev->set_color_brightness) {
> We will not have this, as discussed.

Ack this will be removed in v9


>
>> +		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;
>> +
>> +	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.

Ack


>
>> +	}
>> +
>> +	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;
>> +	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);
>
>> +		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;

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


>
>> +	}
>> +
>> +	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);
>> +}
>> +
>> +/**
>> + * 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.


>> +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?


>
>> +{
>> +	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 <dmurphy@ti.com>");
>> +MODULE_DESCRIPTION("Multi Color LED class interface");
>> +MODULE_LICENSE("GPL v2");
>> diff --git a/include/linux/led-class-multicolor.h b/include/linux/led-class-multicolor.h
>> new file mode 100644
>> index 000000000000..afcaf429fba5
>> --- /dev/null
>> +++ b/include/linux/led-class-multicolor.h
>> @@ -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
>> + * @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?


Dan


>> +					    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 */
>>

Re: [PATCH v8 6/9] leds: multicolor: Introduce a multicolor class definition

[Jacek Anaszewski]

Dan,

On 9/23/19 5:14 PM, Dan Murphy wrote:
> Jacek
> 
> On 9/21/19 8:30 AM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 9/20/19 7:41 PM, Dan Murphy wrote:
>>> 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.
> 
[...]
>>> +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;
>>> +    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);
>>
>>> +        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;
> 
> Ack but responded to your follow up email on using bit ops.

Yeah, bitops will be better here.

>>> +    }
>>> +
>>> +    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);
>>> +}
>>> +
>>> +/**
>>> + * 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.
> 
> 
>>> +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?

Yes. We can always fallback to the old LED name initialization way
that uses struct led_classdev's name property by setting init_data
to NULL.

>>> +{
>>> +    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 <dmurphy@ti.com>");
>>> +MODULE_DESCRIPTION("Multi Color LED class interface");
>>> +MODULE_LICENSE("GPL v2");
>>> diff --git a/include/linux/led-class-multicolor.h
>>> b/include/linux/led-class-multicolor.h
>>> new file mode 100644
>>> index 000000000000..afcaf429fba5
>>> --- /dev/null
>>> +++ b/include/linux/led-class-multicolor.h
>>> @@ -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
>>> + * @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?

Yes, in a dedicated patch.

>>> +                        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 */
>>>
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 6/9] leds: multicolor: Introduce a multicolor class definition

[Jacek Anaszewski]

Dan,

One more remark below.

On 9/20/19 7:41 PM, Dan Murphy wrote:
> 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 <dmurphy@ti.com>
> ---
>  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
> 
> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
> index 6e7703fd03d0..cfb1ebb6517f 100644
> --- a/drivers/leds/Kconfig
> +++ b/drivers/leds/Kconfig
> @@ -30,6 +30,16 @@ config LEDS_CLASS_FLASH
[...]
> +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;
> +	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.

> +		if (color_id) {

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

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

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 6/9] leds: multicolor: Introduce a multicolor class definition

[Dan Murphy]

Jacek

On 9/21/19 1:08 PM, Jacek Anaszewski wrote:
> Dan,
>
> One more remark below.
>
> On 9/20/19 7:41 PM, Dan Murphy wrote:
>> 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 <dmurphy@ti.com>
>> ---
>>   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
>>
>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
>> index 6e7703fd03d0..cfb1ebb6517f 100644
>> --- a/drivers/leds/Kconfig
>> +++ b/drivers/leds/Kconfig
>> @@ -30,6 +30,16 @@ config LEDS_CLASS_FLASH
> [...]
>> +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;
>> +	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.
>
>> +		if (color_id) {
> Here you need: if (test_bit(i, &mcled_cdev->available_colors))

Then I can get rid of the color_id and just use test_bit.

Then your other request for color_mask is not needed because we can just 
test against the incremental 'i'

Dan

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

[PATCH v8 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers

[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 <dmurphy@ti.com>
---
 .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
 1 file changed, 148 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-lp50xx.txt

diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.txt b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
new file mode 100644
index 000000000000..9d05f43042e0
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
@@ -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:
+	- 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.
+
+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
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> 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 <dmurphy@ti.com>
> ---
>  .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
>  1 file changed, 148 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/leds/leds-lp50xx.txt
> 
> diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.txt b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
> new file mode 100644
> index 000000000000..9d05f43042e0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
> @@ -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:
> +	- 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.

> +
> +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
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers

[Dan Murphy]

Jacek

On 9/21/19 10:13 AM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/20/19 7:41 PM, Dan Murphy wrote:
>> 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 <dmurphy@ti.com>
>> ---
>>   .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
>>   1 file changed, 148 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>
>> diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.txt b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>> new file mode 100644
>> index 000000000000..9d05f43042e0
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>> @@ -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:
>> +	- 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.

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


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

This should be 3 total not 2

Dan

>> +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
>>

Re: [PATCH v8 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers

[Jacek Anaszewski]

Dan,

On 9/23/19 5:28 PM, Dan Murphy wrote:
> Jacek
> 
> On 9/21/19 10:13 AM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 9/20/19 7:41 PM, Dan Murphy wrote:
>>> 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 <dmurphy@ti.com>
>>> ---
>>>   .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
>>>   1 file changed, 148 insertions(+)
>>>   create mode 100644
>>> Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>
>>> diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>> b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>> new file mode 100644
>>> index 000000000000..9d05f43042e0
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>> @@ -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:
>>> +    - 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.
> 
> 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.

> 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


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


>>> +
>>> +LP5009 - 2 Total RGB cluster LED outputs 0-1
> 
> This should be 3 total not 2
> 
> Dan
> 
>>> +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
>>>
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers

[Dan Murphy]

Rob

On 9/23/19 4:42 PM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/23/19 5:28 PM, Dan Murphy wrote:
>> Jacek
>>
>> On 9/21/19 10:13 AM, Jacek Anaszewski wrote:
>>> Dan,
>>>
>>> On 9/20/19 7:41 PM, Dan Murphy wrote:
>>>> 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 <dmurphy@ti.com>
>>>> ---
>>>>    .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
>>>>    1 file changed, 148 insertions(+)
>>>>    create mode 100644
>>>> Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>> b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>> new file mode 100644
>>>> index 000000000000..9d05f43042e0
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>> @@ -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:
>>>> +    - 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.
>> 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.
>
>> 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
>
> I'd say it is required. But let's wait for DT guys' opinion.
>
Do you have an opinion on whether we need to publish in the DT the 
output to module map?

This is the last item I have to fix before submitting v9.

Dan


>>>> +
>>>> +LP5009 - 2 Total RGB cluster LED outputs 0-1
>> This should be 3 total not 2
>>
>> Dan
>>
>>>> +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
>>>>

Re: [PATCH v8 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers

[Dan Murphy]

Rob

On 9/23/19 4:42 PM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/23/19 5:28 PM, Dan Murphy wrote:
>> Jacek
>>
>> On 9/21/19 10:13 AM, Jacek Anaszewski wrote:
>>> Dan,
>>>
>>> On 9/20/19 7:41 PM, Dan Murphy wrote:
>>>> 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 <dmurphy@ti.com>
>>>> ---
>>>>    .../devicetree/bindings/leds/leds-lp50xx.txt  | 148 ++++++++++++++++++
>>>>    1 file changed, 148 insertions(+)
>>>>    create mode 100644
>>>> Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>> b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>> new file mode 100644
>>>> index 000000000000..9d05f43042e0
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.txt
>>>> @@ -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:
>>>> +    - 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.
>> 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.
>
>> 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
>
> I'd say it is required. But let's wait for DT guys' opinion.
>
Do you have an opinion on whether we need to publish in the DT the 
output to module map?

This is the last item I have to fix before submitting v9.

Dan


>>>> +
>>>> +LP5009 - 2 Total RGB cluster LED outputs 0-1
>> This should be 3 total not 2
>>
>> Dan
>>
>>>> +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
>>>>

[PATCH v8 8/9] leds: lp50xx: Add the LP50XX family of the RGB LED driver

[Dan Murphy]

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 <dmurphy@ti.com>
---
 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

diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
index cfb1ebb6517f..1c0cacb100e6 100644
--- a/drivers/leds/Kconfig
+++ b/drivers/leds/Kconfig
@@ -363,6 +363,13 @@ config LEDS_LP3952
 	  To compile this driver as a module, choose M here: the
 	  module will be called leds-lp3952.
 
+config LEDS_LP50XX
+	tristate "LED Support for TI LP5036/30/24/18 LED driver chip"
+	depends on LEDS_CLASS && REGMAP_I2C
+	help
+	  If you say yes here you get support for the Texas Instruments
+	  LP5036, LP5030, LP5024 and LP5018 LED driver.
+
 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
diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
index 841038cfe35b..7a208a0f7b84 100644
--- a/drivers/leds/Makefile
+++ b/drivers/leds/Makefile
@@ -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
diff --git a/drivers/leds/leds-lp50xx.c b/drivers/leds/leds-lp50xx.c
new file mode 100644
index 000000000000..3ddc14f53eae
--- /dev/null
+++ b/drivers/leds/leds-lp50xx.c
@@ -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
+#define LP5024_MAX_LED_MODULES	8
+#define LP5030_MAX_LED_MODULES	10
+#define LP5036_MAX_LED_MODULES	12
+
+struct lp50xx_led {
+	struct led_classdev led_dev;
+	struct led_classdev_mc mc_cdev;
+	struct lp50xx *priv;
+	unsigned long bank_modules;
+	int led_intensity[LED_COLOR_ID_MAX];
+	u8 ctrl_bank_enabled;
+	int led_number;
+};
+
+/**
+ * struct lp50xx -
+ * @enable_gpio: Hardware enable gpio
+ * @regulator: LED supply regulator pointer
+ * @client: Pointer to the I2C client
+ * @regmap: Devices register map
+ * @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,
+};
+
+/*
+ * struct lp50xx_chip_info -
+ * @num_leds: number of LED outputs available on the device
+ * @led_brightness0_reg: first brightness register of the device
+ * @mix_out0_reg: first color mix register of the device
+ * @bank_brt_reg: bank brightness register
+ * @bank_mix_reg: color mix register
+ * @reset_reg: devices reset register
+ */
+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,
+	},
+};
+
+static struct lp50xx_led *mcled_cdev_to_led(struct led_classdev_mc *mcled_cdev)
+{
+	return container_of(mcled_cdev, struct lp50xx_led, mc_cdev);
+}
+
+static int lp50xx_set_intensity(struct lp50xx_led *led)
+{
+	struct lp50xx *priv = led->priv;
+	u8 led_offset, reg_number, reg_color_off;
+	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);
+	if (ret)
+		goto err_out;
+
+	ret = lp50xx_set_intensity(led);
+err_out:
+	mutex_unlock(&led->priv->lock);
+	return ret;
+}
+
+static enum led_brightness lp50xx_brightness_get(struct led_classdev *cdev)
+{
+	struct lp50xx_led *led = container_of(cdev, struct lp50xx_led, led_dev);
+	unsigned int brt_val;
+	u8 reg_val;
+	int ret;
+
+	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_read(led->priv->regmap, reg_val, &brt_val);
+
+	mutex_unlock(&led->priv->lock);
+
+	return brt_val;
+}
+
+static int lp50xx_set_color(struct led_classdev_mc *mcled_cdev,
+			    int color, int value)
+{
+	struct lp50xx_led *led = mcled_cdev_to_led(mcled_cdev);
+
+	led->led_intensity[color] = value;
+
+	return 0;
+}
+
+static int lp50xx_set_banks(struct lp50xx *priv, u32 led_strings[])
+{
+	u8 led_ctrl_enable = 0;
+	u8 led1_ctrl_enable = 0;
+	u8 ctrl_ext = 0;
+	int ret;
+	int j;
+
+	for (j = 0; j <= priv->chip_info->num_leds - 1; j++) {
+		if (led_strings[j] > (LP5024_MAX_LED_MODULES - 1)) {
+			ctrl_ext = led_strings[j] - LP5024_MAX_LED_MODULES;
+			led1_ctrl_enable |= (1 << ctrl_ext);
+		} else {
+			led_ctrl_enable |= (1 << led_strings[j]);
+		}
+	}
+
+	ret = regmap_write(priv->regmap, LP50XX_LED_CFG0, led_ctrl_enable);
+
+	if (led1_ctrl_enable)
+		ret = regmap_write(priv->regmap, LP5036_LED_CFG1,
+				   led1_ctrl_enable);
+
+	return ret;
+}
+
+static int lp50xx_reset(struct lp50xx *priv)
+{
+	if (priv->enable_gpio)
+		return gpiod_direction_output(priv->enable_gpio, 1);
+	else
+		return regmap_write(priv->regmap, priv->chip_info->reset_reg,
+				    LP50XX_SW_RESET);
+}
+
+static int lp50xx_enable_disable(struct lp50xx *priv, u8 enable_disable)
+{
+	return regmap_write(priv->regmap, LP50XX_DEV_CFG0, enable_disable);
+}
+
+static int lp50xx_probe_dt(struct lp50xx *priv)
+{
+	u32 led_strings[LP5036_MAX_LED_MODULES];
+	struct fwnode_handle *child = NULL;
+	struct fwnode_handle *led_node = NULL;
+	struct led_init_data init_data;
+	struct lp50xx_led *led;
+	int num_colors;
+	u32 color_id;
+	int led_number;
+	size_t i = 0;
+	int ret;
+
+	priv->enable_gpio = devm_gpiod_get_optional(&priv->client->dev,
+						   "enable", GPIOD_OUT_LOW);
+	if (IS_ERR(priv->enable_gpio)) {
+		ret = PTR_ERR(priv->enable_gpio);
+		dev_err(&priv->client->dev, "Failed to get enable gpio: %d\n",
+			ret);
+		return ret;
+	}
+
+	priv->regulator = devm_regulator_get(&priv->client->dev, "vled");
+	if (IS_ERR(priv->regulator))
+		priv->regulator = NULL;
+
+	device_for_each_child_node(&priv->client->dev, child) {
+		led = &priv->leds[i];
+		if (fwnode_property_present(child, "ti,led-bank")) {
+			ret = fwnode_property_read_u32_array(child,
+							     "ti,led-bank",
+							     NULL, 0);
+			ret = fwnode_property_read_u32_array(child,
+							     "ti,led-bank",
+							     led_strings,
+							     ret);
+
+			priv->num_of_banked_leds = ARRAY_SIZE(led_strings);
+
+			ret = lp50xx_set_banks(priv, led_strings);
+			if (ret) {
+				dev_err(&priv->client->dev,
+					"Cannot setup banked LEDs\n");
+				fwnode_handle_put(child);
+				goto child_out;
+			}
+			led->ctrl_bank_enabled = 1;
+
+		} else {
+			ret = fwnode_property_read_u32(child, "reg",
+					       &led_number);
+
+			led->led_number = led_number;
+		}
+		if (ret) {
+			dev_err(&priv->client->dev,
+				"led sourcing property missing\n");
+			fwnode_handle_put(child);
+			goto child_out;
+		}
+
+		if (led_number > priv->chip_info->num_leds) {
+			dev_err(&priv->client->dev,
+				"led-sources property is invalid\n");
+			ret = -EINVAL;
+			fwnode_handle_put(child);
+			goto child_out;
+		}
+
+		init_data.fwnode = child;
+		init_data.devicename = priv->client->name;
+		init_data.default_label = ":";
+
+		fwnode_property_read_string(child, "linux,default-trigger",
+				    &led->led_dev.default_trigger);
+		num_colors = 0;
+
+		fwnode_for_each_child_node(child, led_node) {
+			ret = fwnode_property_read_u32(led_node, "color",
+						       &color_id);
+			if (ret)
+				dev_err(&priv->client->dev,
+				"Cannot read color\n");
+
+			set_bit(color_id, &led->mc_cdev.available_colors);
+			num_colors++;
+
+		}
+
+		led->priv = priv;
+		led->mc_cdev.set_color_brightness = lp50xx_set_color;
+		led->mc_cdev.num_leds = num_colors;
+		led->mc_cdev.led_cdev = &led->led_dev;
+		led->led_dev.brightness_set_blocking = lp50xx_brightness_set;
+		led->led_dev.brightness_get = lp50xx_brightness_get;
+		ret = led_classdev_multicolor_register_ext(&priv->client->dev,
+						       &led->mc_cdev,
+						       &init_data);
+		if (ret) {
+			dev_err(&priv->client->dev, "led register err: %d\n",
+				ret);
+			fwnode_handle_put(child);
+			goto child_out;
+		}
+		i++;
+	}
+
+child_out:
+	return ret;
+}
+
+static int lp50xx_probe(struct i2c_client *client,
+			const struct i2c_device_id *id)
+{
+	struct lp50xx *led;
+	int count;
+	int ret;
+
+	count = device_get_child_node_count(&client->dev);
+	if (!count) {
+		dev_err(&client->dev, "LEDs are not defined in device tree!");
+		return -ENODEV;
+	}
+
+	led = devm_kzalloc(&client->dev, struct_size(led, leds, count),
+			   GFP_KERNEL);
+	if (!led)
+		return -ENOMEM;
+
+	mutex_init(&led->lock);
+	led->client = client;
+	led->dev = &client->dev;
+	led->chip_info = &lp50xx_chip_info_tbl[id->driver_data];
+	i2c_set_clientdata(client, led);
+
+	led->regmap = devm_regmap_init_i2c(client,
+					&led->chip_info->lp50xx_regmap_config);
+	if (IS_ERR(led->regmap)) {
+		ret = PTR_ERR(led->regmap);
+		dev_err(&client->dev, "Failed to allocate register map: %d\n",
+			ret);
+		return ret;
+	}
+
+	ret = lp50xx_reset(led);
+	if (ret)
+		return ret;
+
+	ret = lp50xx_probe_dt(led);
+	if (ret)
+		return ret;
+
+	return lp50xx_enable_disable(led, LP50XX_CHIP_EN);
+}
+
+static int lp50xx_remove(struct i2c_client *client)
+{
+	struct lp50xx *led = i2c_get_clientdata(client);
+	int ret;
+
+	ret = lp50xx_enable_disable(led, LP50XX_CHIP_EN);
+	if (ret) {
+		dev_err(&led->client->dev, "Failed to disable regulator\n");
+		return ret;
+	}
+
+	if (led->enable_gpio)
+		gpiod_direction_output(led->enable_gpio, 0);
+
+	if (led->regulator) {
+		ret = regulator_disable(led->regulator);
+		if (ret)
+			dev_err(&led->client->dev,
+				"Failed to disable regulator\n");
+	}
+
+	mutex_destroy(&led->lock);
+
+	return 0;
+}
+
+static const struct i2c_device_id lp50xx_id[] = {
+	{ "lp5009", LP5009 },
+	{ "lp5012", LP5012 },
+	{ "lp5018", LP5018 },
+	{ "lp5024", LP5024 },
+	{ "lp5030", LP5030 },
+	{ "lp5036", LP5036 },
+	{ }
+};
+MODULE_DEVICE_TABLE(i2c, lp50xx_id);
+
+static const struct of_device_id of_lp50xx_leds_match[] = {
+	{ .compatible = "ti,lp5009", .data = (void *)LP5009 },
+	{ .compatible = "ti,lp5012", .data = (void *)LP5012 },
+	{ .compatible = "ti,lp5018", .data = (void *)LP5018 },
+	{ .compatible = "ti,lp5024", .data = (void *)LP5024 },
+	{ .compatible = "ti,lp5030", .data = (void *)LP5030 },
+	{ .compatible = "ti,lp5036", .data = (void *)LP5036 },
+	{},
+};
+MODULE_DEVICE_TABLE(of, of_lp50xx_leds_match);
+
+static struct i2c_driver lp50xx_driver = {
+	.driver = {
+		.name	= "lp50xx",
+		.of_match_table = of_lp50xx_leds_match,
+	},
+	.probe		= lp50xx_probe,
+	.remove		= lp50xx_remove,
+	.id_table	= lp50xx_id,
+};
+module_i2c_driver(lp50xx_driver);
+
+MODULE_DESCRIPTION("Texas Instruments LP50XX LED driver");
+MODULE_AUTHOR("Dan Murphy <dmurphy@ti.com>");
+MODULE_LICENSE("GPL v2");
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 8/9] leds: lp50xx: Add the LP50XX family of the RGB LED driver

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> 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 <dmurphy@ti.com>
> ---
>  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
> 
> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
> index cfb1ebb6517f..1c0cacb100e6 100644
> --- a/drivers/leds/Kconfig
> +++ b/drivers/leds/Kconfig
> @@ -363,6 +363,13 @@ config LEDS_LP3952
>  	  To compile this driver as a module, choose M here: the
>  	  module will be called leds-lp3952.
>  
> +config LEDS_LP50XX
> +	tristate "LED Support for TI LP5036/30/24/18 LED driver chip"
> +	depends on LEDS_CLASS && REGMAP_I2C

&& OF

> +	help
> +	  If you say yes here you get support for the Texas Instruments
> +	  LP5036, LP5030, LP5024 and LP5018 LED driver.

Please add also this standard sentence for a module.

> +
>  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
> diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
> index 841038cfe35b..7a208a0f7b84 100644
> --- a/drivers/leds/Makefile
> +++ b/drivers/leds/Makefile
> @@ -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
> diff --git a/drivers/leds/leds-lp50xx.c b/drivers/leds/leds-lp50xx.c
> new file mode 100644
> index 000000000000..3ddc14f53eae
> --- /dev/null
> +++ b/drivers/leds/leds-lp50xx.c
> @@ -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
> +#define LP5024_MAX_LED_MODULES	8
> +#define LP5030_MAX_LED_MODULES	10
> +#define LP5036_MAX_LED_MODULES	12
> +
> +struct lp50xx_led {
> +	struct led_classdev led_dev;
> +	struct led_classdev_mc mc_cdev;
> +	struct lp50xx *priv;
> +	unsigned long bank_modules;
> +	int led_intensity[LED_COLOR_ID_MAX];

This is waste of memory. There should be only three elements.

> +	u8 ctrl_bank_enabled;
> +	int led_number;
> +};
> +
> +/**
> + * struct lp50xx -
> + * @enable_gpio: Hardware enable gpio
> + * @regulator: LED supply regulator pointer
> + * @client: Pointer to the I2C client
> + * @regmap: Devices register map

Device or Device's ?

> + * @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,
> +};
> +
> +/*
> + * struct lp50xx_chip_info -
> + * @num_leds: number of LED outputs available on the device
> + * @led_brightness0_reg: first brightness register of the device
> + * @mix_out0_reg: first color mix register of the device
> + * @bank_brt_reg: bank brightness register
> + * @bank_mix_reg: color mix register
> + * @reset_reg: devices reset register

s/devices/device/

Please be consequent: I prefer starting the property description
always with lower case.

> + */
> +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,
> +	},
> +};
> +
> +static struct lp50xx_led *mcled_cdev_to_led(struct led_classdev_mc *mcled_cdev)
> +{
> +	return container_of(mcled_cdev, struct lp50xx_led, mc_cdev);
> +}
> +
> +static int lp50xx_set_intensity(struct lp50xx_led *led)
> +{
> +	struct lp50xx *priv = led->priv;
> +	u8 led_offset, reg_number, reg_color_off;

reg_color_off feels like "turning the color off"

Let's have full reg_color_offset form.

> +	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);
> +	if (ret)
> +		goto err_out;
> +
> +	ret = lp50xx_set_intensity(led);
> +err_out:
> +	mutex_unlock(&led->priv->lock);
> +	return ret;
> +}
> +
> +static enum led_brightness lp50xx_brightness_get(struct led_classdev *cdev)

Do we really need this op? Is it possible that the device will alter
brightness autonomously ? IOW can't we rely on what we've written
previously to the hw?

> +{
> +	struct lp50xx_led *led = container_of(cdev, struct lp50xx_led, led_dev);
> +	unsigned int brt_val;
> +	u8 reg_val;
> +	int ret;
> +
> +	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_read(led->priv->regmap, reg_val, &brt_val);
> +
> +	mutex_unlock(&led->priv->lock);
> +
> +	return brt_val;
> +}
> +
> +static int lp50xx_set_color(struct led_classdev_mc *mcled_cdev,
> +			    int color, int value)
> +{
> +	struct lp50xx_led *led = mcled_cdev_to_led(mcled_cdev);
> +
> +	led->led_intensity[color] = value;
> +
> +	return 0;
> +}
> +
> +static int lp50xx_set_banks(struct lp50xx *priv, u32 led_strings[])

This is a bit misleading to introduce "strings" when the function
claims to set "banks". Let's have the parameter name "led_banks".

> +{
> +	u8 led_ctrl_enable = 0;
> +	u8 led1_ctrl_enable = 0;
> +	u8 ctrl_ext = 0;

Let's have below instead of the above three variables:

	u32 bank_enable_mask = 0;
	u8 led_config_lo, led_config_hi;

> +	int ret;
> +	int j;

This is subjective, but why j? We usually have 'i' for one level loop.

> +
> +	for (j = 0; j <= priv->chip_info->num_leds - 1; j++) {
> +		if (led_strings[j] > (LP5024_MAX_LED_MODULES - 1)) {
> +			ctrl_ext = led_strings[j] - LP5024_MAX_LED_MODULES;
> +			led1_ctrl_enable |= (1 << ctrl_ext)> +		} else {
> +			led_ctrl_enable |= (1 << led_strings[j]);
> +		}
> +	}

This looks harder than it should be.

for (i = 0; i < priv->chip_info->num_leds; i++)
	bank_enable_mask |= (1 << led_banks[i]);

led_config_lo = (u8)(bank_enable_mask & 0xff);
led_config_hi = (u8)(bank_enable_mask >> 8) & 0xff);

> +
> +	ret = regmap_write(priv->regmap, LP50XX_LED_CFG0, led_ctrl_enable);

ret = regmap_write(priv->regmap, LP50XX_LED_CFG0, led_config_lo);
if (ret)
	return ret;

> +
> +	if (led1_ctrl_enable)
> +		ret = regmap_write(priv->regmap, LP5036_LED_CFG1,
> +				   led1_ctrl_enable);

if (led_config_hi)
	ret = regmap_write(priv->regmap, LP5036_LED_CFG1,
                           led_config_hi);


> +
> +	return ret;
> +}
> +
> +static int lp50xx_reset(struct lp50xx *priv)
> +{
> +	if (priv->enable_gpio)
> +		return gpiod_direction_output(priv->enable_gpio, 1);
> +	else
> +		return regmap_write(priv->regmap, priv->chip_info->reset_reg,
> +				    LP50XX_SW_RESET);
> +}
> +
> +static int lp50xx_enable_disable(struct lp50xx *priv, u8 enable_disable)
> +{
> +	return regmap_write(priv->regmap, LP50XX_DEV_CFG0, enable_disable);
> +}
> +
> +static int lp50xx_probe_dt(struct lp50xx *priv)
> +{
> +	u32 led_strings[LP5036_MAX_LED_MODULES];

s/led_strings/led_banks/

> +	struct fwnode_handle *child = NULL;
> +	struct fwnode_handle *led_node = NULL;
> +	struct led_init_data init_data;
> +	struct lp50xx_led *led;
> +	int num_colors;
> +	u32 color_id;
> +	int led_number;
> +	size_t i = 0;
> +	int ret;
> +
> +	priv->enable_gpio = devm_gpiod_get_optional(&priv->client->dev,
> +						   "enable", GPIOD_OUT_LOW);
> +	if (IS_ERR(priv->enable_gpio)) {
> +		ret = PTR_ERR(priv->enable_gpio);
> +		dev_err(&priv->client->dev, "Failed to get enable gpio: %d\n",
> +			ret);
> +		return ret;
> +	}
> +
> +	priv->regulator = devm_regulator_get(&priv->client->dev, "vled");
> +	if (IS_ERR(priv->regulator))
> +		priv->regulator = NULL;
> +
> +	device_for_each_child_node(&priv->client->dev, child) {
> +		led = &priv->leds[i];
> +		if (fwnode_property_present(child, "ti,led-bank")) {
> +			ret = fwnode_property_read_u32_array(child,
> +							     "ti,led-bank",
> +							     NULL, 0);
> +			ret = fwnode_property_read_u32_array(child,
> +							     "ti,led-bank",
> +							     led_strings,
> +							     ret);
> +
> +			priv->num_of_banked_leds = ARRAY_SIZE(led_strings);
> +
> +			ret = lp50xx_set_banks(priv, led_strings);
> +			if (ret) {
> +				dev_err(&priv->client->dev,
> +					"Cannot setup banked LEDs\n");
> +				fwnode_handle_put(child);
> +				goto child_out;
> +			}
> +			led->ctrl_bank_enabled = 1;
> +
> +		} else {
> +			ret = fwnode_property_read_u32(child, "reg",
> +					       &led_number);
> +
> +			led->led_number = led_number;
> +		}
> +		if (ret) {
> +			dev_err(&priv->client->dev,
> +				"led sourcing property missing\n");
> +			fwnode_handle_put(child);
> +			goto child_out;
> +		}
> +
> +		if (led_number > priv->chip_info->num_leds) {
> +			dev_err(&priv->client->dev,
> +				"led-sources property is invalid\n");
> +			ret = -EINVAL;
> +			fwnode_handle_put(child);
> +			goto child_out;
> +		}
> +
> +		init_data.fwnode = child;
> +		init_data.devicename = priv->client->name;
> +		init_data.default_label = ":";

devicename and default_label are for LEDs with mandatory devicename
and for backward compatibility. Neither is pertinent to this driver.

> +
> +		fwnode_property_read_string(child, "linux,default-trigger",
> +				    &led->led_dev.default_trigger);
> +		num_colors = 0;
> +
> +		fwnode_for_each_child_node(child, led_node) {
> +			ret = fwnode_property_read_u32(led_node, "color",
> +						       &color_id);
> +			if (ret)
> +				dev_err(&priv->client->dev,
> +				"Cannot read color\n");
> +
> +			set_bit(color_id, &led->mc_cdev.available_colors);
> +			num_colors++;
> +
> +		}
> +
> +		led->priv = priv;
> +		led->mc_cdev.set_color_brightness = lp50xx_set_color;
> +		led->mc_cdev.num_leds = num_colors;
> +		led->mc_cdev.led_cdev = &led->led_dev;
> +		led->led_dev.brightness_set_blocking = lp50xx_brightness_set;
> +		led->led_dev.brightness_get = lp50xx_brightness_get;
> +		ret = led_classdev_multicolor_register_ext(&priv->client->dev,
> +						       &led->mc_cdev,
> +						       &init_data);
> +		if (ret) {
> +			dev_err(&priv->client->dev, "led register err: %d\n",
> +				ret);
> +			fwnode_handle_put(child);
> +			goto child_out;
> +		}
> +		i++;
> +	}
> +
> +child_out:
> +	return ret;
> +}
> +
> +static int lp50xx_probe(struct i2c_client *client,
> +			const struct i2c_device_id *id)
> +{
> +	struct lp50xx *led;
> +	int count;
> +	int ret;
> +
> +	count = device_get_child_node_count(&client->dev);
> +	if (!count) {
> +		dev_err(&client->dev, "LEDs are not defined in device tree!");
> +		return -ENODEV;
> +	}
> +
> +	led = devm_kzalloc(&client->dev, struct_size(led, leds, count),
> +			   GFP_KERNEL);
> +	if (!led)
> +		return -ENOMEM;
> +
> +	mutex_init(&led->lock);
> +	led->client = client;
> +	led->dev = &client->dev;
> +	led->chip_info = &lp50xx_chip_info_tbl[id->driver_data];
> +	i2c_set_clientdata(client, led);
> +
> +	led->regmap = devm_regmap_init_i2c(client,
> +					&led->chip_info->lp50xx_regmap_config);
> +	if (IS_ERR(led->regmap)) {
> +		ret = PTR_ERR(led->regmap);
> +		dev_err(&client->dev, "Failed to allocate register map: %d\n",
> +			ret);
> +		return ret;
> +	}
> +
> +	ret = lp50xx_reset(led);
> +	if (ret)
> +		return ret;
> +
> +	ret = lp50xx_probe_dt(led);
> +	if (ret)
> +		return ret;
> +
> +	return lp50xx_enable_disable(led, LP50XX_CHIP_EN);
> +}
> +
> +static int lp50xx_remove(struct i2c_client *client)
> +{
> +	struct lp50xx *led = i2c_get_clientdata(client);
> +	int ret;
> +
> +	ret = lp50xx_enable_disable(led, LP50XX_CHIP_EN);
> +	if (ret) {
> +		dev_err(&led->client->dev, "Failed to disable regulator\n");
> +		return ret;
> +	}
> +
> +	if (led->enable_gpio)
> +		gpiod_direction_output(led->enable_gpio, 0);
> +
> +	if (led->regulator) {
> +		ret = regulator_disable(led->regulator);
> +		if (ret)
> +			dev_err(&led->client->dev,
> +				"Failed to disable regulator\n");
> +	}
> +
> +	mutex_destroy(&led->lock);
> +
> +	return 0;
> +}
> +
> +static const struct i2c_device_id lp50xx_id[] = {
> +	{ "lp5009", LP5009 },
> +	{ "lp5012", LP5012 },
> +	{ "lp5018", LP5018 },
> +	{ "lp5024", LP5024 },
> +	{ "lp5030", LP5030 },
> +	{ "lp5036", LP5036 },
> +	{ }
> +};
> +MODULE_DEVICE_TABLE(i2c, lp50xx_id);
> +
> +static const struct of_device_id of_lp50xx_leds_match[] = {
> +	{ .compatible = "ti,lp5009", .data = (void *)LP5009 },
> +	{ .compatible = "ti,lp5012", .data = (void *)LP5012 },
> +	{ .compatible = "ti,lp5018", .data = (void *)LP5018 },
> +	{ .compatible = "ti,lp5024", .data = (void *)LP5024 },
> +	{ .compatible = "ti,lp5030", .data = (void *)LP5030 },
> +	{ .compatible = "ti,lp5036", .data = (void *)LP5036 },
> +	{},
> +};
> +MODULE_DEVICE_TABLE(of, of_lp50xx_leds_match);
> +
> +static struct i2c_driver lp50xx_driver = {
> +	.driver = {
> +		.name	= "lp50xx",
> +		.of_match_table = of_lp50xx_leds_match,
> +	},
> +	.probe		= lp50xx_probe,
> +	.remove		= lp50xx_remove,
> +	.id_table	= lp50xx_id,
> +};
> +module_i2c_driver(lp50xx_driver);
> +
> +MODULE_DESCRIPTION("Texas Instruments LP50XX LED driver");
> +MODULE_AUTHOR("Dan Murphy <dmurphy@ti.com>");
> +MODULE_LICENSE("GPL v2");
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 8/9] leds: lp50xx: Add the LP50XX family of the RGB LED driver

[Dan Murphy]

Jacek

On 9/21/19 10:11 AM, Jacek Anaszewski wrote:
> Dan,
>
> On 9/20/19 7:41 PM, Dan Murphy wrote:
>> 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<dmurphy@ti.com>
>> ---
>>   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
>>
>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
>> index cfb1ebb6517f..1c0cacb100e6 100644
>> --- a/drivers/leds/Kconfig
>> +++ b/drivers/leds/Kconfig
>> @@ -363,6 +363,13 @@ config LEDS_LP3952
>>   	  To compile this driver as a module, choose M here: the
>>   	  module will be called leds-lp3952.
>>   
>> +config LEDS_LP50XX
>> +	tristate "LED Support for TI LP5036/30/24/18 LED driver chip"
>> +	depends on LEDS_CLASS && REGMAP_I2C
> && OF

Not sure why I would add that since we are using fw_node calls not 
of_property calls.

The fw_node calls are built in as default kernel so these should always 
be available.

Unless this is a led_class has a dependency


>> +	help
>> +	  If you say yes here you get support for the Texas Instruments
>> +	  LP5036, LP5030, LP5024 and LP5018 LED driver.
> Please add also this standard sentence for a module.

Ack

>> +
>>   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
>> diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
>> index 841038cfe35b..7a208a0f7b84 100644
>> --- a/drivers/leds/Makefile
>> +++ b/drivers/leds/Makefile
>> @@ -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
>> diff --git a/drivers/leds/leds-lp50xx.c b/drivers/leds/leds-lp50xx.c
>> new file mode 100644
>> index 000000000000..3ddc14f53eae
>> --- /dev/null
>> +++ b/drivers/leds/leds-lp50xx.c
>> @@ -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
>> +#define LP5024_MAX_LED_MODULES	8
>> +#define LP5030_MAX_LED_MODULES	10
>> +#define LP5036_MAX_LED_MODULES	12
>> +
>> +struct lp50xx_led {
>> +	struct led_classdev led_dev;
>> +	struct led_classdev_mc mc_cdev;
>> +	struct lp50xx *priv;
>> +	unsigned long bank_modules;
>> +	int led_intensity[LED_COLOR_ID_MAX];
> This is waste of memory. There should be only three elements.

Ack


>> +	u8 ctrl_bank_enabled;
>> +	int led_number;
>> +};
>> +
>> +/**
>> + * struct lp50xx -
>> + * @enable_gpio: Hardware enable gpio
>> + * @regulator: LED supply regulator pointer
>> + * @client: Pointer to the I2C client
>> + * @regmap: Devices register map
> Device or Device's ?
device
>
>> + * @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,
>> +};
>> +
>> +/*
>> + * struct lp50xx_chip_info -
>> + * @num_leds: number of LED outputs available on the device
>> + * @led_brightness0_reg: first brightness register of the device
>> + * @mix_out0_reg: first color mix register of the device
>> + * @bank_brt_reg: bank brightness register
>> + * @bank_mix_reg: color mix register
>> + * @reset_reg: devices reset register
> s/devices/device/
>
> Please be consequent: I prefer starting the property description
> always with lower case.

Ack


>> + */
>> +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,
>> +	},
>> +};
>> +
>> +static struct lp50xx_led *mcled_cdev_to_led(struct led_classdev_mc *mcled_cdev)
>> +{
>> +	return container_of(mcled_cdev, struct lp50xx_led, mc_cdev);
>> +}
>> +
>> +static int lp50xx_set_intensity(struct lp50xx_led *led)
>> +{
>> +	struct lp50xx *priv = led->priv;
>> +	u8 led_offset, reg_number, reg_color_off;
> reg_color_off feels like "turning the color off"
>
> Let's have full reg_color_offset form.

I will ack this for brightness set as this function will disappear in v9


>
>> +	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);
>> +	if (ret)
>> +		goto err_out;
>> +
>> +	ret = lp50xx_set_intensity(led);
>> +err_out:
>> +	mutex_unlock(&led->priv->lock);
>> +	return ret;
>> +}
>> +
>> +static enum led_brightness lp50xx_brightness_get(struct led_classdev *cdev)
> Do we really need this op? Is it possible that the device will alter
> brightness autonomously ? IOW can't we rely on what we've written
> previously to the hw?

How can we be sure that the previous I/O actually wrote to the device?

If set_brightness fails does the LED class not modify the current 
brightness setting?

So we have mismatched values and with this call back we can refresh the 
right setting.

But I can remove it if you see no value in doing get_brightness call back.

>
>> +{
>> +	struct lp50xx_led *led = container_of(cdev, struct lp50xx_led, led_dev);
>> +	unsigned int brt_val;
>> +	u8 reg_val;
>> +	int ret;
>> +
>> +	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_read(led->priv->regmap, reg_val, &brt_val);
>> +
>> +	mutex_unlock(&led->priv->lock);
>> +
>> +	return brt_val;
>> +}
>> +
>> +static int lp50xx_set_color(struct led_classdev_mc *mcled_cdev,
>> +			    int color, int value)
>> +{
>> +	struct lp50xx_led *led = mcled_cdev_to_led(mcled_cdev);
>> +
>> +	led->led_intensity[color] = value;
>> +
>> +	return 0;
>> +}
>> +
>> +static int lp50xx_set_banks(struct lp50xx *priv, u32 led_strings[])
> This is a bit misleading to introduce "strings" when the function
> claims to set "banks". Let's have the parameter name "led_banks".
Ack
>
>> +{
>> +	u8 led_ctrl_enable = 0;
>> +	u8 led1_ctrl_enable = 0;
>> +	u8 ctrl_ext = 0;
> Let's have below instead of the above three variables:
>
> 	u32 bank_enable_mask = 0;
> 	u8 led_config_lo, led_config_hi;

Ack but I have to keep the initialization to 0 as the compiler 
complained that these values may not be set.


>
>> +	int ret;
>> +	int j;
> This is subjective, but why j? We usually have 'i' for one level loop.

I think this was residual from code from previous revisions I will 
change it to i

Ack

>
>> +
>> +	for (j = 0; j <= priv->chip_info->num_leds - 1; j++) {
>> +		if (led_strings[j] > (LP5024_MAX_LED_MODULES - 1)) {
>> +			ctrl_ext = led_strings[j] - LP5024_MAX_LED_MODULES;
>> +			led1_ctrl_enable |= (1 << ctrl_ext)> +		} else {
>> +			led_ctrl_enable |= (1 << led_strings[j]);
>> +		}
>> +	}
> This looks harder than it should be.
>
> for (i = 0; i < priv->chip_info->num_leds; i++)
> 	bank_enable_mask |= (1 << led_banks[i]);
>
> led_config_lo = (u8)(bank_enable_mask & 0xff);
> led_config_hi = (u8)(bank_enable_mask >> 8) & 0xff);

I will have to go through your logic to make sure it writes the correct 
values.

There was a reason why I did it this way but that was a while back and I 
have to review.


>> +
>> +	ret = regmap_write(priv->regmap, LP50XX_LED_CFG0, led_ctrl_enable);
> ret = regmap_write(priv->regmap, LP50XX_LED_CFG0, led_config_lo);
> if (ret)
> 	return ret;
>
Ack
>> +
>> +	if (led1_ctrl_enable)
>> +		ret = regmap_write(priv->regmap, LP5036_LED_CFG1,
>> +				   led1_ctrl_enable);
> if (led_config_hi)
> 	ret = regmap_write(priv->regmap, LP5036_LED_CFG1,
>                             led_config_hi);
>
Ack
>> +
>> +	return ret;
>> +}
>> +
>> +static int lp50xx_reset(struct lp50xx *priv)
>> +{
>> +	if (priv->enable_gpio)
>> +		return gpiod_direction_output(priv->enable_gpio, 1);
>> +	else
>> +		return regmap_write(priv->regmap, priv->chip_info->reset_reg,
>> +				    LP50XX_SW_RESET);
>> +}
>> +
>> +static int lp50xx_enable_disable(struct lp50xx *priv, u8 enable_disable)
>> +{
>> +	return regmap_write(priv->regmap, LP50XX_DEV_CFG0, enable_disable);
>> +}
>> +
>> +static int lp50xx_probe_dt(struct lp50xx *priv)
>> +{
>> +	u32 led_strings[LP5036_MAX_LED_MODULES];
> s/led_strings/led_banks/

Ack


>> +	struct fwnode_handle *child = NULL;
>> +	struct fwnode_handle *led_node = NULL;
>> +	struct led_init_data init_data;
>> +	struct lp50xx_led *led;
>> +	int num_colors;
>> +	u32 color_id;
>> +	int led_number;
>> +	size_t i = 0;
>> +	int ret;
>> +
>> +	priv->enable_gpio = devm_gpiod_get_optional(&priv->client->dev,
>> +						   "enable", GPIOD_OUT_LOW);
>> +	if (IS_ERR(priv->enable_gpio)) {
>> +		ret = PTR_ERR(priv->enable_gpio);
>> +		dev_err(&priv->client->dev, "Failed to get enable gpio: %d\n",
>> +			ret);
>> +		return ret;
>> +	}
>> +
>> +	priv->regulator = devm_regulator_get(&priv->client->dev, "vled");
>> +	if (IS_ERR(priv->regulator))
>> +		priv->regulator = NULL;
>> +
>> +	device_for_each_child_node(&priv->client->dev, child) {
>> +		led = &priv->leds[i];
>> +		if (fwnode_property_present(child, "ti,led-bank")) {
>> +			ret = fwnode_property_read_u32_array(child,
>> +							     "ti,led-bank",
>> +							     NULL, 0);
>> +			ret = fwnode_property_read_u32_array(child,
>> +							     "ti,led-bank",
>> +							     led_strings,
>> +							     ret);
>> +
>> +			priv->num_of_banked_leds = ARRAY_SIZE(led_strings);
>> +
>> +			ret = lp50xx_set_banks(priv, led_strings);
>> +			if (ret) {
>> +				dev_err(&priv->client->dev,
>> +					"Cannot setup banked LEDs\n");
>> +				fwnode_handle_put(child);
>> +				goto child_out;
>> +			}
>> +			led->ctrl_bank_enabled = 1;
>> +
>> +		} else {
>> +			ret = fwnode_property_read_u32(child, "reg",
>> +					       &led_number);
>> +
>> +			led->led_number = led_number;
>> +		}
>> +		if (ret) {
>> +			dev_err(&priv->client->dev,
>> +				"led sourcing property missing\n");
>> +			fwnode_handle_put(child);
>> +			goto child_out;
>> +		}
>> +
>> +		if (led_number > priv->chip_info->num_leds) {
>> +			dev_err(&priv->client->dev,
>> +				"led-sources property is invalid\n");
>> +			ret = -EINVAL;
>> +			fwnode_handle_put(child);
>> +			goto child_out;
>> +		}
>> +
>> +		init_data.fwnode = child;
>> +		init_data.devicename = priv->client->name;
>> +		init_data.default_label = ":";
> devicename and default_label are for LEDs with mandatory devicename
> and for backward compatibility. Neither is pertinent to this driver.

Ack

Dan

[...]

Re: [PATCH v8 8/9] leds: lp50xx: Add the LP50XX family of the RGB LED driver

[Jacek Anaszewski]

Dan,

On 9/23/19 7:56 PM, Dan Murphy wrote:
> Jacek
> 
> On 9/21/19 10:11 AM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 9/20/19 7:41 PM, Dan Murphy wrote:
>>> 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<dmurphy@ti.com>
>>> ---
>>>   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
>>>
>>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
>>> index cfb1ebb6517f..1c0cacb100e6 100644
>>> --- a/drivers/leds/Kconfig
>>> +++ b/drivers/leds/Kconfig
>>> @@ -363,6 +363,13 @@ config LEDS_LP3952
>>>         To compile this driver as a module, choose M here: the
>>>         module will be called leds-lp3952.
>>>   +config LEDS_LP50XX
>>> +    tristate "LED Support for TI LP5036/30/24/18 LED driver chip"
>>> +    depends on LEDS_CLASS && REGMAP_I2C
>> && OF
> 
> Not sure why I would add that since we are using fw_node calls not
> of_property calls.
> 
> The fw_node calls are built in as default kernel so these should always
> be available.

Ah, right. Forget it.

[...]
>>> +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);
>>> +    if (ret)
>>> +        goto err_out;
>>> +
>>> +    ret = lp50xx_set_intensity(led);
>>> +err_out:
>>> +    mutex_unlock(&led->priv->lock);
>>> +    return ret;
>>> +}
>>> +
>>> +static enum led_brightness lp50xx_brightness_get(struct led_classdev
>>> *cdev)
>> Do we really need this op? Is it possible that the device will alter
>> brightness autonomously ? IOW can't we rely on what we've written
>> previously to the hw?
> 
> How can we be sure that the previous I/O actually wrote to the device?

brightness_set* op returned 0?

> If set_brightness fails does the LED class not modify the current
> brightness setting?

It does modify it on every brightness setting op in
led_set_brightness_nosleep().

> So we have mismatched values and with this call back we can refresh the
> right setting.
> 
> But I can remove it if you see no value in doing get_brightness call back.

If write to the device fails it signifies much more serious problem
than resulting mismatched values. Have you experienced that?

>>> +{
>>> +    struct lp50xx_led *led = container_of(cdev, struct lp50xx_led,
>>> led_dev);
>>> +    unsigned int brt_val;
>>> +    u8 reg_val;
>>> +    int ret;
>>> +
>>> +    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_read(led->priv->regmap, reg_val, &brt_val);
>>> +
>>> +    mutex_unlock(&led->priv->lock);
>>> +
>>> +    return brt_val;
>>> +}
>>> +
>>> +static int lp50xx_set_color(struct led_classdev_mc *mcled_cdev,
>>> +                int color, int value)
>>> +{
>>> +    struct lp50xx_led *led = mcled_cdev_to_led(mcled_cdev);
>>> +
>>> +    led->led_intensity[color] = value;
>>> +
>>> +    return 0;
>>> +}
>>> +
>>> +static int lp50xx_set_banks(struct lp50xx *priv, u32 led_strings[])
>> This is a bit misleading to introduce "strings" when the function
>> claims to set "banks". Let's have the parameter name "led_banks".
> Ack
>>
>>> +{
>>> +    u8 led_ctrl_enable = 0;
>>> +    u8 led1_ctrl_enable = 0;
>>> +    u8 ctrl_ext = 0;
>> Let's have below instead of the above three variables:
>>
>>     u32 bank_enable_mask = 0;
>>     u8 led_config_lo, led_config_hi;
> 
> Ack but I have to keep the initialization to 0 as the compiler
> complained that these values may not be set.

It was because in your code values are assigned in a loop that
may or may not execute at all, depending on num_leds.
In my example variables will be assigned unconditionally
so there should be no compiler complaints.


-- 
Best regards,
Jacek Anaszewski

[PATCH v8 9/9] leds: Update the lp55xx to use the multi color framework

[Dan Murphy]

Update the lp5523 to use the multi color framework.

Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
 drivers/leds/leds-lp5523.c                |  13 +++
 drivers/leds/leds-lp55xx-common.c         | 131 ++++++++++++++++++----
 drivers/leds/leds-lp55xx-common.h         |   9 ++
 include/linux/platform_data/leds-lp55xx.h |   6 +
 4 files changed, 137 insertions(+), 22 deletions(-)

diff --git a/drivers/leds/leds-lp5523.c b/drivers/leds/leds-lp5523.c
index d0b931a136b9..8b2cdb98fed6 100644
--- a/drivers/leds/leds-lp5523.c
+++ b/drivers/leds/leds-lp5523.c
@@ -791,6 +791,18 @@ static ssize_t store_master_fader_leds(struct device *dev,
 	return ret;
 }
 
+static int lp5523_led_intensity(struct lp55xx_led *led, int chan_num)
+{
+	struct lp55xx_chip *chip = led->chip;
+	int ret;
+
+	mutex_lock(&chip->lock);
+	ret = lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + chan_num,
+		     led->brightness);
+	mutex_unlock(&chip->lock);
+	return ret;
+}
+
 static int lp5523_led_brightness(struct lp55xx_led *led)
 {
 	struct lp55xx_chip *chip = led->chip;
@@ -857,6 +869,7 @@ static struct lp55xx_device_config lp5523_cfg = {
 	.max_channel  = LP5523_MAX_LEDS,
 	.post_init_device   = lp5523_post_init_device,
 	.brightness_fn      = lp5523_led_brightness,
+	.color_intensity_fn = lp5523_led_intensity,
 	.set_led_current    = lp5523_set_led_current,
 	.firmware_cb        = lp5523_firmware_loaded,
 	.run_engine         = lp5523_run_engine,
diff --git a/drivers/leds/leds-lp55xx-common.c b/drivers/leds/leds-lp55xx-common.c
index 44ced02b49f9..a5efe2407832 100644
--- a/drivers/leds/leds-lp55xx-common.c
+++ b/drivers/leds/leds-lp55xx-common.c
@@ -136,9 +136,26 @@ static int lp55xx_set_brightness(struct led_classdev *cdev,
 {
 	struct lp55xx_led *led = cdev_to_lp55xx_led(cdev);
 	struct lp55xx_device_config *cfg = led->chip->cfg;
+	int adj_value[LED_COLOR_ID_MAX];
+	int ret;
+	int i;
+
+	if (led->mc_cdev.num_leds > 1) {
+		led_mc_calc_brightness(&led->mc_cdev,
+				       brightness, adj_value);
+		for (i = 0; i < led->mc_cdev.num_leds; i++) {
+			led->brightness = adj_value[i];
+			ret = cfg->color_intensity_fn(led,
+						      led->grouped_channels[i]);
+			if (ret)
+				break;
+		}
+	} else {
+		led->brightness = (u8)brightness;
+		ret = cfg->brightness_fn(led);
+	}
 
-	led->brightness = (u8)brightness;
-	return cfg->brightness_fn(led);
+	return ret;
 }
 
 static int lp55xx_init_led(struct lp55xx_led *led,
@@ -147,9 +164,9 @@ static int lp55xx_init_led(struct lp55xx_led *led,
 	struct lp55xx_platform_data *pdata = chip->pdata;
 	struct lp55xx_device_config *cfg = chip->cfg;
 	struct device *dev = &chip->cl->dev;
+	int max_channel = cfg->max_channel;
 	char name[32];
 	int ret;
-	int max_channel = cfg->max_channel;
 
 	if (chan >= max_channel) {
 		dev_err(dev, "invalid channel: %d / %d\n", chan, max_channel);
@@ -159,10 +176,35 @@ static int lp55xx_init_led(struct lp55xx_led *led,
 	if (pdata->led_config[chan].led_current == 0)
 		return 0;
 
+	if (pdata->led_config[chan].name) {
+		led->cdev.name = pdata->led_config[chan].name;
+	} else {
+		snprintf(name, sizeof(name), "%s:channel%d",
+			pdata->label ? : chip->cl->name, chan);
+		led->cdev.name = name;
+	}
+
+	if (pdata->led_config[chan].num_colors > 1) {
+		led->mc_cdev.led_cdev = &led->cdev;
+		led->cdev.brightness_set_blocking = lp55xx_set_brightness;
+		led->cdev.groups = lp55xx_led_groups;
+		led->mc_cdev.num_leds = pdata->led_config[chan].num_colors;
+		led->mc_cdev.available_colors = pdata->led_config[chan].available_colors;
+		memcpy(led->channel_color,
+		       pdata->led_config[chan].channel_color,
+		       sizeof(led->channel_color));
+		memcpy(led->grouped_channels,
+		       pdata->led_config[chan].grouped_channels,
+		       sizeof(led->grouped_channels));
+	} else {
+
+		led->cdev.default_trigger = pdata->led_config[chan].default_trigger;
+		led->cdev.brightness_set_blocking = lp55xx_set_brightness;
+	}	led->cdev.groups = lp55xx_led_groups;
+
 	led->led_current = pdata->led_config[chan].led_current;
 	led->max_current = pdata->led_config[chan].max_current;
 	led->chan_nr = pdata->led_config[chan].chan_nr;
-	led->cdev.default_trigger = pdata->led_config[chan].default_trigger;
 
 	if (led->chan_nr >= max_channel) {
 		dev_err(dev, "Use channel numbers between 0 and %d\n",
@@ -170,18 +212,11 @@ static int lp55xx_init_led(struct lp55xx_led *led,
 		return -EINVAL;
 	}
 
-	led->cdev.brightness_set_blocking = lp55xx_set_brightness;
-	led->cdev.groups = lp55xx_led_groups;
+	if (pdata->led_config[chan].num_colors > 1)
+		ret = led_classdev_multicolor_register(dev, &led->mc_cdev);
+	else
+		ret = led_classdev_register(dev, &led->cdev);
 
-	if (pdata->led_config[chan].name) {
-		led->cdev.name = pdata->led_config[chan].name;
-	} else {
-		snprintf(name, sizeof(name), "%s:channel%d",
-			pdata->label ? : chip->cl->name, chan);
-		led->cdev.name = name;
-	}
-
-	ret = led_classdev_register(dev, &led->cdev);
 	if (ret) {
 		dev_err(dev, "led register err: %d\n", ret);
 		return ret;
@@ -466,7 +501,6 @@ int lp55xx_register_leds(struct lp55xx_led *led, struct lp55xx_chip *chip)
 		dev_err(&chip->cl->dev, "empty brightness configuration\n");
 		return -EINVAL;
 	}
-
 	for (i = 0; i < num_channels; i++) {
 
 		/* do not initialize channels that are not connected */
@@ -538,6 +572,38 @@ void lp55xx_unregister_sysfs(struct lp55xx_chip *chip)
 }
 EXPORT_SYMBOL_GPL(lp55xx_unregister_sysfs);
 
+static int lp5xx_parse_channel_child(struct device_node *np,
+				     struct lp55xx_led_config *cfg,
+				     int chan_num)
+{
+	struct device_node *child;
+	int num_colors = 0;
+	u32 color_id;
+	u32 led_number;
+	int ret;
+
+	cfg[chan_num].default_trigger =
+			of_get_property(np, "linux,default-trigger", NULL);
+
+	for_each_child_of_node(np, child) {
+		of_property_read_string(child, "chan-name",
+					&cfg[chan_num].name);
+		of_property_read_u8(child, "led-cur",
+				    &cfg[chan_num].led_current);
+		of_property_read_u8(child, "max-cur",
+				    &cfg[chan_num].max_current);
+		of_property_read_u32(child, "color", &color_id);
+		cfg[chan_num].channel_color[num_colors] = color_id;
+		set_bit(color_id, &cfg[chan_num].available_colors);
+		ret = of_property_read_u32(child, "reg", &led_number);
+		cfg[chan_num].grouped_channels[num_colors] = led_number;
+		num_colors++;
+	}
+	cfg[chan_num].num_colors = num_colors;
+
+	return 0;
+}
+
 struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
 						      struct device_node *np)
 {
@@ -545,7 +611,10 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
 	struct lp55xx_platform_data *pdata;
 	struct lp55xx_led_config *cfg;
 	int num_channels;
+	int channel_color;
+	u32 led_number;
 	int i = 0;
+	int ret;
 
 	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
 	if (!pdata)
@@ -565,13 +634,31 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
 	pdata->num_channels = num_channels;
 
 	for_each_child_of_node(np, child) {
-		cfg[i].chan_nr = i;
+		ret = of_property_read_u32(child, "color", &channel_color);
+		if (ret) {
+			dev_err(dev,"Missing color property setting white\n");
+			channel_color = LED_COLOR_ID_WHITE;
+		}
 
-		of_property_read_string(child, "chan-name", &cfg[i].name);
-		of_property_read_u8(child, "led-cur", &cfg[i].led_current);
-		of_property_read_u8(child, "max-cur", &cfg[i].max_current);
-		cfg[i].default_trigger =
-			of_get_property(child, "linux,default-trigger", NULL);
+		if (channel_color == LED_COLOR_ID_MULTI)
+			lp5xx_parse_channel_child(child, cfg, i);
+		else {
+			of_property_read_string(child, "chan-name",
+						&cfg[i].name);
+			of_property_read_u8(child, "led-cur",
+					    &cfg[i].led_current);
+			of_property_read_u8(child, "max-cur",
+					    &cfg[i].max_current);
+			cfg[i].default_trigger =
+				of_get_property(child, "linux,default-trigger",
+						NULL);
+			of_property_read_u32(child, "reg", &led_number);
+
+			if (led_number < 0 || led_number > 6)
+				return ERR_PTR(EINVAL);
+
+			cfg[i].chan_nr = led_number;
+		}
 
 		i++;
 	}
diff --git a/drivers/leds/leds-lp55xx-common.h b/drivers/leds/leds-lp55xx-common.h
index 783ed5103ce5..d9c114259dcb 100644
--- a/drivers/leds/leds-lp55xx-common.h
+++ b/drivers/leds/leds-lp55xx-common.h
@@ -12,6 +12,8 @@
 #ifndef _LEDS_LP55XX_COMMON_H
 #define _LEDS_LP55XX_COMMON_H
 
+#include <linux/led-class-multicolor.h>
+
 enum lp55xx_engine_index {
 	LP55XX_ENGINE_INVALID,
 	LP55XX_ENGINE_1,
@@ -109,6 +111,9 @@ struct lp55xx_device_config {
 	/* access brightness register */
 	int (*brightness_fn)(struct lp55xx_led *led);
 
+	/* access specific brightness register */
+	int (*color_intensity_fn)(struct lp55xx_led *led, int chan_num);
+
 	/* current setting function */
 	void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
 
@@ -159,6 +164,7 @@ struct lp55xx_chip {
  * struct lp55xx_led
  * @chan_nr         : Channel number
  * @cdev            : LED class device
+ * @mc_cdev	    : Multi color class device
  * @led_current     : Current setting at each led channel
  * @max_current     : Maximun current at each led channel
  * @brightness      : Brightness value
@@ -167,9 +173,12 @@ struct lp55xx_chip {
 struct lp55xx_led {
 	int chan_nr;
 	struct led_classdev cdev;
+	struct led_classdev_mc mc_cdev;
 	u8 led_current;
 	u8 max_current;
 	u8 brightness;
+	int channel_color[LED_COLOR_ID_MAX];
+	int grouped_channels[LED_COLOR_ID_MAX];
 	struct lp55xx_chip *chip;
 };
 
diff --git a/include/linux/platform_data/leds-lp55xx.h b/include/linux/platform_data/leds-lp55xx.h
index 96a787100fda..0ac29f537ab6 100644
--- a/include/linux/platform_data/leds-lp55xx.h
+++ b/include/linux/platform_data/leds-lp55xx.h
@@ -12,6 +12,8 @@
 #ifndef _LEDS_LP55XX_H
 #define _LEDS_LP55XX_H
 
+#include <linux/led-class-multicolor.h>
+
 /* Clock configuration */
 #define LP55XX_CLOCK_AUTO	0
 #define LP55XX_CLOCK_INT	1
@@ -23,6 +25,10 @@ struct lp55xx_led_config {
 	u8 chan_nr;
 	u8 led_current; /* mA x10, 0 if led is not connected */
 	u8 max_current;
+	int num_colors;
+	unsigned long available_colors;
+	u32 channel_color[LED_COLOR_ID_MAX];
+	int grouped_channels[LED_COLOR_ID_MAX];
 };
 
 struct lp55xx_predef_pattern {
-- 
2.22.0.214.g8dca754b1e

Re: [PATCH v8 9/9] leds: Update the lp55xx to use the multi color framework

[Jacek Anaszewski]

Dan,

On 9/20/19 7:41 PM, Dan Murphy wrote:
> Update the lp5523 to use the multi color framework.
> 
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  drivers/leds/leds-lp5523.c                |  13 +++
>  drivers/leds/leds-lp55xx-common.c         | 131 ++++++++++++++++++----
>  drivers/leds/leds-lp55xx-common.h         |   9 ++
>  include/linux/platform_data/leds-lp55xx.h |   6 +
>  4 files changed, 137 insertions(+), 22 deletions(-)
> 
> diff --git a/drivers/leds/leds-lp5523.c b/drivers/leds/leds-lp5523.c
> index d0b931a136b9..8b2cdb98fed6 100644
> --- a/drivers/leds/leds-lp5523.c
> +++ b/drivers/leds/leds-lp5523.c
> @@ -791,6 +791,18 @@ static ssize_t store_master_fader_leds(struct device *dev,
>  	return ret;
>  }
>  
> +static int lp5523_led_intensity(struct lp55xx_led *led, int chan_num)
> +{
> +	struct lp55xx_chip *chip = led->chip;
> +	int ret;
> +
> +	mutex_lock(&chip->lock);
> +	ret = lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + chan_num,
> +		     led->brightness);
> +	mutex_unlock(&chip->lock);
> +	return ret;
> +}
> +
>  static int lp5523_led_brightness(struct lp55xx_led *led)
>  {
>  	struct lp55xx_chip *chip = led->chip;
> @@ -857,6 +869,7 @@ static struct lp55xx_device_config lp5523_cfg = {
>  	.max_channel  = LP5523_MAX_LEDS,
>  	.post_init_device   = lp5523_post_init_device,
>  	.brightness_fn      = lp5523_led_brightness,
> +	.color_intensity_fn = lp5523_led_intensity,
>  	.set_led_current    = lp5523_set_led_current,
>  	.firmware_cb        = lp5523_firmware_loaded,
>  	.run_engine         = lp5523_run_engine,
> diff --git a/drivers/leds/leds-lp55xx-common.c b/drivers/leds/leds-lp55xx-common.c
> index 44ced02b49f9..a5efe2407832 100644
> --- a/drivers/leds/leds-lp55xx-common.c
> +++ b/drivers/leds/leds-lp55xx-common.c
> @@ -136,9 +136,26 @@ static int lp55xx_set_brightness(struct led_classdev *cdev,
>  {
>  	struct lp55xx_led *led = cdev_to_lp55xx_led(cdev);
>  	struct lp55xx_device_config *cfg = led->chip->cfg;
> +	int adj_value[LED_COLOR_ID_MAX];

This looks suboptimal. This array should have only the number
of elements equal to the number of requested colors.

> +	int ret;
> +	int i;
> +
> +	if (led->mc_cdev.num_leds > 1) {
> +		led_mc_calc_brightness(&led->mc_cdev,
> +				       brightness, adj_value);

I still feel uncomfortable with the name of the third
argument for led_mc_calc_brightness().

In the function definition I proposed brightness_val instead of
adj_value, but this is not too informative either.
How about brightness_dimmed ? If you agree then let's change it
also in the definition. Also the type should be enum led_brightness.

Here we would have the following call:

led_mc_calc_brightness(&led->mc_cdev, brightness, brightness_dimmed);

> +		for (i = 0; i < led->mc_cdev.num_leds; i++) {
> +			led->brightness = adj_value[i];
> +			ret = cfg->color_intensity_fn(led,
> +						      led->grouped_channels[i]);
> +			if (ret)
> +				break;
> +		}
> +	} else {
> +		led->brightness = (u8)brightness;
> +		ret = cfg->brightness_fn(led);
> +	}
>  
> -	led->brightness = (u8)brightness;
> -	return cfg->brightness_fn(led);
> +	return ret;
>  }
>  
>  static int lp55xx_init_led(struct lp55xx_led *led,
> @@ -147,9 +164,9 @@ static int lp55xx_init_led(struct lp55xx_led *led,
>  	struct lp55xx_platform_data *pdata = chip->pdata;
>  	struct lp55xx_device_config *cfg = chip->cfg;
>  	struct device *dev = &chip->cl->dev;
> +	int max_channel = cfg->max_channel;
>  	char name[32];
>  	int ret;
> -	int max_channel = cfg->max_channel;
>  
>  	if (chan >= max_channel) {
>  		dev_err(dev, "invalid channel: %d / %d\n", chan, max_channel);
> @@ -159,10 +176,35 @@ static int lp55xx_init_led(struct lp55xx_led *led,
>  	if (pdata->led_config[chan].led_current == 0)
>  		return 0;
>  
> +	if (pdata->led_config[chan].name) {
> +		led->cdev.name = pdata->led_config[chan].name;
> +	} else {
> +		snprintf(name, sizeof(name), "%s:channel%d",
> +			pdata->label ? : chip->cl->name, chan);
> +		led->cdev.name = name;
> +	}
> +
> +	if (pdata->led_config[chan].num_colors > 1) {> +		led->mc_cdev.led_cdev = &led->cdev;
> +		led->cdev.brightness_set_blocking = lp55xx_set_brightness;
> +		led->cdev.groups = lp55xx_led_groups;
> +		led->mc_cdev.num_leds = pdata->led_config[chan].num_colors;
> +		led->mc_cdev.available_colors = pdata->led_config[chan].available_colors;
> +		memcpy(led->channel_color,
> +		       pdata->led_config[chan].channel_color,
> +		       sizeof(led->channel_color));
> +		memcpy(led->grouped_channels,
> +		       pdata->led_config[chan].grouped_channels,
> +		       sizeof(led->grouped_channels));
> +	} else {
> +
> +		led->cdev.default_trigger = pdata->led_config[chan].default_trigger;
> +		led->cdev.brightness_set_blocking = lp55xx_set_brightness;
> +	}	led->cdev.groups = lp55xx_led_groups;
> +
>  	led->led_current = pdata->led_config[chan].led_current;
>  	led->max_current = pdata->led_config[chan].max_current;
>  	led->chan_nr = pdata->led_config[chan].chan_nr;
> -	led->cdev.default_trigger = pdata->led_config[chan].default_trigger;
>  
>  	if (led->chan_nr >= max_channel) {
>  		dev_err(dev, "Use channel numbers between 0 and %d\n",
> @@ -170,18 +212,11 @@ static int lp55xx_init_led(struct lp55xx_led *led,
>  		return -EINVAL;
>  	}
>  
> -	led->cdev.brightness_set_blocking = lp55xx_set_brightness;
> -	led->cdev.groups = lp55xx_led_groups;
> +	if (pdata->led_config[chan].num_colors > 1)
> +		ret = led_classdev_multicolor_register(dev, &led->mc_cdev);
> +	else
> +		ret = led_classdev_register(dev, &led->cdev);
>  
> -	if (pdata->led_config[chan].name) {
> -		led->cdev.name = pdata->led_config[chan].name;
> -	} else {
> -		snprintf(name, sizeof(name), "%s:channel%d",
> -			pdata->label ? : chip->cl->name, chan);
> -		led->cdev.name = name;
> -	}
> -
> -	ret = led_classdev_register(dev, &led->cdev);
>  	if (ret) {
>  		dev_err(dev, "led register err: %d\n", ret);
>  		return ret;
> @@ -466,7 +501,6 @@ int lp55xx_register_leds(struct lp55xx_led *led, struct lp55xx_chip *chip)
>  		dev_err(&chip->cl->dev, "empty brightness configuration\n");
>  		return -EINVAL;
>  	}
> -
>  	for (i = 0; i < num_channels; i++) {
>  
>  		/* do not initialize channels that are not connected */
> @@ -538,6 +572,38 @@ void lp55xx_unregister_sysfs(struct lp55xx_chip *chip)
>  }
>  EXPORT_SYMBOL_GPL(lp55xx_unregister_sysfs);
>  
> +static int lp5xx_parse_channel_child(struct device_node *np,
> +				     struct lp55xx_led_config *cfg,
> +				     int chan_num)
> +{
> +	struct device_node *child;
> +	int num_colors = 0;
> +	u32 color_id;
> +	u32 led_number;
> +	int ret;
> +
> +	cfg[chan_num].default_trigger =
> +			of_get_property(np, "linux,default-trigger", NULL);
> +
> +	for_each_child_of_node(np, child) {
> +		of_property_read_string(child, "chan-name",
> +					&cfg[chan_num].name);
> +		of_property_read_u8(child, "led-cur",
> +				    &cfg[chan_num].led_current);
> +		of_property_read_u8(child, "max-cur",
> +				    &cfg[chan_num].max_current);
> +		of_property_read_u32(child, "color", &color_id);
> +		cfg[chan_num].channel_color[num_colors] = color_id;
> +		set_bit(color_id, &cfg[chan_num].available_colors);
> +		ret = of_property_read_u32(child, "reg", &led_number);
> +		cfg[chan_num].grouped_channels[num_colors] = led_number;
> +		num_colors++;

We have similar parser snippet below in lp55xx_of_populate_pdata().
Why this duplication is needed? We also need an update to DT bindings.
Now I don't know what's the multicolor DT design for this driver
family.

> +	}
> +	cfg[chan_num].num_colors = num_colors;
> +
> +	return 0;
> +}
> +
>  struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>  						      struct device_node *np)
>  {
> @@ -545,7 +611,10 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>  	struct lp55xx_platform_data *pdata;
>  	struct lp55xx_led_config *cfg;
>  	int num_channels;
> +	int channel_color;
> +	u32 led_number;
>  	int i = 0;
> +	int ret;
>  
>  	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
>  	if (!pdata)
> @@ -565,13 +634,31 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>  	pdata->num_channels = num_channels;
>  
>  	for_each_child_of_node(np, child) {
> -		cfg[i].chan_nr = i;
> +		ret = of_property_read_u32(child, "color", &channel_color);
> +		if (ret) {
> +			dev_err(dev,"Missing color property setting white\n");
> +			channel_color = LED_COLOR_ID_WHITE;
> +		}
>  
> -		of_property_read_string(child, "chan-name", &cfg[i].name);
> -		of_property_read_u8(child, "led-cur", &cfg[i].led_current);
> -		of_property_read_u8(child, "max-cur", &cfg[i].max_current);
> -		cfg[i].default_trigger =
> -			of_get_property(child, "linux,default-trigger", NULL);
> +		if (channel_color == LED_COLOR_ID_MULTI)
> +			lp5xx_parse_channel_child(child, cfg, i);
> +		else {
> +			of_property_read_string(child, "chan-name",
> +						&cfg[i].name);
> +			of_property_read_u8(child, "led-cur",
> +					    &cfg[i].led_current);
> +			of_property_read_u8(child, "max-cur",
> +					    &cfg[i].max_current);
> +			cfg[i].default_trigger =
> +				of_get_property(child, "linux,default-trigger",
> +						NULL);
> +			of_property_read_u32(child, "reg", &led_number);
> +
> +			if (led_number < 0 || led_number > 6)
> +				return ERR_PTR(EINVAL);
> +
> +			cfg[i].chan_nr = led_number;
> +		}
>  
>  		i++;
>  	}
> diff --git a/drivers/leds/leds-lp55xx-common.h b/drivers/leds/leds-lp55xx-common.h
> index 783ed5103ce5..d9c114259dcb 100644
> --- a/drivers/leds/leds-lp55xx-common.h
> +++ b/drivers/leds/leds-lp55xx-common.h
> @@ -12,6 +12,8 @@
>  #ifndef _LEDS_LP55XX_COMMON_H
>  #define _LEDS_LP55XX_COMMON_H
>  
> +#include <linux/led-class-multicolor.h>
> +
>  enum lp55xx_engine_index {
>  	LP55XX_ENGINE_INVALID,
>  	LP55XX_ENGINE_1,
> @@ -109,6 +111,9 @@ struct lp55xx_device_config {
>  	/* access brightness register */
>  	int (*brightness_fn)(struct lp55xx_led *led);
>  
> +	/* access specific brightness register */
> +	int (*color_intensity_fn)(struct lp55xx_led *led, int chan_num);
> +
>  	/* current setting function */
>  	void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
>  
> @@ -159,6 +164,7 @@ struct lp55xx_chip {
>   * struct lp55xx_led
>   * @chan_nr         : Channel number
>   * @cdev            : LED class device
> + * @mc_cdev	    : Multi color class device
>   * @led_current     : Current setting at each led channel
>   * @max_current     : Maximun current at each led channel
>   * @brightness      : Brightness value
> @@ -167,9 +173,12 @@ struct lp55xx_chip {
>  struct lp55xx_led {
>  	int chan_nr;
>  	struct led_classdev cdev;
> +	struct led_classdev_mc mc_cdev;
>  	u8 led_current;
>  	u8 max_current;
>  	u8 brightness;
> +	int channel_color[LED_COLOR_ID_MAX];
> +	int grouped_channels[LED_COLOR_ID_MAX];
>  	struct lp55xx_chip *chip;
>  };
>  
> diff --git a/include/linux/platform_data/leds-lp55xx.h b/include/linux/platform_data/leds-lp55xx.h
> index 96a787100fda..0ac29f537ab6 100644
> --- a/include/linux/platform_data/leds-lp55xx.h
> +++ b/include/linux/platform_data/leds-lp55xx.h
> @@ -12,6 +12,8 @@
>  #ifndef _LEDS_LP55XX_H
>  #define _LEDS_LP55XX_H
>  
> +#include <linux/led-class-multicolor.h>
> +
>  /* Clock configuration */
>  #define LP55XX_CLOCK_AUTO	0
>  #define LP55XX_CLOCK_INT	1
> @@ -23,6 +25,10 @@ struct lp55xx_led_config {
>  	u8 chan_nr;
>  	u8 led_current; /* mA x10, 0 if led is not connected */
>  	u8 max_current;
> +	int num_colors;
> +	unsigned long available_colors;
> +	u32 channel_color[LED_COLOR_ID_MAX];
> +	int grouped_channels[LED_COLOR_ID_MAX];

We can do with three-element arrays here.

>  };
>  
>  struct lp55xx_predef_pattern {
> 

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 9/9] leds: Update the lp55xx to use the multi color framework

[Jacek Anaszewski]

Dan,

On 9/23/19 9:29 PM, Dan Murphy wrote:
> Jacek
> 
> On 9/21/19 1:06 PM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 9/20/19 7:41 PM, Dan Murphy wrote:
>>> Update the lp5523 to use the multi color framework.
>>>
>>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>>> ---
>>>  drivers/leds/leds-lp5523.c                |  13 +++
>>>  drivers/leds/leds-lp55xx-common.c         | 131 ++++++++++++++++++----
>>>  drivers/leds/leds-lp55xx-common.h         |   9 ++
>>>  include/linux/platform_data/leds-lp55xx.h |   6 +
>>>  4 files changed, 137 insertions(+), 22 deletions(-)
>>>
>>> diff --git a/drivers/leds/leds-lp5523.c b/drivers/leds/leds-lp5523.c
>>> index d0b931a136b9..8b2cdb98fed6 100644
>>> --- a/drivers/leds/leds-lp5523.c
>>> +++ b/drivers/leds/leds-lp5523.c
>>> @@ -791,6 +791,18 @@ static ssize_t store_master_fader_leds(struct device *dev,
>>>  	return ret;
>>>  }
>>>  
>>> +static int lp5523_led_intensity(struct lp55xx_led *led, int chan_num)
>>> +{
>>> +	struct lp55xx_chip *chip = led->chip;
>>> +	int ret;
>>> +
>>> +	mutex_lock(&chip->lock);
>>> +	ret = lp55xx_write(chip, LP5523_REG_LED_PWM_BASE + chan_num,
>>> +		     led->brightness);
>>> +	mutex_unlock(&chip->lock);
>>> +	return ret;
>>> +}
>>> +
>>>  static int lp5523_led_brightness(struct lp55xx_led *led)
>>>  {
>>>  	struct lp55xx_chip *chip = led->chip;
>>> @@ -857,6 +869,7 @@ static struct lp55xx_device_config lp5523_cfg = {
>>>  	.max_channel  = LP5523_MAX_LEDS,
>>>  	.post_init_device   = lp5523_post_init_device,
>>>  	.brightness_fn      = lp5523_led_brightness,
>>> +	.color_intensity_fn = lp5523_led_intensity,
>>>  	.set_led_current    = lp5523_set_led_current,
>>>  	.firmware_cb        = lp5523_firmware_loaded,
>>>  	.run_engine         = lp5523_run_engine,
>>> diff --git a/drivers/leds/leds-lp55xx-common.c b/drivers/leds/leds-lp55xx-common.c
>>> index 44ced02b49f9..a5efe2407832 100644
>>> --- a/drivers/leds/leds-lp55xx-common.c
>>> +++ b/drivers/leds/leds-lp55xx-common.c
>>> @@ -136,9 +136,26 @@ static int lp55xx_set_brightness(struct led_classdev *cdev,
>>>  {
>>>  	struct lp55xx_led *led = cdev_to_lp55xx_led(cdev);
>>>  	struct lp55xx_device_config *cfg = led->chip->cfg;
>>> +	int adj_value[LED_COLOR_ID_MAX];
>> This looks suboptimal. This array should have only the number
>> of elements equal to the number of requested colors.
> 
> That varys from product implementation to implementation.  Plus this is
> just a stack variable and does not take up to much space.

AFAICS there should be max four LEDS in RGBW case.
And we don't know how the number of our color definitions will grow.
At some point we may exceed stack frame size.


>>> +	int ret;
>>> +	int i;
>>> +
>>> +	if (led->mc_cdev.num_leds > 1) {
>>> +		led_mc_calc_brightness(&led->mc_cdev,
>>> +				       brightness, adj_value);
>> I still feel uncomfortable with the name of the third
>> argument for led_mc_calc_brightness().
>>
>> In the function definition I proposed brightness_val instead of
>> adj_value, but this is not too informative either.
>> How about brightness_dimmed ? If you agree then let's change it
>> also in the definition. Also the type should be enum led_brightness.
>>
>> Here we would have the following call:
>>
>> led_mc_calc_brightness(&led->mc_cdev, brightness, brightness_dimmed);
> 
> You did propose that variable update in the multicolor class code [0]. 
> I just did not change it here
> 
> I would rather call it brightness_val.  The brightness may not be dimmed.
> 
> [0] https://lore.kernel.org/patchwork/patch/1126678/
> <https://lore.kernel.org/patchwork/patch/1126678/>

I remember that, I am just still not satisfied with my own proposal :-)
Let's leave it know, maybe something better will come to ones mind
soon.

> 
>>> +		for (i = 0; i < led->mc_cdev.num_leds; i++) {
>>> +			led->brightness = adj_value[i];
>>> +			ret = cfg->color_intensity_fn(led,
>>> +						      led->grouped_channels[i]);
>>> +			if (ret)
>>> +				break;
>>> +		}
>>> +	} else {
>>> +		led->brightness = (u8)brightness;
>>> +		ret = cfg->brightness_fn(led);
>>> +	}
>>>  
>>> -	led->brightness = (u8)brightness;
>>> -	return cfg->brightness_fn(led);
>>> +	return ret;
>>>  }
>>>  
>>>  static int lp55xx_init_led(struct lp55xx_led *led,
>>> @@ -147,9 +164,9 @@ static int lp55xx_init_led(struct lp55xx_led *led,
>>>  	struct lp55xx_platform_data *pdata = chip->pdata;
>>>  	struct lp55xx_device_config *cfg = chip->cfg;
>>>  	struct device *dev = &chip->cl->dev;
>>> +	int max_channel = cfg->max_channel;
>>>  	char name[32];
>>>  	int ret;
>>> -	int max_channel = cfg->max_channel;
>>>  
>>>  	if (chan >= max_channel) {
>>>  		dev_err(dev, "invalid channel: %d / %d\n", chan, max_channel);
>>> @@ -159,10 +176,35 @@ static int lp55xx_init_led(struct lp55xx_led *led,
>>>  	if (pdata->led_config[chan].led_current == 0)
>>>  		return 0;
>>>  
>>> +	if (pdata->led_config[chan].name) {
>>> +		led->cdev.name = pdata->led_config[chan].name;
>>> +	} else {
>>> +		snprintf(name, sizeof(name), "%s:channel%d",
>>> +			pdata->label ? : chip->cl->name, chan);
>>> +		led->cdev.name = name;
>>> +	}
>>> +
>>> +	if (pdata->led_config[chan].num_colors > 1) {> +		led->mc_cdev.led_cdev = &led->cdev;
>>> +		led->cdev.brightness_set_blocking = lp55xx_set_brightness;
>>> +		led->cdev.groups = lp55xx_led_groups;
>>> +		led->mc_cdev.num_leds = pdata->led_config[chan].num_colors;
>>> +		led->mc_cdev.available_colors = pdata->led_config[chan].available_colors;
>>> +		memcpy(led->channel_color,
>>> +		       pdata->led_config[chan].channel_color,
>>> +		       sizeof(led->channel_color));
>>> +		memcpy(led->grouped_channels,
>>> +		       pdata->led_config[chan].grouped_channels,
>>> +		       sizeof(led->grouped_channels));
>>> +	} else {
>>> +
>>> +		led->cdev.default_trigger = pdata->led_config[chan].default_trigger;
>>> +		led->cdev.brightness_set_blocking = lp55xx_set_brightness;
>>> +	}	led->cdev.groups = lp55xx_led_groups;
>>> +
>>>  	led->led_current = pdata->led_config[chan].led_current;
>>>  	led->max_current = pdata->led_config[chan].max_current;
>>>  	led->chan_nr = pdata->led_config[chan].chan_nr;
>>> -	led->cdev.default_trigger = pdata->led_config[chan].default_trigger;
>>>  
>>>  	if (led->chan_nr >= max_channel) {
>>>  		dev_err(dev, "Use channel numbers between 0 and %d\n",
>>> @@ -170,18 +212,11 @@ static int lp55xx_init_led(struct lp55xx_led *led,
>>>  		return -EINVAL;
>>>  	}
>>>  
>>> -	led->cdev.brightness_set_blocking = lp55xx_set_brightness;
>>> -	led->cdev.groups = lp55xx_led_groups;
>>> +	if (pdata->led_config[chan].num_colors > 1)
>>> +		ret = led_classdev_multicolor_register(dev, &led->mc_cdev);
>>> +	else
>>> +		ret = led_classdev_register(dev, &led->cdev);
>>>  
>>> -	if (pdata->led_config[chan].name) {
>>> -		led->cdev.name = pdata->led_config[chan].name;
>>> -	} else {
>>> -		snprintf(name, sizeof(name), "%s:channel%d",
>>> -			pdata->label ? : chip->cl->name, chan);
>>> -		led->cdev.name = name;
>>> -	}
>>> -
>>> -	ret = led_classdev_register(dev, &led->cdev);
>>>  	if (ret) {
>>>  		dev_err(dev, "led register err: %d\n", ret);
>>>  		return ret;
>>> @@ -466,7 +501,6 @@ int lp55xx_register_leds(struct lp55xx_led *led, struct lp55xx_chip *chip)
>>>  		dev_err(&chip->cl->dev, "empty brightness configuration\n");
>>>  		return -EINVAL;
>>>  	}
>>> -
>>>  	for (i = 0; i < num_channels; i++) {
>>>  
>>>  		/* do not initialize channels that are not connected */
>>> @@ -538,6 +572,38 @@ void lp55xx_unregister_sysfs(struct lp55xx_chip *chip)
>>>  }
>>>  EXPORT_SYMBOL_GPL(lp55xx_unregister_sysfs);
>>>  
>>> +static int lp5xx_parse_channel_child(struct device_node *np,
>>> +				     struct lp55xx_led_config *cfg,
>>> +				     int chan_num)
>>> +{
>>> +	struct device_node *child;
>>> +	int num_colors = 0;
>>> +	u32 color_id;
>>> +	u32 led_number;
>>> +	int ret;
>>> +
>>> +	cfg[chan_num].default_trigger =
>>> +			of_get_property(np, "linux,default-trigger", NULL);
>>> +
>>> +	for_each_child_of_node(np, child) {
>>> +		of_property_read_string(child, "chan-name",
>>> +					&cfg[chan_num].name);
>>> +		of_property_read_u8(child, "led-cur",
>>> +				    &cfg[chan_num].led_current);
>>> +		of_property_read_u8(child, "max-cur",
>>> +				    &cfg[chan_num].max_current);
>>> +		of_property_read_u32(child, "color", &color_id);
>>> +		cfg[chan_num].channel_color[num_colors] = color_id;
>>> +		set_bit(color_id, &cfg[chan_num].available_colors);
>>> +		ret = of_property_read_u32(child, "reg", &led_number);
>>> +		cfg[chan_num].grouped_channels[num_colors] = led_number;
>>> +		num_colors++;
>> We have similar parser snippet below in lp55xx_of_populate_pdata().
>> Why this duplication is needed? We also need an update to DT bindings.
>> Now I don't know what's the multicolor DT design for this driver
>> family.
> 
> Ack.  I will update the DT docs as well as reduce redundant code
> 
> 
>>> +	}
>>> +	cfg[chan_num].num_colors = num_colors;
>>> +
>>> +	return 0;
>>> +}
>>> +
>>>  struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>>>  						      struct device_node *np)
>>>  {
>>> @@ -545,7 +611,10 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>>>  	struct lp55xx_platform_data *pdata;
>>>  	struct lp55xx_led_config *cfg;
>>>  	int num_channels;
>>> +	int channel_color;
>>> +	u32 led_number;
>>>  	int i = 0;
>>> +	int ret;
>>>  
>>>  	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
>>>  	if (!pdata)
>>> @@ -565,13 +634,31 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>>>  	pdata->num_channels = num_channels;
>>>  
>>>  	for_each_child_of_node(np, child) {
>>> -		cfg[i].chan_nr = i;
>>> +		ret = of_property_read_u32(child, "color", &channel_color);
>>> +		if (ret) {
>>> +			dev_err(dev,"Missing color property setting white\n");
>>> +			channel_color = LED_COLOR_ID_WHITE;
>>> +		}
>>>  
>>> -		of_property_read_string(child, "chan-name", &cfg[i].name);
>>> -		of_property_read_u8(child, "led-cur", &cfg[i].led_current);
>>> -		of_property_read_u8(child, "max-cur", &cfg[i].max_current);
>>> -		cfg[i].default_trigger =
>>> -			of_get_property(child, "linux,default-trigger", NULL);
>>> +		if (channel_color == LED_COLOR_ID_MULTI)
>>> +			lp5xx_parse_channel_child(child, cfg, i);
>>> +		else {
>>> +			of_property_read_string(child, "chan-name",
>>> +						&cfg[i].name);
>>> +			of_property_read_u8(child, "led-cur",
>>> +					    &cfg[i].led_current);
>>> +			of_property_read_u8(child, "max-cur",
>>> +					    &cfg[i].max_current);
>>> +			cfg[i].default_trigger =
>>> +				of_get_property(child, "linux,default-trigger",
>>> +						NULL);
>>> +			of_property_read_u32(child, "reg", &led_number);
>>> +
>>> +			if (led_number < 0 || led_number > 6)
>>> +				return ERR_PTR(EINVAL);
>>> +
>>> +			cfg[i].chan_nr = led_number;
>>> +		}
>>>  
>>>  		i++;
>>>  	}
>>> diff --git a/drivers/leds/leds-lp55xx-common.h b/drivers/leds/leds-lp55xx-common.h
>>> index 783ed5103ce5..d9c114259dcb 100644
>>> --- a/drivers/leds/leds-lp55xx-common.h
>>> +++ b/drivers/leds/leds-lp55xx-common.h
>>> @@ -12,6 +12,8 @@
>>>  #ifndef _LEDS_LP55XX_COMMON_H
>>>  #define _LEDS_LP55XX_COMMON_H
>>>  
>>> +#include <linux/led-class-multicolor.h>
>>> +
>>>  enum lp55xx_engine_index {
>>>  	LP55XX_ENGINE_INVALID,
>>>  	LP55XX_ENGINE_1,
>>> @@ -109,6 +111,9 @@ struct lp55xx_device_config {
>>>  	/* access brightness register */
>>>  	int (*brightness_fn)(struct lp55xx_led *led);
>>>  
>>> +	/* access specific brightness register */
>>> +	int (*color_intensity_fn)(struct lp55xx_led *led, int chan_num);
>>> +
>>>  	/* current setting function */
>>>  	void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
>>>  
>>> @@ -159,6 +164,7 @@ struct lp55xx_chip {
>>>   * struct lp55xx_led
>>>   * @chan_nr         : Channel number
>>>   * @cdev            : LED class device
>>> + * @mc_cdev	    : Multi color class device
>>>   * @led_current     : Current setting at each led channel
>>>   * @max_current     : Maximun current at each led channel
>>>   * @brightness      : Brightness value
>>> @@ -167,9 +173,12 @@ struct lp55xx_chip {
>>>  struct lp55xx_led {
>>>  	int chan_nr;
>>>  	struct led_classdev cdev;
>>> +	struct led_classdev_mc mc_cdev;
>>>  	u8 led_current;
>>>  	u8 max_current;
>>>  	u8 brightness;
>>> +	int channel_color[LED_COLOR_ID_MAX];
>>> +	int grouped_channels[LED_COLOR_ID_MAX];
>>>  	struct lp55xx_chip *chip;
>>>  };
>>>  
>>> diff --git a/include/linux/platform_data/leds-lp55xx.h b/include/linux/platform_data/leds-lp55xx.h
>>> index 96a787100fda..0ac29f537ab6 100644
>>> --- a/include/linux/platform_data/leds-lp55xx.h
>>> +++ b/include/linux/platform_data/leds-lp55xx.h
>>> @@ -12,6 +12,8 @@
>>>  #ifndef _LEDS_LP55XX_H
>>>  #define _LEDS_LP55XX_H
>>>  
>>> +#include <linux/led-class-multicolor.h>
>>> +
>>>  /* Clock configuration */
>>>  #define LP55XX_CLOCK_AUTO	0
>>>  #define LP55XX_CLOCK_INT	1
>>> @@ -23,6 +25,10 @@ struct lp55xx_led_config {
>>>  	u8 chan_nr;
>>>  	u8 led_current; /* mA x10, 0 if led is not connected */
>>>  	u8 max_current;
>>> +	int num_colors;
>>> +	unsigned long available_colors;
>>> +	u32 channel_color[LED_COLOR_ID_MAX];
>>> +	int grouped_channels[LED_COLOR_ID_MAX];
>> We can do with three-element arrays here.
> 
> Well there is no guarantee with the LP55xx that there will be only 3
> LEDs grouped together unlike the LP50xx.
> 
> You could actually group a RGBW or RGBA in one cluster.  So limiting
> this to 3 elements is not a good thing for this IC.

4 will not be enough?

-- 
Best regards,
Jacek Anaszewski

Re: [PATCH v8 9/9] leds: Update the lp55xx to use the multi color framework

[kbuild test robot]

[-- Attachment #1: Type: text/plain, Size: 1242 bytes --]

Hi Dan,

I love your patch! Yet something to improve:

[auto build test ERROR on linus/master]
[cannot apply to v5.3 next-20190920]
[if your patch is applied to the wrong git tree, please drop us a note to help
improve the system. BTW, we also suggest to use '--base' option to specify the
base tree in git format-patch, please see https://stackoverflow.com/a/37406982]

url:    https://github.com/0day-ci/linux/commits/Dan-Murphy/leds-multicolor-Add-sysfs-interface-definition/20190921-092827
config: x86_64-rhel (attached as .config)
compiler: gcc-7 (Debian 7.4.0-13) 7.4.0
reproduce:
        # save the attached .config to linux build tree
        make ARCH=x86_64 
:::::: branch date: 5 hours ago
:::::: commit date: 5 hours ago

If you fix the issue, kindly add following tag
Reported-by: kbuild test robot <lkp@intel.com>

All errors (new ones prefixed by >>):

>> ERROR: "led_classdev_multicolor_register_ext" [drivers/leds/leds-lp55xx-common.ko] undefined!
>> ERROR: "led_mc_calc_brightness" [drivers/leds/leds-lp55xx-common.ko] undefined!

---
0-DAY kernel test infrastructure                Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all                   Intel Corporation
\0

[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 43718 bytes --]

Re: [PATCH v8 0/9] Multicolor FW v8 update

[Randy Dunlap]

On 9/20/19 10:41 AM, Dan Murphy wrote:
> Hello
> 
> Per request I removed the ops structure.  But there is a potential need for some
> device drivers to have a call back that sets the intesity of the LED color
> without modifying the hardware register.  The hardware registers are only updated
> when the brightness_set<op> is called.  The need arises with the LP50xx chip
> series where the chip has 2 control knobs to modify the output current to the
> LED.  In most cases drivers only have a single brightness register for a given
> iOUT pin.  But the LP50xx has a brightness register that controls cluster
> brightness and individual registers to control the monochrome LED intensity.
> 
> The set_color_brightness call back has been simplified in the LP50xx device
> driver so that it can cache the LED intensity in it's stack for a specific color
> as opposed to having to call back into the MC FW for the current intensity which
> made the driver complex.

"FW" historically means either firmware or firewire.
Please spell out framework in the future.

> Once the set_brightness<op> is called the driver can set the brightness and then
> set the LED intensity registers if the driver has that ability.
> 
> Dan
> 
> Dan Murphy (9):
>   leds: multicolor: Add sysfs interface definition
>   documention: leds: Add multicolor class documentation
>   dt: bindings: Add multicolor class dt bindings documention
>   dt-bindings: leds: Add multicolor ID to the color ID list
>   leds: Add multicolor ID to the color ID list
>   leds: multicolor: Introduce a multicolor class definition
>   dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers
>   leds: lp50xx: Add the LP50XX family of the RGB LED driver
>   leds: Update the lp55xx to use the multi color framework


Thanks.
-- 
~Randy