diff mbox series

[3/3] staging: iio: ad5933: add binding doc for ad5933

Message ID 348cbe2abbe256b66ed830bd1abb9fc50bf4d10e.1544292845.git.marcelo.schmitt1@gmail.com (mailing list archive)
State New, archived
Headers show
Series Add devicetree support for ad5933 | expand

Commit Message

Marcelo Schmitt Dec. 8, 2018, 6:19 p.m. UTC
Add a devicetree documentation for the ad5933 and ad5934 impedance
converter, network analyzer.

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>
---
 .../iio/impedance-analyzer/ad5933.txt         | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt

Comments

Jonathan Cameron Dec. 10, 2018, 9:27 p.m. UTC | #1
On Sat, 8 Dec 2018 16:19:59 -0200
Marcelo Schmitt <marcelo.schmitt1@gmail.com> wrote:

> Add a devicetree documentation for the ad5933 and ad5934 impedance
> converter, network analyzer.
> 
> 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>
Device tree binding patches need to also go to the DT maintainers and list
for review.

This looks fine to me but they are the specialists in these!

+cc Rob, Mark and DT list.

Jonathan
> ---
>  .../iio/impedance-analyzer/ad5933.txt         | 26 +++++++++++++++++++
>  1 file changed, 26 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..5ff38728ff91
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt
> @@ -0,0 +1,26 @@
> +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 : The regulator supply for DVDD, AVDD1 and AVDD2 when they
> +   are connected together.
> +
> +Optional properties:
> +- clocks : external clock reference.
> +- clock-names : must be "mclk" if clocks is set.
> +
> +Example for a I2C device node:
> +
> +	impedance-analyzer@0d {
> +		compatible = "adi,adxl345";
> +		reg = <0x0d>;
> +		vdd-supply = <&vdd_supply>;
> +		clocks = <&ref_clk>;
> +		clock-names = "mclk";
> +	};
Jonathan Cameron Dec. 16, 2018, 12:16 p.m. UTC | #2
On Mon, 10 Dec 2018 21:27:02 +0000
Jonathan Cameron <jic23@kernel.org> wrote:

> On Sat, 8 Dec 2018 16:19:59 -0200
> Marcelo Schmitt <marcelo.schmitt1@gmail.com> wrote:
> 
> > Add a devicetree documentation for the ad5933 and ad5934 impedance
> > converter, network analyzer.
> > 
> > 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>  
> Device tree binding patches need to also go to the DT maintainers and list
> for review.
> 
> This looks fine to me but they are the specialists in these!
> 
> +cc Rob, Mark and DT list.

Long enough I think.  This will be in my tree in a fashion I can rebase for
a week or so anyway so please still feel free to comment.

Applied to the togreg branch of iio.git and pushed out as testing for
the autobuilders to play with it.

Thanks,

Jonathan
> 
> Jonathan
> > ---
> >  .../iio/impedance-analyzer/ad5933.txt         | 26 +++++++++++++++++++
> >  1 file changed, 26 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..5ff38728ff91
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt
> > @@ -0,0 +1,26 @@
> > +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 : The regulator supply for DVDD, AVDD1 and AVDD2 when they
> > +   are connected together.
> > +
> > +Optional properties:
> > +- clocks : external clock reference.
> > +- clock-names : must be "mclk" if clocks is set.
> > +
> > +Example for a I2C device node:
> > +
> > +	impedance-analyzer@0d {
> > +		compatible = "adi,adxl345";
> > +		reg = <0x0d>;
> > +		vdd-supply = <&vdd_supply>;
> > +		clocks = <&ref_clk>;
> > +		clock-names = "mclk";
> > +	};  
>
diff mbox series

Patch

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..5ff38728ff91
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/impedance-analyzer/ad5933.txt
@@ -0,0 +1,26 @@ 
+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 : The regulator supply for DVDD, AVDD1 and AVDD2 when they
+   are connected together.
+
+Optional properties:
+- clocks : external clock reference.
+- clock-names : must be "mclk" if clocks is set.
+
+Example for a I2C device node:
+
+	impedance-analyzer@0d {
+		compatible = "adi,adxl345";
+		reg = <0x0d>;
+		vdd-supply = <&vdd_supply>;
+		clocks = <&ref_clk>;
+		clock-names = "mclk";
+	};