Merge tag 'mfd-for-linus-4.1' of git://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd
[firefly-linux-kernel-4.4.55.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 for all the ethernet interfaces:
7 - compatible: Should state binding information from the following list,
8   - "apm,xgene-enet":    RGMII based 1G interface
9   - "apm,xgene1-sgenet": SGMII based 1G interface
10   - "apm,xgene1-xgenet": XFI based 10G interface
11 - reg: Address and length of the register set for the device. It contains the
12   information of registers in the same order as described by reg-names
13 - reg-names: Should contain the register set names
14   - "enet_csr": Ethernet control and status register address space
15   - "ring_csr": Descriptor ring control and status register address space
16   - "ring_cmd": Descriptor ring command register address space
17 - interrupts: Ethernet main interrupt
18 - clocks: Reference to the clock entry.
19 - local-mac-address: MAC address assigned to this device
20 - phy-connection-type: Interface type between ethernet device and PHY device
21
22 Required properties for ethernet interfaces that have external PHY:
23 - phy-handle: Reference to a PHY node connected to this device
24
25 - mdio: Device tree subnode with the following required properties:
26   - compatible: Must be "apm,xgene-mdio".
27   - #address-cells: Must be <1>.
28   - #size-cells: Must be <0>.
29
30   For the phy on the mdio bus, there must be a node with the following fields:
31   - compatible: PHY identifier.  Please refer ./phy.txt for the format.
32   - reg: The ID number for the phy.
33
34 Optional properties:
35 - status: Should be "ok" or "disabled" for enabled/disabled. Default is "ok".
36
37 Example:
38         menetclk: menetclk {
39                 compatible = "apm,xgene-device-clock";
40                 clock-output-names = "menetclk";
41                 status = "ok";
42         };
43
44         menet: ethernet@17020000 {
45                 compatible = "apm,xgene-enet";
46                 status = "disabled";
47                 reg = <0x0 0x17020000 0x0 0xd100>,
48                       <0x0 0X17030000 0x0 0X400>,
49                       <0x0 0X10000000 0x0 0X200>;
50                 reg-names = "enet_csr", "ring_csr", "ring_cmd";
51                 interrupts = <0x0 0x3c 0x4>;
52                 clocks = <&menetclk 0>;
53                 local-mac-address = [00 01 73 00 00 01];
54                 phy-connection-type = "rgmii";
55                 phy-handle = <&menetphy>;
56                 mdio {
57                         compatible = "apm,xgene-mdio";
58                         #address-cells = <1>;
59                         #size-cells = <0>;
60                         menetphy: menetphy@3 {
61                                 compatible = "ethernet-phy-id001c.c915";
62                                 reg = <0x3>;
63                         };
64
65                 };
66         };
67
68 /* Board-specific peripheral configurations */
69 &menet {
70         status = "ok";
71 };