diff mbox series

[v2] dt-bindings: iio: accel: add binding documentation for ADIS16203

Message ID 20250303235930.68731-1-danascape@gmail.com (mailing list archive)
State Changes Requested
Headers show
Series [v2] dt-bindings: iio: accel: add binding documentation for ADIS16203 | expand

Commit Message

Saalim Quadri March 3, 2025, 11:59 p.m. UTC
This patch add device tree binding documentation for ADIS16203.

Signed-off-by: Saalim Quadri <danascape@gmail.com>
---
Changes:
V1 - V2: change compatible property from enum to const

 .../bindings/iio/accel/adi,adis16203.yaml     | 52 +++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml

Comments

Rob Herring (Arm) March 4, 2025, 1:24 a.m. UTC | #1
On Tue, 04 Mar 2025 05:29:30 +0530, Saalim Quadri wrote:
> This patch add device tree binding documentation for ADIS16203.
> 
> Signed-off-by: Saalim Quadri <danascape@gmail.com>
> ---
> Changes:
> V1 - V2: change compatible property from enum to const
> 
>  .../bindings/iio/accel/adi,adis16203.yaml     | 52 +++++++++++++++++++
>  1 file changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml: properties:compatible:const: ['adi,adis16203'] is not of type 'integer', 'string'
	from schema $id: http://devicetree.org/meta-schemas/keywords.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml: properties:compatible:const: ['adi,adis16203'] is not of type 'string'
	from schema $id: http://devicetree.org/meta-schemas/string-array.yaml#
Documentation/devicetree/bindings/iio/accel/adi,adis16203.example.dtb: /example-0/spi/accelerometer@0: failed to match any schema with compatible: ['adi,adis16203']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20250303235930.68731-1-danascape@gmail.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.
Krzysztof Kozlowski March 4, 2025, 7:46 a.m. UTC | #2
On Tue, Mar 04, 2025 at 05:29:30AM +0530, Saalim Quadri wrote:
> This patch add device tree binding documentation for ADIS16203.
> 
> Signed-off-by: Saalim Quadri <danascape@gmail.com>
> ---
> Changes:
> V1 - V2: change compatible property from enum to const
> 

Please kindly test your patch before posting, instead of using community
as a testing service.

Best regards,
Krzysztof
Jonathan Cameron March 4, 2025, 2:39 p.m. UTC | #3
On Tue,  4 Mar 2025 05:29:30 +0530
Saalim Quadri <danascape@gmail.com> wrote:

> This patch add device tree binding documentation for ADIS16203.
> 
> Signed-off-by: Saalim Quadri <danascape@gmail.com>
> ---
> Changes:
> V1 - V2: change compatible property from enum to const
> 
>  .../bindings/iio/accel/adi,adis16203.yaml     | 52 +++++++++++++++++++
>  1 file changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
> 
> 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..64370f13e1dc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
> @@ -0,0 +1,52 @@
> +# 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: Analog Devices ADIS16203 Programmable 360 Degrees Inclinometer
> +
> +maintainers:
> +  - Barry Song <21cnbao@gmail.com>
I think you'll be dropping this patch anyway, but just a quick not that
it isn't good to volunteer people.  Barry hasn't worked on these
devices for quite a long time now so seems unlikely he agreed to this.

Jonathan
Saalim Quadri March 6, 2025, 12:15 a.m. UTC | #4
Apologies, it was a mistake on my end, I had wrong dependencies
installed which passed the dt-bindings check on my end when I tried to verify.

Sincerely,
Saalim Quadri
Barry Song March 6, 2025, 12:32 a.m. UTC | #5
On Wed, Mar 5, 2025 at 3:39 AM Jonathan Cameron <jic23@kernel.org> wrote:
>
> On Tue,  4 Mar 2025 05:29:30 +0530
> Saalim Quadri <danascape@gmail.com> wrote:
>
> > This patch add device tree binding documentation for ADIS16203.
> >
> > Signed-off-by: Saalim Quadri <danascape@gmail.com>
> > ---
> > Changes:
> > V1 - V2: change compatible property from enum to const
> >
> >  .../bindings/iio/accel/adi,adis16203.yaml     | 52 +++++++++++++++++++
> >  1 file changed, 52 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
> >
> > 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..64370f13e1dc
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
> > @@ -0,0 +1,52 @@
> > +# 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: Analog Devices ADIS16203 Programmable 360 Degrees Inclinometer
> > +
> > +maintainers:
> > +  - Barry Song <21cnbao@gmail.com>
> I think you'll be dropping this patch anyway, but just a quick not that
> it isn't good to volunteer people.  Barry hasn't worked on these
> devices for quite a long time now so seems unlikely he agreed to this.

Hi Saalim, if you're sending a v2, feel free to nominate yourself or anyone
interested as the maintainer. Apologies, but I probably won’t have time to
handle this :-)

>
> Jonathan

Thanks
Barry
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..64370f13e1dc
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/accel/adi,adis16203.yaml
@@ -0,0 +1,52 @@ 
+# 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: Analog Devices ADIS16203 Programmable 360 Degrees Inclinometer
+
+maintainers:
+  - Barry Song <21cnbao@gmail.com>
+
+description: |
+  https://www.analog.com/media/en/technical-documentation/data-sheets/adis16203.pdf
+
+properties:
+  compatible:
+    const:
+      - adi,adis16203
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    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,adis16203";
+            reg = <0>;
+            spi-max-frequency = <2500000>;
+            interrupt-parent = <&gpio0>;
+            interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
+        };
+    };
+...