[deliverable/linux.git] / Documentation / devicetree / bindings / net / ethernet.txt

The following properties are common to the Ethernet controllers:

- local-mac-address: array of 6 bytes, specifies the MAC address that was
  assigned to the network device;
- mac-address: array of 6 bytes, specifies the MAC address that was last used by
  the boot program; should be used in cases where the MAC address assigned to
  the device by the boot program is different from the "local-mac-address"
  property;
- max-speed: number, specifies maximum speed in Mbit/s supported by the device;
- max-frame-size: number, maximum transfer unit (IEEE defined MTU), rather than
  the maximum frame size (there's contradiction in ePAPR).
- phy-mode: string, operation mode of the PHY interface; supported values are
  "mii", "gmii", "sgmii", "qsgmii", "tbi", "rev-mii", "rmii", "rgmii", "rgmii-id",
  "rgmii-rxid", "rgmii-txid", "rtbi", "smii", "xgmii"; this is now a de-facto
  standard property;
- phy-connection-type: the same as "phy-mode" property but described in ePAPR;
- phy-handle: phandle, specifies a reference to a node representing a PHY
  device; this property is described in ePAPR and so preferred;
- phy: the same as "phy-handle" property, not recommended for new bindings.
- phy-device: the same as "phy-handle" property, not recommended for new
  bindings.
- rx-fifo-depth: the size of the controller's receive fifo in bytes. This
  is used for components that can have configurable receive fifo sizes,
  and is useful for determining certain configuration settings such as
  flow control thresholds.
- tx-fifo-depth: the size of the controller's transmit fifo in bytes. This
  is used for components that can have configurable fifo sizes.
- managed: string, specifies the PHY management type. Supported values are:
  "auto", "in-band-status". "auto" is the default, it usess MDIO for
  management if fixed-link is not specified.

Child nodes of the Ethernet controller are typically the individual PHY devices
connected via the MDIO bus (sometimes the MDIO bus controller is separate).
They are described in the phy.txt file in this same directory.
For non-MDIO PHY management see fixed-link.txt.
Commit	Line	Data
e8f08ee0 SS	1	The following properties are common to the Ethernet controllers:
	2
	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 ePAPR).
	12	- phy-mode: string, operation mode of the PHY interface; supported values are
b9d12085	13	"mii", "gmii", "sgmii", "qsgmii", "tbi", "rev-mii", "rmii", "rgmii", "rgmii-id",
e8f08ee0 SS	14	"rgmii-rxid", "rgmii-txid", "rtbi", "smii", "xgmii"; this is now a de-facto
	15	standard property;
	16	- phy-connection-type: the same as "phy-mode" property but described in ePAPR;
	17	- phy-handle: phandle, specifies a reference to a node representing a PHY
	18	device; this property is described in ePAPR and so preferred;
	19	- phy: the same as "phy-handle" property, not recommended for new bindings.
	20	- phy-device: the same as "phy-handle" property, not recommended for new
	21	bindings.
13967f0c VB	22	- rx-fifo-depth: the size of the controller's receive fifo in bytes. This
	23	is used for components that can have configurable receive fifo sizes,
	24	and is useful for determining certain configuration settings such as
	25	flow control thresholds.
	26	- tx-fifo-depth: the size of the controller's transmit fifo in bytes. This
	27	is used for components that can have configurable fifo sizes.
4cba5c21 SS	28	- managed: string, specifies the PHY management type. Supported values are:
	29	"auto", "in-band-status". "auto" is the default, it usess MDIO for
	30	management if fixed-link is not specified.
e8f08ee0 SS	31
	32	Child nodes of the Ethernet controller are typically the individual PHY devices
	33	connected via the MDIO bus (sometimes the MDIO bus controller is separate).
	34	They are described in the phy.txt file in this same directory.
4cba5c21	35	For non-MDIO PHY management see fixed-link.txt.