diff mbox series

[2/2] dt-bindings: iio: gyro: Add DT binding doc for ADXRS290

Message ID 20200715092821.14625-1-nish.malpani25@gmail.com (mailing list archive)
State New, archived
Headers show
Series [1/2] iio: gyro: Add driver support for ADXRS290 | expand

Commit Message

Nishant Malpani July 15, 2020, 9:28 a.m. UTC 
Add devicetree binding document for ADXRS290, a dual-axis MEMS gyroscope.

Signed-off-by: Nishant Malpani <nish.malpani25@gmail.com>
---
 .../bindings/iio/gyroscope/adi,adxrs290.yaml  | 52 +++++++++++++++++++
 MAINTAINERS                                   |  1 +
 2 files changed, 53 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml

Comments

Jonathan Cameron July 20, 2020, 11:16 a.m. UTC | #1 
On Wed, 15 Jul 2020 14:58:21 +0530
Nishant Malpani <nish.malpani25@gmail.com> wrote:

> Add devicetree binding document for ADXRS290, a dual-axis MEMS gyroscope.
> 
> Signed-off-by: Nishant Malpani <nish.malpani25@gmail.com>
> ---
>  .../bindings/iio/gyroscope/adi,adxrs290.yaml  | 52 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  2 files changed, 53 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
> new file mode 100644
> index 000000000000..a997d945fdb0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright 2020 Analog Devices Inc.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/gyroscope/adi,adxrs290.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices ADXRS290 Dual-Axis MEMS Gyroscope
> +
> +maintainers:
> +  - Nishant Malpani <nish.malpani25@gmail.com>
> +
> +description: |
> +  Bindings for the Analog Devices ADXRS290 dual-axis MEMS gyroscope device.
> +  https://www.analog.com/media/en/technical-documentation/data-sheets/ADXRS290.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,adxrs290

I think we can use const here as only one item currently.

> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    maximum: 5000000
> +
> +  spi-cpol: true
> +
> +  spi-cpha: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-max-frequency
> +  - spi-cpol
> +  - spi-cpha
> +
> +examples:
> +  - |
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        gyro@0 {
> +                   compatible = "adi,adxrs290";
> +                   reg = <0>;
> +                   spi-max-frequency = <5000000>;
> +                   spi-cpol;
> +                   spi-cpha;
> +        };
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index dd02cfc410e8..0bb8ac90fba1 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1103,6 +1103,7 @@ M:	Nishant Malpani <nish.malpani25@gmail.com>
>  L:	linux-iio@vger.kernel.org
>  S:	Supported
>  F:	drivers/iio/gyro/adxrs290.c
> +F:	Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
>  
>  ANALOG DEVICES INC ASOC CODEC DRIVERS
>  M:	Lars-Peter Clausen <lars@metafoo.de>
Rob Herring (Arm) July 21, 2020, 2:41 a.m. UTC | #2 
On Mon, Jul 20, 2020 at 12:16:33PM +0100, Jonathan Cameron wrote:
> On Wed, 15 Jul 2020 14:58:21 +0530
> Nishant Malpani <nish.malpani25@gmail.com> wrote:
> 
> > Add devicetree binding document for ADXRS290, a dual-axis MEMS gyroscope.
> > 
> > Signed-off-by: Nishant Malpani <nish.malpani25@gmail.com>
> > ---
> >  .../bindings/iio/gyroscope/adi,adxrs290.yaml  | 52 +++++++++++++++++++
> >  MAINTAINERS                                   |  1 +
> >  2 files changed, 53 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
> > new file mode 100644
> > index 000000000000..a997d945fdb0
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
> > @@ -0,0 +1,52 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +# Copyright 2020 Analog Devices Inc.
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/gyroscope/adi,adxrs290.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Analog Devices ADXRS290 Dual-Axis MEMS Gyroscope
> > +
> > +maintainers:
> > +  - Nishant Malpani <nish.malpani25@gmail.com>
> > +
> > +description: |
> > +  Bindings for the Analog Devices ADXRS290 dual-axis MEMS gyroscope device.
> > +  https://www.analog.com/media/en/technical-documentation/data-sheets/ADXRS290.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - adi,adxrs290
> 
> I think we can use const here as only one item currently.

Yep. Really depends if you expect to add more.

> 
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  spi-max-frequency:
> > +    maximum: 5000000
> > +
> > +  spi-cpol: true
> > +
> > +  spi-cpha: true
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - spi-max-frequency
> > +  - spi-cpol
> > +  - spi-cpha

Add:

additionalProperties: false

> > +
> > +examples:
> > +  - |
> > +    spi {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +        gyro@0 {
> > +                   compatible = "adi,adxrs290";
> > +                   reg = <0>;
> > +                   spi-max-frequency = <5000000>;
> > +                   spi-cpol;
> > +                   spi-cpha;
> > +        };
> > +    };
> > +...
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index dd02cfc410e8..0bb8ac90fba1 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -1103,6 +1103,7 @@ M:	Nishant Malpani <nish.malpani25@gmail.com>
> >  L:	linux-iio@vger.kernel.org
> >  S:	Supported
> >  F:	drivers/iio/gyro/adxrs290.c
> > +F:	Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
> >  
> >  ANALOG DEVICES INC ASOC CODEC DRIVERS
> >  M:	Lars-Peter Clausen <lars@metafoo.de>
>
Nishant Malpani July 21, 2020, 7:11 p.m. UTC | #3 
Hello Jonathon & Rob,

Thanks for the review. Comments inline...

On 21/07/20 8:11 am, Rob Herring wrote:
> On Mon, Jul 20, 2020 at 12:16:33PM +0100, Jonathan Cameron wrote:
>> On Wed, 15 Jul 2020 14:58:21 +0530
>> Nishant Malpani <nish.malpani25@gmail.com> wrote:
>>
>>> Add devicetree binding document for ADXRS290, a dual-axis MEMS gyroscope.
>>>
>>> Signed-off-by: Nishant Malpani <nish.malpani25@gmail.com>
>>> ---
>>>   .../bindings/iio/gyroscope/adi,adxrs290.yaml  | 52 +++++++++++++++++++
>>>   MAINTAINERS                                   |  1 +
>>>   2 files changed, 53 insertions(+)
>>>   create mode 100644 Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
>>> new file mode 100644
>>> index 000000000000..a997d945fdb0
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
>>> @@ -0,0 +1,52 @@
>>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>>> +# Copyright 2020 Analog Devices Inc.
>>> +%YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/iio/gyroscope/adi,adxrs290.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: Analog Devices ADXRS290 Dual-Axis MEMS Gyroscope
>>> +
>>> +maintainers:
>>> +  - Nishant Malpani <nish.malpani25@gmail.com>
>>> +
>>> +description: |
>>> +  Bindings for the Analog Devices ADXRS290 dual-axis MEMS gyroscope device.
>>> +  https://www.analog.com/media/en/technical-documentation/data-sheets/ADXRS290.pdf
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - adi,adxrs290
>>
>> I think we can use const here as only one item currently.
> 
> Yep. Really depends if you expect to add more.
> 
I'm not aware if we'll be adding more. For now, made it a 'const' in v2.

>>
>>> +
>>> +  reg:
>>> +    maxItems: 1
>>> +
>>> +  spi-max-frequency:
>>> +    maximum: 5000000
>>> +
>>> +  spi-cpol: true
>>> +
>>> +  spi-cpha: true
>>> +
>>> +required:
>>> +  - compatible
>>> +  - reg
>>> +  - spi-max-frequency
>>> +  - spi-cpol
>>> +  - spi-cpha
> 
> Add:
> 
> additionalProperties: false
> 
Okay. Acked in v2.

Regards,
Nishant Malpani

>>> +
>>> +examples:
>>> +  - |
>>> +    spi {
>>> +        #address-cells = <1>;
>>> +        #size-cells = <0>;
>>> +        gyro@0 {
>>> +                   compatible = "adi,adxrs290";
>>> +                   reg = <0>;
>>> +                   spi-max-frequency = <5000000>;
>>> +                   spi-cpol;
>>> +                   spi-cpha;
>>> +        };
>>> +    };
>>> +...
>>> diff --git a/MAINTAINERS b/MAINTAINERS
>>> index dd02cfc410e8..0bb8ac90fba1 100644
>>> --- a/MAINTAINERS
>>> +++ b/MAINTAINERS
>>> @@ -1103,6 +1103,7 @@ M:	Nishant Malpani <nish.malpani25@gmail.com>
>>>   L:	linux-iio@vger.kernel.org
>>>   S:	Supported
>>>   F:	drivers/iio/gyro/adxrs290.c
>>> +F:	Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
>>>   
>>>   ANALOG DEVICES INC ASOC CODEC DRIVERS
>>>   M:	Lars-Peter Clausen <lars@metafoo.de>
>>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
new file mode 100644
index 000000000000..a997d945fdb0
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
@@ -0,0 +1,52 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2020 Analog Devices Inc.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/gyroscope/adi,adxrs290.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices ADXRS290 Dual-Axis MEMS Gyroscope
+
+maintainers:
+  - Nishant Malpani <nish.malpani25@gmail.com>
+
+description: |
+  Bindings for the Analog Devices ADXRS290 dual-axis MEMS gyroscope device.
+  https://www.analog.com/media/en/technical-documentation/data-sheets/ADXRS290.pdf
+
+properties:
+  compatible:
+    enum:
+      - adi,adxrs290
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    maximum: 5000000
+
+  spi-cpol: true
+
+  spi-cpha: true
+
+required:
+  - compatible
+  - reg
+  - spi-max-frequency
+  - spi-cpol
+  - spi-cpha
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        gyro@0 {
+                   compatible = "adi,adxrs290";
+                   reg = <0>;
+                   spi-max-frequency = <5000000>;
+                   spi-cpol;
+                   spi-cpha;
+        };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index dd02cfc410e8..0bb8ac90fba1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1103,6 +1103,7 @@  M:	Nishant Malpani <nish.malpani25@gmail.com>
 L:	linux-iio@vger.kernel.org
 S:	Supported
 F:	drivers/iio/gyro/adxrs290.c
+F:	Documentation/devicetree/bindings/iio/gyroscope/adi,adxrs290.yaml
 
 ANALOG DEVICES INC ASOC CODEC DRIVERS
 M:	Lars-Peter Clausen <lars@metafoo.de>