led: add function naming option from linux
Subsystems (2)
PATCH 1/1 led: add function naming option from linux
in linux we have the option to create the name of a led optionally through the following properties:
- function
- color
- function-enumerator
This patch adds support for parsing this properties if there is no label property.
To be as close as possible to linux import the following files from it:
include/dt-bindings/leds/common.hinclude/linux/uapi/linux/uleds.h
base commit was:
commit: b8f52214c61a ("Merge tag 'audit-pr-20241205' of git://git.kernel.org/pub/scm/linux/kernel/git/pcmoore/audit")
The led name is created in led_post_bind() and we need some storage place for it. Currently this patch prevents to use malloc() instead it stores the name in new member :
char name[LED_MAX_NAME_SIZE];
of struct led_uc_plat. While at it append led tests for the new feature.
---
as we introduce a new element in struct led_uc_priv, may we should add this functionality through a new Kconfig option? (Which also would make this optional and save some bytes for boards who do not need this...)
Ignored a lot of checkpatch warnigs for file include/dt-bindings/leds/common.h
WARNING: Block comments use * on subsequent lines
+/* Obsolete equivalents: "tpacpi::thinklight" (IBM/Lenovo Thinkpads),
+ "lp5523:kb{1,2,3,4,5,6}" (Nokia N900) */
WARNING: Block comments use a trailing */ on a separate line
+ "lp5523:kb{1,2,3,4,5,6}" (Nokia N900) */
WARNING: Block comments use * on subsequent lines +/* System LEDs, usually found on system body.
+ platform::mute (etc) is sometimes seen, :mute would be better */
WARNING: Block comments use a trailing */ on a separate line
+ platform::mute (etc) is sometimes seen, :mute would be better */
WARNING: Block comments use * on subsequent lines
+/* Used RGB notification LEDs common on phones.
+ Obsolete equivalents: "status-led:{red,green,blue}" (Motorola Droid 4),
WARNING: Block comments use a trailing */ on a separate line
+ "lp5523:{r,g,b}" (Nokia N900) */
as it is copied from linux
commit: b8f52214c61a ("Merge tag 'audit-pr-20241205' of git://git.kernel.org/pub/scm/linux/kernel/git/pcmoore/audit")
Azure build:
https://dev.azure.com/hs0298/hs/_build/results?buildId=148&view=results
arch/sandbox/dts/test.dts | 37 +++++++- doc/device-tree-bindings/leds/common.txt | 28 ++++++ drivers/led/led-uclass.c | 72 +++++++++++++- include/dt-bindings/leds/common.h | 114 +++++++++++++++++++++++ include/led.h | 2 + include/linux/uapi/linux/uleds.h | 25 +++++ test/dm/led.c | 22 ++++- test/dm/ofnode.c | 2 +- 8 files changed, 295 insertions(+), 7 deletions(-) create mode 100644 include/dt-bindings/leds/common.h create mode 100644 include/linux/uapi/linux/uleds.h
arch/sandbox/dts/test.dts +36 -1
@@ -13,6 +13,7 @@ #include <dt-bindings/gpio/gpio.h> #include <dt-bindings/gpio/sandbox-gpio.h> #include <dt-bindings/input/input.h> +#include <dt-bindings/leds/common.h> #include <dt-bindings/pinctrl/sandbox-pinmux.h> #include <dt-bindings/mux/mux.h>
@@ -820,7 +821,7 @@ gpio-controller; #gpio-cells = <1>; gpio-bank-name = "a"; - sandbox,gpio-count = <20>; + sandbox,gpio-count = <25>; hog_input_active_low { gpio-hog; input;
@@ -1010,6 +1011,40 @@ /* label intentionally omitted */ default-state = "off"; }; + + led-20 { + gpios = <&gpio_a 20 0>; + /* label intentionally omitted */ + function = LED_FUNCTION_STATUS; + color = <LED_COLOR_ID_RED>; + function-enumerator = <20>; + }; + + led-21 { + gpios = <&gpio_a 21 0>; + /* label intentionally omitted */ + function = LED_FUNCTION_STATUS; + color = <LED_COLOR_ID_GREEN>; + }; + + led-22 { + gpios = <&gpio_a 22 0>; + /* label intentionally omitted */ + function = LED_FUNCTION_STATUS; + }; + + led-23 { + gpios = <&gpio_a 23 0>; + /* label intentionally omitted */ + color = <LED_COLOR_ID_GREEN>; + }; + + led-24 { + gpios = <&gpio_a 24 0>; + label = "sandbox:function"; + function = LED_FUNCTION_STATUS; + color = <LED_COLOR_ID_GREEN>; + }; }; wdt-gpio-toggle {
doc/device-tree-bindings/leds/common.txt +28 -0
@@ -4,6 +4,21 @@ Optional properties for child nodes: - label : The label for this LED. If omitted, the label is taken from the node name (excluding the unit address). +- function: + LED function. Use one of the LED_FUNCTION_* prefixed definitions + from the header include/dt-bindings/leds/common.h. If there is no + matching LED_FUNCTION available, add a new one. + +- color: + Color of the LED. Use one of the LED_COLOR_ID_* prefixed definitions from + the header include/dt-bindings/leds/common.h. If there is no matching + LED_COLOR_ID available, add a new one. + +- function-enumerator: + optional + Integer to be used when more than one instance of the same function is + needed, differing only with an ordinal number. + - linux,default-trigger : This parameter, if present, is a string defining the trigger assigned to the LED. Current triggers are: "backlight" - LED will act as a back-light, controlled by the framebuffer
@@ -21,3 +36,16 @@ system-status { linux,default-trigger = "heartbeat"; ... }; + +led-0 { + function = LED_FUNCTION_STATUS; + color = <LED_COLOR_ID_RED>; + function-enumerator = <20>; + ... +}; + +led-1 { + function = LED_FUNCTION_STATUS; + color = <LED_COLOR_ID_YELLOW>; + ... +};
drivers/led/led-uclass.c +68 -4
106 lines not on this page · raw message
include/dt-bindings/leds/common.h new file +114 -0
114 lines not on this page · raw message
include/led.h +2 -0
@@ -10,6 +10,7 @@#include <stdbool.h> #include <cyclic.h> #include <dm/ofnode.h> +#include <linux/uapi/linux/uleds.h> /** * DOC: Overview
@@ -86,6 +87,7 @@ struct led_sw_blink {struct led_uc_plat {const char *label;enum led_state_t default_state; +char name[LED_MAX_NAME_SIZE ];#ifdef CONFIG_LED_SW_BLINK struct led_sw_blink *sw_blink;#endif
include/linux/uapi/linux/uleds.h new file +25 -0
@@ -0,0 +1,25 @@ +/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */ +/* +* Userspace driver support for the LED subsystem +* +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation; either version 2 of the License, or +* (at your option) any later version. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +*/ +#ifndef _UAPI__ULEDS_H_ +#define _UAPI__ULEDS_H_ + +#define LED_MAX_NAME_SIZE 64 + +struct uleds_user_dev { +char name[LED_MAX_NAME_SIZE ]; +int max_brightness; +}; + +#endif /* _UAPI__ULEDS_H_ */
test/dm/led.c +21 -1
@@ -20,7 +20,12 @@ static int dm_test_led_base(struct unit_test_state *uts)ut_assertok (uclass_get_device (UCLASS_LED ,1 , &dev));ut_assertok (uclass_get_device (UCLASS_LED ,2 , &dev));ut_assertok (uclass_get_device (UCLASS_LED ,3 , &dev)); -ut_asserteq (-ENODEV ,uclass_get_device (UCLASS_LED ,4 , &dev)); +ut_assertok (uclass_get_device (UCLASS_LED ,4 , &dev)); +ut_assertok (uclass_get_device (UCLASS_LED ,5 , &dev)); +ut_assertok (uclass_get_device (UCLASS_LED ,6 , &dev)); +ut_assertok (uclass_get_device (UCLASS_LED ,7 , &dev)); +ut_assertok (uclass_get_device (UCLASS_LED ,8 , &dev)); +ut_asserteq (-ENODEV ,uclass_get_device (UCLASS_LED ,9 , &dev));return 0 ; }
@@ -110,6 +115,21 @@ static int dm_test_led_label(struct unit_test_state *uts)ut_asserteq (-ENODEV ,led_get_by_label ("sandbox:blue" , &dev)); +/* Test if function, color and function-enumerator naming works */ +ut_assertok (led_get_by_label ("red:status-20" , &dev)); + +/* Test if function, color naming works */ +ut_assertok (led_get_by_label ("green:status" , &dev)); + +/* Test if function, without color naming works */ +ut_assertok (led_get_by_label (":status" , &dev)); + +/* Test if color without function naming works */ +ut_assertok (led_get_by_label ("green:" , &dev)); + +/* Test if function, color naming is ignored if label is found */ +ut_assertok (led_get_by_label ("sandbox:function" , &dev)); +return 0 ; }DM_TEST (dm_test_led_label,UTF_SCAN_PDATA |UTF_SCAN_FDT );
test/dm/ofnode.c +1 -1
@@ -1580,7 +1580,7 @@ static int dm_test_ofnode_delete(struct unit_test_state *uts)ut_assert (!ofnode_valid (node));ut_assert (!ofnode_valid (ofnode_path ("/leds/default_on" ))); -ut_asserteq (2 ,ofnode_get_child_count (ofnode_path ("/leds" ))); +ut_asserteq (7 ,ofnode_get_child_count (ofnode_path ("/leds" )));return 0 ; }
Signature · 1 line
2.20.1
Quoted 7 lines · Heiko Schocher
in linux we have the option to create the name of a led optionally through the following properties:
- function
- color
- function-enumerator
Quoted 7 lines
This patch adds support for parsing this properties if there is no label property.
To be as close as possible to linux import the following files from it:
include/dt-bindings/leds/common.h
We get this, and the binding, for free from dts/upstream now. Please rebase / rework to make use of that. Thanks!
Signature · 1 line
Tom
Hi!
Quoted 72 lines · Heiko Schocher
in linux we have the option to create the name of a led optionally through the following properties:
- function
- color
- function-enumeratorThis patch adds support for parsing this properties if there is no label property.
To be as close as possible to linux import the following files from it:
include/dt-bindings/leds/common.hinclude/linux/uapi/linux/uleds.hbase commit was:
commit:b8f52214c61a("Merge tag 'audit-pr-20241205' ofgit://git.kernel.org/pub/scm/linux/kernel/git/pcmoore/audit")The led name is created in
led_post_bind()and we need some storage place for it. Currently this patch prevents to usemalloc()instead it stores the name in new member :char name[LED_MAX_NAME_SIZE];of struct
led_uc_plat. While at it append led tests for the new feature.Signed-off-by Heiko Schocher <[email protected]>---
as we introduce a new element in structled_uc_priv, may we should add this functionality through a newKconfigoption? (Which also would make this optional and save some bytes for boards who do not need this...)Ignored a lot of checkpatch warnigs for file
include/dt-bindings/leds/common.hWARNING: Block comments use * on subsequent lines
include/dt-bindings/leds/common.h new file +2
-0+/* Obsolete equivalents: "tpacpi::thinklight" (IBM/Lenovo Thinkpads), +"lp5523:kb{1,2,3,4,5,6}" (Nokia N900) */ WARNING: Block comments use a trailing */ on a separate line
+ "lp5523:kb{1,2,3,4,5,6}" (Nokia N900) */
WARNING: Block comments use * on subsequent linesinclude/dt-bindings/leds/common.h new file +2
-0+/* System LEDs, usually found on system body. +platform::mute (etc) is sometimes seen, :mute would be better */ WARNING: Block comments use a trailing */ on a separate line
+platform::mute(etc) is sometimes seen, :mute would be better */
WARNING: Block comments use * on subsequent linesinclude/dt-bindings/leds/common.h new file +2
-0+/* Used RGB notification LEDs common on phones. +Obsolete equivalents: "status-led:{red,green,blue}" (Motorola Droid 4), WARNING: Block comments use a trailing */ on a separate line
+ "lp5523:{r,g,b}" (Nokia N900) */as it is copied from linux
commit:
b8f52214c61a("Merge tag 'audit-pr-20241205' ofgit://git.kernel.org/pub/scm/linux/kernel/git/pcmoore/audit")Azure build:
https://dev.azure.com/hs0298/hs/_build/results?buildId=148&view=resultsarch/sandbox/dts/test.dts | 37 +++++++- doc/device-tree-bindings/leds/common.txt | 28 ++++++ drivers/led/led-uclass.c | 72 +++++++++++++- include/dt-bindings/leds/common.h | 114 +++++++++++++++++++++++ include/led.h | 2 + include/linux/uapi/linux/uleds.h | 25 +++++ test/dm/led.c | 22 ++++- test/dm/ofnode.c | 2 +- 8 files changed, 295 insertions(+), 7 deletions(-)create mode 100644
include/dt-bindings/leds/common.hcreate mode 100644include/linux/uapi/linux/uleds.h
[...]
Quoted 72 lines
drivers/led/led-uclass.c +56
-1@@ -13,6 +13,25 @@#include <dm/lists.h> #include <dm/root.h> #include <dm/uclass-internal.h> +#include <dt-bindings/leds/common.h> + +static const char *const led_colors[LED_COLOR_ID_MAX ] = { + [LED_COLOR_ID_WHITE ] ="white" , + [LED_COLOR_ID_RED ] ="red" , + [LED_COLOR_ID_GREEN ] ="green" , + [LED_COLOR_ID_BLUE ] ="blue" , + [LED_COLOR_ID_AMBER ] ="amber" , + [LED_COLOR_ID_VIOLET ] ="violet" , + [LED_COLOR_ID_YELLOW ] ="yellow" , + [LED_COLOR_ID_IR ] ="ir" , + [LED_COLOR_ID_MULTI ] ="multicolor" , + [LED_COLOR_ID_RGB ] ="rgb" , + [LED_COLOR_ID_PURPLE ] ="purple" , + [LED_COLOR_ID_ORANGE ] ="orange" , + [LED_COLOR_ID_PINK ] ="pink" , + [LED_COLOR_ID_CYAN ] ="cyan" , + [LED_COLOR_ID_LIME ] ="lime" , +};int led_bind_generic (struct udevice *parent,const char *driver_name) {@@ -232,11 +251,56 @@ int led_activity_blink(void)#endif #endif -static const char *led_get_label (ofnode node) +static const char *led_get_function_name (struct udevice *dev) +{ +struct led_uc_plat *uc_plat; +const char *func; +u32 color; +u32 enumerator; +int ret; +int cp; + +if (!dev) +return NULL ; + + uc_plat =dev_get_uclass_plat (dev); +if (!uc_plat) +return NULL ; + +if (uc_plat->label) +return uc_plat->label; + +/* Now try to detect function label name */ + func =dev_read_string (dev,"function" ); + cp =dev_read_u32 (dev,"color" , &color); +if (cp ==0 || func) { + ret =dev_read_u32 (dev,"function-enumerator" , &enumerator); +if (!ret) { +snprintf (uc_plat->name,LED_MAX_NAME_SIZE , +"%s:%s-%d" , + cp ?"" : led_colors[color], + func ? func :"" , enumerator); + }else { +snprintf (uc_plat->name,LED_MAX_NAME_SIZE , +"%s:%s" , + cp ?"" : led_colors[color], + func ? func :"" ); + } + uc_plat->label = uc_plat->name; + }
drivers/led/led-uclass.c int led_activity_blink(void) · line 300
Quoted 10 lines
drivers/led/led-uclass.c +7
-0+ +return uc_plat->label; +} + +static const char *led_get_label (struct udevice *dev,ofnode node) {const char *label; +const char *name; + name =ofnode_get_name (node);
name is not used, crap from debug... I remove it in v2, but wait for some comments before posting it.
[...]
bye,
Heiko
Signature · 3 lines
DENX Software Engineering GmbH, Managing Director: Erika Unter HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany Phone: +49-8142-66989-52 Fax: +49-8142-66989-80 Email: [email protected]