Merge tag 'v4.20' into next
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / net / socionext,uniphier-ave4.txt
1 * Socionext AVE ethernet controller
2
3 This describes the devicetree bindings for AVE ethernet controller
4 implemented on Socionext UniPhier SoCs.
5
6 Required properties:
7  - compatible: Should be
8         - "socionext,uniphier-pro4-ave4" : for Pro4 SoC
9         - "socionext,uniphier-pxs2-ave4" : for PXs2 SoC
10         - "socionext,uniphier-ld11-ave4" : for LD11 SoC
11         - "socionext,uniphier-ld20-ave4" : for LD20 SoC
12         - "socionext,uniphier-pxs3-ave4" : for PXs3 SoC
13  - reg: Address where registers are mapped and size of region.
14  - interrupts: Should contain the MAC interrupt.
15  - phy-mode: See ethernet.txt in the same directory. Allow to choose
16         "rgmii", "rmii", "mii", or "internal" according to the PHY.
17         The acceptable mode is SoC-dependent.
18  - phy-handle: Should point to the external phy device.
19         See ethernet.txt file in the same directory.
20  - clocks: A phandle to the clock for the MAC.
21         For Pro4 SoC, that is "socionext,uniphier-pro4-ave4",
22         another MAC clock, GIO bus clock and PHY clock are also required.
23  - clock-names: Should contain
24         - "ether", "ether-gb", "gio", "ether-phy" for Pro4 SoC
25         - "ether" for others
26  - resets: A phandle to the reset control for the MAC. For Pro4 SoC,
27         GIO bus reset is also required.
28  - reset-names: Should contain
29         - "ether", "gio" for Pro4 SoC
30         - "ether" for others
31  - socionext,syscon-phy-mode: A phandle to syscon with one argument
32         that configures phy mode. The argument is the ID of MAC instance.
33
34 Optional properties:
35  - local-mac-address: See ethernet.txt in the same directory.
36
37 Required subnode:
38  - mdio: A container for child nodes representing phy nodes.
39          See phy.txt in the same directory.
40
41 Example:
42
43         ether: ethernet@65000000 {
44                 compatible = "socionext,uniphier-ld20-ave4";
45                 reg = <0x65000000 0x8500>;
46                 interrupts = <0 66 4>;
47                 phy-mode = "rgmii";
48                 phy-handle = <&ethphy>;
49                 clock-names = "ether";
50                 clocks = <&sys_clk 6>;
51                 reset-names = "ether";
52                 resets = <&sys_rst 6>;
53                 socionext,syscon-phy-mode = <&soc_glue 0>;
54                 local-mac-address = [00 00 00 00 00 00];
55
56                 mdio {
57                         #address-cells = <1>;
58                         #size-cells = <0>;
59
60                         ethphy: ethphy@1 {
61                                 reg = <1>;
62                         };
63                 };
64         };