2019-12-05 21:25:54

by Jacek Anaszewski

[permalink] [raw]
Subject: [PATCH] leds: gpio: Fix uninitialized gpio label for fwnode based probe

When switching to using generic LED name composition mechanism via
devm_led_classdev_register_ext() API the part of code initializing
struct gpio_led's template name property was removed alongside.
It was however overlooked that the property was also passed to
devm_fwnode_get_gpiod_from_child() in place of "label" parameter,
which when set to NULL, results in gpio label being initialized to '?'.

It could be observed in debugfs and failed to properly identify
gpio association with LED consumer.

Fix this shortcoming by updating the GPIO label after the LED is
registered and its final name is known.

Fixes: d7235f5feaa0 ("leds: gpio: Use generic support for composing LED names")
Cc: Linus Walleij <[email protected]>
Cc: Pavel Machek <[email protected]>
Cc: Russell King <[email protected]>
Signed-off-by: Jacek Anaszewski <[email protected]>
---
drivers/leds/leds-gpio.c | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/drivers/leds/leds-gpio.c b/drivers/leds/leds-gpio.c
index a5c73f3d5f79..43eeed096d0d 100644
--- a/drivers/leds/leds-gpio.c
+++ b/drivers/leds/leds-gpio.c
@@ -151,9 +151,14 @@ static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
struct gpio_led led = {};
const char *state = NULL;

+ /**
+ * Acquire gpiod from DT with uninitialized label, which
+ * will be updated after LED class device is registered,
+ * Only then the final LED name is known.
+ */
led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL, child,
GPIOD_ASIS,
- led.name);
+ NULL);
if (IS_ERR(led.gpiod)) {
fwnode_handle_put(child);
return ERR_CAST(led.gpiod);
@@ -186,6 +191,9 @@ static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
fwnode_handle_put(child);
return ERR_PTR(ret);
}
+ /* Set gpiod label to match the corresponding LED name. */
+ gpiod_set_consumer_name(led_dat->gpiod,
+ led_dat->cdev.dev->kobj.name);
priv->num_leds++;
}

--
2.11.0


2019-12-11 00:45:50

by Linus Walleij

[permalink] [raw]
Subject: Re: [PATCH] leds: gpio: Fix uninitialized gpio label for fwnode based probe

On Thu, Dec 5, 2019 at 10:25 PM Jacek Anaszewski
<[email protected]> wrote:

> When switching to using generic LED name composition mechanism via
> devm_led_classdev_register_ext() API the part of code initializing
> struct gpio_led's template name property was removed alongside.
> It was however overlooked that the property was also passed to
> devm_fwnode_get_gpiod_from_child() in place of "label" parameter,
> which when set to NULL, results in gpio label being initialized to '?'.
>
> It could be observed in debugfs and failed to properly identify
> gpio association with LED consumer.
>
> Fix this shortcoming by updating the GPIO label after the LED is
> registered and its final name is known.
>
> Fixes: d7235f5feaa0 ("leds: gpio: Use generic support for composing LED names")
> Cc: Linus Walleij <[email protected]>
> Cc: Pavel Machek <[email protected]>
> Cc: Russell King <[email protected]>
> Signed-off-by: Jacek Anaszewski <[email protected]>

Reviewed-by: Linus Walleij <[email protected]>

Yours,
Linus Walleij

2019-12-21 18:51:57

by Pavel Machek

[permalink] [raw]
Subject: Re: [PATCH] leds: gpio: Fix uninitialized gpio label for fwnode based probe

Hi!

> When switching to using generic LED name composition mechanism via
> devm_led_classdev_register_ext() API the part of code initializing
> struct gpio_led's template name property was removed alongside.
> It was however overlooked that the property was also passed to
> devm_fwnode_get_gpiod_from_child() in place of "label" parameter,
> which when set to NULL, results in gpio label being initialized to '?'.
>
> It could be observed in debugfs and failed to properly identify
> gpio association with LED consumer.
>
> Fix this shortcoming by updating the GPIO label after the LED is
> registered and its final name is known.
>
> Fixes: d7235f5feaa0 ("leds: gpio: Use generic support for composing LED names")
> Cc: Linus Walleij <[email protected]>
> Cc: Pavel Machek <[email protected]>
> Cc: Russell King <[email protected]>
> Signed-off-by: Jacek Anaszewski <[email protected]>

Patch looks good, except:

> @@ -151,9 +151,14 @@ static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
> struct gpio_led led = {};
> const char *state = NULL;
>
> + /**
> + * Acquire gpiod from DT with uninitialized label, which
> + * will be updated after LED class device is registered,
> + * Only then the final LED name is known.
> + */
> led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL, child,
> GPIOD_ASIS,
> - led.name);
> + NULL);

This is not linuxdoc, so comment should beging with /* AFAICT.

I'll probably hand-edit the patch.

Best regards,
Pavel
--
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html


Attachments:
(No filename) (1.70 kB)
signature.asc (188.00 B)
Digital signature
Download all attachments

2019-12-21 20:27:47

by Jacek Anaszewski

[permalink] [raw]
Subject: Re: [PATCH] leds: gpio: Fix uninitialized gpio label for fwnode based probe

On 12/21/19 7:49 PM, Pavel Machek wrote:
> Hi!
>
>> When switching to using generic LED name composition mechanism via
>> devm_led_classdev_register_ext() API the part of code initializing
>> struct gpio_led's template name property was removed alongside.
>> It was however overlooked that the property was also passed to
>> devm_fwnode_get_gpiod_from_child() in place of "label" parameter,
>> which when set to NULL, results in gpio label being initialized to '?'.
>>
>> It could be observed in debugfs and failed to properly identify
>> gpio association with LED consumer.
>>
>> Fix this shortcoming by updating the GPIO label after the LED is
>> registered and its final name is known.
>>
>> Fixes: d7235f5feaa0 ("leds: gpio: Use generic support for composing LED names")
>> Cc: Linus Walleij <[email protected]>
>> Cc: Pavel Machek <[email protected]>
>> Cc: Russell King <[email protected]>
>> Signed-off-by: Jacek Anaszewski <[email protected]>
>
> Patch looks good, except:
>
>> @@ -151,9 +151,14 @@ static struct gpio_leds_priv *gpio_leds_create(struct platform_device *pdev)
>> struct gpio_led led = {};
>> const char *state = NULL;
>>
>> + /**
>> + * Acquire gpiod from DT with uninitialized label, which
>> + * will be updated after LED class device is registered,
>> + * Only then the final LED name is known.
>> + */
>> led.gpiod = devm_fwnode_get_gpiod_from_child(dev, NULL, child,
>> GPIOD_ASIS,
>> - led.name);
>> + NULL);
>
> This is not linuxdoc, so comment should beging with /* AFAICT.

Right.

> I'll probably hand-edit the patch.

Sure, thanks.

--
Best regards,
Jacek Anaszewski