xref: /freebsd/sys/contrib/device-tree/Bindings/soc/fsl/qman-portals.txt (revision 924226fba12cc9a228c73b956e1b7fa24c60b055)
1QorIQ DPAA Queue Manager Portals Device Tree Binding
2
3Copyright (C) 2008 - 2014 Freescale Semiconductor Inc.
4
5CONTENTS
6
7	- QMan Portal
8	- Example
9
10QMan Portal Node
11
12Portals are memory mapped interfaces to QMan that allow low-latency, lock-less
13interaction by software running on processor cores, accelerators and network
14interfaces with the QMan
15
16PROPERTIES
17
18- compatible
19	Usage:		Required
20	Value type:	<stringlist>
21	Definition:	Must include "fsl,qman-portal-<hardware revision>"
22			May include "fsl,<SoC>-qman-portal" or "fsl,qman-portal"
23
24- reg
25	Usage:		Required
26	Value type:	<prop-encoded-array>
27	Definition:	Two regions. The first is the cache-enabled region of
28			the portal. The second is the cache-inhibited region of
29			the portal
30
31- interrupts
32	Usage:		Required
33	Value type:	<prop-encoded-array>
34	Definition:	Standard property
35
36- fsl,liodn
37	Usage:		See pamu.txt
38	Value type:	<prop-encoded-array>
39	Definition:	Two LIODN(s). DQRR LIODN (DLIODN) and Frame LIODN
40			(FLIODN)
41
42- fsl,iommu-parent
43	Usage:		See pamu.txt
44	Value type:	<phandle>
45	Definition:	PAMU property used for dynamic LIODN assignment
46
47	For additional details about the PAMU/LIODN binding(s) see pamu.txt
48
49- cell-index
50	Usage:		Required
51	Value type:	<u32>
52	Definition:	The hardware index of the channel. This can also be
53			determined by dividing any of the channel's 8 work queue
54			IDs by 8
55
56In addition to these properties the qman-portals should have sub-nodes to
57represent the HW devices/portals that are connected to the software portal
58described here
59
60The currently supported sub-nodes are:
61	* fman0
62	* fman1
63	* pme
64	* crypto
65
66These subnodes should have the following properties:
67
68- fsl,liodn
69	Usage:		See pamu.txt
70	Value type:	<prop-encoded-array>
71	Definition:	PAMU property used for static LIODN assignment
72
73- fsl,iommu-parent
74	Usage:		See pamu.txt
75	Value type:	<phandle>
76	Definition:	PAMU property used for dynamic LIODN assignment
77
78- dev-handle
79	Usage:		Required
80	Value type:	<phandle>
81	Definition:	The phandle to the particular hardware device that this
82			portal is connected to.
83
84EXAMPLE
85
86The example below shows a (P4080) QMan portals container/bus node with two portals
87
88	qman-portals@ff4200000 {
89		#address-cells = <1>;
90		#size-cells = <1>;
91		compatible = "simple-bus";
92		ranges = <0 0xf 0xf4200000 0x200000>;
93
94		qman-portal@0 {
95			compatible = "fsl,qman-portal-1.2.0", "fsl,qman-portal";
96			reg = <0 0x4000>, <0x100000 0x1000>;
97			interrupts = <104 2 0 0>;
98			fsl,liodn = <1 2>;
99			fsl,qman-channel-id = <0>;
100
101			fman0 {
102				fsl,liodn = <0x21>;
103				dev-handle = <&fman0>;
104			};
105			fman1 {
106				fsl,liodn = <0xa1>;
107				dev-handle = <&fman1>;
108			};
109			crypto {
110				fsl,liodn = <0x41 0x66>;
111				dev-handle = <&crypto>;
112			};
113		};
114		qman-portal@4000 {
115			compatible = "fsl,qman-portal-1.2.0", "fsl,qman-portal";
116			reg = <0x4000 0x4000>, <0x101000 0x1000>;
117			interrupts = <106 2 0 0>;
118			fsl,liodn = <3 4>;
119			cell-index = <1>;
120
121			fman0 {
122				fsl,liodn = <0x22>;
123				dev-handle = <&fman0>;
124			};
125			fman1 {
126				fsl,liodn = <0xa2>;
127				dev-handle = <&fman1>;
128			};
129			crypto {
130				fsl,liodn = <0x42 0x67>;
131				dev-handle = <&crypto>;
132			};
133		};
134	};
135