[v3,3/3] bindings: iio: pressure: Add dlh-i2c documentation
diff mbox series

Message ID 20191204100354.16652-4-tomislav.denis@avl.com
State Changes Requested
Headers show
Series
  • Add support for DLH pressure sensors
Related show

Checks

Context Check Description
robh/dt-meta-schema fail build log
robh/checkpatch success

Commit Message

Denis, Tomislav AVL DiTEST Dec. 4, 2019, 10:03 a.m. UTC
From: Tomislav Denis <tomislav.denis@avl.com>

Add a device tree binding documentation for DLH series pressure
sensors.

Signed-off-by: Tomislav Denis <tomislav.denis@avl.com>
---
 .../bindings/iio/pressure/asc,dlh-i2c.yaml         | 51 ++++++++++++++++++++++
 MAINTAINERS                                        |  1 +
 2 files changed, 52 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml

Comments

Jonathan Cameron Dec. 7, 2019, 11:34 a.m. UTC | #1
On Wed, 4 Dec 2019 11:03:54 +0100
<tomislav.denis@avl.com> wrote:

> From: Tomislav Denis <tomislav.denis@avl.com>
> 
> Add a device tree binding documentation for DLH series pressure
> sensors.
> 
> Signed-off-by: Tomislav Denis <tomislav.denis@avl.com>

One question for DT maintainers.  

Should the file be named after a specific part of is a generic
name for the parts covered acceptable?  I would assume it should
be a part number, but not sure what precedence there is.

Otherwise looks good to me, but I will let it sit to give time
for DT review.

Thanks,

Jonathan

> ---
>  .../bindings/iio/pressure/asc,dlh-i2c.yaml         | 51 ++++++++++++++++++++++
>  MAINTAINERS                                        |  1 +
>  2 files changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml b/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
> new file mode 100644
> index 0000000..5de2277
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/pressure/dlh-i2c.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: All Sensors DLH series low voltage digital pressure sensors
> +
> +maintainers:
> +  - Tomislav Denis <tomislav.denis@avl.com>
> +
> +description: |
> +  Bindings for the All Sensors DLH series pressure sensors.
> +
> +  Specifications about the sensors can be found at:
> +    http://www.allsensors.com/cad/DS-0355_Rev_B.PDF
> +
> +properties:
> +  compatible:
> +    enum:
> +      - asc,dlhl60d
> +      - asc,dlhl60g
> +
> +  reg:
> +    description: I2C device address
> +    maxItems: 1
> +
> +  interrupts:
> +    description: interrupt mapping for EOC(data ready) pin
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    i2c0 {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      pressure@29 {
> +          compatible = "asc,dlhl60d";
> +          reg = <0x29>;
> +          interrupt-parent = <&gpio0>;
> +          interrupts = <10 IRQ_TYPE_EDGE_RISING>;
> +      };
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 39d6f0f..8f0eab0 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -674,6 +674,7 @@ W:	http://www.allsensors.com/
>  S:	Maintained
>  L:	linux-iio@vger.kernel.org
>  F:	drivers/iio/pressure/dlh-i2c.c
> +F:	Documentation/devicetree/bindings/iio/pressure/dlh-i2c.yaml
>  
>  ALLEGRO DVT VIDEO IP CORE DRIVER
>  M:	Michael Tretter <m.tretter@pengutronix.de>
Rob Herring Dec. 16, 2019, 9:32 p.m. UTC | #2
On Sat, Dec 07, 2019 at 11:34:42AM +0000, Jonathan Cameron wrote:
> On Wed, 4 Dec 2019 11:03:54 +0100
> <tomislav.denis@avl.com> wrote:
> 
> > From: Tomislav Denis <tomislav.denis@avl.com>
> > 
> > Add a device tree binding documentation for DLH series pressure
> > sensors.
> > 
> > Signed-off-by: Tomislav Denis <tomislav.denis@avl.com>
> 
> One question for DT maintainers.  
> 
> Should the file be named after a specific part of is a generic
> name for the parts covered acceptable?  I would assume it should
> be a part number, but not sure what precedence there is.

I would use asc,dlhl60.yaml I think. The rule is match the compatible if 
there's only one. Otherwise, no hard rule really. Use the first/oldest 
compatible, do wildcard, or vendor prefix and something else.

> Otherwise looks good to me, but I will let it sit to give time
> for DT review.
> 
> Thanks,
> 
> Jonathan
> 
> > ---
> >  .../bindings/iio/pressure/asc,dlh-i2c.yaml         | 51 ++++++++++++++++++++++
> >  MAINTAINERS                                        |  1 +
> >  2 files changed, 52 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml b/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
> > new file mode 100644
> > index 0000000..5de2277
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
> > @@ -0,0 +1,51 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/pressure/dlh-i2c.yaml#

Note that the filename doesn't match here. Run 'make dt_binding_check'.

> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: All Sensors DLH series low voltage digital pressure sensors
> > +
> > +maintainers:
> > +  - Tomislav Denis <tomislav.denis@avl.com>
> > +
> > +description: |
> > +  Bindings for the All Sensors DLH series pressure sensors.
> > +
> > +  Specifications about the sensors can be found at:
> > +    http://www.allsensors.com/cad/DS-0355_Rev_B.PDF
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - asc,dlhl60d
> > +      - asc,dlhl60g
> > +
> > +  reg:
> > +    description: I2C device address
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    description: interrupt mapping for EOC(data ready) pin
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +
> > +    i2c0 {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +
> > +      pressure@29 {
> > +          compatible = "asc,dlhl60d";
> > +          reg = <0x29>;
> > +          interrupt-parent = <&gpio0>;
> > +          interrupts = <10 IRQ_TYPE_EDGE_RISING>;
> > +      };
> > +    };
> > +...
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 39d6f0f..8f0eab0 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -674,6 +674,7 @@ W:	http://www.allsensors.com/
> >  S:	Maintained
> >  L:	linux-iio@vger.kernel.org
> >  F:	drivers/iio/pressure/dlh-i2c.c
> > +F:	Documentation/devicetree/bindings/iio/pressure/dlh-i2c.yaml
> >  
> >  ALLEGRO DVT VIDEO IP CORE DRIVER
> >  M:	Michael Tretter <m.tretter@pengutronix.de>
>

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml b/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
new file mode 100644
index 0000000..5de2277
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/pressure/asc,dlh-i2c.yaml
@@ -0,0 +1,51 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/pressure/dlh-i2c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: All Sensors DLH series low voltage digital pressure sensors
+
+maintainers:
+  - Tomislav Denis <tomislav.denis@avl.com>
+
+description: |
+  Bindings for the All Sensors DLH series pressure sensors.
+
+  Specifications about the sensors can be found at:
+    http://www.allsensors.com/cad/DS-0355_Rev_B.PDF
+
+properties:
+  compatible:
+    enum:
+      - asc,dlhl60d
+      - asc,dlhl60g
+
+  reg:
+    description: I2C device address
+    maxItems: 1
+
+  interrupts:
+    description: interrupt mapping for EOC(data ready) pin
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    i2c0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      pressure@29 {
+          compatible = "asc,dlhl60d";
+          reg = <0x29>;
+          interrupt-parent = <&gpio0>;
+          interrupts = <10 IRQ_TYPE_EDGE_RISING>;
+      };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 39d6f0f..8f0eab0 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -674,6 +674,7 @@  W:	http://www.allsensors.com/
 S:	Maintained
 L:	linux-iio@vger.kernel.org
 F:	drivers/iio/pressure/dlh-i2c.c
+F:	Documentation/devicetree/bindings/iio/pressure/dlh-i2c.yaml
 
 ALLEGRO DVT VIDEO IP CORE DRIVER
 M:	Michael Tretter <m.tretter@pengutronix.de>