Skip to contentSkip to conversation

auxdisplay: ht16k33: Drop device node reference after registration failure in ht16k33_led_probe()

PATCH In review Markus Elfring 2 participants 4 messages Jun 4, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 auxdisplay: ht16k33: Drop device node reference after registration failure in ht16k33_led_probe()

From: Markus Elfring <[email protected]>
Date: Tue, 4 Jun 2024 17:02:15 +0200

A failed call of the function “devm_led_classdev_register_ext” can be reported.
Add a call of the function “fwnode_handle_put” for this error case.

Fixes c223d9c636ed ("auxdisplay: ht16k33: Add LED support")
---
 drivers/auxdisplay/ht16k33.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
drivers/auxdisplay/ht16k33.c +3 -1
index ce987944662c..ef86537c9d83 100644
@@ -483,8 +483,10 @@ static int ht16k33_led_probe(struct device *dev, struct led_classdev *led,
 	led->max_brightness = MAX_BRIGHTNESS;
 
 	err = devm_led_classdev_register_ext(dev, led, &init_data);
-	if (err)
+	if (err) {
 		dev_err(dev, "Failed to register LED\n");
+		fwnode_handle_put(init_data.fwnode);
+	}
 
 	return err;
 }

--
2.45.1

maintainer
#1 lore raw
Quoted 6 lines · Markus Elfring

From: Markus Elfring <[email protected]>
Date: Tue, 4 Jun 2024 17:02:15 +0200

A failed call of the function “devm_led_classdev_register_ext” can be reported.
Add a call of the function “fwnode_handle_put” for this error case.

Replace double quotes by parentheses, so the reference to the functions will look like func().

...

drivers/auxdisplay/ht16k33.c static int ht16k33_led_probe(struct device *dev, struct led_classdev *led, · line 489

Quoted 6 lines
drivers/auxdisplay/ht16k33.c +3 -1
 	err = devm_led_classdev_register_ext(dev, led, &init_data);
-	if (err)
+	if (err) {
 		dev_err(dev, "Failed to register LED\n");
+		fwnode_handle_put(init_data.fwnode);
+	}

There are two issues with this approach:
1) there is the same issue in ->remove(), isn't it?
2) it potentially might mess up the ordering if any other devm call happens in beetween.

But, by design we don't use reference counting after we registered LED, hence both error and successful paths need to have this, so add another fwnode_handle_put() after this branch.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#2 lore raw
Quoted 2 lines

But, by design we don't use reference counting after we registered LED, hence both error and successful paths need to have this,

Do you indicate really special data processing constraints here?

Quoted 1 line

so add another fwnode_handle_put() after this branch.

Will this suggestion trigger any further clarifications for the affected software?

Regards,
Markus

maintainer
#3 lore raw
Quoted 4 lines · Markus Elfring
Quoted 2 lines

But, by design we don't use reference counting after we registered LED, hence both error and successful paths need to have this,

Do you indicate really special data processing constraints here?

Nothing special, either we hold reference for the entire life time of the device or not. For LEDS the convention is not to hold.

Quoted 3 lines
Quoted 1 line

so add another fwnode_handle_put() after this branch.

Will this suggestion trigger any further clarifications for the affected software?

You need to put an fwnode handle in both paths: inside the if branch as you have done (error path) and missing one is after that needs to be added.

Just address my comments and I believe everyone will be happy about it.

Signature · 2 lines
With Best Regards,
Andy Shevchenko