Skip to contentSkip to conversation

led: led-class: Read max-brightness from devicetree

PATCH In review Astrid Rost 5 participants 7 messages Jun 30, 2023 – Jul 3, 2023 1 message not in the archive

Subsystems (2)
lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): [email protected]

#1 lore raw

PATCH v2 1/2 led: led-class: Read max-brightness from devicetree

Add max-brightness in order to reduce the current on the connected LEDs. Normally, the maximum brightness is determined by the hardware, and this property is not required. This property is used to set a software limit. It could happen that an LED is made so bright that it gets damaged or causes damage due to restrictions in a specific system, such as mounting conditions. Note that led-max-microamp should be preferably used, if it is supported by the controller.

---
 drivers/leds/led-class.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/leds/led-class.c +4 -0
index 9255bc11f99d..ce652abf9336 100644
@@ -457,6 +457,10 @@ int led_classdev_register_ext(struct device *parent,
 			if (fwnode_property_present(init_data->fwnode,
 						    "retain-state-shutdown"))
 				led_cdev->flags |= LED_RETAIN_AT_SHUTDOWN;
+
+			fwnode_property_read_u32(init_data->fwnode,
+				"max-brightness",
+				&led_cdev->max_brightness);
 		}
 	} else {
 		proposed_name = led_cdev->name;
Signature · 1 line
2.30.2
Reviewed-by on v2 1/2
#2 lore raw
Quoted 7 lines · Astrid Rost

Add max-brightness in order to reduce the current on the connected LEDs. Normally, the maximum brightness is determined by the hardware, and this property is not required. This property is used to set a software limit. It could happen that an LED is made so bright that it gets damaged or causes damage due to restrictions in a specific system, such as mounting conditions. Note that led-max-microamp should be preferably used, if it is supported by the controller.

LGTM,

Maybe you can also add to the cover letter that there are already users in the kernel that may be simplified after this change lands the upstream.

Quoted 23 lines
---
 drivers/leds/led-class.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/leds/led-class.c +4 -0
index 9255bc11f99d..ce652abf9336 100644
@@ -457,6 +457,10 @@ int led_classdev_register_ext(struct device *parent,
 			if (fwnode_property_present(init_data->fwnode,
 						    "retain-state-shutdown"))
 				led_cdev->flags |= LED_RETAIN_AT_SHUTDOWN;
+
+			fwnode_property_read_u32(init_data->fwnode,
+				"max-brightness",
+				&led_cdev->max_brightness);
 		}
 	} else {
 		proposed_name = led_cdev->name;
Signature · 1 line
2.30.2
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw
In reply to Astrid Rost

Hi Astrid,

Quoted 18 lines · Astrid Rost

Add max-brightness in order to reduce the current on the connected LEDs. Normally, the maximum brightness is determined by the hardware, and this property is not required. This property is used to set a software limit. It could happen that an LED is made so bright that it gets damaged or causes damage due to restrictions in a specific system, such as mounting conditions. Note that led-max-microamp should be preferably used, if it is supported by the controller.

---
  drivers/leds/led-class.c | 4 ++++
  1 file changed, 4 insertions(+)
drivers/leds/led-class.c +0 -0
index 9255bc11f99d..ce652abf9336 100644

drivers/leds/led-class.c int led_classdev_register_ext(struct device *parent, · line 466

Quoted 10 lines
drivers/leds/led-class.c +4 -0
@@ -457,6 +457,10 @@ int led_classdev_register_ext(struct device *parent,
  			if (fwnode_property_present(init_data->fwnode,
  						    "retain-state-shutdown"))
  				led_cdev->flags |= LED_RETAIN_AT_SHUTDOWN;
+
+			fwnode_property_read_u32(init_data->fwnode,
+				"max-brightness",
+				&led_cdev->max_brightness);
  		}
  	} else {
  		proposed_name = led_cdev->name;

We have led-max-microamp for that and every LED class driver is supposed to calculate its max brightness level basing on it.

Signature · 2 lines
Best regards,
Jacek Anaszewski
#4 lore raw

Hello Jacek,

I am having problems with the PWM controller LP5024.

https://www.ti.com/product/LP5024

There is no such a calculation in the data-sheet like:
max_brightness = max_current / constant.

I also assume it is depending on the type of LEDs and circuit, which are connected.

It supports two current modes: 25,5 mA and and 35 mA, both is to high for the LEDs I have.

For max_brightness seems to be everything inside the kernel, but reading the value from devicetree. I first thought I could add it in the lp50xx driver, but Andy and Rob thought that I better put it into the general parts. And of course drivers having led-max-microamp should better use it.

Please, let me know if you have a better suggestion.

Astrid

Quoted 35 lines · Jacek Anaszewski

Hi Astrid,

Quoted 18 lines · Astrid Rost

Add max-brightness in order to reduce the current on the connected LEDs. Normally, the maximum brightness is determined by the hardware, and this property is not required. This property is used to set a software limit. It could happen that an LED is made so bright that it gets damaged or causes damage due to restrictions in a specific system, such as mounting conditions. Note that led-max-microamp should be preferably used, if it is supported by the controller.

---
  drivers/leds/led-class.c | 4 ++++

  1 file changed, 4 insertions(+)
drivers/leds/led-class.c +0 -0
index 9255bc11f99d..ce652abf9336 100644

drivers/leds/led-class.c int led_classdev_register_ext(struct device *parent, · line 466

Quoted 10 lines
drivers/leds/led-class.c +4 -0
@@ -457,6 +457,10 @@ int led_classdev_register_ext(struct device *parent,
               if (fwnode_property_present(init_data->fwnode,
                               "retain-state-shutdown"))
                   led_cdev->flags |= LED_RETAIN_AT_SHUTDOWN;
+
+            fwnode_property_read_u32(init_data->fwnode,
+                "max-brightness",
+                &led_cdev->max_brightness);
           }
       } else {
           proposed_name = led_cdev->name;

We have led-max-microamp for that and every LED class driver is supposed to calculate its max brightness level basing on it.

#5 lore raw

Hi Astrid,

Quoted 9 lines · Astrid Rost

Hello Jacek,

I am having problems with the PWM controller LP5024.

https://www.ti.com/product/LP5024

There is no such a calculation in the data-sheet like:
max_brightness = max_current / constant.

Quoted 8 lines

I also assume it is depending on the type of LEDs and circuit, which are connected.

It supports two current modes: 25,5 mA and and 35 mA, both is to high for the LEDs I have.

For max_brightness seems to be everything inside the kernel, but reading the value from devicetree. I first thought I could add it in the lp50xx driver, but Andy and Rob thought that I better put it into the general parts. And of course drivers having led-max-microamp should better use it.

Please, let me know if you have a better suggestion.

OK, since this LED controller is PWM-driven then there is no current per brightness level granulation. Bindings of leds-pwm driver also use max-brightness DT property. So, yeah, let's make it a common property, but state clearly that it is mainly for drivers like PWM ones, where it is not possible to map brightness level to the amount of current.

Signature · 2 lines
Best regards,
Jacek Anaszewski
#6 lore raw

PATCH v2 2/2 dt-bindings: leds: Read max-brightness from devicetree

In reply to a message not in the archive

Add max-brightness in order to reduce the current on the connected LEDs. Normally, the maximum brightness is determined by the hardware, and this property is not required. This property is used to set a software limit. It could happen that an LED is made so bright that it gets damaged or causes damage due to restrictions in a specific system, such as mounting conditions. Note that led-max-microamp should be preferably used, if it is supported by the controller.

---
 Documentation/devicetree/bindings/leds/common.yaml | 10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/devicetree/bindings/leds/common.yaml +10 -0
index 11aedf1650a1..603a5630fc3d 100644
@@ -160,6 +160,16 @@ properties:
       For flash LED controllers with configurable current this property is
       mandatory for the LEDs in the non-flash modes (e.g. torch or indicator).
 
+  max-brightness:
+    description:
+      Normally, the maximum brightness is determined by the hardware, and
+      this property is not required. This property is used to set a software
+      limit. It could happen that an LED is made so bright that it gets damaged
+      or causes damage due to restrictions in a specific system, such as
+      mounting conditions. Note that led-max-microamp should be preferably used,
+      if it is supported by the controller.
+    $ref: /schemas/types.yaml#definitions/uint32
+
   panic-indicator:
     description:
       This property specifies that the LED should be used, if at all possible,
Signature · 1 line
2.30.2
maintainer Reviewed-by on v2 2/2
#7 lore raw

Re: [PATCH v2 2/2] dt-bindings: leds: Read max-brightness from devicetree

Quoted 8 lines · Astrid Rost

Add max-brightness in order to reduce the current on the connected LEDs. Normally, the maximum brightness is determined by the hardware, and this property is not required. This property is used to set a software limit. It could happen that an LED is made so bright that it gets damaged or causes damage due to restrictions in a specific system, such as mounting conditions. Note that led-max-microamp should be preferably used, if it is supported by the controller.

Quoted 4 lines
---
 Documentation/devicetree/bindings/leds/common.yaml | 10 ++++++++++
 1 file changed, 10 insertions(+)

The patch order is wrong. You have to define a property before you can use it. Otherwise,