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 items:
24 maxItems: 6 !! 21 - minItems: 6
>> 22 maxItems: 6
25 23
26 mac-address: 24 mac-address:
27 description: 25 description:
28 Specifies the MAC address that was last 26 Specifies the MAC address that was last used by the boot
29 program; should be used in cases where t 27 program; should be used in cases where the MAC address assigned
30 to the device by the boot program is dif 28 to the device by the boot program is different from the
31 local-mac-address property. 29 local-mac-address property.
32 $ref: /schemas/types.yaml#/definitions/uin !! 30 $ref: /schemas/types.yaml#definitions/uint8-array
33 minItems: 6 !! 31 items:
34 maxItems: 6 !! 32 - minItems: 6
>> 33 maxItems: 6
35 34
36 max-frame-size: 35 max-frame-size:
37 $ref: /schemas/types.yaml#/definitions/uin !! 36 $ref: /schemas/types.yaml#definitions/uint32
38 description: 37 description:
39 Maximum transfer unit (IEEE defined MTU) 38 Maximum transfer unit (IEEE defined MTU), rather than the
40 maximum frame size (there\'s contradicti 39 maximum frame size (there\'s contradiction in the Devicetree
41 Specification). 40 Specification).
42 41
43 max-speed: 42 max-speed:
44 $ref: /schemas/types.yaml#/definitions/uin !! 43 $ref: /schemas/types.yaml#definitions/uint32
45 description: 44 description:
46 Specifies maximum speed in Mbit/s suppor 45 Specifies maximum speed in Mbit/s supported by the device.
47 46
48 nvmem-cells: 47 nvmem-cells:
49 maxItems: 1 48 maxItems: 1
50 description: 49 description:
51 Reference to an nvmem node for the MAC a 50 Reference to an nvmem node for the MAC address
52 51
53 nvmem-cell-names: !! 52 nvmem-cells-names:
54 const: mac-address 53 const: mac-address
55 54
56 phy-connection-type: 55 phy-connection-type:
57 description: 56 description:
58 Specifies interface type between the Eth 57 Specifies interface type between the Ethernet device and a physical
59 layer (PHY) device. 58 layer (PHY) device.
60 enum: 59 enum:
61 # There is not a standard bus between th 60 # There is not a standard bus between the MAC and the PHY,
62 # something proprietary is being used to 61 # something proprietary is being used to embed the PHY in the
63 # MAC. 62 # MAC.
64 - internal 63 - internal
65 - mii 64 - mii
66 - gmii 65 - gmii
67 - sgmii 66 - sgmii
68 - psgmii <<
69 - qsgmii 67 - qsgmii
70 - qusgmii <<
71 - tbi 68 - tbi
72 - rev-mii 69 - rev-mii
73 - rmii 70 - rmii
74 - rev-rmii <<
75 - 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 <<
98 - rxaui 92 - rxaui
99 - xaui 93 - xaui
100 94
101 # 10GBASE-KR, XFI, SFI 95 # 10GBASE-KR, XFI, SFI
102 - 10gbase-kr 96 - 10gbase-kr
103 - usxgmii 97 - usxgmii
104 - 10gbase-r <<
105 - 25gbase-r <<
106 - 10g-qxgmii <<
107 98
108 phy-mode: 99 phy-mode:
109 $ref: "#/properties/phy-connection-type" 100 $ref: "#/properties/phy-connection-type"
110 101
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: 102 phy-handle:
124 $ref: /schemas/types.yaml#/definitions/pha !! 103 $ref: /schemas/types.yaml#definitions/phandle
125 description: 104 description:
126 Specifies a reference to a node represen 105 Specifies a reference to a node representing a PHY device.
127 106
128 phy: 107 phy:
129 $ref: "#/properties/phy-handle" 108 $ref: "#/properties/phy-handle"
130 deprecated: true 109 deprecated: true
131 110
132 phy-device: 111 phy-device:
133 $ref: "#/properties/phy-handle" 112 $ref: "#/properties/phy-handle"
134 deprecated: true 113 deprecated: true
135 114
136 rx-fifo-depth: 115 rx-fifo-depth:
137 $ref: /schemas/types.yaml#/definitions/uin !! 116 $ref: /schemas/types.yaml#definitions/uint32
138 description: 117 description:
139 The size of the controller\'s receive fi 118 The size of the controller\'s receive fifo in bytes. This is used
140 for components that can have configurabl 119 for components that can have configurable receive fifo sizes,
141 and is useful for determining certain co 120 and is useful for determining certain configuration settings
142 such as flow control thresholds. 121 such as flow control thresholds.
143 122
144 sfp: 123 sfp:
145 $ref: /schemas/types.yaml#/definitions/pha !! 124 $ref: /schemas/types.yaml#definitions/phandle
146 description: 125 description:
147 Specifies a reference to a node represen 126 Specifies a reference to a node representing a SFP cage.
148 127
149 tx-fifo-depth: 128 tx-fifo-depth:
150 $ref: /schemas/types.yaml#/definitions/uin !! 129 $ref: /schemas/types.yaml#definitions/uint32
151 description: 130 description:
152 The size of the controller\'s transmit f 131 The size of the controller\'s transmit fifo in bytes. This
153 is used for components that can have con 132 is used for components that can have configurable fifo sizes.
154 133
155 managed: 134 managed:
156 description: 135 description:
157 Specifies the PHY management type. If au 136 Specifies the PHY management type. If auto is set and fixed-link
158 is not specified, it uses MDIO for manag 137 is not specified, it uses MDIO for management.
159 $ref: /schemas/types.yaml#/definitions/str !! 138 $ref: /schemas/types.yaml#definitions/string
160 default: auto 139 default: auto
161 enum: 140 enum:
162 - auto 141 - auto
163 - in-band-status 142 - in-band-status
164 143
165 fixed-link: 144 fixed-link:
166 oneOf: !! 145 allOf:
167 - $ref: /schemas/types.yaml#/definitions !! 146 - if:
168 deprecated: true !! 147 type: array
169 items: !! 148 then:
170 - minimum: 0 !! 149 deprecated: true
171 maximum: 31 !! 150 minItems: 1
172 description: !! 151 maxItems: 1
173 Emulated PHY ID, choose any but !! 152 items:
174 specified fixed-links !! 153 items:
175 !! 154 - minimum: 0
176 - enum: [0, 1] !! 155 maximum: 31
177 description: !! 156 description:
178 Duplex configuration. 0 for half !! 157 Emulated PHY ID, choose any but unique to the all
179 full duplex !! 158 specified fixed-links
180 !! 159
181 - enum: [10, 100, 1000, 2500, 10000] !! 160 - enum: [0, 1]
182 description: !! 161 description:
183 Link speed in Mbits/sec. !! 162 Duplex configuration. 0 for half duplex or 1 for
184 !! 163 full duplex
185 - enum: [0, 1] !! 164
186 description: !! 165 - enum: [10, 100, 1000]
187 Pause configuration. 0 for no pa !! 166 description:
188 !! 167 Link speed in Mbits/sec.
189 - enum: [0, 1] !! 168
190 description: !! 169 - enum: [0, 1]
191 Asymmetric pause configuration. !! 170 description:
192 pause, 1 for asymmetric pause !! 171 Pause configuration. 0 for no pause, 1 for pause
193 - type: object !! 172
194 additionalProperties: false !! 173 - enum: [0, 1]
195 properties: !! 174 description:
196 speed: !! 175 Asymmetric pause configuration. 0 for no asymmetric
197 description: !! 176 pause, 1 for asymmetric pause
198 Link speed. !! 177
199 $ref: /schemas/types.yaml#/definit !! 178
200 enum: [10, 100, 1000, 2500, 10000] !! 179 - if:
201 !! 180 type: object
202 full-duplex: !! 181 then:
203 $ref: /schemas/types.yaml#/definit !! 182 properties:
204 description: !! 183 speed:
205 Indicates that full-duplex is us !! 184 description:
206 duplex is assumed. !! 185 Link speed.
207 !! 186 $ref: /schemas/types.yaml#definitions/uint32
208 pause: !! 187 enum: [10, 100, 1000]
209 $ref: /schemas/types.yaml#/definit !! 188
210 description: !! 189 full-duplex:
211 Indicates that pause should be e !! 190 $ref: /schemas/types.yaml#definitions/flag
212 !! 191 description:
213 asym-pause: !! 192 Indicates that full-duplex is used. When absent, half
214 $ref: /schemas/types.yaml#/definit !! 193 duplex is assumed.
215 description: !! 194
216 Indicates that asym_pause should !! 195 asym-pause:
217 !! 196 $ref: /schemas/types.yaml#definitions/flag
218 link-gpios: !! 197 description:
219 maxItems: 1 !! 198 Indicates that asym_pause should be enabled.
220 description: !! 199
221 GPIO to determine if the link is !! 200 link-gpios:
222 !! 201 maxItems: 1
223 required: !! 202 description:
224 - speed !! 203 GPIO to determine if the link is up
225 <<
226 leds: <<
227 description: <<
228 Describes the LEDs associated by Etherne <<
229 These LEDs are not integrated in the PHY <<
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 204
287 additionalProperties: true !! 205 required:
>> 206 - speed
288 207
289 ... 208 ...
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.