Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Mon, 3 Dec 2018 13:16:21 +0000
From:   Jonathan Cameron <jonathan.cameron@huawei.com>
To:     Marcelo Schmitt <marcelo.schmitt1@gmail.com>
CC:     <lars@metafoo.de>, <Michael.Hennerich@analog.com>,
        <jic23@kernel.org>, <knaack.h@gmx.de>, <pmeerw@pmeerw.net>,
        <gregkh@linuxfoundation.org>, <linux-iio@vger.kernel.org>,
        <devel@driverdev.osuosl.org>, <linux-kernel@vger.kernel.org>,
        <kernel-usp@googlegroups.com>
Subject: Re: [PATCH] staging: iio: ad5933: add binding doc for ad5933
Message-ID: <20181203131621.00002a40@huawei.com>
In-Reply-To: <20181202165712.t6pd6ygq57llf2lr@smtp.gmail.com>
References: <20181202165712.t6pd6ygq57llf2lr@smtp.gmail.com>
Organization: Huawei
MIME-Version: 1.0
Content-Type: text/plain; charset="US-ASCII"
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Sun, 2 Dec 2018 14:57:12 -0200
Marcelo Schmitt <marcelo.schmitt1@gmail.com> wrote:

> Add a devicetree documentation for the ad5933 and ad5934 impedance
> converter, network analyzer.
> 
> Co-Developed-by: Gabriel Capella <gabriel@capella.pro>

Put this in line below Gabriel's sign off - it makes script
parsing of these easier.

Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.com>
Signed-off-by: Gabriel Capella <gabriel@capella.pro>
Co-Developed-by: Gabriel Capella <gabriel@capella.pro>

> 
> Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.com>
> Signed-off-by: Gabriel Capella <gabriel@capella.pro>
> ---
>  .../iio/impedance-analyzer/ad5933.txt         | 23 +++++++++++++++++++
>  1 file changed, 23 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt b/Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt
> new file mode 100644
> index 000000000000..d9ae2babf016
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt
> @@ -0,0 +1,23 @@
> +Analog Devices AD5933/AD5934 Impedance Converter, Network Analyzer
> +
> +https://www.analog.com/media/en/technical-documentation/data-sheets/AD5933.pdf
> +https://www.analog.com/media/en/technical-documentation/data-sheets/AD5934.pdf
> +
> +Required properties:
> + - compatible : should be one of
> +		"adi,ad5933"
> +		"adi,ad5934"
> + - reg : the I2C address
> + - vdd-supply : supply reference for the device.
> +
> +Optional properties:
> + - vref_mv : default voltage reference.

Regulator framework rather than a simple voltage.

> + - ext_clk_hz : external master clock for the system.

Please use the clocks framework for this rather than rolling our own.
There are fixed clocks to cover the common case, but it may be supplied by
something smarter.

> +
> +Example:
> +
> +	impedance-analyzer@0d {
> +		compatible = "adi,ad5933";
> +		reg = <0x0d>;
> +		vdd-supply = <&vdd_supply>;
> +	};