On 7/7/20 8:34 PM, Chris Ruehl wrote: > Hi Guenter, > > On 7/7/2020 9:35 pm, Guenter Roeck wrote: >> On Tue, Jul 07, 2020 at 04:01:03PM +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. >>> >>> Signed-off-by: Chris Ruehl <chris.ruehl@xxxxxxxxxxxx> >>> --- >>> .../bindings/hwmon/sensirion,shtc1.yaml | 53 +++++++++++++++++++ >>> 1 file changed, 53 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..bcccdcadd86b >>> --- /dev/null >>> +++ b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml >>> @@ -0,0 +1,53 @@ >>> +# 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: >>> + - jdelvare@xxxxxxxx >> >> Did Jean agree to maintain this file ? > > I thought its OK to set the maintainer from the list shown with > get_maintainer.pl here. I don't mind take care of this file - there will be small changes only in case the dt-schema change and requires updates. > No, it isn't. Jean and I are the maintainers for the hwmon subsystem, but that doesn't mean or suggest that we should be listed as maintainers in individual files. > I put me here, if that is acceptable. > Either you, or none. Thanks, Guenter > Chris > >> >>> + >>> +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: I2C address 0x70 >>> + >>> +Optional properties: >>> + sensirion,blocking_io: | >>> + bool, if set the i2c bus hold until measure finished >>> + sensirion,low_precision: | >>> + bool, if set aquire data with low precision (not recommend) >> >> recommended >> >> It might make sense to mention that the default is expected to be high precision >> if not specified. >> >>> + >>> +required: >>> + - compatible >>> + - reg >>> + >>> +additionalProperties: false >>> + >>> +Example: >>> + &i2c1 { >>> + status = "okay"; >>> + clock-frequency = <400000>; >>> + >>> + shtc3@70 { >>> + compatible = "sensirion,shtc3"; >>> + reg = <0x70> >>> + sensirion,blocking_io; >>> + status = "okay"; >>> + }; >>> + }; >>> -- >>> 2.20.1 >>> >
