summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/net/fsl_ppfe/pfe.txt
blob: 780de449c6ca0c0691ae0d1f8ca4f5c48dcf7e80 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
=============================================================================
NXP Programmable Packet Forwarding Engine Device Bindings

CONTENTS
  - PFE Node
  - Ethernet Node

=============================================================================
PFE Node

DESCRIPTION

PFE Node has all the properties associated with Packet Forwarding Engine block.

PROPERTIES

- compatible
		Usage: required
		Value type: <stringlist>
		Definition: Must include "fsl,pfe"

- reg
		Usage: required
		Value type: <prop-encoded-array>
		Definition: A standard property.
		Specifies the offset of the following registers:
		- PFE configuration registers
		- DDR memory used by PFE

- fsl,pfe-num-interfaces
		Usage: required
		Value type: <u32>
		Definition: Must be present. Value can be either one or two.

- interrupts
		Usage: required
		Value type: <prop-encoded-array>
		Definition: Three interrupts are specified in this property.
		- HIF interrupt
		- HIF NO COPY interrupt
		- Wake On LAN interrupt

- interrupt-names
		Usage: required
		Value type: <stringlist>
		Definition: Following strings are defined for the 3 interrupts.
		"pfe_hif" - HIF interrupt
		"pfe_hif_nocpy" - HIF NO COPY interrupt
		"pfe_wol" - Wake On LAN interrupt

- memory-region
		Usage: required
		Value type: <phandle>
		Definition: phandle to a node describing reserved memory used by pfe.
		Refer:- Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt

- fsl,pfe-scfg
		Usage: required
		Value type: <phandle>
		Definition: phandle for scfg.

- fsl,rcpm-wakeup
		Usage: required
		Value type: <phandle>
		Definition: phandle for rcpm.

- clocks
		Usage: required
		Value type: <phandle>
		Definition: phandle for clockgen.

- clock-names
		Usage: required
		Value type: <string>
		Definition: phandle for clock name.

EXAMPLE

pfe: pfe@04000000 {
	compatible = "fsl,pfe";
	reg =   <0x0 0x04000000 0x0 0xc00000>,	/* AXI 16M */
		<0x0 0x83400000 0x0 0xc00000>;  /* PFE DDR 12M */
	reg-names = "pfe", "pfe-ddr";
	fsl,pfe-num-interfaces = <0x2>;
	interrupts = <0 172 0x4>,    /* HIF interrupt */
		     <0 173 0x4>,    /*HIF_NOCPY interrupt */
		     <0 174 0x4>;    /* WoL interrupt */
	interrupt-names = "pfe_hif", "pfe_hif_nocpy", "pfe_wol";
	memory-region = <&pfe_reserved>;
	fsl,pfe-scfg = <&scfg 0>;
	fsl,rcpm-wakeup = <&rcpm 0xf0000020>;
	clocks = <&clockgen 4 0>;
	clock-names = "pfe";

	status = "okay";
	pfe_mac0: ethernet@0 {
	};

	pfe_mac1: ethernet@1 {
	};
};

=============================================================================
Ethernet Node

DESCRIPTION

Ethernet Node has all the properties associated with PFE used by platforms to
connect to PHY:

PROPERTIES

- compatible
		Usage: required
		Value type: <stringlist>
		Definition: Must include "fsl,pfe-gemac-port"

- reg
		Usage: required
		Value type: <prop-encoded-array>
		Definition: A standard property.
		Specifies the gemacid of the interface.

- fsl,gemac-bus-id
		Usage: required
		Value type: <u32>
		Definition: Must be present. Value should be the id of the bus
		connected to gemac.

- fsl,gemac-phy-id
		Usage: required
		Value type: <u32>
		Definition: Must be present. Value should be the id of the phy
		connected to gemac.

- fsl,mdio-mux-val
		Usage: required
		Value type: <u32>
		Definition: Must be present. Value can be either 0 or 2 or 3.
		This value is used to configure the mux to enable mdio.

- phy-mode
		Usage: required
		Value type: <string>
		Definition: Must include "sgmii"

- fsl,pfe-phy-if-flags
		Usage: required
		Value type: <u32>
		Definition: Must be present. Value should be 0 by default.
		If there is not phy connected, this need to be 1.

- mdio
		optional subnode that specifies the mdio bus. This has reg
		property which is used to enable/disable the mdio bus.

EXAMPLE

ethernet@0 {
	compatible = "fsl,pfe-gemac-port";
	#address-cells = <1>;
	#size-cells = <0>;
	reg = <0x0>;	/* GEM_ID */
	fsl,gemac-bus-id = <0x0>;	/* BUS_ID */
	fsl,gemac-phy-id = <0x2>;	/* PHY_ID */
	fsl,mdio-mux-val = <0x0>;
	phy-mode = "sgmii";
	fsl,pfe-phy-if-flags = <0x0>;

	mdio@0 {
		reg = <0x1>; /* enabled/disabled */
	};
};