1 # SPDX-License-Identifier: GPL-2.0 1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2 2 %YAML 1.2
3 --- 3 ---
4 $id: http://devicetree.org/schemas/net/etherne 4 $id: http://devicetree.org/schemas/net/ethernet-phy.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: Ethernet PHY Common Properties 7 title: Ethernet PHY Common Properties
8 8
9 maintainers: 9 maintainers:
10 - Andrew Lunn <andrew@lunn.ch> 10 - Andrew Lunn <andrew@lunn.ch>
11 - Florian Fainelli <f.fainelli@gmail.com> 11 - Florian Fainelli <f.fainelli@gmail.com>
12 - Heiner Kallweit <hkallweit1@gmail.com> 12 - Heiner Kallweit <hkallweit1@gmail.com>
13 13
14 # The dt-schema tools will generate a select s 14 # The dt-schema tools will generate a select statement first by using
15 # the compatible, and second by using the node 15 # the compatible, and second by using the node name if any. In our
16 # case, the node name is the one we want to ma 16 # case, the node name is the one we want to match on, while the
17 # compatible is optional. 17 # compatible is optional.
18 select: 18 select:
19 properties: 19 properties:
20 $nodename: 20 $nodename:
21 pattern: "^ethernet-phy(@[a-f0-9]+)?$" 21 pattern: "^ethernet-phy(@[a-f0-9]+)?$"
22 22
23 required: 23 required:
24 - $nodename 24 - $nodename
25 25
26 properties: 26 properties:
27 $nodename: 27 $nodename:
28 pattern: "^ethernet-phy(@[a-f0-9]+)?$" 28 pattern: "^ethernet-phy(@[a-f0-9]+)?$"
29 29
30 compatible: 30 compatible:
31 oneOf: 31 oneOf:
32 - const: ethernet-phy-ieee802.3-c22 32 - const: ethernet-phy-ieee802.3-c22
33 description: PHYs that implement IEEE8 33 description: PHYs that implement IEEE802.3 clause 22
34 - const: ethernet-phy-ieee802.3-c45 34 - const: ethernet-phy-ieee802.3-c45
35 description: PHYs that implement IEEE8 35 description: PHYs that implement IEEE802.3 clause 45
36 - pattern: "^ethernet-phy-id[a-f0-9]{4}\ 36 - pattern: "^ethernet-phy-id[a-f0-9]{4}\\.[a-f0-9]{4}$"
37 description: 37 description:
38 If the PHY reports an incorrect ID ( 38 If the PHY reports an incorrect ID (or none at all) then the
39 compatible list may contain an entry 39 compatible list may contain an entry with the correct PHY ID
40 in the above form. 40 in the above form.
41 The first group of digits is the 16 41 The first group of digits is the 16 bit Phy Identifier 1
42 register, this is the chip vendor OU 42 register, this is the chip vendor OUI bits 3:18. The
43 second group of digits is the Phy Id 43 second group of digits is the Phy Identifier 2 register,
44 this is the chip vendor OUI bits 19: 44 this is the chip vendor OUI bits 19:24, followed by 10
45 bits of a vendor specific ID. 45 bits of a vendor specific ID.
46 - items: 46 - items:
47 - pattern: "^ethernet-phy-id[a-f0-9] 47 - pattern: "^ethernet-phy-id[a-f0-9]{4}\\.[a-f0-9]{4}$"
48 - const: ethernet-phy-ieee802.3-c22 48 - const: ethernet-phy-ieee802.3-c22
49 - items: 49 - items:
50 - pattern: "^ethernet-phy-id[a-f0-9] 50 - pattern: "^ethernet-phy-id[a-f0-9]{4}\\.[a-f0-9]{4}$"
51 - const: ethernet-phy-ieee802.3-c45 51 - const: ethernet-phy-ieee802.3-c45
52 52
53 reg: 53 reg:
54 minimum: 0 54 minimum: 0
55 maximum: 31 55 maximum: 31
56 description: 56 description:
57 The ID number for the PHY. 57 The ID number for the PHY.
58 58
59 interrupts: 59 interrupts:
60 maxItems: 1 60 maxItems: 1
61 61
62 max-speed: 62 max-speed:
63 enum: 63 enum:
64 - 10 64 - 10
65 - 100 65 - 100
66 - 1000 66 - 1000
67 - 2500 67 - 2500
68 - 5000 68 - 5000
69 - 10000 69 - 10000
70 - 20000 70 - 20000
71 - 25000 71 - 25000
72 - 40000 72 - 40000
73 - 50000 73 - 50000
74 - 56000 74 - 56000
75 - 100000 75 - 100000
76 - 200000 76 - 200000
77 description: 77 description:
78 Maximum PHY supported speed in Mbits / s 78 Maximum PHY supported speed in Mbits / seconds.
79 79
80 phy-10base-t1l-2.4vpp: 80 phy-10base-t1l-2.4vpp:
81 description: | 81 description: |
82 tristate, request/disable 2.4 Vpp operat 82 tristate, request/disable 2.4 Vpp operating mode. The values are:
83 0: Disable 2.4 Vpp operating mode. 83 0: Disable 2.4 Vpp operating mode.
84 1: Request 2.4 Vpp operating mode from l 84 1: Request 2.4 Vpp operating mode from link partner.
85 Absence of this property will leave conf 85 Absence of this property will leave configuration to default values.
86 $ref: /schemas/types.yaml#/definitions/uin 86 $ref: /schemas/types.yaml#/definitions/uint32
87 enum: [0, 1] 87 enum: [0, 1]
88 88
89 broken-turn-around: 89 broken-turn-around:
90 $ref: /schemas/types.yaml#/definitions/fla 90 $ref: /schemas/types.yaml#/definitions/flag
91 description: 91 description:
92 If set, indicates the PHY device does no 92 If set, indicates the PHY device does not correctly release
93 the turn around line low at end of the c 93 the turn around line low at end of the control phase of the
94 MDIO transaction. 94 MDIO transaction.
95 95
96 brr-mode: <<
97 $ref: /schemas/types.yaml#/definitions/fla <<
98 description: <<
99 If set, indicates the network cable inte <<
100 defined in the BroadR-Reach link mode sp <<
101 1BR-10 names. The PHY must be configured <<
102 by software. <<
103 <<
104 clocks: <<
105 maxItems: 1 <<
106 description: <<
107 External clock connected to the PHY. If <<
108 that the PHY uses a fixed crystal or an <<
109 <<
110 enet-phy-lane-swap: 96 enet-phy-lane-swap:
111 $ref: /schemas/types.yaml#/definitions/fla 97 $ref: /schemas/types.yaml#/definitions/flag
112 description: 98 description:
113 If set, indicates the PHY will swap the 99 If set, indicates the PHY will swap the TX/RX lanes to
114 compensate for the board being designed 100 compensate for the board being designed with the lanes
115 swapped. 101 swapped.
116 102
117 enet-phy-lane-no-swap: 103 enet-phy-lane-no-swap:
118 $ref: /schemas/types.yaml#/definitions/fla 104 $ref: /schemas/types.yaml#/definitions/flag
119 description: 105 description:
120 If set, indicates that PHY will disable 106 If set, indicates that PHY will disable swap of the
121 TX/RX lanes. This property allows the PH !! 107 TX/RX lanes. This property allows the PHY to work correcly after
122 e.g. wrong bootstrap configuration cause 108 e.g. wrong bootstrap configuration caused by issues in PCB
123 layout design. 109 layout design.
124 110
125 eee-broken-100tx: 111 eee-broken-100tx:
126 $ref: /schemas/types.yaml#/definitions/fla 112 $ref: /schemas/types.yaml#/definitions/flag
127 description: 113 description:
128 Mark the corresponding energy efficient 114 Mark the corresponding energy efficient ethernet mode as
129 broken and request the ethernet to stop 115 broken and request the ethernet to stop advertising it.
130 116
131 eee-broken-1000t: 117 eee-broken-1000t:
132 $ref: /schemas/types.yaml#/definitions/fla 118 $ref: /schemas/types.yaml#/definitions/flag
133 description: 119 description:
134 Mark the corresponding energy efficient 120 Mark the corresponding energy efficient ethernet mode as
135 broken and request the ethernet to stop 121 broken and request the ethernet to stop advertising it.
136 122
137 eee-broken-10gt: 123 eee-broken-10gt:
138 $ref: /schemas/types.yaml#/definitions/fla 124 $ref: /schemas/types.yaml#/definitions/flag
139 description: 125 description:
140 Mark the corresponding energy efficient 126 Mark the corresponding energy efficient ethernet mode as
141 broken and request the ethernet to stop 127 broken and request the ethernet to stop advertising it.
142 128
143 eee-broken-1000kx: 129 eee-broken-1000kx:
144 $ref: /schemas/types.yaml#/definitions/fla 130 $ref: /schemas/types.yaml#/definitions/flag
145 description: 131 description:
146 Mark the corresponding energy efficient 132 Mark the corresponding energy efficient ethernet mode as
147 broken and request the ethernet to stop 133 broken and request the ethernet to stop advertising it.
148 134
149 eee-broken-10gkx4: 135 eee-broken-10gkx4:
150 $ref: /schemas/types.yaml#/definitions/fla 136 $ref: /schemas/types.yaml#/definitions/flag
151 description: 137 description:
152 Mark the corresponding energy efficient 138 Mark the corresponding energy efficient ethernet mode as
153 broken and request the ethernet to stop 139 broken and request the ethernet to stop advertising it.
154 140
155 eee-broken-10gkr: 141 eee-broken-10gkr:
156 $ref: /schemas/types.yaml#/definitions/fla 142 $ref: /schemas/types.yaml#/definitions/flag
157 description: 143 description:
158 Mark the corresponding energy efficient 144 Mark the corresponding energy efficient ethernet mode as
159 broken and request the ethernet to stop 145 broken and request the ethernet to stop advertising it.
160 146
161 pses: 147 pses:
162 $ref: /schemas/types.yaml#/definitions/pha 148 $ref: /schemas/types.yaml#/definitions/phandle-array
163 maxItems: 1 149 maxItems: 1
164 description: 150 description:
165 Specifies a reference to a node represen 151 Specifies a reference to a node representing a Power Sourcing Equipment.
166 152
167 phy-is-integrated: 153 phy-is-integrated:
168 $ref: /schemas/types.yaml#/definitions/fla 154 $ref: /schemas/types.yaml#/definitions/flag
169 description: 155 description:
170 If set, indicates that the PHY is integr 156 If set, indicates that the PHY is integrated into the same
171 physical package as the Ethernet MAC. If 157 physical package as the Ethernet MAC. If needed, muxers
172 should be configured to ensure the integ 158 should be configured to ensure the integrated PHY is
173 used. The absence of this property indic 159 used. The absence of this property indicates the muxers
174 should be configured so that the externa 160 should be configured so that the external PHY is used.
175 161
176 resets: 162 resets:
177 maxItems: 1 163 maxItems: 1
178 164
179 reset-names: 165 reset-names:
180 const: phy 166 const: phy
181 167
182 reset-gpios: 168 reset-gpios:
183 maxItems: 1 169 maxItems: 1
184 description: 170 description:
185 The GPIO phandle and specifier for the P 171 The GPIO phandle and specifier for the PHY reset signal.
186 172
187 reset-assert-us: 173 reset-assert-us:
188 description: 174 description:
189 Delay after the reset was asserted in mi 175 Delay after the reset was asserted in microseconds. If this
190 property is missing the delay will be sk 176 property is missing the delay will be skipped.
191 177
192 reset-deassert-us: 178 reset-deassert-us:
193 description: 179 description:
194 Delay after the reset was deasserted in 180 Delay after the reset was deasserted in microseconds. If
195 this property is missing the delay will 181 this property is missing the delay will be skipped.
196 182
197 sfp: 183 sfp:
198 $ref: /schemas/types.yaml#/definitions/pha 184 $ref: /schemas/types.yaml#/definitions/phandle
199 description: 185 description:
200 Specifies a reference to a node represen 186 Specifies a reference to a node representing a SFP cage.
201 187
202 rx-internal-delay-ps: 188 rx-internal-delay-ps:
203 description: | 189 description: |
204 RGMII Receive PHY Clock Delay defined in 190 RGMII Receive PHY Clock Delay defined in pico seconds. This is used for
205 PHY's that have configurable RX internal 191 PHY's that have configurable RX internal delays. If this property is
206 present then the PHY applies the RX dela 192 present then the PHY applies the RX delay.
207 193
208 tx-internal-delay-ps: 194 tx-internal-delay-ps:
209 description: | 195 description: |
210 RGMII Transmit PHY Clock Delay defined i 196 RGMII Transmit PHY Clock Delay defined in pico seconds. This is used for
211 PHY's that have configurable TX internal 197 PHY's that have configurable TX internal delays. If this property is
212 present then the PHY applies the TX dela 198 present then the PHY applies the TX delay.
213 199
214 leds: 200 leds:
215 type: object 201 type: object
216 202
217 properties: 203 properties:
218 '#address-cells': 204 '#address-cells':
219 const: 1 205 const: 1
220 206
221 '#size-cells': 207 '#size-cells':
222 const: 0 208 const: 0
223 209
224 patternProperties: 210 patternProperties:
225 '^led@[a-f0-9]+$': 211 '^led@[a-f0-9]+$':
226 $ref: /schemas/leds/common.yaml# 212 $ref: /schemas/leds/common.yaml#
227 213
228 properties: 214 properties:
229 reg: 215 reg:
230 maxItems: 1 216 maxItems: 1
231 description: 217 description:
232 This define the LED index in the 218 This define the LED index in the PHY or the MAC. It's really
233 driver dependent and required fo 219 driver dependent and required for ports that define multiple
234 LED for the same port. 220 LED for the same port.
235 221
236 required: 222 required:
237 - reg 223 - reg
238 224
239 unevaluatedProperties: false 225 unevaluatedProperties: false
240 226
241 additionalProperties: false 227 additionalProperties: false
242 228
243 required: 229 required:
244 - reg 230 - reg
245 231
246 additionalProperties: true 232 additionalProperties: true
247 233
248 examples: 234 examples:
249 - | 235 - |
250 #include <dt-bindings/leds/common.h> 236 #include <dt-bindings/leds/common.h>
251 237
252 ethernet { 238 ethernet {
253 #address-cells = <1>; 239 #address-cells = <1>;
254 #size-cells = <0>; 240 #size-cells = <0>;
255 241
256 ethernet-phy@0 { 242 ethernet-phy@0 {
257 compatible = "ethernet-phy-id0141. 243 compatible = "ethernet-phy-id0141.0e90", "ethernet-phy-ieee802.3-c45";
258 interrupt-parent = <&PIC>; 244 interrupt-parent = <&PIC>;
259 interrupts = <35 1>; 245 interrupts = <35 1>;
260 reg = <0>; 246 reg = <0>;
261 247
262 resets = <&rst 8>; 248 resets = <&rst 8>;
263 reset-names = "phy"; 249 reset-names = "phy";
264 reset-gpios = <&gpio1 4 1>; 250 reset-gpios = <&gpio1 4 1>;
265 reset-assert-us = <1000>; 251 reset-assert-us = <1000>;
266 reset-deassert-us = <2000>; 252 reset-deassert-us = <2000>;
267 253
268 leds { 254 leds {
269 #address-cells = <1>; 255 #address-cells = <1>;
270 #size-cells = <0>; 256 #size-cells = <0>;
271 257
272 led@0 { 258 led@0 {
273 reg = <0>; 259 reg = <0>;
274 color = <LED_COLOR_ID_WHIT 260 color = <LED_COLOR_ID_WHITE>;
275 function = LED_FUNCTION_LA 261 function = LED_FUNCTION_LAN;
276 default-state = "keep"; 262 default-state = "keep";
277 }; 263 };
278 }; 264 };
279 }; 265 };
280 }; 266 };
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.