xref: /freebsd/sys/contrib/device-tree/Bindings/powerpc/fsl/raideng.txt (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1* Freescale 85xx RAID Engine nodes
2
3RAID Engine nodes are defined to describe on-chip RAID accelerators.  Each RAID
4Engine should have a separate node.
5
6Supported chips:
7P5020, P5040
8
9Required properties:
10
11- compatible:	Should contain "fsl,raideng-v1.0" as the value
12		This identifies RAID Engine block. 1 in 1.0 represents
13		major number whereas 0 represents minor number. The
14		version matches the hardware IP version.
15- reg:		offset and length of the register set for the device
16- ranges:	standard ranges property specifying the translation
17		between child address space and parent address space
18
19Example:
20	/* P5020 */
21	raideng: raideng@320000 {
22		compatible = "fsl,raideng-v1.0";
23		#address-cells = <1>;
24		#size-cells = <1>;
25		reg	= <0x320000 0x10000>;
26		ranges	= <0 0x320000 0x10000>;
27	};
28
29
30There must be a sub-node for each job queue present in RAID Engine
31This node must be a sub-node of the main RAID Engine node
32
33- compatible:	Should contain "fsl,raideng-v1.0-job-queue" as the value
34		This identifies the job queue interface
35- reg:		offset and length of the register set for job queue
36- ranges:	standard ranges property specifying the translation
37		between child address space and parent address space
38
39Example:
40	/* P5020 */
41	raideng_jq0@1000 {
42		compatible = "fsl,raideng-v1.0-job-queue";
43		reg	   = <0x1000 0x1000>;
44		ranges	   = <0x0 0x1000 0x1000>;
45	};
46
47
48There must be a sub-node for each job ring present in RAID Engine
49This node must be a sub-node of job queue node
50
51- compatible:	Must contain "fsl,raideng-v1.0-job-ring" as the value
52		This identifies job ring. Should contain either
53		"fsl,raideng-v1.0-hp-ring" or "fsl,raideng-v1.0-lp-ring"
54		depending upon whether ring has high or low priority
55- reg:		offset and length of the register set for job ring
56- interrupts:	interrupt mapping for job ring IRQ
57
58Optional property:
59
60- fsl,liodn:	Specifies the LIODN to be used for Job Ring. This
61		property is normally set by firmware. Value
62		is of 12-bits which is the LIODN number for this JR.
63		This property is used by the IOMMU (PAMU) to distinquish
64		transactions from this JR and than be able to do address
65		translation & protection accordingly.
66
67Example:
68	/* P5020 */
69	raideng_jq0@1000 {
70		compatible = "fsl,raideng-v1.0-job-queue";
71		reg	   = <0x1000 0x1000>;
72		ranges	   = <0x0 0x1000 0x1000>;
73
74		raideng_jr0: jr@0 {
75			compatible = "fsl,raideng-v1.0-job-ring", "fsl,raideng-v1.0-hp-ring";
76			reg	   = <0x0 0x400>;
77			interrupts = <139 2 0 0>;
78			interrupt-parent = <&mpic>;
79			fsl,liodn = <0x41>;
80		};
81	};
82