devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/2] dt-bindings: iio: dac: Add docs for AD5770R DAC
@ 2018-07-30 13:59 Mircea Caprioru
  2018-08-13 23:01 ` Rob Herring
  0 siblings, 1 reply; 2+ messages in thread
From: Mircea Caprioru @ 2018-07-30 13:59 UTC (permalink / raw)
  Cc: Mircea Caprioru, Jonathan Cameron, Hartmut Knaack,
	Lars-Peter Clausen, Peter Meerwald-Stadler, Rob Herring,
	Mark Rutland, Linus Walleij, Sedat Dilek, Rafael Aquini,
	David S. Miller, Ludovic Desroches, Florian Fainelli,
	Randy Dunlap, Kuppuswamy Sathyanarayanan, linux-iio, devicetree,
	linux-kernel

Adding dt-bindings documentation for AD5770R DAC. The bindings follow the
standard SPI and fixed regulator bindings.

Signed-off-by: Mircea Caprioru <mircea.caprioru@analog.com>
---
 .../devicetree/bindings/iio/dac/ad5770r.txt   | 86 +++++++++++++++++++
 MAINTAINERS                                   |  7 ++
 2 files changed, 93 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/dac/ad5770r.txt

diff --git a/Documentation/devicetree/bindings/iio/dac/ad5770r.txt b/Documentation/devicetree/bindings/iio/dac/ad5770r.txt
new file mode 100644
index 000000000000..bdd6ee4d5f2f
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/dac/ad5770r.txt
@@ -0,0 +1,86 @@
+Analog Devices AD5770R DAC device driver
+
+Required properties for the AD5770R:
+	- compatible: Must be "adi,ad5770r"
+	- reg: SPI chip select number for the device
+	- spi-max-frequency: Max SPI frequency to use (< 10000000, as per
+			Documentation/devicetree/bindings/spi/spi-bus.txt)
+	- child nodes: Each child node represents one channel and has
+		the following required properties:
+		* num: This represents the channel num
+		* adi,range-microamp: Output range of the channel
+		The following ranges are supported:
+		* Channel 0:
+			* <0 300000> 0 mA to 300 mA
+			* <(-60000) 0> -60 to 0 mA
+			* <(-60000) 300000> -60 to 300 mA
+		* Channel 1:
+			* <0 140000> 0 to 140 mA
+			* <0 250000> 0 to 250 mA
+		* Channel 2:
+			* <0 55000> 0 to 55 mA
+			* <0 150000> 0 to 150 mA
+		* Channel 3 to Channel 5:
+			* <0 45000> 0 to 45 mA
+			* <0 100000> 0 to 100 mA
+
+Optional properties:
+
+- vref: Specify the voltage of the external reference used.
+		Available reference options are: 1.25 V or 2.5 V. If no
+		external reference declared then the device will use the
+		internal reference of 1.25 V.
+
+- reset-gpios: GPIO spec for the RESET pin. If specified, it will be
+		asserted during driver probe.
+
+AD5770R Example:
+
+	ad5770r@0 {
+		compatible = "ad5770r";
+		reg = <0>;
+                spi-max-frequency = <1000000>;
+		vref-supply = <&vref>;
+
+		reset-gpios = <&gpio 22 0>;
+
+		channel@0 {
+			num = <0>;
+			adi,range-microamp = <0 300000>;
+		};
+
+		channel@1 {
+			num = <1>;
+			adi,range-microamp = <0 140000>;
+		};
+
+		channel@2 {
+			num = <2>;
+			adi,range-microamp = <0 55000>;
+		};
+
+		channel@3 {
+			num = <3>;
+			adi,range-microamp = <0 45000>;
+		};
+
+		channel@4 {
+			num = <4>;
+			adi,range-microamp = <0 45000>;
+		};
+
+		channel@5 {
+			num = <5>;
+			adi,range-microamp = <0 45000>;
+		};
+       };
+
+External reference example:
+
+	vref: fixedregulator@0 {
+		compatible = "regulator-fixed";
+		regulator-name = "fixed-supply";
+		regulator-min-microvolt = <1250000>;
+		regulator-max-microvolt = <1250000>;
+	};
+
diff --git a/MAINTAINERS b/MAINTAINERS
index 6f7721d1634c..9c2626079592 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -756,6 +756,13 @@ M:	Michael Hanselmann <linux-kernel@hansmi.ch>
 S:	Supported
 F:	drivers/macintosh/ams/
 
+ANALOG DEVICES INC AD5770R DRIVER
+M:	Mircea Caprioru <mircea.caprioru@analog.com>
+L:	linux-iio@vger.kernel.org
+W:	http://ez.analog.com/community/linux-device-drivers
+S:	Supported
+F:	Documentation/devicetree/bindings/iio/dac/ad5770r.txt
+
 ANALOG DEVICES INC AD9389B DRIVER
 M:	Hans Verkuil <hans.verkuil@cisco.com>
 L:	linux-media@vger.kernel.org
-- 
2.17.1

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH 1/2] dt-bindings: iio: dac: Add docs for AD5770R DAC
  2018-07-30 13:59 [PATCH 1/2] dt-bindings: iio: dac: Add docs for AD5770R DAC Mircea Caprioru
@ 2018-08-13 23:01 ` Rob Herring
  0 siblings, 0 replies; 2+ messages in thread
From: Rob Herring @ 2018-08-13 23:01 UTC (permalink / raw)
  To: Mircea Caprioru
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Mark Rutland, Linus Walleij, Sedat Dilek,
	Rafael Aquini, David S. Miller, Ludovic Desroches,
	Florian Fainelli, Randy Dunlap, Kuppuswamy Sathyanarayanan,
	linux-iio, devicetree, linux-kernel

On Mon, Jul 30, 2018 at 04:59:55PM +0300, Mircea Caprioru wrote:
> Adding dt-bindings documentation for AD5770R DAC. The bindings follow the
> standard SPI and fixed regulator bindings.
> 
> Signed-off-by: Mircea Caprioru <mircea.caprioru@analog.com>
> ---
>  .../devicetree/bindings/iio/dac/ad5770r.txt   | 86 +++++++++++++++++++

Preferred filename is matching compatible string if there's only 1 
compatible string.

>  MAINTAINERS                                   |  7 ++
>  2 files changed, 93 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/dac/ad5770r.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/dac/ad5770r.txt b/Documentation/devicetree/bindings/iio/dac/ad5770r.txt
> new file mode 100644
> index 000000000000..bdd6ee4d5f2f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/dac/ad5770r.txt
> @@ -0,0 +1,86 @@
> +Analog Devices AD5770R DAC device driver

Bindings aren't device drivers...

> +
> +Required properties for the AD5770R:
> +	- compatible: Must be "adi,ad5770r"
> +	- reg: SPI chip select number for the device
> +	- spi-max-frequency: Max SPI frequency to use (< 10000000, as per
> +			Documentation/devicetree/bindings/spi/spi-bus.txt)
> +	- child nodes: Each child node represents one channel and has
> +		the following required properties:
> +		* num: This represents the channel num

Use reg instead.

> +		* adi,range-microamp: Output range of the channel
> +		The following ranges are supported:
> +		* Channel 0:
> +			* <0 300000> 0 mA to 300 mA
> +			* <(-60000) 0> -60 to 0 mA
> +			* <(-60000) 300000> -60 to 300 mA
> +		* Channel 1:
> +			* <0 140000> 0 to 140 mA
> +			* <0 250000> 0 to 250 mA
> +		* Channel 2:
> +			* <0 55000> 0 to 55 mA
> +			* <0 150000> 0 to 150 mA
> +		* Channel 3 to Channel 5:
> +			* <0 45000> 0 to 45 mA
> +			* <0 100000> 0 to 100 mA
> +
> +Optional properties:
> +
> +- vref: Specify the voltage of the external reference used.
> +		Available reference options are: 1.25 V or 2.5 V. If no
> +		external reference declared then the device will use the
> +		internal reference of 1.25 V.

This should be updated to vref-supply.

> +
> +- reset-gpios: GPIO spec for the RESET pin. If specified, it will be
> +		asserted during driver probe.

Driver probe is not relevant to the binding. 
> +
> +AD5770R Example:
> +
> +	ad5770r@0 {

dac@0

> +		compatible = "ad5770r";
> +		reg = <0>;
> +                spi-max-frequency = <1000000>;

Some whitespace problems here.

> +		vref-supply = <&vref>;
> +
> +		reset-gpios = <&gpio 22 0>;
> +
> +		channel@0 {
> +			num = <0>;
> +			adi,range-microamp = <0 300000>;
> +		};
> +
> +		channel@1 {
> +			num = <1>;
> +			adi,range-microamp = <0 140000>;
> +		};
> +
> +		channel@2 {
> +			num = <2>;
> +			adi,range-microamp = <0 55000>;
> +		};
> +
> +		channel@3 {
> +			num = <3>;
> +			adi,range-microamp = <0 45000>;
> +		};
> +
> +		channel@4 {
> +			num = <4>;
> +			adi,range-microamp = <0 45000>;
> +		};
> +
> +		channel@5 {
> +			num = <5>;
> +			adi,range-microamp = <0 45000>;
> +		};
> +       };
> +
> +External reference example:
> +
> +	vref: fixedregulator@0 {

Unit-address should be dropped (no reg property here).

> +		compatible = "regulator-fixed";
> +		regulator-name = "fixed-supply";
> +		regulator-min-microvolt = <1250000>;
> +		regulator-max-microvolt = <1250000>;
> +	};
> +
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 6f7721d1634c..9c2626079592 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -756,6 +756,13 @@ M:	Michael Hanselmann <linux-kernel@hansmi.ch>
>  S:	Supported
>  F:	drivers/macintosh/ams/
>  
> +ANALOG DEVICES INC AD5770R DRIVER
> +M:	Mircea Caprioru <mircea.caprioru@analog.com>
> +L:	linux-iio@vger.kernel.org
> +W:	http://ez.analog.com/community/linux-device-drivers
> +S:	Supported
> +F:	Documentation/devicetree/bindings/iio/dac/ad5770r.txt
> +
>  ANALOG DEVICES INC AD9389B DRIVER
>  M:	Hans Verkuil <hans.verkuil@cisco.com>
>  L:	linux-media@vger.kernel.org
> -- 
> 2.17.1
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2018-08-13 23:01 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-07-30 13:59 [PATCH 1/2] dt-bindings: iio: dac: Add docs for AD5770R DAC Mircea Caprioru
2018-08-13 23:01 ` Rob Herring

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).