From: Jacek Anaszewski <jacek.anaszewski@gmail.com>
To: Dan Murphy <dmurphy@ti.com>, linux-leds@vger.kernel.org
Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
pavel@ucw.cz, robh@kernel.org,
Baolin Wang <baolin.wang@linaro.org>,
Daniel Mack <daniel@zonque.org>,
Linus Walleij <linus.walleij@linaro.org>,
Oleh Kravchenko <oleg@kaa.org.ua>,
Sakari Ailus <sakari.ailus@linux.intel.com>,
Simon Shields <simon@lineageos.org>,
Xiaotong Lu <xiaotong.lu@spreadtrum.com>
Subject: Re: [PATCH 02/24] leds: core: Add support for composing LED class device names
Date: Thu, 8 Nov 2018 21:48:04 +0100 [thread overview]
Message-ID: <5e857610-baee-9b4b-7a21-025be1f9670e@gmail.com> (raw)
In-Reply-To: <84dd8750-883e-1318-df85-f4c6b46b898f@ti.com>
Dan,
On 11/08/2018 07:06 PM, Dan Murphy wrote:
> On 11/06/2018 04:07 PM, Jacek Anaszewski wrote:
>> Add public led_compose_name() API for composing LED class device
>> name basing on fwnode_handle data. The function composes device name
>> according to either a new <color:function> pattern or the legacy
>> <devicename:color:function> pattern. The decision on using the
>> particular pattern is made basing on whether fwnode contains new
>> "function" and "color" properties, or the legacy "label" proeprty.
>>
>> Backwards compatibility with in-driver hard-coded LED class device
>> names is assured thanks to the default_desc argument.
>>
>> In case none of the aformentioned properties was found, then, for OF
>> nodes, the node name is adopted for LED class device name.
>>
>> Signed-off-by: Jacek Anaszewski <jacek.anaszewski@gmail.com>
>> Cc: Baolin Wang <baolin.wang@linaro.org>
>> Cc: Daniel Mack <daniel@zonque.org>
>> Cc: Dan Murphy <dmurphy@ti.com>
>> Cc: Linus Walleij <linus.walleij@linaro.org>
>> Cc: Oleh Kravchenko <oleg@kaa.org.ua>
>> Cc: Sakari Ailus <sakari.ailus@linux.intel.com>
>> Cc: Simon Shields <simon@lineageos.org>
>> Cc: Xiaotong Lu <xiaotong.lu@spreadtrum.com>
>> ---
>> Documentation/leds/leds-class.txt | 2 +-
>> drivers/leds/led-core.c | 71 +++++++++++++++++++++++++++++++++++++++
>> include/linux/leds.h | 32 ++++++++++++++++++
>> 3 files changed, 104 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/leds/leds-class.txt b/Documentation/leds/leds-class.txt
>> index 836cb16..e9009c4 100644
>> --- a/Documentation/leds/leds-class.txt
>> +++ b/Documentation/leds/leds-class.txt
>> @@ -43,7 +43,7 @@ LED Device Naming
>>
>> Is currently of the form:
>>
>> -"devicename:colour:function"
>> +"colour:function"
>>
>> There have been calls for LED properties such as colour to be exported as
>> individual led class attributes. As a solution which doesn't incur as much
>> diff --git a/drivers/leds/led-core.c b/drivers/leds/led-core.c
>> index ede4fa0..f7371fc 100644
>> --- a/drivers/leds/led-core.c
>> +++ b/drivers/leds/led-core.c
>> @@ -16,6 +16,8 @@
>> #include <linux/list.h>
>> #include <linux/module.h>
>> #include <linux/mutex.h>
>> +#include <linux/of.h>
>> +#include <linux/property.h>
>> #include <linux/rwsem.h>
>> #include "leds.h"
>>
>> @@ -327,3 +329,72 @@ void led_sysfs_enable(struct led_classdev *led_cdev)
>> led_cdev->flags &= ~LED_SYSFS_DISABLE;
>> }
>> EXPORT_SYMBOL_GPL(led_sysfs_enable);
>> +
>> +static void led_parse_properties(struct fwnode_handle *fwnode,
>> + struct led_properties *props)
>> +{
>> + int ret;
>> +
>> + if (!fwnode)
>> + return;
>> +
>> + ret = fwnode_property_read_string(fwnode, "label", &props->label);
>
> If we have the label do we need to continue to look for the function and color nodes?
>
> It can be checked and diverted using fwnode_property_present for the "label" property
Good catch. I will respin it as proposed.
>> + if (!ret)
>> + return;
>> +
>> + ret = fwnode_property_read_string(fwnode, "function", &props->function);
>> + if (ret)
>> + pr_info("Failed to parse function property\n");
>> +
>> + ret = fwnode_property_read_string(fwnode, "color", &props->color);
>> + if (ret)
>> + pr_info("Failed to parse color property\n");
>> +}
>> +
>> +int led_compose_name(struct fwnode_handle *fwnode, const char *led_hw_name,
>> + const char *default_desc, char *led_classdev_name)
>> +{
>> + struct led_properties props = {};
>> +
>> + if (!led_classdev_name)
>> + return -EINVAL;
>> +
>> + led_parse_properties(fwnode, &props);
>> +
>> + if (props.label) {
>> + /*
>> + * Presence of 'label' DT property implies legacy LED name,
>> + * formatted as <devicename:color:function>, with possible
>> + * section omission if doesn't apply to given device.
>> + *
>> + * If no led_hw_name has been passed, then it indicates that
>> + * DT label should be used as-is for LED class device name.
>> + * Otherwise the label is prepended with led_hw_name to compose
>> + * the final LED class device name.
>> + */
>> + if (!led_hw_name) {
>> + strncpy(led_classdev_name, props.label,
>> + LED_MAX_NAME_SIZE);
>> + } else {
>> + snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
>> + led_hw_name, props.label);
>> + }
>> + } else if (props.function || props.color) {
>> + snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
>> + props.color ?: "", props.function ?: "");
>> + } else if (default_desc) {
>> + if (!led_hw_name) {
>> + pr_err("Legacy LED naming requires devicename segment");
>> + return -EINVAL;
>> + }
>> + snprintf(led_classdev_name, LED_MAX_NAME_SIZE, "%s:%s",
>> + led_hw_name, default_desc);
>> + } else if (is_of_node(fwnode)) {
>> + strncpy(led_classdev_name, to_of_node(fwnode)->name,
>> + LED_MAX_NAME_SIZE);
>> + } else
>> + return -EINVAL;
>> +
>> + return 0;
>> +}
>> +EXPORT_SYMBOL_GPL(led_compose_name);
>> diff --git a/include/linux/leds.h b/include/linux/leds.h
>> index 646c49a..ddb4001 100644
>> --- a/include/linux/leds.h
>> +++ b/include/linux/leds.h
>> @@ -238,6 +238,32 @@ extern void led_sysfs_disable(struct led_classdev *led_cdev);
>> extern void led_sysfs_enable(struct led_classdev *led_cdev);
>>
>> /**
>> + * led_compose_name - compose LED class device name
>> + * @child: child fwnode_handle describing a LED,
>> + * or a group of synchronized LEDs.
>> + * @led_hw_name: name of the LED controller, used when falling back to legacy
>> + * LED naming; it should be set to NULL in new LED class drivers
>> + * @default_desc: default <color:function> tuple, for backwards compatibility
>> + * with in-driver hard-coded LED names used as a fallback when
>> + * "label" DT property was absent; it should be set to NULL
>> + * in new LED class drivers
>> + * @led_classdev_name: composed LED class device name
>> + *
>> + * Create LED class device name basing on the configuration provided by the
>> + * board firmware. The name can have a legacy form <devicename:color:function>,
>> + * or a new form <color:function>. The latter is chosen if at least one of
>> + * "color" or "function" properties is present in the fwnode, leaving the
>> + * section blank if the related property is absent. The former is applied
>> + * when legacy "label" property is present in the fwnode. In case none of the
>> + * aformentioned properties was found, then, for OF nodes, the node name
>
> s/aforementioned
>
>> + * is adopted for LED class device name.
>> + *
>> + * Returns: 0 on success or negative error value on failure
>> + */
>> +extern int led_compose_name(struct fwnode_handle *child, const char *led_hw_name,
>> + const char *default_desc, char *led_classdev_name);
>> +
>> +/**
>> * led_sysfs_is_disabled - check if LED sysfs interface is disabled
>> * @led_cdev: the LED to query
>> *
>> @@ -414,6 +440,12 @@ struct led_platform_data {
>> struct led_info *leds;
>> };
>>
>> +struct led_properties {
>> + const char *color;
>> + const char *function;
>> + const char *label;
>> +};
>> +
>> struct gpio_desc;
>> typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state,
>> unsigned long *delay_on,
>>
>
>
--
Best regards,
Jacek Anaszewski
next prev parent reply other threads:[~2018-11-08 20:48 UTC|newest]
Thread overview: 105+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-06 22:07 [PATCH 00/24] Add generic support for composing LED class device name Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 01/24] leds: class: Improve LED and LED flash class registration API Jacek Anaszewski
2018-11-07 6:55 ` Baolin Wang
2018-11-07 20:51 ` Jacek Anaszewski
2018-11-08 17:50 ` Dan Murphy
2018-11-08 20:47 ` Jacek Anaszewski
2018-11-11 11:31 ` Pavel Machek
2018-11-06 22:07 ` [PATCH 02/24] leds: core: Add support for composing LED class device names Jacek Anaszewski
2018-11-07 7:20 ` Baolin Wang
2018-11-08 20:47 ` Jacek Anaszewski
2018-11-09 2:35 ` Baolin Wang
2018-11-08 18:06 ` Dan Murphy
2018-11-08 20:48 ` Jacek Anaszewski [this message]
2018-11-11 12:02 ` Pavel Machek
2018-11-11 20:02 ` Jacek Anaszewski
2018-11-11 20:16 ` Pavel Machek
2018-11-11 21:14 ` Jacek Anaszewski
2018-11-12 0:01 ` Vesa Jääskeläinen
2018-11-12 15:59 ` Jacek Anaszewski
2018-11-12 21:25 ` Linus Walleij
2018-11-12 22:11 ` LEDs on USB keyboards was " Pavel Machek
2018-11-12 10:35 ` Pavel Machek
2018-11-12 16:01 ` Jacek Anaszewski
2018-11-12 19:05 ` Pavel Machek
2018-11-12 20:11 ` Jacek Anaszewski
2018-11-12 22:06 ` Pavel Machek
2018-11-13 20:57 ` Jacek Anaszewski
2018-11-13 21:38 ` Geert Uytterhoeven
2018-11-13 21:50 ` Pavel Machek
2018-11-12 21:23 ` Linus Walleij
2018-11-13 19:55 ` Jacek Anaszewski
2018-11-15 9:10 ` Linus Walleij
2018-11-06 22:07 ` [PATCH 03/24] leds: dt-bindings: Add LED_FUNCTION definitions Jacek Anaszewski
2018-11-07 8:36 ` Vokáč Michal
2018-11-07 19:28 ` Jacek Anaszewski
2018-11-08 15:13 ` Rob Herring
2018-11-08 21:03 ` Jacek Anaszewski
2018-11-11 11:31 ` Pavel Machek
2018-11-11 20:02 ` Jacek Anaszewski
2018-11-11 20:20 ` Pavel Machek
2018-11-11 21:16 ` Jacek Anaszewski
2018-11-12 0:25 ` Vesa Jääskeläinen
2018-11-12 16:01 ` Jacek Anaszewski
2018-11-15 9:16 ` Linus Walleij
2018-11-06 22:07 ` [PATCH 04/24] dt-bindings: leds: Add function and color properties Jacek Anaszewski
2018-11-08 18:00 ` Dan Murphy
2018-11-08 20:47 ` Jacek Anaszewski
2018-11-08 21:08 ` Dan Murphy
2018-11-09 20:00 ` Jacek Anaszewski
2018-11-09 8:32 ` Vesa Jääskeläinen
2018-11-09 20:42 ` Jacek Anaszewski
2018-11-10 17:19 ` Vesa Jääskeläinen
2018-11-12 16:02 ` Jacek Anaszewski
2018-11-13 7:10 ` Vesa Jääskeläinen
2018-11-13 19:02 ` Jacek Anaszewski
[not found] ` <5bea0eb8.1c69fb81.6b921.80e6@mx.google.com>
2018-11-13 20:57 ` Jacek Anaszewski
2018-11-27 20:37 ` Jacek Anaszewski
2018-11-30 14:38 ` Rob Herring
2018-11-30 21:08 ` Pavel Machek
2018-11-30 22:19 ` Rob Herring
2018-12-01 21:17 ` Jacek Anaszewski
2018-12-11 17:27 ` Rob Herring
2018-12-11 22:44 ` Pavel Machek
2018-12-21 10:12 ` Linus Walleij
2018-12-12 9:59 ` Pavel Machek
2018-12-12 13:56 ` Rob Herring
2018-12-12 18:32 ` Pavel Machek
2018-12-23 20:11 ` Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 05/24] dt-bindings: sc27xx-blt: " Jacek Anaszewski
2018-11-11 14:29 ` Pavel Machek
2018-11-11 20:03 ` Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 06/24] leds: sc27xx-blt: Use led_compose_name() Jacek Anaszewski
2018-11-07 7:22 ` Baolin Wang
2018-11-11 14:31 ` Pavel Machek
2018-11-06 22:07 ` [PATCH 07/24] dt-bindings: lt3593: Add function and color properties Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 08/24] leds: lt3593: Use led_compose_name() Jacek Anaszewski
2018-11-07 19:37 ` Daniel Mack
2018-11-07 19:49 ` Jacek Anaszewski
2018-11-08 8:33 ` Daniel Mack
2018-11-06 22:07 ` [PATCH 09/24] dt-bindings: lp8860: Add function and color properties Jacek Anaszewski
2018-11-08 18:01 ` Dan Murphy
2018-11-06 22:07 ` [PATCH 10/24] leds: lp8860: Use led_compose_name() Jacek Anaszewski
2018-11-08 18:16 ` Dan Murphy
2018-11-08 20:48 ` Jacek Anaszewski
2018-11-12 14:05 ` Dan Murphy
2018-11-06 22:07 ` [PATCH 11/24] dt-bindings: lm3692x: Add function and color properties Jacek Anaszewski
2018-11-08 18:12 ` Dan Murphy
2018-11-06 22:07 ` [PATCH 12/24] leds: lm3692x: Use led_compose_name() Jacek Anaszewski
2018-11-08 18:14 ` Dan Murphy
2018-11-08 20:48 ` Jacek Anaszewski
2018-11-08 21:11 ` Dan Murphy
2018-11-11 14:31 ` Pavel Machek
2018-11-06 22:07 ` [PATCH 13/24] dt-bindings: lm36010: Add function and color properties Jacek Anaszewski
2018-11-08 18:15 ` Dan Murphy
2018-11-06 22:07 ` [PATCH 14/24] leds: lm3601x: Use led_compose_name() Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 15/24] dt-bindings: cr0014114: Add function and color properties Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 16/24] leds: cr0014114: Use led_compose_name() Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 17/24] dt-bindings: aat1290: Add function and color properties Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 18/24] leds: aat1290: Use led_compose_name() Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 19/24] dt-bindings: as3645a: Add function and color properties Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 20/24] leds: as3645a: Use led_compose_name() Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 21/24] dt-bindings: leds-gpio: Add function and color properties Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 22/24] leds: gpio: Use led_compose_name() Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 23/24] dt-bindings: an30259a: Add function and color properties Jacek Anaszewski
2018-11-06 22:07 ` [PATCH 24/24] leds: an30259a: Use led_compose_name() Jacek Anaszewski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5e857610-baee-9b4b-7a21-025be1f9670e@gmail.com \
--to=jacek.anaszewski@gmail.com \
--cc=baolin.wang@linaro.org \
--cc=daniel@zonque.org \
--cc=devicetree@vger.kernel.org \
--cc=dmurphy@ti.com \
--cc=linus.walleij@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-leds@vger.kernel.org \
--cc=oleg@kaa.org.ua \
--cc=pavel@ucw.cz \
--cc=robh@kernel.org \
--cc=sakari.ailus@linux.intel.com \
--cc=simon@lineageos.org \
--cc=xiaotong.lu@spreadtrum.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).