1 // SPDX-License-Identifier: GPL-2.0+
3 * drivers/net/phy/realtek.c
5 * Driver for Realtek PHYs
7 * Author: Johnson Leung <r58129@freescale.com>
9 * Copyright (c) 2004 Freescale Semiconductor, Inc.
11 #include <linux/bitops.h>
12 #include <linux/phy.h>
13 #include <linux/module.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_INSR 0x1d
31 #define RTL8211F_TX_DELAY BIT(8)
32 #define RTL8211F_RX_DELAY BIT(3)
34 #define RTL8211E_TX_DELAY BIT(1)
35 #define RTL8211E_RX_DELAY BIT(2)
36 #define RTL8211E_MODE_MII_GMII BIT(3)
38 #define RTL8201F_ISR 0x1e
39 #define RTL8201F_IER 0x13
41 #define RTL8366RB_POWER_SAVE 0x15
42 #define RTL8366RB_POWER_SAVE_ON BIT(12)
44 #define RTL_SUPPORTS_5000FULL BIT(14)
45 #define RTL_SUPPORTS_2500FULL BIT(13)
46 #define RTL_SUPPORTS_10000FULL BIT(0)
47 #define RTL_ADV_2500FULL BIT(7)
48 #define RTL_LPADV_10000FULL BIT(11)
49 #define RTL_LPADV_5000FULL BIT(6)
50 #define RTL_LPADV_2500FULL BIT(5)
52 #define RTL_GENERIC_PHYID 0x001cc800
54 MODULE_DESCRIPTION("Realtek PHY driver");
55 MODULE_AUTHOR("Johnson Leung");
56 MODULE_LICENSE("GPL");
58 static int rtl821x_read_page(struct phy_device
*phydev
)
60 return __phy_read(phydev
, RTL821x_PAGE_SELECT
);
63 static int rtl821x_write_page(struct phy_device
*phydev
, int page
)
65 return __phy_write(phydev
, RTL821x_PAGE_SELECT
, page
);
68 static int rtl8201_ack_interrupt(struct phy_device
*phydev
)
72 err
= phy_read(phydev
, RTL8201F_ISR
);
74 return (err
< 0) ? err
: 0;
77 static int rtl821x_ack_interrupt(struct phy_device
*phydev
)
81 err
= phy_read(phydev
, RTL821x_INSR
);
83 return (err
< 0) ? err
: 0;
86 static int rtl8211f_ack_interrupt(struct phy_device
*phydev
)
90 err
= phy_read_paged(phydev
, 0xa43, RTL8211F_INSR
);
92 return (err
< 0) ? err
: 0;
95 static int rtl8201_config_intr(struct phy_device
*phydev
)
99 if (phydev
->interrupts
== PHY_INTERRUPT_ENABLED
)
100 val
= BIT(13) | BIT(12) | BIT(11);
104 return phy_write_paged(phydev
, 0x7, RTL8201F_IER
, val
);
107 static int rtl8211b_config_intr(struct phy_device
*phydev
)
111 if (phydev
->interrupts
== PHY_INTERRUPT_ENABLED
)
112 err
= phy_write(phydev
, RTL821x_INER
,
115 err
= phy_write(phydev
, RTL821x_INER
, 0);
120 static int rtl8211e_config_intr(struct phy_device
*phydev
)
124 if (phydev
->interrupts
== PHY_INTERRUPT_ENABLED
)
125 err
= phy_write(phydev
, RTL821x_INER
,
126 RTL8211E_INER_LINK_STATUS
);
128 err
= phy_write(phydev
, RTL821x_INER
, 0);
133 static int rtl8211f_config_intr(struct phy_device
*phydev
)
137 if (phydev
->interrupts
== PHY_INTERRUPT_ENABLED
)
138 val
= RTL8211F_INER_LINK_STATUS
;
142 return phy_write_paged(phydev
, 0xa42, RTL821x_INER
, val
);
145 static int rtl8211_config_aneg(struct phy_device
*phydev
)
149 ret
= genphy_config_aneg(phydev
);
153 /* Quirk was copied from vendor driver. Unfortunately it includes no
154 * description of the magic numbers.
156 if (phydev
->speed
== SPEED_100
&& phydev
->autoneg
== AUTONEG_DISABLE
) {
157 phy_write(phydev
, 0x17, 0x2138);
158 phy_write(phydev
, 0x0e, 0x0260);
160 phy_write(phydev
, 0x17, 0x2108);
161 phy_write(phydev
, 0x0e, 0x0000);
167 static int rtl8211c_config_init(struct phy_device
*phydev
)
169 /* RTL8211C has an issue when operating in Gigabit slave mode */
170 return phy_set_bits(phydev
, MII_CTRL1000
,
171 CTL1000_ENABLE_MASTER
| CTL1000_AS_MASTER
);
174 static int rtl8211f_config_init(struct phy_device
*phydev
)
176 struct device
*dev
= &phydev
->mdio
.dev
;
177 u16 val_txdly
, val_rxdly
;
180 switch (phydev
->interface
) {
181 case PHY_INTERFACE_MODE_RGMII
:
186 case PHY_INTERFACE_MODE_RGMII_RXID
:
188 val_rxdly
= RTL8211F_RX_DELAY
;
191 case PHY_INTERFACE_MODE_RGMII_TXID
:
192 val_txdly
= RTL8211F_TX_DELAY
;
196 case PHY_INTERFACE_MODE_RGMII_ID
:
197 val_txdly
= RTL8211F_TX_DELAY
;
198 val_rxdly
= RTL8211F_RX_DELAY
;
201 default: /* the rest of the modes imply leaving delay as is. */
205 ret
= phy_modify_paged_changed(phydev
, 0xd08, 0x11, RTL8211F_TX_DELAY
,
208 dev_err(dev
, "Failed to update the TX delay register\n");
212 "%s 2ns TX delay (and changing the value from pin-strapping RXD1 or the bootloader)\n",
213 val_txdly
? "Enabling" : "Disabling");
216 "2ns TX delay was already %s (by pin-strapping RXD1 or bootloader configuration)\n",
217 val_txdly
? "enabled" : "disabled");
220 ret
= phy_modify_paged_changed(phydev
, 0xd08, 0x15, RTL8211F_RX_DELAY
,
223 dev_err(dev
, "Failed to update the RX delay register\n");
227 "%s 2ns RX delay (and changing the value from pin-strapping RXD0 or the bootloader)\n",
228 val_rxdly
? "Enabling" : "Disabling");
231 "2ns RX delay was already %s (by pin-strapping RXD0 or bootloader configuration)\n",
232 val_rxdly
? "enabled" : "disabled");
238 static int rtl8211e_config_init(struct phy_device
*phydev
)
240 int ret
= 0, oldpage
;
243 /* enable TX/RX delay for rgmii-* modes, and disable them for rgmii. */
244 switch (phydev
->interface
) {
245 case PHY_INTERFACE_MODE_RGMII
:
248 case PHY_INTERFACE_MODE_RGMII_ID
:
249 val
= RTL8211E_TX_DELAY
| RTL8211E_RX_DELAY
;
251 case PHY_INTERFACE_MODE_RGMII_RXID
:
252 val
= RTL8211E_RX_DELAY
;
254 case PHY_INTERFACE_MODE_RGMII_TXID
:
255 val
= RTL8211E_TX_DELAY
;
257 default: /* the rest of the modes imply leaving delays as is. */
261 /* According to a sample driver there is a 0x1c config register on the
262 * 0xa4 extension page (0x7) layout. It can be used to disable/enable
263 * the RX/TX delays otherwise controlled by RXDLY/TXDLY pins. It can
264 * also be used to customize the whole configuration register:
265 * 8:6 = PHY Address, 5:4 = Auto-Negotiation, 3 = Interface Mode Select,
266 * 2 = RX Delay, 1 = TX Delay, 0 = SELRGV (see original PHY datasheet
269 oldpage
= phy_select_page(phydev
, 0x7);
271 goto err_restore_page
;
273 ret
= __phy_write(phydev
, RTL821x_EXT_PAGE_SELECT
, 0xa4);
275 goto err_restore_page
;
277 ret
= __phy_modify(phydev
, 0x1c, RTL8211E_TX_DELAY
| RTL8211E_RX_DELAY
,
281 return phy_restore_page(phydev
, oldpage
, ret
);
284 static int rtl8211b_suspend(struct phy_device
*phydev
)
286 phy_write(phydev
, MII_MMD_DATA
, BIT(9));
288 return genphy_suspend(phydev
);
291 static int rtl8211b_resume(struct phy_device
*phydev
)
293 phy_write(phydev
, MII_MMD_DATA
, 0);
295 return genphy_resume(phydev
);
298 static int rtl8366rb_config_init(struct phy_device
*phydev
)
302 ret
= phy_set_bits(phydev
, RTL8366RB_POWER_SAVE
,
303 RTL8366RB_POWER_SAVE_ON
);
305 dev_err(&phydev
->mdio
.dev
,
306 "error enabling power management\n");
312 static int rtlgen_read_mmd(struct phy_device
*phydev
, int devnum
, u16 regnum
)
316 if (devnum
== MDIO_MMD_PCS
&& regnum
== MDIO_PCS_EEE_ABLE
) {
317 rtl821x_write_page(phydev
, 0xa5c);
318 ret
= __phy_read(phydev
, 0x12);
319 rtl821x_write_page(phydev
, 0);
320 } else if (devnum
== MDIO_MMD_AN
&& regnum
== MDIO_AN_EEE_ADV
) {
321 rtl821x_write_page(phydev
, 0xa5d);
322 ret
= __phy_read(phydev
, 0x10);
323 rtl821x_write_page(phydev
, 0);
324 } else if (devnum
== MDIO_MMD_AN
&& regnum
== MDIO_AN_EEE_LPABLE
) {
325 rtl821x_write_page(phydev
, 0xa5d);
326 ret
= __phy_read(phydev
, 0x11);
327 rtl821x_write_page(phydev
, 0);
335 static int rtlgen_write_mmd(struct phy_device
*phydev
, int devnum
, u16 regnum
,
340 if (devnum
== MDIO_MMD_AN
&& regnum
== MDIO_AN_EEE_ADV
) {
341 rtl821x_write_page(phydev
, 0xa5d);
342 ret
= __phy_write(phydev
, 0x10, val
);
343 rtl821x_write_page(phydev
, 0);
351 static int rtl8125_read_mmd(struct phy_device
*phydev
, int devnum
, u16 regnum
)
353 int ret
= rtlgen_read_mmd(phydev
, devnum
, regnum
);
355 if (ret
!= -EOPNOTSUPP
)
358 if (devnum
== MDIO_MMD_PCS
&& regnum
== MDIO_PCS_EEE_ABLE2
) {
359 rtl821x_write_page(phydev
, 0xa6e);
360 ret
= __phy_read(phydev
, 0x16);
361 rtl821x_write_page(phydev
, 0);
362 } else if (devnum
== MDIO_MMD_AN
&& regnum
== MDIO_AN_EEE_ADV2
) {
363 rtl821x_write_page(phydev
, 0xa6d);
364 ret
= __phy_read(phydev
, 0x12);
365 rtl821x_write_page(phydev
, 0);
366 } else if (devnum
== MDIO_MMD_AN
&& regnum
== MDIO_AN_EEE_LPABLE2
) {
367 rtl821x_write_page(phydev
, 0xa6d);
368 ret
= __phy_read(phydev
, 0x10);
369 rtl821x_write_page(phydev
, 0);
375 static int rtl8125_write_mmd(struct phy_device
*phydev
, int devnum
, u16 regnum
,
378 int ret
= rtlgen_write_mmd(phydev
, devnum
, regnum
, val
);
380 if (ret
!= -EOPNOTSUPP
)
383 if (devnum
== MDIO_MMD_AN
&& regnum
== MDIO_AN_EEE_ADV2
) {
384 rtl821x_write_page(phydev
, 0xa6d);
385 ret
= __phy_write(phydev
, 0x12, val
);
386 rtl821x_write_page(phydev
, 0);
392 static int rtl8125_get_features(struct phy_device
*phydev
)
396 val
= phy_read_paged(phydev
, 0xa61, 0x13);
400 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT
,
401 phydev
->supported
, val
& RTL_SUPPORTS_2500FULL
);
402 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT
,
403 phydev
->supported
, val
& RTL_SUPPORTS_5000FULL
);
404 linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT
,
405 phydev
->supported
, val
& RTL_SUPPORTS_10000FULL
);
407 return genphy_read_abilities(phydev
);
410 static int rtl8125_config_aneg(struct phy_device
*phydev
)
414 if (phydev
->autoneg
== AUTONEG_ENABLE
) {
417 if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT
,
418 phydev
->advertising
))
419 adv2500
= RTL_ADV_2500FULL
;
421 ret
= phy_modify_paged_changed(phydev
, 0xa5d, 0x12,
422 RTL_ADV_2500FULL
, adv2500
);
427 return __genphy_config_aneg(phydev
, ret
);
430 static int rtl8125_read_status(struct phy_device
*phydev
)
432 if (phydev
->autoneg
== AUTONEG_ENABLE
) {
433 int lpadv
= phy_read_paged(phydev
, 0xa5d, 0x13);
438 linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT
,
439 phydev
->lp_advertising
, lpadv
& RTL_LPADV_10000FULL
);
440 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT
,
441 phydev
->lp_advertising
, lpadv
& RTL_LPADV_5000FULL
);
442 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT
,
443 phydev
->lp_advertising
, lpadv
& RTL_LPADV_2500FULL
);
446 return genphy_read_status(phydev
);
449 static bool rtlgen_supports_2_5gbps(struct phy_device
*phydev
)
453 phy_write(phydev
, RTL821x_PAGE_SELECT
, 0xa61);
454 val
= phy_read(phydev
, 0x13);
455 phy_write(phydev
, RTL821x_PAGE_SELECT
, 0);
457 return val
>= 0 && val
& RTL_SUPPORTS_2500FULL
;
460 static int rtlgen_match_phy_device(struct phy_device
*phydev
)
462 return phydev
->phy_id
== RTL_GENERIC_PHYID
&&
463 !rtlgen_supports_2_5gbps(phydev
);
466 static int rtl8125_match_phy_device(struct phy_device
*phydev
)
468 return phydev
->phy_id
== RTL_GENERIC_PHYID
&&
469 rtlgen_supports_2_5gbps(phydev
);
472 static struct phy_driver realtek_drvs
[] = {
474 PHY_ID_MATCH_EXACT(0x00008201),
475 .name
= "RTL8201CP Ethernet",
477 PHY_ID_MATCH_EXACT(0x001cc816),
478 .name
= "RTL8201F Fast Ethernet",
479 .ack_interrupt
= &rtl8201_ack_interrupt
,
480 .config_intr
= &rtl8201_config_intr
,
481 .suspend
= genphy_suspend
,
482 .resume
= genphy_resume
,
483 .read_page
= rtl821x_read_page
,
484 .write_page
= rtl821x_write_page
,
486 PHY_ID_MATCH_MODEL(0x001cc880),
487 .name
= "RTL8208 Fast Ethernet",
488 .read_mmd
= genphy_read_mmd_unsupported
,
489 .write_mmd
= genphy_write_mmd_unsupported
,
490 .suspend
= genphy_suspend
,
491 .resume
= genphy_resume
,
492 .read_page
= rtl821x_read_page
,
493 .write_page
= rtl821x_write_page
,
495 PHY_ID_MATCH_EXACT(0x001cc910),
496 .name
= "RTL8211 Gigabit Ethernet",
497 .config_aneg
= rtl8211_config_aneg
,
498 .read_mmd
= &genphy_read_mmd_unsupported
,
499 .write_mmd
= &genphy_write_mmd_unsupported
,
500 .read_page
= rtl821x_read_page
,
501 .write_page
= rtl821x_write_page
,
503 PHY_ID_MATCH_EXACT(0x001cc912),
504 .name
= "RTL8211B Gigabit Ethernet",
505 .ack_interrupt
= &rtl821x_ack_interrupt
,
506 .config_intr
= &rtl8211b_config_intr
,
507 .read_mmd
= &genphy_read_mmd_unsupported
,
508 .write_mmd
= &genphy_write_mmd_unsupported
,
509 .suspend
= rtl8211b_suspend
,
510 .resume
= rtl8211b_resume
,
511 .read_page
= rtl821x_read_page
,
512 .write_page
= rtl821x_write_page
,
514 PHY_ID_MATCH_EXACT(0x001cc913),
515 .name
= "RTL8211C Gigabit Ethernet",
516 .config_init
= rtl8211c_config_init
,
517 .read_mmd
= &genphy_read_mmd_unsupported
,
518 .write_mmd
= &genphy_write_mmd_unsupported
,
519 .read_page
= rtl821x_read_page
,
520 .write_page
= rtl821x_write_page
,
522 PHY_ID_MATCH_EXACT(0x001cc914),
523 .name
= "RTL8211DN Gigabit Ethernet",
524 .ack_interrupt
= rtl821x_ack_interrupt
,
525 .config_intr
= rtl8211e_config_intr
,
526 .suspend
= genphy_suspend
,
527 .resume
= genphy_resume
,
528 .read_page
= rtl821x_read_page
,
529 .write_page
= rtl821x_write_page
,
531 PHY_ID_MATCH_EXACT(0x001cc915),
532 .name
= "RTL8211E Gigabit Ethernet",
533 .config_init
= &rtl8211e_config_init
,
534 .ack_interrupt
= &rtl821x_ack_interrupt
,
535 .config_intr
= &rtl8211e_config_intr
,
536 .suspend
= genphy_suspend
,
537 .resume
= genphy_resume
,
538 .read_page
= rtl821x_read_page
,
539 .write_page
= rtl821x_write_page
,
541 PHY_ID_MATCH_EXACT(0x001cc916),
542 .name
= "RTL8211F Gigabit Ethernet",
543 .config_init
= &rtl8211f_config_init
,
544 .ack_interrupt
= &rtl8211f_ack_interrupt
,
545 .config_intr
= &rtl8211f_config_intr
,
546 .suspend
= genphy_suspend
,
547 .resume
= genphy_resume
,
548 .read_page
= rtl821x_read_page
,
549 .write_page
= rtl821x_write_page
,
551 .name
= "Generic FE-GE Realtek PHY",
552 .match_phy_device
= rtlgen_match_phy_device
,
553 .suspend
= genphy_suspend
,
554 .resume
= genphy_resume
,
555 .read_page
= rtl821x_read_page
,
556 .write_page
= rtl821x_write_page
,
557 .read_mmd
= rtlgen_read_mmd
,
558 .write_mmd
= rtlgen_write_mmd
,
560 .name
= "RTL8125 2.5Gbps internal",
561 .match_phy_device
= rtl8125_match_phy_device
,
562 .get_features
= rtl8125_get_features
,
563 .config_aneg
= rtl8125_config_aneg
,
564 .read_status
= rtl8125_read_status
,
565 .suspend
= genphy_suspend
,
566 .resume
= genphy_resume
,
567 .read_page
= rtl821x_read_page
,
568 .write_page
= rtl821x_write_page
,
569 .read_mmd
= rtl8125_read_mmd
,
570 .write_mmd
= rtl8125_write_mmd
,
572 PHY_ID_MATCH_EXACT(0x001cc961),
573 .name
= "RTL8366RB Gigabit Ethernet",
574 .config_init
= &rtl8366rb_config_init
,
575 /* These interrupts are handled by the irq controller
576 * embedded inside the RTL8366RB, they get unmasked when the
577 * irq is requested and ACKed by reading the status register,
578 * which is done by the irqchip code.
580 .ack_interrupt
= genphy_no_ack_interrupt
,
581 .config_intr
= genphy_no_config_intr
,
582 .suspend
= genphy_suspend
,
583 .resume
= genphy_resume
,
587 module_phy_driver(realtek_drvs
);
589 static const struct mdio_device_id __maybe_unused realtek_tbl
[] = {
590 { PHY_ID_MATCH_VENDOR(0x001cc800) },
594 MODULE_DEVICE_TABLE(mdio
, realtek_tbl
);