diff mbox series

[1/3] dt-bindings: iio: chemical: Add binding for CCS811 VOC sensor

Message ID 20200412183658.6755-2-mani@kernel.org (mailing list archive)
State New, archived
Headers show
Series Add Reset and Wakeup support for CCS811 | expand

Commit Message

Manivannan Sadhasivam April 12, 2020, 6:36 p.m. UTC 
From: Manivannan Sadhasivam <mani@kernel.org>

This commit adds devicetree binding for AMS CCS811 VOC sensor.

Signed-off-by: Manivannan Sadhasivam <mani@kernel.org>
---
 .../bindings/iio/chemical/ams,ccs811.yaml     | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml

Comments

Jonathan Cameron April 13, 2020, 4:53 p.m. UTC | #1 
On Mon, 13 Apr 2020 00:06:56 +0530
mani@kernel.org wrote:

> From: Manivannan Sadhasivam <mani@kernel.org>
> 
> This commit adds devicetree binding for AMS CCS811 VOC sensor.
> 
> Signed-off-by: Manivannan Sadhasivam <mani@kernel.org>
Great to see this driver getting some more attention.

A few things inline

Thanks,

Jonathan

> ---
>  .../bindings/iio/chemical/ams,ccs811.yaml     | 50 +++++++++++++++++++
>  1 file changed, 50 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml b/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> new file mode 100644
> index 000000000000..564208af7b2b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> @@ -0,0 +1,50 @@
> +# SPDX-License-Identifier: GPL-2.0

Preferred that all new binding docs are dual licensed with BSD as well
to allow there use by things other than the kernel.

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/chemical/ams,ccs811.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: AMS CCS811 VOC Sensor
> +
> +maintainers:
> +  - Narcisa Vasile <narcisaanamaria12@gmail.com>
> +
> +description: |
> +  Ultra-Low Power Digital Gas Sensor for Monitoring Indoor Air Quality.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ams,ccs811
> +  reg:
> +    maxItems: 1
> +
> +  reset-gpios:
> +    description: GPIO connected to the nRESET line. This is an active low
> +                 input to CCS811.
> +    maxItems: 1
> +
> +  wakeup-gpios:
> +    description: GPIO connected to the nWAKE line. This is an active low
> +                 input to CCS811.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +examples:
> +  - |
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      ccs811@5b {
Hmm. Not sure we have a generic name in the dt spec for voc sensor.
Even so we should try for something appropriate.

Could go with voc@5b?

> +        compatible = "ams,ccs811";
> +        reg = <0x5b>;
> +        reset-gpios = <&gpioa 11 GPIO_ACTIVE_LOW>;
> +        wakeup-gpios = <&gpioa 12 GPIO_ACTIVE_LOW>;
> +      };
> +    };
> +
> +...
Manivannan Sadhasivam April 14, 2020, 12:10 p.m. UTC | #2 
On Mon, Apr 13, 2020 at 05:53:23PM +0100, Jonathan Cameron wrote:
> On Mon, 13 Apr 2020 00:06:56 +0530
> mani@kernel.org wrote:
> 
> > From: Manivannan Sadhasivam <mani@kernel.org>
> > 
> > This commit adds devicetree binding for AMS CCS811 VOC sensor.
> > 
> > Signed-off-by: Manivannan Sadhasivam <mani@kernel.org>
> Great to see this driver getting some more attention.
> 
> A few things inline
> 
> Thanks,
> 
> Jonathan
> 
> > ---
> >  .../bindings/iio/chemical/ams,ccs811.yaml     | 50 +++++++++++++++++++
> >  1 file changed, 50 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml b/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> > new file mode 100644
> > index 000000000000..564208af7b2b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> > @@ -0,0 +1,50 @@
> > +# SPDX-License-Identifier: GPL-2.0
> 
> Preferred that all new binding docs are dual licensed with BSD as well
> to allow there use by things other than the kernel.
> 

Okay will do.

> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/chemical/ams,ccs811.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: AMS CCS811 VOC Sensor
> > +
> > +maintainers:
> > +  - Narcisa Vasile <narcisaanamaria12@gmail.com>
> > +
> > +description: |
> > +  Ultra-Low Power Digital Gas Sensor for Monitoring Indoor Air Quality.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - ams,ccs811
> > +  reg:
> > +    maxItems: 1
> > +
> > +  reset-gpios:
> > +    description: GPIO connected to the nRESET line. This is an active low
> > +                 input to CCS811.
> > +    maxItems: 1
> > +
> > +  wakeup-gpios:
> > +    description: GPIO connected to the nWAKE line. This is an active low
> > +                 input to CCS811.
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +examples:
> > +  - |
> > +    i2c {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +
> > +      ccs811@5b {
> Hmm. Not sure we have a generic name in the dt spec for voc sensor.
> Even so we should try for something appropriate.
> 
> Could go with voc@5b?
> 

Sounds good to me.

Thanks,
Mani

> > +        compatible = "ams,ccs811";
> > +        reg = <0x5b>;
> > +        reset-gpios = <&gpioa 11 GPIO_ACTIVE_LOW>;
> > +        wakeup-gpios = <&gpioa 12 GPIO_ACTIVE_LOW>;
> > +      };
> > +    };
> > +
> > +...
>
Rob Herring (Arm) April 14, 2020, 1:27 p.m. UTC | #3 
On Mon, 13 Apr 2020 00:06:56 +0530, mani@kernel.org wrote:
> From: Manivannan Sadhasivam <mani@kernel.org>
> 
> This commit adds devicetree binding for AMS CCS811 VOC sensor.
> 
> Signed-off-by: Manivannan Sadhasivam <mani@kernel.org>
> ---
>  .../bindings/iio/chemical/ams,ccs811.yaml     | 50 +++++++++++++++++++
>  1 file changed, 50 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> 

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

Error: Documentation/devicetree/bindings/iio/chemical/ams,ccs811.example.dts:24.38-39 syntax error
FATAL ERROR: Unable to parse input tree
scripts/Makefile.lib:311: recipe for target 'Documentation/devicetree/bindings/iio/chemical/ams,ccs811.example.dt.yaml' failed
make[1]: *** [Documentation/devicetree/bindings/iio/chemical/ams,ccs811.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
Makefile:1262: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1269473

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

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
Manivannan Sadhasivam April 14, 2020, 2:08 p.m. UTC | #4 
On Tue, Apr 14, 2020 at 08:27:17AM -0500, Rob Herring wrote:
> On Mon, 13 Apr 2020 00:06:56 +0530, mani@kernel.org wrote:
> > From: Manivannan Sadhasivam <mani@kernel.org>
> > 
> > This commit adds devicetree binding for AMS CCS811 VOC sensor.
> > 
> > Signed-off-by: Manivannan Sadhasivam <mani@kernel.org>
> > ---
> >  .../bindings/iio/chemical/ams,ccs811.yaml     | 50 +++++++++++++++++++
> >  1 file changed, 50 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
> > 
> 
> My bot found errors running 'make dt_binding_check' on your patch:
> 
> Error: Documentation/devicetree/bindings/iio/chemical/ams,ccs811.example.dts:24.38-39 syntax error
> FATAL ERROR: Unable to parse input tree
> scripts/Makefile.lib:311: recipe for target 'Documentation/devicetree/bindings/iio/chemical/ams,ccs811.example.dt.yaml' failed
> make[1]: *** [Documentation/devicetree/bindings/iio/chemical/ams,ccs811.example.dt.yaml] Error 1
> make[1]: *** Waiting for unfinished jobs....
> Makefile:1262: recipe for target 'dt_binding_check' failed
> make: *** [dt_binding_check] Error 2
> 
> See https://patchwork.ozlabs.org/patch/1269473
> 
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure dt-schema is up to date:
> 

Ah, sorry. I did run 'dtbs_check' but forgot that it won't report errors in the
binding schemas.

Will run `dt_binding_check` hereafter.

Thanks,
Mani

> pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade
> 
> Please check and re-submit.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml b/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
new file mode 100644
index 000000000000..564208af7b2b
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/chemical/ams,ccs811.yaml
@@ -0,0 +1,50 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/chemical/ams,ccs811.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AMS CCS811 VOC Sensor
+
+maintainers:
+  - Narcisa Vasile <narcisaanamaria12@gmail.com>
+
+description: |
+  Ultra-Low Power Digital Gas Sensor for Monitoring Indoor Air Quality.
+
+properties:
+  compatible:
+    enum:
+      - ams,ccs811
+  reg:
+    maxItems: 1
+
+  reset-gpios:
+    description: GPIO connected to the nRESET line. This is an active low
+                 input to CCS811.
+    maxItems: 1
+
+  wakeup-gpios:
+    description: GPIO connected to the nWAKE line. This is an active low
+                 input to CCS811.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      ccs811@5b {
+        compatible = "ams,ccs811";
+        reg = <0x5b>;
+        reset-gpios = <&gpioa 11 GPIO_ACTIVE_LOW>;
+        wakeup-gpios = <&gpioa 12 GPIO_ACTIVE_LOW>;
+      };
+    };
+
+...