From patchwork Wed Jul 8 04:07:47 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chris Ruehl X-Patchwork-Id: 11650611 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id E4ABB13B4 for ; Wed, 8 Jul 2020 04:08:00 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id D65E2206BE for ; Wed, 8 Jul 2020 04:08:00 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729082AbgGHEH5 (ORCPT ); Wed, 8 Jul 2020 00:07:57 -0400 Received: from server-x.ipv4.hkg02.ds.network ([27.111.83.178]:45412 "EHLO mail.gtsys.com.hk" rhost-flags-OK-FAIL-OK-OK) by vger.kernel.org with ESMTP id S1728401AbgGHEH4 (ORCPT ); Wed, 8 Jul 2020 00:07:56 -0400 Received: from localhost (localhost [127.0.0.1]) by mail.gtsys.com.hk (Postfix) with ESMTP id B3B8C20001F5; Wed, 8 Jul 2020 12:07:54 +0800 (HKT) X-Virus-Scanned: Debian amavisd-new at gtsys.com.hk Received: from mail.gtsys.com.hk ([127.0.0.1]) by localhost (mail.gtsys.com.hk [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 0TXAqsA29Xuz; Wed, 8 Jul 2020 12:07:54 +0800 (HKT) Received: from s01.gtsys.com.hk (unknown [10.128.4.2]) by mail.gtsys.com.hk (Postfix) with ESMTP id 99462200E20A; Wed, 8 Jul 2020 12:07:54 +0800 (HKT) Received: from armhf2.gtsys.com.hk (unknown [10.128.4.15]) by s01.gtsys.com.hk (Postfix) with ESMTP id 96052C01B68; Wed, 8 Jul 2020 12:07:54 +0800 (HKT) Received: by armhf2.gtsys.com.hk (Postfix, from userid 1000) id 91DF820031F; Wed, 8 Jul 2020 12:07:54 +0800 (HKT) From: Chris Ruehl To: Chris Ruehl Cc: Jack Lo , devicetree@vger.kernel.org, Jean Delvare , Guenter Roeck , Rob Herring , linux-hwmon@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v4 2/2] devicetree: hwmon: shtc1: Add sensirion,shtc1.yaml Date: Wed, 8 Jul 2020 12:07:47 +0800 Message-Id: <20200708040748.9014-3-chris.ruehl@gtsys.com.hk> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200708040748.9014-1-chris.ruehl@gtsys.com.hk> References: <20200708040748.9014-1-chris.ruehl@gtsys.com.hk> MIME-Version: 1.0 Sender: linux-hwmon-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-hwmon@vger.kernel.org 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 --- .../bindings/hwmon/sensirion,shtc1.yaml | 60 +++++++++++++++++++ 1 file changed, 60 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..6725a7b646b7 --- /dev/null +++ b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml @@ -0,0 +1,60 @@ +# 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: + maxItems: 1 + description: I2C address 0x70 + + sensirion,blocking_io: + $ref: /schemas/types.yaml#definitions/flag + description: + If set the i2c bus hold until measure finished. + + sensirion,low_precision: + $ref: /schemas/types.yaml#definitions/flag + description: + If set aquire data with low precision (not recommended). + The driver aquire data with high precision by default. + +required: + - compatible + - reg + +examples: + - | + i2c1 { + status = "okay"; + clock-frequency = <400000>; + + shtc3@70 { + compatible = "sensirion,shtc3"; + reg = <0x70> + sensirion,blocking_io; + status = "okay"; + }; + }; +...