blob: cfc376bc977aa0a25e64d4e1ef617a1a326fe634 [file] [log] [blame]
Simon Glass7b9cf842015-04-05 16:07:35 -06001The following properties are common to the Ethernet controllers:
2
Rasmus Villemoes93ce16f2019-12-12 14:38:23 +00003NOTE: All 'phy*' properties documented below are Ethernet specific. For the
4generic PHY 'phys' property, see
5Documentation/devicetree/bindings/phy/phy-bindings.txt.
6
Simon Glass7b9cf842015-04-05 16:07:35 -06007- local-mac-address: array of 6 bytes, specifies the MAC address that was
8 assigned to the network device;
9- mac-address: array of 6 bytes, specifies the MAC address that was last used by
10 the boot program; should be used in cases where the MAC address assigned to
11 the device by the boot program is different from the "local-mac-address"
12 property;
Rasmus Villemoes93ce16f2019-12-12 14:38:23 +000013- nvmem-cells: phandle, reference to an nvmem node for the MAC address;
14- nvmem-cell-names: string, should be "mac-address" if nvmem is to be used;
Simon Glass7b9cf842015-04-05 16:07:35 -060015- max-speed: number, specifies maximum speed in Mbit/s supported by the device;
16- max-frame-size: number, maximum transfer unit (IEEE defined MTU), rather than
Rasmus Villemoes93ce16f2019-12-12 14:38:23 +000017 the maximum frame size (there's contradiction in the Devicetree
18 Specification).
19- phy-mode: string, operation mode of the PHY interface. This is now a de-facto
20 standard property; supported values are:
21 * "internal"
22 * "mii"
23 * "gmii"
24 * "sgmii"
25 * "qsgmii"
26 * "tbi"
27 * "rev-mii"
28 * "rmii"
29 * "rgmii" (RX and TX delays are added by the MAC when required)
30 * "rgmii-id" (RGMII with internal RX and TX delays provided by the PHY, the
31 MAC should not add the RX or TX delays in this case)
32 * "rgmii-rxid" (RGMII with internal RX delay provided by the PHY, the MAC
33 should not add an RX delay in this case)
34 * "rgmii-txid" (RGMII with internal TX delay provided by the PHY, the MAC
35 should not add an TX delay in this case)
36 * "rtbi"
37 * "smii"
38 * "xgmii"
39 * "trgmii"
40 * "2000base-x",
41 * "2500base-x",
42 * "rxaui"
43 * "xaui"
44 * "10gbase-kr" (10GBASE-KR, XFI, SFI)
45- phy-connection-type: the same as "phy-mode" property but described in the
46 Devicetree Specification;
Simon Glass7b9cf842015-04-05 16:07:35 -060047- phy-handle: phandle, specifies a reference to a node representing a PHY
Rasmus Villemoes93ce16f2019-12-12 14:38:23 +000048 device; this property is described in the Devicetree Specification and so
49 preferred;
Simon Glass7b9cf842015-04-05 16:07:35 -060050- phy: the same as "phy-handle" property, not recommended for new bindings.
51- phy-device: the same as "phy-handle" property, not recommended for new
52 bindings.
Rasmus Villemoes93ce16f2019-12-12 14:38:23 +000053- rx-fifo-depth: the size of the controller's receive fifo in bytes. This
54 is used for components that can have configurable receive fifo sizes,
55 and is useful for determining certain configuration settings such as
56 flow control thresholds.
57- tx-fifo-depth: the size of the controller's transmit fifo in bytes. This
58 is used for components that can have configurable fifo sizes.
59- managed: string, specifies the PHY management type. Supported values are:
60 "auto", "in-band-status". "auto" is the default, it usess MDIO for
61 management if fixed-link is not specified.
Simon Glass7b9cf842015-04-05 16:07:35 -060062
63Child nodes of the Ethernet controller are typically the individual PHY devices
64connected via the MDIO bus (sometimes the MDIO bus controller is separate).
65They are described in the phy.txt file in this same directory.
Rasmus Villemoes93ce16f2019-12-12 14:38:23 +000066For non-MDIO PHY management see fixed-link.txt.