Skip to contentSkip to conversation

leds: Ensure hardware blinking turns off when requested

PATCH RESEND In review Eddie James 2 participants 2 messages Apr 5, 2023 – Apr 20, 2023 LED

lore
Share & tools
lore
#0 lore raw

PATCH RESEND 1/1 leds: Ensure hardware blinking turns off when requested

If an LED is blinking through the hardware and the trigger is deactivated, the driver will set the brightness to 0 to disable blinking. However, if the LED driver doesn't support non-blocking operations, the request for setting brightness to 0 will get queued. Then if a user requests a new non-zero brightness before the request for 0 brightness is executed, the LED blinking will not get disabled since the brightness will simply be updated.
Fix this by flushing the workqueue before updating the requested brightness.

Fixes 4d71a4a12b13 ("leds: Add support for setting brightness in a synchronous way")
---
 drivers/leds/led-class.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/leds/led-class.c +2 -0
index 9255bc11f99d..78a270300d30 100644
@@ -57,6 +57,8 @@ static ssize_t brightness_store(struct device *dev,
 
 	if (state == LED_OFF)
 		led_trigger_remove(led_cdev);
+	/* flush out any request to disable blinking */
+	flush_work(&led_cdev->set_brightness_work);
 	led_set_brightness(led_cdev, state);
 	flush_work(&led_cdev->set_brightness_work);
 
Signature · 1 line
2.31.1
maintainer
#1 lore raw
Quoted 9 lines · Eddie James

If an LED is blinking through the hardware and the trigger is deactivated, the driver will set the brightness to 0 to disable blinking. However, if the LED driver doesn't support non-blocking operations, the request for setting brightness to 0 will get queued. Then if a user requests a new non-zero brightness before the request for 0 brightness is executed, the LED blinking will not get disabled since the brightness will simply be updated.
Fix this by flushing the workqueue before updating the requested brightness.

You make a convincing argument for this.

Quoted 11 lines
Fixes 4d71a4a12b13 ("leds: Add support for setting brightness in a synchronous way")
---
 drivers/leds/led-class.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/leds/led-class.c +0 -0
index 9255bc11f99d..78a270300d30 100644

drivers/leds/led-class.c static ssize_t brightness_store(struct device *dev, · line 63

Quoted 7 lines
drivers/leds/led-class.c +2 -0
@@ -57,6 +57,8 @@ static ssize_t brightness_store(struct device *dev,
 
 	if (state == LED_OFF)
 		led_trigger_remove(led_cdev);
+	/* flush out any request to disable blinking */
+	flush_work(&led_cdev->set_brightness_work);
 	led_set_brightness(led_cdev, state);
 	flush_work(&led_cdev->set_brightness_work);

Just to be clear, you want to flush the work before AND after setting the brightness?

In the commit message, could you make it clear why simply moving this flush won't work.

Signature · 1 line
Lee Jones [李琼斯]