Re: [PATCH v3 2/2] devicetree: hwmon: shtc1: Add sensirion,shtc1.yaml

[Guenter Roeck]

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
>>>
>