xref: /linux/Documentation/devicetree/bindings/net/rockchip-dwmac.yaml (revision 34dc1baba215b826e454b8d19e4f24adbeb7d00d) 
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/net/rockchip-dwmac.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Rockchip 10/100/1000 Ethernet driver(GMAC)
8
9maintainers:
10  - David Wu <david.wu@rock-chips.com>
11
12# We need a select here so we don't match all nodes with 'snps,dwmac'
13select:
14  properties:
15    compatible:
16      contains:
17        enum:
18          - rockchip,px30-gmac
19          - rockchip,rk3128-gmac
20          - rockchip,rk3228-gmac
21          - rockchip,rk3288-gmac
22          - rockchip,rk3308-gmac
23          - rockchip,rk3328-gmac
24          - rockchip,rk3366-gmac
25          - rockchip,rk3368-gmac
26          - rockchip,rk3399-gmac
27          - rockchip,rk3568-gmac
28          - rockchip,rk3588-gmac
29          - rockchip,rv1108-gmac
30          - rockchip,rv1126-gmac
31  required:
32    - compatible
33
34allOf:
35  - $ref: snps,dwmac.yaml#
36
37properties:
38  compatible:
39    oneOf:
40      - items:
41          - enum:
42              - rockchip,px30-gmac
43              - rockchip,rk3128-gmac
44              - rockchip,rk3228-gmac
45              - rockchip,rk3288-gmac
46              - rockchip,rk3308-gmac
47              - rockchip,rk3328-gmac
48              - rockchip,rk3366-gmac
49              - rockchip,rk3368-gmac
50              - rockchip,rk3399-gmac
51              - rockchip,rv1108-gmac
52      - items:
53          - enum:
54              - rockchip,rk3568-gmac
55              - rockchip,rk3588-gmac
56              - rockchip,rv1126-gmac
57          - const: snps,dwmac-4.20a
58
59  clocks:
60    minItems: 5
61    maxItems: 8
62
63  clock-names:
64    contains:
65      enum:
66        - stmmaceth
67        - mac_clk_tx
68        - mac_clk_rx
69        - aclk_mac
70        - pclk_mac
71        - clk_mac_ref
72        - clk_mac_refout
73        - clk_mac_speed
74
75  clock_in_out:
76    description:
77      For RGMII, it must be "input", means main clock(125MHz)
78      is not sourced from SoC's PLL, but input from PHY.
79      For RMII, "input" means PHY provides the reference clock(50MHz),
80      "output" means GMAC provides the reference clock.
81    $ref: /schemas/types.yaml#/definitions/string
82    enum: [input, output]
83    default: input
84
85  rockchip,grf:
86    description: The phandle of the syscon node for the general register file.
87    $ref: /schemas/types.yaml#/definitions/phandle
88
89  rockchip,php-grf:
90    description:
91      The phandle of the syscon node for the peripheral general register file.
92    $ref: /schemas/types.yaml#/definitions/phandle
93
94  tx_delay:
95    description: Delay value for TXD timing.
96    $ref: /schemas/types.yaml#/definitions/uint32
97    minimum: 0
98    maximum: 0x7F
99    default: 0x30
100
101  rx_delay:
102    description: Delay value for RXD timing.
103    $ref: /schemas/types.yaml#/definitions/uint32
104    minimum: 0
105    maximum: 0x7F
106    default: 0x10
107
108  phy-supply:
109    description: PHY regulator
110
111required:
112  - compatible
113  - clocks
114  - clock-names
115
116unevaluatedProperties: false
117
118examples:
119  - |
120    #include <dt-bindings/interrupt-controller/arm-gic.h>
121    #include <dt-bindings/clock/rk3288-cru.h>
122
123    gmac: ethernet@ff290000 {
124        compatible = "rockchip,rk3288-gmac";
125        reg = <0xff290000 0x10000>;
126        interrupts = <GIC_SPI 27 IRQ_TYPE_LEVEL_HIGH>;
127        interrupt-names = "macirq";
128        clocks = <&cru SCLK_MAC>,
129                 <&cru SCLK_MAC_RX>, <&cru SCLK_MAC_TX>,
130                 <&cru SCLK_MACREF>, <&cru SCLK_MACREF_OUT>,
131                 <&cru ACLK_GMAC>, <&cru PCLK_GMAC>;
132        clock-names = "stmmaceth",
133                      "mac_clk_rx", "mac_clk_tx",
134                      "clk_mac_ref", "clk_mac_refout",
135                      "aclk_mac", "pclk_mac";
136        assigned-clocks = <&cru SCLK_MAC>;
137        assigned-clock-parents = <&ext_gmac>;
138
139        rockchip,grf = <&grf>;
140        phy-mode = "rgmii";
141        clock_in_out = "input";
142        tx_delay = <0x30>;
143        rx_delay = <0x10>;
144    };
145