Add support for DTS bindings to the shtc driver
The patches add the compatible table and of_property_read_bool to the
shtc1.c. Newly created Yaml document has been released to the
Documentation/devicetree/hwmon/sensirion,shtc1.yaml
Signed-off-by: Chris Ruehl <[email protected]>
---
Version 7
make dt_binding_check warings, missing #address-cells, #size-cells in example
dtschema-2020.7.dev3+g8fd8ce7
Version 6
fix dt_binding_check: missing ';' in examples
Version 5
devicetree/driver-source: name conversion sensirion,low-precision sensirion,blocking-io
use const: 0x70 with the reg:
Version 4
Fix errors report by make dt_binding_check (devicetree)
Set maintainers for the yaml document to my own.
Version 3
Fix errors report with checkpatch.pl
Correct logic, add (!) when check for sensirion,low_precision
Version 2
remove the #ifdef CONFIG_OF
ignore platform data if dev->of_node is valid
use boolean only therefor use sensirion,low_precise to fit the logic
add missing driver.of_match_table entry
Version 1
initial version
Add documentation for the newly added DTS support in the shtc1 driver.
To align with the drivers logic to have high precision by default
a boolean sensirion,low_precision is used to switch to low precision.
Signed-off-by: Chris Ruehl <[email protected]>
---
.../bindings/hwmon/sensirion,shtc1.yaml | 59 +++++++++++++++++++
1 file changed, 59 insertions(+)
create mode 100644 Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
diff --git a/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
new file mode 100644
index 000000000000..41cc59b0b0e3
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/sensirion,shtc1.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sensirion SHTC1 Humidity and Temperature Sensor IC
+
+maintainers:
+ - [email protected]
+
+description: |
+ The SHTC1, SHTW1 and SHTC3 are digital humidity and temperature sensor
+ designed especially for battery-driven high-volume consumer electronics
+ applications.
+ For further information refere to Documentation/hwmon/shtc1.rst
+
+ This binding document describes the binding for the hardware monitor
+ portion of the driver.
+
+properties:
+ compatible:
+ enum:
+ - sensirion,shtc1
+ - sensirion,shtw1
+ - sensirion,shtc3
+
+ reg:
+ const: 0x70
+
+ sensirion,blocking-io:
+ $ref: /schemas/types.yaml#definitions/flag
+ description:
+ If set, the driver hold the i2c bus until measurement is finished.
+
+ sensirion,low-precision:
+ $ref: /schemas/types.yaml#definitions/flag
+ description:
+ If set, the sensor aquire data with low precision (not recommended).
+ The driver aquire data with high precision by default.
+
+required:
+ - compatible
+ - reg
+
+examples:
+ - |
+ i2c1 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ clock-frequency = <400000>;
+
+ shtc3@70 {
+ compatible = "sensirion,shtc3";
+ reg = <0x70>;
+ sensirion,blocking-io;
+ };
+ };
+...
--
2.20.1
On Fri, Aug 07, 2020 at 03:31:43PM +0800, Chris Ruehl wrote:
> Add documentation for the newly added DTS support in the shtc1 driver.
> To align with the drivers logic to have high precision by default
> a boolean sensirion,low_precision is used to switch to low precision.
low-precision
>
> Signed-off-by: Chris Ruehl <[email protected]>
> ---
> .../bindings/hwmon/sensirion,shtc1.yaml | 59 +++++++++++++++++++
> 1 file changed, 59 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
>
> diff --git a/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
> new file mode 100644
> index 000000000000..41cc59b0b0e3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
> @@ -0,0 +1,59 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/hwmon/sensirion,shtc1.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Sensirion SHTC1 Humidity and Temperature Sensor IC
> +
> +maintainers:
> + - [email protected]
Full name too please.
> +
> +description: |
> + The SHTC1, SHTW1 and SHTC3 are digital humidity and temperature sensor
> + designed especially for battery-driven high-volume consumer electronics
> + applications.
> + For further information refere to Documentation/hwmon/shtc1.rst
> +
> + This binding document describes the binding for the hardware monitor
> + portion of the driver.
> +
> +properties:
> + compatible:
> + enum:
> + - sensirion,shtc1
> + - sensirion,shtw1
> + - sensirion,shtc3
> +
> + reg:
> + const: 0x70
> +
> + sensirion,blocking-io:
> + $ref: /schemas/types.yaml#definitions/flag
> + description:
> + If set, the driver hold the i2c bus until measurement is finished.
> +
> + sensirion,low-precision:
> + $ref: /schemas/types.yaml#definitions/flag
> + description:
> + If set, the sensor aquire data with low precision (not recommended).
> + The driver aquire data with high precision by default.
> +
> +required:
> + - compatible
> + - reg
Add:
additionalProperties: false
> +
> +examples:
> + - |
> + i2c1 {
i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + clock-frequency = <400000>;
> +
> + shtc3@70 {
> + compatible = "sensirion,shtc3";
> + reg = <0x70>;
> + sensirion,blocking-io;
> + };
> + };
> +...
> --
> 2.20.1
>