Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e8f08ee0 authored by Sergei Shtylyov's avatar Sergei Shtylyov Committed by David S. Miller
Browse files

DT: net: document Ethernet bindings in one place 



This patch is an attempt to gather the Ethernet related bindings in one file,
like it's done in the MMC and some other subsystems. It should save some of
the trouble of documenting several properties over and over in each binding
document, instead only making reference to the main file.

I have used the Embedded Power Architecture(TM) Platform Requirements (ePAPR)
standard as a base for the properties description, also documenting some ad-hoc
properties that have been introduced over time despite having direct analogs in
ePAPR.

Signed-off-by: default avatarSergei Shtylyov <sergei.shtylyov@cogentembedded.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 6df3efcc

Documentation/devicetree/bindings/net/allwinner,sun4i-emac.txt

+1 −5
Original line number Diff line number Diff line
@@ -5,13 +5,9 @@ Required properties: 
              "allwinner,sun4i-emac")

- reg: address and length of the register set for the device.

- interrupts: interrupt for the device

- phy: A phandle to a phy node defining the PHY address (as the reg

  property, a single integer).

- phy: see ethernet.txt file in the same directory.

- clocks: A phandle to the reference clock for this device



Optional properties:

- (local-)mac-address: mac address to be used by this driver



Example:



emac: ethernet@01c0b000 {

Documentation/devicetree/bindings/net/arc_emac.txt

+2 −9
Original line number Diff line number Diff line
@@ -6,19 +6,12 @@ Required properties: 
- interrupts: Should contain the EMAC interrupts

- clock-frequency: CPU frequency. It is needed to calculate and set polling

period of EMAC.

- max-speed: Maximum supported data-rate in Mbit/s. In some HW configurations

bandwidth of external memory controller might be a limiting factor. That's why

it's required to specify which data-rate is supported on current SoC or FPGA.

For example if only 10 Mbit/s is supported (10BASE-T) set "10". If 100 Mbit/s is

supported (100BASE-TX) set "100".

- phy: PHY device attached to the EMAC via MDIO bus

- max-speed: see ethernet.txt file in the same directory.

- phy: see ethernet.txt file in the same directory.



Child nodes of the driver are the individual PHY devices connected to the

MDIO bus. They must have a "reg" property given the PHY address on the MDIO bus.



Optional properties:

- mac-address: 6 bytes, mac address



Examples:



	ethernet@c0fc2000 {

Documentation/devicetree/bindings/net/broadcom-bcmgenet.txt

+3 −6
Original line number Diff line number Diff line
@@ -7,9 +7,7 @@ Required properties: 
- interrupts: must be two cells, the first cell is the general purpose

  interrupt line, while the second cell is the interrupt for the ring

  RX and TX queues operating in ring mode

- phy-mode: String, operation mode of the PHY interface. Supported values are

  "mii", "rgmii", "rgmii-txid", "rev-mii", "moca". Analogous to ePAPR

  "phy-connection-type" values

- phy-mode: see ethernet.txt file in the same directory

- address-cells: should be 1

- size-cells: should be 1
@@ -20,9 +18,8 @@ Optional properties: 
- clock-names: When provided, names of the functional clock phandles, first

  name should be "enet" and second should be "enet-wol".



- phy-handle: A phandle to a phy node defining the PHY address (as the reg

  property, a single integer), used to describe configurations where a PHY

  (internal or external) is used.

- phy-handle: See ethernet.txt file in the same directory; used to describe

  configurations where a PHY (internal or external) is used.



- fixed-link: When the GENET interface is connected to a MoCA hardware block or

  when operating in a RGMII to RGMII type of connection, or when the MDIO bus is

Documentation/devicetree/bindings/net/cavium-mix.txt

+1 −6
Original line number Diff line number Diff line
@@ -18,12 +18,7 @@ Properties: 
- interrupts: Two interrupt specifiers.  The first is the MIX

  interrupt routing and the second the routing for the AGL interrupts.



- mac-address: Optional, the MAC address to assign to the device.



- local-mac-address: Optional, the MAC address to assign to the device

  if mac-address is not specified.



- phy-handle: Optional, a phandle for the PHY device connected to this device.

- phy-handle: Optional, see ethernet.txt file in the same directory.



Example:

	ethernet@1070000100800 {

Documentation/devicetree/bindings/net/cavium-pip.txt

+1 −6
Original line number Diff line number Diff line
@@ -35,12 +35,7 @@ Properties for PIP port which is a child the PIP interface: 


- reg: The port number within the interface group.



- mac-address: Optional, the MAC address to assign to the device.



- local-mac-address: Optional, the MAC address to assign to the device

  if mac-address is not specified.



- phy-handle: Optional, a phandle for the PHY device connected to this device.

- phy-handle: Optional, see ethernet.txt file in the same directory.



Example: