diff mbox series

[v1,1/2] dt-binding: iio: add NPCM ADC documentation

Message ID 20181224164755.286932-2-tmaimon77@gmail.com
State Accepted, archived
Headers show
Series iio: adc: npcm: add NPCm ADC driver | expand

Commit Message

Tomer Maimon Dec. 24, 2018, 4:47 p.m. UTC
Added device tree binding documentation for Nuvoton BMC
NPCM Analog-to-Digital Converter(ADC).

Signed-off-by: Tomer Maimon <tmaimon77@gmail.com>
---
 .../bindings/iio/adc/nuvoton,npcm-adc.txt          | 35 ++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt

Comments

Rob Herring Jan. 3, 2019, 9:14 p.m. UTC | #1
On Mon, Dec 24, 2018 at 06:47:54PM +0200, Tomer Maimon wrote:
> Added device tree binding documentation for Nuvoton BMC
> NPCM Analog-to-Digital Converter(ADC).
> 
> Signed-off-by: Tomer Maimon <tmaimon77@gmail.com>
> ---
>  .../bindings/iio/adc/nuvoton,npcm-adc.txt          | 35 ++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> new file mode 100644
> index 000000000000..6f0843d837cc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> @@ -0,0 +1,35 @@
> +Nuvoton NPCM Analog to Digital Converter (ADC)
> +
> +The NPCM ADC is a 10-bit converter for eight channel inputs.
> +
> +Required properties:
> +- compatible	: "nuvoton,npcm750-adc" for the NPCM7XX BMC.
> +- reg			: specifies physical base address and size of the registers.
> +- interrupts	: Contain the ADC interrupt with flags for falling edge.
> +
> +Optional properties:
> +- clocks		: phandle of ADC reference clock, in case the clock is not
> +				  added the ADC will use the default ADC sample rate.
> +- vref-supply	: The regulator supply ADC reference voltage, in case the
> +				  vref-supply is not added the ADC will use internal voltage
> +				  reference.
> +
> +Required Node in the NPCM7xx BMC:
> +An additional register is present in the NPCM7xx SOC which is
> +assumed to be in the same device tree, with and marked as
> +compatible with "nuvoton,npcm750-rst".
> +
> +Example:
> +
> +adc: adc@f000c000 {
> +	compatible = "nuvoton,npcm750-adc";
> +	reg = <0xf000c000 0x8>;
> +	interrupts = <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>;
> +	clocks = <&clk NPCM7XX_CLK_ADC>;
> +};
> +
> +rst: rst@f0801000 {

Why is this node here?

> +	compatible = "nuvoton,npcm750-rst", "syscon",
> +	"simple-mfd";
> +	reg = <0xf0801000 0x6C>;
> +};
> -- 
> 2.14.1
>
Jonathan Cameron Jan. 5, 2019, 4:57 p.m. UTC | #2
On Mon, 24 Dec 2018 18:47:54 +0200
Tomer Maimon <tmaimon77@gmail.com> wrote:

> Added device tree binding documentation for Nuvoton BMC
> NPCM Analog-to-Digital Converter(ADC).
> 
> Signed-off-by: Tomer Maimon <tmaimon77@gmail.com>
> ---
>  .../bindings/iio/adc/nuvoton,npcm-adc.txt          | 35 ++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> new file mode 100644
> index 000000000000..6f0843d837cc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> @@ -0,0 +1,35 @@
> +Nuvoton NPCM Analog to Digital Converter (ADC)
> +
> +The NPCM ADC is a 10-bit converter for eight channel inputs.
> +
> +Required properties:
> +- compatible	: "nuvoton,npcm750-adc" for the NPCM7XX BMC.
> +- reg			: specifies physical base address and size of the registers.
Something a bit crazy with the indentation here!

> +- interrupts	: Contain the ADC interrupt with flags for falling edge.
> +
> +Optional properties:
> +- clocks		: phandle of ADC reference clock, in case the clock is not
> +				  added the ADC will use the default ADC sample rate.
> +- vref-supply	: The regulator supply ADC reference voltage, in case the
> +				  vref-supply is not added the ADC will use internal voltage
> +				  reference.
> +
> +Required Node in the NPCM7xx BMC:
> +An additional register is present in the NPCM7xx SOC which is
> +assumed to be in the same device tree, with and marked as
> +compatible with "nuvoton,npcm750-rst".
> +
> +Example:
> +
> +adc: adc@f000c000 {
> +	compatible = "nuvoton,npcm750-adc";
> +	reg = <0xf000c000 0x8>;
> +	interrupts = <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>;
> +	clocks = <&clk NPCM7XX_CLK_ADC>;
> +};
> +
> +rst: rst@f0801000 {
> +	compatible = "nuvoton,npcm750-rst", "syscon",
> +	"simple-mfd";
> +	reg = <0xf0801000 0x6C>;
> +};
Tomer Maimon Jan. 9, 2019, 4:48 p.m. UTC | #3
Hi Rob,

On Thu, 3 Jan 2019 at 23:14, Rob Herring <robh@kernel.org> wrote:

> On Mon, Dec 24, 2018 at 06:47:54PM +0200, Tomer Maimon wrote:
> > Added device tree binding documentation for Nuvoton BMC
> > NPCM Analog-to-Digital Converter(ADC).
> >
> > Signed-off-by: Tomer Maimon <tmaimon77@gmail.com>
> > ---
> >  .../bindings/iio/adc/nuvoton,npcm-adc.txt          | 35
> ++++++++++++++++++++++
> >  1 file changed, 35 insertions(+)
> >  create mode 100644
> Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> >
> > diff --git
> a/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> > new file mode 100644
> > index 000000000000..6f0843d837cc
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
> > @@ -0,0 +1,35 @@
> > +Nuvoton NPCM Analog to Digital Converter (ADC)
> > +
> > +The NPCM ADC is a 10-bit converter for eight channel inputs.
> > +
> > +Required properties:
> > +- compatible : "nuvoton,npcm750-adc" for the NPCM7XX BMC.
> > +- reg                        : specifies physical base address and size
> of the registers.
> > +- interrupts : Contain the ADC interrupt with flags for falling edge.
> > +
> > +Optional properties:
> > +- clocks             : phandle of ADC reference clock, in case the
> clock is not
> > +                               added the ADC will use the default ADC
> sample rate.
> > +- vref-supply        : The regulator supply ADC reference voltage, in
> case the
> > +                               vref-supply is not added the ADC will
> use internal voltage
> > +                               reference.
> > +
> > +Required Node in the NPCM7xx BMC:
> > +An additional register is present in the NPCM7xx SOC which is
> > +assumed to be in the same device tree, with and marked as
> > +compatible with "nuvoton,npcm750-rst".
> > +
> > +Example:
> > +
> > +adc: adc@f000c000 {
> > +     compatible = "nuvoton,npcm750-adc";
> > +     reg = <0xf000c000 0x8>;
> > +     interrupts = <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>;
> > +     clocks = <&clk NPCM7XX_CLK_ADC>;
> > +};
> > +
> > +rst: rst@f0801000 {
>
> Why is this node here?
>
example for the reset node that required when using NPCM7xx SOC.
(Required Node in the NPCM7xx BMC:
An additional register is present in the NPCM7xx SOC which is
assumed to be in the same device tree, with and marked as
compatible with "nuvoton,npcm750-rst")

>
> > +     compatible = "nuvoton,npcm750-rst", "syscon",
> > +     "simple-mfd";
> > +     reg = <0xf0801000 0x6C>;
> > +};
> > --
> > 2.14.1
> >
>

Thanks,

Tomer
<div dir="ltr"><div dir="ltr"></div>Hi Rob,<div><br></div><div><div class="gmail_quote"><div dir="ltr">On Thu, 3 Jan 2019 at 23:14, Rob Herring &lt;<a href="mailto:robh@kernel.org">robh@kernel.org</a>&gt; wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On Mon, Dec 24, 2018 at 06:47:54PM +0200, Tomer Maimon wrote:<br>
&gt; Added device tree binding documentation for Nuvoton BMC<br>
&gt; NPCM Analog-to-Digital Converter(ADC).<br>
&gt; <br>
&gt; Signed-off-by: Tomer Maimon &lt;<a href="mailto:tmaimon77@gmail.com" target="_blank">tmaimon77@gmail.com</a>&gt;<br>
&gt; ---<br>
&gt;  .../bindings/iio/adc/nuvoton,npcm-adc.txt          | 35 ++++++++++++++++++++++<br>
&gt;  1 file changed, 35 insertions(+)<br>
&gt;  create mode 100644 Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt<br>
&gt; <br>
&gt; diff --git a/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt<br>
&gt; new file mode 100644<br>
&gt; index 000000000000..6f0843d837cc<br>
&gt; --- /dev/null<br>
&gt; +++ b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt<br>
&gt; @@ -0,0 +1,35 @@<br>
&gt; +Nuvoton NPCM Analog to Digital Converter (ADC)<br>
&gt; +<br>
&gt; +The NPCM ADC is a 10-bit converter for eight channel inputs.<br>
&gt; +<br>
&gt; +Required properties:<br>
&gt; +- compatible : &quot;nuvoton,npcm750-adc&quot; for the NPCM7XX BMC.<br>
&gt; +- reg                        : specifies physical base address and size of the registers.<br>
&gt; +- interrupts : Contain the ADC interrupt with flags for falling edge.<br>
&gt; +<br>
&gt; +Optional properties:<br>
&gt; +- clocks             : phandle of ADC reference clock, in case the clock is not<br>
&gt; +                               added the ADC will use the default ADC sample rate.<br>
&gt; +- vref-supply        : The regulator supply ADC reference voltage, in case the<br>
&gt; +                               vref-supply is not added the ADC will use internal voltage<br>
&gt; +                               reference.<br>
&gt; +<br>
&gt; +Required Node in the NPCM7xx BMC:<br>
&gt; +An additional register is present in the NPCM7xx SOC which is<br>
&gt; +assumed to be in the same device tree, with and marked as<br>
&gt; +compatible with &quot;nuvoton,npcm750-rst&quot;.<br>
&gt; +<br>
&gt; +Example:<br>
&gt; +<br>
&gt; +adc: adc@f000c000 {<br>
&gt; +     compatible = &quot;nuvoton,npcm750-adc&quot;;<br>
&gt; +     reg = &lt;0xf000c000 0x8&gt;;<br>
&gt; +     interrupts = &lt;GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH&gt;;<br>
&gt; +     clocks = &lt;&amp;clk NPCM7XX_CLK_ADC&gt;;<br>
&gt; +};<br>
&gt; +<br>
&gt; +rst: rst@f0801000 {<br>
<br>
Why is this node here?<br></blockquote><div>example for the reset node that required when using NPCM7xx SOC.</div><div>(Required Node in the NPCM7xx BMC:</div>An additional register is present in the NPCM7xx SOC which is<br>assumed to be in the same device tree, with and marked as<br>compatible with &quot;nuvoton,npcm750-rst&quot;)<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
&gt; +     compatible = &quot;nuvoton,npcm750-rst&quot;, &quot;syscon&quot;,<br>
&gt; +     &quot;simple-mfd&quot;;<br>
&gt; +     reg = &lt;0xf0801000 0x6C&gt;;<br>
&gt; +};<br>
&gt; -- <br>
&gt; 2.14.1<br>
&gt; <br></blockquote><div><br></div><div>Thanks,</div><div><br></div><div>Tomer </div></div></div></div>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
new file mode 100644
index 000000000000..6f0843d837cc
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/nuvoton,npcm-adc.txt
@@ -0,0 +1,35 @@ 
+Nuvoton NPCM Analog to Digital Converter (ADC)
+
+The NPCM ADC is a 10-bit converter for eight channel inputs.
+
+Required properties:
+- compatible	: "nuvoton,npcm750-adc" for the NPCM7XX BMC.
+- reg			: specifies physical base address and size of the registers.
+- interrupts	: Contain the ADC interrupt with flags for falling edge.
+
+Optional properties:
+- clocks		: phandle of ADC reference clock, in case the clock is not
+				  added the ADC will use the default ADC sample rate.
+- vref-supply	: The regulator supply ADC reference voltage, in case the
+				  vref-supply is not added the ADC will use internal voltage
+				  reference.
+
+Required Node in the NPCM7xx BMC:
+An additional register is present in the NPCM7xx SOC which is
+assumed to be in the same device tree, with and marked as
+compatible with "nuvoton,npcm750-rst".
+
+Example:
+
+adc: adc@f000c000 {
+	compatible = "nuvoton,npcm750-adc";
+	reg = <0xf000c000 0x8>;
+	interrupts = <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>;
+	clocks = <&clk NPCM7XX_CLK_ADC>;
+};
+
+rst: rst@f0801000 {
+	compatible = "nuvoton,npcm750-rst", "syscon",
+	"simple-mfd";
+	reg = <0xf0801000 0x6C>;
+};