dt/bindings: Introduce the FSL QorIQ DPAA BMan portal(s)
authorEmil Medve <Emilian.Medve@freescale.com>
Wed, 5 Nov 2014 15:18:52 +0000 (09:18 -0600)
committerScott Wood <scottwood@freescale.com>
Thu, 13 Nov 2014 05:53:41 +0000 (23:53 -0600)
Portals are memory mapped interfaces to BMan that allow low-latency,
lock-less interaction by software running on processor cores,
accelerators and network interfaces with the BMan

Signed-off-by: Emil Medve <Emilian.Medve@Freescale.com>
Change-Id: I6d245ffc14ba3d0e91d403ac7c3b91b75a9e6a95
Signed-off-by: Scott Wood <scottwood@freescale.com>
Documentation/devicetree/bindings/soc/fsl/bman-portals.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/soc/fsl/bman-portals.txt b/Documentation/devicetree/bindings/soc/fsl/bman-portals.txt
new file mode 100644 (file)
index 0000000..2a00e14
--- /dev/null
@@ -0,0 +1,56 @@
+QorIQ DPAA Buffer Manager Portals Device Tree Binding
+
+Copyright (C) 2008 - 2014 Freescale Semiconductor Inc.
+
+CONTENTS
+
+       - BMan Portal
+       - Example
+
+BMan Portal Node
+
+Portals are memory mapped interfaces to BMan that allow low-latency, lock-less
+interaction by software running on processor cores, accelerators and network
+interfaces with the BMan
+
+PROPERTIES
+
+- compatible
+       Usage:          Required
+       Value type:     <stringlist>
+       Definition:     Must include "fsl,bman-portal-<hardware revision>"
+                       May include "fsl,<SoC>-bman-portal" or "fsl,bman-portal"
+
+- reg
+       Usage:          Required
+       Value type:     <prop-encoded-array>
+       Definition:     Two regions. The first is the cache-enabled region of
+                       the portal. The second is the cache-inhibited region of
+                       the portal
+
+- interrupts
+       Usage:          Required
+       Value type:     <prop-encoded-array>
+       Definition:     Standard property
+
+EXAMPLE
+
+The example below shows a (P4080) BMan portals container/bus node with two portals
+
+       bman-portals@ff4000000 {
+               #address-cells = <1>;
+               #size-cells = <1>;
+               compatible = "simple-bus";
+               ranges = <0 0xf 0xf4000000 0x200000>;
+
+               bman-portal@0 {
+                       compatible = "fsl,bman-portal-1.0.0", "fsl,bman-portal";
+                       reg = <0x0 0x4000>, <0x100000 0x1000>;
+                       interrupts = <105 2 0 0>;
+               };
+               bman-portal@4000 {
+                       compatible = "fsl,bman-portal-1.0.0", "fsl,bman-portal";
+                       reg = <0x4000 0x4000>, <0x101000 0x1000>;
+                       interrupts = <107 2 0 0>;
+               };
+       };