Merge branch 'mediatek-hw-lro'
[cascardo/linux.git] / Documentation / devicetree / bindings / net / mediatek-net.txt
1 MediaTek Frame Engine Ethernet controller
2 =========================================
3
4 The frame engine ethernet controller can be found on MediaTek SoCs. These SoCs
5 have dual GMAC each represented by a child node..
6
7 * Ethernet controller node
8
9 Required properties:
10 - compatible: Should be "mediatek,mt7623-eth"
11 - reg: Address and length of the register set for the device
12 - interrupts: Should contain the three frame engines interrupts in numeric
13         order. These are fe_int0, fe_int1 and fe_int2.
14 - clocks: the clock used by the core
15 - clock-names: the names of the clock listed in the clocks property. These are
16         "ethif", "esw", "gp2", "gp1"
17 - power-domains: phandle to the power domain that the ethernet is part of
18 - resets: Should contain a phandle to the ethsys reset signal
19 - reset-names: Should contain the reset signal name "eth"
20 - mediatek,ethsys: phandle to the syscon node that handles the port setup
21 - mediatek,pctl: phandle to the syscon node that handles the ports slew rate
22         and driver current
23
24 Optional properties:
25 - interrupt-parent: Should be the phandle for the interrupt controller
26   that services interrupts for this device
27 - mediatek,hwlro: the capability if the hardware supports LRO functions
28
29 * Ethernet MAC node
30
31 Required properties:
32 - compatible: Should be "mediatek,eth-mac"
33 - reg: The number of the MAC
34 - phy-handle: see ethernet.txt file in the same directory.
35
36 Example:
37
38 eth: ethernet@1b100000 {
39         compatible = "mediatek,mt7623-eth";
40         reg = <0 0x1b100000 0 0x20000>;
41         clocks = <&topckgen CLK_TOP_ETHIF_SEL>,
42                  <&ethsys CLK_ETHSYS_ESW>,
43                  <&ethsys CLK_ETHSYS_GP2>,
44                  <&ethsys CLK_ETHSYS_GP1>;
45         clock-names = "ethif", "esw", "gp2", "gp1";
46         interrupts = <GIC_SPI 200 IRQ_TYPE_LEVEL_LOW
47                       GIC_SPI 199 IRQ_TYPE_LEVEL_LOW
48                       GIC_SPI 198 IRQ_TYPE_LEVEL_LOW>;
49         power-domains = <&scpsys MT2701_POWER_DOMAIN_ETH>;
50         resets = <&ethsys MT2701_ETHSYS_ETH_RST>;
51         reset-names = "eth";
52         mediatek,ethsys = <&ethsys>;
53         mediatek,pctl = <&syscfg_pctl_a>;
54         mediatek,hwlro;
55         #address-cells = <1>;
56         #size-cells = <0>;
57
58         gmac1: mac@0 {
59                 compatible = "mediatek,eth-mac";
60                 reg = <0>;
61                 phy-handle = <&phy0>;
62         };
63
64         gmac2: mac@1 {
65                 compatible = "mediatek,eth-mac";
66                 reg = <1>;
67                 phy-handle = <&phy1>;
68         };
69
70         mdio-bus {
71                 phy0: ethernet-phy@0 {
72                         reg = <0>;
73                         phy-mode = "rgmii";
74                 };
75
76                 phy1: ethernet-phy@1 {
77                         reg = <1>;
78                         phy-mode = "rgmii";
79                 };
80         };
81 };