devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Wen He <wen.he_1@nxp.com>
To: vkoul@kernel.org, dmaengine@vger.kernel.org
Cc: robh+dt@kernel.org, devicetree@vger.kernel.org,
	leoyang.li@nxp.com, jiafei.pan@nxp.com, jiaheng.fan@nxp.com,
	wen.he_1@nxp.com
Subject: [v5 3/6] dt-bindings: fsl-qdma: Add NXP Layerscpae qDMA controller bindings
Date: Fri, 25 May 2018 19:19:17 +0800	[thread overview]
Message-ID: <20180525111920.24498-3-wen.he_1@nxp.com> (raw)
In-Reply-To: <20180525111920.24498-1-wen.he_1@nxp.com>

Document the devicetree bindings for NXP Layerscape qDMA controller
which could be found on NXP QorIQ Layerscape SoCs.

Signed-off-by: Wen He <wen.he_1@nxp.com>
---
change in v5:
	- Replace dts node variable 'queues' to 'fsl,queues' that add vendor prefix

change in v4:
	- Rewrite the bindings document that follows generic DMA bindings file

change in v3:
	- no change

change in v2:
	- Remove indentation
	- Add "Should be" before 'fsl,ls1021a-qdma'
	- Replace 'channels' by 'dma-channels'
	- Replace 'qdma@8390000' by 'dma-controller@8390000'

 Documentation/devicetree/bindings/dma/fsl-qdma.txt |   41 ++++++++++++++++++++
 1 files changed, 41 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/dma/fsl-qdma.txt

diff --git a/Documentation/devicetree/bindings/dma/fsl-qdma.txt b/Documentation/devicetree/bindings/dma/fsl-qdma.txt
new file mode 100644
index 0000000..99b3d74
--- /dev/null
+++ b/Documentation/devicetree/bindings/dma/fsl-qdma.txt
@@ -0,0 +1,41 @@
+NXP Layerscape SoC qDMA Controller
+==================================
+
+This device follows the generic DMA bindings defined in dma/dma.txt.
+
+Required properties:
+
+- compatible:		Must be one of
+			 "fsl,ls1021a-qdma": for LS1021A Board
+			 "fsl,ls1043a-qdma": for ls1043A Board
+			 "fsl,ls1046a-qdma": for ls1046A Board
+- reg:			Should contain the register's base address and length.
+- interrupts:		Should contain a reference to the interrupt used by this
+			device.
+- interrupt-names:	Should contain interrupt names:
+			 "qdma-error": the error interrupt
+			 "qdma-queue": the queue interrupt
+- fsl,queues:		Should contain number of queues supported.
+
+Optional properties:
+
+- dma-channels:		Number of DMA channels supported by the controller.
+- big-endian:		If present registers and hardware scatter/gather descriptors
+			of the qDMA are implemented in big endian mode, otherwise in little
+			mode.
+
+Examples:
+
+	qdma: dma-controller@8390000 {
+		compatible = "fsl,ls1021a-qdma";
+		reg = <0x0 0x8398000 0x0 0x2000 /* Controller registers */
+		       0x0 0x839a000 0x0 0x2000>; /* Block registers */
+		interrupts = <GIC_SPI 185 IRQ_TYPE_LEVEL_HIGH>,
+				<GIC_SPI 76 IRQ_TYPE_LEVEL_HIGH>;
+		interrupt-names = "qdma-error", "qdma-queue";
+		dma-channels = <8>;
+		queues = <2>;
+		big-endian;
+	};
+
+DMA clients must use the format described in dma/dma.txt file.
-- 
1.7.1

  parent reply	other threads:[~2018-05-25 11:19 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-25 11:19 [v5 1/6] dmaengine: fsldma: Replace DMA_IN/OUT by FSL_DMA_IN/OUT Wen He
2018-05-25 11:19 ` [v5 2/6] dmaengine: fsl-qdma: Add qDMA controller driver for Layerscape SoCs Wen He
2018-05-29  7:07   ` Vinod
2018-05-29  9:59     ` Wen He
2018-05-29 10:19       ` Vinod
2018-05-29 10:38         ` Wen He
2018-05-30 10:27           ` Vinod Koul
2018-05-31  1:58             ` Wen He
2018-06-05 16:28               ` Vinod
2018-06-11  8:14                 ` Wen He
2018-06-14  2:15                   ` Wen He
2018-06-14  7:26                     ` Vinod
2018-05-30 18:51   ` Li Yang
2018-06-04  9:53     ` Wen He
2018-06-05 16:30       ` Vinod
2018-06-05 17:24         ` Li Yang
2018-06-12  4:00           ` Vinod
2018-06-12 16:32             ` Li Yang
2018-05-25 11:19 ` Wen He [this message]
2018-05-31  0:49   ` [v5 3/6] dt-bindings: fsl-qdma: Add NXP Layerscpae qDMA controller bindings Rob Herring
2018-05-25 11:19 ` [v5 4/6] arm64: dts: ls1043a: add qdma device tree nodes Wen He
2018-05-25 11:19 ` [v5 5/6] arm64: dts: ls1046a: " Wen He
2018-05-25 11:19 ` [v5 6/6] arm: dts: ls1021a: " Wen He
2018-05-29  4:49 ` [v5 1/6] dmaengine: fsldma: Replace DMA_IN/OUT by FSL_DMA_IN/OUT Vinod
2018-05-29 10:14   ` Wen He
2018-05-29 10:21     ` Vinod
2018-05-29 10:22       ` Wen He

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=20180525111920.24498-3-wen.he_1@nxp.com \
    --to=wen.he_1@nxp.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dmaengine@vger.kernel.org \
    --cc=jiafei.pan@nxp.com \
    --cc=jiaheng.fan@nxp.com \
    --cc=leoyang.li@nxp.com \
    --cc=robh+dt@kernel.org \
    --cc=vkoul@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).