^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) # SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) %YAML 1.2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ---
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) $id: http://devicetree.org/schemas/net/ethernet-controller.yaml#
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) $schema: http://devicetree.org/meta-schemas/core.yaml#
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) title: Ethernet Controller Generic Binding
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) maintainers:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) - David S. Miller <davem@davemloft.net>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) properties:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) $nodename:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) pattern: "^ethernet(@.*)?$"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) local-mac-address:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) Specifies the MAC address that was assigned to the network device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) $ref: /schemas/types.yaml#definitions/uint8-array
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) - minItems: 6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) maxItems: 6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) mac-address:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) Specifies the MAC address that was last used by the boot
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) program; should be used in cases where the MAC address assigned
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) to the device by the boot program is different from the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) local-mac-address property.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) $ref: /schemas/types.yaml#definitions/uint8-array
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) - minItems: 6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) maxItems: 6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) max-frame-size:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) $ref: /schemas/types.yaml#definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) Maximum transfer unit (IEEE defined MTU), rather than the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) maximum frame size (there\'s contradiction in the Devicetree
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) Specification).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) max-speed:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) $ref: /schemas/types.yaml#definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) Specifies maximum speed in Mbit/s supported by the device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) nvmem-cells:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) maxItems: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) Reference to an nvmem node for the MAC address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) nvmem-cell-names:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) const: mac-address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) phy-connection-type:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) Specifies interface type between the Ethernet device and a physical
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) layer (PHY) device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) enum:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) # There is not a standard bus between the MAC and the PHY,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) # something proprietary is being used to embed the PHY in the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) # MAC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) - internal
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) - mii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) - gmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) - sgmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) - qsgmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) - tbi
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) - rev-mii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) - rmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) # RX and TX delays are added by the MAC when required
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) - rgmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) # RGMII with internal RX and TX delays provided by the PHY,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) # the MAC should not add the RX or TX delays in this case
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) - rgmii-id
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) # RGMII with internal RX delay provided by the PHY, the MAC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) # should not add an RX delay in this case
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) - rgmii-rxid
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) # RGMII with internal TX delay provided by the PHY, the MAC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) # should not add an TX delay in this case
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) - rgmii-txid
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) - rtbi
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) - smii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) - xgmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) - trgmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) - 1000base-x
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) - 2500base-x
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) - rxaui
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) - xaui
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) # 10GBASE-KR, XFI, SFI
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) - 10gbase-kr
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) - usxgmii
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) phy-mode:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) $ref: "#/properties/phy-connection-type"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) phy-handle:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) $ref: /schemas/types.yaml#definitions/phandle
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) Specifies a reference to a node representing a PHY device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) phy:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) $ref: "#/properties/phy-handle"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) deprecated: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) phy-device:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) $ref: "#/properties/phy-handle"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) deprecated: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) rx-fifo-depth:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) $ref: /schemas/types.yaml#definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) The size of the controller\'s receive fifo in bytes. This is used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) for components that can have configurable receive fifo sizes,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) and is useful for determining certain configuration settings
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) such as flow control thresholds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) rx-internal-delay-ps:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) $ref: /schemas/types.yaml#/definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) description: |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) RGMII Receive Clock Delay defined in pico seconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) This is used for controllers that have configurable RX internal delays.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) If this property is present then the MAC applies the RX delay.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) sfp:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) $ref: /schemas/types.yaml#definitions/phandle
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) Specifies a reference to a node representing a SFP cage.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) tx-fifo-depth:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) $ref: /schemas/types.yaml#definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) The size of the controller\'s transmit fifo in bytes. This
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) is used for components that can have configurable fifo sizes.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) tx-internal-delay-ps:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) $ref: /schemas/types.yaml#/definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) description: |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) RGMII Transmit Clock Delay defined in pico seconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) This is used for controllers that have configurable TX internal delays.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) If this property is present then the MAC applies the TX delay.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) managed:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) Specifies the PHY management type. If auto is set and fixed-link
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) is not specified, it uses MDIO for management.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) $ref: /schemas/types.yaml#definitions/string
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) default: auto
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) enum:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) - auto
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) - in-band-status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) fixed-link:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) allOf:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) - if:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) type: array
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) then:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) deprecated: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) minItems: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) maxItems: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) items:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) - minimum: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) maximum: 31
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) Emulated PHY ID, choose any but unique to the all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) specified fixed-links
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) - enum: [0, 1]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) Duplex configuration. 0 for half duplex or 1 for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) full duplex
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) - enum: [10, 100, 1000]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) Link speed in Mbits/sec.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) - enum: [0, 1]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) Pause configuration. 0 for no pause, 1 for pause
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) - enum: [0, 1]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) Asymmetric pause configuration. 0 for no asymmetric
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) pause, 1 for asymmetric pause
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) - if:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) type: object
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) then:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) properties:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) speed:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) Link speed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) $ref: /schemas/types.yaml#definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) enum: [10, 100, 1000]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) full-duplex:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) $ref: /schemas/types.yaml#definitions/flag
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) Indicates that full-duplex is used. When absent, half
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) duplex is assumed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) pause:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) $ref: /schemas/types.yaml#definitions/flag
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) Indicates that pause should be enabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) asym-pause:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) $ref: /schemas/types.yaml#definitions/flag
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) Indicates that asym_pause should be enabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) link-gpios:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) maxItems: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) GPIO to determine if the link is up
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) required:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) - speed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) additionalProperties: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) ...