linux-kernel - Re: [PATCH v2 5/7] dt-bindings: iio: adc: add bindings doc for AXI ADC driver

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <bae96d470b4c1db7f1289866975913278e3b8ad1.camel@analog.com>
Date:   Thu, 27 Feb 2020 07:06:10 +0000
From:   "Ardelean, Alexandru" <alexandru.Ardelean@...log.com>
To:     "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        "linux-iio@...r.kernel.org" <linux-iio@...r.kernel.org>
CC:     "jic23@...nel.org" <jic23@...nel.org>,
        "robh+dt@...nel.org" <robh+dt@...nel.org>
Subject: Re: [PATCH v2 5/7] dt-bindings: iio: adc: add bindings doc for AXI
 ADC driver

On Wed, 2020-02-26 at 17:08 +0200, Alexandru Ardelean wrote:
> [External]
> 
> This change adds the bindings documentation for the AXI ADC driver.
> 
> Signed-off-by: Alexandru Ardelean <alexandru.ardelean@...log.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
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,axi-adc.yaml
> b/Documentation/devicetree/bindings/iio/adc/adi,axi-adc.yaml

I just had a thought.
Since the driver name is now called adi-axi-adc.c, maybe it's a good idea to
also change this to adi-axi-adc.yaml

> new file mode 100644
> index 000000000000..65ffd337cd2f
> --- /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@...log.com>
> +  - Alexandru Ardelean <alexandru.ardelean@...log.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:

Maybe one for Rob here.
[ I also noticed that I forgot to add the DT list; will do that on V3 ]

The reason I named this field 'adi-axi-adc-client' and not 'adi,axi-adc-client'
is because I would get:

Documentation/devicetree/bindings/iio/adc/adi,axi-adc.yaml: properties:adi,axi-
adc-client: {'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,axi-adc-client: 'not' is a required property

make[1]: *** [Documentation/devicetree/bindings/Makefile:12:
Documentation/devicetree/bindings/iio/adc/adi,axi-adc.example.dts] Error 1


> +    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@...00000 {
> +          compatible = "adi,axi-adc-10.0.a";
> +          reg = <0x44a00000 0x10000>;
> +          dmas = <&rx_dma 0>;
> +          dma-names = "rx";
> +
> +          adi-axi-adc-client = <&spi_adc>;
> +        };
> +    };
> +...