* [PATCH v11 01/16] dt: bindings: Add multicolor class dt bindings documention
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-09 22:07 ` Jacek Anaszewski
2019-10-08 20:47 ` [PATCH v11 02/16] dt-bindings: leds: Add multicolor ID to the color ID list Dan Murphy
` (14 subsequent siblings)
15 siblings, 1 reply; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, 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 | 98 +++++++++++++++++++
1 file changed, 98 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..8619c9bf1811
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
@@ -0,0 +1,98 @@
+* Multicolor LED properties
+
+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>;
+ };
+ };
+
+};
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* Re: [PATCH v11 01/16] dt: bindings: Add multicolor class dt bindings documention
2019-10-08 20:47 ` [PATCH v11 01/16] dt: bindings: Add multicolor class dt bindings documention Dan Murphy
@ 2019-10-09 22:07 ` Jacek Anaszewski
2019-10-10 0:49 ` Dan Murphy
0 siblings, 1 reply; 32+ messages in thread
From: Jacek Anaszewski @ 2019-10-09 22:07 UTC (permalink / raw)
To: Dan Murphy, pavel; +Cc: linux-leds, linux-kernel
Dan,
On 10/8/19 10:47 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 | 98 +++++++++++++++++++
> 1 file changed, 98 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..8619c9bf1811
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
> @@ -0,0 +1,98 @@
> +* Multicolor LED properties
> +
> +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:
s/Child/child/
> + - 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;
Status is not too fancy function for multi color LED ;-)
I'd skip it entirely for this example if we don't have
anything suitable at the moment for our disposal.
> +
> + 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
^ permalink raw reply [flat|nested] 32+ messages in thread* Re: [PATCH v11 01/16] dt: bindings: Add multicolor class dt bindings documention
2019-10-09 22:07 ` Jacek Anaszewski
@ 2019-10-10 0:49 ` Dan Murphy
2019-10-10 18:42 ` Jacek Anaszewski
0 siblings, 1 reply; 32+ messages in thread
From: Dan Murphy @ 2019-10-10 0:49 UTC (permalink / raw)
To: Jacek Anaszewski, pavel; +Cc: linux-leds, linux-kernel
Jacek
On 10/9/19 5:07 PM, Jacek Anaszewski wrote:
> Dan,
>
> On 10/8/19 10:47 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 | 98 +++++++++++++++++++
>> 1 file changed, 98 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..8619c9bf1811
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
>> @@ -0,0 +1,98 @@
>> +* Multicolor LED properties
>> +
>> +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:
> s/Child/child/
Ack
>
>> + - 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;
> Status is not too fancy function for multi color LED ;-)
> I'd skip it entirely for this example if we don't have
> anything suitable at the moment for our disposal.
Not sure I understand. Status is a good example as a RGB module can be
used to present charging status
Unless I misinterpreted your comment.
Dan
^ permalink raw reply [flat|nested] 32+ messages in thread* Re: [PATCH v11 01/16] dt: bindings: Add multicolor class dt bindings documention
2019-10-10 0:49 ` Dan Murphy
@ 2019-10-10 18:42 ` Jacek Anaszewski
0 siblings, 0 replies; 32+ messages in thread
From: Jacek Anaszewski @ 2019-10-10 18:42 UTC (permalink / raw)
To: Dan Murphy, pavel; +Cc: linux-leds, linux-kernel
Dan,
On 10/10/19 2:49 AM, Dan Murphy wrote:
> Jacek
>
> On 10/9/19 5:07 PM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 10/8/19 10:47 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 | 98 +++++++++++++++++++
>>> 1 file changed, 98 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..8619c9bf1811
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
>>> @@ -0,0 +1,98 @@
>>> +* Multicolor LED properties
>>> +
>>> +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:
>> s/Child/child/
>
> Ack
>
>
>>
>>> + - 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;
>> Status is not too fancy function for multi color LED ;-)
>> I'd skip it entirely for this example if we don't have
>> anything suitable at the moment for our disposal.
>
> Not sure I understand. Status is a good example as a RGB module can be
> used to present charging status
So, maybe LED_FUNCTION_CHARGING ? This implies that color can change
gradually during charging. However me might think of adding
LED_FUNCTION_VBAT or so.
--
Best regards,
Jacek Anaszewski
^ permalink raw reply [flat|nested] 32+ messages in thread
* [PATCH v11 02/16] dt-bindings: leds: Add multicolor ID to the color ID list
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
2019-10-08 20:47 ` [PATCH v11 01/16] dt: bindings: Add multicolor class dt bindings documention Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 03/16] " Dan Murphy
` (13 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, 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
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 03/16] leds: Add multicolor ID to the color ID list
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
2019-10-08 20:47 ` [PATCH v11 01/16] dt: bindings: Add multicolor class dt bindings documention Dan Murphy
2019-10-08 20:47 ` [PATCH v11 02/16] dt-bindings: leds: Add multicolor ID to the color ID list Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition Dan Murphy
` (12 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, 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
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (2 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 03/16] " Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-09 20:11 ` Bjorn Andersson
2019-10-09 21:47 ` Jacek Anaszewski
2019-10-08 20:47 ` [PATCH v11 05/16] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers Dan Murphy
` (11 subsequent siblings)
15 siblings, 2 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, Dan Murphy
Introduce a multicolor class that groups colored LEDs
within a LED node.
The multi color class groups monochrome 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.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
.../ABI/testing/sysfs-class-led-multicolor | 35 +++
Documentation/leds/index.rst | 1 +
Documentation/leds/leds-class-multicolor.rst | 96 +++++++
drivers/leds/Kconfig | 10 +
drivers/leds/Makefile | 1 +
drivers/leds/led-class-multicolor.c | 271 ++++++++++++++++++
include/linux/led-class-multicolor.h | 143 +++++++++
7 files changed, 557 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor
create mode 100644 Documentation/leds/leds-class-multicolor.rst
create mode 100644 drivers/leds/led-class-multicolor.c
create mode 100644 include/linux/led-class-multicolor.h
diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
new file mode 100644
index 000000000000..65cb43de26e6
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
@@ -0,0 +1,35 @@
+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 = 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/<color>_intensity
+Date: Sept 2019
+KernelVersion: 5.5
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read/write
+ The <color>_intensity file is created based on the color
+ defined by the registrar of the class.
+ There is one file per color presented.
+
+ The value of the color is from 0 to
+ /sys/class/leds/<led>/colors/<color>_max_intensity.
+
+What: /sys/class/leds/<led>/colors/<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.
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..7a695a29377e
--- /dev/null
+++ b/Documentation/leds/leds-class-multicolor.rst
@@ -0,0 +1,96 @@
+====================================
+Multi Color LED handling under Linux
+====================================
+
+Description
+===========
+The multi color class groups monochrome 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
+<color>_intensity and <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-r--r-- 1 root root 4096 Jul 7 03:10 blue_intensity
+-r--r--r-- 1 root root 4096 Jul 7 03:10 blue_max_intensity
+-rw-r--r-- 1 root root 4096 Jul 7 03:10 green_intensity
+-r--r--r-- 1 root root 4096 Jul 7 03:10 green_max_intensity
+-rw-r--r-- 1 root root 4096 Jul 7 03:10 red_intensity
+-r--r--r-- 1 root root 4096 Jul 7 03:10 red_max_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 brightness.
+
+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/brightness
+128
diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
index 4b68520ac251..a1ede89afc9e 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..89f4bc9e057c
--- /dev/null
+++ b/drivers/leds/led-class-multicolor.c
@@ -0,0 +1,271 @@
+// 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"
+
+int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+ enum led_brightness brightness,
+ struct led_mc_color_conversion color_component[])
+{
+ struct led_mc_color_entry *priv;
+ int i = 0;
+
+ list_for_each_entry(priv, &mcled_cdev->color_list, list) {
+ color_component[i].color_id = priv->led_color_id;
+ color_component[i].brightness = brightness *
+ priv->intensity / priv->max_intensity;
+ i++;
+ }
+
+ return 0;
+}
+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 *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;
+ 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 *mcled_cdev,
+ int color_id)
+{
+ 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)
+ return -ENOMEM;
+
+ 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 = 0644;
+ 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 = 0444;
+ 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, &mcled_cdev->color_list);
+
+max_intensity_err_out:
+ kfree(max_intensity_file_name);
+intensity_err_out:
+ kfree(intensity_file_name);
+ return ret;
+}
+
+static int led_multicolor_init_color_dir(struct led_classdev_mc *mcled_cdev)
+{
+ struct led_classdev *led_cdev = mcled_cdev->led_cdev;
+ int ret;
+ int i;
+
+ ret = sysfs_create_group(&led_cdev->dev->kobj, &led_color_group);
+ if (ret)
+ return ret;
+
+ for (i = 0; i < LED_COLOR_ID_MAX; i++) {
+ if (test_bit(i, &mcled_cdev->available_colors)) {
+ ret = led_multicolor_init_color(mcled_cdev, i);
+ if (ret)
+ break;
+
+ }
+ }
+
+ 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;
+ int ret;
+
+ if (!mcled_cdev)
+ return -EINVAL;
+
+ led_cdev = mcled_cdev->led_cdev;
+ INIT_LIST_HEAD(&mcled_cdev->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(mcled_cdev);
+}
+EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext);
+
+void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev)
+{
+ struct led_mc_color_entry *priv, *next;
+
+ if (!mcled_cdev)
+ return;
+
+ list_for_each_entry_safe(priv, next, &mcled_cdev->color_list, list)
+ list_del(&priv->list);
+
+ 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);
+}
+
+int devm_led_classdev_multicolor_register_ext(struct device *parent,
+ struct led_classdev_mc *mcled_cdev,
+ struct led_init_data *init_data)
+{
+ 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_ext);
+
+static int devm_led_classdev_multicolor_match(struct device *dev,
+ void *res, void *data)
+{
+ struct led_classdev_mc **p = res;
+
+ if (WARN_ON(!p || !*p))
+ return 0;
+
+ return *p == data;
+}
+
+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..5d0cdca32223
--- /dev/null
+++ b/include/linux/led-class-multicolor.h
@@ -0,0 +1,143 @@
+/* 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_mc_color_conversion {
+ int color_id;
+ int brightness;
+ int output_num;
+};
+
+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;
+};
+
+struct led_classdev_mc {
+ /* led class device */
+ struct led_classdev *led_cdev;
+ struct list_head color_list;
+
+ unsigned long available_colors;
+ int num_leds;
+};
+#ifdef CONFIG_LEDS_CLASS_MULTI_COLOR
+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
+ */
+int led_classdev_multicolor_register_ext(struct device *parent,
+ struct led_classdev_mc *mcled_cdev,
+ struct led_init_data *init_data);
+
+static inline int led_classdev_multicolor_register(struct device *parent,
+ struct led_classdev_mc *mcled_cdev)
+{
+ return 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
+ */
+void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);
+
+/* Calculate brightness for the monochrome LED cluster */
+int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+ enum led_brightness brightness,
+ struct led_mc_color_conversion color_component[]);
+
+int devm_led_classdev_multicolor_register_ext(struct device *parent,
+ struct led_classdev_mc *mcled_cdev,
+ struct led_init_data *init_data);
+
+static inline int devm_led_classdev_multicolor_register(struct device *parent,
+ struct led_classdev_mc *mcled_cdev)
+{
+ return devm_led_classdev_multicolor_register_ext(parent, mcled_cdev,
+ NULL);
+}
+
+void devm_led_classdev_multicolor_unregister(struct device *parent,
+ struct led_classdev_mc *mcled_cdev);
+#else
+
+static inline struct led_classdev_mc *lcdev_to_mccdev(
+ struct led_classdev *lcdev)
+{
+ return NULL;
+}
+
+static inline int led_classdev_multicolor_register_ext(struct device *parent,
+ struct led_classdev_mc *mcled_cdev,
+ struct led_init_data *init_data)
+{
+ return -EINVAL;
+}
+
+static inline int led_classdev_multicolor_register(struct device *parent,
+ struct led_classdev_mc *mcled_cdev)
+{
+ return -EINVAL;
+}
+
+static inline void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev) {}
+
+static inline int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
+ enum led_brightness brightness,
+ struct led_mc_color_conversion color_component[])
+{
+ return -EINVAL;
+}
+
+static inline int devm_led_classdev_multicolor_register_ext(struct device *parent,
+ struct led_classdev_mc *mcled_cdev,
+ struct led_init_data *init_data)
+{
+ return -EINVAL;
+}
+
+static inline int devm_led_classdev_multicolor_register(struct device *parent,
+ struct led_classdev_mc *mcled_cdev)
+{
+ return -EINVAL;
+}
+
+static inline void devm_led_classdev_multicolor_unregister(struct device *parent,
+ struct led_classdev_mc *mcled_cdev) {}
+
+#endif /* CONFIG_LEDS_CLASS_MULTI_COLOR */
+#endif /* __LINUX_MULTICOLOR_LEDS_H_INCLUDED */
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-08 20:47 ` [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition Dan Murphy
@ 2019-10-09 20:11 ` Bjorn Andersson
2019-10-09 20:44 ` Dan Murphy
2019-10-09 21:47 ` Jacek Anaszewski
1 sibling, 1 reply; 32+ messages in thread
From: Bjorn Andersson @ 2019-10-09 20:11 UTC (permalink / raw)
To: Dan Murphy; +Cc: Jacek Anaszewski, Pavel Machek, Linux LED Subsystem, lkml
On Tue, Oct 8, 2019 at 1:49 PM Dan Murphy <dmurphy@ti.com> wrote:
>
> Introduce a multicolor class that groups colored LEDs
> within a LED node.
>
> The multi color class groups monochrome 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.
>
Thanks for making progress on this, it's been the one outstanding
question mark for the long overdue respin of the Qualcomm LPG driver.
But while it works for the LPG, in that it has outputs named "RGB" I
have boards with "generic" LED drivers that are connected to RGB LEDs.
So per your proposed solution we would need to add the additional
mc_class handling to every single LED driver that might be used to
sink current into an RGB LED.
I also don't see anything preventing hardware designers from feeding
single RGB LEDs from multiple different LED controllers, something the
current proposal would prohibit.
Regards,
Bjorn
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
> .../ABI/testing/sysfs-class-led-multicolor | 35 +++
> Documentation/leds/index.rst | 1 +
> Documentation/leds/leds-class-multicolor.rst | 96 +++++++
> drivers/leds/Kconfig | 10 +
> drivers/leds/Makefile | 1 +
> drivers/leds/led-class-multicolor.c | 271 ++++++++++++++++++
> include/linux/led-class-multicolor.h | 143 +++++++++
> 7 files changed, 557 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor
> create mode 100644 Documentation/leds/leds-class-multicolor.rst
> create mode 100644 drivers/leds/led-class-multicolor.c
> create mode 100644 include/linux/led-class-multicolor.h
>
> diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
> new file mode 100644
> index 000000000000..65cb43de26e6
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
> @@ -0,0 +1,35 @@
> +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 = 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/<color>_intensity
> +Date: Sept 2019
> +KernelVersion: 5.5
> +Contact: Dan Murphy <dmurphy@ti.com>
> +Description: read/write
> + The <color>_intensity file is created based on the color
> + defined by the registrar of the class.
> + There is one file per color presented.
> +
> + The value of the color is from 0 to
> + /sys/class/leds/<led>/colors/<color>_max_intensity.
> +
> +What: /sys/class/leds/<led>/colors/<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.
> 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..7a695a29377e
> --- /dev/null
> +++ b/Documentation/leds/leds-class-multicolor.rst
> @@ -0,0 +1,96 @@
> +====================================
> +Multi Color LED handling under Linux
> +====================================
> +
> +Description
> +===========
> +The multi color class groups monochrome 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
> +<color>_intensity and <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-r--r-- 1 root root 4096 Jul 7 03:10 blue_intensity
> +-r--r--r-- 1 root root 4096 Jul 7 03:10 blue_max_intensity
> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 green_intensity
> +-r--r--r-- 1 root root 4096 Jul 7 03:10 green_max_intensity
> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 red_intensity
> +-r--r--r-- 1 root root 4096 Jul 7 03:10 red_max_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 brightness.
> +
> +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/brightness
> +128
> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
> index 4b68520ac251..a1ede89afc9e 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..89f4bc9e057c
> --- /dev/null
> +++ b/drivers/leds/led-class-multicolor.c
> @@ -0,0 +1,271 @@
> +// 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"
> +
> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
> + enum led_brightness brightness,
> + struct led_mc_color_conversion color_component[])
> +{
> + struct led_mc_color_entry *priv;
> + int i = 0;
> +
> + list_for_each_entry(priv, &mcled_cdev->color_list, list) {
> + color_component[i].color_id = priv->led_color_id;
> + color_component[i].brightness = brightness *
> + priv->intensity / priv->max_intensity;
> + i++;
> + }
> +
> + return 0;
> +}
> +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 *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;
> + 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 *mcled_cdev,
> + int color_id)
> +{
> + 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)
> + return -ENOMEM;
> +
> + 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 = 0644;
> + 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 = 0444;
> + 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, &mcled_cdev->color_list);
> +
> +max_intensity_err_out:
> + kfree(max_intensity_file_name);
> +intensity_err_out:
> + kfree(intensity_file_name);
> + return ret;
> +}
> +
> +static int led_multicolor_init_color_dir(struct led_classdev_mc *mcled_cdev)
> +{
> + struct led_classdev *led_cdev = mcled_cdev->led_cdev;
> + int ret;
> + int i;
> +
> + ret = sysfs_create_group(&led_cdev->dev->kobj, &led_color_group);
> + if (ret)
> + return ret;
> +
> + for (i = 0; i < LED_COLOR_ID_MAX; i++) {
> + if (test_bit(i, &mcled_cdev->available_colors)) {
> + ret = led_multicolor_init_color(mcled_cdev, i);
> + if (ret)
> + break;
> +
> + }
> + }
> +
> + 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;
> + int ret;
> +
> + if (!mcled_cdev)
> + return -EINVAL;
> +
> + led_cdev = mcled_cdev->led_cdev;
> + INIT_LIST_HEAD(&mcled_cdev->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(mcled_cdev);
> +}
> +EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext);
> +
> +void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev)
> +{
> + struct led_mc_color_entry *priv, *next;
> +
> + if (!mcled_cdev)
> + return;
> +
> + list_for_each_entry_safe(priv, next, &mcled_cdev->color_list, list)
> + list_del(&priv->list);
> +
> + 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);
> +}
> +
> +int devm_led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data)
> +{
> + 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_ext);
> +
> +static int devm_led_classdev_multicolor_match(struct device *dev,
> + void *res, void *data)
> +{
> + struct led_classdev_mc **p = res;
> +
> + if (WARN_ON(!p || !*p))
> + return 0;
> +
> + return *p == data;
> +}
> +
> +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..5d0cdca32223
> --- /dev/null
> +++ b/include/linux/led-class-multicolor.h
> @@ -0,0 +1,143 @@
> +/* 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_mc_color_conversion {
> + int color_id;
> + int brightness;
> + int output_num;
> +};
> +
> +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;
> +};
> +
> +struct led_classdev_mc {
> + /* led class device */
> + struct led_classdev *led_cdev;
> + struct list_head color_list;
> +
> + unsigned long available_colors;
> + int num_leds;
> +};
> +#ifdef CONFIG_LEDS_CLASS_MULTI_COLOR
> +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
> + */
> +int led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data);
> +
> +static inline int led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return 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
> + */
> +void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);
> +
> +/* Calculate brightness for the monochrome LED cluster */
> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
> + enum led_brightness brightness,
> + struct led_mc_color_conversion color_component[]);
> +
> +int devm_led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data);
> +
> +static inline int devm_led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return devm_led_classdev_multicolor_register_ext(parent, mcled_cdev,
> + NULL);
> +}
> +
> +void devm_led_classdev_multicolor_unregister(struct device *parent,
> + struct led_classdev_mc *mcled_cdev);
> +#else
> +
> +static inline struct led_classdev_mc *lcdev_to_mccdev(
> + struct led_classdev *lcdev)
> +{
> + return NULL;
> +}
> +
> +static inline int led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data)
> +{
> + return -EINVAL;
> +}
> +
> +static inline int led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return -EINVAL;
> +}
> +
> +static inline void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev) {}
> +
> +static inline int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
> + enum led_brightness brightness,
> + struct led_mc_color_conversion color_component[])
> +{
> + return -EINVAL;
> +}
> +
> +static inline int devm_led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data)
> +{
> + return -EINVAL;
> +}
> +
> +static inline int devm_led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return -EINVAL;
> +}
> +
> +static inline void devm_led_classdev_multicolor_unregister(struct device *parent,
> + struct led_classdev_mc *mcled_cdev) {}
> +
> +#endif /* CONFIG_LEDS_CLASS_MULTI_COLOR */
> +#endif /* __LINUX_MULTICOLOR_LEDS_H_INCLUDED */
> --
> 2.22.0.214.g8dca754b1e
>
^ permalink raw reply [flat|nested] 32+ messages in thread* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-09 20:11 ` Bjorn Andersson
@ 2019-10-09 20:44 ` Dan Murphy
2019-10-09 23:25 ` Bjorn Andersson
0 siblings, 1 reply; 32+ messages in thread
From: Dan Murphy @ 2019-10-09 20:44 UTC (permalink / raw)
To: Bjorn Andersson; +Cc: Jacek Anaszewski, Pavel Machek, Linux LED Subsystem, lkml
Bjorn
On 10/9/19 3:11 PM, Bjorn Andersson wrote:
> On Tue, Oct 8, 2019 at 1:49 PM Dan Murphy <dmurphy@ti.com> wrote:
>> Introduce a multicolor class that groups colored LEDs
>> within a LED node.
>>
>> The multi color class groups monochrome 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.
>>
> Thanks for making progress on this, it's been the one outstanding
> question mark for the long overdue respin of the Qualcomm LPG driver.
> But while it works for the LPG, in that it has outputs named "RGB" I
> have boards with "generic" LED drivers that are connected to RGB LEDs.
> So per your proposed solution we would need to add the additional
You don't have to add the MC class to those drivers. This is an
optional framework but if you wanted to use the framework for specific
devices then yes you would need to add that support. This is why I did
the LP55xx patches to demonstrate the feasibility since the LP50xx has
the MC class intelligence already.
The LP55xx driver can register to the LED class and/or the MC LED class
pending on the DT organization.
I don't plan on going through all of TI's RGB drivers and retrofitting
them to the MC class. I do have to update the GPIO LED driver to use
the class but that work is still pending.
I may also update the Motorola PCAP driver as well since I have a Droid4
to test.
> mc_class handling to every single LED driver that might be used to
> sink current into an RGB LED.
>
> I also don't see anything preventing hardware designers from feeding
> single RGB LEDs from multiple different LED controllers, something the
> current proposal would prohibit.
What do you mean by a single RGB LED? Are you referring to a RGB module?
http://wiki.sunfounder.cc/index.php?title=RGB_LED_Module
There is no prevention for HW designers to put a driver on each LED
output but I am not sure why they would incur
the additional BOM cost seems quite silly unless you have an unlimited
budget ;)
If they did design the system that way then the SW would need to revert
back to the standard LED class as it is done today.
Dan
^ permalink raw reply [flat|nested] 32+ messages in thread
* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-09 20:44 ` Dan Murphy
@ 2019-10-09 23:25 ` Bjorn Andersson
2019-10-10 0:43 ` Dan Murphy
0 siblings, 1 reply; 32+ messages in thread
From: Bjorn Andersson @ 2019-10-09 23:25 UTC (permalink / raw)
To: Dan Murphy; +Cc: Jacek Anaszewski, Pavel Machek, Linux LED Subsystem, lkml
On Wed 09 Oct 13:44 PDT 2019, Dan Murphy wrote:
> Bjorn
>
> On 10/9/19 3:11 PM, Bjorn Andersson wrote:
> > On Tue, Oct 8, 2019 at 1:49 PM Dan Murphy <dmurphy@ti.com> wrote:
> > > Introduce a multicolor class that groups colored LEDs
> > > within a LED node.
> > >
> > > The multi color class groups monochrome 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.
> > >
> > Thanks for making progress on this, it's been the one outstanding
> > question mark for the long overdue respin of the Qualcomm LPG driver.
>
> > But while it works for the LPG, in that it has outputs named "RGB" I
> > have boards with "generic" LED drivers that are connected to RGB LEDs.
> > So per your proposed solution we would need to add the additional
>
> You don't have to add the MC class to those drivers. This is an optional
> framework but if you wanted to use the framework for specific devices then
> yes you would need to add that support. This is why I did the LP55xx patches
> to demonstrate the feasibility since the LP50xx has the MC class
> intelligence already.
>
Correct me if I've misunderstood something, but if I have a product
using e.g. lm3533 connected to an RGB LED then the correct way to
represent this towards userspace is to introduce the MC class in the
lm3533 LED driver, no?
> The LP55xx driver can register to the LED class and/or the MC LED class
> pending on the DT organization.
>
Understood.
> I don't plan on going through all of TI's RGB drivers and retrofitting them
> to the MC class. I do have to update the GPIO LED driver to use the class
> but that work is still pending.
>
> I may also update the Motorola PCAP driver as well since I have a Droid4 to
> test.
>
My concern with this is that being connected to a RGB LED is not a
property of the controller, but the system design and the proposed
implementation makes it a property of each controller.
I'm not saying that the proposed path is wrong, I'm saying that we have
83 files named leds-*.c in drivers/leds and this adaption needs to
happen on each one.
And I'm not saying I expect you to do this.
> > mc_class handling to every single LED driver that might be used to
> > sink current into an RGB LED.
> >
> > I also don't see anything preventing hardware designers from feeding
> > single RGB LEDs from multiple different LED controllers, something the
> > current proposal would prohibit.
>
> What do you mean by a single RGB LED? Are you referring to a RGB module?
>
> http://wiki.sunfounder.cc/index.php?title=RGB_LED_Module
>
Yes
> There is no prevention for HW designers to put a driver on each LED output
> but I am not sure why they would incur
>
> the additional BOM cost seems quite silly unless you have an unlimited
> budget ;)
>
So if you have a system with e.g. 8 PWM channels on one PMIC and a
single PWM available on a different PMIC then you're saying that the
hardware guys would be silly to believe that they can drive 3 RGB LEDS
off this?
> If they did design the system that way then the SW would need to revert back
> to the standard LED class as it is done today.
>
If that is the agreed upon design then I'll continue to adapt my LED
drivers to the MC class.
Regards,
Bjorn
^ permalink raw reply [flat|nested] 32+ messages in thread
* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-09 23:25 ` Bjorn Andersson
@ 2019-10-10 0:43 ` Dan Murphy
0 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-10 0:43 UTC (permalink / raw)
To: Bjorn Andersson; +Cc: Jacek Anaszewski, Pavel Machek, Linux LED Subsystem, lkml
Bjorn
On 10/9/19 6:25 PM, Bjorn Andersson wrote:
> On Wed 09 Oct 13:44 PDT 2019, Dan Murphy wrote:
>
>> Bjorn
>>
>> On 10/9/19 3:11 PM, Bjorn Andersson wrote:
>>> On Tue, Oct 8, 2019 at 1:49 PM Dan Murphy <dmurphy@ti.com> wrote:
>>>> Introduce a multicolor class that groups colored LEDs
>>>> within a LED node.
>>>>
>>>> The multi color class groups monochrome 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.
>>>>
>>> Thanks for making progress on this, it's been the one outstanding
>>> question mark for the long overdue respin of the Qualcomm LPG driver.
>>> But while it works for the LPG, in that it has outputs named "RGB" I
>>> have boards with "generic" LED drivers that are connected to RGB LEDs.
>>> So per your proposed solution we would need to add the additional
>> You don't have to add the MC class to those drivers. This is an optional
>> framework but if you wanted to use the framework for specific devices then
>> yes you would need to add that support. This is why I did the LP55xx patches
>> to demonstrate the feasibility since the LP50xx has the MC class
>> intelligence already.
>>
> Correct me if I've misunderstood something, but if I have a product
> using e.g. lm3533 connected to an RGB LED then the correct way to
> represent this towards userspace is to introduce the MC class in the
> lm3533 LED driver, no?
>
Not necessarily. If the RGB LED is to be used as a RGB module and not
as independent LEDs.
For instance on smartphones if you had that RGB module connected to the
LM3533 and needed to mix colors to give different status indicators then
yes you would use the MC class. As the MC class presents and treats the
module as a single LED with individual color mixing control knobs.
If you were using each LED for a separate use cases then you would want
to present these as individual LEDs as done today.
>> The LP55xx driver can register to the LED class and/or the MC LED class
>> pending on the DT organization.
>>
> Understood.
>
>> I don't plan on going through all of TI's RGB drivers and retrofitting them
>> to the MC class. I do have to update the GPIO LED driver to use the class
>> but that work is still pending.
>>
>> I may also update the Motorola PCAP driver as well since I have a Droid4 to
>> test.
>>
> My concern with this is that being connected to a RGB LED is not a
> property of the controller, but the system design and the proposed
> implementation makes it a property of each controller.
>
> I'm not saying that the proposed path is wrong, I'm saying that we have
> 83 files named leds-*.c in drivers/leds and this adaption needs to
> happen on each one.
Agreed. I would expect the adoption to be done on a case by case basis
driven by usage and need.
>
>
> And I'm not saying I expect you to do this.
Phew. I did not think you were. I will only convert drivers that I can
could test.
>
>>> mc_class handling to every single LED driver that might be used to
>>> sink current into an RGB LED.
>>>
>>> I also don't see anything preventing hardware designers from feeding
>>> single RGB LEDs from multiple different LED controllers, something the
>>> current proposal would prohibit.
>> What do you mean by a single RGB LED? Are you referring to a RGB module?
>>
>> http://wiki.sunfounder.cc/index.php?title=RGB_LED_Module
>>
> Yes
>
>> There is no prevention for HW designers to put a driver on each LED output
>> but I am not sure why they would incur
>>
>> the additional BOM cost seems quite silly unless you have an unlimited
>> budget ;)
>>
> So if you have a system with e.g. 8 PWM channels on one PMIC and a
> single PWM available on a different PMIC then you're saying that the
> hardware guys would be silly to believe that they can drive 3 RGB LEDS
> off this?
OK I must have removed my question to you on presenting a use case.
Grouping LEDs across multiple devices would an issue yes but we would
need a design or hardware to develop a good solution.
>
>> If they did design the system that way then the SW would need to revert back
>> to the standard LED class as it is done today.
>>
> If that is the agreed upon design then I'll continue to adapt my LED
> drivers to the MC class.
For now this is the basic design. We are willing to take other
suggestions. We appreciate the feedback.
Dan
^ permalink raw reply [flat|nested] 32+ messages in thread
* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-08 20:47 ` [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition Dan Murphy
2019-10-09 20:11 ` Bjorn Andersson
@ 2019-10-09 21:47 ` Jacek Anaszewski
2019-10-10 0:27 ` Dan Murphy
1 sibling, 1 reply; 32+ messages in thread
From: Jacek Anaszewski @ 2019-10-09 21:47 UTC (permalink / raw)
To: Dan Murphy, pavel; +Cc: linux-leds, linux-kernel
Dan,
On 10/8/19 10:47 PM, Dan Murphy wrote:
> Introduce a multicolor class that groups colored LEDs
> within a LED node.
>
> The multi color class groups monochrome 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.
>
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
> .../ABI/testing/sysfs-class-led-multicolor | 35 +++
> Documentation/leds/index.rst | 1 +
> Documentation/leds/leds-class-multicolor.rst | 96 +++++++
> drivers/leds/Kconfig | 10 +
> drivers/leds/Makefile | 1 +
> drivers/leds/led-class-multicolor.c | 271 ++++++++++++++++++
> include/linux/led-class-multicolor.h | 143 +++++++++
> 7 files changed, 557 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor
> create mode 100644 Documentation/leds/leds-class-multicolor.rst
> create mode 100644 drivers/leds/led-class-multicolor.c
> create mode 100644 include/linux/led-class-multicolor.h
>
> diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
> new file mode 100644
> index 000000000000..65cb43de26e6
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
> @@ -0,0 +1,35 @@
> +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 = brightness * <color>_intensity/<color>_max_intensity
This equation alone incites questions on how it is supposed to work.
It would be better to present the whole algorithm for calculating
combined color here.
> +
> + 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/<color>_intensity
> +Date: Sept 2019
> +KernelVersion: 5.5
> +Contact: Dan Murphy <dmurphy@ti.com>
> +Description: read/write
> + The <color>_intensity file is created based on the color
> + defined by the registrar of the class.
> + There is one file per color presented.
> +
> + The value of the color is from 0 to
> + /sys/class/leds/<led>/colors/<color>_max_intensity.
> +
> +What: /sys/class/leds/<led>/colors/<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.
> 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..7a695a29377e
> --- /dev/null
> +++ b/Documentation/leds/leds-class-multicolor.rst
> @@ -0,0 +1,96 @@
> +====================================
> +Multi Color LED handling under Linux
> +====================================
> +
> +Description
> +===========
> +The multi color class groups monochrome 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
> +<color>_intensity and <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-r--r-- 1 root root 4096 Jul 7 03:10 blue_intensity
> +-r--r--r-- 1 root root 4096 Jul 7 03:10 blue_max_intensity
> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 green_intensity
> +-r--r--r-- 1 root root 4096 Jul 7 03:10 green_max_intensity
> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 red_intensity
> +-r--r--r-- 1 root root 4096 Jul 7 03:10 red_max_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 brightness.
> +
> +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/brightness
> +128
> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
> index 4b68520ac251..a1ede89afc9e 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..89f4bc9e057c
> --- /dev/null
> +++ b/drivers/leds/led-class-multicolor.c
> @@ -0,0 +1,271 @@
> +// 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"
> +
> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
> + enum led_brightness brightness,
> + struct led_mc_color_conversion color_component[])
Now the function name doesn't match with the output array name.
How about:
- led_mc_brightness_to_color_components
- led_mc_calc_color_components
Other suggestions?
> +{
> + struct led_mc_color_entry *priv;
> + int i = 0;
> +
> + list_for_each_entry(priv, &mcled_cdev->color_list, list) {
> + color_component[i].color_id = priv->led_color_id;
> + color_component[i].brightness = brightness *
> + priv->intensity / priv->max_intensity;
> + i++;
> + }
> +
> + return 0;
> +}
> +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 *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;
> + 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 *mcled_cdev,
> + int color_id)
> +{
> + 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)
> + return -ENOMEM;
> +
> + 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 = 0644;
> + 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 = 0444;
> + 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, &mcled_cdev->color_list);
> +
> +max_intensity_err_out:
> + kfree(max_intensity_file_name);
> +intensity_err_out:
> + kfree(intensity_file_name);
> + return ret;
> +}
> +
> +static int led_multicolor_init_color_dir(struct led_classdev_mc *mcled_cdev)
> +{
> + struct led_classdev *led_cdev = mcled_cdev->led_cdev;
> + int ret;
> + int i;
> +
> + ret = sysfs_create_group(&led_cdev->dev->kobj, &led_color_group);
> + if (ret)
> + return ret;
> +
> + for (i = 0; i < LED_COLOR_ID_MAX; i++) {
> + if (test_bit(i, &mcled_cdev->available_colors)) {
> + ret = led_multicolor_init_color(mcled_cdev, i);
> + if (ret)
> + break;
> +
> + }
> + }
> +
> + 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;
> + int ret;
> +
> + if (!mcled_cdev)
> + return -EINVAL;
> +
> + led_cdev = mcled_cdev->led_cdev;
> + INIT_LIST_HEAD(&mcled_cdev->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(mcled_cdev);
> +}
> +EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext);
> +
> +void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev)
> +{
> + struct led_mc_color_entry *priv, *next;
> +
> + if (!mcled_cdev)
> + return;
> +
> + list_for_each_entry_safe(priv, next, &mcled_cdev->color_list, list)
> + list_del(&priv->list);
> +
> + 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);
> +}
> +
> +int devm_led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data)
> +{
> + 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_ext);
> +
> +static int devm_led_classdev_multicolor_match(struct device *dev,
> + void *res, void *data)
> +{
> + struct led_classdev_mc **p = res;
> +
> + if (WARN_ON(!p || !*p))
> + return 0;
> +
> + return *p == data;
> +}
> +
> +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..5d0cdca32223
> --- /dev/null
> +++ b/include/linux/led-class-multicolor.h
> @@ -0,0 +1,143 @@
> +/* 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_mc_color_conversion {
> + int color_id;
> + int brightness;
> + int output_num;
> +};
> +
> +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;
> +};
> +
> +struct led_classdev_mc {
> + /* led class device */
> + struct led_classdev *led_cdev;
> + struct list_head color_list;
> +
> + unsigned long available_colors;
> + int num_leds;
> +};
> +#ifdef CONFIG_LEDS_CLASS_MULTI_COLOR
> +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
> + */
> +int led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data);
> +
> +static inline int led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return 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
> + */
> +void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);
> +
> +/* Calculate brightness for the monochrome LED cluster */
> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
> + enum led_brightness brightness,
> + struct led_mc_color_conversion color_component[]);
> +
> +int devm_led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data);
> +
> +static inline int devm_led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return devm_led_classdev_multicolor_register_ext(parent, mcled_cdev,
> + NULL);
> +}
> +
> +void devm_led_classdev_multicolor_unregister(struct device *parent,
> + struct led_classdev_mc *mcled_cdev);
> +#else
> +
> +static inline struct led_classdev_mc *lcdev_to_mccdev(
> + struct led_classdev *lcdev)
> +{
> + return NULL;
> +}
> +
> +static inline int led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data)
> +{
> + return -EINVAL;
> +}
> +
> +static inline int led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return -EINVAL;
> +}
> +
> +static inline void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev) {}
> +
> +static inline int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
> + enum led_brightness brightness,
> + struct led_mc_color_conversion color_component[])
> +{
> + return -EINVAL;
> +}
> +
> +static inline int devm_led_classdev_multicolor_register_ext(struct device *parent,
> + struct led_classdev_mc *mcled_cdev,
> + struct led_init_data *init_data)
> +{
> + return -EINVAL;
> +}
> +
> +static inline int devm_led_classdev_multicolor_register(struct device *parent,
> + struct led_classdev_mc *mcled_cdev)
> +{
> + return -EINVAL;
> +}
Do you have use case for which these no-ops would be useful?
We don't have no-ops for any of current LED API beside triggers,
which are indeed useful.
> +static inline void devm_led_classdev_multicolor_unregister(struct device *parent,
> + struct led_classdev_mc *mcled_cdev) {}
> +
> +#endif /* CONFIG_LEDS_CLASS_MULTI_COLOR */
> +#endif /* __LINUX_MULTICOLOR_LEDS_H_INCLUDED */
>
--
Best regards,
Jacek Anaszewski
^ permalink raw reply [flat|nested] 32+ messages in thread* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-09 21:47 ` Jacek Anaszewski
@ 2019-10-10 0:27 ` Dan Murphy
2019-10-10 18:36 ` Jacek Anaszewski
2019-10-10 18:37 ` Jacek Anaszewski
0 siblings, 2 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-10 0:27 UTC (permalink / raw)
To: Jacek Anaszewski, pavel; +Cc: linux-leds, linux-kernel
Jacek
On 10/9/19 4:47 PM, Jacek Anaszewski wrote:
> Dan,
>
> On 10/8/19 10:47 PM, Dan Murphy wrote:
>> Introduce a multicolor class that groups colored LEDs
>> within a LED node.
>>
>> The multi color class groups monochrome 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.
>>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>> .../ABI/testing/sysfs-class-led-multicolor | 35 +++
>> Documentation/leds/index.rst | 1 +
>> Documentation/leds/leds-class-multicolor.rst | 96 +++++++
>> drivers/leds/Kconfig | 10 +
>> drivers/leds/Makefile | 1 +
>> drivers/leds/led-class-multicolor.c | 271 ++++++++++++++++++
>> include/linux/led-class-multicolor.h | 143 +++++++++
>> 7 files changed, 557 insertions(+)
>> create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor
>> create mode 100644 Documentation/leds/leds-class-multicolor.rst
>> create mode 100644 drivers/leds/led-class-multicolor.c
>> create mode 100644 include/linux/led-class-multicolor.h
>>
>> diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
>> new file mode 100644
>> index 000000000000..65cb43de26e6
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
>> @@ -0,0 +1,35 @@
>> +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 = brightness * <color>_intensity/<color>_max_intensity
> This equation alone incites questions on how it is supposed to work.
>
> It would be better to present the whole algorithm for calculating
> combined color here.
I am not sure I follow. Isn't that explained in the class document?
>
>> +
>> + 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/<color>_intensity
>> +Date: Sept 2019
>> +KernelVersion: 5.5
>> +Contact: Dan Murphy <dmurphy@ti.com>
>> +Description: read/write
>> + The <color>_intensity file is created based on the color
>> + defined by the registrar of the class.
>> + There is one file per color presented.
>> +
>> + The value of the color is from 0 to
>> + /sys/class/leds/<led>/colors/<color>_max_intensity.
>> +
>> +What: /sys/class/leds/<led>/colors/<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.
>> 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..7a695a29377e
>> --- /dev/null
>> +++ b/Documentation/leds/leds-class-multicolor.rst
>> @@ -0,0 +1,96 @@
>> +====================================
>> +Multi Color LED handling under Linux
>> +====================================
>> +
>> +Description
>> +===========
>> +The multi color class groups monochrome 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
>> +<color>_intensity and <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-r--r-- 1 root root 4096 Jul 7 03:10 blue_intensity
>> +-r--r--r-- 1 root root 4096 Jul 7 03:10 blue_max_intensity
>> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 green_intensity
>> +-r--r--r-- 1 root root 4096 Jul 7 03:10 green_max_intensity
>> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 red_intensity
>> +-r--r--r-- 1 root root 4096 Jul 7 03:10 red_max_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 brightness.
>> +
>> +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/brightness
>> +128
>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
>> index 4b68520ac251..a1ede89afc9e 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..89f4bc9e057c
>> --- /dev/null
>> +++ b/drivers/leds/led-class-multicolor.c
>> @@ -0,0 +1,271 @@
>> +// 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"
>> +
>> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
>> + enum led_brightness brightness,
>> + struct led_mc_color_conversion color_component[])
> Now the function name doesn't match with the output array name.
>
> How about:
>
> - led_mc_brightness_to_color_components
> - led_mc_calc_color_components
>
> Other suggestions?
led_mc_calc_color_components is fine the first one is to long
>
>> +{
>> + struct led_mc_color_entry *priv;
>> + int i = 0;
>> +
>> + list_for_each_entry(priv, &mcled_cdev->color_list, list) {
>> + color_component[i].color_id = priv->led_color_id;
>> + color_component[i].brightness = brightness *
>> + priv->intensity / priv->max_intensity;
>> + i++;
>> + }
>> +
>> + return 0;
>> +}
>> +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 *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;
>> + 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 *mcled_cdev,
>> + int color_id)
>> +{
>> + 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)
>> + return -ENOMEM;
>> +
>> + 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 = 0644;
>> + 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 = 0444;
>> + 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, &mcled_cdev->color_list);
>> +
>> +max_intensity_err_out:
>> + kfree(max_intensity_file_name);
>> +intensity_err_out:
>> + kfree(intensity_file_name);
>> + return ret;
>> +}
>> +
>> +static int led_multicolor_init_color_dir(struct led_classdev_mc *mcled_cdev)
>> +{
>> + struct led_classdev *led_cdev = mcled_cdev->led_cdev;
>> + int ret;
>> + int i;
>> +
>> + ret = sysfs_create_group(&led_cdev->dev->kobj, &led_color_group);
>> + if (ret)
>> + return ret;
>> +
>> + for (i = 0; i < LED_COLOR_ID_MAX; i++) {
>> + if (test_bit(i, &mcled_cdev->available_colors)) {
>> + ret = led_multicolor_init_color(mcled_cdev, i);
>> + if (ret)
>> + break;
>> +
>> + }
>> + }
>> +
>> + 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;
>> + int ret;
>> +
>> + if (!mcled_cdev)
>> + return -EINVAL;
>> +
>> + led_cdev = mcled_cdev->led_cdev;
>> + INIT_LIST_HEAD(&mcled_cdev->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(mcled_cdev);
>> +}
>> +EXPORT_SYMBOL_GPL(led_classdev_multicolor_register_ext);
>> +
>> +void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev)
>> +{
>> + struct led_mc_color_entry *priv, *next;
>> +
>> + if (!mcled_cdev)
>> + return;
>> +
>> + list_for_each_entry_safe(priv, next, &mcled_cdev->color_list, list)
>> + list_del(&priv->list);
>> +
>> + 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);
>> +}
>> +
>> +int devm_led_classdev_multicolor_register_ext(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev,
>> + struct led_init_data *init_data)
>> +{
>> + 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_ext);
>> +
>> +static int devm_led_classdev_multicolor_match(struct device *dev,
>> + void *res, void *data)
>> +{
>> + struct led_classdev_mc **p = res;
>> +
>> + if (WARN_ON(!p || !*p))
>> + return 0;
>> +
>> + return *p == data;
>> +}
>> +
>> +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..5d0cdca32223
>> --- /dev/null
>> +++ b/include/linux/led-class-multicolor.h
>> @@ -0,0 +1,143 @@
>> +/* 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_mc_color_conversion {
>> + int color_id;
>> + int brightness;
>> + int output_num;
>> +};
>> +
>> +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;
>> +};
>> +
>> +struct led_classdev_mc {
>> + /* led class device */
>> + struct led_classdev *led_cdev;
>> + struct list_head color_list;
>> +
>> + unsigned long available_colors;
>> + int num_leds;
>> +};
>> +#ifdef CONFIG_LEDS_CLASS_MULTI_COLOR
>> +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
>> + */
>> +int led_classdev_multicolor_register_ext(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev,
>> + struct led_init_data *init_data);
>> +
>> +static inline int led_classdev_multicolor_register(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev)
>> +{
>> + return 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
>> + */
>> +void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev);
>> +
>> +/* Calculate brightness for the monochrome LED cluster */
>> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
>> + enum led_brightness brightness,
>> + struct led_mc_color_conversion color_component[]);
>> +
>> +int devm_led_classdev_multicolor_register_ext(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev,
>> + struct led_init_data *init_data);
>> +
>> +static inline int devm_led_classdev_multicolor_register(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev)
>> +{
>> + return devm_led_classdev_multicolor_register_ext(parent, mcled_cdev,
>> + NULL);
>> +}
>> +
>> +void devm_led_classdev_multicolor_unregister(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev);
>> +#else
>> +
>> +static inline struct led_classdev_mc *lcdev_to_mccdev(
>> + struct led_classdev *lcdev)
>> +{
>> + return NULL;
>> +}
>> +
>> +static inline int led_classdev_multicolor_register_ext(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev,
>> + struct led_init_data *init_data)
>> +{
>> + return -EINVAL;
>> +}
>> +
>> +static inline int led_classdev_multicolor_register(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev)
>> +{
>> + return -EINVAL;
>> +}
>> +
>> +static inline void led_classdev_multicolor_unregister(struct led_classdev_mc *mcled_cdev) {}
>> +
>> +static inline int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
>> + enum led_brightness brightness,
>> + struct led_mc_color_conversion color_component[])
>> +{
>> + return -EINVAL;
>> +}
>> +
>> +static inline int devm_led_classdev_multicolor_register_ext(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev,
>> + struct led_init_data *init_data)
>> +{
>> + return -EINVAL;
>> +}
>> +
>> +static inline int devm_led_classdev_multicolor_register(struct device *parent,
>> + struct led_classdev_mc *mcled_cdev)
>> +{
>> + return -EINVAL;
>> +}
> Do you have use case for which these no-ops would be useful?
> We don't have no-ops for any of current LED API beside triggers,
> which are indeed useful.
Absolutely this was the solution for the kbuild test. This MC framework
is optional for drivers where as the LED class and flash are not.
The LP55xx does not have a dependency on the CONFIG_MULTICOLOR_CLASS
flag and it does not need a hard dependency. Without that flag defined
in the defconfig
we get build errors
Dan
^ permalink raw reply [flat|nested] 32+ messages in thread* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-10 0:27 ` Dan Murphy
@ 2019-10-10 18:36 ` Jacek Anaszewski
2019-10-10 18:37 ` Jacek Anaszewski
1 sibling, 0 replies; 32+ messages in thread
From: Jacek Anaszewski @ 2019-10-10 18:36 UTC (permalink / raw)
To: Dan Murphy, pavel; +Cc: linux-leds, linux-kernel
Dan,
On 10/10/19 2:27 AM, Dan Murphy wrote:
> Jacek
>
> On 10/9/19 4:47 PM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 10/8/19 10:47 PM, Dan Murphy wrote:
>>> Introduce a multicolor class that groups colored LEDs
>>> within a LED node.
>>>
>>> The multi color class groups monochrome 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.
>>>
>>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>>> ---
>>> .../ABI/testing/sysfs-class-led-multicolor | 35 +++
>>> Documentation/leds/index.rst | 1 +
>>> Documentation/leds/leds-class-multicolor.rst | 96 +++++++
>>> drivers/leds/Kconfig | 10 +
>>> drivers/leds/Makefile | 1 +
>>> drivers/leds/led-class-multicolor.c | 271 ++++++++++++++++++
>>> include/linux/led-class-multicolor.h | 143 +++++++++
>>> 7 files changed, 557 insertions(+)
>>> create mode 100644
>>> Documentation/ABI/testing/sysfs-class-led-multicolor
>>> create mode 100644 Documentation/leds/leds-class-multicolor.rst
>>> create mode 100644 drivers/leds/led-class-multicolor.c
>>> create mode 100644 include/linux/led-class-multicolor.h
>>>
>>> diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor
>>> b/Documentation/ABI/testing/sysfs-class-led-multicolor
>>> new file mode 100644
>>> index 000000000000..65cb43de26e6
>>> --- /dev/null
>>> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
>>> @@ -0,0 +1,35 @@
>>> +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 = brightness *
>>> <color>_intensity/<color>_max_intensity
>> This equation alone incites questions on how it is supposed to work.
>>
>> It would be better to present the whole algorithm for calculating
>> combined color here.
>
> I am not sure I follow. Isn't that explained in the class document?
I just think that this document should contain all necessary info
for the reader to understand the effect of writing brightness.
Looking once more it seems that slight modification of the last
sentence above equation could suffice:
s/is calculated/is calculated for each grouped LED/
>>> +
>>> + 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/<color>_intensity
>>> +Date: Sept 2019
>>> +KernelVersion: 5.5
>>> +Contact: Dan Murphy <dmurphy@ti.com>
>>> +Description: read/write
>>> + The <color>_intensity file is created based on the color
>>> + defined by the registrar of the class.
>>> + There is one file per color presented.
>>> +
>>> + The value of the color is from 0 to
>>> + /sys/class/leds/<led>/colors/<color>_max_intensity.
>>> +
>>> +What: /sys/class/leds/<led>/colors/<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.
>>> 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..7a695a29377e
>>> --- /dev/null
>>> +++ b/Documentation/leds/leds-class-multicolor.rst
>>> @@ -0,0 +1,96 @@
>>> +====================================
>>> +Multi Color LED handling under Linux
>>> +====================================
>>> +
>>> +Description
>>> +===========
>>> +The multi color class groups monochrome 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
>>> +<color>_intensity and <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-r--r-- 1 root root 4096 Jul 7 03:10 blue_intensity
>>> +-r--r--r-- 1 root root 4096 Jul 7 03:10
>>> blue_max_intensity
>>> +-rw-r--r-- 1 root root 4096 Jul 7 03:10
>>> green_intensity
>>> +-r--r--r-- 1 root root 4096 Jul 7 03:10
>>> green_max_intensity
>>> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 red_intensity
>>> +-r--r--r-- 1 root root 4096 Jul 7 03:10
>>> red_max_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 brightness.
>>> +
>>> +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/brightness
>>> +128
>>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
>>> index 4b68520ac251..a1ede89afc9e 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..89f4bc9e057c
>>> --- /dev/null
>>> +++ b/drivers/leds/led-class-multicolor.c
>>> @@ -0,0 +1,271 @@
>>> +// 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"
>>> +
>>> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
>>> + enum led_brightness brightness,
>>> + struct led_mc_color_conversion color_component[])
>> Now the function name doesn't match with the output array name.
>>
>> How about:
>>
>> - led_mc_brightness_to_color_components
>> - led_mc_calc_color_components
>>
>> Other suggestions?
>
> led_mc_calc_color_components is fine the first one is to long
Agreed.
[...]
>>> +static inline int devm_led_classdev_multicolor_register(struct
>>> device *parent,
>>> + struct led_classdev_mc *mcled_cdev)
>>> +{
>>> + return -EINVAL;
>>> +}
>> Do you have use case for which these no-ops would be useful?
>> We don't have no-ops for any of current LED API beside triggers,
>> which are indeed useful.
>
> Absolutely this was the solution for the kbuild test. This MC framework
> is optional for drivers where as the LED class and flash are not.
>
> The LP55xx does not have a dependency on the CONFIG_MULTICOLOR_CLASS
> flag and it does not need a hard dependency. Without that flag defined
> in the defconfig
Ack.
--
Best regards,
Jacek Anaszewski
^ permalink raw reply [flat|nested] 32+ messages in thread* Re: [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition
2019-10-10 0:27 ` Dan Murphy
2019-10-10 18:36 ` Jacek Anaszewski
@ 2019-10-10 18:37 ` Jacek Anaszewski
1 sibling, 0 replies; 32+ messages in thread
From: Jacek Anaszewski @ 2019-10-10 18:37 UTC (permalink / raw)
To: Dan Murphy, pavel; +Cc: linux-leds, linux-kernel
Dan,
On 10/10/19 2:27 AM, Dan Murphy wrote:
> Jacek
>
> On 10/9/19 4:47 PM, Jacek Anaszewski wrote:
>> Dan,
>>
>> On 10/8/19 10:47 PM, Dan Murphy wrote:
>>> Introduce a multicolor class that groups colored LEDs
>>> within a LED node.
>>>
>>> The multi color class groups monochrome 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.
>>>
>>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>>> ---
>>> .../ABI/testing/sysfs-class-led-multicolor | 35 +++
>>> Documentation/leds/index.rst | 1 +
>>> Documentation/leds/leds-class-multicolor.rst | 96 +++++++
>>> drivers/leds/Kconfig | 10 +
>>> drivers/leds/Makefile | 1 +
>>> drivers/leds/led-class-multicolor.c | 271 ++++++++++++++++++
>>> include/linux/led-class-multicolor.h | 143 +++++++++
>>> 7 files changed, 557 insertions(+)
>>> create mode 100644
>>> Documentation/ABI/testing/sysfs-class-led-multicolor
>>> create mode 100644 Documentation/leds/leds-class-multicolor.rst
>>> create mode 100644 drivers/leds/led-class-multicolor.c
>>> create mode 100644 include/linux/led-class-multicolor.h
>>>
>>> diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor
>>> b/Documentation/ABI/testing/sysfs-class-led-multicolor
>>> new file mode 100644
>>> index 000000000000..65cb43de26e6
>>> --- /dev/null
>>> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
>>> @@ -0,0 +1,35 @@
>>> +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 = brightness *
>>> <color>_intensity/<color>_max_intensity
>> This equation alone incites questions on how it is supposed to work.
>>
>> It would be better to present the whole algorithm for calculating
>> combined color here.
>
> I am not sure I follow. Isn't that explained in the class document?
I just think that this document should contain all necessary info
for the reader to understand the effect of writing brightness.
Looking once more it seems that slight modification of the last
sentence above equation could suffice:
s/is calculated/is calculated for each grouped LED/
>>> +
>>> + 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/<color>_intensity
>>> +Date: Sept 2019
>>> +KernelVersion: 5.5
>>> +Contact: Dan Murphy <dmurphy@ti.com>
>>> +Description: read/write
>>> + The <color>_intensity file is created based on the color
>>> + defined by the registrar of the class.
>>> + There is one file per color presented.
>>> +
>>> + The value of the color is from 0 to
>>> + /sys/class/leds/<led>/colors/<color>_max_intensity.
>>> +
>>> +What: /sys/class/leds/<led>/colors/<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.
>>> 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..7a695a29377e
>>> --- /dev/null
>>> +++ b/Documentation/leds/leds-class-multicolor.rst
>>> @@ -0,0 +1,96 @@
>>> +====================================
>>> +Multi Color LED handling under Linux
>>> +====================================
>>> +
>>> +Description
>>> +===========
>>> +The multi color class groups monochrome 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
>>> +<color>_intensity and <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-r--r-- 1 root root 4096 Jul 7 03:10 blue_intensity
>>> +-r--r--r-- 1 root root 4096 Jul 7 03:10
>>> blue_max_intensity
>>> +-rw-r--r-- 1 root root 4096 Jul 7 03:10
>>> green_intensity
>>> +-r--r--r-- 1 root root 4096 Jul 7 03:10
>>> green_max_intensity
>>> +-rw-r--r-- 1 root root 4096 Jul 7 03:10 red_intensity
>>> +-r--r--r-- 1 root root 4096 Jul 7 03:10
>>> red_max_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 brightness.
>>> +
>>> +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/brightness
>>> +128
>>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
>>> index 4b68520ac251..a1ede89afc9e 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..89f4bc9e057c
>>> --- /dev/null
>>> +++ b/drivers/leds/led-class-multicolor.c
>>> @@ -0,0 +1,271 @@
>>> +// 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"
>>> +
>>> +int led_mc_calc_brightness(struct led_classdev_mc *mcled_cdev,
>>> + enum led_brightness brightness,
>>> + struct led_mc_color_conversion color_component[])
>> Now the function name doesn't match with the output array name.
>>
>> How about:
>>
>> - led_mc_brightness_to_color_components
>> - led_mc_calc_color_components
>>
>> Other suggestions?
>
> led_mc_calc_color_components is fine the first one is to long
Agreed.
[...]
>>> +static inline int devm_led_classdev_multicolor_register(struct
>>> device *parent,
>>> + struct led_classdev_mc *mcled_cdev)
>>> +{
>>> + return -EINVAL;
>>> +}
>> Do you have use case for which these no-ops would be useful?
>> We don't have no-ops for any of current LED API beside triggers,
>> which are indeed useful.
>
> Absolutely this was the solution for the kbuild test. This MC framework
> is optional for drivers where as the LED class and flash are not.
>
> The LP55xx does not have a dependency on the CONFIG_MULTICOLOR_CLASS
> flag and it does not need a hard dependency. Without that flag defined
> in the defconfig
Ack.
--
Best regards,
Jacek Anaszewski
^ permalink raw reply [flat|nested] 32+ messages in thread
* [PATCH v11 05/16] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (3 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 04/16] leds: multicolor: Introduce a multicolor class definition Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 06/16] leds: lp50xx: Add the LP50XX family of the RGB LED driver Dan Murphy
` (10 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, 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..8a0a21f1056c
--- /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 - 0x14, 0x15, 0x16, 0x17
+ lp5018/24 - 0x28, 0x29, 0x2a, 0x2b
+ lp5030/36 - 0x30, 0x31, 0x32, 0x33
+ - #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 : Must be LED_COLOR_ID_MULTI
+ - 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 output that controls
+ the monochrome LED.
+ - color : see Documentation/devicetree/bindings/leds/common.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 - 3 Total RGB cluster LED outputs 0-2
+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
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 06/16] leds: lp50xx: Add the LP50XX family of the RGB LED driver
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (4 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 05/16] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 07/16] dt: bindings: lp55xx: Be consistent in the document with LED acronym Dan Murphy
` (9 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, 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
LP5009 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 | 11 +
drivers/leds/Makefile | 1 +
drivers/leds/leds-lp50xx.c | 799 +++++++++++++++++++++++++++++++++++++
3 files changed, 811 insertions(+)
create mode 100644 drivers/leds/leds-lp50xx.c
diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
index a1ede89afc9e..fb614a6b9afa 100644
--- a/drivers/leds/Kconfig
+++ b/drivers/leds/Kconfig
@@ -363,6 +363,17 @@ 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/12/9 LED driver chip"
+ depends on LEDS_CLASS && REGMAP_I2C
+ depends on LEDS_CLASS_MULTI_COLOR
+ help
+ If you say yes here you get support for the Texas Instruments
+ LP5036, LP5030, LP5024, LP5018, LP5012 and LP5009 LED driver.
+
+ To compile this driver as a module, choose M here: the
+ module will be called leds-lp50xx.
+
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..6a042f973a83
--- /dev/null
+++ b/drivers/leds/leds-lp50xx.c
@@ -0,0 +1,799 @@
+// 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)
+
+/* There are 3 LED outputs per bank */
+#define LP50XX_LEDS_PER_MODULE 3
+
+#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
+
+#define LP5009_MAX_LEDS (LP5009_MAX_LED_MODULES * LP50XX_LEDS_PER_MODULE)
+#define LP5012_MAX_LEDS (LP5012_MAX_LED_MODULES * LP50XX_LEDS_PER_MODULE)
+#define LP5018_MAX_LEDS (LP5018_MAX_LED_MODULES * LP50XX_LEDS_PER_MODULE)
+#define LP5024_MAX_LEDS (LP5024_MAX_LED_MODULES * LP50XX_LEDS_PER_MODULE)
+#define LP5030_MAX_LEDS (LP5030_MAX_LED_MODULES * LP50XX_LEDS_PER_MODULE)
+#define LP5036_MAX_LEDS (LP5036_MAX_LED_MODULES * LP50XX_LEDS_PER_MODULE)
+
+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: device reset register
+ */
+struct lp50xx_chip_info {
+ const struct regmap_config lp50xx_regmap_config;
+ int model_id;
+ u8 max_modules;
+ 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] = {
+ .model_id = LP5009,
+ .max_modules = LP5009_MAX_LED_MODULES,
+ .num_leds = LP5009_MAX_LEDS,
+ .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] = {
+ .model_id = LP5012,
+ .max_modules = LP5012_MAX_LED_MODULES,
+ .num_leds = LP5012_MAX_LEDS,
+ .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] = {
+ .model_id = LP5018,
+ .max_modules = LP5018_MAX_LED_MODULES,
+ .num_leds = LP5018_MAX_LEDS,
+ .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] = {
+ .model_id = LP5024,
+ .max_modules = LP5024_MAX_LED_MODULES,
+ .num_leds = LP5024_MAX_LEDS,
+ .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] = {
+ .model_id = LP5030,
+ .max_modules = LP5030_MAX_LED_MODULES,
+ .num_leds = LP5030_MAX_LEDS,
+ .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] = {
+ .model_id = LP5036,
+ .max_modules = LP5036_MAX_LED_MODULES,
+ .num_leds = LP5036_MAX_LEDS,
+ .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,
+ },
+};
+
+struct lp50xx_led {
+ struct led_classdev led_dev;
+ struct led_classdev_mc mc_cdev;
+ struct lp50xx *priv;
+ unsigned long bank_modules;
+ int led_intensity[LP50XX_LEDS_PER_MODULE];
+ 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: device 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 int lp50xx_brightness_set(struct led_classdev *cdev,
+ enum led_brightness brightness)
+{
+ struct lp50xx_led *led = container_of(cdev, struct lp50xx_led, led_dev);
+ const struct lp50xx_chip_info *led_chip = led->priv->chip_info;
+ struct led_mc_color_entry *color_data;
+ u8 led_offset, reg_val, reg_color_offset;
+ int ret = 0;
+
+ mutex_lock(&led->priv->lock);
+
+ if (led->ctrl_bank_enabled)
+ reg_val = led_chip->bank_brt_reg;
+ else
+ reg_val = led_chip->led_brightness0_reg +
+ led->led_number;
+
+ ret = regmap_write(led->priv->regmap, reg_val, brightness);
+ if (ret) {
+ dev_err(&led->priv->client->dev,
+ "Cannot write brightness value %d\n", ret);
+ goto out;
+ }
+
+ list_for_each_entry(color_data, &led->mc_cdev.color_list, list) {
+ if (color_data->led_color_id == LED_COLOR_ID_RED) {
+ reg_color_offset = 0;
+ } else if (color_data->led_color_id == LED_COLOR_ID_GREEN) {
+ reg_color_offset = 1;
+ } else if (color_data->led_color_id == LED_COLOR_ID_BLUE) {
+ reg_color_offset = 2;
+ } else {
+ dev_err(&led->priv->client->dev,
+ "LED color not found\n");
+ ret = -EINVAL;
+ goto out;
+ }
+
+ if (led->ctrl_bank_enabled) {
+ reg_val = led_chip->bank_mix_reg + reg_color_offset;
+ } else {
+ led_offset = (led->led_number * 3) + reg_color_offset;
+ reg_val = led_chip->mix_out0_reg + led_offset;
+ }
+
+ ret = regmap_write(led->priv->regmap, reg_val,
+ color_data->intensity);
+ if (ret) {
+ dev_err(&led->priv->client->dev,
+ "Cannot write intensity value %d\n", ret);
+ goto out;
+ }
+ }
+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);
+ const struct lp50xx_chip_info *led_chip = led->priv->chip_info;
+ unsigned int brt_val;
+ u8 reg_val;
+ int ret;
+
+ mutex_lock(&led->priv->lock);
+
+ if (led->ctrl_bank_enabled)
+ reg_val = led_chip->bank_brt_reg;
+ else
+ reg_val = led_chip->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_banks(struct lp50xx *priv, u32 led_banks[])
+{
+ u8 led_config_lo, led_config_hi;
+ u32 bank_enable_mask = 0;
+ int ret;
+ int i;
+
+ 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_config_lo);
+ if (ret)
+ return ret;
+
+ if (priv->chip_info->model_id >= LP5030)
+ 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_banks[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);
+ priv->num_of_banked_leds = ret;
+ if (priv->num_of_banked_leds >
+ priv->chip_info->max_modules) {
+ dev_err(&priv->client->dev,
+ "led-bank property is invalid\n");
+ ret = -EINVAL;
+ fwnode_handle_put(child);
+ goto child_out;
+ }
+
+ ret = fwnode_property_read_u32_array(child,
+ "ti,led-bank",
+ led_banks,
+ ret);
+ if (ret) {
+ dev_err(&priv->client->dev,
+ "led-bank property is missing\n");
+ fwnode_handle_put(child);
+ goto child_out;
+ }
+
+ ret = lp50xx_set_banks(priv, led_banks);
+ 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);
+ if (ret) {
+ dev_err(&priv->client->dev,
+ "led reg 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;
+ }
+
+ led->led_number = led_number;
+ }
+
+ init_data.fwnode = child;
+ 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.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
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 07/16] dt: bindings: lp55xx: Be consistent in the document with LED acronym
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (5 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 06/16] leds: lp50xx: Add the LP50XX family of the RGB LED driver Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 08/16] dt: bindings: lp55xx: Update binding for Multicolor Framework Dan Murphy
` (8 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, Dan Murphy
Update the document to be consistent in case when using "LED".
This acronym should be capital throughout the document.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
Documentation/devicetree/bindings/leds/leds-lp55xx.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/devicetree/bindings/leds/leds-lp55xx.txt b/Documentation/devicetree/bindings/leds/leds-lp55xx.txt
index 1b66a413fb9d..bfe2805c5534 100644
--- a/Documentation/devicetree/bindings/leds/leds-lp55xx.txt
+++ b/Documentation/devicetree/bindings/leds/leds-lp55xx.txt
@@ -1,4 +1,4 @@
-Binding for TI/National Semiconductor LP55xx Led Drivers
+Binding for TI/National Semiconductor LP55xx LED Drivers
Required properties:
- compatible: one of
@@ -12,8 +12,8 @@ Required properties:
- clock-mode: Input clock mode, (0: automode, 1: internal, 2: external)
Each child has own specific current settings
-- led-cur: Current setting at each led channel (mA x10, 0 if led is not connected)
-- max-cur: Maximun current at each led channel.
+- led-cur: Current setting at each LED channel (mA x10, 0 if LED is not connected)
+- max-cur: Maximun current at each LED channel.
Optional properties:
- enable-gpio: GPIO attached to the chip's enable pin
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 08/16] dt: bindings: lp55xx: Update binding for Multicolor Framework
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (6 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 07/16] dt: bindings: lp55xx: Be consistent in the document with LED acronym Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-16 11:25 ` Linus Walleij
2019-10-08 20:47 ` [PATCH v11 09/16] ARM: dts: n900: Add reg property to the LP5523 channel node Dan Murphy
` (7 subsequent siblings)
15 siblings, 1 reply; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel
Cc: linux-leds, linux-kernel, Dan Murphy, Tony Lindgren,
Benoît Cousson, Linus Walleij, Shawn Guo, Sascha Hauer,
Pengutronix Kernel Team, Fabio Estevam, NXP Linux Team
Update the DT binding to include the properties to use the
multicolor framework for the devices that use the LP55xx
framework.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
CC: Tony Lindgren <tony@atomide.com>
CC: "Benoît Cousson" <bcousson@baylibre.com>
CC: Linus Walleij <linus.walleij@linaro.org>
CC: Shawn Guo <shawnguo@kernel.org>
CC: Sascha Hauer <s.hauer@pengutronix.de>
CC: Pengutronix Kernel Team <kernel@pengutronix.de>
CC: Fabio Estevam <festevam@gmail.com>
CC: NXP Linux Team <linux-imx@nxp.com>
---
.../devicetree/bindings/leds/leds-lp55xx.txt | 149 +++++++++++++++---
1 file changed, 124 insertions(+), 25 deletions(-)
diff --git a/Documentation/devicetree/bindings/leds/leds-lp55xx.txt b/Documentation/devicetree/bindings/leds/leds-lp55xx.txt
index bfe2805c5534..736a2e1538be 100644
--- a/Documentation/devicetree/bindings/leds/leds-lp55xx.txt
+++ b/Documentation/devicetree/bindings/leds/leds-lp55xx.txt
@@ -1,6 +1,8 @@
Binding for TI/National Semiconductor LP55xx LED Drivers
Required properties:
+- #address-cells: 1
+- #size-cells: 0
- compatible: one of
national,lp5521
national,lp5523
@@ -14,6 +16,18 @@ Required properties:
Each child has own specific current settings
- led-cur: Current setting at each LED channel (mA x10, 0 if LED is not connected)
- max-cur: Maximun current at each LED channel.
+- reg: Output channel for the LED. This is zero based channel identifier and
+ the data sheet is a one based channel identifier.
+ reg value to output to LED output number
+ D1 = reg value is 0
+ D2 = reg value is 1
+ D3 = reg value is 2
+ D4 = reg value is 3
+ D5 = reg value is 4
+ D6 = reg value is 5
+ D7 = reg value is 6
+ D8 = reg value is 7
+ D9 = reg value is 8
Optional properties:
- enable-gpio: GPIO attached to the chip's enable pin
@@ -35,23 +49,28 @@ example 1) LP5521
on channel 0.
lp5521@32 {
+ #address-cells = <1>;
+ #size-cells = <0>;
compatible = "national,lp5521";
reg = <0x32>;
label = "lp5521_pri";
clock-mode = /bits/ 8 <2>;
- chan0 {
+ chan@0 {
+ reg = <0>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
linux,default-trigger = "heartbeat";
};
- chan1 {
+ chan@1 {
+ reg = <1>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
};
- chan2 {
+ chan@2 {
+ reg = <2>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
};
@@ -70,59 +89,70 @@ ASEL1 ASEL0 Address
VEN VEN 35h
lp5523@32 {
+ #address-cells = <1>;
+ #size-cells = <0>;
compatible = "national,lp5523";
reg = <0x32>;
clock-mode = /bits/ 8 <1>;
- chan0 {
+ chan@0 {
+ reg = <0>;
chan-name = "d1";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan1 {
+ chan@1 {
+ reg = <1>;
chan-name = "d2";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan2 {
+ chan@2 {
+ reg = <2>;
chan-name = "d3";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan3 {
+ chan@3 {
+ reg = <3>;
chan-name = "d4";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan4 {
+ chan@4 {
+ reg = <4>;
chan-name = "d5";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan5 {
+ chan@5 {
+ reg = <5>;
chan-name = "d6";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan6 {
+ chan@6 {
+ reg = <6>;
chan-name = "d7";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan7 {
+ chan@7 {
+ reg = <7>;
chan-name = "d8";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan8 {
+ chan@8 {
+ reg = <8>;
chan-name = "d9";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
@@ -133,29 +163,35 @@ example 3) LP5562
4 channels are defined.
lp5562@30 {
+ #address-cells = <1>;
+ #size-cells = <0>;
compatible = "ti,lp5562";
reg = <0x30>;
clock-mode = /bits/8 <2>;
- chan0 {
+ chan@0 {
+ reg = <0>;
chan-name = "R";
led-cur = /bits/ 8 <0x20>;
max-cur = /bits/ 8 <0x60>;
};
- chan1 {
+ chan@1 {
+ reg = <1>;
chan-name = "G";
led-cur = /bits/ 8 <0x20>;
max-cur = /bits/ 8 <0x60>;
};
- chan2 {
+ chan@2 {
+ reg = <2>;
chan-name = "B";
led-cur = /bits/ 8 <0x20>;
max-cur = /bits/ 8 <0x60>;
};
- chan3 {
+ chan@3 {
+ reg = <3>;
chan-name = "W";
led-cur = /bits/ 8 <0x20>;
max-cur = /bits/ 8 <0x60>;
@@ -167,62 +203,125 @@ example 4) LP8501
Others are same as LP5523.
lp8501@32 {
+ #address-cells = <1>;
+ #size-cells = <0>;
compatible = "ti,lp8501";
reg = <0x32>;
clock-mode = /bits/ 8 <2>;
pwr-sel = /bits/ 8 <3>; /* D1~9 connected to VOUT */
- chan0 {
+ chan@0 {
+ reg = <0>;
chan-name = "d1";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan1 {
+ chan@1 {
+ reg = <1>;
chan-name = "d2";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan2 {
+ chan@2 {
+ reg = <2>;
chan-name = "d3";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan3 {
+ chan@3 {
+ reg = <3>;
chan-name = "d4";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan4 {
+ chan@4 {
+ reg = <4>;
chan-name = "d5";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan5 {
+ chan@5 {
+ reg = <5>;
chan-name = "d6";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan6 {
+ chan@6 {
+ reg = <6>;
chan-name = "d7";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan7 {
+ chan@7 {
+ reg = <7>;
chan-name = "d8";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
- chan8 {
+ chan@8 {
+ reg = <8>;
chan-name = "d9";
led-cur = /bits/ 8 <0x14>;
max-cur = /bits/ 8 <0x20>;
};
};
+
+Multicolor Framework Support
+In addition to the nodes and properties defined above for device support the
+properties below are needed for multicolor framework support as defined in
+Documentation/devicetree/bindings/leds/leds-class-multicolor.txt
+
+Required child properties for multicolor framework
+ - color : Must be LED_COLOR_ID_MULTI
+ - function : see Documentation/devicetree/bindings/leds/common.txt
+
+Required grandchildren properties
+ - reg : This is the LED output of the device
+ - color : see Documentation/devicetree/bindings/leds/common.txt
+
+Multicolor LED example:
+lp5523: lp5523@32 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ compatible = "national,lp5523";
+ reg = <0x32>;
+ clock-mode = /bits/ 8 <0>; /* LP55XX_CLOCK_AUTO */
+
+ multi-led@2 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ reg = <2>;
+ color = <LED_COLOR_ID_MULTI>;
+ function = LED_FUNCTION_STANDBY;
+ linux,default-trigger = "heartbeat";
+
+ led@0 {
+ led-cur = /bits/ 8 <50>;
+ max-cur = /bits/ 8 <100>;
+ reg = <0x0>;
+ color = <LED_COLOR_ID_GREEN>;
+ };
+
+ led@1 {
+ led-cur = /bits/ 8 <50>;
+ max-cur = /bits/ 8 <100>;
+ reg = <0x1>;
+ color = <LED_COLOR_ID_BLUE>;
+ };
+
+ led@6 {
+ led-cur = /bits/ 8 <50>;
+ max-cur = /bits/ 8 <100>;
+ reg = <0x6>;
+ color = <LED_COLOR_ID_RED>;
+ };
+ };
+};
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* Re: [PATCH v11 08/16] dt: bindings: lp55xx: Update binding for Multicolor Framework
2019-10-08 20:47 ` [PATCH v11 08/16] dt: bindings: lp55xx: Update binding for Multicolor Framework Dan Murphy
@ 2019-10-16 11:25 ` Linus Walleij
0 siblings, 0 replies; 32+ messages in thread
From: Linus Walleij @ 2019-10-16 11:25 UTC (permalink / raw)
To: Dan Murphy
Cc: Jacek Anaszewski, Pavel Machek, Linux LED Subsystem,
linux-kernel, Tony Lindgren, Benoît Cousson, Shawn Guo,
Sascha Hauer, Pengutronix Kernel Team, Fabio Estevam,
NXP Linux Team
On Tue, Oct 8, 2019 at 10:48 PM Dan Murphy <dmurphy@ti.com> wrote:
> Update the DT binding to include the properties to use the
> multicolor framework for the devices that use the LP55xx
> framework.
>
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> CC: Tony Lindgren <tony@atomide.com>
> CC: "Benoît Cousson" <bcousson@baylibre.com>
> CC: Linus Walleij <linus.walleij@linaro.org>
> CC: Shawn Guo <shawnguo@kernel.org>
> CC: Sascha Hauer <s.hauer@pengutronix.de>
> CC: Pengutronix Kernel Team <kernel@pengutronix.de>
> CC: Fabio Estevam <festevam@gmail.com>
> CC: NXP Linux Team <linux-imx@nxp.com>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Yours,
Linus Walleij
^ permalink raw reply [flat|nested] 32+ messages in thread
* [PATCH v11 09/16] ARM: dts: n900: Add reg property to the LP5523 channel node
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (7 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 08/16] dt: bindings: lp55xx: Update binding for Multicolor Framework Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 10/16] ARM: dts: imx6dl-yapp4: Add reg property to the lp5562 " Dan Murphy
` (6 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel
Cc: linux-leds, linux-kernel, Dan Murphy, Tony Lindgren, Benoît Cousson
Add the reg property to each channel node. This update is
to accomodate the multicolor framework. In addition to the
accomodation this allows the LEDs to be placed on any channel
and allow designs to skip channels as opposed to requiring
sequential order.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
CC: Tony Lindgren <tony@atomide.com>
CC: "Benoît Cousson" <bcousson@baylibre.com>
k# interactive rebase in progress; onto ae89cc6d4a8c
---
arch/arm/boot/dts/omap3-n900.dts | 29 ++++++++++++++++++++---------
1 file changed, 20 insertions(+), 9 deletions(-)
diff --git a/arch/arm/boot/dts/omap3-n900.dts b/arch/arm/boot/dts/omap3-n900.dts
index 84a5ade1e865..643f35619246 100644
--- a/arch/arm/boot/dts/omap3-n900.dts
+++ b/arch/arm/boot/dts/omap3-n900.dts
@@ -607,63 +607,74 @@
};
lp5523: lp5523@32 {
+ #address-cells = <1>;
+ #size-cells = <0>;
compatible = "national,lp5523";
reg = <0x32>;
clock-mode = /bits/ 8 <0>; /* LP55XX_CLOCK_AUTO */
enable-gpio = <&gpio2 9 GPIO_ACTIVE_HIGH>; /* 41 */
- chan0 {
+ chan@0 {
chan-name = "lp5523:kb1";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <0>;
};
- chan1 {
+ chan@1 {
chan-name = "lp5523:kb2";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <1>;
};
- chan2 {
+ chan@2 {
chan-name = "lp5523:kb3";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <2>;
};
- chan3 {
+ chan@3 {
chan-name = "lp5523:kb4";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <3>;
};
- chan4 {
+ chan@4 {
chan-name = "lp5523:b";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <4>;
};
- chan5 {
+ chan@5 {
chan-name = "lp5523:g";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <5>;
};
- chan6 {
+ chan@6 {
chan-name = "lp5523:r";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <6>;
};
- chan7 {
+ chan@7 {
chan-name = "lp5523:kb5";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <7>;
};
- chan8 {
+ chan@8 {
chan-name = "lp5523:kb6";
led-cur = /bits/ 8 <50>;
max-cur = /bits/ 8 <100>;
+ reg = <8>;
};
};
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 10/16] ARM: dts: imx6dl-yapp4: Add reg property to the lp5562 channel node
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (8 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 09/16] ARM: dts: n900: Add reg property to the LP5523 channel node Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 11/16] ARM: dts: ste-href: Add reg property to the LP5521 channel nodes Dan Murphy
` (5 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel
Cc: linux-leds, linux-kernel, Dan Murphy, Shawn Guo, Sascha Hauer,
Pengutronix Kernel Team, Fabio Estevam, NXP Linux Team
Add the reg property to each channel node. This update is
to accomodate the multicolor framework. In addition to the
accomodation this allows the LEDs to be placed on any channel
and allow designs to skip channels as opposed to requiring
sequential order.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
CC: Shawn Guo <shawnguo@kernel.org>
CC: Sascha Hauer <s.hauer@pengutronix.de>
CC: Pengutronix Kernel Team <kernel@pengutronix.de>
CC: Fabio Estevam <festevam@gmail.com>
CC: NXP Linux Team <linux-imx@nxp.com>
---
arch/arm/boot/dts/imx6dl-yapp4-common.dtsi | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/arch/arm/boot/dts/imx6dl-yapp4-common.dtsi b/arch/arm/boot/dts/imx6dl-yapp4-common.dtsi
index e8d800fec637..efc466ed1fea 100644
--- a/arch/arm/boot/dts/imx6dl-yapp4-common.dtsi
+++ b/arch/arm/boot/dts/imx6dl-yapp4-common.dtsi
@@ -257,29 +257,35 @@
reg = <0x30>;
clock-mode = /bits/ 8 <1>;
status = "disabled";
+ #address-cells = <1>;
+ #size-cells = <0>;
- chan0 {
+ chan@0 {
chan-name = "R";
led-cur = /bits/ 8 <0x20>;
max-cur = /bits/ 8 <0x60>;
+ reg = <0>;
};
- chan1 {
+ chan@1 {
chan-name = "G";
led-cur = /bits/ 8 <0x20>;
max-cur = /bits/ 8 <0x60>;
+ reg = <1>;
};
- chan2 {
+ chan@2 {
chan-name = "B";
led-cur = /bits/ 8 <0x20>;
max-cur = /bits/ 8 <0x60>;
+ reg = <2>;
};
- chan3 {
+ chan@3 {
chan-name = "W";
led-cur = /bits/ 8 <0x0>;
max-cur = /bits/ 8 <0x0>;
+ reg = <3>;
};
};
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 11/16] ARM: dts: ste-href: Add reg property to the LP5521 channel nodes
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (9 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 10/16] ARM: dts: imx6dl-yapp4: Add reg property to the lp5562 " Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-16 11:24 ` Linus Walleij
2019-10-08 20:47 ` [PATCH v11 12/16] leds: lp55xx: Add multicolor framework support to lp55xx Dan Murphy
` (4 subsequent siblings)
15 siblings, 1 reply; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel
Cc: linux-leds, linux-kernel, Dan Murphy, Linus Walleij
Add the reg property to each channel node. This update is
to accomodate the multicolor framework. In addition to the
accomodation this allows the LEDs to be placed on any channel
and allow designs to skip channels as opposed to requiring
sequential order.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
CC: Linus Walleij <linus.walleij@linaro.org>
---
arch/arm/boot/dts/ste-href.dtsi | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/arch/arm/boot/dts/ste-href.dtsi b/arch/arm/boot/dts/ste-href.dtsi
index 4f6acbd8c040..8a873da102d3 100644
--- a/arch/arm/boot/dts/ste-href.dtsi
+++ b/arch/arm/boot/dts/ste-href.dtsi
@@ -56,16 +56,21 @@
reg = <0x33>;
label = "lp5521_pri";
clock-mode = /bits/ 8 <2>;
- chan0 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ chan@0 {
+ reg = <0>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
linux,default-trigger = "heartbeat";
};
- chan1 {
+ chan@1 {
+ reg = <1>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
};
- chan2 {
+ chan@2 {
+ reg = <2>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
};
@@ -75,15 +80,20 @@
reg = <0x34>;
label = "lp5521_sec";
clock-mode = /bits/ 8 <2>;
- chan0 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ chan@0 {
+ reg = <0>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
};
- chan1 {
+ chan@1 {
+ reg = <1>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
};
- chan2 {
+ chan@2 {
+ reg = <2>;
led-cur = /bits/ 8 <0x2f>;
max-cur = /bits/ 8 <0x5f>;
};
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* Re: [PATCH v11 11/16] ARM: dts: ste-href: Add reg property to the LP5521 channel nodes
2019-10-08 20:47 ` [PATCH v11 11/16] ARM: dts: ste-href: Add reg property to the LP5521 channel nodes Dan Murphy
@ 2019-10-16 11:24 ` Linus Walleij
0 siblings, 0 replies; 32+ messages in thread
From: Linus Walleij @ 2019-10-16 11:24 UTC (permalink / raw)
To: Dan Murphy
Cc: Jacek Anaszewski, Pavel Machek, Linux LED Subsystem, linux-kernel
On Tue, Oct 8, 2019 at 10:48 PM Dan Murphy <dmurphy@ti.com> wrote:
> Add the reg property to each channel node. This update is
> to accomodate the multicolor framework. In addition to the
> accomodation this allows the LEDs to be placed on any channel
> and allow designs to skip channels as opposed to requiring
> sequential order.
>
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> CC: Linus Walleij <linus.walleij@linaro.org>
Patch applied to the Ux500 tree.
Yours,
Linus Walleij
^ permalink raw reply [flat|nested] 32+ messages in thread
* [PATCH v11 12/16] leds: lp55xx: Add multicolor framework support to lp55xx
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (10 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 11/16] ARM: dts: ste-href: Add reg property to the LP5521 channel nodes Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-09 22:04 ` Jacek Anaszewski
2019-10-08 20:47 ` [PATCH v11 13/16] leds: lp5523: Update the lp5523 code to add intensity function Dan Murphy
` (3 subsequent siblings)
15 siblings, 1 reply; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, Dan Murphy
Add multicolor framework support for the lp55xx family.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
drivers/leds/Kconfig | 1 +
drivers/leds/leds-lp55xx-common.c | 176 +++++++++++++++++++---
drivers/leds/leds-lp55xx-common.h | 11 ++
include/linux/platform_data/leds-lp55xx.h | 5 +
4 files changed, 169 insertions(+), 24 deletions(-)
diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
index fb614a6b9afa..5706bf8d8bd1 100644
--- a/drivers/leds/Kconfig
+++ b/drivers/leds/Kconfig
@@ -377,6 +377,7 @@ config LEDS_LP50XX
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
+ depends on OF
select FW_LOADER
select FW_LOADER_USER_HELPER
help
diff --git a/drivers/leds/leds-lp55xx-common.c b/drivers/leds/leds-lp55xx-common.c
index 44ced02b49f9..85629f836082 100644
--- a/drivers/leds/leds-lp55xx-common.c
+++ b/drivers/leds/leds-lp55xx-common.c
@@ -131,14 +131,54 @@ static struct attribute *lp55xx_led_attrs[] = {
};
ATTRIBUTE_GROUPS(lp55xx_led);
+static int lp55xx_map_channel(struct lp55xx_led *led, int color_id,
+ enum led_brightness brightness)
+{
+ int i;
+
+ for (i = 0; i < led->mc_cdev.num_leds; i++) {
+ if (led->color_component[i].color_id == color_id) {
+ led->color_component[i].brightness = brightness;
+ return 0;
+ }
+ }
+
+ return -EINVAL;
+}
+
static int lp55xx_set_brightness(struct led_classdev *cdev,
enum led_brightness brightness)
{
+ struct led_mc_color_conversion color_component[LP55XX_MAX_GROUPED_CHAN];
struct lp55xx_led *led = cdev_to_lp55xx_led(cdev);
struct lp55xx_device_config *cfg = led->chip->cfg;
+ int ret;
+ int i;
- led->brightness = (u8)brightness;
- return cfg->brightness_fn(led);
+ if (led->mc_cdev.num_leds > 1) {
+ if (!cfg->color_intensity_fn)
+ return -EINVAL;
+
+ led_mc_calc_brightness(&led->mc_cdev, brightness,
+ color_component);
+
+ for (i = 0; i < led->mc_cdev.num_leds; i++) {
+ ret = lp55xx_map_channel(led,
+ color_component[i].color_id,
+ color_component[i].brightness);
+ if (ret)
+ return ret;
+ }
+
+ ret = cfg->color_intensity_fn(led);
+ if (ret)
+ return ret;
+ } else {
+ led->brightness = (u8)brightness;
+ ret = cfg->brightness_fn(led);
+ }
+
+ return ret;
}
static int lp55xx_init_led(struct lp55xx_led *led,
@@ -147,9 +187,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 +199,34 @@ 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->color_component,
+ pdata->led_config[chan].color_component,
+ sizeof(led->color_component));
+ } 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 +234,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].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)
+ ret = led_classdev_multicolor_register(dev, &led->mc_cdev);
+ else
+ ret = led_classdev_register(dev, &led->cdev);
- ret = led_classdev_register(dev, &led->cdev);
if (ret) {
dev_err(dev, "led register err: %d\n", ret);
return ret;
@@ -466,7 +523,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 +594,82 @@ void lp55xx_unregister_sysfs(struct lp55xx_chip *chip)
}
EXPORT_SYMBOL_GPL(lp55xx_unregister_sysfs);
+static int lp5xx_parse_common_child(struct device_node *np,
+ struct lp55xx_led_config *cfg,
+ int chan_num, bool is_multicolor,
+ int color_num)
+{
+ u32 led_number;
+ int ret;
+
+ of_property_read_string(np, "chan-name",
+ &cfg[chan_num].name);
+ of_property_read_u8(np, "led-cur",
+ &cfg[chan_num].led_current);
+ of_property_read_u8(np, "max-cur",
+ &cfg[chan_num].max_current);
+
+ ret = of_property_read_u32(np, "reg", &led_number);
+ if (ret)
+ return ret;
+
+ if (led_number < 0 || led_number > 6)
+ return -EINVAL;
+
+ if (is_multicolor)
+ cfg[chan_num].color_component[color_num].output_num =
+ led_number;
+ else
+ cfg[chan_num].chan_nr = led_number;
+
+ return 0;
+}
+
+static int lp5xx_parse_channel_child(struct device_node *np,
+ struct lp55xx_led_config *cfg,
+ int child_number)
+{
+ struct device_node *child;
+ int channel_color;
+ int num_colors = 0;
+ u32 color_id;
+ int ret;
+
+ cfg[child_number].default_trigger =
+ of_get_property(np, "linux,default-trigger", NULL);
+
+ ret = of_property_read_u32(np, "color", &channel_color);
+ if (ret)
+ channel_color = ret;
+
+
+ if (channel_color == LED_COLOR_ID_MULTI) {
+ for_each_child_of_node(np, child) {
+ ret = lp5xx_parse_common_child(child, cfg,
+ child_number, true,
+ num_colors);
+ if (ret)
+ return ret;
+
+ ret = of_property_read_u32(child, "color", &color_id);
+ if (ret)
+ return ret;
+
+ cfg[child_number].color_component[num_colors].color_id =
+ color_id;
+ set_bit(color_id, &cfg[child_number].available_colors);
+ num_colors++;
+ }
+
+ cfg[child_number].num_colors = num_colors;
+ } else {
+ return lp5xx_parse_common_child(np, cfg, child_number, false,
+ num_colors);
+ }
+
+ return 0;
+}
+
struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
struct device_node *np)
{
@@ -546,6 +678,7 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
struct lp55xx_led_config *cfg;
int num_channels;
int i = 0;
+ int ret;
pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
if (!pdata)
@@ -565,14 +698,9 @@ 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;
-
- 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);
-
+ ret = lp5xx_parse_channel_child(child, cfg, i);
+ if (ret)
+ return ERR_PTR(-EINVAL);
i++;
}
diff --git a/drivers/leds/leds-lp55xx-common.h b/drivers/leds/leds-lp55xx-common.h
index 783ed5103ce5..55d420f704d1 100644
--- a/drivers/leds/leds-lp55xx-common.h
+++ b/drivers/leds/leds-lp55xx-common.h
@@ -12,6 +12,10 @@
#ifndef _LEDS_LP55XX_COMMON_H
#define _LEDS_LP55XX_COMMON_H
+#include <linux/led-class-multicolor.h>
+
+#define LP55XX_MAX_GROUPED_CHAN 4
+
enum lp55xx_engine_index {
LP55XX_ENGINE_INVALID,
LP55XX_ENGINE_1,
@@ -109,6 +113,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);
+
/* current setting function */
void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
@@ -159,6 +166,8 @@ struct lp55xx_chip {
* struct lp55xx_led
* @chan_nr : Channel number
* @cdev : LED class device
+ * @mc_cdev : Multi color class device
+ * @color_component : Multi color LED map information
* @led_current : Current setting at each led channel
* @max_current : Maximun current at each led channel
* @brightness : Brightness value
@@ -167,6 +176,8 @@ struct lp55xx_chip {
struct lp55xx_led {
int chan_nr;
struct led_classdev cdev;
+ struct led_classdev_mc mc_cdev;
+ struct led_mc_color_conversion color_component[LP55XX_MAX_GROUPED_CHAN];
u8 led_current;
u8 max_current;
u8 brightness;
diff --git a/include/linux/platform_data/leds-lp55xx.h b/include/linux/platform_data/leds-lp55xx.h
index 96a787100fda..1e7a25ed9a87 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,9 @@ 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;
+ struct led_mc_color_conversion color_component[LED_COLOR_ID_MAX];
};
struct lp55xx_predef_pattern {
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* Re: [PATCH v11 12/16] leds: lp55xx: Add multicolor framework support to lp55xx
2019-10-08 20:47 ` [PATCH v11 12/16] leds: lp55xx: Add multicolor framework support to lp55xx Dan Murphy
@ 2019-10-09 22:04 ` Jacek Anaszewski
2019-10-10 0:47 ` Dan Murphy
0 siblings, 1 reply; 32+ messages in thread
From: Jacek Anaszewski @ 2019-10-09 22:04 UTC (permalink / raw)
To: Dan Murphy, pavel; +Cc: linux-leds, linux-kernel
Dan,
On 10/8/19 10:47 PM, Dan Murphy wrote:
> Add multicolor framework support for the lp55xx family.
>
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
> drivers/leds/Kconfig | 1 +
> drivers/leds/leds-lp55xx-common.c | 176 +++++++++++++++++++---
> drivers/leds/leds-lp55xx-common.h | 11 ++
> include/linux/platform_data/leds-lp55xx.h | 5 +
> 4 files changed, 169 insertions(+), 24 deletions(-)
>
[...]
>
> +static int lp5xx_parse_common_child(struct device_node *np,
> + struct lp55xx_led_config *cfg,
> + int chan_num, bool is_multicolor,
> + int color_num)
> +{
> + u32 led_number;
> + int ret;
> +
> + of_property_read_string(np, "chan-name",
> + &cfg[chan_num].name);
> + of_property_read_u8(np, "led-cur",
> + &cfg[chan_num].led_current);
> + of_property_read_u8(np, "max-cur",
> + &cfg[chan_num].max_current);
> +
> + ret = of_property_read_u32(np, "reg", &led_number);
> + if (ret)
> + return ret;
> +
> + if (led_number < 0 || led_number > 6)
> + return -EINVAL;
> +
> + if (is_multicolor)
> + cfg[chan_num].color_component[color_num].output_num =
> + led_number;
> + else
> + cfg[chan_num].chan_nr = led_number;
> +
> + return 0;
> +}
> +
> +static int lp5xx_parse_channel_child(struct device_node *np,
> + struct lp55xx_led_config *cfg,
> + int child_number)
> +{
> + struct device_node *child;
> + int channel_color;
> + int num_colors = 0;
> + u32 color_id;
> + int ret;
> +
> + cfg[child_number].default_trigger =
> + of_get_property(np, "linux,default-trigger", NULL);
> +
> + ret = of_property_read_u32(np, "color", &channel_color);
> + if (ret)
> + channel_color = ret;
> +
> +
> + if (channel_color == LED_COLOR_ID_MULTI) {
> + for_each_child_of_node(np, child) {
> + ret = lp5xx_parse_common_child(child, cfg,
> + child_number, true,
> + num_colors);
> + if (ret)
> + return ret;
> +
> + ret = of_property_read_u32(child, "color", &color_id);
> + if (ret)
> + return ret;
> +
> + cfg[child_number].color_component[num_colors].color_id =
> + color_id;
> + set_bit(color_id, &cfg[child_number].available_colors);
> + num_colors++;
> + }
> +
> + cfg[child_number].num_colors = num_colors;
> + } else {
> + return lp5xx_parse_common_child(np, cfg, child_number, false,
> + num_colors);
> + }
> +
> + return 0;
> +}
> +
> struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
> struct device_node *np)
> {
> @@ -546,6 +678,7 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
> struct lp55xx_led_config *cfg;
> int num_channels;
> int i = 0;
> + int ret;
>
> pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
> if (!pdata)
> @@ -565,14 +698,9 @@ 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;
> -
> - 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);
> -
> + ret = lp5xx_parse_channel_child(child, cfg, i);
> + if (ret)
> + return ERR_PTR(-EINVAL);
> i++;
> }
>
> diff --git a/drivers/leds/leds-lp55xx-common.h b/drivers/leds/leds-lp55xx-common.h
> index 783ed5103ce5..55d420f704d1 100644
> --- a/drivers/leds/leds-lp55xx-common.h
> +++ b/drivers/leds/leds-lp55xx-common.h
> @@ -12,6 +12,10 @@
> #ifndef _LEDS_LP55XX_COMMON_H
> #define _LEDS_LP55XX_COMMON_H
>
> +#include <linux/led-class-multicolor.h>
> +
> +#define LP55XX_MAX_GROUPED_CHAN 4
> +
> enum lp55xx_engine_index {
> LP55XX_ENGINE_INVALID,
> LP55XX_ENGINE_1,
> @@ -109,6 +113,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);
> +
> /* current setting function */
> void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
>
> @@ -159,6 +166,8 @@ struct lp55xx_chip {
> * struct lp55xx_led
> * @chan_nr : Channel number
> * @cdev : LED class device
> + * @mc_cdev : Multi color class device
> + * @color_component : Multi color LED map information
> * @led_current : Current setting at each led channel
> * @max_current : Maximun current at each led channel
> * @brightness : Brightness value
> @@ -167,6 +176,8 @@ struct lp55xx_chip {
> struct lp55xx_led {
> int chan_nr;
> struct led_classdev cdev;
> + struct led_classdev_mc mc_cdev;
> + struct led_mc_color_conversion color_component[LP55XX_MAX_GROUPED_CHAN];
> u8 led_current;
> u8 max_current;
> u8 brightness;
> diff --git a/include/linux/platform_data/leds-lp55xx.h b/include/linux/platform_data/leds-lp55xx.h
> index 96a787100fda..1e7a25ed9a87 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,9 @@ 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;
> + struct led_mc_color_conversion color_component[LED_COLOR_ID_MAX];
I can't see why the array length can't be LP55XX_MAX_GROUPED_CHAN here
too. You're indexing it with num_colors counter and not with color_id.
> };
>
> struct lp55xx_predef_pattern {
>
--
Best regards,
Jacek Anaszewski
^ permalink raw reply [flat|nested] 32+ messages in thread* Re: [PATCH v11 12/16] leds: lp55xx: Add multicolor framework support to lp55xx
2019-10-09 22:04 ` Jacek Anaszewski
@ 2019-10-10 0:47 ` Dan Murphy
0 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-10 0:47 UTC (permalink / raw)
To: Jacek Anaszewski, pavel; +Cc: linux-leds, linux-kernel
Jacek
On 10/9/19 5:04 PM, Jacek Anaszewski wrote:
> Dan,
>
> On 10/8/19 10:47 PM, Dan Murphy wrote:
>> Add multicolor framework support for the lp55xx family.
>>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>> drivers/leds/Kconfig | 1 +
>> drivers/leds/leds-lp55xx-common.c | 176 +++++++++++++++++++---
>> drivers/leds/leds-lp55xx-common.h | 11 ++
>> include/linux/platform_data/leds-lp55xx.h | 5 +
>> 4 files changed, 169 insertions(+), 24 deletions(-)
>>
> [...]
>>
>> +static int lp5xx_parse_common_child(struct device_node *np,
>> + struct lp55xx_led_config *cfg,
>> + int chan_num, bool is_multicolor,
>> + int color_num)
>> +{
>> + u32 led_number;
>> + int ret;
>> +
>> + of_property_read_string(np, "chan-name",
>> + &cfg[chan_num].name);
>> + of_property_read_u8(np, "led-cur",
>> + &cfg[chan_num].led_current);
>> + of_property_read_u8(np, "max-cur",
>> + &cfg[chan_num].max_current);
>> +
>> + ret = of_property_read_u32(np, "reg", &led_number);
>> + if (ret)
>> + return ret;
>> +
>> + if (led_number < 0 || led_number > 6)
>> + return -EINVAL;
>> +
>> + if (is_multicolor)
>> + cfg[chan_num].color_component[color_num].output_num =
>> + led_number;
>> + else
>> + cfg[chan_num].chan_nr = led_number;
>> +
>> + return 0;
>> +}
>> +
>> +static int lp5xx_parse_channel_child(struct device_node *np,
>> + struct lp55xx_led_config *cfg,
>> + int child_number)
>> +{
>> + struct device_node *child;
>> + int channel_color;
>> + int num_colors = 0;
>> + u32 color_id;
>> + int ret;
>> +
>> + cfg[child_number].default_trigger =
>> + of_get_property(np, "linux,default-trigger", NULL);
>> +
>> + ret = of_property_read_u32(np, "color", &channel_color);
>> + if (ret)
>> + channel_color = ret;
>> +
>> +
>> + if (channel_color == LED_COLOR_ID_MULTI) {
>> + for_each_child_of_node(np, child) {
>> + ret = lp5xx_parse_common_child(child, cfg,
>> + child_number, true,
>> + num_colors);
>> + if (ret)
>> + return ret;
>> +
>> + ret = of_property_read_u32(child, "color", &color_id);
>> + if (ret)
>> + return ret;
>> +
>> + cfg[child_number].color_component[num_colors].color_id =
>> + color_id;
>> + set_bit(color_id, &cfg[child_number].available_colors);
>> + num_colors++;
>> + }
>> +
>> + cfg[child_number].num_colors = num_colors;
>> + } else {
>> + return lp5xx_parse_common_child(np, cfg, child_number, false,
>> + num_colors);
>> + }
>> +
>> + return 0;
>> +}
>> +
>> struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>> struct device_node *np)
>> {
>> @@ -546,6 +678,7 @@ struct lp55xx_platform_data *lp55xx_of_populate_pdata(struct device *dev,
>> struct lp55xx_led_config *cfg;
>> int num_channels;
>> int i = 0;
>> + int ret;
>>
>> pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
>> if (!pdata)
>> @@ -565,14 +698,9 @@ 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;
>> -
>> - 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);
>> -
>> + ret = lp5xx_parse_channel_child(child, cfg, i);
>> + if (ret)
>> + return ERR_PTR(-EINVAL);
>> i++;
>> }
>>
>> diff --git a/drivers/leds/leds-lp55xx-common.h b/drivers/leds/leds-lp55xx-common.h
>> index 783ed5103ce5..55d420f704d1 100644
>> --- a/drivers/leds/leds-lp55xx-common.h
>> +++ b/drivers/leds/leds-lp55xx-common.h
>> @@ -12,6 +12,10 @@
>> #ifndef _LEDS_LP55XX_COMMON_H
>> #define _LEDS_LP55XX_COMMON_H
>>
>> +#include <linux/led-class-multicolor.h>
>> +
>> +#define LP55XX_MAX_GROUPED_CHAN 4
>> +
>> enum lp55xx_engine_index {
>> LP55XX_ENGINE_INVALID,
>> LP55XX_ENGINE_1,
>> @@ -109,6 +113,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);
>> +
>> /* current setting function */
>> void (*set_led_current) (struct lp55xx_led *led, u8 led_current);
>>
>> @@ -159,6 +166,8 @@ struct lp55xx_chip {
>> * struct lp55xx_led
>> * @chan_nr : Channel number
>> * @cdev : LED class device
>> + * @mc_cdev : Multi color class device
>> + * @color_component : Multi color LED map information
>> * @led_current : Current setting at each led channel
>> * @max_current : Maximun current at each led channel
>> * @brightness : Brightness value
>> @@ -167,6 +176,8 @@ struct lp55xx_chip {
>> struct lp55xx_led {
>> int chan_nr;
>> struct led_classdev cdev;
>> + struct led_classdev_mc mc_cdev;
>> + struct led_mc_color_conversion color_component[LP55XX_MAX_GROUPED_CHAN];
>> u8 led_current;
>> u8 max_current;
>> u8 brightness;
>> diff --git a/include/linux/platform_data/leds-lp55xx.h b/include/linux/platform_data/leds-lp55xx.h
>> index 96a787100fda..1e7a25ed9a87 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,9 @@ 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;
>> + struct led_mc_color_conversion color_component[LED_COLOR_ID_MAX];
> I can't see why the array length can't be LP55XX_MAX_GROUPED_CHAN here
> too. You're indexing it with num_colors counter and not with color_id.
Ack
Dan
^ permalink raw reply [flat|nested] 32+ messages in thread
* [PATCH v11 13/16] leds: lp5523: Update the lp5523 code to add intensity function
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (11 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 12/16] leds: lp55xx: Add multicolor framework support to lp55xx Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 14/16] leds: lp5521: Add multicolor framework intensity support Dan Murphy
` (2 subsequent siblings)
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, Dan Murphy
Add the intensity function call back to support the multicolor
framework. This function allows setting a specific brightness on
a specific channel.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
drivers/leds/leds-lp5523.c | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/drivers/leds/leds-lp5523.c b/drivers/leds/leds-lp5523.c
index d0b931a136b9..5d6002e4d657 100644
--- a/drivers/leds/leds-lp5523.c
+++ b/drivers/leds/leds-lp5523.c
@@ -791,6 +791,25 @@ static ssize_t store_master_fader_leds(struct device *dev,
return ret;
}
+static int lp5523_led_intensity(struct lp55xx_led *led)
+{
+ struct lp55xx_chip *chip = led->chip;
+ int ret;
+ int i;
+
+ mutex_lock(&chip->lock);
+ for (i = 0; i < led->mc_cdev.num_leds; i++) {
+ ret = lp55xx_write(chip,
+ LP5523_REG_LED_PWM_BASE +
+ led->color_component[i].output_num,
+ led->color_component[i].brightness);
+ if (ret)
+ break;
+ }
+ mutex_unlock(&chip->lock);
+ return ret;
+}
+
static int lp5523_led_brightness(struct lp55xx_led *led)
{
struct lp55xx_chip *chip = led->chip;
@@ -857,6 +876,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,
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 14/16] leds: lp5521: Add multicolor framework intensity support
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (12 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 13/16] leds: lp5523: Update the lp5523 code to add intensity function Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:47 ` [PATCH v11 15/16] leds: lp55xx: Fix checkpatch file permissions issues Dan Murphy
2019-10-08 20:48 ` [PATCH v11 16/16] leds: lp5523: Fix checkpatch issues in the code Dan Murphy
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, Dan Murphy
Add the intensity function call back to support the multicolor
framework. This function allows setting a specific brightness on
a specific channel.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
drivers/leds/leds-lp5521.c | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/drivers/leds/leds-lp5521.c b/drivers/leds/leds-lp5521.c
index 6f0272249dc8..05731f405c9a 100644
--- a/drivers/leds/leds-lp5521.c
+++ b/drivers/leds/leds-lp5521.c
@@ -349,6 +349,25 @@ static int lp5521_run_selftest(struct lp55xx_chip *chip, char *buf)
return 0;
}
+static int lp5521_led_intensity(struct lp55xx_led *led)
+{
+ struct lp55xx_chip *chip = led->chip;
+ int ret;
+ int i;
+
+ mutex_lock(&chip->lock);
+ for (i = 0; i < led->mc_cdev.num_leds; i++) {
+ ret = lp55xx_write(chip,
+ LP5521_REG_LED_PWM_BASE +
+ led->color_component[i].output_num,
+ led->color_component[i].brightness);
+ if (ret)
+ break;
+ }
+ mutex_unlock(&chip->lock);
+ return ret;
+}
+
static int lp5521_led_brightness(struct lp55xx_led *led)
{
struct lp55xx_chip *chip = led->chip;
@@ -490,6 +509,7 @@ static struct lp55xx_device_config lp5521_cfg = {
.max_channel = LP5521_MAX_LEDS,
.post_init_device = lp5521_post_init_device,
.brightness_fn = lp5521_led_brightness,
+ .color_intensity_fn = lp5521_led_intensity,
.set_led_current = lp5521_set_led_current,
.firmware_cb = lp5521_firmware_loaded,
.run_engine = lp5521_run_engine,
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 15/16] leds: lp55xx: Fix checkpatch file permissions issues
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (13 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 14/16] leds: lp5521: Add multicolor framework intensity support Dan Murphy
@ 2019-10-08 20:47 ` Dan Murphy
2019-10-08 20:48 ` [PATCH v11 16/16] leds: lp5523: Fix checkpatch issues in the code Dan Murphy
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:47 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, Dan Murphy
Fix the checkpatch warnings for the use of the file permission macros.
In converting the file permissions to the DEVICE_ATTR_XX macros the
call back function names needed to be updated within the code.
This means that the lp55xx_ needed to be dropped in the name to keep in
harmony with the ABI documentation.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
drivers/leds/leds-lp55xx-common.c | 22 ++++++++++------------
1 file changed, 10 insertions(+), 12 deletions(-)
diff --git a/drivers/leds/leds-lp55xx-common.c b/drivers/leds/leds-lp55xx-common.c
index 85629f836082..fc5224108c64 100644
--- a/drivers/leds/leds-lp55xx-common.c
+++ b/drivers/leds/leds-lp55xx-common.c
@@ -78,7 +78,7 @@ static int lp55xx_post_init_device(struct lp55xx_chip *chip)
return cfg->post_init_device(chip);
}
-static ssize_t lp55xx_show_current(struct device *dev,
+static ssize_t led_current_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -87,7 +87,7 @@ static ssize_t lp55xx_show_current(struct device *dev,
return scnprintf(buf, PAGE_SIZE, "%d\n", led->led_current);
}
-static ssize_t lp55xx_store_current(struct device *dev,
+static ssize_t led_current_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t len)
{
@@ -111,7 +111,7 @@ static ssize_t lp55xx_store_current(struct device *dev,
return len;
}
-static ssize_t lp55xx_show_max_current(struct device *dev,
+static ssize_t max_current_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -120,9 +120,8 @@ static ssize_t lp55xx_show_max_current(struct device *dev,
return scnprintf(buf, PAGE_SIZE, "%d\n", led->max_current);
}
-static DEVICE_ATTR(led_current, S_IRUGO | S_IWUSR, lp55xx_show_current,
- lp55xx_store_current);
-static DEVICE_ATTR(max_current, S_IRUGO , lp55xx_show_max_current, NULL);
+static DEVICE_ATTR_RW(led_current);
+static DEVICE_ATTR_RO(max_current);
static struct attribute *lp55xx_led_attrs[] = {
&dev_attr_led_current.attr,
@@ -282,7 +281,7 @@ static int lp55xx_request_firmware(struct lp55xx_chip *chip)
GFP_KERNEL, chip, lp55xx_firmware_loaded);
}
-static ssize_t lp55xx_show_engine_select(struct device *dev,
+static ssize_t select_engine_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -292,7 +291,7 @@ static ssize_t lp55xx_show_engine_select(struct device *dev,
return sprintf(buf, "%d\n", chip->engine_idx);
}
-static ssize_t lp55xx_store_engine_select(struct device *dev,
+static ssize_t select_engine_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t len)
{
@@ -334,7 +333,7 @@ static inline void lp55xx_run_engine(struct lp55xx_chip *chip, bool start)
chip->cfg->run_engine(chip, start);
}
-static ssize_t lp55xx_store_engine_run(struct device *dev,
+static ssize_t run_engine_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t len)
{
@@ -359,9 +358,8 @@ static ssize_t lp55xx_store_engine_run(struct device *dev,
return len;
}
-static DEVICE_ATTR(select_engine, S_IRUGO | S_IWUSR,
- lp55xx_show_engine_select, lp55xx_store_engine_select);
-static DEVICE_ATTR(run_engine, S_IWUSR, NULL, lp55xx_store_engine_run);
+static DEVICE_ATTR_RW(select_engine);
+static DEVICE_ATTR_WO(run_engine);
static struct attribute *lp55xx_engine_attributes[] = {
&dev_attr_select_engine.attr,
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread* [PATCH v11 16/16] leds: lp5523: Fix checkpatch issues in the code
2019-10-08 20:47 [PATCH v11 00/16] Multicolor Framework v11 Dan Murphy
` (14 preceding siblings ...)
2019-10-08 20:47 ` [PATCH v11 15/16] leds: lp55xx: Fix checkpatch file permissions issues Dan Murphy
@ 2019-10-08 20:48 ` Dan Murphy
15 siblings, 0 replies; 32+ messages in thread
From: Dan Murphy @ 2019-10-08 20:48 UTC (permalink / raw)
To: jacek.anaszewski, pavel; +Cc: linux-leds, linux-kernel, Dan Murphy
Fix checkpatch errors and warnings for the LP5523.c device
driver.
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
drivers/leds/leds-lp5523.c | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/drivers/leds/leds-lp5523.c b/drivers/leds/leds-lp5523.c
index 5d6002e4d657..3c7c2e68e137 100644
--- a/drivers/leds/leds-lp5523.c
+++ b/drivers/leds/leds-lp5523.c
@@ -23,13 +23,13 @@
#define LP5523_PROGRAM_LENGTH 32 /* bytes */
/* Memory is used like this:
- 0x00 engine 1 program
- 0x10 engine 2 program
- 0x20 engine 3 program
- 0x30 engine 1 muxing info
- 0x40 engine 2 muxing info
- 0x50 engine 3 muxing info
-*/
+ * 0x00 engine 1 program
+ * 0x10 engine 2 program
+ * 0x20 engine 3 program
+ * 0x30 engine 1 muxing info
+ * 0x40 engine 2 muxing info
+ * 0x50 engine 3 muxing info
+ */
#define LP5523_MAX_LEDS 9
/* Registers */
@@ -326,7 +326,7 @@ static int lp5523_update_program_memory(struct lp55xx_chip *chip,
const u8 *data, size_t size)
{
u8 pattern[LP5523_PROGRAM_LENGTH] = {0};
- unsigned cmd;
+ unsigned int cmd;
char c[3];
int nrchars;
int ret;
@@ -468,6 +468,7 @@ static int lp5523_mux_parse(const char *buf, u16 *mux, size_t len)
static void lp5523_mux_to_array(u16 led_mux, char *array)
{
int i, pos = 0;
+
for (i = 0; i < LP5523_MAX_LEDS; i++)
pos += sprintf(array + pos, "%x", LED_ACTIVE(led_mux, i));
@@ -506,7 +507,7 @@ static int lp5523_load_mux(struct lp55xx_chip *chip, u16 mux, int nr)
if (ret)
return ret;
- ret = lp55xx_write(chip, LP5523_REG_PROG_MEM , (u8)(mux >> 8));
+ ret = lp55xx_write(chip, LP5523_REG_PROG_MEM, (u8)(mux >> 8));
if (ret)
return ret;
--
2.22.0.214.g8dca754b1e
^ permalink raw reply related [flat|nested] 32+ messages in thread