diff mbox series

[v2,1/3] dt-bindings: iio/adc: Add docs for Ingenic JZ47xx SoCs ADC.

Message ID 20190204001514.29891-1-contact@artur-rojek.eu (mailing list archive)
State New, archived
Headers show
Series [v2,1/3] dt-bindings: iio/adc: Add docs for Ingenic JZ47xx SoCs ADC. | expand

Commit Message

Artur Rojek Feb. 4, 2019, 12:15 a.m. UTC
Add documentation for the ADC controller on JZ47xx SoCs,
used by the ingenic-adc driver.

Signed-off-by: Artur Rojek <contact@artur-rojek.eu>
---

 Changes:

 v2: change a typo ',' into ';' in battery example

 .../bindings/iio/adc/ingenic,adc.txt          | 48 +++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt

Comments

Jonathan Cameron Feb. 9, 2019, 3:38 p.m. UTC | #1
On Mon,  4 Feb 2019 01:15:12 +0100
Artur Rojek <contact@artur-rojek.eu> wrote:

> Add documentation for the ADC controller on JZ47xx SoCs,
> used by the ingenic-adc driver.
> 
> Signed-off-by: Artur Rojek <contact@artur-rojek.eu>

Hi,

This one seems simple enough and entirely standard that I'll take
it without a dt review.  As ever one is welcome, but feels like
it would be wasting Rob / Mark or anyone elses time!

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

Thanks,

Jonathan

> ---
> 
>  Changes:
> 
>  v2: change a typo ',' into ';' in battery example
> 
>  .../bindings/iio/adc/ingenic,adc.txt          | 48 +++++++++++++++++++
>  1 file changed, 48 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt b/Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt
> new file mode 100644
> index 000000000000..f01159f20d87
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt
> @@ -0,0 +1,48 @@
> +* Ingenic JZ47xx ADC controller IIO bindings
> +
> +Required properties:
> +
> +- compatible: Should be one of:
> +  * ingenic,jz4725b-adc
> +  * ingenic,jz4740-adc
> +- reg: ADC controller registers location and length.
> +- clocks: phandle to the SoC's ADC clock.
> +- clock-names: Must be set to "adc".
> +- #io-channel-cells: Must be set to <1> to indicate channels are selected
> +  by index.
> +
> +ADC clients must use the format described in iio-bindings.txt, giving
> +a phandle and IIO specifier pair ("io-channels") to the ADC controller.
> +
> +Example:
> +
> +#include <dt-bindings/iio/adc/ingenic,adc.h>
> +
> +adc: adc@10070000 {
> +	compatible = "ingenic,jz4740-adc";
> +	#io-channel-cells = <1>;
> +
> +	reg = <0x10070000 0x30>;
> +
> +	clocks = <&cgu JZ4740_CLK_ADC>;
> +	clock-names = "adc";
> +
> +	interrupt-parent = <&intc>;
> +	interrupts = <18>;
> +};
> +
> +adc-keys {
> +	...
> +	compatible = "adc-keys";
> +	io-channels = <&adc INGENIC_ADC_AUX>;
> +	io-channel-names = "buttons";
> +	...
> +};
> +
> +battery {
> +	...
> +	compatible = "ingenic,jz4740-battery";
> +	io-channels = <&adc INGENIC_ADC_BATTERY>;
> +	io-channel-names = "battery";
> +	...
> +};
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt b/Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt
new file mode 100644
index 000000000000..f01159f20d87
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/ingenic,adc.txt
@@ -0,0 +1,48 @@ 
+* Ingenic JZ47xx ADC controller IIO bindings
+
+Required properties:
+
+- compatible: Should be one of:
+  * ingenic,jz4725b-adc
+  * ingenic,jz4740-adc
+- reg: ADC controller registers location and length.
+- clocks: phandle to the SoC's ADC clock.
+- clock-names: Must be set to "adc".
+- #io-channel-cells: Must be set to <1> to indicate channels are selected
+  by index.
+
+ADC clients must use the format described in iio-bindings.txt, giving
+a phandle and IIO specifier pair ("io-channels") to the ADC controller.
+
+Example:
+
+#include <dt-bindings/iio/adc/ingenic,adc.h>
+
+adc: adc@10070000 {
+	compatible = "ingenic,jz4740-adc";
+	#io-channel-cells = <1>;
+
+	reg = <0x10070000 0x30>;
+
+	clocks = <&cgu JZ4740_CLK_ADC>;
+	clock-names = "adc";
+
+	interrupt-parent = <&intc>;
+	interrupts = <18>;
+};
+
+adc-keys {
+	...
+	compatible = "adc-keys";
+	io-channels = <&adc INGENIC_ADC_AUX>;
+	io-channel-names = "buttons";
+	...
+};
+
+battery {
+	...
+	compatible = "ingenic,jz4740-battery";
+	io-channels = <&adc INGENIC_ADC_BATTERY>;
+	io-channel-names = "battery";
+	...
+};