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-controller.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: Ethernet Controller Common Properties !! 7 title: Ethernet Controller Generic Binding
8 8
9 maintainers: 9 maintainers:
10 - David S. Miller <davem@davemloft.net> 10 - David S. Miller <davem@davemloft.net>
11 11
12 properties: 12 properties:
13 $nodename: 13 $nodename:
14 pattern: "^ethernet(@.*)?$" 14 pattern: "^ethernet(@.*)?$"
15 15
16 label: <<
17 description: Human readable label on a por <<
18 <<
19 local-mac-address: 16 local-mac-address:
20 description: 17 description:
21 Specifies the MAC address that was assig 18 Specifies the MAC address that was assigned to the network device.
22 $ref: /schemas/types.yaml#/definitions/uin 19 $ref: /schemas/types.yaml#/definitions/uint8-array
23 minItems: 6 20 minItems: 6
24 maxItems: 6 21 maxItems: 6
25 22
26 mac-address: 23 mac-address:
27 description: 24 description:
28 Specifies the MAC address that was last 25 Specifies the MAC address that was last used by the boot
29 program; should be used in cases where t 26 program; should be used in cases where the MAC address assigned
30 to the device by the boot program is dif 27 to the device by the boot program is different from the
31 local-mac-address property. 28 local-mac-address property.
32 $ref: /schemas/types.yaml#/definitions/uin 29 $ref: /schemas/types.yaml#/definitions/uint8-array
33 minItems: 6 30 minItems: 6
34 maxItems: 6 31 maxItems: 6
35 32
36 max-frame-size: 33 max-frame-size:
37 $ref: /schemas/types.yaml#/definitions/uin 34 $ref: /schemas/types.yaml#/definitions/uint32
38 description: 35 description:
39 Maximum transfer unit (IEEE defined MTU) 36 Maximum transfer unit (IEEE defined MTU), rather than the
40 maximum frame size (there\'s contradicti 37 maximum frame size (there\'s contradiction in the Devicetree
41 Specification). 38 Specification).
42 39
43 max-speed: 40 max-speed:
44 $ref: /schemas/types.yaml#/definitions/uin 41 $ref: /schemas/types.yaml#/definitions/uint32
45 description: 42 description:
46 Specifies maximum speed in Mbit/s suppor 43 Specifies maximum speed in Mbit/s supported by the device.
47 44
48 nvmem-cells: 45 nvmem-cells:
49 maxItems: 1 46 maxItems: 1
50 description: 47 description:
51 Reference to an nvmem node for the MAC a 48 Reference to an nvmem node for the MAC address
52 49
53 nvmem-cell-names: 50 nvmem-cell-names:
54 const: mac-address 51 const: mac-address
55 52
56 phy-connection-type: 53 phy-connection-type:
57 description: 54 description:
58 Specifies interface type between the Eth 55 Specifies interface type between the Ethernet device and a physical
59 layer (PHY) device. 56 layer (PHY) device.
60 enum: 57 enum:
61 # There is not a standard bus between th 58 # There is not a standard bus between the MAC and the PHY,
62 # something proprietary is being used to 59 # something proprietary is being used to embed the PHY in the
63 # MAC. 60 # MAC.
64 - internal 61 - internal
65 - mii 62 - mii
66 - gmii 63 - gmii
67 - sgmii 64 - sgmii
68 - psgmii <<
69 - qsgmii 65 - qsgmii
70 - qusgmii <<
71 - tbi 66 - tbi
72 - rev-mii 67 - rev-mii
73 - rmii 68 - rmii
74 - rev-rmii 69 - rev-rmii
75 - moca 70 - moca
76 71
77 # RX and TX delays are added by the MAC 72 # RX and TX delays are added by the MAC when required
78 - rgmii 73 - rgmii
79 74
80 # RGMII with internal RX and TX delays p 75 # RGMII with internal RX and TX delays provided by the PHY,
81 # the MAC should not add the RX or TX de 76 # the MAC should not add the RX or TX delays in this case
82 - rgmii-id 77 - rgmii-id
83 78
84 # RGMII with internal RX delay provided 79 # RGMII with internal RX delay provided by the PHY, the MAC
85 # should not add an RX delay in this cas 80 # should not add an RX delay in this case
86 - rgmii-rxid 81 - rgmii-rxid
87 82
88 # RGMII with internal TX delay provided 83 # RGMII with internal TX delay provided by the PHY, the MAC
89 # should not add an TX delay in this cas 84 # should not add an TX delay in this case
90 - rgmii-txid 85 - rgmii-txid
91 - rtbi 86 - rtbi
92 - smii 87 - smii
93 - xgmii 88 - xgmii
94 - trgmii 89 - trgmii
95 - 1000base-x 90 - 1000base-x
96 - 2500base-x 91 - 2500base-x
97 - 5gbase-r 92 - 5gbase-r
98 - rxaui 93 - rxaui
99 - xaui 94 - xaui
100 95
101 # 10GBASE-KR, XFI, SFI 96 # 10GBASE-KR, XFI, SFI
102 - 10gbase-kr 97 - 10gbase-kr
103 - usxgmii 98 - usxgmii
104 - 10gbase-r 99 - 10gbase-r
105 - 25gbase-r 100 - 25gbase-r
106 - 10g-qxgmii <<
107 101
108 phy-mode: 102 phy-mode:
109 $ref: "#/properties/phy-connection-type" 103 $ref: "#/properties/phy-connection-type"
110 104
111 pcs-handle: <<
112 $ref: /schemas/types.yaml#/definitions/pha <<
113 items: <<
114 maxItems: 1 <<
115 description: <<
116 Specifies a reference to a node represen <<
117 bus to link with an external PHY (phy-ha <<
118 <<
119 pcs-handle-names: <<
120 description: <<
121 The name of each PCS in pcs-handle. <<
122 <<
123 phy-handle: 105 phy-handle:
124 $ref: /schemas/types.yaml#/definitions/pha 106 $ref: /schemas/types.yaml#/definitions/phandle
125 description: 107 description:
126 Specifies a reference to a node represen 108 Specifies a reference to a node representing a PHY device.
127 109
128 phy: 110 phy:
129 $ref: "#/properties/phy-handle" 111 $ref: "#/properties/phy-handle"
130 deprecated: true 112 deprecated: true
131 113
132 phy-device: 114 phy-device:
133 $ref: "#/properties/phy-handle" 115 $ref: "#/properties/phy-handle"
134 deprecated: true 116 deprecated: true
135 117
136 rx-fifo-depth: 118 rx-fifo-depth:
137 $ref: /schemas/types.yaml#/definitions/uin 119 $ref: /schemas/types.yaml#/definitions/uint32
138 description: 120 description:
139 The size of the controller\'s receive fi 121 The size of the controller\'s receive fifo in bytes. This is used
140 for components that can have configurabl 122 for components that can have configurable receive fifo sizes,
141 and is useful for determining certain co 123 and is useful for determining certain configuration settings
142 such as flow control thresholds. 124 such as flow control thresholds.
143 125
>> 126 rx-internal-delay-ps:
>> 127 description: |
>> 128 RGMII Receive Clock Delay defined in pico seconds.
>> 129 This is used for controllers that have configurable RX internal delays.
>> 130 If this property is present then the MAC applies the RX delay.
>> 131
144 sfp: 132 sfp:
145 $ref: /schemas/types.yaml#/definitions/pha 133 $ref: /schemas/types.yaml#/definitions/phandle
146 description: 134 description:
147 Specifies a reference to a node represen 135 Specifies a reference to a node representing a SFP cage.
148 136
149 tx-fifo-depth: 137 tx-fifo-depth:
150 $ref: /schemas/types.yaml#/definitions/uin 138 $ref: /schemas/types.yaml#/definitions/uint32
151 description: 139 description:
152 The size of the controller\'s transmit f 140 The size of the controller\'s transmit fifo in bytes. This
153 is used for components that can have con 141 is used for components that can have configurable fifo sizes.
154 142
>> 143 tx-internal-delay-ps:
>> 144 description: |
>> 145 RGMII Transmit Clock Delay defined in pico seconds.
>> 146 This is used for controllers that have configurable TX internal delays.
>> 147 If this property is present then the MAC applies the TX delay.
>> 148
155 managed: 149 managed:
156 description: 150 description:
157 Specifies the PHY management type. If au 151 Specifies the PHY management type. If auto is set and fixed-link
158 is not specified, it uses MDIO for manag 152 is not specified, it uses MDIO for management.
159 $ref: /schemas/types.yaml#/definitions/str 153 $ref: /schemas/types.yaml#/definitions/string
160 default: auto 154 default: auto
161 enum: 155 enum:
162 - auto 156 - auto
163 - in-band-status 157 - in-band-status
164 158
165 fixed-link: 159 fixed-link:
166 oneOf: !! 160 allOf:
167 - $ref: /schemas/types.yaml#/definitions !! 161 - if:
168 deprecated: true !! 162 type: array
169 items: !! 163 then:
170 - minimum: 0 !! 164 deprecated: true
171 maximum: 31 !! 165 items:
172 description: !! 166 - minimum: 0
173 Emulated PHY ID, choose any but !! 167 maximum: 31
174 specified fixed-links !! 168 description:
175 !! 169 Emulated PHY ID, choose any but unique to the all
176 - enum: [0, 1] !! 170 specified fixed-links
177 description: !! 171
178 Duplex configuration. 0 for half !! 172 - enum: [0, 1]
179 full duplex !! 173 description:
180 !! 174 Duplex configuration. 0 for half duplex or 1 for
181 - enum: [10, 100, 1000, 2500, 10000] !! 175 full duplex
182 description: !! 176
183 Link speed in Mbits/sec. !! 177 - enum: [10, 100, 1000, 2500, 10000]
184 !! 178 description:
185 - enum: [0, 1] !! 179 Link speed in Mbits/sec.
186 description: !! 180
187 Pause configuration. 0 for no pa !! 181 - enum: [0, 1]
188 !! 182 description:
189 - enum: [0, 1] !! 183 Pause configuration. 0 for no pause, 1 for pause
190 description: !! 184
191 Asymmetric pause configuration. !! 185 - enum: [0, 1]
192 pause, 1 for asymmetric pause !! 186 description:
193 - type: object !! 187 Asymmetric pause configuration. 0 for no asymmetric
194 additionalProperties: false !! 188 pause, 1 for asymmetric pause
195 properties: !! 189
196 speed: !! 190
197 description: !! 191 - if:
198 Link speed. !! 192 type: object
199 $ref: /schemas/types.yaml#/definit !! 193 then:
200 enum: [10, 100, 1000, 2500, 10000] !! 194 properties:
201 !! 195 speed:
202 full-duplex: !! 196 description:
203 $ref: /schemas/types.yaml#/definit !! 197 Link speed.
204 description: !! 198 $ref: /schemas/types.yaml#/definitions/uint32
205 Indicates that full-duplex is us !! 199 enum: [10, 100, 1000, 2500, 10000]
206 duplex is assumed. !! 200
207 !! 201 full-duplex:
208 pause: !! 202 $ref: /schemas/types.yaml#/definitions/flag
209 $ref: /schemas/types.yaml#/definit !! 203 description:
210 description: !! 204 Indicates that full-duplex is used. When absent, half
211 Indicates that pause should be e !! 205 duplex is assumed.
212 !! 206
213 asym-pause: !! 207 pause:
214 $ref: /schemas/types.yaml#/definit !! 208 $ref: /schemas/types.yaml#definitions/flag
215 description: !! 209 description:
216 Indicates that asym_pause should !! 210 Indicates that pause should be enabled.
217 !! 211
218 link-gpios: !! 212 asym-pause:
219 maxItems: 1 !! 213 $ref: /schemas/types.yaml#/definitions/flag
220 description: !! 214 description:
221 GPIO to determine if the link is !! 215 Indicates that asym_pause should be enabled.
222 !! 216
223 required: !! 217 link-gpios:
224 - speed !! 218 maxItems: 1
225 !! 219 description:
226 leds: !! 220 GPIO to determine if the link is up
227 description: !! 221
228 Describes the LEDs associated by Etherne !! 222 required:
229 These LEDs are not integrated in the PHY !! 223 - speed
230 control on them. Ethernet Controller reg <<
231 these defined LEDs. <<
232 <<
233 type: object <<
234 <<
235 properties: <<
236 '#address-cells': <<
237 const: 1 <<
238 <<
239 '#size-cells': <<
240 const: 0 <<
241 <<
242 patternProperties: <<
243 '^led@[a-f0-9]+$': <<
244 $ref: /schemas/leds/common.yaml# <<
245 <<
246 properties: <<
247 reg: <<
248 maxItems: 1 <<
249 description: <<
250 This define the LED index in the <<
251 driver dependent and required fo <<
252 LED for the same port. <<
253 <<
254 required: <<
255 - reg <<
256 <<
257 unevaluatedProperties: false <<
258 <<
259 additionalProperties: false <<
260 <<
261 dependencies: <<
262 pcs-handle-names: [pcs-handle] <<
263 <<
264 allOf: <<
265 - if: <<
266 properties: <<
267 phy-mode: <<
268 contains: <<
269 enum: <<
270 - rgmii <<
271 - rgmii-rxid <<
272 - rgmii-txid <<
273 - rgmii-id <<
274 then: <<
275 properties: <<
276 rx-internal-delay-ps: <<
277 description: <<
278 RGMII Receive Clock Delay defined <<
279 controllers that have configurable <<
280 property is present then the MAC a <<
281 tx-internal-delay-ps: <<
282 description: <<
283 RGMII Transmit Clock Delay defined <<
284 controllers that have configurable <<
285 property is present then the MAC a <<
286 224
287 additionalProperties: true 225 additionalProperties: true
288 226
289 ... 227 ...
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.