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 rtl821x_resume(struct phy_device *phydev)
253 ret = genphy_resume(phydev);
262 static int rtl8211e_config_init(struct phy_device *phydev)
264 int ret = 0, oldpage;
267 /* enable TX/RX delay for rgmii-* modes, and disable them for rgmii. */
268 switch (phydev->interface) {
269 case PHY_INTERFACE_MODE_RGMII:
270 val = RTL8211E_CTRL_DELAY | 0;
272 case PHY_INTERFACE_MODE_RGMII_ID:
273 val = RTL8211E_CTRL_DELAY | RTL8211E_TX_DELAY | RTL8211E_RX_DELAY;
275 case PHY_INTERFACE_MODE_RGMII_RXID:
276 val = RTL8211E_CTRL_DELAY | RTL8211E_RX_DELAY;
278 case PHY_INTERFACE_MODE_RGMII_TXID:
279 val = RTL8211E_CTRL_DELAY | RTL8211E_TX_DELAY;
281 default: /* the rest of the modes imply leaving delays as is. */
285 /* According to a sample driver there is a 0x1c config register on the
286 * 0xa4 extension page (0x7) layout. It can be used to disable/enable
287 * the RX/TX delays otherwise controlled by RXDLY/TXDLY pins.
288 * The configuration register definition:
290 * 13 = Force Tx RX Delay controlled by bit12 bit11,
291 * 12 = RX Delay, 11 = TX Delay
292 * 10:0 = Test && debug settings reserved by realtek
294 oldpage = phy_select_page(phydev, 0x7);
296 goto err_restore_page;
298 ret = __phy_write(phydev, RTL821x_EXT_PAGE_SELECT, 0xa4);
300 goto err_restore_page;
302 ret = __phy_modify(phydev, 0x1c, RTL8211E_CTRL_DELAY
303 | RTL8211E_TX_DELAY | RTL8211E_RX_DELAY,
307 return phy_restore_page(phydev, oldpage, ret);
310 static int rtl8211b_suspend(struct phy_device *phydev)
312 phy_write(phydev, MII_MMD_DATA, BIT(9));
314 return genphy_suspend(phydev);
317 static int rtl8211b_resume(struct phy_device *phydev)
319 phy_write(phydev, MII_MMD_DATA, 0);
321 return genphy_resume(phydev);
324 static int rtl8366rb_config_init(struct phy_device *phydev)
328 ret = phy_set_bits(phydev, RTL8366RB_POWER_SAVE,
329 RTL8366RB_POWER_SAVE_ON);
331 dev_err(&phydev->mdio.dev,
332 "error enabling power management\n");
338 /* get actual speed to cover the downshift case */
339 static int rtlgen_get_speed(struct phy_device *phydev)
346 val = phy_read_paged(phydev, 0xa43, 0x12);
350 switch (val & RTLGEN_SPEED_MASK) {
352 phydev->speed = SPEED_10;
355 phydev->speed = SPEED_100;
358 phydev->speed = SPEED_1000;
361 phydev->speed = SPEED_10000;
364 phydev->speed = SPEED_2500;
367 phydev->speed = SPEED_5000;
376 static int rtlgen_read_status(struct phy_device *phydev)
380 ret = genphy_read_status(phydev);
384 return rtlgen_get_speed(phydev);
387 static int rtlgen_read_mmd(struct phy_device *phydev, int devnum, u16 regnum)
391 if (devnum == MDIO_MMD_PCS && regnum == MDIO_PCS_EEE_ABLE) {
392 rtl821x_write_page(phydev, 0xa5c);
393 ret = __phy_read(phydev, 0x12);
394 rtl821x_write_page(phydev, 0);
395 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV) {
396 rtl821x_write_page(phydev, 0xa5d);
397 ret = __phy_read(phydev, 0x10);
398 rtl821x_write_page(phydev, 0);
399 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_LPABLE) {
400 rtl821x_write_page(phydev, 0xa5d);
401 ret = __phy_read(phydev, 0x11);
402 rtl821x_write_page(phydev, 0);
410 static int rtlgen_write_mmd(struct phy_device *phydev, int devnum, u16 regnum,
415 if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV) {
416 rtl821x_write_page(phydev, 0xa5d);
417 ret = __phy_write(phydev, 0x10, val);
418 rtl821x_write_page(phydev, 0);
426 static int rtl822x_read_mmd(struct phy_device *phydev, int devnum, u16 regnum)
428 int ret = rtlgen_read_mmd(phydev, devnum, regnum);
430 if (ret != -EOPNOTSUPP)
433 if (devnum == MDIO_MMD_PCS && regnum == MDIO_PCS_EEE_ABLE2) {
434 rtl821x_write_page(phydev, 0xa6e);
435 ret = __phy_read(phydev, 0x16);
436 rtl821x_write_page(phydev, 0);
437 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV2) {
438 rtl821x_write_page(phydev, 0xa6d);
439 ret = __phy_read(phydev, 0x12);
440 rtl821x_write_page(phydev, 0);
441 } else if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_LPABLE2) {
442 rtl821x_write_page(phydev, 0xa6d);
443 ret = __phy_read(phydev, 0x10);
444 rtl821x_write_page(phydev, 0);
450 static int rtl822x_write_mmd(struct phy_device *phydev, int devnum, u16 regnum,
453 int ret = rtlgen_write_mmd(phydev, devnum, regnum, val);
455 if (ret != -EOPNOTSUPP)
458 if (devnum == MDIO_MMD_AN && regnum == MDIO_AN_EEE_ADV2) {
459 rtl821x_write_page(phydev, 0xa6d);
460 ret = __phy_write(phydev, 0x12, val);
461 rtl821x_write_page(phydev, 0);
467 static int rtl822x_get_features(struct phy_device *phydev)
471 val = phy_read_paged(phydev, 0xa61, 0x13);
475 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
476 phydev->supported, val & RTL_SUPPORTS_2500FULL);
477 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
478 phydev->supported, val & RTL_SUPPORTS_5000FULL);
479 linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
480 phydev->supported, val & RTL_SUPPORTS_10000FULL);
482 return genphy_read_abilities(phydev);
485 static int rtl822x_config_aneg(struct phy_device *phydev)
489 if (phydev->autoneg == AUTONEG_ENABLE) {
492 if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
493 phydev->advertising))
494 adv2500 = RTL_ADV_2500FULL;
496 ret = phy_modify_paged_changed(phydev, 0xa5d, 0x12,
497 RTL_ADV_2500FULL, adv2500);
502 return __genphy_config_aneg(phydev, ret);
505 static int rtl822x_read_status(struct phy_device *phydev)
509 if (phydev->autoneg == AUTONEG_ENABLE) {
510 int lpadv = phy_read_paged(phydev, 0xa5d, 0x13);
515 linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
516 phydev->lp_advertising, lpadv & RTL_LPADV_10000FULL);
517 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
518 phydev->lp_advertising, lpadv & RTL_LPADV_5000FULL);
519 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
520 phydev->lp_advertising, lpadv & RTL_LPADV_2500FULL);
523 ret = genphy_read_status(phydev);
527 return rtlgen_get_speed(phydev);
530 static bool rtlgen_supports_2_5gbps(struct phy_device *phydev)
534 phy_write(phydev, RTL821x_PAGE_SELECT, 0xa61);
535 val = phy_read(phydev, 0x13);
536 phy_write(phydev, RTL821x_PAGE_SELECT, 0);
538 return val >= 0 && val & RTL_SUPPORTS_2500FULL;
541 static int rtlgen_match_phy_device(struct phy_device *phydev)
543 return phydev->phy_id == RTL_GENERIC_PHYID &&
544 !rtlgen_supports_2_5gbps(phydev);
547 static int rtl8226_match_phy_device(struct phy_device *phydev)
549 return phydev->phy_id == RTL_GENERIC_PHYID &&
550 rtlgen_supports_2_5gbps(phydev);
553 static int rtlgen_resume(struct phy_device *phydev)
555 int ret = genphy_resume(phydev);
557 /* Internal PHY's from RTL8168h up may not be instantly ready */
563 static struct phy_driver realtek_drvs[] = {
565 PHY_ID_MATCH_EXACT(0x00008201),
566 .name = "RTL8201CP Ethernet",
567 .read_page = rtl821x_read_page,
568 .write_page = rtl821x_write_page,
570 PHY_ID_MATCH_EXACT(0x001cc816),
571 .name = "RTL8201F Fast Ethernet",
572 .ack_interrupt = &rtl8201_ack_interrupt,
573 .config_intr = &rtl8201_config_intr,
574 .suspend = genphy_suspend,
575 .resume = genphy_resume,
576 .read_page = rtl821x_read_page,
577 .write_page = rtl821x_write_page,
579 PHY_ID_MATCH_MODEL(0x001cc880),
580 .name = "RTL8208 Fast Ethernet",
581 .read_mmd = genphy_read_mmd_unsupported,
582 .write_mmd = genphy_write_mmd_unsupported,
583 .suspend = genphy_suspend,
584 .resume = genphy_resume,
585 .read_page = rtl821x_read_page,
586 .write_page = rtl821x_write_page,
588 PHY_ID_MATCH_EXACT(0x001cc910),
589 .name = "RTL8211 Gigabit Ethernet",
590 .config_aneg = rtl8211_config_aneg,
591 .read_mmd = &genphy_read_mmd_unsupported,
592 .write_mmd = &genphy_write_mmd_unsupported,
593 .read_page = rtl821x_read_page,
594 .write_page = rtl821x_write_page,
596 PHY_ID_MATCH_EXACT(0x001cc912),
597 .name = "RTL8211B Gigabit Ethernet",
598 .ack_interrupt = &rtl821x_ack_interrupt,
599 .config_intr = &rtl8211b_config_intr,
600 .read_mmd = &genphy_read_mmd_unsupported,
601 .write_mmd = &genphy_write_mmd_unsupported,
602 .suspend = rtl8211b_suspend,
603 .resume = rtl8211b_resume,
604 .read_page = rtl821x_read_page,
605 .write_page = rtl821x_write_page,
607 PHY_ID_MATCH_EXACT(0x001cc913),
608 .name = "RTL8211C Gigabit Ethernet",
609 .config_init = rtl8211c_config_init,
610 .read_mmd = &genphy_read_mmd_unsupported,
611 .write_mmd = &genphy_write_mmd_unsupported,
612 .read_page = rtl821x_read_page,
613 .write_page = rtl821x_write_page,
615 PHY_ID_MATCH_EXACT(0x001cc914),
616 .name = "RTL8211DN Gigabit Ethernet",
617 .ack_interrupt = rtl821x_ack_interrupt,
618 .config_intr = rtl8211e_config_intr,
619 .suspend = genphy_suspend,
620 .resume = genphy_resume,
621 .read_page = rtl821x_read_page,
622 .write_page = rtl821x_write_page,
624 PHY_ID_MATCH_EXACT(0x001cc915),
625 .name = "RTL8211E Gigabit Ethernet",
626 .config_init = &rtl8211e_config_init,
627 .ack_interrupt = &rtl821x_ack_interrupt,
628 .config_intr = &rtl8211e_config_intr,
629 .suspend = genphy_suspend,
630 .resume = genphy_resume,
631 .read_page = rtl821x_read_page,
632 .write_page = rtl821x_write_page,
634 PHY_ID_MATCH_EXACT(0x001cc916),
635 .name = "RTL8211F Gigabit Ethernet",
636 .config_init = &rtl8211f_config_init,
637 .ack_interrupt = &rtl8211f_ack_interrupt,
638 .config_intr = &rtl8211f_config_intr,
639 .suspend = genphy_suspend,
640 .resume = rtl821x_resume,
641 .read_page = rtl821x_read_page,
642 .write_page = rtl821x_write_page,
644 .name = "Generic FE-GE Realtek PHY",
645 .match_phy_device = rtlgen_match_phy_device,
646 .read_status = rtlgen_read_status,
647 .suspend = genphy_suspend,
648 .resume = rtlgen_resume,
649 .read_page = rtl821x_read_page,
650 .write_page = rtl821x_write_page,
651 .read_mmd = rtlgen_read_mmd,
652 .write_mmd = rtlgen_write_mmd,
654 .name = "RTL8226 2.5Gbps PHY",
655 .match_phy_device = rtl8226_match_phy_device,
656 .get_features = rtl822x_get_features,
657 .config_aneg = rtl822x_config_aneg,
658 .read_status = rtl822x_read_status,
659 .suspend = genphy_suspend,
660 .resume = rtlgen_resume,
661 .read_page = rtl821x_read_page,
662 .write_page = rtl821x_write_page,
663 .read_mmd = rtl822x_read_mmd,
664 .write_mmd = rtl822x_write_mmd,
666 PHY_ID_MATCH_EXACT(0x001cc840),
667 .name = "RTL8226B_RTL8221B 2.5Gbps PHY",
668 .get_features = rtl822x_get_features,
669 .config_aneg = rtl822x_config_aneg,
670 .read_status = rtl822x_read_status,
671 .suspend = genphy_suspend,
672 .resume = rtlgen_resume,
673 .read_page = rtl821x_read_page,
674 .write_page = rtl821x_write_page,
675 .read_mmd = rtl822x_read_mmd,
676 .write_mmd = rtl822x_write_mmd,
678 PHY_ID_MATCH_EXACT(0x001cc961),
679 .name = "RTL8366RB Gigabit Ethernet",
680 .config_init = &rtl8366rb_config_init,
681 /* These interrupts are handled by the irq controller
682 * embedded inside the RTL8366RB, they get unmasked when the
683 * irq is requested and ACKed by reading the status register,
684 * which is done by the irqchip code.
686 .ack_interrupt = genphy_no_ack_interrupt,
687 .config_intr = genphy_no_config_intr,
688 .suspend = genphy_suspend,
689 .resume = genphy_resume,
693 module_phy_driver(realtek_drvs);
695 static const struct mdio_device_id __maybe_unused realtek_tbl[] = {
696 { PHY_ID_MATCH_VENDOR(0x001cc800) },
700 MODULE_DEVICE_TABLE(mdio, realtek_tbl);