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