Merge tag 'v3.17-rc4' into sched/core, to prevent conflicts with upcoming patches...
[cascardo/linux.git] / Documentation / devicetree / bindings / net / apm-xgene-enet.txt
1 APM X-Gene SoC Ethernet nodes
2
3 Ethernet nodes are defined to describe on-chip ethernet interfaces in
4 APM X-Gene SoC.
5
6 Required properties:
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 - phy-handle: Reference to a PHY node connected to this device
19
20 - mdio: Device tree subnode with the following required properties:
21   - compatible: Must be "apm,xgene-mdio".
22   - #address-cells: Must be <1>.
23   - #size-cells: Must be <0>.
24
25   For the phy on the mdio bus, there must be a node with the following fields:
26   - compatible: PHY identifier.  Please refer ./phy.txt for the format.
27   - reg: The ID number for the phy.
28
29 Optional properties:
30 - status: Should be "ok" or "disabled" for enabled/disabled. Default is "ok".
31
32 Example:
33         menetclk: menetclk {
34                 compatible = "apm,xgene-device-clock";
35                 clock-output-names = "menetclk";
36                 status = "ok";
37         };
38
39         menet: ethernet@17020000 {
40                 compatible = "apm,xgene-enet";
41                 status = "disabled";
42                 reg = <0x0 0x17020000 0x0 0xd100>,
43                       <0x0 0X17030000 0x0 0X400>,
44                       <0x0 0X10000000 0x0 0X200>;
45                 reg-names = "enet_csr", "ring_csr", "ring_cmd";
46                 interrupts = <0x0 0x3c 0x4>;
47                 clocks = <&menetclk 0>;
48                 local-mac-address = [00 01 73 00 00 01];
49                 phy-connection-type = "rgmii";
50                 phy-handle = <&menetphy>;
51                 mdio {
52                         compatible = "apm,xgene-mdio";
53                         #address-cells = <1>;
54                         #size-cells = <0>;
55                         menetphy: menetphy@3 {
56                                 compatible = "ethernet-phy-id001c.c915";
57                                 reg = <0x3>;
58                         };
59
60                 };
61         };
62
63 /* Board-specific peripheral configurations */
64 &menet {
65         status = "ok";
66 };