linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alexandru Ardelean <alexandru.ardelean@analog.com>
To: <linux-iio@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Cc: <jic23@kernel.org>, Alexandru Ardelean <alexandru.ardelean@analog.com>
Subject: [PATCH v2 5/7] dt-bindings: iio: adc: add bindings doc for AXI ADC driver
Date: Wed, 26 Feb 2020 17:08:33 +0200	[thread overview]
Message-ID: <20200226150835.19649-6-alexandru.ardelean@analog.com> (raw)
In-Reply-To: <20200226150835.19649-1-alexandru.ardelean@analog.com>

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

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..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@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>;
+        };
+    };
+...
-- 
2.20.1


  parent reply	other threads:[~2020-02-26 15:05 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-26 15:08 [PATCH v2 0/7] iio: adi-axi-adc,ad9647: Add support for AD9467 ADC Alexandru Ardelean
2020-02-26 15:08 ` [PATCH v2 1/7] include: fpga: adi-axi-common.h: fixup whitespace tab -> space Alexandru Ardelean
2020-02-26 15:08 ` [PATCH v2 2/7] include: fpga: adi-axi-common.h: add version helper macros Alexandru Ardelean
2020-02-26 15:08 ` [PATCH v2 3/7] iio: buffer-dmaengine: add dev-managed calls for buffer alloc Alexandru Ardelean
2020-02-26 15:08 ` [PATCH v2 4/7] iio: adc: adi-axi-adc: add support for AXI ADC IP core Alexandru Ardelean
2020-02-26 23:02   ` kbuild test robot
2020-02-27  7:01     ` Ardelean, Alexandru
2020-02-26 15:08 ` Alexandru Ardelean [this message]
2020-02-27  7:06   ` [PATCH v2 5/7] dt-bindings: iio: adc: add bindings doc for AXI ADC driver Ardelean, Alexandru
2020-02-26 15:08 ` [PATCH v2 6/7] iio: adc: ad9467: add support AD9467 ADC Alexandru Ardelean
2020-02-26 15:08 ` [PATCH v2 7/7] dt-bindings: iio: adc: add bindings doc for " Alexandru Ardelean

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200226150835.19649-6-alexandru.ardelean@analog.com \
    --to=alexandru.ardelean@analog.com \
    --cc=jic23@kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).