1 // SPDX-License-Identifier: GPL-2.0-only
3 * Amlogic Meson8b, Meson8m2 and GXBB DWMAC glue layer
5 * Copyright (C) 2016 Martin Blumenstingl <martin.blumenstingl@googlemail.com>
9 #include <linux/clk-provider.h>
10 #include <linux/device.h>
11 #include <linux/ethtool.h>
13 #include <linux/ioport.h>
14 #include <linux/module.h>
15 #include <linux/of_device.h>
16 #include <linux/of_net.h>
17 #include <linux/mfd/syscon.h>
18 #include <linux/platform_device.h>
19 #include <linux/stmmac.h>
21 #include "stmmac_platform.h"
25 #define PRG_ETH0_RGMII_MODE BIT(0)
27 #define PRG_ETH0_EXT_PHY_MODE_MASK GENMASK(2, 0)
28 #define PRG_ETH0_EXT_RGMII_MODE 1
29 #define PRG_ETH0_EXT_RMII_MODE 4
31 /* mux to choose between fclk_div2 (bit unset) and mpll2 (bit set) */
32 #define PRG_ETH0_CLK_M250_SEL_SHIFT 4
33 #define PRG_ETH0_CLK_M250_SEL_MASK GENMASK(4, 4)
35 #define PRG_ETH0_TXDLY_SHIFT 5
36 #define PRG_ETH0_TXDLY_MASK GENMASK(6, 5)
38 /* divider for the result of m250_sel */
39 #define PRG_ETH0_CLK_M250_DIV_SHIFT 7
40 #define PRG_ETH0_CLK_M250_DIV_WIDTH 3
42 #define PRG_ETH0_RGMII_TX_CLK_EN 10
44 #define PRG_ETH0_INVERTED_RMII_CLK BIT(11)
45 #define PRG_ETH0_TX_AND_PHY_REF_CLK BIT(12)
47 #define MUX_CLK_NUM_PARENTS 2
51 struct meson8b_dwmac_data
{
52 int (*set_phy_mode
)(struct meson8b_dwmac
*dwmac
);
55 struct meson8b_dwmac
{
59 const struct meson8b_dwmac_data
*data
;
60 phy_interface_t phy_mode
;
61 struct clk
*rgmii_tx_clk
;
65 struct meson8b_dwmac_clk_configs
{
66 struct clk_mux m250_mux
;
67 struct clk_divider m250_div
;
68 struct clk_fixed_factor fixed_div2
;
69 struct clk_gate rgmii_tx_en
;
72 static void meson8b_dwmac_mask_bits(struct meson8b_dwmac
*dwmac
, u32 reg
,
77 data
= readl(dwmac
->regs
+ reg
);
79 data
|= (value
& mask
);
81 writel(data
, dwmac
->regs
+ reg
);
84 static struct clk
*meson8b_dwmac_register_clk(struct meson8b_dwmac
*dwmac
,
85 const char *name_suffix
,
86 const char **parent_names
,
88 const struct clk_ops
*ops
,
91 struct clk_init_data init
;
94 snprintf(clk_name
, sizeof(clk_name
), "%s#%s", dev_name(dwmac
->dev
),
99 init
.flags
= CLK_SET_RATE_PARENT
;
100 init
.parent_names
= parent_names
;
101 init
.num_parents
= num_parents
;
105 return devm_clk_register(dwmac
->dev
, hw
);
108 static int meson8b_init_rgmii_tx_clk(struct meson8b_dwmac
*dwmac
)
112 struct device
*dev
= dwmac
->dev
;
113 const char *parent_name
, *mux_parent_names
[MUX_CLK_NUM_PARENTS
];
114 struct meson8b_dwmac_clk_configs
*clk_configs
;
115 static const struct clk_div_table div_table
[] = {
116 { .div
= 2, .val
= 2, },
117 { .div
= 3, .val
= 3, },
118 { .div
= 4, .val
= 4, },
119 { .div
= 5, .val
= 5, },
120 { .div
= 6, .val
= 6, },
121 { .div
= 7, .val
= 7, },
122 { /* end of array */ }
125 clk_configs
= devm_kzalloc(dev
, sizeof(*clk_configs
), GFP_KERNEL
);
129 /* get the mux parents from DT */
130 for (i
= 0; i
< MUX_CLK_NUM_PARENTS
; i
++) {
133 snprintf(name
, sizeof(name
), "clkin%d", i
);
134 clk
= devm_clk_get(dev
, name
);
137 if (ret
!= -EPROBE_DEFER
)
138 dev_err(dev
, "Missing clock %s\n", name
);
142 mux_parent_names
[i
] = __clk_get_name(clk
);
145 clk_configs
->m250_mux
.reg
= dwmac
->regs
+ PRG_ETH0
;
146 clk_configs
->m250_mux
.shift
= PRG_ETH0_CLK_M250_SEL_SHIFT
;
147 clk_configs
->m250_mux
.mask
= PRG_ETH0_CLK_M250_SEL_MASK
;
148 clk
= meson8b_dwmac_register_clk(dwmac
, "m250_sel", mux_parent_names
,
149 MUX_CLK_NUM_PARENTS
, &clk_mux_ops
,
150 &clk_configs
->m250_mux
.hw
);
151 if (WARN_ON(IS_ERR(clk
)))
154 parent_name
= __clk_get_name(clk
);
155 clk_configs
->m250_div
.reg
= dwmac
->regs
+ PRG_ETH0
;
156 clk_configs
->m250_div
.shift
= PRG_ETH0_CLK_M250_DIV_SHIFT
;
157 clk_configs
->m250_div
.width
= PRG_ETH0_CLK_M250_DIV_WIDTH
;
158 clk_configs
->m250_div
.table
= div_table
;
159 clk_configs
->m250_div
.flags
= CLK_DIVIDER_ALLOW_ZERO
|
160 CLK_DIVIDER_ROUND_CLOSEST
;
161 clk
= meson8b_dwmac_register_clk(dwmac
, "m250_div", &parent_name
, 1,
163 &clk_configs
->m250_div
.hw
);
164 if (WARN_ON(IS_ERR(clk
)))
167 parent_name
= __clk_get_name(clk
);
168 clk_configs
->fixed_div2
.mult
= 1;
169 clk_configs
->fixed_div2
.div
= 2;
170 clk
= meson8b_dwmac_register_clk(dwmac
, "fixed_div2", &parent_name
, 1,
171 &clk_fixed_factor_ops
,
172 &clk_configs
->fixed_div2
.hw
);
173 if (WARN_ON(IS_ERR(clk
)))
176 parent_name
= __clk_get_name(clk
);
177 clk_configs
->rgmii_tx_en
.reg
= dwmac
->regs
+ PRG_ETH0
;
178 clk_configs
->rgmii_tx_en
.bit_idx
= PRG_ETH0_RGMII_TX_CLK_EN
;
179 clk
= meson8b_dwmac_register_clk(dwmac
, "rgmii_tx_en", &parent_name
, 1,
181 &clk_configs
->rgmii_tx_en
.hw
);
182 if (WARN_ON(IS_ERR(clk
)))
185 dwmac
->rgmii_tx_clk
= clk
;
190 static int meson8b_set_phy_mode(struct meson8b_dwmac
*dwmac
)
192 switch (dwmac
->phy_mode
) {
193 case PHY_INTERFACE_MODE_RGMII
:
194 case PHY_INTERFACE_MODE_RGMII_RXID
:
195 case PHY_INTERFACE_MODE_RGMII_ID
:
196 case PHY_INTERFACE_MODE_RGMII_TXID
:
197 /* enable RGMII mode */
198 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
,
200 PRG_ETH0_RGMII_MODE
);
202 case PHY_INTERFACE_MODE_RMII
:
203 /* disable RGMII mode -> enables RMII mode */
204 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
,
205 PRG_ETH0_RGMII_MODE
, 0);
208 dev_err(dwmac
->dev
, "fail to set phy-mode %s\n",
209 phy_modes(dwmac
->phy_mode
));
216 static int meson_axg_set_phy_mode(struct meson8b_dwmac
*dwmac
)
218 switch (dwmac
->phy_mode
) {
219 case PHY_INTERFACE_MODE_RGMII
:
220 case PHY_INTERFACE_MODE_RGMII_RXID
:
221 case PHY_INTERFACE_MODE_RGMII_ID
:
222 case PHY_INTERFACE_MODE_RGMII_TXID
:
223 /* enable RGMII mode */
224 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
,
225 PRG_ETH0_EXT_PHY_MODE_MASK
,
226 PRG_ETH0_EXT_RGMII_MODE
);
228 case PHY_INTERFACE_MODE_RMII
:
229 /* disable RGMII mode -> enables RMII mode */
230 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
,
231 PRG_ETH0_EXT_PHY_MODE_MASK
,
232 PRG_ETH0_EXT_RMII_MODE
);
235 dev_err(dwmac
->dev
, "fail to set phy-mode %s\n",
236 phy_modes(dwmac
->phy_mode
));
243 static int meson8b_init_prg_eth(struct meson8b_dwmac
*dwmac
)
248 switch (dwmac
->phy_mode
) {
249 case PHY_INTERFACE_MODE_RGMII
:
250 case PHY_INTERFACE_MODE_RGMII_RXID
:
251 /* TX clock delay in ns = "8ns / 4 * tx_dly_val" (where
252 * 8ns are exactly one cycle of the 125MHz RGMII TX clock):
253 * 0ns = 0x0, 2ns = 0x1, 4ns = 0x2, 6ns = 0x3
255 tx_dly_val
= dwmac
->tx_delay_ns
>> 1;
258 case PHY_INTERFACE_MODE_RGMII_ID
:
259 case PHY_INTERFACE_MODE_RGMII_TXID
:
260 /* only relevant for RMII mode -> disable in RGMII mode */
261 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
,
262 PRG_ETH0_INVERTED_RMII_CLK
, 0);
264 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
, PRG_ETH0_TXDLY_MASK
,
265 tx_dly_val
<< PRG_ETH0_TXDLY_SHIFT
);
267 /* Configure the 125MHz RGMII TX clock, the IP block changes
268 * the output automatically (= without us having to configure
269 * a register) based on the line-speed (125MHz for Gbit speeds,
270 * 25MHz for 100Mbit/s and 2.5MHz for 10Mbit/s).
272 ret
= clk_set_rate(dwmac
->rgmii_tx_clk
, 125 * 1000 * 1000);
275 "failed to set RGMII TX clock\n");
279 ret
= clk_prepare_enable(dwmac
->rgmii_tx_clk
);
282 "failed to enable the RGMII TX clock\n");
286 devm_add_action_or_reset(dwmac
->dev
,
287 (void(*)(void *))clk_disable_unprepare
,
288 dwmac
->rgmii_tx_clk
);
291 case PHY_INTERFACE_MODE_RMII
:
292 /* invert internal clk_rmii_i to generate 25/2.5 tx_rx_clk */
293 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
,
294 PRG_ETH0_INVERTED_RMII_CLK
,
295 PRG_ETH0_INVERTED_RMII_CLK
);
297 /* TX clock delay cannot be configured in RMII mode */
298 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
, PRG_ETH0_TXDLY_MASK
,
304 dev_err(dwmac
->dev
, "unsupported phy-mode %s\n",
305 phy_modes(dwmac
->phy_mode
));
309 /* enable TX_CLK and PHY_REF_CLK generator */
310 meson8b_dwmac_mask_bits(dwmac
, PRG_ETH0
, PRG_ETH0_TX_AND_PHY_REF_CLK
,
311 PRG_ETH0_TX_AND_PHY_REF_CLK
);
316 static int meson8b_dwmac_probe(struct platform_device
*pdev
)
318 struct plat_stmmacenet_data
*plat_dat
;
319 struct stmmac_resources stmmac_res
;
320 struct meson8b_dwmac
*dwmac
;
323 ret
= stmmac_get_platform_resources(pdev
, &stmmac_res
);
327 plat_dat
= stmmac_probe_config_dt(pdev
, &stmmac_res
.mac
);
328 if (IS_ERR(plat_dat
))
329 return PTR_ERR(plat_dat
);
331 dwmac
= devm_kzalloc(&pdev
->dev
, sizeof(*dwmac
), GFP_KERNEL
);
334 goto err_remove_config_dt
;
337 dwmac
->data
= (const struct meson8b_dwmac_data
*)
338 of_device_get_match_data(&pdev
->dev
);
341 goto err_remove_config_dt
;
343 dwmac
->regs
= devm_platform_ioremap_resource(pdev
, 1);
344 if (IS_ERR(dwmac
->regs
)) {
345 ret
= PTR_ERR(dwmac
->regs
);
346 goto err_remove_config_dt
;
349 dwmac
->dev
= &pdev
->dev
;
350 ret
= of_get_phy_mode(pdev
->dev
.of_node
, &dwmac
->phy_mode
);
352 dev_err(&pdev
->dev
, "missing phy-mode property\n");
353 goto err_remove_config_dt
;
356 /* use 2ns as fallback since this value was previously hardcoded */
357 if (of_property_read_u32(pdev
->dev
.of_node
, "amlogic,tx-delay-ns",
358 &dwmac
->tx_delay_ns
))
359 dwmac
->tx_delay_ns
= 2;
361 ret
= meson8b_init_rgmii_tx_clk(dwmac
);
363 goto err_remove_config_dt
;
365 ret
= dwmac
->data
->set_phy_mode(dwmac
);
367 goto err_remove_config_dt
;
369 ret
= meson8b_init_prg_eth(dwmac
);
371 goto err_remove_config_dt
;
373 plat_dat
->bsp_priv
= dwmac
;
375 ret
= stmmac_dvr_probe(&pdev
->dev
, plat_dat
, &stmmac_res
);
377 goto err_remove_config_dt
;
381 err_remove_config_dt
:
382 stmmac_remove_config_dt(pdev
, plat_dat
);
387 static const struct meson8b_dwmac_data meson8b_dwmac_data
= {
388 .set_phy_mode
= meson8b_set_phy_mode
,
391 static const struct meson8b_dwmac_data meson_axg_dwmac_data
= {
392 .set_phy_mode
= meson_axg_set_phy_mode
,
395 static const struct of_device_id meson8b_dwmac_match
[] = {
397 .compatible
= "amlogic,meson8b-dwmac",
398 .data
= &meson8b_dwmac_data
,
401 .compatible
= "amlogic,meson8m2-dwmac",
402 .data
= &meson8b_dwmac_data
,
405 .compatible
= "amlogic,meson-gxbb-dwmac",
406 .data
= &meson8b_dwmac_data
,
409 .compatible
= "amlogic,meson-axg-dwmac",
410 .data
= &meson_axg_dwmac_data
,
414 MODULE_DEVICE_TABLE(of
, meson8b_dwmac_match
);
416 static struct platform_driver meson8b_dwmac_driver
= {
417 .probe
= meson8b_dwmac_probe
,
418 .remove
= stmmac_pltfr_remove
,
420 .name
= "meson8b-dwmac",
421 .pm
= &stmmac_pltfr_pm_ops
,
422 .of_match_table
= meson8b_dwmac_match
,
425 module_platform_driver(meson8b_dwmac_driver
);
427 MODULE_AUTHOR("Martin Blumenstingl <martin.blumenstingl@googlemail.com>");
428 MODULE_DESCRIPTION("Amlogic Meson8b, Meson8m2 and GXBB DWMAC glue layer");
429 MODULE_LICENSE("GPL v2");