xref: /linux/Documentation/devicetree/bindings/net/apm-xgene-enet.txt (revision 4949009eb8d40a441dcddcd96e101e77d31cf1b2)
1APM X-Gene SoC Ethernet nodes
2
3Ethernet nodes are defined to describe on-chip ethernet interfaces in
4APM X-Gene SoC.
5
6Required properties for all the ethernet interfaces:
7- compatible: Should be "apm,xgene-enet"
8- reg: Address and length of the register set for the device. It contains the
9  information of registers in the same order as described by reg-names
10- reg-names: Should contain the register set names
11  - "enet_csr": Ethernet control and status register address space
12  - "ring_csr": Descriptor ring control and status register address space
13  - "ring_cmd": Descriptor ring command register address space
14- interrupts: Ethernet main interrupt
15- clocks: Reference to the clock entry.
16- local-mac-address: MAC address assigned to this device
17- phy-connection-type: Interface type between ethernet device and PHY device
18
19Required properties for ethernet interfaces that have external PHY:
20- phy-handle: Reference to a PHY node connected to this device
21
22- mdio: Device tree subnode with the following required properties:
23  - compatible: Must be "apm,xgene-mdio".
24  - #address-cells: Must be <1>.
25  - #size-cells: Must be <0>.
26
27  For the phy on the mdio bus, there must be a node with the following fields:
28  - compatible: PHY identifier.  Please refer ./phy.txt for the format.
29  - reg: The ID number for the phy.
30
31Optional properties:
32- status: Should be "ok" or "disabled" for enabled/disabled. Default is "ok".
33
34Example:
35	menetclk: menetclk {
36		compatible = "apm,xgene-device-clock";
37		clock-output-names = "menetclk";
38		status = "ok";
39	};
40
41	menet: ethernet@17020000 {
42		compatible = "apm,xgene-enet";
43		status = "disabled";
44		reg = <0x0 0x17020000 0x0 0xd100>,
45		      <0x0 0X17030000 0x0 0X400>,
46		      <0x0 0X10000000 0x0 0X200>;
47		reg-names = "enet_csr", "ring_csr", "ring_cmd";
48		interrupts = <0x0 0x3c 0x4>;
49		clocks = <&menetclk 0>;
50		local-mac-address = [00 01 73 00 00 01];
51		phy-connection-type = "rgmii";
52		phy-handle = <&menetphy>;
53		mdio {
54			compatible = "apm,xgene-mdio";
55			#address-cells = <1>;
56			#size-cells = <0>;
57			menetphy: menetphy@3 {
58				compatible = "ethernet-phy-id001c.c915";
59				reg = <0x3>;
60			};
61
62		};
63	};
64
65/* Board-specific peripheral configurations */
66&menet {
67        status = "ok";
68};
69