linuxppc-dev.lists.ozlabs.org archive mirror
 help / color / mirror / Atom feed
From: Liu Gang <Gang.Liu@freescale.com>
To: <linuxppc-dev@lists.ozlabs.org>
Cc: Jin Qing <b24347@freescale.com>,
	r58472@freescale.com, r61911@freescale.com,
	linux-kernel@vger.kernel.org, Liu Gang <Gang.Liu@freescale.com>,
	akpm@linux-foundation.org, B11780@freescale.com
Subject: [PATCH 4/4] powerpc/fsl: Document rapidio node binding-information
Date: Thu, 29 Sep 2011 10:29:01 +0800	[thread overview]
Message-ID: <1317263341-19010-4-git-send-email-Gang.Liu@freescale.com> (raw)
In-Reply-To: <1317263341-19010-1-git-send-email-Gang.Liu@freescale.com>

This document is created for powerpc rapidio and rmu nodes in dts file. These nodes
can support two rapidio ports and message units. In addition, It explicates the properties
and gives examples about rapidio and rmu nodes.

Signed-off-by: Li Yang <leoli@freescale.com>
Signed-off-by: Jin Qing <b24347@freescale.com>
Signed-off-by: Liu Gang <Gang.Liu@freescale.com>
---
 .../devicetree/bindings/powerpc/fsl/srio.txt       |   85 ++++++++++++++++++++
 1 files changed, 85 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/powerpc/fsl/srio.txt

diff --git a/Documentation/devicetree/bindings/powerpc/fsl/srio.txt b/Documentation/devicetree/bindings/powerpc/fsl/srio.txt
new file mode 100644
index 0000000..01f2da1
--- /dev/null
+++ b/Documentation/devicetree/bindings/powerpc/fsl/srio.txt
@@ -0,0 +1,85 @@
+* Freescale Rapidio Controller
+
+Rapidio port node:
+Properties:
+	- compatible: "fsl,rapidio-delta".
+	  "fsl,rapidio-delta" should be listed for any chip whose rapidio controller is compatible.
+	  At first, rapidio controller was introduced with the version of delta and has no revision
+	  register. Rapidio driver and controller were matched by "fsl,rapidio-delta". After the
+	  addition of two revision registers in rapidio controller, we can read some revision and
+	  configuration information about rapidio controller IP block, and the compatible with
+	  "fsl,rapidio-delta" was still used.
+
+	- reg: For devices compatible with "fsl,rapidio-delta", should contain the address and
+	  the length about all the rapidio controller's registers.
+
+	- ranges: Should be defined according to the u-boot settings about SRIO. Describe the memory
+	  mapped I/O space used by the rapidio controller.
+
+	- interrupts: Interrupt mapping for rapidio IRQ. Three interrupts in the group, and starting
+	  with SRIO error/port-write IRQ, an error interrupt and with interrupt type 1. The other
+	  two interrupts are doorbell outbound IRQ and doorbell inbound IRQ, and they are external
+	  interrupts.
+
+	- fsl,rio-num-ports: The number of rapidio ports supported by this controller.
+
+	- fsl,liodn: The logical I/O device number for the PAMU to be correctly configured for SRIO
+	  accesses. This property is added in SRIO node by u-boot and usually used by hypervisor.
+	  The number of elements may either be 2 or 4 LIODN values. For HW that only supports LIODNs
+	  for ALL memory & maintenance transactions we have 2 cells. For HW that has separate LIODNs
+	  for memory & maintenance transaction we utilize 4 cells.
+
+	- rmu-handle: The phandle for the rmu connected to this rapidio controller.
+
+Example:
+
+	rapidio: rapidio@ffe0c0000 {
+		#address-cells = <2>;
+		#size-cells = <2>;
+		compatible = "fsl,rapidio-delta";
+		interrupts = <
+			16 2 1 11 /* err_irq */
+			56 2 0 0  /* bell_outb_irq */
+			57 2 0 0>;/* bell_inb_irq */
+		fsl,rio-num-ports = <2>;
+		rmu-handle = <&rmu>;
+	};
+
+Message unit node:
+Properties:
+	- compatible: "fsl,rmu".
+	  "fsl,rmu" should be listed for any chip whose message unit is compatible. In addition,
+	  RMAN will replace RMU for rapidio message transaction in some chips using DPAA architecture.
+	  Then instead of RMU node, RMAN node will be used in dts file and the compatible property
+	  "fsl,rmu" should be replaced.
+
+	- reg: Registers mapping for message unit.
+
+	- interrupts: Interrupt mapping for message unit controller. Every message
+	  unit controller has two external interrupts: message outbound IRQ and
+	  message inbound IRQ.
+
+	- fsl,liodn: The logical I/O device number for rmuliodnr and added by u-boot.
+
+Example:
+
+	rmu: rmu@d3000 {
+		fsl,liodn = <0xc8>;
+		#address-cells = <1>;
+		#size-cells = <1>;
+		compatible = "fsl,rmu";
+		reg = <0xd3000 0x200>;
+
+		message-unit@0 {
+		reg = <0x0 0x100>;
+		interrupts = <
+			60 2 0 0  /* msg1_tx_irq */
+			61 2 0 0>;/* msg1_rx_irq */
+		};
+		message-unit@1 {
+		reg = <0x100 0x100>;
+		interrupts = <
+			62 2 0 0  /* msg2_tx_irq */
+			63 2 0 0>;/* msg2_rx_irq */
+		};
+	};
-- 
1.7.3.1

  parent reply	other threads:[~2011-09-29  2:30 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-09-29  2:28 [PATCH 1/4] fsl-rio: Split rio driver into two parts, RapidIO endpoint and RapidIO message unit Liu Gang
2011-09-29  2:28 ` [PATCH 2/4] fsl-rio: Add two ports and rapidio message units support Liu Gang
2011-09-29  2:29 ` [PATCH 3/4] p4080ds-dts: Add two rapidio ports and " Liu Gang
2011-09-29 14:22   ` Kumar Gala
2011-09-29 14:23   ` Kumar Gala
2011-09-29  2:29 ` Liu Gang [this message]
2011-09-29 14:20   ` [PATCH 4/4] powerpc/fsl: Document rapidio node binding-information Kumar Gala
2011-09-30  7:35     ` Liu Gang-B34182
2011-09-29 14:21 ` [PATCH 1/4] fsl-rio: Split rio driver into two parts, RapidIO endpoint and RapidIO message unit Kumar Gala

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=1317263341-19010-4-git-send-email-Gang.Liu@freescale.com \
    --to=gang.liu@freescale.com \
    --cc=B11780@freescale.com \
    --cc=akpm@linux-foundation.org \
    --cc=b24347@freescale.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=r58472@freescale.com \
    --cc=r61911@freescale.com \
    /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).