[PATCH] dt-bindings: iio: Document "label" property

[PATCH] dt-bindings: iio: Document "label" property

[Paul Cercueil]

All iio devices can have a label, which will be carried on to userspace
as a sysfs attribute. This is useful when having several iio devices
that represent different instances of the same hardware, as the name
attribute would then not be enough to differentiate between them.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
---
 Documentation/devicetree/bindings/iio/common.yaml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/devicetree/bindings/iio/common.yaml b/Documentation/devicetree/bindings/iio/common.yaml
index f845b41d74c4..a90ad7718ecf 100644
--- a/Documentation/devicetree/bindings/iio/common.yaml
+++ b/Documentation/devicetree/bindings/iio/common.yaml
@@ -32,6 +32,14 @@ properties:
       considered 'near' to the device (an object is near to the
       sensor).
 
+  label:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: |
+      All iio devices can have a label, which will be carried on to userspace
+      as a sysfs attribute. This is useful when having several iio devices that
+      represent different instances of the same hardware, as the name attribute
+      would then not be enough to differentiate between them.
+
 additionalProperties: true
 
 ...
-- 
2.34.1

Re: [PATCH] dt-bindings: iio: Document "label" property

[Lars-Peter Clausen]

On 12/21/21 11:43 AM, Paul Cercueil wrote:
> All iio devices can have a label, which will be carried on to userspace
> as a sysfs attribute. This is useful when having several iio devices
> that represent different instances of the same hardware, as the name
> attribute would then not be enough to differentiate between them.
>
> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> ---
>   Documentation/devicetree/bindings/iio/common.yaml | 8 ++++++++
>   1 file changed, 8 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/iio/common.yaml b/Documentation/devicetree/bindings/iio/common.yaml
> index f845b41d74c4..a90ad7718ecf 100644
> --- a/Documentation/devicetree/bindings/iio/common.yaml
> +++ b/Documentation/devicetree/bindings/iio/common.yaml
> @@ -32,6 +32,14 @@ properties:
>         considered 'near' to the device (an object is near to the
>         sensor).
>   
> +  label:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description: |
> +      All iio devices can have a label, which will be carried on to userspace
> +      as a sysfs attribute. This is useful when having several iio devices that
> +      represent different instances of the same hardware, as the name attribute
> +      would then not be enough to differentiate between them.
> +

The description has a lot of implementation details of the Linux kernel. 
The devicetree bindings should be formulated operating system agnostic.

Something like:

A descriptive label that allows to uniquely identify the device within 
the system.

Re: [PATCH] dt-bindings: iio: Document "label" property

[Paul Cercueil]

Le mar., déc. 21 2021 at 12:29:04 +0100, Lars-Peter Clausen 
<lars@metafoo.de> a écrit :
> On 12/21/21 11:43 AM, Paul Cercueil wrote:
>> All iio devices can have a label, which will be carried on to 
>> userspace
>> as a sysfs attribute. This is useful when having several iio devices
>> that represent different instances of the same hardware, as the name
>> attribute would then not be enough to differentiate between them.
>> 
>> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
>> ---
>>   Documentation/devicetree/bindings/iio/common.yaml | 8 ++++++++
>>   1 file changed, 8 insertions(+)
>> 
>> diff --git a/Documentation/devicetree/bindings/iio/common.yaml 
>> b/Documentation/devicetree/bindings/iio/common.yaml
>> index f845b41d74c4..a90ad7718ecf 100644
>> --- a/Documentation/devicetree/bindings/iio/common.yaml
>> +++ b/Documentation/devicetree/bindings/iio/common.yaml
>> @@ -32,6 +32,14 @@ properties:
>>         considered 'near' to the device (an object is near to the
>>         sensor).
>>   \x7f+  label:
>> +    $ref: /schemas/types.yaml#/definitions/string
>> +    description: |
>> +      All iio devices can have a label, which will be carried on to 
>> userspace
>> +      as a sysfs attribute. This is useful when having several iio 
>> devices that
>> +      represent different instances of the same hardware, as the 
>> name attribute
>> +      would then not be enough to differentiate between them.
>> +
> 
> The description has a lot of implementation details of the Linux 
> kernel. The devicetree bindings should be formulated operating system 
> agnostic.
> 
> Something like:
> 
> A descriptive label that allows to uniquely identify the device 
> within the system.

Alright. I'll V2 ASAP.

Cheers,
-Paul