Merge tag 'armsoc-dt' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / net / macb.txt
1 * Cadence MACB/GEM Ethernet controller
2
3 Required properties:
4 - compatible: Should be "cdns,[<chip>-]{macb|gem}"
5   Use "cdns,at91rm9200-emac" Atmel at91rm9200 SoC.
6   Use "cdns,at91sam9260-macb" for Atmel at91sam9 SoCs.
7   Use "cdns,sam9x60-macb" for Microchip sam9x60 SoC.
8   Use "cdns,np4-macb" for NP4 SoC devices.
9   Use "cdns,at32ap7000-macb" for other 10/100 usage or use the generic form: "cdns,macb".
10   Use "cdns,pc302-gem" for Picochip picoXcell pc302 and later devices based on
11   the Cadence GEM, or the generic form: "cdns,gem".
12   Use "atmel,sama5d2-gem" for the GEM IP (10/100) available on Atmel sama5d2 SoCs.
13   Use "atmel,sama5d3-macb" for the 10/100Mbit IP available on Atmel sama5d3 SoCs.
14   Use "atmel,sama5d3-gem" for the Gigabit IP available on Atmel sama5d3 SoCs.
15   Use "atmel,sama5d4-gem" for the GEM IP (10/100) available on Atmel sama5d4 SoCs.
16   Use "cdns,zynq-gem" Xilinx Zynq-7xxx SoC.
17   Use "cdns,zynqmp-gem" for Zynq Ultrascale+ MPSoC.
18   Or the generic form: "cdns,emac".
19 - reg: Address and length of the register set for the device
20 - interrupts: Should contain macb interrupt
21 - phy-mode: See ethernet.txt file in the same directory.
22 - clock-names: Tuple listing input clock names.
23         Required elements: 'pclk', 'hclk'
24         Optional elements: 'tx_clk'
25         Optional elements: 'rx_clk' applies to cdns,zynqmp-gem
26         Optional elements: 'tsu_clk'
27 - clocks: Phandles to input clocks.
28
29 The MAC address will be determined using the optional properties
30 defined in ethernet.txt.
31
32 Optional properties for PHY child node:
33 - reset-gpios : Should specify the gpio for phy reset
34 - magic-packet : If present, indicates that the hardware supports waking
35   up via magic packet.
36 - phy-handle : see ethernet.txt file in the same directory
37
38 Examples:
39
40         macb0: ethernet@fffc4000 {
41                 compatible = "cdns,at32ap7000-macb";
42                 reg = <0xfffc4000 0x4000>;
43                 interrupts = <21>;
44                 phy-mode = "rmii";
45                 local-mac-address = [3a 0e 03 04 05 06];
46                 clock-names = "pclk", "hclk", "tx_clk";
47                 clocks = <&clkc 30>, <&clkc 30>, <&clkc 13>;
48                 ethernet-phy@1 {
49                         reg = <0x1>;
50                         reset-gpios = <&pioE 6 1>;
51                 };
52         };