Simon Glass | a71fa3f | 2015-04-05 16:07:35 -0600 | [diff] [blame] | 1 | The following properties are common to the Ethernet controllers: |
| 2 | |
Rasmus Villemoes | 607174a | 2019-12-12 14:38:23 +0000 | [diff] [blame] | 3 | NOTE: All 'phy*' properties documented below are Ethernet specific. For the |
| 4 | generic PHY 'phys' property, see |
| 5 | Documentation/devicetree/bindings/phy/phy-bindings.txt. |
| 6 | |
Simon Glass | a71fa3f | 2015-04-05 16:07:35 -0600 | [diff] [blame] | 7 | - 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 Villemoes | 607174a | 2019-12-12 14:38:23 +0000 | [diff] [blame] | 13 | - 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 Glass | a71fa3f | 2015-04-05 16:07:35 -0600 | [diff] [blame] | 15 | - 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 Villemoes | 607174a | 2019-12-12 14:38:23 +0000 | [diff] [blame] | 17 | 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" |
Vladimir Oltean | 6a6e402 | 2021-09-18 15:32:34 +0300 | [diff] [blame] | 44 | * "10gbase-r" (This is the IEEE 802.3 Clause 49 defined 10GBASE-R protocol |
| 45 | used with various different mediums. Please refer to the IEEE standard for |
| 46 | a definition of this. Note: 10GBASE-R is just one protocol that can be used |
| 47 | with XFI and SFI. XFI and SFI permit multiple protocols over a single |
| 48 | SERDES lane, and also defines the electrical characteristics of the signals |
| 49 | with a host compliance board plugged into the host XFP/SFP connector. |
| 50 | Therefore, XFI and SFI are not PHY interface types in their own right.) |
| 51 | * "10gbase-kr" (This is the IEEE 802.3 Clause 49 defined 10GBASE-R with |
| 52 | Clause 73 autonegotiation. Please refer to the IEEE standard for further |
| 53 | information. Note: due to legacy usage, some 10GBASE-R usage incorrectly |
| 54 | makes use of this definition). |
Rasmus Villemoes | 607174a | 2019-12-12 14:38:23 +0000 | [diff] [blame] | 55 | - phy-connection-type: the same as "phy-mode" property but described in the |
| 56 | Devicetree Specification; |
Simon Glass | a71fa3f | 2015-04-05 16:07:35 -0600 | [diff] [blame] | 57 | - phy-handle: phandle, specifies a reference to a node representing a PHY |
Rasmus Villemoes | 607174a | 2019-12-12 14:38:23 +0000 | [diff] [blame] | 58 | device; this property is described in the Devicetree Specification and so |
| 59 | preferred; |
Simon Glass | a71fa3f | 2015-04-05 16:07:35 -0600 | [diff] [blame] | 60 | - phy: the same as "phy-handle" property, not recommended for new bindings. |
| 61 | - phy-device: the same as "phy-handle" property, not recommended for new |
| 62 | bindings. |
Rasmus Villemoes | 607174a | 2019-12-12 14:38:23 +0000 | [diff] [blame] | 63 | - rx-fifo-depth: the size of the controller's receive fifo in bytes. This |
| 64 | is used for components that can have configurable receive fifo sizes, |
| 65 | and is useful for determining certain configuration settings such as |
| 66 | flow control thresholds. |
| 67 | - tx-fifo-depth: the size of the controller's transmit fifo in bytes. This |
| 68 | is used for components that can have configurable fifo sizes. |
| 69 | - managed: string, specifies the PHY management type. Supported values are: |
| 70 | "auto", "in-band-status". "auto" is the default, it usess MDIO for |
| 71 | management if fixed-link is not specified. |
Simon Glass | a71fa3f | 2015-04-05 16:07:35 -0600 | [diff] [blame] | 72 | |
| 73 | Child nodes of the Ethernet controller are typically the individual PHY devices |
| 74 | connected via the MDIO bus (sometimes the MDIO bus controller is separate). |
| 75 | They are described in the phy.txt file in this same directory. |
Rasmus Villemoes | 607174a | 2019-12-12 14:38:23 +0000 | [diff] [blame] | 76 | For non-MDIO PHY management see fixed-link.txt. |