Skip to contentSkip to conversation

dt-bindings: leds: Mark label property as deprecated

PATCH In review Christoph Niedermaier 9 participants 30 messages Nov 22, 2022 – Dec 22, 2022

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

PATCH 1/1 dt-bindings: leds: Mark label property as deprecated

Mark the label property as deprecated as it is mentioned in the description.

---
Cc: Pavel Machek <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Jacek Anaszewski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/leds/common.yaml | 1 +
 1 file changed, 1 insertion(+)
Documentation/devicetree/bindings/leds/common.yaml +1 -0
index f5c57a580078..c1ce846f7676 100644
@@ -52,6 +52,7 @@ properties:
     $ref: /schemas/types.yaml#/definitions/uint32
 
   label:
+    deprecated: true
     description:
       The label for this LED. If omitted, the label is taken from the node name
       (excluding the unit address). It has to uniquely identify a device, i.e.
Signature · 1 line
2.11.0
#1 lore raw

PATCH 1/1 dt-bindings: mfd: da9062: Correct file name for watchdog

Replace the watchdog file name with the name currently in use.

---
Cc: Support Opensource <[email protected]>
Cc: Lee Jones <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mfd/da9062.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/da9062.txt +1 -1
index bab0d0e66cb3..e96629eb9f48 100644
@@ -85,7 +85,7 @@ Sub-nodes:
 
 - onkey : See ../input/da9062-onkey.txt
 
-- watchdog: See ../watchdog/da9062-watchdog.txt
+- watchdog: See ../watchdog/da9062-wdt.txt
 
 - thermal : See ../thermal/da9062-thermal.txt
 
Signature · 1 line
2.11.0
#2 lore raw

Re: [PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

Quoted 21 lines · Christoph Niedermaier

Replace the watchdog file name with the name currently in use.

---
Cc: Support Opensource <[email protected]>
Cc: Lee Jones <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mfd/da9062.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/da9062.txt +0 -0
index bab0d0e66cb3..e96629eb9f48 100644

Documentation/devicetree/bindings/mfd/da9062.txt Sub-nodes: · line 88

Quoted 5 lines
Documentation/devicetree/bindings/mfd/da9062.txt +1 -1
@@ -85,7 +85,7 @@ Sub-nodes:
 
 - onkey : See ../input/da9062-onkey.txt
 
-- watchdog: See ../watchdog/da9062-watchdog.txt
+- watchdog: See ../watchdog/da9062-wdt.txt

How is this related to LED patch? Don't mix threads.

Best regards,
Krzysztof

maintainer
#3 lore raw

Re: [PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

Quoted 23 lines · Krzysztof Kozlowski
Quoted 22 lines · Christoph Niedermaier

Replace the watchdog file name with the name currently in use.

---
Cc: Support Opensource <[email protected]>
Cc: Lee Jones <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mfd/da9062.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/da9062.txt +0 -0
index bab0d0e66cb3..e96629eb9f48 100644
@@ -85,7 +85,7 @@ Sub-nodes:
 
Quoted 6 lines

Documentation/devicetree/bindings/mfd/da9062.txt Sub-nodes: · line 88

Quoted 4 lines
Documentation/devicetree/bindings/mfd/da9062.txt +1 -1
 - onkey : See ../input/da9062-onkey.txt
 
-- watchdog: See ../watchdog/da9062-watchdog.txt
+- watchdog: See ../watchdog/da9062-wdt.txt

How is this related to LED patch? Don't mix threads.

Que?

[PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

Signature · 1 line
Lee Jones [李琼斯]
#4 lore raw

Re: [PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

Quoted 27 lines · Lee Jones
Quoted 25 lines · Krzysztof Kozlowski
Quoted 24 lines · Christoph Niedermaier

Replace the watchdog file name with the name currently in use.

---
Cc: Support Opensource <[email protected]>
Cc: Lee Jones <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mfd/da9062.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/da9062.txt +0 -0
index bab0d0e66cb3..e96629eb9f48 100644
@@ -85,7 +85,7 @@ Sub-nodes:
 
 - onkey : See ../input/da9062-onkey.txt
 
Quoted 8 lines
Quoted 4 lines

Documentation/devicetree/bindings/mfd/da9062.txt Sub-nodes: · line 88

Quoted 2 lines
Documentation/devicetree/bindings/mfd/da9062.txt +1 -1
-- watchdog: See ../watchdog/da9062-watchdog.txt
+- watchdog: See ../watchdog/da9062-wdt.txt

How is this related to LED patch? Don't mix threads.

Que?

[PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

It's a response to a LED patch (single, not thread).

Best regards,
Krzysztof

maintainer
#5 lore raw

Re: [PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

Quoted 33 lines · Krzysztof Kozlowski
Quoted 32 lines · Lee Jones
Quoted 29 lines · Krzysztof Kozlowski
Quoted 21 lines · Christoph Niedermaier

Replace the watchdog file name with the name currently in use.

---
Cc: Support Opensource <[email protected]>
Cc: Lee Jones <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mfd/da9062.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/da9062.txt +0 -0
index bab0d0e66cb3..e96629eb9f48 100644

Documentation/devicetree/bindings/mfd/da9062.txt Sub-nodes: · line 88

Quoted 5 lines
Documentation/devicetree/bindings/mfd/da9062.txt +1 -1
@@ -85,7 +85,7 @@ Sub-nodes:
 
 - onkey : See ../input/da9062-onkey.txt
 
-- watchdog: See ../watchdog/da9062-watchdog.txt
+- watchdog: See ../watchdog/da9062-wdt.txt

How is this related to LED patch? Don't mix threads.

Quoted 5 lines
Quoted 3 lines

Que?

[PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

It's a response to a LED patch (single, not thread).

Didn't show up like that of me.

I guess I wasn't included on the LED patch.

Signature · 1 line
Lee Jones [李琼斯]
#6 lore raw

RE: [PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

In reply to Lee Jones

From: Lee Jones [mailto:[email protected]]
Sent: Wednesday, November 30, 2022 11:10 AM

Quoted 32 lines · Krzysztof Kozlowski
Quoted 24 lines · Christoph Niedermaier
Quoted 22 lines

Replace the watchdog file name with the name currently in use.

---
Cc: Support Opensource <[email protected]>
Cc: Lee Jones <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mfd/da9062.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/da9062.txt +0 -0
index bab0d0e66cb3..e96629eb9f48 100644
@@ -85,7 +85,7 @@ Sub-nodes:
 
Quoted 6 lines

Documentation/devicetree/bindings/mfd/da9062.txt Sub-nodes: · line 88

Quoted 4 lines
Documentation/devicetree/bindings/mfd/da9062.txt +1 -1
 - onkey : See ../input/da9062-onkey.txt
 
-- watchdog: See ../watchdog/da9062-watchdog.txt
+- watchdog: See ../watchdog/da9062-wdt.txt

How is this related to LED patch? Don't mix threads.

Quoted 6 lines

Que?

[PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

--
Lee Jones [李琼斯]

I am sorry. I used git send-email the wrong way. Thanks for pointing this out. Don't answer to this E-Mail. I will send a new patch.

Regards
Christoph

#7 lore raw

RE: [PATCH] dt-bindings: mfd: da9062: Correct file name for watchdog

In reply to Krzysztof Kozlowski

From: Krzysztof Kozlowski [mailto:[email protected]]
Sent: Tuesday, November 29, 2022 1:34 PM

Quoted 23 lines · Christoph Niedermaier
Quoted 22 lines

Replace the watchdog file name with the name currently in use.

---
Cc: Support Opensource <[email protected]>
Cc: Lee Jones <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mfd/da9062.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/da9062.txt +0 -0
index bab0d0e66cb3..e96629eb9f48 100644
@@ -85,7 +85,7 @@ Sub-nodes:
 
Quoted 6 lines

Documentation/devicetree/bindings/mfd/da9062.txt Sub-nodes: · line 88

Quoted 4 lines
Documentation/devicetree/bindings/mfd/da9062.txt +1 -1
 - onkey : See ../input/da9062-onkey.txt
 
-- watchdog: See ../watchdog/da9062-watchdog.txt
+- watchdog: See ../watchdog/da9062-wdt.txt

How is this related to LED patch? Don't mix threads.

I am sorry. I used git send-email the wrong way. Thanks for pointing this out. Don't answer to this E-Mail. I will send a new patch.

Regards
Christoph

#8 lore raw

PATCH 1/1 dt-bindings: mmc: Make comment on wakeup-source less confusing

In reply to Christoph Niedermaier

The current comment on wakeup-source is a bit confusing, because it isn't clear at first sight which property is actually deprecated. Change the comment to one that is less confusing.

---
Cc: Ulf Hansson <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +1 -1
index 802e3ca8be4d..a921442c6c1d 100644
@@ -293,7 +293,7 @@ properties:
     description:
       SDIO only. Preserves card power during a suspend/resume cycle.
 
-  # Deprecated: enable-sdio-wakeup
+  # Use wakeup-source instead of the deprecated enable-sdio-wakeup
   wakeup-source:
     $ref: /schemas/types.yaml#/definitions/flag
     description:
Signature · 1 line
2.11.0
#9 lore raw

Re: [PATCH] dt-bindings: mmc: Make comment on wakeup-source less confusing

Quoted 24 lines · Christoph Niedermaier

The current comment on wakeup-source is a bit confusing, because it isn't clear at first sight which property is actually deprecated. Change the comment to one that is less confusing.

---
Cc: Ulf Hansson <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +0 -0
index 802e3ca8be4d..a921442c6c1d 100644

Documentation/devicetree/bindings/mmc/mmc-controller.yaml properties: · line 299

Quoted 8 lines
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +1 -1
@@ -293,7 +293,7 @@ properties:
     description:
       SDIO only. Preserves card power during a suspend/resume cycle.
 
-  # Deprecated: enable-sdio-wakeup
+  # Use wakeup-source instead of the deprecated enable-sdio-wakeup
   wakeup-source:
     $ref: /schemas/types.yaml#/definitions/flag
     description:

Rob, Krzysztof - do we have a preferred pattern for how to express deprecated bindings - or is the above okay to you?

Kind regards
Uffe

#10 lore raw

Re: [PATCH] dt-bindings: mmc: Make comment on wakeup-source less confusing

Quoted 29 lines · Ulf Hansson
Quoted 27 lines · Christoph Niedermaier

The current comment on wakeup-source is a bit confusing, because it isn't clear at first sight which property is actually deprecated. Change the comment to one that is less confusing.

---
Cc: Ulf Hansson <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +0 -0
index 802e3ca8be4d..a921442c6c1d 100644
@@ -293,7 +293,7 @@ properties:
     description:
       SDIO only. Preserves card power during a suspend/resume cycle.
 
Quoted 8 lines

Documentation/devicetree/bindings/mmc/mmc-controller.yaml properties: · line 299

Quoted 5 lines
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +1 -1
-  # Deprecated: enable-sdio-wakeup
+  # Use wakeup-source instead of the deprecated enable-sdio-wakeup
   wakeup-source:
     $ref: /schemas/types.yaml#/definitions/flag
     description:

Rob, Krzysztof - do we have a preferred pattern for how to express deprecated bindings - or is the above okay to you?

Yes, we have:
deprecated: true

I don't get why this is in response to LED patch? I entirely ignored this thread because of it.

Best regards,
Krzysztof

#11 lore raw

Re: [PATCH] dt-bindings: mmc: Make comment on wakeup-source less confusing

In reply to Christoph Niedermaier
Quoted 3 lines · Christoph Niedermaier

The current comment on wakeup-source is a bit confusing, because it isn't clear at first sight which property is actually deprecated. Change the comment to one that is less confusing.

It's still confusing - you mention some non-existing property. I don't think it's worth to touch it. If you insist, drop entire comment...

Quoted 20 lines

---
Cc: Ulf Hansson <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +0 -0
index 802e3ca8be4d..a921442c6c1d 100644

Documentation/devicetree/bindings/mmc/mmc-controller.yaml properties: · line 299

Quoted 8 lines
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +1 -1
@@ -293,7 +293,7 @@ properties:
     description:
       SDIO only. Preserves card power during a suspend/resume cycle.
 
-  # Deprecated: enable-sdio-wakeup
+  # Use wakeup-source instead of the deprecated enable-sdio-wakeup
   wakeup-source:
     $ref: /schemas/types.yaml#/definitions/flag
     description:

Best regards,
Krzysztof

#12 lore raw

Re: [PATCH] dt-bindings: mmc: Make comment on wakeup-source less confusing

Quoted 8 lines · Krzysztof Kozlowski
Quoted 3 lines · Christoph Niedermaier

The current comment on wakeup-source is a bit confusing, because it isn't clear at first sight which property is actually deprecated. Change the comment to one that is less confusing.

It's still confusing - you mention some non-existing property. I don't think it's worth to touch it. If you insist, drop entire comment...

Hmm, it doesn't look that easy to me. The "enable-sdio-wakeup" is indeed a deprecated wakeup property [1], but it seems like it's not really described somewhere. I wouldn't mind removing it (as it seems to add some confusions), but in that case it needs to be entirely removed from the DT docs, right?

Another option, would be to add a proper description of the property and mark it with "deprecated: true".

Quoted 24 lines
Quoted 24 lines

---
Cc: Ulf Hansson <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
To: [email protected]

---
 Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +0 -0
index 802e3ca8be4d..a921442c6c1d 100644
@@ -293,7 +293,7 @@ properties:
     description:
       SDIO only. Preserves card power during a suspend/resume cycle.
 
Quoted 5 lines

Documentation/devicetree/bindings/mmc/mmc-controller.yaml properties: · line 299

Quoted 5 lines
Documentation/devicetree/bindings/mmc/mmc-controller.yaml +1 -1
-  # Deprecated: enable-sdio-wakeup
+  # Use wakeup-source instead of the deprecated enable-sdio-wakeup
   wakeup-source:
     $ref: /schemas/types.yaml#/definitions/flag
     description:

Kind regards
Uffe

[1] Documentation/devicetree/bindings/power/wakeup-source.txt

#13 lore raw

Re: [PATCH] dt-bindings: mmc: Make comment on wakeup-source less confusing

Quoted 11 lines · Ulf Hansson
Quoted 8 lines · Krzysztof Kozlowski
Quoted 3 lines · Christoph Niedermaier

The current comment on wakeup-source is a bit confusing, because it isn't clear at first sight which property is actually deprecated. Change the comment to one that is less confusing.

It's still confusing - you mention some non-existing property. I don't think it's worth to touch it. If you insist, drop entire comment...

Quoted 8 lines

Hmm, it doesn't look that easy to me. The "enable-sdio-wakeup" is indeed a deprecated wakeup property [1], but it seems like it's not really described somewhere. I wouldn't mind removing it (as it seems to add some confusions), but in that case it needs to be entirely removed from the DT docs, right?

Another option, would be to add a proper description of the property and mark it with "deprecated: true".

There are no in-tree DTs which use the property, so maybe we should just drop it altogether from the bindings ?

next-20221128$ git grep enable-sdio-wakeup
Documentation/devicetree/bindings/mmc/mmc-controller.yaml: # Deprecated: enable-sdio-wakeup Documentation/devicetree/bindings/power/wakeup-source.txt:1. "enable-sdio-wakeup" Documentation/devicetree/bindings/mmc/mmc.txt

drivers/mmc/core/host.c:            device_property_read_bool(dev, "enable-sdio-wakeup")) /* legacy */
drivers/mmc/host/sdhci-pltfm.c:     device_property_read_bool(dev, "enable-sdio-wakeup")) /* legacy */
#14 lore raw

Re: [PATCH] dt-bindings: mmc: Make comment on wakeup-source less confusing

In reply to Ulf Hansson
Quoted 8 lines · Ulf Hansson
Quoted 6 lines · Krzysztof Kozlowski
Quoted 3 lines · Christoph Niedermaier

The current comment on wakeup-source is a bit confusing, because it isn't clear at first sight which property is actually deprecated. Change the comment to one that is less confusing.

Quoted 8 lines
Quoted 2 lines

It's still confusing - you mention some non-existing property. I don't think it's worth to touch it. If you insist, drop entire comment...

Hmm, it doesn't look that easy to me. The "enable-sdio-wakeup" is indeed a deprecated wakeup property [1], but it seems like it's not really described somewhere. I wouldn't mind removing it (as it seems to add some confusions), but in that case it needs to be entirely removed from the DT docs, right?

Yes, from the bindings and from DTSes. It's already gone from mmc-controller.yaml bindings, so basically we already did the most of such removal.

Quoted 3 lines

Another option, would be to add a proper description of the property and mark it with "deprecated: true".

Best regards,
Krzysztof

#15 lore raw
In reply to Christoph Niedermaier

Hi!

Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Best regards,
Pavel

Quoted 9 lines

+++ b/Documentation/devicetree/bindings/leds/common.yaml

Documentation/devicetree/bindings/leds/common.yaml +1 -0
@@ -52,6 +52,7 @@ properties:
     $ref: /schemas/types.yaml#/definitions/uint32
 
   label:
+    deprecated: true
     description:
       The label for this LED. If omitted, the label is taken from the node name
       (excluding the unit address). It has to uniquely identify a device, i.e.
Signature · 1 line
People of Russia, stop Putin before his war on Ukraine escalates.
#16 lore raw
Quoted 1 line · Pavel Machek

Hi!

Hi,

Quoted 5 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

#17 lore raw

From: Marek Vasut [mailto:[email protected]]
Sent: Friday, November 25, 2022 10:27 PM

Quoted 5 lines · Pavel Machek
Quoted 1 line

Hi!

Hi,

Hi,

Quoted 11 lines
Quoted 5 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

I'm a little confused because the direction seems to have changed here. Do you want label and functions (etc.) to be able to be used equally side by side, or should one of them be preferred?

I also do DTs and it would be good to know what to go for. Could you please provide further explanation?

Regards
Christoph

maintainer
#18 lore raw
In reply to Marek Vasut
Quoted 8 lines · Marek Vasut
Quoted 1 line · Pavel Machek

Hi!

Hi,

Quoted 3 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Quoted 8 lines
Quoted 2 lines

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

They serve 2 different purposes.

Rob

#19 lore raw
Quoted 18 lines · Rob Herring
Quoted 8 lines · Marek Vasut
Quoted 1 line · Pavel Machek

Hi!

Hi,

Quoted 3 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Quoted 8 lines
Quoted 2 lines

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

Quoted 6 lines

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

Unfortunately, no.

We use label as a path in /sys/class/leds. And it looks like integer "function" is not really adequate for describing what LED does. There are too many LEDs and not enough integers, and it is common to have same function ("activity") on multiple devices ("wifi", "mmc", "eth").

Best regards,
Pavel

Signature · 1 line
People of Russia, stop Putin before his war on Ukraine escalates.
maintainer
#20 lore raw
Quoted 20 lines · Pavel Machek
Quoted 18 lines · Rob Herring
Quoted 16 lines · Marek Vasut
Quoted 1 line · Pavel Machek

Hi!

Hi,

Quoted 5 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

Quoted 8 lines
Quoted 6 lines

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

Unfortunately, no.

That's why I said 'shouldn't care', not 'doesn't care'.

'label' is also not just an LED property. It's used elsewhere, but unfortunately the LED subsystem makes more use of it than it perhaps should.

Quoted 1 line

We use label as a path in /sys/class/leds.

Yes, or node name if no label. That's still not really caring what the value of label is. At least the kernel doesn't. A well behaved userspace wouldn't either and doesn't for most classes.

Quoted 4 lines

And it looks like integer
"function" is not really adequate for describing what LED does. There are too many LEDs and not enough integers, and it is common to have same function ("activity") on multiple devices ("wifi", "mmc", "eth").

Whatever the problems are, 'label' is not the solution.

There is a way to associate leds with devices. 'trigger-source' IIRC.

Rob

#21 lore raw

Hi!

Quoted 18 lines
Quoted 11 lines
Quoted 9 lines
Quoted 2 lines

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

Unfortunately, no.

That's why I said 'shouldn't care', not 'doesn't care'.

'label' is also not just an LED property. It's used elsewhere, but unfortunately the LED subsystem makes more use of it than it perhaps should.

Quoted 5 lines
Quoted 1 line

We use label as a path in /sys/class/leds.

Yes, or node name if no label. That's still not really caring what the value of label is. At least the kernel doesn't. A well behaved userspace wouldn't either and doesn't for most classes.

A well behaved userspace needs that to tell what kind of LED it is. It is important to tell keyboard backlight from HDD activity LED and from fllash on back camera for example.

Quoted 9 lines
Quoted 4 lines

And it looks like integer
"function" is not really adequate for describing what LED does. There are too many LEDs and not enough integers, and it is common to have same function ("activity") on multiple devices ("wifi", "mmc", "eth").

Whatever the problems are, 'label' is not the solution.

There is a way to associate leds with devices. 'trigger-source' IIRC.

Neither is trigger-source a solution.

Can we have linux,sysfs-path or something?

Pavel

Signature · 1 line
People of Russia, stop Putin before his war on Ukraine escalates.
#22 lore raw
In reply to Pavel Machek
Quoted 26 lines · Pavel Machek
Quoted 18 lines · Rob Herring
Quoted 8 lines · Marek Vasut
Quoted 1 line · Pavel Machek

Hi!

Hi,

Quoted 3 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Quoted 8 lines
Quoted 2 lines

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

Quoted 6 lines

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

Quoted 6 lines

Unfortunately, no.

We use label as a path in /sys/class/leds. And it looks like integer "function" is not really adequate for describing what LED does. There are too many LEDs and not enough integers, and it is common to have same function ("activity") on multiple devices ("wifi", "mmc", "eth").

The Documentation/devicetree/bindings/leds/common.yaml schema indicates that function is a string, not an integer:

"
32 function:
33 description:

 34       LED function. Use one of the LED_FUNCTION_* prefixed definitions
 35       from the header include/dt-bindings/leds/common.h. If there is no
 36       matching LED_FUNCTION available, add a new one.

37 $ref: /schemas/types.yaml#/definitions/string
"

#23 lore raw
In reply to Rob Herring
Quoted 15 lines · Rob Herring
Quoted 14 lines · Marek Vasut
Quoted 1 line · Pavel Machek

Hi!

Hi,

Quoted 5 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

Quoted 6 lines
Quoted 2 lines

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

Isn't this 'function' more of a standardized replacement for 'label' ?

$ git grep LED_FUNCTION_ include/
...
include/dt-bindings/leds/common.h:#define LED_FUNCTION_PLAYER5 "player-5"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_ACTIVITY "activity"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_ALARM "alarm"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BACKLIGHT "backlight"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BLUETOOTH "bluetooth"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BOOT "boot"
...

Seems to me that ^ is closer to a "standardized" form of 'label' .

The LED subsystem does not infer any behavior of those LEDs based on their 'function' property as far as I can tell, at least not in the way 'linux,default-trigger' behaves.

Quoted 2 lines

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

This part I understand. What is not clear to me is, why is 'label' being un-deprecated.

We newly have 'function', 'function-enumerator' and 'color' DT properties for LEDs, which seem to be standardized forms of describing what the LED is used for, which LED it is (if there are multiple), and color of that LED. This was previously described in the 'label' property, usually in free form of e.g. "beaglebone:green:usr2" .

Quoted 1 line

They serve 2 different purposes.

[...]

#24 lore raw

Hi all,

Quoted 16 lines · Marek Vasut
Quoted 15 lines · Rob Herring
Quoted 14 lines · Marek Vasut
Quoted 1 line · Pavel Machek

Hi!

Hi,

Quoted 5 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the correct one for new DTs ?

Quoted 8 lines
Quoted 6 lines
Quoted 2 lines

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

Isn't this 'function' more of a standardized replacement for 'label' ?

Yes it is. Introduction of function and color properties aimed at standardizing LED naming. Before there was only 'label' used for that, with DT node name as fallback if 'label' property was not provided.
With introduction of 'function' and 'color' label was deprecated in
the sense that if the former two are present, they are used for
composing the LED name.

In LED documentation [0] people are encouraged to use definitions from include/dt-bindings/leds/common.h to keep LED naming uniform. It allows to avoid duplicates like "wlan" and "wifi".

Quoted 10 lines
$ git grep LED_FUNCTION_ include/
...
include/dt-bindings/leds/common.h:#define LED_FUNCTION_PLAYER5 "player-5"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_ACTIVITY "activity"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_ALARM "alarm"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BACKLIGHT "backlight"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BLUETOOTH "bluetooth"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BOOT "boot"
...
Quoted 8 lines

Seems to me that ^ is closer to a "standardized" form of 'label' .

The LED subsystem does not infer any behavior of those LEDs based on their 'function' property as far as I can tell, at least not in the way 'linux,default-trigger' behaves.

Quoted 2 lines

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

This part I understand. What is not clear to me is, why is 'label' being un-deprecated.

It shouldn't be. It seems to be Pavel's ad-hoc decision.

Quoted 5 lines

We newly have 'function', 'function-enumerator' and 'color' DT properties for LEDs, which seem to be standardized forms of describing what the LED is used for, which LED it is (if there are multiple), and color of that LED. This was previously described in the 'label' property, usually in free form of e.g. "beaglebone:green:usr2" .

Quoted 1 line

They serve 2 different purposes.

[...]

[0] Documentation/leds/leds-class.rst

Signature · 2 lines
Best regards,
Jacek Anaszewski
#25 lore raw

From: Jacek Anaszewski [mailto:[email protected]]
Sent: Monday, December 5, 2022 7:44 PM

Quoted 3 lines

Hi all,

Hi all,

Quoted 56 lines · Marek Vasut
Quoted 17 lines · Rob Herring
Quoted 16 lines · Marek Vasut
Quoted 15 lines · Pavel Machek
Quoted 1 line

Hi!

Hi,

Quoted 5 lines
Quoted 2 lines

Mark the label property as deprecated as it is mentioned in the description.

Lets do it the other way around. Functions (etc) don't really provide good enough description of LED, and label is still needed.

Can you please provide a clear explanation which property or approach is the
correct one for new DTs ?

Quoted 8 lines
Quoted 6 lines
Quoted 2 lines

So far, the documentation states that "label" is deprecated, and users should replace it with "function" and "color".

'function' is what activity/operation the LED is associated with. It is a fixed set of strings which s/w may use. It is a replacement for 'linux,default-trigger'.

Isn't this 'function' more of a standardized replacement for 'label' ?

Yes it is. Introduction of function and color properties aimed at standardizing LED naming. Before there was only 'label' used for that, with DT node name as fallback if 'label' property was not provided. With introduction of 'function' and 'color' label was deprecated in the sense that if the former two are present, they are used for composing the LED name.

In LED documentation [0] people are encouraged to use definitions from include/dt-bindings/leds/common.h to keep LED naming uniform. It allows to avoid duplicates like "wlan" and "wifi".

Quoted 18 lines
$ git grep LED_FUNCTION_ include/
...
include/dt-bindings/leds/common.h:#define LED_FUNCTION_PLAYER5 "player-5"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_ACTIVITY "activity"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_ALARM "alarm"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BACKLIGHT
"backlight"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BLUETOOTH
"bluetooth"
include/dt-bindings/leds/common.h:#define LED_FUNCTION_BOOT "boot"
...

Seems to me that ^ is closer to a "standardized" form of 'label' .

The LED subsystem does not infer any behavior of those LEDs based on their 'function' property as far as I can tell, at least not in the way 'linux,default-trigger' behaves.

Quoted 7 lines
Quoted 5 lines
Quoted 2 lines

'label' is what is printed next to the LED for a human to read. 'label' can be anything and the OS shouldn't care what it is.

This part I understand. What is not clear to me is, why is 'label' being un-deprecated.

It shouldn't be. It seems to be Pavel's ad-hoc decision.

Is there a majority agreement that the "label" property remains deprecated? If so, I would say we can mark the label as deprecated.

On the other hand, the new generated standardized sysfs name does not seem to provide a full replacement for the "label" property.
What is still missing?
How can the current state be extended to find more acceptance?

[...]

Regards
Christoph

#26 lore raw

Hi!

Quoted 9 lines
Quoted 4 lines
Quoted 2 lines

This part I understand. What is not clear to me is, why is 'label' being un-deprecated.

It shouldn't be. It seems to be Pavel's ad-hoc decision.

Is there a majority agreement that the "label" property remains deprecated?

Quoted 5 lines

If so, I would say we can mark the label as deprecated.

On the other hand, the new generated standardized sysfs name does not seem to provide a full replacement for the "label" property.
What is still missing?

Having reasonable naming of the LEDs is pre-requisite for deprecating label property.

And no, kernel community does not operate by "majority agreement"s.

Best regards,
Pavel

Signature · 1 line
People of Russia, stop Putin before his war on Ukraine escalates.
#27 lore raw
Quoted 11 lines · Pavel Machek

Hi!

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

This part I understand. What is not clear to me is, why is 'label' being un-deprecated.

It shouldn't be. It seems to be Pavel's ad-hoc decision.

Is there a majority agreement that the "label" property remains deprecated?

Quoted 8 lines
Quoted 5 lines

If so, I would say we can mark the label as deprecated.

On the other hand, the new generated standardized sysfs name does not seem to provide a full replacement for the "label" property.
What is still missing?

Having reasonable naming of the LEDs is pre-requisite for deprecating label property.

As far as I can tell, function and function-enumerator is the reasonable naming. Jacek seem to confirm that. I would say, label can be deprecated . What is the counter-argument for why it should NOT be deprecated ?

#28 lore raw
Quoted 18 lines · Marek Vasut
Quoted 17 lines · Pavel Machek

Hi!

Quoted 14 lines
Quoted 4 lines
Quoted 2 lines

This part I understand. What is not clear to me is, why is 'label' being un-deprecated.

It shouldn't be. It seems to be Pavel's ad-hoc decision.

Is there a majority agreement that the "label" property remains deprecated?

If so, I would say we can mark the label as deprecated.

On the other hand, the new generated standardized sysfs name does not seem to provide a full replacement for the "label" property.
What is still missing?

Quoted 6 lines
Quoted 2 lines

Having reasonable naming of the LEDs is pre-requisite for deprecating label property.

As far as I can tell, function and function-enumerator is the reasonable naming. Jacek seem to confirm that. I would say, label can be deprecated . What is the counter-argument for why it should NOT be deprecated ?

When the label is no longer neccessary for naming leds, it can be deprecated. AFAICT, that is currently not the case.

Best regards,
Pavel

Signature · 1 line
People of Russia, stop Putin before his war on Ukraine escalates.
#29 lore raw
Quoted 22 lines · Pavel Machek
Quoted 21 lines · Marek Vasut
Quoted 19 lines · Pavel Machek

Hi!

Quoted 9 lines
Quoted 4 lines
Quoted 2 lines

This part I understand. What is not clear to me is, why is 'label' being un-deprecated.

It shouldn't be. It seems to be Pavel's ad-hoc decision.

Is there a majority agreement that the "label" property remains deprecated?

Quoted 5 lines

If so, I would say we can mark the label as deprecated.

On the other hand, the new generated standardized sysfs name does not seem to provide a full replacement for the "label" property.
What is still missing?

Having reasonable naming of the LEDs is pre-requisite for deprecating label property.

Quoted 6 lines
Quoted 3 lines

As far as I can tell, function and function-enumerator is the reasonable naming. Jacek seem to confirm that. I would say, label can be deprecated . What is the counter-argument for why it should NOT be deprecated ?

When the label is no longer neccessary for naming leds, it can be deprecated. AFAICT, that is currently not the case.

I'm sorry, this is not a counter-argument, this is hand-waving .

Do you have anything to back your claim that the label is currently still needed, contrary to what the DT bindings document claims for years? "This property is deprecated - use 'function' and 'color' properties instead. function-enumerator has no effect when this property is present."

"
commit c5d18dd6b64e09dd6984bda9bdd55160af537a8c
Date: Sun Jun 9 20:19:04 2019 +0200

dt-bindings: leds: Add properties for LED name construction

Introduce dedicated properties for conveying information about LED function and color. Mark old "label" property as deprecated.

Additionally function-enumerator property is being provided for the cases when neither function nor color can be used for LED differentiation.
"

It seems the function and function-enumerator is very much the replacement for label, except standardized. If that's not the case, do elaborate. If there is a special case that is not covered by it, do point it out.