1 // SPDX-License-Identifier: GPL-2.0+
3 * Marvell 10G 88x3310 PHY driver
5 * Based upon the ID registers, this PHY appears to be a mixture of IPs
6 * from two different companies.
8 * There appears to be several different data paths through the PHY which
9 * are automatically managed by the PHY. The following has been determined
10 * via observation and experimentation for a setup using single-lane Serdes:
12 * SGMII PHYXS -- BASE-T PCS -- 10G PMA -- AN -- Copper (for <= 1G)
13 * 10GBASE-KR PHYXS -- BASE-T PCS -- 10G PMA -- AN -- Copper (for 10G)
14 * 10GBASE-KR PHYXS -- BASE-R PCS -- Fiber
16 * With XAUI, observation shows:
18 * XAUI PHYXS -- <appropriate PCS as above>
20 * and no switching of the host interface mode occurs.
22 * If both the fiber and copper ports are connected, the first to gain
23 * link takes priority and the other port is completely locked out.
25 #include <linux/ctype.h>
26 #include <linux/delay.h>
27 #include <linux/hwmon.h>
28 #include <linux/marvell_phy.h>
29 #include <linux/phy.h>
30 #include <linux/sfp.h>
32 #define MV_PHY_ALASKA_NBT_QUIRK_MASK 0xfffffffe
33 #define MV_PHY_ALASKA_NBT_QUIRK_REV (MARVELL_PHY_ID_88X3310 | 0xa)
36 MV_PMA_FW_VER0 = 0xc011,
37 MV_PMA_FW_VER1 = 0xc012,
39 MV_PMA_BOOT_FATAL = BIT(0),
41 MV_PCS_BASE_T = 0x0000,
42 MV_PCS_BASE_R = 0x1000,
43 MV_PCS_1000BASEX = 0x2000,
45 MV_PCS_CSCR1 = 0x8000,
46 MV_PCS_CSCR1_ED_MASK = 0x0300,
47 MV_PCS_CSCR1_ED_OFF = 0x0000,
48 MV_PCS_CSCR1_ED_RX = 0x0200,
49 MV_PCS_CSCR1_ED_NLP = 0x0300,
50 MV_PCS_CSCR1_MDIX_MASK = 0x0060,
51 MV_PCS_CSCR1_MDIX_MDI = 0x0000,
52 MV_PCS_CSCR1_MDIX_MDIX = 0x0020,
53 MV_PCS_CSCR1_MDIX_AUTO = 0x0060,
55 MV_PCS_CSSR1 = 0x8008,
56 MV_PCS_CSSR1_SPD1_MASK = 0xc000,
57 MV_PCS_CSSR1_SPD1_SPD2 = 0xc000,
58 MV_PCS_CSSR1_SPD1_1000 = 0x8000,
59 MV_PCS_CSSR1_SPD1_100 = 0x4000,
60 MV_PCS_CSSR1_SPD1_10 = 0x0000,
61 MV_PCS_CSSR1_DUPLEX_FULL= BIT(13),
62 MV_PCS_CSSR1_RESOLVED = BIT(11),
63 MV_PCS_CSSR1_MDIX = BIT(6),
64 MV_PCS_CSSR1_SPD2_MASK = 0x000c,
65 MV_PCS_CSSR1_SPD2_5000 = 0x0008,
66 MV_PCS_CSSR1_SPD2_2500 = 0x0004,
67 MV_PCS_CSSR1_SPD2_10000 = 0x0000,
69 /* Temperature read register (88E2110 only) */
72 /* These registers appear at 0x800X and 0xa00X - the 0xa00X control
73 * registers appear to set themselves to the 0x800X when AN is
74 * restarted, but status registers appear readable from either.
76 MV_AN_CTRL1000 = 0x8000, /* 1000base-T control register */
77 MV_AN_STAT1000 = 0x8001, /* 1000base-T status register */
79 /* Vendor2 MMD registers */
80 MV_V2_PORT_CTRL = 0xf001,
81 MV_V2_PORT_CTRL_SWRST = BIT(15),
82 MV_V2_PORT_CTRL_PWRDOWN = BIT(11),
83 /* Temperature control/read registers (88X3310 only) */
84 MV_V2_TEMP_CTRL = 0xf08a,
85 MV_V2_TEMP_CTRL_MASK = 0xc000,
86 MV_V2_TEMP_CTRL_SAMPLE = 0x0000,
87 MV_V2_TEMP_CTRL_DISABLE = 0xc000,
89 MV_V2_TEMP_UNKNOWN = 0x9600, /* unknown function */
95 struct device *hwmon_dev;
100 static umode_t mv3310_hwmon_is_visible(const void *data,
101 enum hwmon_sensor_types type,
102 u32 attr, int channel)
104 if (type == hwmon_chip && attr == hwmon_chip_update_interval)
106 if (type == hwmon_temp && attr == hwmon_temp_input)
111 static int mv3310_hwmon_read_temp_reg(struct phy_device *phydev)
113 return phy_read_mmd(phydev, MDIO_MMD_VEND2, MV_V2_TEMP);
116 static int mv2110_hwmon_read_temp_reg(struct phy_device *phydev)
118 return phy_read_mmd(phydev, MDIO_MMD_PCS, MV_PCS_TEMP);
121 static int mv10g_hwmon_read_temp_reg(struct phy_device *phydev)
123 if (phydev->drv->phy_id == MARVELL_PHY_ID_88X3310)
124 return mv3310_hwmon_read_temp_reg(phydev);
125 else /* MARVELL_PHY_ID_88E2110 */
126 return mv2110_hwmon_read_temp_reg(phydev);
129 static int mv3310_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
130 u32 attr, int channel, long *value)
132 struct phy_device *phydev = dev_get_drvdata(dev);
135 if (type == hwmon_chip && attr == hwmon_chip_update_interval) {
136 *value = MSEC_PER_SEC;
140 if (type == hwmon_temp && attr == hwmon_temp_input) {
141 temp = mv10g_hwmon_read_temp_reg(phydev);
145 *value = ((temp & 0xff) - 75) * 1000;
153 static const struct hwmon_ops mv3310_hwmon_ops = {
154 .is_visible = mv3310_hwmon_is_visible,
155 .read = mv3310_hwmon_read,
158 static u32 mv3310_hwmon_chip_config[] = {
159 HWMON_C_REGISTER_TZ | HWMON_C_UPDATE_INTERVAL,
163 static const struct hwmon_channel_info mv3310_hwmon_chip = {
165 .config = mv3310_hwmon_chip_config,
168 static u32 mv3310_hwmon_temp_config[] = {
173 static const struct hwmon_channel_info mv3310_hwmon_temp = {
175 .config = mv3310_hwmon_temp_config,
178 static const struct hwmon_channel_info *mv3310_hwmon_info[] = {
184 static const struct hwmon_chip_info mv3310_hwmon_chip_info = {
185 .ops = &mv3310_hwmon_ops,
186 .info = mv3310_hwmon_info,
189 static int mv3310_hwmon_config(struct phy_device *phydev, bool enable)
194 if (phydev->drv->phy_id != MARVELL_PHY_ID_88X3310)
197 ret = phy_write_mmd(phydev, MDIO_MMD_VEND2, MV_V2_TEMP,
202 val = enable ? MV_V2_TEMP_CTRL_SAMPLE : MV_V2_TEMP_CTRL_DISABLE;
204 return phy_modify_mmd(phydev, MDIO_MMD_VEND2, MV_V2_TEMP_CTRL,
205 MV_V2_TEMP_CTRL_MASK, val);
208 static void mv3310_hwmon_disable(void *data)
210 struct phy_device *phydev = data;
212 mv3310_hwmon_config(phydev, false);
215 static int mv3310_hwmon_probe(struct phy_device *phydev)
217 struct device *dev = &phydev->mdio.dev;
218 struct mv3310_priv *priv = dev_get_drvdata(&phydev->mdio.dev);
221 priv->hwmon_name = devm_kstrdup(dev, dev_name(dev), GFP_KERNEL);
222 if (!priv->hwmon_name)
225 for (i = j = 0; priv->hwmon_name[i]; i++) {
226 if (isalnum(priv->hwmon_name[i])) {
228 priv->hwmon_name[j] = priv->hwmon_name[i];
232 priv->hwmon_name[j] = '\0';
234 ret = mv3310_hwmon_config(phydev, true);
238 ret = devm_add_action_or_reset(dev, mv3310_hwmon_disable, phydev);
242 priv->hwmon_dev = devm_hwmon_device_register_with_info(dev,
243 priv->hwmon_name, phydev,
244 &mv3310_hwmon_chip_info, NULL);
246 return PTR_ERR_OR_ZERO(priv->hwmon_dev);
249 static inline int mv3310_hwmon_config(struct phy_device *phydev, bool enable)
254 static int mv3310_hwmon_probe(struct phy_device *phydev)
260 static int mv3310_power_down(struct phy_device *phydev)
262 return phy_set_bits_mmd(phydev, MDIO_MMD_VEND2, MV_V2_PORT_CTRL,
263 MV_V2_PORT_CTRL_PWRDOWN);
266 static int mv3310_power_up(struct phy_device *phydev)
268 struct mv3310_priv *priv = dev_get_drvdata(&phydev->mdio.dev);
271 ret = phy_clear_bits_mmd(phydev, MDIO_MMD_VEND2, MV_V2_PORT_CTRL,
272 MV_V2_PORT_CTRL_PWRDOWN);
274 if (phydev->drv->phy_id != MARVELL_PHY_ID_88X3310 ||
275 priv->firmware_ver < 0x00030000)
278 return phy_set_bits_mmd(phydev, MDIO_MMD_VEND2, MV_V2_PORT_CTRL,
279 MV_V2_PORT_CTRL_SWRST);
282 static int mv3310_reset(struct phy_device *phydev, u32 unit)
286 err = phy_modify_mmd(phydev, MDIO_MMD_PCS, unit + MDIO_CTRL1,
287 MDIO_CTRL1_RESET, MDIO_CTRL1_RESET);
291 return phy_read_mmd_poll_timeout(phydev, MDIO_MMD_PCS,
292 unit + MDIO_CTRL1, val,
293 !(val & MDIO_CTRL1_RESET),
297 static int mv3310_get_edpd(struct phy_device *phydev, u16 *edpd)
301 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MV_PCS_CSCR1);
305 switch (val & MV_PCS_CSCR1_ED_MASK) {
306 case MV_PCS_CSCR1_ED_NLP:
309 case MV_PCS_CSCR1_ED_RX:
310 *edpd = ETHTOOL_PHY_EDPD_NO_TX;
313 *edpd = ETHTOOL_PHY_EDPD_DISABLE;
319 static int mv3310_set_edpd(struct phy_device *phydev, u16 edpd)
326 case ETHTOOL_PHY_EDPD_DFLT_TX_MSECS:
327 val = MV_PCS_CSCR1_ED_NLP;
330 case ETHTOOL_PHY_EDPD_NO_TX:
331 val = MV_PCS_CSCR1_ED_RX;
334 case ETHTOOL_PHY_EDPD_DISABLE:
335 val = MV_PCS_CSCR1_ED_OFF;
342 err = phy_modify_mmd_changed(phydev, MDIO_MMD_PCS, MV_PCS_CSCR1,
343 MV_PCS_CSCR1_ED_MASK, val);
345 err = mv3310_reset(phydev, MV_PCS_BASE_T);
350 static int mv3310_sfp_insert(void *upstream, const struct sfp_eeprom_id *id)
352 struct phy_device *phydev = upstream;
353 __ETHTOOL_DECLARE_LINK_MODE_MASK(support) = { 0, };
354 phy_interface_t iface;
356 sfp_parse_support(phydev->sfp_bus, id, support);
357 iface = sfp_select_interface(phydev->sfp_bus, support);
359 if (iface != PHY_INTERFACE_MODE_10GBASER) {
360 dev_err(&phydev->mdio.dev, "incompatible SFP module inserted\n");
366 static const struct sfp_upstream_ops mv3310_sfp_ops = {
367 .attach = phy_sfp_attach,
368 .detach = phy_sfp_detach,
369 .module_insert = mv3310_sfp_insert,
372 static int mv3310_probe(struct phy_device *phydev)
374 struct mv3310_priv *priv;
375 u32 mmd_mask = MDIO_DEVS_PMAPMD | MDIO_DEVS_AN;
378 if (!phydev->is_c45 ||
379 (phydev->c45_ids.devices_in_package & mmd_mask) != mmd_mask)
382 ret = phy_read_mmd(phydev, MDIO_MMD_PMAPMD, MV_PMA_BOOT);
386 if (ret & MV_PMA_BOOT_FATAL) {
387 dev_warn(&phydev->mdio.dev,
388 "PHY failed to boot firmware, status=%04x\n", ret);
392 priv = devm_kzalloc(&phydev->mdio.dev, sizeof(*priv), GFP_KERNEL);
396 dev_set_drvdata(&phydev->mdio.dev, priv);
398 ret = phy_read_mmd(phydev, MDIO_MMD_PMAPMD, MV_PMA_FW_VER0);
402 priv->firmware_ver = ret << 16;
404 ret = phy_read_mmd(phydev, MDIO_MMD_PMAPMD, MV_PMA_FW_VER1);
408 priv->firmware_ver |= ret;
410 phydev_info(phydev, "Firmware version %u.%u.%u.%u\n",
411 priv->firmware_ver >> 24, (priv->firmware_ver >> 16) & 255,
412 (priv->firmware_ver >> 8) & 255, priv->firmware_ver & 255);
414 /* Powering down the port when not in use saves about 600mW */
415 ret = mv3310_power_down(phydev);
419 ret = mv3310_hwmon_probe(phydev);
423 return phy_sfp_probe(phydev, &mv3310_sfp_ops);
426 static int mv3310_suspend(struct phy_device *phydev)
428 return mv3310_power_down(phydev);
431 static int mv3310_resume(struct phy_device *phydev)
435 ret = mv3310_power_up(phydev);
439 return mv3310_hwmon_config(phydev, true);
442 /* Some PHYs in the Alaska family such as the 88X3310 and the 88E2010
443 * don't set bit 14 in PMA Extended Abilities (1.11), although they do
444 * support 2.5GBASET and 5GBASET. For these models, we can still read their
445 * 2.5G/5G extended abilities register (1.21). We detect these models based on
446 * the PMA device identifier, with a mask matching models known to have this
449 static bool mv3310_has_pma_ngbaset_quirk(struct phy_device *phydev)
451 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_PMAPMD))
454 /* Only some revisions of the 88X3310 family PMA seem to be impacted */
455 return (phydev->c45_ids.device_ids[MDIO_MMD_PMAPMD] &
456 MV_PHY_ALASKA_NBT_QUIRK_MASK) == MV_PHY_ALASKA_NBT_QUIRK_REV;
459 static int mv3310_config_init(struct phy_device *phydev)
463 /* Check that the PHY interface type is compatible */
464 if (phydev->interface != PHY_INTERFACE_MODE_SGMII &&
465 phydev->interface != PHY_INTERFACE_MODE_2500BASEX &&
466 phydev->interface != PHY_INTERFACE_MODE_XAUI &&
467 phydev->interface != PHY_INTERFACE_MODE_RXAUI &&
468 phydev->interface != PHY_INTERFACE_MODE_10GBASER)
471 phydev->mdix_ctrl = ETH_TP_MDI_AUTO;
473 /* Power up so reset works */
474 err = mv3310_power_up(phydev);
478 /* Enable EDPD mode - saving 600mW */
479 return mv3310_set_edpd(phydev, ETHTOOL_PHY_EDPD_DFLT_TX_MSECS);
482 static int mv3310_get_features(struct phy_device *phydev)
486 ret = genphy_c45_pma_read_abilities(phydev);
490 if (mv3310_has_pma_ngbaset_quirk(phydev)) {
491 val = phy_read_mmd(phydev, MDIO_MMD_PMAPMD,
492 MDIO_PMA_NG_EXTABLE);
496 linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
498 val & MDIO_PMA_NG_EXTABLE_2_5GBT);
500 linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
502 val & MDIO_PMA_NG_EXTABLE_5GBT);
508 static int mv3310_config_mdix(struct phy_device *phydev)
513 switch (phydev->mdix_ctrl) {
514 case ETH_TP_MDI_AUTO:
515 val = MV_PCS_CSCR1_MDIX_AUTO;
518 val = MV_PCS_CSCR1_MDIX_MDIX;
521 val = MV_PCS_CSCR1_MDIX_MDI;
527 err = phy_modify_mmd_changed(phydev, MDIO_MMD_PCS, MV_PCS_CSCR1,
528 MV_PCS_CSCR1_MDIX_MASK, val);
530 err = mv3310_reset(phydev, MV_PCS_BASE_T);
535 static int mv3310_config_aneg(struct phy_device *phydev)
537 bool changed = false;
541 ret = mv3310_config_mdix(phydev);
545 if (phydev->autoneg == AUTONEG_DISABLE)
546 return genphy_c45_pma_setup_forced(phydev);
548 ret = genphy_c45_an_config_aneg(phydev);
554 /* Clause 45 has no standardized support for 1000BaseT, therefore
555 * use vendor registers for this mode.
557 reg = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
558 ret = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MV_AN_CTRL1000,
559 ADVERTISE_1000FULL | ADVERTISE_1000HALF, reg);
565 return genphy_c45_check_and_restart_aneg(phydev, changed);
568 static int mv3310_aneg_done(struct phy_device *phydev)
572 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MV_PCS_BASE_R + MDIO_STAT1);
576 if (val & MDIO_STAT1_LSTATUS)
579 return genphy_c45_aneg_done(phydev);
582 static void mv3310_update_interface(struct phy_device *phydev)
584 if ((phydev->interface == PHY_INTERFACE_MODE_SGMII ||
585 phydev->interface == PHY_INTERFACE_MODE_2500BASEX ||
586 phydev->interface == PHY_INTERFACE_MODE_10GBASER) &&
588 /* The PHY automatically switches its serdes interface (and
589 * active PHYXS instance) between Cisco SGMII, 10GBase-R and
590 * 2500BaseX modes according to the speed. Florian suggests
591 * setting phydev->interface to communicate this to the MAC.
592 * Only do this if we are already in one of the above modes.
594 switch (phydev->speed) {
596 phydev->interface = PHY_INTERFACE_MODE_10GBASER;
599 phydev->interface = PHY_INTERFACE_MODE_2500BASEX;
604 phydev->interface = PHY_INTERFACE_MODE_SGMII;
612 /* 10GBASE-ER,LR,LRM,SR do not support autonegotiation. */
613 static int mv3310_read_status_10gbaser(struct phy_device *phydev)
616 phydev->speed = SPEED_10000;
617 phydev->duplex = DUPLEX_FULL;
622 static int mv3310_read_status_copper(struct phy_device *phydev)
624 int cssr1, speed, val;
626 val = genphy_c45_read_link(phydev);
630 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_STAT1);
634 cssr1 = phy_read_mmd(phydev, MDIO_MMD_PCS, MV_PCS_CSSR1);
638 /* If the link settings are not resolved, mark the link down */
639 if (!(cssr1 & MV_PCS_CSSR1_RESOLVED)) {
644 /* Read the copper link settings */
645 speed = cssr1 & MV_PCS_CSSR1_SPD1_MASK;
646 if (speed == MV_PCS_CSSR1_SPD1_SPD2)
647 speed |= cssr1 & MV_PCS_CSSR1_SPD2_MASK;
650 case MV_PCS_CSSR1_SPD1_SPD2 | MV_PCS_CSSR1_SPD2_10000:
651 phydev->speed = SPEED_10000;
654 case MV_PCS_CSSR1_SPD1_SPD2 | MV_PCS_CSSR1_SPD2_5000:
655 phydev->speed = SPEED_5000;
658 case MV_PCS_CSSR1_SPD1_SPD2 | MV_PCS_CSSR1_SPD2_2500:
659 phydev->speed = SPEED_2500;
662 case MV_PCS_CSSR1_SPD1_1000:
663 phydev->speed = SPEED_1000;
666 case MV_PCS_CSSR1_SPD1_100:
667 phydev->speed = SPEED_100;
670 case MV_PCS_CSSR1_SPD1_10:
671 phydev->speed = SPEED_10;
675 phydev->duplex = cssr1 & MV_PCS_CSSR1_DUPLEX_FULL ?
676 DUPLEX_FULL : DUPLEX_HALF;
677 phydev->mdix = cssr1 & MV_PCS_CSSR1_MDIX ?
678 ETH_TP_MDI_X : ETH_TP_MDI;
680 if (val & MDIO_AN_STAT1_COMPLETE) {
681 val = genphy_c45_read_lpa(phydev);
685 /* Read the link partner's 1G advertisement */
686 val = phy_read_mmd(phydev, MDIO_MMD_AN, MV_AN_STAT1000);
690 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising, val);
692 /* Update the pause status */
693 phy_resolve_aneg_pause(phydev);
699 static int mv3310_read_status(struct phy_device *phydev)
703 phydev->speed = SPEED_UNKNOWN;
704 phydev->duplex = DUPLEX_UNKNOWN;
705 linkmode_zero(phydev->lp_advertising);
708 phydev->asym_pause = 0;
709 phydev->mdix = ETH_TP_MDI_INVALID;
711 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MV_PCS_BASE_R + MDIO_STAT1);
715 if (val & MDIO_STAT1_LSTATUS)
716 err = mv3310_read_status_10gbaser(phydev);
718 err = mv3310_read_status_copper(phydev);
723 mv3310_update_interface(phydev);
728 static int mv3310_get_tunable(struct phy_device *phydev,
729 struct ethtool_tunable *tuna, void *data)
732 case ETHTOOL_PHY_EDPD:
733 return mv3310_get_edpd(phydev, data);
739 static int mv3310_set_tunable(struct phy_device *phydev,
740 struct ethtool_tunable *tuna, const void *data)
743 case ETHTOOL_PHY_EDPD:
744 return mv3310_set_edpd(phydev, *(u16 *)data);
750 static struct phy_driver mv3310_drivers[] = {
752 .phy_id = MARVELL_PHY_ID_88X3310,
753 .phy_id_mask = MARVELL_PHY_ID_MASK,
755 .get_features = mv3310_get_features,
756 .soft_reset = genphy_no_soft_reset,
757 .config_init = mv3310_config_init,
758 .probe = mv3310_probe,
759 .suspend = mv3310_suspend,
760 .resume = mv3310_resume,
761 .config_aneg = mv3310_config_aneg,
762 .aneg_done = mv3310_aneg_done,
763 .read_status = mv3310_read_status,
764 .get_tunable = mv3310_get_tunable,
765 .set_tunable = mv3310_set_tunable,
768 .phy_id = MARVELL_PHY_ID_88E2110,
769 .phy_id_mask = MARVELL_PHY_ID_MASK,
771 .probe = mv3310_probe,
772 .suspend = mv3310_suspend,
773 .resume = mv3310_resume,
774 .soft_reset = genphy_no_soft_reset,
775 .config_init = mv3310_config_init,
776 .config_aneg = mv3310_config_aneg,
777 .aneg_done = mv3310_aneg_done,
778 .read_status = mv3310_read_status,
779 .get_tunable = mv3310_get_tunable,
780 .set_tunable = mv3310_set_tunable,
784 module_phy_driver(mv3310_drivers);
786 static struct mdio_device_id __maybe_unused mv3310_tbl[] = {
787 { MARVELL_PHY_ID_88X3310, MARVELL_PHY_ID_MASK },
788 { MARVELL_PHY_ID_88E2110, MARVELL_PHY_ID_MASK },
791 MODULE_DEVICE_TABLE(mdio, mv3310_tbl);
792 MODULE_DESCRIPTION("Marvell Alaska X 10Gigabit Ethernet PHY driver (MV88X3310)");
793 MODULE_LICENSE("GPL");