diff mbox series

[v2,12/12] dt-bindings: iio: accel: Add ADIS16203 Inclinometer

Message ID 20230129155602.740743-13-jic23@kernel.org (mailing list archive)
State New, archived
Headers show
Series staging: iio: accel: adis16203 Inclinometer cleanup and graduation | expand

Commit Message

Jonathan Cameron Jan. 29, 2023, 3:56 p.m. UTC 
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

There has been a driver in staging for quite a while.
Given we are now moving it to the main tree, time to make sure it
has binding documentation.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

--
V2:
- maxItems/minItems added where needed.
- fix interrupt-names to allow multiple entries.
---
 .../bindings/iio/accel/adi,adis16203.yaml     | 64 +++++++++++++++++++
 1 file changed, 64 insertions(+)

Comments

Rob Herring Jan. 30, 2023, 1:35 p.m. UTC | #1 
On Sun, 29 Jan 2023 15:56:02 +0000, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> There has been a driver in staging for quite a while.
> Given we are now moving it to the main tree, time to make sure it
> has binding documentation.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> --
> V2:
> - maxItems/minItems added where needed.
> - fix interrupt-names to allow multiple entries.
> ---
>  .../bindings/iio/accel/adi,adis16203.yaml     | 64 +++++++++++++++++++
>  1 file changed, 64 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/accel/adi,adis16203.example.dtb: accelerometer@0: Unevaluated properties are not allowed ('interrupt-names' was unexpected)
	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/accel/adi,adis16201.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230129155602.740743-13-jic23@kernel.org

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.
Rob Herring Jan. 30, 2023, 3:21 p.m. UTC | #2 
On Mon, Jan 30, 2023 at 07:35:26AM -0600, Rob Herring wrote:
> 
> On Sun, 29 Jan 2023 15:56:02 +0000, Jonathan Cameron wrote:
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > 
> > There has been a driver in staging for quite a while.
> > Given we are now moving it to the main tree, time to make sure it
> > has binding documentation.
> > 
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > 
> > --
> > V2:
> > - maxItems/minItems added where needed.
> > - fix interrupt-names to allow multiple entries.
> > ---
> >  .../bindings/iio/accel/adi,adis16203.yaml     | 64 +++++++++++++++++++
> >  1 file changed, 64 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/accel/adi,adis16203.example.dtb: accelerometer@0: Unevaluated properties are not allowed ('interrupt-names' was unexpected)
> 	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/accel/adi,adis16201.yaml

I was scratching my head on this one... Check the compatible string in 
the example. You've got 201 instead of 203.

Are these parts that different?

Rob
Jonathan Cameron Jan. 30, 2023, 5:09 p.m. UTC | #3 
On Mon, 30 Jan 2023 09:21:37 -0600
Rob Herring <robh@kernel.org> wrote:

> On Mon, Jan 30, 2023 at 07:35:26AM -0600, Rob Herring wrote:
> > 
> > On Sun, 29 Jan 2023 15:56:02 +0000, Jonathan Cameron wrote:  
> > > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > > 
> > > There has been a driver in staging for quite a while.
> > > Given we are now moving it to the main tree, time to make sure it
> > > has binding documentation.
> > > 
> > > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > > 
> > > --
> > > V2:
> > > - maxItems/minItems added where needed.
> > > - fix interrupt-names to allow multiple entries.
> > > ---
> > >  .../bindings/iio/accel/adi,adis16203.yaml     | 64 +++++++++++++++++++
> > >  1 file changed, 64 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/accel/adi,adis16203.example.dtb: accelerometer@0: Unevaluated properties are not allowed ('interrupt-names' was unexpected)
> > 	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/accel/adi,adis16201.yaml  
> 
> I was scratching my head on this one... Check the compatible string in 
> the example. You've got 201 instead of 203.
> 
> Are these parts that different?
> 
> Rob

Gah,  Not sure why I didn't see this error - definitely something odd going on when
I test at the moment. The parts are not particularly related.

I'll fix that and send a v3.
Jonathan Cameron Jan. 30, 2023, 5:24 p.m. UTC | #4 
On Mon, 30 Jan 2023 17:09:23 +0000
Jonathan Cameron <Jonathan.Cameron@Huawei.com> wrote:

> On Mon, 30 Jan 2023 09:21:37 -0600
> Rob Herring <robh@kernel.org> wrote:
> 
> > On Mon, Jan 30, 2023 at 07:35:26AM -0600, Rob Herring wrote:  
> > > 
> > > On Sun, 29 Jan 2023 15:56:02 +0000, Jonathan Cameron wrote:    
> > > > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > > > 
> > > > There has been a driver in staging for quite a while.
> > > > Given we are now moving it to the main tree, time to make sure it
> > > > has binding documentation.
> > > > 
> > > > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > > > 
> > > > --
> > > > V2:
> > > > - maxItems/minItems added where needed.
> > > > - fix interrupt-names to allow multiple entries.
> > > > ---
> > > >  .../bindings/iio/accel/adi,adis16203.yaml     | 64 +++++++++++++++++++
> > > >  1 file changed, 64 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/accel/adi,adis16203.example.dtb: accelerometer@0: Unevaluated properties are not allowed ('interrupt-names' was unexpected)
> > > 	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/accel/adi,adis16201.yaml    
> > 
> > I was scratching my head on this one... Check the compatible string in 
> > the example. You've got 201 instead of 203.
> > 
> > Are these parts that different?
> > 
> > Rob  
> 
> Gah,  Not sure why I didn't see this error - definitely something odd going on when
> I test at the moment. The parts are not particularly related.

On closer inspection they are more similar than most of the adis16xxx parts, so
it might make sense to have a combined binding and just enhance the adis16201
binding doc. I'll take a closer look at the datasheets before v3.

> 
> I'll fix that and send a v3. 
>  
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml b/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
new file mode 100644
index 000000000000..2248fb4eb2c3
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
@@ -0,0 +1,64 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/accel/adi,adis16203.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADIS16203 Programmable 360 degree inclinometer
+
+maintainers:
+  - Jonathan Cameron <Jonathan.Cameron@huawei.com>
+
+properties:
+  compatible:
+    const: adi,adis16203
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    minItems: 1
+    maxItems: 2
+
+  interrupt-names:
+    minItems: 1
+    maxItems: 2
+    description:
+      Device has two configurable outputs, both of which may be used
+      as interrupt sources.
+    items:
+      enum:
+        - dio0
+        - dio1
+
+  reset-gpios:
+    maxItems: 1
+
+  vdd-supply: true
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        accelerometer@0 {
+            compatible = "adi,adis16201";
+            reg = <0>;
+            spi-max-frequency = <2500000>;
+            interrupt-parent = <&gpio0>;
+            interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
+            interrupt-names = "dio0";
+        };
+    };
+...
+