From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 41D86C43217 for ; Tue, 15 Nov 2022 17:44:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231953AbiKORoA convert rfc822-to-8bit (ORCPT ); Tue, 15 Nov 2022 12:44:00 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:43106 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229633AbiKORn7 (ORCPT ); Tue, 15 Nov 2022 12:43:59 -0500 Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A1AC9F65; Tue, 15 Nov 2022 09:43:58 -0800 (PST) Received: from frapeml100007.china.huawei.com (unknown [172.18.147.206]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4NBYQ524BCz687Rd; Wed, 16 Nov 2022 01:41:33 +0800 (CST) Received: from lhrpeml500005.china.huawei.com (7.191.163.240) by frapeml100007.china.huawei.com (7.182.85.133) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.31; Tue, 15 Nov 2022 18:43:56 +0100 Received: from localhost (10.202.227.76) by lhrpeml500005.china.huawei.com (7.191.163.240) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.31; Tue, 15 Nov 2022 17:43:56 +0000 Date: Tue, 15 Nov 2022 17:43:55 +0000 From: Jonathan Cameron To: Gerald Loacker CC: , , , Jonathan Cameron , Lars-Peter Clausen , Rob Herring , Krzysztof Kozlowski , Andy Shevchenko , Nikita Yushchenko , Jakob Hauser , Michael Riesch Subject: Re: [PATCH 1/2] dt-bindings: iio: magnetometer: add ti tmag5273 documentation file Message-ID: <20221115174355.00004a01@Huawei.com> In-Reply-To: <20221115073718.2377311-2-gerald.loacker@wolfvision.net> References: <20221115073718.2377311-1-gerald.loacker@wolfvision.net> <20221115073718.2377311-2-gerald.loacker@wolfvision.net> Organization: Huawei Technologies Research and Development (UK) Ltd. X-Mailer: Claws Mail 4.1.0 (GTK 3.24.33; x86_64-w64-mingw32) MIME-Version: 1.0 Content-Type: text/plain; charset="ISO-8859-1" Content-Transfer-Encoding: 8BIT X-Originating-IP: [10.202.227.76] X-ClientProxiedBy: lhrpeml500004.china.huawei.com (7.191.163.9) To lhrpeml500005.china.huawei.com (7.191.163.240) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org On Tue, 15 Nov 2022 08:37:17 +0100 Gerald Loacker wrote: > Add bindings documentation file for TI TMAG5273. > > Signed-off-by: Gerald Loacker > --- > .../iio/magnetometer/ti,tmag5273.yaml | 72 +++++++++++++++++++ > MAINTAINERS | 6 ++ > 2 files changed, 78 insertions(+) > create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml > > diff --git a/Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml b/Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml > new file mode 100644 > index 000000000000..2f5b0a4d2f40 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml > @@ -0,0 +1,72 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/magnetometer/ti,tmag5273.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor > + > +maintainers: > + - Gerald Loacker > + > +description: > + The TI TMAG5273 is a low-power linear 3D Hall-effect sensor. This device > + integrates three independent Hall-effect sensors in the X, Y, and Z axes. > + The device has an integrated temperature sensor available. The TMAG5273 > + can be configured through the I2C interface to enable any combination of > + magnetic axes and temperature measurements. An integrated angle calculation > + engine (CORDIC) provides full 360° angular position information for both > + on-axis and off-axis angle measurement topologies. The angle calculation is > + performed using two user-selected magnetic axes. > + > +properties: > + $nodename: > + pattern: '^magnetometer@[0-9a-f]+$' What Krzysztof said on this ;) > + > + compatible: > + const: ti,tmag5273 > + > + reg: > + maxItems: 1 > + > + "#io-channel-cells": > + const: 1 > + > + ti,angle-enable: > + description: > + Enables angle measurement in the selected plane. > + 0 = OFF > + 1 = X-Y (default) > + 2 = Y-Z > + 3 = X-Z This feels like something we should be configuring at runtime rather that DT, or is it driven by board design or similar? > + $ref: /schemas/types.yaml#/definitions/uint32 > + minimum: 0 > + maximum: 3 > + > + vcc-supply: > + description: > + A regulator providing 1.7 V to 3.6 V supply voltage on the VCC pin, > + typically 3.3 V. > + The dt binding should attempt to describe the hardware, not what we happen to support in the driver so far. So I'd expect to also see an interrupt. That way if someone ships a dts file today, and we enable it sometime in the future they will be ready for it. > +required: > + - compatible > + - reg > + - vcc-supply Ah. This is presumably as side effect of having the driver set the voltage. Normally we only need to 'require' a supply if we need to read it's voltage (for scaling on ADCs and similar). That's not the case here so I wouldn't expect to see it. > + > +additionalProperties: false > + > +examples: > + - | > + i2c-0 { > + #address-cells = <1>; > + #size-cells = <0>; > + > + magnetometer@35 { > + compatible = "ti,tmag5273"; > + reg = <0x35>; > + #io-channel-cells = <1>; > + ti,angle-enable = <3>; > + vcc-supply = <&vcc3v3>; > + }; > + }; > +...