diff mbox series

[v3,1/8] dt-bindings: adc: ad9467: add new io-backend property

Message ID 20231213-dev-iio-backend-v3-1-bb9f12a5c6dc@analog.com (mailing list archive)
State Superseded
Headers show
Series iio: add new backend framework | expand

Commit Message

Nuno Sa via B4 Relay Dec. 13, 2023, 3:02 p.m. UTC
From: Nuno Sa <nuno.sa@analog.com>

The ad9467 will make use of the new IIO backend framework which is a
provider - consumer interface where IIO backends provide services to
consumers. As such, and being this device a consumer,  add the new
generic io-backend property to the bindings.

Signed-off-by: Nuno Sa <nuno.sa@analog.com>
---
 Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Rob Herring (Arm) Dec. 13, 2023, 5:55 p.m. UTC | #1
On Wed, 13 Dec 2023 16:02:32 +0100, Nuno Sa wrote:
> The ad9467 will make use of the new IIO backend framework which is a
> provider - consumer interface where IIO backends provide services to
> consumers. As such, and being this device a consumer,  add the new
> generic io-backend property to the bindings.
> 
> Signed-off-by: Nuno Sa <nuno.sa@analog.com>
> ---
>  Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml | 5 +++++
>  1 file changed, 5 insertions(+)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml: io-backends: missing type definition

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231213-dev-iio-backend-v3-1-bb9f12a5c6dc@analog.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Nuno Sá Dec. 14, 2023, 12:27 p.m. UTC | #2
On Wed, 2023-12-13 at 11:55 -0600, Rob Herring wrote:
> 
> On Wed, 13 Dec 2023 16:02:32 +0100, Nuno Sa wrote:
> > The ad9467 will make use of the new IIO backend framework which is a
> > provider - consumer interface where IIO backends provide services to
> > consumers. As such, and being this device a consumer,  add the new
> > generic io-backend property to the bindings.
> > 
> > Signed-off-by: Nuno Sa <nuno.sa@analog.com>
> > ---
> >  Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml | 5 +++++
> >  1 file changed, 5 insertions(+)
> > 
> 
> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> on your patch (DT_CHECKER_FLAGS is new in v5.13):
> 
> yamllint warnings/errors:
> 
> dtschema/dtc warnings/errors:
> /builds/robherring/dt-review-
> ci/linux/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml: io-backends:
> missing type definition
> 
> doc reference errors (make refcheckdocs):
> 
> See
> https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231213-dev-iio-backend-v3-1-bb9f12a5c6dc@analog.com
> 
> The base for the series is generally the latest rc1. A different dependency
> should be noted in *this* patch.
> 
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure 'yamllint' is installed and dt-schema is up to
> date:
> 
> pip3 install dtschema --upgrade
> 
> Please check and re-submit after running the above command yourself. Note
> that DT_SCHEMA_FILES can be set to your schema file to speed up checking
> your schema. However, it must be unset to test all examples with your schema.
> 

This is kind of expected as the property is being proposed as a generic one...

- Nuno Sá
Rob Herring (Arm) Dec. 14, 2023, 5:05 p.m. UTC | #3
On Wed, Dec 13, 2023 at 04:02:32PM +0100, Nuno Sa wrote:
> The ad9467 will make use of the new IIO backend framework which is a
> provider - consumer interface where IIO backends provide services to
> consumers. As such, and being this device a consumer,  add the new
> generic io-backend property to the bindings.
> 
> Signed-off-by: Nuno Sa <nuno.sa@analog.com>
> ---
>  Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
> index 7aa748d6b7a0..74e6827cbd47 100644
> --- a/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
> +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
> @@ -44,6 +44,9 @@ properties:
>        Pin that controls the powerdown mode of the device.
>      maxItems: 1
>  
> +  io-backends:
> +    maxItems: 1
> +
>    reset-gpios:
>      description:
>        Reset pin for the device.
> @@ -54,6 +57,7 @@ required:
>    - reg
>    - clocks
>    - clock-names
> +  - io-backends

New required properties are an ABI break. Please justify this in the 
commit message.

Rob
Nuno Sá Dec. 15, 2023, 7:52 a.m. UTC | #4
On Thu, 2023-12-14 at 11:05 -0600, Rob Herring wrote:
> On Wed, Dec 13, 2023 at 04:02:32PM +0100, Nuno Sa wrote:
> > The ad9467 will make use of the new IIO backend framework which is a
> > provider - consumer interface where IIO backends provide services to
> > consumers. As such, and being this device a consumer,  add the new
> > generic io-backend property to the bindings.
> > 
> > Signed-off-by: Nuno Sa <nuno.sa@analog.com>
> > ---
> >  Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml | 5 +++++
> >  1 file changed, 5 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
> > b/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
> > index 7aa748d6b7a0..74e6827cbd47 100644
> > --- a/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
> > +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
> > @@ -44,6 +44,9 @@ properties:
> >        Pin that controls the powerdown mode of the device.
> >      maxItems: 1
> >  
> > +  io-backends:
> > +    maxItems: 1
> > +
> >    reset-gpios:
> >      description:
> >        Reset pin for the device.
> > @@ -54,6 +57,7 @@ required:
> >    - reg
> >    - clocks
> >    - clock-names
> > +  - io-backends
> 
> New required properties are an ABI break. Please justify this in the 
> commit message.
> 

Yeah, I know... I'll further comment on the cover and depending on the
conclusion we get I'll justify it (or not if not needed) in the message.

- Nuno Sá
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
index 7aa748d6b7a0..74e6827cbd47 100644
--- a/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
+++ b/Documentation/devicetree/bindings/iio/adc/adi,ad9467.yaml
@@ -44,6 +44,9 @@  properties:
       Pin that controls the powerdown mode of the device.
     maxItems: 1
 
+  io-backends:
+    maxItems: 1
+
   reset-gpios:
     description:
       Reset pin for the device.
@@ -54,6 +57,7 @@  required:
   - reg
   - clocks
   - clock-names
+  - io-backends
 
 additionalProperties: false
 
@@ -68,6 +72,7 @@  examples:
             reg = <0>;
             clocks = <&adc_clk>;
             clock-names = "adc-clk";
+            io-backends = <&iio_backend>;
         };
     };
 ...