Skip to contentSkip to conversation

dt-bindings: iio: chemical: Add bindings for Dynament Premier series single gas sensor

PATCH Superseded ruantu 2 participants 2 messages Dec 10, 2019 – Dec 15, 2019

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

ruantu

author
#0 lore raw

PATCH 2/2 dt-bindings: iio: chemical: Add bindings for Dynament Premier series single gas sensor

Dynament Premier series single gas sensor.

---
 .../iio/chemical/dynament,premier.yaml        | 43 +++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
 MAINTAINERS                                   |  1 +
 3 files changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml
Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml new file +43 -0
new file mode 100644
index 000000000000..076ae9d90cee
@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/chemical/dynament,premier.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Dynament Premier series single gas sensor
+
+maintainers:
+  - ruantu <[email protected]>
+
+description: |
+  single gas sensor capable of measuring gas concentration of dust
+  particles, multi-gas sensor are not supported.
+
+  Specifications about the sensor can be found at:
+    https://www.dynament.com/_webedit/uploaded-files/All%20Files/SIL%20Data/tds0045_1.44.pdf, read chapter 1.5.2 Read live data simple
+
+properties:
+  compatible:
+    enum:
+      - dynament,premier
+
+  vcc-supply:
+    description: regulator that provides power to the sensor
+
+  reset-gpios:
+    description: GPIO connected to the RESET line
+    maxItems: 1
+
+required:
+  - compatible
+
+examples:
+  - |
+    serial {
+      single-gas-sensor {
+        compatible = "dynament,premier";
+        vcc-supply = <&reg_vcc5v0>;
+      };
+    };
+
+...
Documentation/devicetree/bindings/vendor-prefixes.yaml +2 -0
index 6046f4555852..5afca0586c41 100644
@@ -261,6 +261,8 @@ patternProperties:
     description: Dragino Technology Co., Limited
   "^dserve,.*":
     description: dServe Technology B.V.
+  "^dynament,.*":
+    description: Dynament, Ltd.
   "^ea,.*":
     description: Embedded Artists AB
   "^ebs-systart,.*":
MAINTAINERS +1 -0
index 18c26558ddfe..84592789e01b 100644
@@ -13137,6 +13137,7 @@ DYNAMENT PREMIER SERIES SINGLE GAS SENSOR DRIVER
 M:	ruantu <[email protected]>
 S:	Maintained
 F:	drivers/iio/chemical/premier.c
+F:	Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml
 
 PLANTOWER PMS7003 AIR POLLUTION SENSOR DRIVER
 M:	Tomasz Duszynski <[email protected]>
Signature · 1 line
2.24.0
maintainer
#1 lore raw
Quoted 16 lines · On Tue, 10 Dec 2019 13:37:44 +0800 ruantu <[email protected]> wrote:

Dynament Premier series single gas sensor.

---
 .../iio/chemical/dynament,premier.yaml        | 43 +++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
 MAINTAINERS                                   |  1 +
 3 files changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml
Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml new file +0 -0
new file mode 100644
index 000000000000..076ae9d90cee

Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml line 1

Quoted 1 line
Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml new file +1 -0
@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: GPL-2.0

The dt maintainers are asking if possible for all new bindings to be dual licensed with BSD as it makes them easier to reuse outside linux.

Quoted 18 lines
Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml new file +18 -0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/chemical/dynament,premier.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Dynament Premier series single gas sensor
+
+maintainers:
+  - ruantu <[email protected]>
+
+description: |
+  single gas sensor capable of measuring gas concentration of dust
+  particles, multi-gas sensor are not supported.
+
+  Specifications about the sensor can be found at:
+    https://www.dynament.com/_webedit/uploaded-files/All%20Files/SIL%20Data/tds0045_1.44.pdf, read chapter 1.5.2 Read live data simple
+
+properties:

Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml line 29

Quoted 10 lines
Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml new file +10 -0
+  compatible:
+    enum:
+      - dynament,premier
+
+  vcc-supply:
+    description: regulator that provides power to the sensor
+
+  reset-gpios:
+    description: GPIO connected to the RESET line
+    maxItems: 1

Good to have the regulator and reset defined from the start. It may be worth adding the regulator enable to the driver. Reset is actually optional I assume whereas power isn't (it's just a question of whether it is already turned on or not!)

Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml line 41

Quoted 12 lines
Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml new file +12 -0
+
+required:
+  - compatible
+
+examples:
+  - |
+    serial {
+      single-gas-sensor {
+        compatible = "dynament,premier";
+        vcc-supply = <&reg_vcc5v0>;
+      };
+    };

Bindings have indented in multiples of 4 spaces I believe. That needs tidying up in this example.

Thanks,

Jonathan

Quoted 27 lines
Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml new file +2 -0
+
+...
Documentation/devicetree/bindings/vendor-prefixes.yaml +2 -0
index 6046f4555852..5afca0586c41 100644
@@ -261,6 +261,8 @@ patternProperties:
     description: Dragino Technology Co., Limited
   "^dserve,.*":
     description: dServe Technology B.V.
+  "^dynament,.*":
+    description: Dynament, Ltd.
   "^ea,.*":
     description: Embedded Artists AB
   "^ebs-systart,.*":
MAINTAINERS +1 -0
index 18c26558ddfe..84592789e01b 100644
@@ -13137,6 +13137,7 @@ DYNAMENT PREMIER SERIES SINGLE GAS SENSOR DRIVER
 M:	ruantu <[email protected]>
 S:	Maintained
 F:	drivers/iio/chemical/premier.c
+F:	Documentation/devicetree/bindings/iio/chemical/dynament,premier.yaml
 
 PLANTOWER PMS7003 AIR POLLUTION SENSOR DRIVER
 M:	Tomasz Duszynski <[email protected]>