diff mbox series

[v3,6/8] dt-bindings: iio: adc: add bindings doc for AXI ADC driver

Message ID 20200227082719.6343-7-alexandru.ardelean@analog.com (mailing list archive)
State New, archived
Headers show
Series ] iio: adi-axi-adc,ad9647: Add support for AD9467 ADC | expand

Commit Message

Alexandru Ardelean Feb. 27, 2020, 8:27 a.m. UTC 
This change adds the bindings documentation for the AXI ADC driver.

Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
---
 .../bindings/iio/adc/adi-axi-adc.yaml         | 69 +++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml

Comments

Rob Herring March 3, 2020, 4:53 p.m. UTC | #1 
On Thu, Feb 27, 2020 at 10:27:17AM +0200, Alexandru Ardelean wrote:
> This change adds the bindings documentation for the AXI ADC driver.
> 
> Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
> ---
>  .../bindings/iio/adc/adi-axi-adc.yaml         | 69 +++++++++++++++++++

Follow the compatible string: adi,axi-adc.yaml 

>  1 file changed, 69 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> new file mode 100644
> index 000000000000..d45d41f4f08e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> @@ -0,0 +1,69 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/adi-axi-adc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices AXI ADC IP core
> +
> +maintainers:
> +  - Michael Hennerich <michael.hennerich@analog.com>
> +  - Alexandru Ardelean <alexandru.ardelean@analog.com>
> +
> +description: |
> +  Analog Devices Generic AXI ADC IP core for interfacing an ADC device
> +  with a high speed serial (JESD204B/C) or source synchronous parallel
> +  interface (LVDS/CMOS).
> +  Usually, some other interface type (i.e SPI) is used as a control
> +  interface for the actual ADC, while this IP core will interface
> +  to the data-lines of the ADC and handle the streaming of data into
> +  memory via DMA.
> +
> +  https://wiki.analog.com/resources/fpga/docs/axi_adc_ip
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,axi-adc-10.0.a
> +
> +  reg:
> +    maxItems: 1
> +
> +  dmas:
> +    minItems: 1
> +    maxItems: 1

Just maxItems is enough.

> +
> +  dma-names:
> +    maxItems: 1
> +    items:
> +      - const: rx
> +
> +  adi-axi-adc-client:

adi,axi-adc-client

Though I think 'adi,adc-dev' would be better name.

> +    description:
> +      A reference to a the actual ADC to which this FPGA ADC interfaces to.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - dmas
> +  - reg
> +  - adi-axi-adc-client
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    fpga_axi {

You can drop this node.

> +        #address-cells = <1>;
> +        #size-cells = <1>;
> +
> +        axi-adc@44a00000 {
> +          compatible = "adi,axi-adc-10.0.a";
> +          reg = <0x44a00000 0x10000>;
> +          dmas = <&rx_dma 0>;
> +          dma-names = "rx";
> +
> +          adi-axi-adc-client = <&spi_adc>;
> +        };
> +    };
> +...
> -- 
> 2.20.1
>
Alexandru Ardelean March 4, 2020, 7:55 a.m. UTC | #2 
On Tue, 2020-03-03 at 10:53 -0600, Rob Herring wrote:
> On Thu, Feb 27, 2020 at 10:27:17AM +0200, Alexandru Ardelean wrote:
> > This change adds the bindings documentation for the AXI ADC driver.
> > 
> > Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
> > ---
> >  .../bindings/iio/adc/adi-axi-adc.yaml         | 69 +++++++++++++++++++
> 
> Follow the compatible string: adi,axi-adc.yaml 

ack

> 
> >  1 file changed, 69 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/adc/adi-axi-
> > adc.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> > b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> > new file mode 100644
> > index 000000000000..d45d41f4f08e
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> > @@ -0,0 +1,69 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/adc/adi-axi-adc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Analog Devices AXI ADC IP core
> > +
> > +maintainers:
> > +  - Michael Hennerich <michael.hennerich@analog.com>
> > +  - Alexandru Ardelean <alexandru.ardelean@analog.com>
> > +
> > +description: |
> > +  Analog Devices Generic AXI ADC IP core for interfacing an ADC device
> > +  with a high speed serial (JESD204B/C) or source synchronous parallel
> > +  interface (LVDS/CMOS).
> > +  Usually, some other interface type (i.e SPI) is used as a control
> > +  interface for the actual ADC, while this IP core will interface
> > +  to the data-lines of the ADC and handle the streaming of data into
> > +  memory via DMA.
> > +
> > +  https://wiki.analog.com/resources/fpga/docs/axi_adc_ip
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - adi,axi-adc-10.0.a
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  dmas:
> > +    minItems: 1
> > +    maxItems: 1
> 
> Just maxItems is enough.

ack

> 
> > +
> > +  dma-names:
> > +    maxItems: 1
> > +    items:
> > +      - const: rx
> > +
> > +  adi-axi-adc-client:
> 
> adi,axi-adc-client
> 
> Though I think 'adi,adc-dev' would be better name.

works for me
one question though; this still gives:

  CHKDT   Documentation/devicetree/bindings/iio/adc/adi,axi-adc.yaml
/home/sandu/work/linux/upstream/Documentation/devicetree/bindings/iio/adc/adi,ax
i-adc.yaml: properties:adi,adc-dev: {'description': 'A reference to a the actual
ADC to which this FPGA ADC interfaces to.', 'maxItems': 1} is not valid under
any of the given schemas (Possible causes of the failure):
	/home/sandu/work/linux/upstream/Documentation/devicetree/bindings/iio/ad
c/adi,axi-adc.yaml: properties:adi,adc-dev: 'not' is a required property


Any thoughts?


> 
> > +    description:
> > +      A reference to a the actual ADC to which this FPGA ADC interfaces to.
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - dmas
> > +  - reg
> > +  - adi-axi-adc-client
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    fpga_axi {
> 
> You can drop this node.

ack

> 
> > +        #address-cells = <1>;
> > +        #size-cells = <1>;
> > +
> > +        axi-adc@44a00000 {
> > +          compatible = "adi,axi-adc-10.0.a";
> > +          reg = <0x44a00000 0x10000>;
> > +          dmas = <&rx_dma 0>;
> > +          dma-names = "rx";
> > +
> > +          adi-axi-adc-client = <&spi_adc>;
> > +        };
> > +    };
> > +...
> > -- 
> > 2.20.1
> >
Rob Herring March 4, 2020, 4:18 p.m. UTC | #3 
On Wed, Mar 4, 2020 at 1:55 AM Ardelean, Alexandru
<alexandru.Ardelean@analog.com> wrote:
>
> On Tue, 2020-03-03 at 10:53 -0600, Rob Herring wrote:
> > On Thu, Feb 27, 2020 at 10:27:17AM +0200, Alexandru Ardelean wrote:
> > > This change adds the bindings documentation for the AXI ADC driver.
> > >
> > > Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
> > > ---
> > >  .../bindings/iio/adc/adi-axi-adc.yaml         | 69 +++++++++++++++++++
> >
> > Follow the compatible string: adi,axi-adc.yaml
>
> ack
>
> >
> > >  1 file changed, 69 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/iio/adc/adi-axi-
> > > adc.yaml
> > >
> > > diff --git a/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> > > b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> > > new file mode 100644
> > > index 000000000000..d45d41f4f08e
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
> > > @@ -0,0 +1,69 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/iio/adc/adi-axi-adc.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Analog Devices AXI ADC IP core
> > > +
> > > +maintainers:
> > > +  - Michael Hennerich <michael.hennerich@analog.com>
> > > +  - Alexandru Ardelean <alexandru.ardelean@analog.com>
> > > +
> > > +description: |
> > > +  Analog Devices Generic AXI ADC IP core for interfacing an ADC device
> > > +  with a high speed serial (JESD204B/C) or source synchronous parallel
> > > +  interface (LVDS/CMOS).
> > > +  Usually, some other interface type (i.e SPI) is used as a control
> > > +  interface for the actual ADC, while this IP core will interface
> > > +  to the data-lines of the ADC and handle the streaming of data into
> > > +  memory via DMA.
> > > +
> > > +  https://wiki.analog.com/resources/fpga/docs/axi_adc_ip
> > > +
> > > +properties:
> > > +  compatible:
> > > +    enum:
> > > +      - adi,axi-adc-10.0.a
> > > +
> > > +  reg:
> > > +    maxItems: 1
> > > +
> > > +  dmas:
> > > +    minItems: 1
> > > +    maxItems: 1
> >
> > Just maxItems is enough.
>
> ack
>
> >
> > > +
> > > +  dma-names:
> > > +    maxItems: 1
> > > +    items:
> > > +      - const: rx
> > > +
> > > +  adi-axi-adc-client:
> >
> > adi,axi-adc-client
> >
> > Though I think 'adi,adc-dev' would be better name.
>
> works for me
> one question though; this still gives:
>
>   CHKDT   Documentation/devicetree/bindings/iio/adc/adi,axi-adc.yaml
> /home/sandu/work/linux/upstream/Documentation/devicetree/bindings/iio/adc/adi,ax
> i-adc.yaml: properties:adi,adc-dev: {'description': 'A reference to a the actual
> ADC to which this FPGA ADC interfaces to.', 'maxItems': 1} is not valid under
> any of the given schemas (Possible causes of the failure):
>         /home/sandu/work/linux/upstream/Documentation/devicetree/bindings/iio/ad
> c/adi,axi-adc.yaml: properties:adi,adc-dev: 'not' is a required property

Yes, not the most helpful errors I know. You need a type reference and
'maxItems' should be dropped.

$ref: /schemas/types.yaml#/definitions/phandle

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
new file mode 100644
index 000000000000..d45d41f4f08e
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/adi-axi-adc.yaml
@@ -0,0 +1,69 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi-axi-adc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AXI ADC IP core
+
+maintainers:
+  - Michael Hennerich <michael.hennerich@analog.com>
+  - Alexandru Ardelean <alexandru.ardelean@analog.com>
+
+description: |
+  Analog Devices Generic AXI ADC IP core for interfacing an ADC device
+  with a high speed serial (JESD204B/C) or source synchronous parallel
+  interface (LVDS/CMOS).
+  Usually, some other interface type (i.e SPI) is used as a control
+  interface for the actual ADC, while this IP core will interface
+  to the data-lines of the ADC and handle the streaming of data into
+  memory via DMA.
+
+  https://wiki.analog.com/resources/fpga/docs/axi_adc_ip
+
+properties:
+  compatible:
+    enum:
+      - adi,axi-adc-10.0.a
+
+  reg:
+    maxItems: 1
+
+  dmas:
+    minItems: 1
+    maxItems: 1
+
+  dma-names:
+    maxItems: 1
+    items:
+      - const: rx
+
+  adi-axi-adc-client:
+    description:
+      A reference to a the actual ADC to which this FPGA ADC interfaces to.
+    maxItems: 1
+
+required:
+  - compatible
+  - dmas
+  - reg
+  - adi-axi-adc-client
+
+additionalProperties: false
+
+examples:
+  - |
+    fpga_axi {
+        #address-cells = <1>;
+        #size-cells = <1>;
+
+        axi-adc@44a00000 {
+          compatible = "adi,axi-adc-10.0.a";
+          reg = <0x44a00000 0x10000>;
+          dmas = <&rx_dma 0>;
+          dma-names = "rx";
+
+          adi-axi-adc-client = <&spi_adc>;
+        };
+    };
+...