| Message ID | 20200807073143.30462-3-chris.ruehl@gtsys.com.hk (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | shtc1: add support for device tree bindings | expand |
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 <chris.ruehl@gtsys.com.hk> > --- > .../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: > + - chris.ruehl@gtsys.com.hk 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 >
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: + - chris.ruehl@gtsys.com.hk + +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; + }; + }; +...
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 <chris.ruehl@gtsys.com.hk> --- .../bindings/hwmon/sensirion,shtc1.yaml | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml