1 // SPDX-License-Identifier: GPL-2.0+
2 /* drivers/net/phy/realtek.c
4 * Driver for Realtek PHYs
6 * Author: Johnson Leung <r58129@freescale.com>
8 * Copyright (c) 2004 Freescale Semiconductor, Inc.
10 #include <linux/bitops.h>
11 #include <linux/phy.h>
12 #include <linux/module.h>
13 #include <linux/delay.h>
15 #define RTL821x_PHYSR 0x11
16 #define RTL821x_PHYSR_DUPLEX BIT(13)
17 #define RTL821x_PHYSR_SPEED GENMASK(15, 14)
19 #define RTL821x_INER 0x12
20 #define RTL8211B_INER_INIT 0x6400
21 #define RTL8211E_INER_LINK_STATUS BIT(10)
22 #define RTL8211F_INER_LINK_STATUS BIT(4)
24 #define RTL821x_INSR 0x13
26 #define RTL821x_EXT_PAGE_SELECT 0x1e
27 #define RTL821x_PAGE_SELECT 0x1f
29 #define RTL8211F_PHYCR1 0x18
30 #define RTL8211F_INSR 0x1d
32 #define RTL8211F_TX_DELAY BIT(8)
33 #define RTL8211F_RX_DELAY BIT(3)
35 #define RTL8211F_ALDPS_PLL_OFF BIT(1)
36 #define RTL8211F_ALDPS_ENABLE BIT(2)
37 #define RTL8211F_ALDPS_XTAL_OFF BIT(12)
39 #define RTL8211E_CTRL_DELAY BIT(13)
40 #define RTL8211E_TX_DELAY BIT(12)
41 #define RTL8211E_RX_DELAY BIT(11)
43 #define RTL8201F_ISR 0x1e
44 #define RTL8201F_IER 0x13
46 #define RTL8366RB_POWER_SAVE 0x15
47 #define RTL8366RB_POWER_SAVE_ON BIT(12)
49 #define RTL_SUPPORTS_5000FULL BIT(14)
50 #define RTL_SUPPORTS_2500FULL BIT(13)
51 #define RTL_SUPPORTS_10000FULL BIT(0)
52 #define RTL_ADV_2500FULL BIT(7)
53 #define RTL_LPADV_10000FULL BIT(11)
54 #define RTL_LPADV_5000FULL BIT(6)
55 #define RTL_LPADV_2500FULL BIT(5)
57 #define RTLGEN_SPEED_MASK 0x0630
59 #define RTL_GENERIC_PHYID 0x001cc800
61 MODULE_DESCRIPTION("Realtek PHY driver");
62 MODULE_AUTHOR("Johnson Leung");
63 MODULE_LICENSE("GPL");
65 static int rtl821x_read_page(struct phy_device *phydev)
67 return __phy_read(phydev, RTL821x_PAGE_SELECT);
70 static int rtl821x_write_page(struct phy_device *phydev, int page)
72 return __phy_write(phydev, RTL821x_PAGE_SELECT, page);
75 static int rtl8201_ack_interrupt(struct phy_device *phydev)
79 err = phy_read(phydev, RTL8201F_ISR);
81 return (err < 0) ? err : 0;
84 static int rtl821x_ack_interrupt(struct phy_device *phydev)
88 err = phy_read(phydev, RTL821x_INSR);
90 return (err < 0) ? err : 0;
93 static int rtl8211f_ack_interrupt(struct phy_device *phydev)
97 err = phy_read_paged(phydev, 0xa43, RTL8211F_INSR);
99 return (err < 0) ? err : 0;
102 static int rtl8201_config_intr(struct phy_device *phydev)
106 if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
107 val = BIT(13) | BIT(12) | BIT(11);
111 return phy_write_paged(phydev, 0x7, RTL8201F_IER, val);
114 static int rtl8211b_config_intr(struct phy_device *phydev)
118 if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
119 err = phy_write(phydev, RTL821x_INER,
122 err = phy_write(phydev, RTL821x_INER, 0);
127 static int rtl8211e_config_intr(struct phy_device *phydev)
131 if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
132 err = phy_write(phydev, RTL821x_INER,
133 RTL8211E_INER_LINK_STATUS);
135 err = phy_write(phydev, RTL821x_INER, 0);
140 static int rtl8211f_config_intr(struct phy_device *phydev)
144 if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
145 val = RTL8211F_INER_LINK_STATUS;
149 return phy_write_paged(phydev, 0xa42, RTL821x_INER, val);
152 static int rtl8211_config_aneg(struct phy_device *phydev)
156 ret = genphy_config_aneg(phydev);
160 /* Quirk was copied from vendor driver. Unfortunately it includes no
161 * description of the magic numbers.
163 if (phydev->speed == SPEED_100 && phydev->autoneg == AUTONEG_DISABLE) {
164 phy_write(phydev, 0x17, 0x2138);
165 phy_write(phydev, 0x0e, 0x0260);
167 phy_write(phydev, 0x17, 0x2108);
168 phy_write(phydev, 0x0e, 0x0000);
174 static int rtl8211c_config_init(struct phy_device *phydev)
176 /* RTL8211C has an issue when operating in Gigabit slave mode */
177 return phy_set_bits(phydev, MII_CTRL1000,
178 CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER);
181 static int rtl8211f_config_init(struct phy_device *phydev)
183 struct device *dev = &phydev->mdio.dev;
184 u16 val_txdly, val_rxdly;
188 val = RTL8211F_ALDPS_ENABLE | RTL8211F_ALDPS_PLL_OFF | RTL8211F_ALDPS_XTAL_OFF;
189 phy_modify_paged_changed(phydev, 0xa43, RTL8211F_PHYCR1, val, val);
191 switch (phydev->interface) {
192 case PHY_INTERFACE_MODE_RGMII:
197 case PHY_INTERFACE_MODE_RGMII_RXID:
199 val_rxdly = RTL8211F_RX_DELAY;
202 case PHY_INTERFACE_MODE_RGMII_TXID:
203 val_txdly = RTL8211F_TX_DELAY;
207 case PHY_INTERFACE_MODE_RGMII_ID:
208 val_txdly = RTL8211F_TX_DELAY;
209 val_rxdly = RTL8211F_RX_DELAY;
212 default: /* the rest of the modes imply leaving delay as is. */
216 ret = phy_modify_paged_changed(phydev, 0xd08, 0x11, RTL8211F_TX_DELAY,
219 dev_err(dev, "Failed to update the TX delay register\n");
223 "%s 2ns TX delay (and changing the value from pin-strapping RXD1 or the bootloader)\n",
224 val_txdly ? "Enabling" : "Disabling");
227 "2ns TX delay was already %s (by pin-strapping RXD1 or bootloader configuration)\n",
228 val_txdly ? "enabled" : "disabled");
231 ret = phy_modify_paged_changed(phydev, 0xd08, 0x15, RTL8211F_RX_DELAY,
234 dev_err(dev, "Failed to update the RX delay register\n");
238 "%s 2ns RX delay (and changing the value from pin-strapping RXD0 or the bootloader)\n",
239 val_rxdly ? "Enabling" : "Disabling");
242 "2ns RX delay was already %s (by pin-strapping RXD0 or bootloader configuration)\n",
243 val_rxdly ? "enabled" : "disabled");
249 static int rtl8211e_config_init(struct phy_device *phydev)
251 int ret = 0, oldpage;
254 /* enable TX/RX delay for rgmii-* modes, and disable them for rgmii. */
255 switch (phydev->interface) {
256 case PHY_INTERFACE_MODE_RGMII:
257 val = RTL8211E_CTRL_DELAY | 0;
259 case PHY_INTERFACE_MODE_RGMII_ID:
260 val = RTL8211E_CTRL_DELAY | RTL8211E_TX_DELAY | RTL8211E_RX_DELAY;
262 case PHY_INTERFACE_MODE_RGMII_RXID:
263 val = RTL8211E_CTRL_DELAY | RTL8211E_RX_DELAY;
265 case PHY_INTERFACE_MODE_RGMII_TXID:
266 val = RTL8211E_CTRL_DELAY | RTL8211E_TX_DELAY;
268 default: /* the rest of the modes imply leaving delays as is. */
272 /* According to a sample driver there is a 0x1c config register on the
273 * 0xa4 extension page (0x7) layout. It can be used to disable/enable
274 * the RX/TX delays otherwise controlled by RXDLY/TXDLY pins.
275 * The configuration register definition:
277 * 13 = Force Tx RX Delay controlled by bit12 bit11,
278 * 12 = RX Delay, 11 = TX Delay
279 * 10:0 = Test && debug settings reserved by realtek
281 oldpage = phy_select_page(phydev, 0x7);
283 goto err_restore_page;
285 ret = __phy_write(phydev, RTL821x_EXT_PAGE_SELECT, 0xa4);
287 goto err_restore_page;
289 ret = __phy_modify(phydev, 0x1c, RTL8211E_CTRL_DELAY
290 | RTL8211E_TX_DELAY | RTL8211E_RX_DELAY,
294 return phy_restore_page(phydev, oldpage, ret);
297 static int rtl8211b_suspend(struct phy_device *phydev)
299 phy_write(phydev, MII_MMD_DATA, BIT(9));
301 return genphy_suspend(phydev);
304 static int rtl8211b_resume(struct phy_device *phydev)
306 phy_write(phydev, MII_MMD_DATA, 0);
308 return genphy_resume(phydev);
311 static int rtl8366rb_config_init(struct phy_device *phydev)
315 ret = phy_set_bits(phydev, RTL8366RB_POWER_SAVE,
316 RTL8366RB_POWER_SAVE_ON);
318 dev_err(&phydev->mdio.dev,
319 "error enabling power management\n");
325 /* get actual speed to cover the downshift case */
326 static int rtlgen_get_speed(struct phy_device *phydev)
333 val = phy_read_paged(phydev, 0xa43, 0x12);
337 switch (val & RTLGEN_SPEED_MASK) {
339 phydev->speed = SPEED_10;
342 phydev->speed = SPEED_100;
345 phydev->speed = SPEED_1000;
348 phydev->speed = SPEED_10000;
351 phydev->speed = SPEED_2500;
354 phydev->speed = SPEED_5000;
363 static int rtlgen_read_status(struct phy_device *phydev)
367 ret = genphy_read_status(phydev);
371 return rtlgen_get_speed(phydev);
374 static int rtlgen_read_mmd(struct phy_device *phydev, int devnum, u16 regnum)
378 if (devnum == MDIO_MMD_PCS && regnum == MDIO_PCS_EEE_ABLE) {
379 rtl821x_write_page(phydev, 0xa5c);
380 ret = __phy_read(phydev, 0x12);
381 rtl821x_write_page(phydev, 0);
382 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV) {
383 rtl821x_write_page(phydev, 0xa5d);
384 ret = __phy_read(phydev, 0x10);
385 rtl821x_write_page(phydev, 0);
386 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_LPABLE) {
387 rtl821x_write_page(phydev, 0xa5d);
388 ret = __phy_read(phydev, 0x11);
389 rtl821x_write_page(phydev, 0);
397 static int rtlgen_write_mmd(struct phy_device *phydev, int devnum, u16 regnum,
402 if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV) {
403 rtl821x_write_page(phydev, 0xa5d);
404 ret = __phy_write(phydev, 0x10, val);
405 rtl821x_write_page(phydev, 0);
413 static int rtl822x_read_mmd(struct phy_device *phydev, int devnum, u16 regnum)
415 int ret = rtlgen_read_mmd(phydev, devnum, regnum);
417 if (ret != -EOPNOTSUPP)
420 if (devnum == MDIO_MMD_PCS && regnum == MDIO_PCS_EEE_ABLE2) {
421 rtl821x_write_page(phydev, 0xa6e);
422 ret = __phy_read(phydev, 0x16);
423 rtl821x_write_page(phydev, 0);
424 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV2) {
425 rtl821x_write_page(phydev, 0xa6d);
426 ret = __phy_read(phydev, 0x12);
427 rtl821x_write_page(phydev, 0);
428 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_LPABLE2) {
429 rtl821x_write_page(phydev, 0xa6d);
430 ret = __phy_read(phydev, 0x10);
431 rtl821x_write_page(phydev, 0);
437 static int rtl822x_write_mmd(struct phy_device *phydev, int devnum, u16 regnum,
440 int ret = rtlgen_write_mmd(phydev, devnum, regnum, val);
442 if (ret != -EOPNOTSUPP)
445 if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV2) {
446 rtl821x_write_page(phydev, 0xa6d);
447 ret = __phy_write(phydev, 0x12, val);
448 rtl821x_write_page(phydev, 0);
454 static int rtl822x_get_features(struct phy_device *phydev)
458 val = phy_read_paged(phydev, 0xa61, 0x13);
462 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
463 phydev->supported, val & RTL_SUPPORTS_2500FULL);
464 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
465 phydev->supported, val & RTL_SUPPORTS_5000FULL);
466 linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
467 phydev->supported, val & RTL_SUPPORTS_10000FULL);
469 return genphy_read_abilities(phydev);
472 static int rtl822x_config_aneg(struct phy_device *phydev)
476 if (phydev->autoneg == AUTONEG_ENABLE) {
479 if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
480 phydev->advertising))
481 adv2500 = RTL_ADV_2500FULL;
483 ret = phy_modify_paged_changed(phydev, 0xa5d, 0x12,
484 RTL_ADV_2500FULL, adv2500);
489 return __genphy_config_aneg(phydev, ret);
492 static int rtl822x_read_status(struct phy_device *phydev)
496 if (phydev->autoneg == AUTONEG_ENABLE) {
497 int lpadv = phy_read_paged(phydev, 0xa5d, 0x13);
502 linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
503 phydev->lp_advertising, lpadv & RTL_LPADV_10000FULL);
504 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
505 phydev->lp_advertising, lpadv & RTL_LPADV_5000FULL);
506 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
507 phydev->lp_advertising, lpadv & RTL_LPADV_2500FULL);
510 ret = genphy_read_status(phydev);
514 return rtlgen_get_speed(phydev);
517 static bool rtlgen_supports_2_5gbps(struct phy_device *phydev)
521 phy_write(phydev, RTL821x_PAGE_SELECT, 0xa61);
522 val = phy_read(phydev, 0x13);
523 phy_write(phydev, RTL821x_PAGE_SELECT, 0);
525 return val >= 0 && val & RTL_SUPPORTS_2500FULL;
528 static int rtlgen_match_phy_device(struct phy_device *phydev)
530 return phydev->phy_id == RTL_GENERIC_PHYID &&
531 !rtlgen_supports_2_5gbps(phydev);
534 static int rtl8226_match_phy_device(struct phy_device *phydev)
536 return phydev->phy_id == RTL_GENERIC_PHYID &&
537 rtlgen_supports_2_5gbps(phydev);
540 static int rtlgen_resume(struct phy_device *phydev)
542 int ret = genphy_resume(phydev);
544 /* Internal PHY's from RTL8168h up may not be instantly ready */
550 static struct phy_driver realtek_drvs[] = {
552 PHY_ID_MATCH_EXACT(0x00008201),
553 .name = "RTL8201CP Ethernet",
554 .read_page = rtl821x_read_page,
555 .write_page = rtl821x_write_page,
557 PHY_ID_MATCH_EXACT(0x001cc816),
558 .name = "RTL8201F Fast Ethernet",
559 .ack_interrupt = &rtl8201_ack_interrupt,
560 .config_intr = &rtl8201_config_intr,
561 .suspend = genphy_suspend,
562 .resume = genphy_resume,
563 .read_page = rtl821x_read_page,
564 .write_page = rtl821x_write_page,
566 PHY_ID_MATCH_MODEL(0x001cc880),
567 .name = "RTL8208 Fast Ethernet",
568 .read_mmd = genphy_read_mmd_unsupported,
569 .write_mmd = genphy_write_mmd_unsupported,
570 .suspend = genphy_suspend,
571 .resume = genphy_resume,
572 .read_page = rtl821x_read_page,
573 .write_page = rtl821x_write_page,
575 PHY_ID_MATCH_EXACT(0x001cc910),
576 .name = "RTL8211 Gigabit Ethernet",
577 .config_aneg = rtl8211_config_aneg,
578 .read_mmd = &genphy_read_mmd_unsupported,
579 .write_mmd = &genphy_write_mmd_unsupported,
580 .read_page = rtl821x_read_page,
581 .write_page = rtl821x_write_page,
583 PHY_ID_MATCH_EXACT(0x001cc912),
584 .name = "RTL8211B Gigabit Ethernet",
585 .ack_interrupt = &rtl821x_ack_interrupt,
586 .config_intr = &rtl8211b_config_intr,
587 .read_mmd = &genphy_read_mmd_unsupported,
588 .write_mmd = &genphy_write_mmd_unsupported,
589 .suspend = rtl8211b_suspend,
590 .resume = rtl8211b_resume,
591 .read_page = rtl821x_read_page,
592 .write_page = rtl821x_write_page,
594 PHY_ID_MATCH_EXACT(0x001cc913),
595 .name = "RTL8211C Gigabit Ethernet",
596 .config_init = rtl8211c_config_init,
597 .read_mmd = &genphy_read_mmd_unsupported,
598 .write_mmd = &genphy_write_mmd_unsupported,
599 .read_page = rtl821x_read_page,
600 .write_page = rtl821x_write_page,
602 PHY_ID_MATCH_EXACT(0x001cc914),
603 .name = "RTL8211DN Gigabit Ethernet",
604 .ack_interrupt = rtl821x_ack_interrupt,
605 .config_intr = rtl8211e_config_intr,
606 .suspend = genphy_suspend,
607 .resume = genphy_resume,
608 .read_page = rtl821x_read_page,
609 .write_page = rtl821x_write_page,
611 PHY_ID_MATCH_EXACT(0x001cc915),
612 .name = "RTL8211E Gigabit Ethernet",
613 .config_init = &rtl8211e_config_init,
614 .ack_interrupt = &rtl821x_ack_interrupt,
615 .config_intr = &rtl8211e_config_intr,
616 .suspend = genphy_suspend,
617 .resume = genphy_resume,
618 .read_page = rtl821x_read_page,
619 .write_page = rtl821x_write_page,
621 PHY_ID_MATCH_EXACT(0x001cc916),
622 .name = "RTL8211F Gigabit Ethernet",
623 .config_init = &rtl8211f_config_init,
624 .ack_interrupt = &rtl8211f_ack_interrupt,
625 .config_intr = &rtl8211f_config_intr,
626 .suspend = genphy_suspend,
627 .resume = genphy_resume,
628 .read_page = rtl821x_read_page,
629 .write_page = rtl821x_write_page,
631 .name = "Generic FE-GE Realtek PHY",
632 .match_phy_device = rtlgen_match_phy_device,
633 .read_status = rtlgen_read_status,
634 .suspend = genphy_suspend,
635 .resume = rtlgen_resume,
636 .read_page = rtl821x_read_page,
637 .write_page = rtl821x_write_page,
638 .read_mmd = rtlgen_read_mmd,
639 .write_mmd = rtlgen_write_mmd,
641 .name = "RTL8226 2.5Gbps PHY",
642 .match_phy_device = rtl8226_match_phy_device,
643 .get_features = rtl822x_get_features,
644 .config_aneg = rtl822x_config_aneg,
645 .read_status = rtl822x_read_status,
646 .suspend = genphy_suspend,
647 .resume = rtlgen_resume,
648 .read_page = rtl821x_read_page,
649 .write_page = rtl821x_write_page,
650 .read_mmd = rtl822x_read_mmd,
651 .write_mmd = rtl822x_write_mmd,
653 PHY_ID_MATCH_EXACT(0x001cc840),
654 .name = "RTL8226B_RTL8221B 2.5Gbps PHY",
655 .get_features = rtl822x_get_features,
656 .config_aneg = rtl822x_config_aneg,
657 .read_status = rtl822x_read_status,
658 .suspend = genphy_suspend,
659 .resume = rtlgen_resume,
660 .read_page = rtl821x_read_page,
661 .write_page = rtl821x_write_page,
662 .read_mmd = rtl822x_read_mmd,
663 .write_mmd = rtl822x_write_mmd,
665 PHY_ID_MATCH_EXACT(0x001cc961),
666 .name = "RTL8366RB Gigabit Ethernet",
667 .config_init = &rtl8366rb_config_init,
668 /* These interrupts are handled by the irq controller
669 * embedded inside the RTL8366RB, they get unmasked when the
670 * irq is requested and ACKed by reading the status register,
671 * which is done by the irqchip code.
673 .ack_interrupt = genphy_no_ack_interrupt,
674 .config_intr = genphy_no_config_intr,
675 .suspend = genphy_suspend,
676 .resume = genphy_resume,
680 module_phy_driver(realtek_drvs);
682 static const struct mdio_device_id __maybe_unused realtek_tbl[] = {
683 { PHY_ID_MATCH_VENDOR(0x001cc800) },
687 MODULE_DEVICE_TABLE(mdio, realtek_tbl);