Message ID | 20210820133821.159239-2-jacopo@jmondi.org |
---|---|
State | Superseded |
Headers | show |
Series | [v2,1/3] dt-bindings: iio: chemical: Document senseair,sunrise CO2 sensor | expand |
On Fri, Aug 20, 2021 at 02:46:12PM -0500, Rob Herring wrote: > On Fri, 20 Aug 2021 15:38:19 +0200, Jacopo Mondi wrote: > > Add documentation for the Senseair Sunrise 006-0-0007 CO2 NDIR sensor. > > > > Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> > > --- > > v1->v2: > > - Add maxItems to -gpios properties as suggested by Rob > > - Add a label to the device node in the example as suggested by Rob > > Labels cannot contain '-'. I'll make this sunrise: co2-sensor@68 My bad and sorry for not running dt_binding_check, I thought the changes were trivial enough. Thanks j > > --- > > .../iio/chemical/senseair,sunrise.yaml | 53 +++++++++++++++++++ > > .../devicetree/bindings/vendor-prefixes.yaml | 2 + > > 2 files changed, 55 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.yaml > > > > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' > on your patch (DT_CHECKER_FLAGS is new in v5.13): > > yamllint warnings/errors: > > dtschema/dtc warnings/errors: > Error: Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.example.dts:23.21-22 syntax error > FATAL ERROR: Unable to parse input tree > make[1]: *** [scripts/Makefile.lib:380: Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.example.dt.yaml] Error 1 > make[1]: *** Waiting for unfinished jobs.... > make: *** [Makefile:1419: dt_binding_check] Error 2 > > doc reference errors (make refcheckdocs): > > See https://patchwork.ozlabs.org/patch/1519042 > > This check can fail if there are any dependencies. The base for a patch > series is generally the most recent rc1. > > 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. >
On Sun, 22 Aug 2021 18:04:44 +0200 Jacopo Mondi <jacopo@jmondi.org> wrote: > On Fri, Aug 20, 2021 at 02:46:12PM -0500, Rob Herring wrote: > > On Fri, 20 Aug 2021 15:38:19 +0200, Jacopo Mondi wrote: > > > Add documentation for the Senseair Sunrise 006-0-0007 CO2 NDIR sensor. > > > > > > Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> > > > --- > > > v1->v2: > > > - Add maxItems to -gpios properties as suggested by Rob > > > - Add a label to the device node in the example as suggested by Rob > > > > > Labels cannot contain '-'. > > I'll make this > > sunrise: co2-sensor@68 Why label at all? Might be handy on a real board, but example doesn't need it. Jonathan > > My bad and sorry for not running dt_binding_check, I thought the > changes were trivial enough. > > Thanks > j > > > > --- > > > .../iio/chemical/senseair,sunrise.yaml | 53 +++++++++++++++++++ > > > .../devicetree/bindings/vendor-prefixes.yaml | 2 + > > > 2 files changed, 55 insertions(+) > > > create mode 100644 Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.yaml > > > > > > > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' > > on your patch (DT_CHECKER_FLAGS is new in v5.13): > > > > yamllint warnings/errors: > > > > dtschema/dtc warnings/errors: > > Error: Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.example.dts:23.21-22 syntax error > > FATAL ERROR: Unable to parse input tree > > make[1]: *** [scripts/Makefile.lib:380: Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.example.dt.yaml] Error 1 > > make[1]: *** Waiting for unfinished jobs.... > > make: *** [Makefile:1419: dt_binding_check] Error 2 > > > > doc reference errors (make refcheckdocs): > > > > See https://patchwork.ozlabs.org/patch/1519042 > > > > This check can fail if there are any dependencies. The base for a patch > > series is generally the most recent rc1. > > > > 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. > >
diff --git a/Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.yaml b/Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.yaml new file mode 100644 index 000000000000..d776adcb0117 --- /dev/null +++ b/Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.yaml @@ -0,0 +1,53 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/chemical/senseair,sunrise.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Senseair Sunrise 006-0-0007 CO2 Sensor + +maintainers: + - Jacopo Mondi <jacopo@jmondi.org> + +description: | + Senseair Sunrise 006-0-0007 is a NDIR CO2 sensor. It supports I2C or UART buses + for communications and control. + + Datasheets: + https://rmtplusstoragesenseair.blob.core.windows.net/docs/Dev/publicerat/PSP11704.pdf + https://rmtplusstoragesenseair.blob.core.windows.net/docs/Dev/publicerat/PSH11649.pdf + https://rmtplusstoragesenseair.blob.core.windows.net/docs/Dev/publicerat/TDE5531.pdf + https://rmtplusstoragesenseair.blob.core.windows.net/docs/Market/publicerat/TDE7318.pdf + +properties: + compatible: + const: senseair,sunrise-006-0-0007 + + reg: + maxItems: 1 + + ndry-gpios: + maxItems: 1 + description: Phandle to the GPIO line connected to the nDRY pin. Active low. + + en-gpios: + maxItems: 1 + description: Phandle to the GPIO line connected to the EN pin. Active high. + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + i2c { + #address-cells = <1>; + #size-cells = <0>; + + co2-sensor: sunrise@68 { + compatible = "senseair,sunrise-006-0-0007"; + reg = <0x68>; + }; + }; diff --git a/Documentation/devicetree/bindings/vendor-prefixes.yaml b/Documentation/devicetree/bindings/vendor-prefixes.yaml index 944a14926e02..c60502eb3d36 100644 --- a/Documentation/devicetree/bindings/vendor-prefixes.yaml +++ b/Documentation/devicetree/bindings/vendor-prefixes.yaml @@ -1000,6 +1000,8 @@ patternProperties: description: Shenzhen SEI Robotics Co., Ltd "^semtech,.*": description: Semtech Corporation + "^senseair,.*": + description: Senseair AB "^sensirion,.*": description: Sensirion AG "^sensortek,.*":
Add documentation for the Senseair Sunrise 006-0-0007 CO2 NDIR sensor. Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> --- v1->v2: - Add maxItems to -gpios properties as suggested by Rob - Add a label to the device node in the example as suggested by Rob --- .../iio/chemical/senseair,sunrise.yaml | 53 +++++++++++++++++++ .../devicetree/bindings/vendor-prefixes.yaml | 2 + 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.yaml -- 2.32.0