2 * dwmac-rk.c - Rockchip RK3288 DWMAC specific glue layer
4 * Copyright (C) 2014 Chen-Zhi (Roger Chen)
6 * Chen-Zhi (Roger Chen) <roger.chen@rock-chips.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <linux/stmmac.h>
20 #include <linux/bitops.h>
21 #include <linux/clk.h>
22 #include <linux/phy.h>
23 #include <linux/of_net.h>
24 #include <linux/gpio.h>
25 #include <linux/module.h>
26 #include <linux/of_gpio.h>
27 #include <linux/of_device.h>
28 #include <linux/platform_device.h>
29 #include <linux/regulator/consumer.h>
30 #include <linux/delay.h>
31 #include <linux/mfd/syscon.h>
32 #include <linux/regmap.h>
34 #include "stmmac_platform.h"
38 void (*set_to_rgmii)(struct rk_priv_data *bsp_priv,
39 int tx_delay, int rx_delay);
40 void (*set_to_rmii)(struct rk_priv_data *bsp_priv);
41 void (*set_rgmii_speed)(struct rk_priv_data *bsp_priv, int speed);
42 void (*set_rmii_speed)(struct rk_priv_data *bsp_priv, int speed);
46 struct platform_device *pdev;
48 struct regulator *regulator;
49 const struct rk_gmac_ops *ops;
55 struct clk *gmac_clkin;
56 struct clk *mac_clk_rx;
57 struct clk *mac_clk_tx;
58 struct clk *clk_mac_ref;
59 struct clk *clk_mac_refout;
69 #define HIWORD_UPDATE(val, mask, shift) \
70 ((val) << (shift) | (mask) << ((shift) + 16))
72 #define GRF_BIT(nr) (BIT(nr) | BIT(nr+16))
73 #define GRF_CLR_BIT(nr) (BIT(nr+16))
75 #define RK3288_GRF_SOC_CON1 0x0248
76 #define RK3288_GRF_SOC_CON3 0x0250
78 /*RK3288_GRF_SOC_CON1*/
79 #define RK3288_GMAC_PHY_INTF_SEL_RGMII (GRF_BIT(6) | GRF_CLR_BIT(7) | \
81 #define RK3288_GMAC_PHY_INTF_SEL_RMII (GRF_CLR_BIT(6) | GRF_CLR_BIT(7) | \
83 #define RK3288_GMAC_FLOW_CTRL GRF_BIT(9)
84 #define RK3288_GMAC_FLOW_CTRL_CLR GRF_CLR_BIT(9)
85 #define RK3288_GMAC_SPEED_10M GRF_CLR_BIT(10)
86 #define RK3288_GMAC_SPEED_100M GRF_BIT(10)
87 #define RK3288_GMAC_RMII_CLK_25M GRF_BIT(11)
88 #define RK3288_GMAC_RMII_CLK_2_5M GRF_CLR_BIT(11)
89 #define RK3288_GMAC_CLK_125M (GRF_CLR_BIT(12) | GRF_CLR_BIT(13))
90 #define RK3288_GMAC_CLK_25M (GRF_BIT(12) | GRF_BIT(13))
91 #define RK3288_GMAC_CLK_2_5M (GRF_CLR_BIT(12) | GRF_BIT(13))
92 #define RK3288_GMAC_RMII_MODE GRF_BIT(14)
93 #define RK3288_GMAC_RMII_MODE_CLR GRF_CLR_BIT(14)
95 /*RK3288_GRF_SOC_CON3*/
96 #define RK3288_GMAC_TXCLK_DLY_ENABLE GRF_BIT(14)
97 #define RK3288_GMAC_TXCLK_DLY_DISABLE GRF_CLR_BIT(14)
98 #define RK3288_GMAC_RXCLK_DLY_ENABLE GRF_BIT(15)
99 #define RK3288_GMAC_RXCLK_DLY_DISABLE GRF_CLR_BIT(15)
100 #define RK3288_GMAC_CLK_RX_DL_CFG(val) HIWORD_UPDATE(val, 0x7F, 7)
101 #define RK3288_GMAC_CLK_TX_DL_CFG(val) HIWORD_UPDATE(val, 0x7F, 0)
103 static void rk3288_set_to_rgmii(struct rk_priv_data *bsp_priv,
104 int tx_delay, int rx_delay)
106 struct device *dev = &bsp_priv->pdev->dev;
108 if (IS_ERR(bsp_priv->grf)) {
109 dev_err(dev, "Missing rockchip,grf property\n");
113 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON1,
114 RK3288_GMAC_PHY_INTF_SEL_RGMII |
115 RK3288_GMAC_RMII_MODE_CLR);
116 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON3,
117 RK3288_GMAC_RXCLK_DLY_ENABLE |
118 RK3288_GMAC_TXCLK_DLY_ENABLE |
119 RK3288_GMAC_CLK_RX_DL_CFG(rx_delay) |
120 RK3288_GMAC_CLK_TX_DL_CFG(tx_delay));
123 static void rk3288_set_to_rmii(struct rk_priv_data *bsp_priv)
125 struct device *dev = &bsp_priv->pdev->dev;
127 if (IS_ERR(bsp_priv->grf)) {
128 dev_err(dev, "Missing rockchip,grf property\n");
132 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON1,
133 RK3288_GMAC_PHY_INTF_SEL_RMII | RK3288_GMAC_RMII_MODE);
136 static void rk3288_set_rgmii_speed(struct rk_priv_data *bsp_priv, int speed)
138 struct device *dev = &bsp_priv->pdev->dev;
140 if (IS_ERR(bsp_priv->grf)) {
141 dev_err(dev, "Missing rockchip,grf property\n");
146 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON1,
147 RK3288_GMAC_CLK_2_5M);
148 else if (speed == 100)
149 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON1,
150 RK3288_GMAC_CLK_25M);
151 else if (speed == 1000)
152 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON1,
153 RK3288_GMAC_CLK_125M);
155 dev_err(dev, "unknown speed value for RGMII! speed=%d", speed);
158 static void rk3288_set_rmii_speed(struct rk_priv_data *bsp_priv, int speed)
160 struct device *dev = &bsp_priv->pdev->dev;
162 if (IS_ERR(bsp_priv->grf)) {
163 dev_err(dev, "Missing rockchip,grf property\n");
168 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON1,
169 RK3288_GMAC_RMII_CLK_2_5M |
170 RK3288_GMAC_SPEED_10M);
171 } else if (speed == 100) {
172 regmap_write(bsp_priv->grf, RK3288_GRF_SOC_CON1,
173 RK3288_GMAC_RMII_CLK_25M |
174 RK3288_GMAC_SPEED_100M);
176 dev_err(dev, "unknown speed value for RMII! speed=%d", speed);
180 static const struct rk_gmac_ops rk3288_ops = {
181 .set_to_rgmii = rk3288_set_to_rgmii,
182 .set_to_rmii = rk3288_set_to_rmii,
183 .set_rgmii_speed = rk3288_set_rgmii_speed,
184 .set_rmii_speed = rk3288_set_rmii_speed,
187 #define RK3368_GRF_SOC_CON15 0x043c
188 #define RK3368_GRF_SOC_CON16 0x0440
190 /* RK3368_GRF_SOC_CON15 */
191 #define RK3368_GMAC_PHY_INTF_SEL_RGMII (GRF_BIT(9) | GRF_CLR_BIT(10) | \
193 #define RK3368_GMAC_PHY_INTF_SEL_RMII (GRF_CLR_BIT(9) | GRF_CLR_BIT(10) | \
195 #define RK3368_GMAC_FLOW_CTRL GRF_BIT(8)
196 #define RK3368_GMAC_FLOW_CTRL_CLR GRF_CLR_BIT(8)
197 #define RK3368_GMAC_SPEED_10M GRF_CLR_BIT(7)
198 #define RK3368_GMAC_SPEED_100M GRF_BIT(7)
199 #define RK3368_GMAC_RMII_CLK_25M GRF_BIT(3)
200 #define RK3368_GMAC_RMII_CLK_2_5M GRF_CLR_BIT(3)
201 #define RK3368_GMAC_CLK_125M (GRF_CLR_BIT(4) | GRF_CLR_BIT(5))
202 #define RK3368_GMAC_CLK_25M (GRF_BIT(4) | GRF_BIT(5))
203 #define RK3368_GMAC_CLK_2_5M (GRF_CLR_BIT(4) | GRF_BIT(5))
204 #define RK3368_GMAC_RMII_MODE GRF_BIT(6)
205 #define RK3368_GMAC_RMII_MODE_CLR GRF_CLR_BIT(6)
207 /* RK3368_GRF_SOC_CON16 */
208 #define RK3368_GMAC_TXCLK_DLY_ENABLE GRF_BIT(7)
209 #define RK3368_GMAC_TXCLK_DLY_DISABLE GRF_CLR_BIT(7)
210 #define RK3368_GMAC_RXCLK_DLY_ENABLE GRF_BIT(15)
211 #define RK3368_GMAC_RXCLK_DLY_DISABLE GRF_CLR_BIT(15)
212 #define RK3368_GMAC_CLK_RX_DL_CFG(val) HIWORD_UPDATE(val, 0x7F, 8)
213 #define RK3368_GMAC_CLK_TX_DL_CFG(val) HIWORD_UPDATE(val, 0x7F, 0)
215 static void rk3368_set_to_rgmii(struct rk_priv_data *bsp_priv,
216 int tx_delay, int rx_delay)
218 struct device *dev = &bsp_priv->pdev->dev;
220 if (IS_ERR(bsp_priv->grf)) {
221 dev_err(dev, "%s: Missing rockchip,grf property\n", __func__);
225 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON15,
226 RK3368_GMAC_PHY_INTF_SEL_RGMII |
227 RK3368_GMAC_RMII_MODE_CLR);
228 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON16,
229 RK3368_GMAC_RXCLK_DLY_ENABLE |
230 RK3368_GMAC_TXCLK_DLY_ENABLE |
231 RK3368_GMAC_CLK_RX_DL_CFG(rx_delay) |
232 RK3368_GMAC_CLK_TX_DL_CFG(tx_delay));
235 static void rk3368_set_to_rmii(struct rk_priv_data *bsp_priv)
237 struct device *dev = &bsp_priv->pdev->dev;
239 if (IS_ERR(bsp_priv->grf)) {
240 dev_err(dev, "%s: Missing rockchip,grf property\n", __func__);
244 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON15,
245 RK3368_GMAC_PHY_INTF_SEL_RMII | RK3368_GMAC_RMII_MODE);
248 static void rk3368_set_rgmii_speed(struct rk_priv_data *bsp_priv, int speed)
250 struct device *dev = &bsp_priv->pdev->dev;
252 if (IS_ERR(bsp_priv->grf)) {
253 dev_err(dev, "%s: Missing rockchip,grf property\n", __func__);
258 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON15,
259 RK3368_GMAC_CLK_2_5M);
260 else if (speed == 100)
261 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON15,
262 RK3368_GMAC_CLK_25M);
263 else if (speed == 1000)
264 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON15,
265 RK3368_GMAC_CLK_125M);
267 dev_err(dev, "unknown speed value for RGMII! speed=%d", speed);
270 static void rk3368_set_rmii_speed(struct rk_priv_data *bsp_priv, int speed)
272 struct device *dev = &bsp_priv->pdev->dev;
274 if (IS_ERR(bsp_priv->grf)) {
275 dev_err(dev, "%s: Missing rockchip,grf property\n", __func__);
280 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON15,
281 RK3368_GMAC_RMII_CLK_2_5M |
282 RK3368_GMAC_SPEED_10M);
283 } else if (speed == 100) {
284 regmap_write(bsp_priv->grf, RK3368_GRF_SOC_CON15,
285 RK3368_GMAC_RMII_CLK_25M |
286 RK3368_GMAC_SPEED_100M);
288 dev_err(dev, "unknown speed value for RMII! speed=%d", speed);
292 static const struct rk_gmac_ops rk3368_ops = {
293 .set_to_rgmii = rk3368_set_to_rgmii,
294 .set_to_rmii = rk3368_set_to_rmii,
295 .set_rgmii_speed = rk3368_set_rgmii_speed,
296 .set_rmii_speed = rk3368_set_rmii_speed,
299 static int gmac_clk_init(struct rk_priv_data *bsp_priv)
301 struct device *dev = &bsp_priv->pdev->dev;
303 bsp_priv->clk_enabled = false;
305 bsp_priv->mac_clk_rx = devm_clk_get(dev, "mac_clk_rx");
306 if (IS_ERR(bsp_priv->mac_clk_rx))
307 dev_err(dev, "cannot get clock %s\n",
310 bsp_priv->mac_clk_tx = devm_clk_get(dev, "mac_clk_tx");
311 if (IS_ERR(bsp_priv->mac_clk_tx))
312 dev_err(dev, "cannot get clock %s\n",
315 bsp_priv->aclk_mac = devm_clk_get(dev, "aclk_mac");
316 if (IS_ERR(bsp_priv->aclk_mac))
317 dev_err(dev, "cannot get clock %s\n",
320 bsp_priv->pclk_mac = devm_clk_get(dev, "pclk_mac");
321 if (IS_ERR(bsp_priv->pclk_mac))
322 dev_err(dev, "cannot get clock %s\n",
325 bsp_priv->clk_mac = devm_clk_get(dev, "stmmaceth");
326 if (IS_ERR(bsp_priv->clk_mac))
327 dev_err(dev, "cannot get clock %s\n",
330 if (bsp_priv->phy_iface == PHY_INTERFACE_MODE_RMII) {
331 bsp_priv->clk_mac_ref = devm_clk_get(dev, "clk_mac_ref");
332 if (IS_ERR(bsp_priv->clk_mac_ref))
333 dev_err(dev, "cannot get clock %s\n",
336 if (!bsp_priv->clock_input) {
337 bsp_priv->clk_mac_refout =
338 devm_clk_get(dev, "clk_mac_refout");
339 if (IS_ERR(bsp_priv->clk_mac_refout))
340 dev_err(dev, "cannot get clock %s\n",
345 if (bsp_priv->clock_input) {
346 dev_info(dev, "clock input from PHY\n");
348 if (bsp_priv->phy_iface == PHY_INTERFACE_MODE_RMII)
349 clk_set_rate(bsp_priv->clk_mac, 50000000);
355 static int gmac_clk_enable(struct rk_priv_data *bsp_priv, bool enable)
357 int phy_iface = bsp_priv->phy_iface;
360 if (!bsp_priv->clk_enabled) {
361 if (phy_iface == PHY_INTERFACE_MODE_RMII) {
362 if (!IS_ERR(bsp_priv->mac_clk_rx))
364 bsp_priv->mac_clk_rx);
366 if (!IS_ERR(bsp_priv->clk_mac_ref))
368 bsp_priv->clk_mac_ref);
370 if (!IS_ERR(bsp_priv->clk_mac_refout))
372 bsp_priv->clk_mac_refout);
375 if (!IS_ERR(bsp_priv->aclk_mac))
376 clk_prepare_enable(bsp_priv->aclk_mac);
378 if (!IS_ERR(bsp_priv->pclk_mac))
379 clk_prepare_enable(bsp_priv->pclk_mac);
381 if (!IS_ERR(bsp_priv->mac_clk_tx))
382 clk_prepare_enable(bsp_priv->mac_clk_tx);
385 * if (!IS_ERR(bsp_priv->clk_mac))
386 * clk_prepare_enable(bsp_priv->clk_mac);
389 bsp_priv->clk_enabled = true;
392 if (bsp_priv->clk_enabled) {
393 if (phy_iface == PHY_INTERFACE_MODE_RMII) {
394 if (!IS_ERR(bsp_priv->mac_clk_rx))
395 clk_disable_unprepare(
396 bsp_priv->mac_clk_rx);
398 if (!IS_ERR(bsp_priv->clk_mac_ref))
399 clk_disable_unprepare(
400 bsp_priv->clk_mac_ref);
402 if (!IS_ERR(bsp_priv->clk_mac_refout))
403 clk_disable_unprepare(
404 bsp_priv->clk_mac_refout);
407 if (!IS_ERR(bsp_priv->aclk_mac))
408 clk_disable_unprepare(bsp_priv->aclk_mac);
410 if (!IS_ERR(bsp_priv->pclk_mac))
411 clk_disable_unprepare(bsp_priv->pclk_mac);
413 if (!IS_ERR(bsp_priv->mac_clk_tx))
414 clk_disable_unprepare(bsp_priv->mac_clk_tx);
416 * if (!IS_ERR(bsp_priv->clk_mac))
417 * clk_disable_unprepare(bsp_priv->clk_mac);
419 bsp_priv->clk_enabled = false;
426 static int phy_power_on(struct rk_priv_data *bsp_priv, bool enable)
428 struct regulator *ldo = bsp_priv->regulator;
430 struct device *dev = &bsp_priv->pdev->dev;
433 dev_err(dev, "no regulator found\n");
438 ret = regulator_enable(ldo);
440 dev_err(dev, "fail to enable phy-supply\n");
442 ret = regulator_disable(ldo);
444 dev_err(dev, "fail to disable phy-supply\n");
450 static struct rk_priv_data *rk_gmac_setup(struct platform_device *pdev,
451 const struct rk_gmac_ops *ops)
453 struct rk_priv_data *bsp_priv;
454 struct device *dev = &pdev->dev;
456 const char *strings = NULL;
459 bsp_priv = devm_kzalloc(dev, sizeof(*bsp_priv), GFP_KERNEL);
461 return ERR_PTR(-ENOMEM);
463 bsp_priv->phy_iface = of_get_phy_mode(dev->of_node);
466 bsp_priv->regulator = devm_regulator_get_optional(dev, "phy");
467 if (IS_ERR(bsp_priv->regulator)) {
468 if (PTR_ERR(bsp_priv->regulator) == -EPROBE_DEFER) {
469 dev_err(dev, "phy regulator is not available yet, deferred probing\n");
470 return ERR_PTR(-EPROBE_DEFER);
472 dev_err(dev, "no regulator found\n");
473 bsp_priv->regulator = NULL;
476 ret = of_property_read_string(dev->of_node, "clock_in_out", &strings);
478 dev_err(dev, "Can not read property: clock_in_out.\n");
479 bsp_priv->clock_input = true;
481 dev_info(dev, "clock input or output? (%s).\n",
483 if (!strcmp(strings, "input"))
484 bsp_priv->clock_input = true;
486 bsp_priv->clock_input = false;
489 ret = of_property_read_u32(dev->of_node, "tx_delay", &value);
491 bsp_priv->tx_delay = 0x30;
492 dev_err(dev, "Can not read property: tx_delay.");
493 dev_err(dev, "set tx_delay to 0x%x\n",
496 dev_info(dev, "TX delay(0x%x).\n", value);
497 bsp_priv->tx_delay = value;
500 ret = of_property_read_u32(dev->of_node, "rx_delay", &value);
502 bsp_priv->rx_delay = 0x10;
503 dev_err(dev, "Can not read property: rx_delay.");
504 dev_err(dev, "set rx_delay to 0x%x\n",
507 dev_info(dev, "RX delay(0x%x).\n", value);
508 bsp_priv->rx_delay = value;
511 bsp_priv->grf = syscon_regmap_lookup_by_phandle(dev->of_node,
513 bsp_priv->pdev = pdev;
516 if (bsp_priv->phy_iface == PHY_INTERFACE_MODE_RGMII) {
517 dev_info(dev, "init for RGMII\n");
518 bsp_priv->ops->set_to_rgmii(bsp_priv, bsp_priv->tx_delay,
520 } else if (bsp_priv->phy_iface == PHY_INTERFACE_MODE_RMII) {
521 dev_info(dev, "init for RMII\n");
522 bsp_priv->ops->set_to_rmii(bsp_priv);
524 dev_err(dev, "NO interface defined!\n");
527 gmac_clk_init(bsp_priv);
532 static int rk_gmac_init(struct platform_device *pdev, void *priv)
534 struct rk_priv_data *bsp_priv = priv;
537 ret = phy_power_on(bsp_priv, true);
541 ret = gmac_clk_enable(bsp_priv, true);
548 static void rk_gmac_exit(struct platform_device *pdev, void *priv)
550 struct rk_priv_data *gmac = priv;
552 phy_power_on(gmac, false);
553 gmac_clk_enable(gmac, false);
556 static void rk_fix_speed(void *priv, unsigned int speed)
558 struct rk_priv_data *bsp_priv = priv;
559 struct device *dev = &bsp_priv->pdev->dev;
561 if (bsp_priv->phy_iface == PHY_INTERFACE_MODE_RGMII)
562 bsp_priv->ops->set_rgmii_speed(bsp_priv, speed);
563 else if (bsp_priv->phy_iface == PHY_INTERFACE_MODE_RMII)
564 bsp_priv->ops->set_rmii_speed(bsp_priv, speed);
566 dev_err(dev, "unsupported interface %d", bsp_priv->phy_iface);
569 static int rk_gmac_probe(struct platform_device *pdev)
571 struct plat_stmmacenet_data *plat_dat;
572 struct stmmac_resources stmmac_res;
573 const struct rk_gmac_ops *data;
576 data = of_device_get_match_data(&pdev->dev);
578 dev_err(&pdev->dev, "no of match data provided\n");
582 ret = stmmac_get_platform_resources(pdev, &stmmac_res);
586 plat_dat = stmmac_probe_config_dt(pdev, &stmmac_res.mac);
587 if (IS_ERR(plat_dat))
588 return PTR_ERR(plat_dat);
590 plat_dat->has_gmac = true;
591 plat_dat->init = rk_gmac_init;
592 plat_dat->exit = rk_gmac_exit;
593 plat_dat->fix_mac_speed = rk_fix_speed;
595 plat_dat->bsp_priv = rk_gmac_setup(pdev, data);
596 if (IS_ERR(plat_dat->bsp_priv))
597 return PTR_ERR(plat_dat->bsp_priv);
599 ret = rk_gmac_init(pdev, plat_dat->bsp_priv);
603 return stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res);
606 static const struct of_device_id rk_gmac_dwmac_match[] = {
607 { .compatible = "rockchip,rk3288-gmac", .data = &rk3288_ops },
608 { .compatible = "rockchip,rk3368-gmac", .data = &rk3368_ops },
611 MODULE_DEVICE_TABLE(of, rk_gmac_dwmac_match);
613 static struct platform_driver rk_gmac_dwmac_driver = {
614 .probe = rk_gmac_probe,
615 .remove = stmmac_pltfr_remove,
617 .name = "rk_gmac-dwmac",
618 .pm = &stmmac_pltfr_pm_ops,
619 .of_match_table = rk_gmac_dwmac_match,
622 module_platform_driver(rk_gmac_dwmac_driver);
624 MODULE_AUTHOR("Chen-Zhi (Roger Chen) <roger.chen@rock-chips.com>");
625 MODULE_DESCRIPTION("Rockchip RK3288 DWMAC specific glue layer");
626 MODULE_LICENSE("GPL");