1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2# Copyright 2019 BayLibre, SAS
3%YAML 1.2
4---
5$id: "http://devicetree.org/schemas/net/stm32-dwmac.yaml#"
6$schema: "http://devicetree.org/meta-schemas/core.yaml#"
7
8title: STMicroelectronics STM32 / MCU DWMAC glue layer controller
9
10maintainers:
11  - Alexandre Torgue <alexandre.torgue@foss.st.com>
12  - Christophe Roullier <christophe.roullier@foss.st.com>
13
14description:
15  This file documents platform glue layer for stmmac.
16
17# We need a select here so we don't match all nodes with 'snps,dwmac'
18select:
19  properties:
20    compatible:
21      contains:
22        enum:
23          - st,stm32-dwmac
24          - st,stm32mp1-dwmac
25  required:
26    - compatible
27
28allOf:
29  - $ref: "snps,dwmac.yaml#"
30
31properties:
32  compatible:
33    oneOf:
34      - items:
35          - enum:
36              - st,stm32mp1-dwmac
37          - const: snps,dwmac-4.20a
38      - items:
39          - enum:
40              - st,stm32-dwmac
41          - const: snps,dwmac-4.10a
42      - items:
43          - enum:
44              - st,stm32-dwmac
45          - const: snps,dwmac-3.50a
46
47  reg: true
48
49  reg-names:
50    items:
51      - const: stmmaceth
52
53  clocks:
54    minItems: 3
55    items:
56      - description: GMAC main clock
57      - description: MAC TX clock
58      - description: MAC RX clock
59      - description: For MPU family, used for power mode
60      - description: For MPU family, used for PHY without quartz
61      - description: PTP clock
62
63  clock-names:
64    minItems: 3
65    maxItems: 6
66    contains:
67      enum:
68        - stmmaceth
69        - mac-clk-tx
70        - mac-clk-rx
71        - ethstp
72        - eth-ck
73        - ptp_ref
74
75  st,syscon:
76    $ref: "/schemas/types.yaml#/definitions/phandle-array"
77    description:
78      Should be phandle/offset pair. The phandle to the syscon node which
79      encompases the glue register, and the offset of the control register
80
81  st,eth-clk-sel:
82    description:
83      set this property in RGMII PHY when you want to select RCC clock instead of ETH_CLK125.
84    type: boolean
85
86  st,eth-ref-clk-sel:
87    description:
88      set this property in RMII mode when you have PHY without crystal 50MHz and want to
89      select RCC clock instead of ETH_REF_CLK.
90    type: boolean
91
92required:
93  - compatible
94  - clocks
95  - clock-names
96  - st,syscon
97
98unevaluatedProperties: false
99
100examples:
101  - |
102    #include <dt-bindings/interrupt-controller/arm-gic.h>
103    #include <dt-bindings/clock/stm32mp1-clks.h>
104    #include <dt-bindings/reset/stm32mp1-resets.h>
105    #include <dt-bindings/mfd/stm32h7-rcc.h>
106    //Example 1
107     ethernet0: ethernet@5800a000 {
108           compatible = "st,stm32mp1-dwmac", "snps,dwmac-4.20a";
109           reg = <0x5800a000 0x2000>;
110           reg-names = "stmmaceth";
111           interrupts = <GIC_SPI 61 IRQ_TYPE_LEVEL_HIGH>;
112           interrupt-names = "macirq";
113           clock-names = "stmmaceth",
114                     "mac-clk-tx",
115                     "mac-clk-rx",
116                     "ethstp",
117                     "eth-ck";
118           clocks = <&rcc ETHMAC>,
119                <&rcc ETHTX>,
120                <&rcc ETHRX>,
121                <&rcc ETHSTP>,
122                <&rcc ETHCK_K>;
123           st,syscon = <&syscfg 0x4>;
124           snps,pbl = <2>;
125           snps,axi-config = <&stmmac_axi_config_0>;
126           snps,tso;
127           phy-mode = "rgmii";
128       };
129
130  - |
131    //Example 2 (MCU example)
132     ethernet1: ethernet@40028000 {
133           compatible = "st,stm32-dwmac", "snps,dwmac-3.50a";
134           reg = <0x40028000 0x8000>;
135           reg-names = "stmmaceth";
136           interrupts = <0 61 0>, <0 62 0>;
137           interrupt-names = "macirq", "eth_wake_irq";
138           clock-names = "stmmaceth", "mac-clk-tx", "mac-clk-rx";
139           clocks = <&rcc 0 25>, <&rcc 0 26>, <&rcc 0 27>;
140           st,syscon = <&syscfg 0x4>;
141           snps,pbl = <8>;
142           snps,mixed-burst;
143           phy-mode = "mii";
144       };
145
146  - |
147    //Example 3
148     ethernet2: ethernet@40027000 {
149           compatible = "st,stm32-dwmac", "snps,dwmac-4.10a";
150           reg = <0x40028000 0x8000>;
151           reg-names = "stmmaceth";
152           interrupts = <61>;
153           interrupt-names = "macirq";
154           clock-names = "stmmaceth", "mac-clk-tx", "mac-clk-rx";
155           clocks = <&rcc 62>, <&rcc 61>, <&rcc 60>;
156           st,syscon = <&syscfg 0x4>;
157           snps,pbl = <8>;
158           phy-mode = "mii";
159       };
160