diff mbox series

[v2,2/6] dt-bindings: iio: chemical: add ENS160 sensor

Message ID 20240529001504.33648-2-gustavograzs@gmail.com (mailing list archive)
State Changes Requested
Headers show
Series [v2,1/6] dt-bindings: vendor-prefixes: add ScioSense | expand

Commit Message

Gustavo Silva May 29, 2024, 12:14 a.m. UTC
Add bindings for ScioSense ENS160 multi-gas sensor.

Datasheet: https://www.sciosense.com/wp-content/uploads/2023/12/ENS160-Datasheet.pdf

Signed-off-by: Gustavo Silva <gustavograzs@gmail.com>
---
changes in v2:
 - Add devicetree binding file specifically for this sensor instead of
   adding it to trivial-devices.yaml. This is needed in order to
   document that this chip supports Vdd and Vddio supplies.
 .../iio/chemical/sciosense,ens160.yaml        | 68 +++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml

Comments

Rob Herring May 29, 2024, 1:42 a.m. UTC | #1
On Tue, 28 May 2024 21:14:19 -0300, Gustavo Silva wrote:
> Add bindings for ScioSense ENS160 multi-gas sensor.
> 
> Datasheet: https://www.sciosense.com/wp-content/uploads/2023/12/ENS160-Datasheet.pdf
> 
> Signed-off-by: Gustavo Silva <gustavograzs@gmail.com>
> ---
> changes in v2:
>  - Add devicetree binding file specifically for this sensor instead of
>    adding it to trivial-devices.yaml. This is needed in order to
>    document that this chip supports Vdd and Vddio supplies.
>  .../iio/chemical/sciosense,ens160.yaml        | 68 +++++++++++++++++++
>  1 file changed, 68 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.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/chemical/sciosense,ens160.example.dtb: gas-sensor@0: 'spi-max-frequency' does not match any of the regexes: 'pinctrl-[0-9]+'
	from schema $id: http://devicetree.org/schemas/iio/chemical/sciosense,ens160.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240529001504.33648-2-gustavograzs@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.
Conor Dooley May 29, 2024, 4:36 p.m. UTC | #2
On Tue, May 28, 2024 at 09:14:19PM -0300, Gustavo Silva wrote:
> Add bindings for ScioSense ENS160 multi-gas sensor.
> 
> Datasheet: https://www.sciosense.com/wp-content/uploads/2023/12/ENS160-Datasheet.pdf
> 
> Signed-off-by: Gustavo Silva <gustavograzs@gmail.com>
> ---
> changes in v2:
>  - Add devicetree binding file specifically for this sensor instead of
>    adding it to trivial-devices.yaml. This is needed in order to
>    document that this chip supports Vdd and Vddio supplies.
>  .../iio/chemical/sciosense,ens160.yaml        | 68 +++++++++++++++++++
>  1 file changed, 68 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml b/Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml
> new file mode 100644
> index 000000000..7dd442f94
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml
> @@ -0,0 +1,68 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/chemical/sciosense,ens160.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ScioSense ENS160 multi-gas sensor
> +
> +maintainers:
> +  - Gustavo Silva <gustavograzs@gmail.com>
> +
> +description: |
> +  Digital Multi-Gas Sensor for Monitoring Indoor Air Quality.
> +
> +  Datasheet:
> +    https://www.sciosense.com/wp-content/uploads/2023/12/ENS160-Datasheet.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - sciosense,ens160
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  vdd-supply: true
> +  vddio-supply: true
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      gas-sensor@52 {
> +        compatible = "sciosense,ens160";
> +        reg = <0x52>;
> +        interrupt-parent = <&gpio0>;
> +        interrupts = <19 IRQ_TYPE_EDGE_FALLING>;
> +      };
> +    };
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      gas-sensor@0 {
> +        compatible = "sciosense,ens160";
> +        reg = <0>;
> +        spi-max-frequency = <10000000>;

If you want to include this, you need to add an
allOf:
  - $ref: /schemas/spi/spi-peripheral-props.yaml#
above. Otherwise this looks pretty good, so with that added
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Thanks,
Conor.
Conor Dooley May 29, 2024, 4:37 p.m. UTC | #3
On Wed, May 29, 2024 at 05:36:38PM +0100, Conor Dooley wrote:
> > +      gas-sensor@0 {
> > +        compatible = "sciosense,ens160";
> > +        reg = <0>;
> > +        spi-max-frequency = <10000000>;
> 
> If you want to include this, you need to add an
> allOf:
>   - $ref: /schemas/spi/spi-peripheral-props.yaml#
> above. Otherwise this looks pretty good, so with that added
> Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

(Please make sure to actually test it next time!)
Gustavo Silva May 31, 2024, 10:33 p.m. UTC | #4
On Wed, May 29, 2024 at 05:37:17PM GMT, Conor Dooley wrote:
> On Wed, May 29, 2024 at 05:36:38PM +0100, Conor Dooley wrote:
> > > +      gas-sensor@0 {
> > > +        compatible = "sciosense,ens160";
> > > +        reg = <0>;
> > > +        spi-max-frequency = <10000000>;
> > 
> > If you want to include this, you need to add an
> > allOf:
> >   - $ref: /schemas/spi/spi-peripheral-props.yaml#
> > above. Otherwise this looks pretty good, so with that added
> > Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
> 
> (Please make sure to actually test it next time!)

Hi Conor,

I'll fix it in v3.
I had some trouble running the dt_binding_check target, but I got it
working now. I'll remember to run it in the future.
Thanks.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml b/Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml
new file mode 100644
index 000000000..7dd442f94
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/chemical/sciosense,ens160.yaml
@@ -0,0 +1,68 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/chemical/sciosense,ens160.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ScioSense ENS160 multi-gas sensor
+
+maintainers:
+  - Gustavo Silva <gustavograzs@gmail.com>
+
+description: |
+  Digital Multi-Gas Sensor for Monitoring Indoor Air Quality.
+
+  Datasheet:
+    https://www.sciosense.com/wp-content/uploads/2023/12/ENS160-Datasheet.pdf
+
+properties:
+  compatible:
+    enum:
+      - sciosense,ens160
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  vdd-supply: true
+  vddio-supply: true
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      gas-sensor@52 {
+        compatible = "sciosense,ens160";
+        reg = <0x52>;
+        interrupt-parent = <&gpio0>;
+        interrupts = <19 IRQ_TYPE_EDGE_FALLING>;
+      };
+    };
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      gas-sensor@0 {
+        compatible = "sciosense,ens160";
+        reg = <0>;
+        spi-max-frequency = <10000000>;
+        interrupt-parent = <&gpio>;
+        interrupts = <19 IRQ_TYPE_EDGE_FALLING>;
+      };
+    };
+
+...