1 // SPDX-License-Identifier: GPL-2.0+
3 * drivers/net/phy/micrel.c
5 * Driver for Micrel PHYs
7 * Author: David J. Choi
9 * Copyright (c) 2010-2013 Micrel, Inc.
12 * Support : Micrel Phys:
13 * Giga phys: ksz9021, ksz9031, ksz9131
14 * 100/10 Phys : ksz8001, ksz8721, ksz8737, ksz8041
15 * ksz8021, ksz8031, ksz8051,
18 * Switch : ksz8873, ksz886x
22 #include <linux/bitfield.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/phy.h>
26 #include <linux/micrel_phy.h>
28 #include <linux/clk.h>
29 #include <linux/delay.h>
31 /* Operation Mode Strap Override */
32 #define MII_KSZPHY_OMSO 0x16
33 #define KSZPHY_OMSO_FACTORY_TEST BIT(15)
34 #define KSZPHY_OMSO_B_CAST_OFF BIT(9)
35 #define KSZPHY_OMSO_NAND_TREE_ON BIT(5)
36 #define KSZPHY_OMSO_RMII_OVERRIDE BIT(1)
37 #define KSZPHY_OMSO_MII_OVERRIDE BIT(0)
39 /* general Interrupt control/status reg in vendor specific block. */
40 #define MII_KSZPHY_INTCS 0x1B
41 #define KSZPHY_INTCS_JABBER BIT(15)
42 #define KSZPHY_INTCS_RECEIVE_ERR BIT(14)
43 #define KSZPHY_INTCS_PAGE_RECEIVE BIT(13)
44 #define KSZPHY_INTCS_PARELLEL BIT(12)
45 #define KSZPHY_INTCS_LINK_PARTNER_ACK BIT(11)
46 #define KSZPHY_INTCS_LINK_DOWN BIT(10)
47 #define KSZPHY_INTCS_REMOTE_FAULT BIT(9)
48 #define KSZPHY_INTCS_LINK_UP BIT(8)
49 #define KSZPHY_INTCS_ALL (KSZPHY_INTCS_LINK_UP |\
50 KSZPHY_INTCS_LINK_DOWN)
53 #define MII_KSZPHY_CTRL_1 0x1e
55 /* PHY Control 2 / PHY Control (if no PHY Control 1) */
56 #define MII_KSZPHY_CTRL_2 0x1f
57 #define MII_KSZPHY_CTRL MII_KSZPHY_CTRL_2
58 /* bitmap of PHY register to set interrupt mode */
59 #define KSZPHY_CTRL_INT_ACTIVE_HIGH BIT(9)
60 #define KSZPHY_RMII_REF_CLK_SEL BIT(7)
62 /* Write/read to/from extended registers */
63 #define MII_KSZPHY_EXTREG 0x0b
64 #define KSZPHY_EXTREG_WRITE 0x8000
66 #define MII_KSZPHY_EXTREG_WRITE 0x0c
67 #define MII_KSZPHY_EXTREG_READ 0x0d
69 /* Extended registers */
70 #define MII_KSZPHY_CLK_CONTROL_PAD_SKEW 0x104
71 #define MII_KSZPHY_RX_DATA_PAD_SKEW 0x105
72 #define MII_KSZPHY_TX_DATA_PAD_SKEW 0x106
76 struct kszphy_hw_stat {
82 static struct kszphy_hw_stat kszphy_hw_stats[] = {
83 { "phy_receive_errors", 21, 16},
84 { "phy_idle_errors", 10, 8 },
89 u16 interrupt_level_mask;
90 bool has_broadcast_disable;
91 bool has_nand_tree_disable;
92 bool has_rmii_ref_clk_sel;
96 const struct kszphy_type *type;
98 bool rmii_ref_clk_sel;
99 bool rmii_ref_clk_sel_val;
100 u64 stats[ARRAY_SIZE(kszphy_hw_stats)];
103 static const struct kszphy_type ksz8021_type = {
104 .led_mode_reg = MII_KSZPHY_CTRL_2,
105 .has_broadcast_disable = true,
106 .has_nand_tree_disable = true,
107 .has_rmii_ref_clk_sel = true,
110 static const struct kszphy_type ksz8041_type = {
111 .led_mode_reg = MII_KSZPHY_CTRL_1,
114 static const struct kszphy_type ksz8051_type = {
115 .led_mode_reg = MII_KSZPHY_CTRL_2,
116 .has_nand_tree_disable = true,
119 static const struct kszphy_type ksz8081_type = {
120 .led_mode_reg = MII_KSZPHY_CTRL_2,
121 .has_broadcast_disable = true,
122 .has_nand_tree_disable = true,
123 .has_rmii_ref_clk_sel = true,
126 static const struct kszphy_type ks8737_type = {
127 .interrupt_level_mask = BIT(14),
130 static const struct kszphy_type ksz9021_type = {
131 .interrupt_level_mask = BIT(14),
134 static int kszphy_extended_write(struct phy_device *phydev,
137 phy_write(phydev, MII_KSZPHY_EXTREG, KSZPHY_EXTREG_WRITE | regnum);
138 return phy_write(phydev, MII_KSZPHY_EXTREG_WRITE, val);
141 static int kszphy_extended_read(struct phy_device *phydev,
144 phy_write(phydev, MII_KSZPHY_EXTREG, regnum);
145 return phy_read(phydev, MII_KSZPHY_EXTREG_READ);
148 static int kszphy_ack_interrupt(struct phy_device *phydev)
150 /* bit[7..0] int status, which is a read and clear register. */
153 rc = phy_read(phydev, MII_KSZPHY_INTCS);
155 return (rc < 0) ? rc : 0;
158 static int kszphy_config_intr(struct phy_device *phydev)
160 const struct kszphy_type *type = phydev->drv->driver_data;
164 if (type && type->interrupt_level_mask)
165 mask = type->interrupt_level_mask;
167 mask = KSZPHY_CTRL_INT_ACTIVE_HIGH;
169 /* set the interrupt pin active low */
170 temp = phy_read(phydev, MII_KSZPHY_CTRL);
174 phy_write(phydev, MII_KSZPHY_CTRL, temp);
176 /* enable / disable interrupts */
177 if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
178 temp = KSZPHY_INTCS_ALL;
182 return phy_write(phydev, MII_KSZPHY_INTCS, temp);
185 static int kszphy_rmii_clk_sel(struct phy_device *phydev, bool val)
189 ctrl = phy_read(phydev, MII_KSZPHY_CTRL);
194 ctrl |= KSZPHY_RMII_REF_CLK_SEL;
196 ctrl &= ~KSZPHY_RMII_REF_CLK_SEL;
198 return phy_write(phydev, MII_KSZPHY_CTRL, ctrl);
201 static int kszphy_setup_led(struct phy_device *phydev, u32 reg, int val)
206 case MII_KSZPHY_CTRL_1:
209 case MII_KSZPHY_CTRL_2:
216 temp = phy_read(phydev, reg);
222 temp &= ~(3 << shift);
223 temp |= val << shift;
224 rc = phy_write(phydev, reg, temp);
227 phydev_err(phydev, "failed to set led mode\n");
232 /* Disable PHY address 0 as the broadcast address, so that it can be used as a
233 * unique (non-broadcast) address on a shared bus.
235 static int kszphy_broadcast_disable(struct phy_device *phydev)
239 ret = phy_read(phydev, MII_KSZPHY_OMSO);
243 ret = phy_write(phydev, MII_KSZPHY_OMSO, ret | KSZPHY_OMSO_B_CAST_OFF);
246 phydev_err(phydev, "failed to disable broadcast address\n");
251 static int kszphy_nand_tree_disable(struct phy_device *phydev)
255 ret = phy_read(phydev, MII_KSZPHY_OMSO);
259 if (!(ret & KSZPHY_OMSO_NAND_TREE_ON))
262 ret = phy_write(phydev, MII_KSZPHY_OMSO,
263 ret & ~KSZPHY_OMSO_NAND_TREE_ON);
266 phydev_err(phydev, "failed to disable NAND tree mode\n");
271 /* Some config bits need to be set again on resume, handle them here. */
272 static int kszphy_config_reset(struct phy_device *phydev)
274 struct kszphy_priv *priv = phydev->priv;
277 if (priv->rmii_ref_clk_sel) {
278 ret = kszphy_rmii_clk_sel(phydev, priv->rmii_ref_clk_sel_val);
281 "failed to set rmii reference clock\n");
286 if (priv->led_mode >= 0)
287 kszphy_setup_led(phydev, priv->type->led_mode_reg, priv->led_mode);
292 static int kszphy_config_init(struct phy_device *phydev)
294 struct kszphy_priv *priv = phydev->priv;
295 const struct kszphy_type *type;
302 if (type->has_broadcast_disable)
303 kszphy_broadcast_disable(phydev);
305 if (type->has_nand_tree_disable)
306 kszphy_nand_tree_disable(phydev);
308 return kszphy_config_reset(phydev);
311 static int ksz8041_config_init(struct phy_device *phydev)
313 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
315 struct device_node *of_node = phydev->mdio.dev.of_node;
317 /* Limit supported and advertised modes in fiber mode */
318 if (of_property_read_bool(of_node, "micrel,fiber-mode")) {
319 phydev->dev_flags |= MICREL_PHY_FXEN;
320 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, mask);
321 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, mask);
323 linkmode_and(phydev->supported, phydev->supported, mask);
324 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
326 linkmode_and(phydev->advertising, phydev->advertising, mask);
327 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
328 phydev->advertising);
329 phydev->autoneg = AUTONEG_DISABLE;
332 return kszphy_config_init(phydev);
335 static int ksz8041_config_aneg(struct phy_device *phydev)
337 /* Skip auto-negotiation in fiber mode */
338 if (phydev->dev_flags & MICREL_PHY_FXEN) {
339 phydev->speed = SPEED_100;
343 return genphy_config_aneg(phydev);
346 static int ksz8051_ksz8795_match_phy_device(struct phy_device *phydev,
347 const u32 ksz_phy_id)
351 if ((phydev->phy_id & MICREL_PHY_ID_MASK) != ksz_phy_id)
354 ret = phy_read(phydev, MII_BMSR);
358 /* KSZ8051 PHY and KSZ8794/KSZ8795/KSZ8765 switch share the same
359 * exact PHY ID. However, they can be told apart by the extended
360 * capability registers presence. The KSZ8051 PHY has them while
361 * the switch does not.
364 if (ksz_phy_id == PHY_ID_KSZ8051)
370 static int ksz8051_match_phy_device(struct phy_device *phydev)
372 return ksz8051_ksz8795_match_phy_device(phydev, PHY_ID_KSZ8051);
375 static int ksz8081_config_init(struct phy_device *phydev)
377 /* KSZPHY_OMSO_FACTORY_TEST is set at de-assertion of the reset line
378 * based on the RXER (KSZ8081RNA/RND) or TXC (KSZ8081MNX/RNB) pin. If a
379 * pull-down is missing, the factory test mode should be cleared by
380 * manually writing a 0.
382 phy_clear_bits(phydev, MII_KSZPHY_OMSO, KSZPHY_OMSO_FACTORY_TEST);
384 return kszphy_config_init(phydev);
387 static int ksz8061_config_init(struct phy_device *phydev)
391 ret = phy_write_mmd(phydev, MDIO_MMD_PMAPMD, MDIO_DEVID1, 0xB61A);
395 return kszphy_config_init(phydev);
398 static int ksz8795_match_phy_device(struct phy_device *phydev)
400 return ksz8051_ksz8795_match_phy_device(phydev, PHY_ID_KSZ87XX);
403 static int ksz9021_load_values_from_of(struct phy_device *phydev,
404 const struct device_node *of_node,
406 const char *field1, const char *field2,
407 const char *field3, const char *field4)
416 if (!of_property_read_u32(of_node, field1, &val1))
419 if (!of_property_read_u32(of_node, field2, &val2))
422 if (!of_property_read_u32(of_node, field3, &val3))
425 if (!of_property_read_u32(of_node, field4, &val4))
432 newval = kszphy_extended_read(phydev, reg);
437 newval = ((newval & 0xfff0) | ((val1 / PS_TO_REG) & 0xf) << 0);
440 newval = ((newval & 0xff0f) | ((val2 / PS_TO_REG) & 0xf) << 4);
443 newval = ((newval & 0xf0ff) | ((val3 / PS_TO_REG) & 0xf) << 8);
446 newval = ((newval & 0x0fff) | ((val4 / PS_TO_REG) & 0xf) << 12);
448 return kszphy_extended_write(phydev, reg, newval);
451 static int ksz9021_config_init(struct phy_device *phydev)
453 const struct device *dev = &phydev->mdio.dev;
454 const struct device_node *of_node = dev->of_node;
455 const struct device *dev_walker;
457 /* The Micrel driver has a deprecated option to place phy OF
458 * properties in the MAC node. Walk up the tree of devices to
459 * find a device with an OF node.
461 dev_walker = &phydev->mdio.dev;
463 of_node = dev_walker->of_node;
464 dev_walker = dev_walker->parent;
466 } while (!of_node && dev_walker);
469 ksz9021_load_values_from_of(phydev, of_node,
470 MII_KSZPHY_CLK_CONTROL_PAD_SKEW,
471 "txen-skew-ps", "txc-skew-ps",
472 "rxdv-skew-ps", "rxc-skew-ps");
473 ksz9021_load_values_from_of(phydev, of_node,
474 MII_KSZPHY_RX_DATA_PAD_SKEW,
475 "rxd0-skew-ps", "rxd1-skew-ps",
476 "rxd2-skew-ps", "rxd3-skew-ps");
477 ksz9021_load_values_from_of(phydev, of_node,
478 MII_KSZPHY_TX_DATA_PAD_SKEW,
479 "txd0-skew-ps", "txd1-skew-ps",
480 "txd2-skew-ps", "txd3-skew-ps");
485 #define KSZ9031_PS_TO_REG 60
487 /* Extended registers */
488 /* MMD Address 0x0 */
489 #define MII_KSZ9031RN_FLP_BURST_TX_LO 3
490 #define MII_KSZ9031RN_FLP_BURST_TX_HI 4
492 /* MMD Address 0x2 */
493 #define MII_KSZ9031RN_CONTROL_PAD_SKEW 4
494 #define MII_KSZ9031RN_RX_CTL_M GENMASK(7, 4)
495 #define MII_KSZ9031RN_TX_CTL_M GENMASK(3, 0)
497 #define MII_KSZ9031RN_RX_DATA_PAD_SKEW 5
498 #define MII_KSZ9031RN_RXD3 GENMASK(15, 12)
499 #define MII_KSZ9031RN_RXD2 GENMASK(11, 8)
500 #define MII_KSZ9031RN_RXD1 GENMASK(7, 4)
501 #define MII_KSZ9031RN_RXD0 GENMASK(3, 0)
503 #define MII_KSZ9031RN_TX_DATA_PAD_SKEW 6
504 #define MII_KSZ9031RN_TXD3 GENMASK(15, 12)
505 #define MII_KSZ9031RN_TXD2 GENMASK(11, 8)
506 #define MII_KSZ9031RN_TXD1 GENMASK(7, 4)
507 #define MII_KSZ9031RN_TXD0 GENMASK(3, 0)
509 #define MII_KSZ9031RN_CLK_PAD_SKEW 8
510 #define MII_KSZ9031RN_GTX_CLK GENMASK(9, 5)
511 #define MII_KSZ9031RN_RX_CLK GENMASK(4, 0)
513 /* KSZ9031 has internal RGMII_IDRX = 1.2ns and RGMII_IDTX = 0ns. To
514 * provide different RGMII options we need to configure delay offset
515 * for each pad relative to build in delay.
517 /* keep rx as "No delay adjustment" and set rx_clk to +0.60ns to get delays of
521 #define RX_CLK_ID 0x19
523 /* set rx to +0.30ns and rx_clk to -0.90ns to compensate the
524 * internal 1.2ns delay.
527 #define RX_CLK_ND 0x0
529 /* set tx to -0.42ns and tx_clk to +0.96ns to get 1.38ns delay */
531 #define TX_CLK_ID 0x1f
533 /* set tx and tx_clk to "No delay adjustment" to keep 0ns
537 #define TX_CLK_ND 0xf
539 /* MMD Address 0x1C */
540 #define MII_KSZ9031RN_EDPD 0x23
541 #define MII_KSZ9031RN_EDPD_ENABLE BIT(0)
543 static int ksz9031_of_load_skew_values(struct phy_device *phydev,
544 const struct device_node *of_node,
545 u16 reg, size_t field_sz,
546 const char *field[], u8 numfields,
549 int val[4] = {-1, -2, -3, -4};
556 for (i = 0; i < numfields; i++)
557 if (!of_property_read_u32(of_node, field[i], val + i))
565 if (matches < numfields)
566 newval = phy_read_mmd(phydev, 2, reg);
570 maxval = (field_sz == 4) ? 0xf : 0x1f;
571 for (i = 0; i < numfields; i++)
572 if (val[i] != -(i + 1)) {
574 mask ^= maxval << (field_sz * i);
575 newval = (newval & mask) |
576 (((val[i] / KSZ9031_PS_TO_REG) & maxval)
580 return phy_write_mmd(phydev, 2, reg, newval);
583 /* Center KSZ9031RNX FLP timing at 16ms. */
584 static int ksz9031_center_flp_timing(struct phy_device *phydev)
588 result = phy_write_mmd(phydev, 0, MII_KSZ9031RN_FLP_BURST_TX_HI,
593 result = phy_write_mmd(phydev, 0, MII_KSZ9031RN_FLP_BURST_TX_LO,
598 return genphy_restart_aneg(phydev);
601 /* Enable energy-detect power-down mode */
602 static int ksz9031_enable_edpd(struct phy_device *phydev)
606 reg = phy_read_mmd(phydev, 0x1C, MII_KSZ9031RN_EDPD);
609 return phy_write_mmd(phydev, 0x1C, MII_KSZ9031RN_EDPD,
610 reg | MII_KSZ9031RN_EDPD_ENABLE);
613 static int ksz9031_config_rgmii_delay(struct phy_device *phydev)
615 u16 rx, tx, rx_clk, tx_clk;
618 switch (phydev->interface) {
619 case PHY_INTERFACE_MODE_RGMII:
625 case PHY_INTERFACE_MODE_RGMII_ID:
631 case PHY_INTERFACE_MODE_RGMII_RXID:
637 case PHY_INTERFACE_MODE_RGMII_TXID:
647 ret = phy_write_mmd(phydev, 2, MII_KSZ9031RN_CONTROL_PAD_SKEW,
648 FIELD_PREP(MII_KSZ9031RN_RX_CTL_M, rx) |
649 FIELD_PREP(MII_KSZ9031RN_TX_CTL_M, tx));
653 ret = phy_write_mmd(phydev, 2, MII_KSZ9031RN_RX_DATA_PAD_SKEW,
654 FIELD_PREP(MII_KSZ9031RN_RXD3, rx) |
655 FIELD_PREP(MII_KSZ9031RN_RXD2, rx) |
656 FIELD_PREP(MII_KSZ9031RN_RXD1, rx) |
657 FIELD_PREP(MII_KSZ9031RN_RXD0, rx));
661 ret = phy_write_mmd(phydev, 2, MII_KSZ9031RN_TX_DATA_PAD_SKEW,
662 FIELD_PREP(MII_KSZ9031RN_TXD3, tx) |
663 FIELD_PREP(MII_KSZ9031RN_TXD2, tx) |
664 FIELD_PREP(MII_KSZ9031RN_TXD1, tx) |
665 FIELD_PREP(MII_KSZ9031RN_TXD0, tx));
669 return phy_write_mmd(phydev, 2, MII_KSZ9031RN_CLK_PAD_SKEW,
670 FIELD_PREP(MII_KSZ9031RN_GTX_CLK, tx_clk) |
671 FIELD_PREP(MII_KSZ9031RN_RX_CLK, rx_clk));
674 static int ksz9031_config_init(struct phy_device *phydev)
676 const struct device *dev = &phydev->mdio.dev;
677 const struct device_node *of_node = dev->of_node;
678 static const char *clk_skews[2] = {"rxc-skew-ps", "txc-skew-ps"};
679 static const char *rx_data_skews[4] = {
680 "rxd0-skew-ps", "rxd1-skew-ps",
681 "rxd2-skew-ps", "rxd3-skew-ps"
683 static const char *tx_data_skews[4] = {
684 "txd0-skew-ps", "txd1-skew-ps",
685 "txd2-skew-ps", "txd3-skew-ps"
687 static const char *control_skews[2] = {"txen-skew-ps", "rxdv-skew-ps"};
688 const struct device *dev_walker;
691 result = ksz9031_enable_edpd(phydev);
695 /* The Micrel driver has a deprecated option to place phy OF
696 * properties in the MAC node. Walk up the tree of devices to
697 * find a device with an OF node.
699 dev_walker = &phydev->mdio.dev;
701 of_node = dev_walker->of_node;
702 dev_walker = dev_walker->parent;
703 } while (!of_node && dev_walker);
708 if (phy_interface_is_rgmii(phydev)) {
709 result = ksz9031_config_rgmii_delay(phydev);
714 ksz9031_of_load_skew_values(phydev, of_node,
715 MII_KSZ9031RN_CLK_PAD_SKEW, 5,
716 clk_skews, 2, &update);
718 ksz9031_of_load_skew_values(phydev, of_node,
719 MII_KSZ9031RN_CONTROL_PAD_SKEW, 4,
720 control_skews, 2, &update);
722 ksz9031_of_load_skew_values(phydev, of_node,
723 MII_KSZ9031RN_RX_DATA_PAD_SKEW, 4,
724 rx_data_skews, 4, &update);
726 ksz9031_of_load_skew_values(phydev, of_node,
727 MII_KSZ9031RN_TX_DATA_PAD_SKEW, 4,
728 tx_data_skews, 4, &update);
730 if (update && phydev->interface != PHY_INTERFACE_MODE_RGMII)
732 "*-skew-ps values should be used only with phy-mode = \"rgmii\"\n");
734 /* Silicon Errata Sheet (DS80000691D or DS80000692D):
735 * When the device links in the 1000BASE-T slave mode only,
736 * the optional 125MHz reference output clock (CLK125_NDO)
737 * has wide duty cycle variation.
739 * The optional CLK125_NDO clock does not meet the RGMII
740 * 45/55 percent (min/max) duty cycle requirement and therefore
741 * cannot be used directly by the MAC side for clocking
742 * applications that have setup/hold time requirements on
743 * rising and falling clock edges.
746 * Force the phy to be the master to receive a stable clock
747 * which meets the duty cycle requirement.
749 if (of_property_read_bool(of_node, "micrel,force-master")) {
750 result = phy_read(phydev, MII_CTRL1000);
752 goto err_force_master;
754 /* enable master mode, config & prefer master */
755 result |= CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER;
756 result = phy_write(phydev, MII_CTRL1000, result);
758 goto err_force_master;
762 return ksz9031_center_flp_timing(phydev);
765 phydev_err(phydev, "failed to force the phy to master mode\n");
769 #define KSZ9131_SKEW_5BIT_MAX 2400
770 #define KSZ9131_SKEW_4BIT_MAX 800
771 #define KSZ9131_OFFSET 700
772 #define KSZ9131_STEP 100
774 static int ksz9131_of_load_skew_values(struct phy_device *phydev,
775 struct device_node *of_node,
776 u16 reg, size_t field_sz,
777 char *field[], u8 numfields)
779 int val[4] = {-(1 + KSZ9131_OFFSET), -(2 + KSZ9131_OFFSET),
780 -(3 + KSZ9131_OFFSET), -(4 + KSZ9131_OFFSET)};
781 int skewval, skewmax = 0;
788 /* psec properties in dts should mean x pico seconds */
790 skewmax = KSZ9131_SKEW_5BIT_MAX;
792 skewmax = KSZ9131_SKEW_4BIT_MAX;
794 for (i = 0; i < numfields; i++)
795 if (!of_property_read_s32(of_node, field[i], &skewval)) {
796 if (skewval < -KSZ9131_OFFSET)
797 skewval = -KSZ9131_OFFSET;
798 else if (skewval > skewmax)
801 val[i] = skewval + KSZ9131_OFFSET;
808 if (matches < numfields)
809 newval = phy_read_mmd(phydev, 2, reg);
813 maxval = (field_sz == 4) ? 0xf : 0x1f;
814 for (i = 0; i < numfields; i++)
815 if (val[i] != -(i + 1 + KSZ9131_OFFSET)) {
817 mask ^= maxval << (field_sz * i);
818 newval = (newval & mask) |
819 (((val[i] / KSZ9131_STEP) & maxval)
823 return phy_write_mmd(phydev, 2, reg, newval);
826 #define KSZ9131RN_MMD_COMMON_CTRL_REG 2
827 #define KSZ9131RN_RXC_DLL_CTRL 76
828 #define KSZ9131RN_TXC_DLL_CTRL 77
829 #define KSZ9131RN_DLL_CTRL_BYPASS BIT_MASK(12)
830 #define KSZ9131RN_DLL_ENABLE_DELAY 0
831 #define KSZ9131RN_DLL_DISABLE_DELAY BIT(12)
833 static int ksz9131_config_rgmii_delay(struct phy_device *phydev)
835 u16 rxcdll_val, txcdll_val;
838 switch (phydev->interface) {
839 case PHY_INTERFACE_MODE_RGMII:
840 rxcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
841 txcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
843 case PHY_INTERFACE_MODE_RGMII_ID:
844 rxcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
845 txcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
847 case PHY_INTERFACE_MODE_RGMII_RXID:
848 rxcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
849 txcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
851 case PHY_INTERFACE_MODE_RGMII_TXID:
852 rxcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
853 txcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
859 ret = phy_modify_mmd(phydev, KSZ9131RN_MMD_COMMON_CTRL_REG,
860 KSZ9131RN_RXC_DLL_CTRL, KSZ9131RN_DLL_CTRL_BYPASS,
865 return phy_modify_mmd(phydev, KSZ9131RN_MMD_COMMON_CTRL_REG,
866 KSZ9131RN_TXC_DLL_CTRL, KSZ9131RN_DLL_CTRL_BYPASS,
870 static int ksz9131_config_init(struct phy_device *phydev)
872 const struct device *dev = &phydev->mdio.dev;
873 struct device_node *of_node = dev->of_node;
874 char *clk_skews[2] = {"rxc-skew-psec", "txc-skew-psec"};
875 char *rx_data_skews[4] = {
876 "rxd0-skew-psec", "rxd1-skew-psec",
877 "rxd2-skew-psec", "rxd3-skew-psec"
879 char *tx_data_skews[4] = {
880 "txd0-skew-psec", "txd1-skew-psec",
881 "txd2-skew-psec", "txd3-skew-psec"
883 char *control_skews[2] = {"txen-skew-psec", "rxdv-skew-psec"};
884 const struct device *dev_walker;
887 dev_walker = &phydev->mdio.dev;
889 of_node = dev_walker->of_node;
890 dev_walker = dev_walker->parent;
891 } while (!of_node && dev_walker);
896 if (phy_interface_is_rgmii(phydev)) {
897 ret = ksz9131_config_rgmii_delay(phydev);
902 ret = ksz9131_of_load_skew_values(phydev, of_node,
903 MII_KSZ9031RN_CLK_PAD_SKEW, 5,
908 ret = ksz9131_of_load_skew_values(phydev, of_node,
909 MII_KSZ9031RN_CONTROL_PAD_SKEW, 4,
914 ret = ksz9131_of_load_skew_values(phydev, of_node,
915 MII_KSZ9031RN_RX_DATA_PAD_SKEW, 4,
920 ret = ksz9131_of_load_skew_values(phydev, of_node,
921 MII_KSZ9031RN_TX_DATA_PAD_SKEW, 4,
929 #define KSZ8873MLL_GLOBAL_CONTROL_4 0x06
930 #define KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX BIT(6)
931 #define KSZ8873MLL_GLOBAL_CONTROL_4_SPEED BIT(4)
932 static int ksz8873mll_read_status(struct phy_device *phydev)
937 regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
939 regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
941 if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX)
942 phydev->duplex = DUPLEX_HALF;
944 phydev->duplex = DUPLEX_FULL;
946 if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_SPEED)
947 phydev->speed = SPEED_10;
949 phydev->speed = SPEED_100;
952 phydev->pause = phydev->asym_pause = 0;
957 static int ksz9031_get_features(struct phy_device *phydev)
961 ret = genphy_read_abilities(phydev);
965 /* Silicon Errata Sheet (DS80000691D or DS80000692D):
966 * Whenever the device's Asymmetric Pause capability is set to 1,
967 * link-up may fail after a link-up to link-down transition.
969 * The Errata Sheet is for ksz9031, but ksz9021 has the same issue
972 * Do not enable the Asymmetric Pause capability bit.
974 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
976 /* We force setting the Pause capability as the core will force the
977 * Asymmetric Pause capability to 1 otherwise.
979 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
984 static int ksz9031_read_status(struct phy_device *phydev)
989 err = genphy_read_status(phydev);
993 /* Make sure the PHY is not broken. Read idle error count,
994 * and reset the PHY if it is maxed out.
996 regval = phy_read(phydev, MII_STAT1000);
997 if ((regval & 0xFF) == 0xFF) {
1000 if (phydev->drv->config_intr && phy_interrupt_is_valid(phydev))
1001 phydev->drv->config_intr(phydev);
1002 return genphy_config_aneg(phydev);
1008 static int ksz8873mll_config_aneg(struct phy_device *phydev)
1013 static int kszphy_get_sset_count(struct phy_device *phydev)
1015 return ARRAY_SIZE(kszphy_hw_stats);
1018 static void kszphy_get_strings(struct phy_device *phydev, u8 *data)
1022 for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++) {
1023 strlcpy(data + i * ETH_GSTRING_LEN,
1024 kszphy_hw_stats[i].string, ETH_GSTRING_LEN);
1028 static u64 kszphy_get_stat(struct phy_device *phydev, int i)
1030 struct kszphy_hw_stat stat = kszphy_hw_stats[i];
1031 struct kszphy_priv *priv = phydev->priv;
1035 val = phy_read(phydev, stat.reg);
1039 val = val & ((1 << stat.bits) - 1);
1040 priv->stats[i] += val;
1041 ret = priv->stats[i];
1047 static void kszphy_get_stats(struct phy_device *phydev,
1048 struct ethtool_stats *stats, u64 *data)
1052 for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++)
1053 data[i] = kszphy_get_stat(phydev, i);
1056 static int kszphy_suspend(struct phy_device *phydev)
1058 /* Disable PHY Interrupts */
1059 if (phy_interrupt_is_valid(phydev)) {
1060 phydev->interrupts = PHY_INTERRUPT_DISABLED;
1061 if (phydev->drv->config_intr)
1062 phydev->drv->config_intr(phydev);
1065 return genphy_suspend(phydev);
1068 static int kszphy_resume(struct phy_device *phydev)
1072 genphy_resume(phydev);
1074 /* After switching from power-down to normal mode, an internal global
1075 * reset is automatically generated. Wait a minimum of 1 ms before
1076 * read/write access to the PHY registers.
1078 usleep_range(1000, 2000);
1080 ret = kszphy_config_reset(phydev);
1084 /* Enable PHY Interrupts */
1085 if (phy_interrupt_is_valid(phydev)) {
1086 phydev->interrupts = PHY_INTERRUPT_ENABLED;
1087 if (phydev->drv->config_intr)
1088 phydev->drv->config_intr(phydev);
1094 static int kszphy_probe(struct phy_device *phydev)
1096 const struct kszphy_type *type = phydev->drv->driver_data;
1097 const struct device_node *np = phydev->mdio.dev.of_node;
1098 struct kszphy_priv *priv;
1102 priv = devm_kzalloc(&phydev->mdio.dev, sizeof(*priv), GFP_KERNEL);
1106 phydev->priv = priv;
1110 if (type->led_mode_reg) {
1111 ret = of_property_read_u32(np, "micrel,led-mode",
1114 priv->led_mode = -1;
1116 if (priv->led_mode > 3) {
1117 phydev_err(phydev, "invalid led mode: 0x%02x\n",
1119 priv->led_mode = -1;
1122 priv->led_mode = -1;
1125 clk = devm_clk_get(&phydev->mdio.dev, "rmii-ref");
1126 /* NOTE: clk may be NULL if building without CONFIG_HAVE_CLK */
1127 if (!IS_ERR_OR_NULL(clk)) {
1128 unsigned long rate = clk_get_rate(clk);
1129 bool rmii_ref_clk_sel_25_mhz;
1131 priv->rmii_ref_clk_sel = type->has_rmii_ref_clk_sel;
1132 rmii_ref_clk_sel_25_mhz = of_property_read_bool(np,
1133 "micrel,rmii-reference-clock-select-25-mhz");
1135 if (rate > 24500000 && rate < 25500000) {
1136 priv->rmii_ref_clk_sel_val = rmii_ref_clk_sel_25_mhz;
1137 } else if (rate > 49500000 && rate < 50500000) {
1138 priv->rmii_ref_clk_sel_val = !rmii_ref_clk_sel_25_mhz;
1140 phydev_err(phydev, "Clock rate out of range: %ld\n",
1146 /* Support legacy board-file configuration */
1147 if (phydev->dev_flags & MICREL_PHY_50MHZ_CLK) {
1148 priv->rmii_ref_clk_sel = true;
1149 priv->rmii_ref_clk_sel_val = true;
1155 static struct phy_driver ksphy_driver[] = {
1157 .phy_id = PHY_ID_KS8737,
1158 .phy_id_mask = MICREL_PHY_ID_MASK,
1159 .name = "Micrel KS8737",
1160 /* PHY_BASIC_FEATURES */
1161 .driver_data = &ks8737_type,
1162 .config_init = kszphy_config_init,
1163 .ack_interrupt = kszphy_ack_interrupt,
1164 .config_intr = kszphy_config_intr,
1165 .suspend = genphy_suspend,
1166 .resume = genphy_resume,
1168 .phy_id = PHY_ID_KSZ8021,
1169 .phy_id_mask = 0x00ffffff,
1170 .name = "Micrel KSZ8021 or KSZ8031",
1171 /* PHY_BASIC_FEATURES */
1172 .driver_data = &ksz8021_type,
1173 .probe = kszphy_probe,
1174 .config_init = kszphy_config_init,
1175 .ack_interrupt = kszphy_ack_interrupt,
1176 .config_intr = kszphy_config_intr,
1177 .get_sset_count = kszphy_get_sset_count,
1178 .get_strings = kszphy_get_strings,
1179 .get_stats = kszphy_get_stats,
1180 .suspend = genphy_suspend,
1181 .resume = genphy_resume,
1183 .phy_id = PHY_ID_KSZ8031,
1184 .phy_id_mask = 0x00ffffff,
1185 .name = "Micrel KSZ8031",
1186 /* PHY_BASIC_FEATURES */
1187 .driver_data = &ksz8021_type,
1188 .probe = kszphy_probe,
1189 .config_init = kszphy_config_init,
1190 .ack_interrupt = kszphy_ack_interrupt,
1191 .config_intr = kszphy_config_intr,
1192 .get_sset_count = kszphy_get_sset_count,
1193 .get_strings = kszphy_get_strings,
1194 .get_stats = kszphy_get_stats,
1195 .suspend = genphy_suspend,
1196 .resume = genphy_resume,
1198 .phy_id = PHY_ID_KSZ8041,
1199 .phy_id_mask = MICREL_PHY_ID_MASK,
1200 .name = "Micrel KSZ8041",
1201 /* PHY_BASIC_FEATURES */
1202 .driver_data = &ksz8041_type,
1203 .probe = kszphy_probe,
1204 .config_init = ksz8041_config_init,
1205 .config_aneg = ksz8041_config_aneg,
1206 .ack_interrupt = kszphy_ack_interrupt,
1207 .config_intr = kszphy_config_intr,
1208 .get_sset_count = kszphy_get_sset_count,
1209 .get_strings = kszphy_get_strings,
1210 .get_stats = kszphy_get_stats,
1211 .suspend = genphy_suspend,
1212 .resume = genphy_resume,
1214 .phy_id = PHY_ID_KSZ8041RNLI,
1215 .phy_id_mask = MICREL_PHY_ID_MASK,
1216 .name = "Micrel KSZ8041RNLI",
1217 /* PHY_BASIC_FEATURES */
1218 .driver_data = &ksz8041_type,
1219 .probe = kszphy_probe,
1220 .config_init = kszphy_config_init,
1221 .ack_interrupt = kszphy_ack_interrupt,
1222 .config_intr = kszphy_config_intr,
1223 .get_sset_count = kszphy_get_sset_count,
1224 .get_strings = kszphy_get_strings,
1225 .get_stats = kszphy_get_stats,
1226 .suspend = genphy_suspend,
1227 .resume = genphy_resume,
1229 .name = "Micrel KSZ8051",
1230 /* PHY_BASIC_FEATURES */
1231 .driver_data = &ksz8051_type,
1232 .probe = kszphy_probe,
1233 .config_init = kszphy_config_init,
1234 .ack_interrupt = kszphy_ack_interrupt,
1235 .config_intr = kszphy_config_intr,
1236 .get_sset_count = kszphy_get_sset_count,
1237 .get_strings = kszphy_get_strings,
1238 .get_stats = kszphy_get_stats,
1239 .match_phy_device = ksz8051_match_phy_device,
1240 .suspend = genphy_suspend,
1241 .resume = genphy_resume,
1243 .phy_id = PHY_ID_KSZ8001,
1244 .name = "Micrel KSZ8001 or KS8721",
1245 .phy_id_mask = 0x00fffffc,
1246 /* PHY_BASIC_FEATURES */
1247 .driver_data = &ksz8041_type,
1248 .probe = kszphy_probe,
1249 .config_init = kszphy_config_init,
1250 .ack_interrupt = kszphy_ack_interrupt,
1251 .config_intr = kszphy_config_intr,
1252 .get_sset_count = kszphy_get_sset_count,
1253 .get_strings = kszphy_get_strings,
1254 .get_stats = kszphy_get_stats,
1255 .suspend = genphy_suspend,
1256 .resume = genphy_resume,
1258 .phy_id = PHY_ID_KSZ8081,
1259 .name = "Micrel KSZ8081 or KSZ8091",
1260 .phy_id_mask = MICREL_PHY_ID_MASK,
1261 /* PHY_BASIC_FEATURES */
1262 .driver_data = &ksz8081_type,
1263 .probe = kszphy_probe,
1264 .config_init = ksz8081_config_init,
1265 .ack_interrupt = kszphy_ack_interrupt,
1266 .config_intr = kszphy_config_intr,
1267 .get_sset_count = kszphy_get_sset_count,
1268 .get_strings = kszphy_get_strings,
1269 .get_stats = kszphy_get_stats,
1270 .suspend = kszphy_suspend,
1271 .resume = kszphy_resume,
1273 .phy_id = PHY_ID_KSZ8061,
1274 .name = "Micrel KSZ8061",
1275 .phy_id_mask = MICREL_PHY_ID_MASK,
1276 /* PHY_BASIC_FEATURES */
1277 .config_init = ksz8061_config_init,
1278 .ack_interrupt = kszphy_ack_interrupt,
1279 .config_intr = kszphy_config_intr,
1280 .suspend = genphy_suspend,
1281 .resume = genphy_resume,
1283 .phy_id = PHY_ID_KSZ9021,
1284 .phy_id_mask = 0x000ffffe,
1285 .name = "Micrel KSZ9021 Gigabit PHY",
1286 /* PHY_GBIT_FEATURES */
1287 .driver_data = &ksz9021_type,
1288 .probe = kszphy_probe,
1289 .get_features = ksz9031_get_features,
1290 .config_init = ksz9021_config_init,
1291 .ack_interrupt = kszphy_ack_interrupt,
1292 .config_intr = kszphy_config_intr,
1293 .get_sset_count = kszphy_get_sset_count,
1294 .get_strings = kszphy_get_strings,
1295 .get_stats = kszphy_get_stats,
1296 .suspend = genphy_suspend,
1297 .resume = genphy_resume,
1298 .read_mmd = genphy_read_mmd_unsupported,
1299 .write_mmd = genphy_write_mmd_unsupported,
1301 .phy_id = PHY_ID_KSZ9031,
1302 .phy_id_mask = MICREL_PHY_ID_MASK,
1303 .name = "Micrel KSZ9031 Gigabit PHY",
1304 .driver_data = &ksz9021_type,
1305 .probe = kszphy_probe,
1306 .get_features = ksz9031_get_features,
1307 .config_init = ksz9031_config_init,
1308 .soft_reset = genphy_soft_reset,
1309 .read_status = ksz9031_read_status,
1310 .ack_interrupt = kszphy_ack_interrupt,
1311 .config_intr = kszphy_config_intr,
1312 .get_sset_count = kszphy_get_sset_count,
1313 .get_strings = kszphy_get_strings,
1314 .get_stats = kszphy_get_stats,
1315 .suspend = genphy_suspend,
1316 .resume = kszphy_resume,
1318 .phy_id = PHY_ID_LAN8814,
1319 .phy_id_mask = MICREL_PHY_ID_MASK,
1320 .name = "Microchip INDY Gigabit Quad PHY",
1321 .driver_data = &ksz9021_type,
1322 .probe = kszphy_probe,
1323 .soft_reset = genphy_soft_reset,
1324 .read_status = ksz9031_read_status,
1325 .get_sset_count = kszphy_get_sset_count,
1326 .get_strings = kszphy_get_strings,
1327 .get_stats = kszphy_get_stats,
1328 .suspend = genphy_suspend,
1329 .resume = kszphy_resume,
1331 .phy_id = PHY_ID_KSZ9131,
1332 .phy_id_mask = MICREL_PHY_ID_MASK,
1333 .name = "Microchip KSZ9131 Gigabit PHY",
1334 /* PHY_GBIT_FEATURES */
1335 .driver_data = &ksz9021_type,
1336 .probe = kszphy_probe,
1337 .config_init = ksz9131_config_init,
1338 .read_status = genphy_read_status,
1339 .ack_interrupt = kszphy_ack_interrupt,
1340 .config_intr = kszphy_config_intr,
1341 .get_sset_count = kszphy_get_sset_count,
1342 .get_strings = kszphy_get_strings,
1343 .get_stats = kszphy_get_stats,
1344 .suspend = genphy_suspend,
1345 .resume = kszphy_resume,
1347 .phy_id = PHY_ID_KSZ8873MLL,
1348 .phy_id_mask = MICREL_PHY_ID_MASK,
1349 .name = "Micrel KSZ8873MLL Switch",
1350 /* PHY_BASIC_FEATURES */
1351 .config_init = kszphy_config_init,
1352 .config_aneg = ksz8873mll_config_aneg,
1353 .read_status = ksz8873mll_read_status,
1354 .suspend = genphy_suspend,
1355 .resume = genphy_resume,
1357 .phy_id = PHY_ID_KSZ886X,
1358 .phy_id_mask = MICREL_PHY_ID_MASK,
1359 .name = "Micrel KSZ886X Switch",
1360 /* PHY_BASIC_FEATURES */
1361 .config_init = kszphy_config_init,
1362 .suspend = genphy_suspend,
1363 .resume = genphy_resume,
1365 .name = "Micrel KSZ87XX Switch",
1366 /* PHY_BASIC_FEATURES */
1367 .config_init = kszphy_config_init,
1368 .config_aneg = ksz8873mll_config_aneg,
1369 .read_status = ksz8873mll_read_status,
1370 .match_phy_device = ksz8795_match_phy_device,
1371 .suspend = genphy_suspend,
1372 .resume = genphy_resume,
1374 .phy_id = PHY_ID_KSZ9477,
1375 .phy_id_mask = MICREL_PHY_ID_MASK,
1376 .name = "Microchip KSZ9477",
1377 /* PHY_GBIT_FEATURES */
1378 .config_init = kszphy_config_init,
1379 .suspend = genphy_suspend,
1380 .resume = genphy_resume,
1383 module_phy_driver(ksphy_driver);
1385 MODULE_DESCRIPTION("Micrel PHY driver");
1386 MODULE_AUTHOR("David J. Choi");
1387 MODULE_LICENSE("GPL");
1389 static struct mdio_device_id __maybe_unused micrel_tbl[] = {
1390 { PHY_ID_KSZ9021, 0x000ffffe },
1391 { PHY_ID_KSZ9031, MICREL_PHY_ID_MASK },
1392 { PHY_ID_KSZ9131, MICREL_PHY_ID_MASK },
1393 { PHY_ID_KSZ8001, 0x00fffffc },
1394 { PHY_ID_KS8737, MICREL_PHY_ID_MASK },
1395 { PHY_ID_KSZ8021, 0x00ffffff },
1396 { PHY_ID_KSZ8031, 0x00ffffff },
1397 { PHY_ID_KSZ8041, MICREL_PHY_ID_MASK },
1398 { PHY_ID_KSZ8051, MICREL_PHY_ID_MASK },
1399 { PHY_ID_KSZ8061, MICREL_PHY_ID_MASK },
1400 { PHY_ID_KSZ8081, MICREL_PHY_ID_MASK },
1401 { PHY_ID_KSZ8873MLL, MICREL_PHY_ID_MASK },
1402 { PHY_ID_KSZ886X, MICREL_PHY_ID_MASK },
1403 { PHY_ID_LAN8814, MICREL_PHY_ID_MASK },
1407 MODULE_DEVICE_TABLE(mdio, micrel_tbl);