diff mbox series

[v7,5/5] dt-bindings:iio:adc:adc.txt: Add documentation for channel label attribute

Message ID 20200928090959.88842-5-cristian.pop@analog.com (mailing list archive)
State New, archived
Headers show
Series [v7,1/5] iio: core: Add optional symbolic label to a device channel | expand

Commit Message

Cristian Pop Sept. 28, 2020, 9:09 a.m. UTC
Optional attribute for better identification of the channels.

Signed-off-by: Cristian Pop <cristian.pop@analog.com>
---
Changes in v7:
 - Add this extra commit
 Documentation/devicetree/bindings/iio/adc/adc.txt | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Jonathan Cameron Sept. 29, 2020, 3:48 p.m. UTC | #1
On Mon, 28 Sep 2020 12:09:59 +0300
Cristian Pop <cristian.pop@analog.com> wrote:

> Optional attribute for better identification of the channels.
> 
> Signed-off-by: Cristian Pop <cristian.pop@analog.com>

This one is on my list of binding files to convert fairly soon
so I'm fine with this going in whilst it's still in txt form.

The addition of reg here shows up a quirk of this binding.  We
originally introduced it to specify differential pairs, hence
the @ can refer to the first value of diff-channels instead
of reg.  Hopefully I'll remember to clarify that when doing the
yaml conversion.

The series looks good to me, but given timing it won't make the
merge window for the coming cycle.
+CC Rob and the dt list.

> ---
> Changes in v7:
>  - Add this extra commit
>  Documentation/devicetree/bindings/iio/adc/adc.txt | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/adc.txt b/Documentation/devicetree/bindings/iio/adc/adc.txt
> index 5bbaa330a250..4b37575bbddc 100644
> --- a/Documentation/devicetree/bindings/iio/adc/adc.txt
> +++ b/Documentation/devicetree/bindings/iio/adc/adc.txt
> @@ -5,18 +5,24 @@ Optional properties for child nodes:
>  - diff-channels : Differential channels muxed for this ADC. The first value
>  		specifies the positive input pin, the second value the negative
>  		input pin.
> +- reg: The channel number.
> +- label: Unique name to identify which channel this is.
>  
>  Example:
>  	adc@0 {
>  		compatible = "some,adc";
>  		...
>  		channel@0 {
> +			reg = <0>;
> +			label = "channel_0_name";
>  			bipolar;
>  			diff-channels = <0 1>;
>  			...
>  		};
>  
>  		channel@1 {
> +			reg = <1>;
> +			label = "channel_1_name";
>  			diff-channels = <2 3>;
>  			...
>  		};
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/adc.txt b/Documentation/devicetree/bindings/iio/adc/adc.txt
index 5bbaa330a250..4b37575bbddc 100644
--- a/Documentation/devicetree/bindings/iio/adc/adc.txt
+++ b/Documentation/devicetree/bindings/iio/adc/adc.txt
@@ -5,18 +5,24 @@  Optional properties for child nodes:
 - diff-channels : Differential channels muxed for this ADC. The first value
 		specifies the positive input pin, the second value the negative
 		input pin.
+- reg: The channel number.
+- label: Unique name to identify which channel this is.
 
 Example:
 	adc@0 {
 		compatible = "some,adc";
 		...
 		channel@0 {
+			reg = <0>;
+			label = "channel_0_name";
 			bipolar;
 			diff-channels = <0 1>;
 			...
 		};
 
 		channel@1 {
+			reg = <1>;
+			label = "channel_1_name";
 			diff-channels = <2 3>;
 			...
 		};