Re: [PATCH] dt-bindings:iio:adc:st,spear600-adc: txt to yaml format conversion.

[Jonathan Cameron <jic23@kernel.org>]

On Wed, 23 Apr 2025 15:12:01 -0500
Rob Herring <robh@kernel.org> wrote:

> On Tue, Apr 22, 2025 at 11:14:23PM -0300, Rodrigo Gobbi wrote:
> > Straight forward conversion from spear-adc.txt into yaml format.
> > 
> > Signed-off-by: Rodrigo Gobbi <rodrigo.gobbi.7@gmail.com>
> > ---
> > After the conversion to yaml file, I was not sure about the
> > maintainers yaml field. It looks like the original driver author,
> > Stefan Roese, is not active contributing.
> > @Jonathan, I was not sure about it and I've added you on that field
> > as I've noticed at other yaml`s, but feel free to give any suggestions on that
> > or how to proceed in this case.  
> 
> That's fine I think, or you can add the spear platform maintainers.

Yeah. I'm fine with this as I get all the emails anyway  :)

Huh. I never knew or had long forgotten this file existed. Thanks for cleaning it up!

If anyone actually cares about this driver beyond for legacy support,
the binding and driver are a long way from meeting modern standards!

E.g. sampling frequency shouldn't be in DT, and the vref should be a supply.
The averaging thing is a userspace problem not DT.

Ah well. At this stage I guess indeed makes sense to document in yaml what is out there.


Jonathan

> 
> > 
> > Also noticed that the driver was moved out of staging, but the .txt was not
> > in that time. Added the yaml in the proper path (out of staging as the driver).
> > Tks and best regards.
> > ---
> >  .../bindings/iio/adc/st,spear600-adc.yaml     | 61 +++++++++++++++++++
> >  .../bindings/staging/iio/adc/spear-adc.txt    | 24 --------
> >  2 files changed, 61 insertions(+), 24 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/iio/adc/st,spear600-adc.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/staging/iio/adc/spear-adc.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/adc/st,spear600-adc.yaml b/Documentation/devicetree/bindings/iio/adc/st,spear600-adc.yaml
> > new file mode 100644
> > index 000000000000..a858b3f3c494
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/adc/st,spear600-adc.yaml
> > @@ -0,0 +1,61 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/adc/st,spear600-adc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: ST SPEAr ADC device driver
> > +
> > +maintainers:
> > +  - Jonathan Cameron <jic23@kernel.org>
> > +
> > +description: |
> > +  Integrated ADC inside the ST SPEAr SoC, SPEAr600, supporting
> > +  10-bit resolution. Datasheet can be found here:
> > +  https://www.st.com/resource/en/datasheet/spear600.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - st,spear600-adc  
> 
> blank line
> 
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  sampling-frequency:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      Default sampling frequency of the ADC  
> 
> Constraints?
> 
> > +
> > +  vref-external:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      External voltage reference in milli-volts. If omitted
> > +      the internal voltage reference will be used.  
> 
> Constraints?

> 
> > +
> > +  average-samples:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description:
> > +      Number of samples to generate an average value. If
> > +      omitted, single data conversion will be used.  
> 
> Constraints?
> 
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - sampling-frequency
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    adc: adc@d8200000 {
> > +        compatible = "st,spear600-adc";
> > +        reg = <0xd8200000 0x1000>;
> > +        interrupt-parent = <&vic1>;
> > +        interrupts = <6>;
> > +        sampling-frequency = <5000000>;
> > +        vref-external = <2500>;	/* 2.5V VRef */
> > +    };
> > diff --git a/Documentation/devicetree/bindings/staging/iio/adc/spear-adc.txt b/Documentation/devicetree/bindings/staging/iio/adc/spear-adc.txt
> > deleted file mode 100644
> > index 88bc94fe1f6d..000000000000
> > --- a/Documentation/devicetree/bindings/staging/iio/adc/spear-adc.txt
> > +++ /dev/null
> > @@ -1,24 +0,0 @@
> > -* ST SPEAr ADC device driver
> > -
> > -Required properties:
> > -- compatible: Should be "st,spear600-adc"
> > -- reg: Address and length of the register set for the device
> > -- interrupts: Should contain the ADC interrupt
> > -- sampling-frequency: Default sampling frequency
> > -
> > -Optional properties:
> > -- vref-external: External voltage reference in milli-volts. If omitted
> > -  the internal voltage reference will be used.
> > -- average-samples: Number of samples to generate an average value. If
> > -  omitted, single data conversion will be used.
> > -
> > -Examples:
> > -
> > -	adc: adc@d8200000 {
> > -		compatible = "st,spear600-adc";
> > -		reg = <0xd8200000 0x1000>;
> > -		interrupt-parent = <&vic1>;
> > -		interrupts = <6>;
> > -		sampling-frequency = <5000000>;
> > -		vref-external = <2500>;	/* 2.5V VRef */
> > -	};
> > -- 
> > 2.47.0
> >