1 // SPDX-License-Identifier: GPL-2.0
2 /* Driver for the Texas Instruments DP83822, DP83825 and DP83826 PHYs.
4 * Copyright (C) 2017 Texas Instruments Inc.
7 #include <linux/ethtool.h>
8 #include <linux/etherdevice.h>
9 #include <linux/kernel.h>
10 #include <linux/mii.h>
11 #include <linux/module.h>
13 #include <linux/phy.h>
14 #include <linux/netdevice.h>
16 #define DP83822_PHY_ID 0x2000a240
17 #define DP83825S_PHY_ID 0x2000a140
18 #define DP83825I_PHY_ID 0x2000a150
19 #define DP83825CM_PHY_ID 0x2000a160
20 #define DP83825CS_PHY_ID 0x2000a170
21 #define DP83826C_PHY_ID 0x2000a130
22 #define DP83826NC_PHY_ID 0x2000a110
24 #define DP83822_DEVADDR 0x1f
26 #define MII_DP83822_CTRL_2 0x0a
27 #define MII_DP83822_PHYSTS 0x10
28 #define MII_DP83822_PHYSCR 0x11
29 #define MII_DP83822_MISR1 0x12
30 #define MII_DP83822_MISR2 0x13
31 #define MII_DP83822_FCSCR 0x14
32 #define MII_DP83822_RCSR 0x17
33 #define MII_DP83822_RESET_CTRL 0x1f
34 #define MII_DP83822_GENCFG 0x465
35 #define MII_DP83822_SOR1 0x467
38 #define DP83822_SIG_DET_LOW BIT(0)
40 /* Control Register 2 bits */
41 #define DP83822_FX_ENABLE BIT(14)
43 #define DP83822_HW_RESET BIT(15)
44 #define DP83822_SW_RESET BIT(14)
47 #define DP83822_PHYSTS_DUPLEX BIT(2)
48 #define DP83822_PHYSTS_10 BIT(1)
49 #define DP83822_PHYSTS_LINK BIT(0)
51 /* PHYSCR Register Fields */
52 #define DP83822_PHYSCR_INT_OE BIT(0) /* Interrupt Output Enable */
53 #define DP83822_PHYSCR_INTEN BIT(1) /* Interrupt Enable */
56 #define DP83822_RX_ERR_HF_INT_EN BIT(0)
57 #define DP83822_FALSE_CARRIER_HF_INT_EN BIT(1)
58 #define DP83822_ANEG_COMPLETE_INT_EN BIT(2)
59 #define DP83822_DUP_MODE_CHANGE_INT_EN BIT(3)
60 #define DP83822_SPEED_CHANGED_INT_EN BIT(4)
61 #define DP83822_LINK_STAT_INT_EN BIT(5)
62 #define DP83822_ENERGY_DET_INT_EN BIT(6)
63 #define DP83822_LINK_QUAL_INT_EN BIT(7)
66 #define DP83822_JABBER_DET_INT_EN BIT(0)
67 #define DP83822_WOL_PKT_INT_EN BIT(1)
68 #define DP83822_SLEEP_MODE_INT_EN BIT(2)
69 #define DP83822_MDI_XOVER_INT_EN BIT(3)
70 #define DP83822_LB_FIFO_INT_EN BIT(4)
71 #define DP83822_PAGE_RX_INT_EN BIT(5)
72 #define DP83822_ANEG_ERR_INT_EN BIT(6)
73 #define DP83822_EEE_ERROR_CHANGE_INT_EN BIT(7)
76 #define DP83822_WOL_INT_EN BIT(4)
77 #define DP83822_WOL_INT_STAT BIT(12)
79 #define MII_DP83822_RXSOP1 0x04a5
80 #define MII_DP83822_RXSOP2 0x04a6
81 #define MII_DP83822_RXSOP3 0x04a7
84 #define MII_DP83822_WOL_CFG 0x04a0
85 #define MII_DP83822_WOL_STAT 0x04a1
86 #define MII_DP83822_WOL_DA1 0x04a2
87 #define MII_DP83822_WOL_DA2 0x04a3
88 #define MII_DP83822_WOL_DA3 0x04a4
91 #define DP83822_WOL_MAGIC_EN BIT(0)
92 #define DP83822_WOL_SECURE_ON BIT(5)
93 #define DP83822_WOL_EN BIT(7)
94 #define DP83822_WOL_INDICATION_SEL BIT(8)
95 #define DP83822_WOL_CLR_INDICATION BIT(11)
98 #define DP83822_RX_CLK_SHIFT BIT(12)
99 #define DP83822_TX_CLK_SHIFT BIT(11)
102 #define DP83822_STRAP_MODE1 0
103 #define DP83822_STRAP_MODE2 BIT(0)
104 #define DP83822_STRAP_MODE3 BIT(1)
105 #define DP83822_STRAP_MODE4 GENMASK(1, 0)
107 #define DP83822_COL_STRAP_MASK GENMASK(11, 10)
108 #define DP83822_COL_SHIFT 10
109 #define DP83822_RX_ER_STR_MASK GENMASK(9, 8)
110 #define DP83822_RX_ER_SHIFT 8
112 #define MII_DP83822_FIBER_ADVERTISE (ADVERTISED_TP | ADVERTISED_MII | \
114 ADVERTISED_Pause | ADVERTISED_Asym_Pause)
116 struct dp83822_private {
117 bool fx_signal_det_low;
122 static int dp83822_ack_interrupt(struct phy_device *phydev)
126 err = phy_read(phydev, MII_DP83822_MISR1);
130 err = phy_read(phydev, MII_DP83822_MISR2);
137 static int dp83822_set_wol(struct phy_device *phydev,
138 struct ethtool_wolinfo *wol)
140 struct net_device *ndev = phydev->attached_dev;
144 if (wol->wolopts & (WAKE_MAGIC | WAKE_MAGICSECURE)) {
145 mac = (const u8 *)ndev->dev_addr;
147 if (!is_valid_ether_addr(mac))
150 /* MAC addresses start with byte 5, but stored in mac[0].
151 * 822 PHYs store bytes 4|5, 2|3, 0|1
153 phy_write_mmd(phydev, DP83822_DEVADDR, MII_DP83822_WOL_DA1,
154 (mac[1] << 8) | mac[0]);
155 phy_write_mmd(phydev, DP83822_DEVADDR, MII_DP83822_WOL_DA2,
156 (mac[3] << 8) | mac[2]);
157 phy_write_mmd(phydev, DP83822_DEVADDR, MII_DP83822_WOL_DA3,
158 (mac[5] << 8) | mac[4]);
160 value = phy_read_mmd(phydev, DP83822_DEVADDR,
161 MII_DP83822_WOL_CFG);
162 if (wol->wolopts & WAKE_MAGIC)
163 value |= DP83822_WOL_MAGIC_EN;
165 value &= ~DP83822_WOL_MAGIC_EN;
167 if (wol->wolopts & WAKE_MAGICSECURE) {
168 phy_write_mmd(phydev, DP83822_DEVADDR,
170 (wol->sopass[1] << 8) | wol->sopass[0]);
171 phy_write_mmd(phydev, DP83822_DEVADDR,
173 (wol->sopass[3] << 8) | wol->sopass[2]);
174 phy_write_mmd(phydev, DP83822_DEVADDR,
176 (wol->sopass[5] << 8) | wol->sopass[4]);
177 value |= DP83822_WOL_SECURE_ON;
179 value &= ~DP83822_WOL_SECURE_ON;
182 /* Clear any pending WoL interrupt */
183 phy_read(phydev, MII_DP83822_MISR2);
185 value |= DP83822_WOL_EN | DP83822_WOL_INDICATION_SEL |
186 DP83822_WOL_CLR_INDICATION;
188 return phy_write_mmd(phydev, DP83822_DEVADDR,
189 MII_DP83822_WOL_CFG, value);
191 return phy_clear_bits_mmd(phydev, DP83822_DEVADDR,
192 MII_DP83822_WOL_CFG, DP83822_WOL_EN);
196 static void dp83822_get_wol(struct phy_device *phydev,
197 struct ethtool_wolinfo *wol)
202 wol->supported = (WAKE_MAGIC | WAKE_MAGICSECURE);
205 value = phy_read_mmd(phydev, DP83822_DEVADDR, MII_DP83822_WOL_CFG);
207 if (value & DP83822_WOL_MAGIC_EN)
208 wol->wolopts |= WAKE_MAGIC;
210 if (value & DP83822_WOL_SECURE_ON) {
211 sopass_val = phy_read_mmd(phydev, DP83822_DEVADDR,
213 wol->sopass[0] = (sopass_val & 0xff);
214 wol->sopass[1] = (sopass_val >> 8);
216 sopass_val = phy_read_mmd(phydev, DP83822_DEVADDR,
218 wol->sopass[2] = (sopass_val & 0xff);
219 wol->sopass[3] = (sopass_val >> 8);
221 sopass_val = phy_read_mmd(phydev, DP83822_DEVADDR,
223 wol->sopass[4] = (sopass_val & 0xff);
224 wol->sopass[5] = (sopass_val >> 8);
226 wol->wolopts |= WAKE_MAGICSECURE;
229 /* WoL is not enabled so set wolopts to 0 */
230 if (!(value & DP83822_WOL_EN))
234 static int dp83822_config_intr(struct phy_device *phydev)
236 struct dp83822_private *dp83822 = phydev->priv;
241 if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
242 misr_status = phy_read(phydev, MII_DP83822_MISR1);
246 misr_status |= (DP83822_RX_ERR_HF_INT_EN |
247 DP83822_FALSE_CARRIER_HF_INT_EN |
248 DP83822_LINK_STAT_INT_EN |
249 DP83822_ENERGY_DET_INT_EN |
250 DP83822_LINK_QUAL_INT_EN);
252 if (!dp83822->fx_enabled)
253 misr_status |= DP83822_ANEG_COMPLETE_INT_EN |
254 DP83822_DUP_MODE_CHANGE_INT_EN |
255 DP83822_SPEED_CHANGED_INT_EN;
258 err = phy_write(phydev, MII_DP83822_MISR1, misr_status);
262 misr_status = phy_read(phydev, MII_DP83822_MISR2);
266 misr_status |= (DP83822_JABBER_DET_INT_EN |
267 DP83822_SLEEP_MODE_INT_EN |
268 DP83822_LB_FIFO_INT_EN |
269 DP83822_PAGE_RX_INT_EN |
270 DP83822_EEE_ERROR_CHANGE_INT_EN);
272 if (!dp83822->fx_enabled)
273 misr_status |= DP83822_MDI_XOVER_INT_EN |
274 DP83822_ANEG_ERR_INT_EN |
275 DP83822_WOL_PKT_INT_EN;
277 err = phy_write(phydev, MII_DP83822_MISR2, misr_status);
281 physcr_status = phy_read(phydev, MII_DP83822_PHYSCR);
282 if (physcr_status < 0)
283 return physcr_status;
285 physcr_status |= DP83822_PHYSCR_INT_OE | DP83822_PHYSCR_INTEN;
288 err = phy_write(phydev, MII_DP83822_MISR1, 0);
292 err = phy_write(phydev, MII_DP83822_MISR1, 0);
296 physcr_status = phy_read(phydev, MII_DP83822_PHYSCR);
297 if (physcr_status < 0)
298 return physcr_status;
300 physcr_status &= ~DP83822_PHYSCR_INTEN;
303 return phy_write(phydev, MII_DP83822_PHYSCR, physcr_status);
306 static irqreturn_t dp83822_handle_interrupt(struct phy_device *phydev)
310 /* The MISR1 and MISR2 registers are holding the interrupt status in
311 * the upper half (15:8), while the lower half (7:0) is used for
312 * controlling the interrupt enable state of those individual interrupt
313 * sources. To determine the possible interrupt sources, just read the
314 * MISR* register and use it directly to know which interrupts have
315 * been enabled previously or not.
317 irq_status = phy_read(phydev, MII_DP83822_MISR1);
318 if (irq_status < 0) {
322 if (irq_status & ((irq_status & GENMASK(7, 0)) << 8))
323 goto trigger_machine;
325 irq_status = phy_read(phydev, MII_DP83822_MISR2);
326 if (irq_status < 0) {
330 if (irq_status & ((irq_status & GENMASK(7, 0)) << 8))
331 goto trigger_machine;
336 phy_trigger_machine(phydev);
341 static int dp8382x_disable_wol(struct phy_device *phydev)
343 int value = DP83822_WOL_EN | DP83822_WOL_MAGIC_EN |
344 DP83822_WOL_SECURE_ON;
346 return phy_clear_bits_mmd(phydev, DP83822_DEVADDR,
347 MII_DP83822_WOL_CFG, value);
350 static int dp83822_read_status(struct phy_device *phydev)
352 struct dp83822_private *dp83822 = phydev->priv;
353 int status = phy_read(phydev, MII_DP83822_PHYSTS);
357 if (dp83822->fx_enabled) {
358 if (status & DP83822_PHYSTS_LINK) {
359 phydev->speed = SPEED_UNKNOWN;
360 phydev->duplex = DUPLEX_UNKNOWN;
362 ctrl2 = phy_read(phydev, MII_DP83822_CTRL_2);
366 if (!(ctrl2 & DP83822_FX_ENABLE)) {
367 ret = phy_write(phydev, MII_DP83822_CTRL_2,
368 DP83822_FX_ENABLE | ctrl2);
375 ret = genphy_read_status(phydev);
382 if (status & DP83822_PHYSTS_DUPLEX)
383 phydev->duplex = DUPLEX_FULL;
385 phydev->duplex = DUPLEX_HALF;
387 if (status & DP83822_PHYSTS_10)
388 phydev->speed = SPEED_10;
390 phydev->speed = SPEED_100;
395 static int dp83822_config_init(struct phy_device *phydev)
397 struct dp83822_private *dp83822 = phydev->priv;
398 struct device *dev = &phydev->mdio.dev;
405 if (phy_interface_is_rgmii(phydev)) {
406 rx_int_delay = phy_get_internal_delay(phydev, dev, NULL, 0,
409 if (rx_int_delay <= 0)
412 rgmii_delay = DP83822_RX_CLK_SHIFT;
414 tx_int_delay = phy_get_internal_delay(phydev, dev, NULL, 0,
416 if (tx_int_delay <= 0)
417 rgmii_delay &= ~DP83822_TX_CLK_SHIFT;
419 rgmii_delay |= DP83822_TX_CLK_SHIFT;
422 err = phy_set_bits_mmd(phydev, DP83822_DEVADDR,
423 MII_DP83822_RCSR, rgmii_delay);
429 if (dp83822->fx_enabled) {
430 err = phy_modify(phydev, MII_DP83822_CTRL_2,
431 DP83822_FX_ENABLE, 1);
435 /* Only allow advertising what this PHY supports */
436 linkmode_and(phydev->advertising, phydev->advertising,
439 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
441 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
442 phydev->advertising);
443 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseFX_Full_BIT,
445 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseFX_Half_BIT,
447 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseFX_Full_BIT,
448 phydev->advertising);
449 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseFX_Half_BIT,
450 phydev->advertising);
452 /* Auto neg is not supported in fiber mode */
453 bmcr = phy_read(phydev, MII_BMCR);
457 if (bmcr & BMCR_ANENABLE) {
458 err = phy_modify(phydev, MII_BMCR, BMCR_ANENABLE, 0);
462 phydev->autoneg = AUTONEG_DISABLE;
463 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
465 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
466 phydev->advertising);
468 /* Setup fiber advertisement */
469 err = phy_modify_changed(phydev, MII_ADVERTISE,
470 MII_DP83822_FIBER_ADVERTISE,
471 MII_DP83822_FIBER_ADVERTISE);
476 if (dp83822->fx_signal_det_low) {
477 err = phy_set_bits_mmd(phydev, DP83822_DEVADDR,
479 DP83822_SIG_DET_LOW);
484 return dp8382x_disable_wol(phydev);
487 static int dp8382x_config_init(struct phy_device *phydev)
489 return dp8382x_disable_wol(phydev);
492 static int dp83822_phy_reset(struct phy_device *phydev)
496 err = phy_write(phydev, MII_DP83822_RESET_CTRL, DP83822_SW_RESET);
500 return phydev->drv->config_init(phydev);
503 #ifdef CONFIG_OF_MDIO
504 static int dp83822_of_init(struct phy_device *phydev)
506 struct dp83822_private *dp83822 = phydev->priv;
507 struct device *dev = &phydev->mdio.dev;
509 /* Signal detection for the PHY is only enabled if the FX_EN and the
510 * SD_EN pins are strapped. Signal detection can only enabled if FX_EN
511 * is strapped otherwise signal detection is disabled for the PHY.
513 if (dp83822->fx_enabled && dp83822->fx_sd_enable)
514 dp83822->fx_signal_det_low = device_property_present(dev,
516 if (!dp83822->fx_enabled)
517 dp83822->fx_enabled = device_property_present(dev,
523 static int dp83822_of_init(struct phy_device *phydev)
527 #endif /* CONFIG_OF_MDIO */
529 static int dp83822_read_straps(struct phy_device *phydev)
531 struct dp83822_private *dp83822 = phydev->priv;
532 int fx_enabled, fx_sd_enable;
535 val = phy_read_mmd(phydev, DP83822_DEVADDR, MII_DP83822_SOR1);
539 fx_enabled = (val & DP83822_COL_STRAP_MASK) >> DP83822_COL_SHIFT;
540 if (fx_enabled == DP83822_STRAP_MODE2 ||
541 fx_enabled == DP83822_STRAP_MODE3)
542 dp83822->fx_enabled = 1;
544 if (dp83822->fx_enabled) {
545 fx_sd_enable = (val & DP83822_RX_ER_STR_MASK) >> DP83822_RX_ER_SHIFT;
546 if (fx_sd_enable == DP83822_STRAP_MODE3 ||
547 fx_sd_enable == DP83822_STRAP_MODE4)
548 dp83822->fx_sd_enable = 1;
554 static int dp83822_probe(struct phy_device *phydev)
556 struct dp83822_private *dp83822;
559 dp83822 = devm_kzalloc(&phydev->mdio.dev, sizeof(*dp83822),
564 phydev->priv = dp83822;
566 ret = dp83822_read_straps(phydev);
570 dp83822_of_init(phydev);
575 static int dp83822_suspend(struct phy_device *phydev)
579 value = phy_read_mmd(phydev, DP83822_DEVADDR, MII_DP83822_WOL_CFG);
581 if (!(value & DP83822_WOL_EN))
582 genphy_suspend(phydev);
587 static int dp83822_resume(struct phy_device *phydev)
591 genphy_resume(phydev);
593 value = phy_read_mmd(phydev, DP83822_DEVADDR, MII_DP83822_WOL_CFG);
595 phy_write_mmd(phydev, DP83822_DEVADDR, MII_DP83822_WOL_CFG, value |
596 DP83822_WOL_CLR_INDICATION);
601 #define DP83822_PHY_DRIVER(_id, _name) \
603 PHY_ID_MATCH_MODEL(_id), \
605 /* PHY_BASIC_FEATURES */ \
606 .probe = dp83822_probe, \
607 .soft_reset = dp83822_phy_reset, \
608 .config_init = dp83822_config_init, \
609 .read_status = dp83822_read_status, \
610 .get_wol = dp83822_get_wol, \
611 .set_wol = dp83822_set_wol, \
612 .ack_interrupt = dp83822_ack_interrupt, \
613 .config_intr = dp83822_config_intr, \
614 .handle_interrupt = dp83822_handle_interrupt, \
615 .suspend = dp83822_suspend, \
616 .resume = dp83822_resume, \
619 #define DP8382X_PHY_DRIVER(_id, _name) \
621 PHY_ID_MATCH_MODEL(_id), \
623 /* PHY_BASIC_FEATURES */ \
624 .soft_reset = dp83822_phy_reset, \
625 .config_init = dp8382x_config_init, \
626 .get_wol = dp83822_get_wol, \
627 .set_wol = dp83822_set_wol, \
628 .ack_interrupt = dp83822_ack_interrupt, \
629 .config_intr = dp83822_config_intr, \
630 .handle_interrupt = dp83822_handle_interrupt, \
631 .suspend = dp83822_suspend, \
632 .resume = dp83822_resume, \
635 static struct phy_driver dp83822_driver[] = {
636 DP83822_PHY_DRIVER(DP83822_PHY_ID, "TI DP83822"),
637 DP8382X_PHY_DRIVER(DP83825I_PHY_ID, "TI DP83825I"),
638 DP8382X_PHY_DRIVER(DP83826C_PHY_ID, "TI DP83826C"),
639 DP8382X_PHY_DRIVER(DP83826NC_PHY_ID, "TI DP83826NC"),
640 DP8382X_PHY_DRIVER(DP83825S_PHY_ID, "TI DP83825S"),
641 DP8382X_PHY_DRIVER(DP83825CM_PHY_ID, "TI DP83825M"),
642 DP8382X_PHY_DRIVER(DP83825CS_PHY_ID, "TI DP83825CS"),
644 module_phy_driver(dp83822_driver);
646 static struct mdio_device_id __maybe_unused dp83822_tbl[] = {
647 { DP83822_PHY_ID, 0xfffffff0 },
648 { DP83825I_PHY_ID, 0xfffffff0 },
649 { DP83826C_PHY_ID, 0xfffffff0 },
650 { DP83826NC_PHY_ID, 0xfffffff0 },
651 { DP83825S_PHY_ID, 0xfffffff0 },
652 { DP83825CM_PHY_ID, 0xfffffff0 },
653 { DP83825CS_PHY_ID, 0xfffffff0 },
656 MODULE_DEVICE_TABLE(mdio, dp83822_tbl);
658 MODULE_DESCRIPTION("Texas Instruments DP83822 PHY driver");
659 MODULE_AUTHOR("Dan Murphy <dmurphy@ti.com");
660 MODULE_LICENSE("GPL v2");