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)
51 #define KSZPHY_INTCS_LINK_DOWN_STATUS BIT(2)
52 #define KSZPHY_INTCS_LINK_UP_STATUS BIT(0)
53 #define KSZPHY_INTCS_STATUS (KSZPHY_INTCS_LINK_DOWN_STATUS |\
54 KSZPHY_INTCS_LINK_UP_STATUS)
57 #define MII_KSZPHY_CTRL_1 0x1e
59 /* PHY Control 2 / PHY Control (if no PHY Control 1) */
60 #define MII_KSZPHY_CTRL_2 0x1f
61 #define MII_KSZPHY_CTRL MII_KSZPHY_CTRL_2
62 /* bitmap of PHY register to set interrupt mode */
63 #define KSZPHY_CTRL_INT_ACTIVE_HIGH BIT(9)
64 #define KSZPHY_RMII_REF_CLK_SEL BIT(7)
66 /* Write/read to/from extended registers */
67 #define MII_KSZPHY_EXTREG 0x0b
68 #define KSZPHY_EXTREG_WRITE 0x8000
70 #define MII_KSZPHY_EXTREG_WRITE 0x0c
71 #define MII_KSZPHY_EXTREG_READ 0x0d
73 /* Extended registers */
74 #define MII_KSZPHY_CLK_CONTROL_PAD_SKEW 0x104
75 #define MII_KSZPHY_RX_DATA_PAD_SKEW 0x105
76 #define MII_KSZPHY_TX_DATA_PAD_SKEW 0x106
80 struct kszphy_hw_stat {
86 static struct kszphy_hw_stat kszphy_hw_stats[] = {
87 { "phy_receive_errors", 21, 16},
88 { "phy_idle_errors", 10, 8 },
93 u16 interrupt_level_mask;
94 bool has_broadcast_disable;
95 bool has_nand_tree_disable;
96 bool has_rmii_ref_clk_sel;
100 const struct kszphy_type *type;
102 bool rmii_ref_clk_sel;
103 bool rmii_ref_clk_sel_val;
104 u64 stats[ARRAY_SIZE(kszphy_hw_stats)];
107 static const struct kszphy_type ksz8021_type = {
108 .led_mode_reg = MII_KSZPHY_CTRL_2,
109 .has_broadcast_disable = true,
110 .has_nand_tree_disable = true,
111 .has_rmii_ref_clk_sel = true,
114 static const struct kszphy_type ksz8041_type = {
115 .led_mode_reg = MII_KSZPHY_CTRL_1,
118 static const struct kszphy_type ksz8051_type = {
119 .led_mode_reg = MII_KSZPHY_CTRL_2,
120 .has_nand_tree_disable = true,
123 static const struct kszphy_type ksz8081_type = {
124 .led_mode_reg = MII_KSZPHY_CTRL_2,
125 .has_broadcast_disable = true,
126 .has_nand_tree_disable = true,
127 .has_rmii_ref_clk_sel = true,
130 static const struct kszphy_type ks8737_type = {
131 .interrupt_level_mask = BIT(14),
134 static const struct kszphy_type ksz9021_type = {
135 .interrupt_level_mask = BIT(14),
138 static int kszphy_extended_write(struct phy_device *phydev,
141 phy_write(phydev, MII_KSZPHY_EXTREG, KSZPHY_EXTREG_WRITE | regnum);
142 return phy_write(phydev, MII_KSZPHY_EXTREG_WRITE, val);
145 static int kszphy_extended_read(struct phy_device *phydev,
148 phy_write(phydev, MII_KSZPHY_EXTREG, regnum);
149 return phy_read(phydev, MII_KSZPHY_EXTREG_READ);
152 static int kszphy_ack_interrupt(struct phy_device *phydev)
154 /* bit[7..0] int status, which is a read and clear register. */
157 rc = phy_read(phydev, MII_KSZPHY_INTCS);
159 return (rc < 0) ? rc : 0;
162 static int kszphy_config_intr(struct phy_device *phydev)
164 const struct kszphy_type *type = phydev->drv->driver_data;
168 if (type && type->interrupt_level_mask)
169 mask = type->interrupt_level_mask;
171 mask = KSZPHY_CTRL_INT_ACTIVE_HIGH;
173 /* set the interrupt pin active low */
174 temp = phy_read(phydev, MII_KSZPHY_CTRL);
178 phy_write(phydev, MII_KSZPHY_CTRL, temp);
180 /* enable / disable interrupts */
181 if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
182 err = kszphy_ack_interrupt(phydev);
186 temp = KSZPHY_INTCS_ALL;
187 err = phy_write(phydev, MII_KSZPHY_INTCS, temp);
190 err = phy_write(phydev, MII_KSZPHY_INTCS, temp);
194 err = kszphy_ack_interrupt(phydev);
200 static irqreturn_t kszphy_handle_interrupt(struct phy_device *phydev)
204 irq_status = phy_read(phydev, MII_KSZPHY_INTCS);
205 if (irq_status < 0) {
210 if (!(irq_status & KSZPHY_INTCS_STATUS))
213 phy_trigger_machine(phydev);
218 static int kszphy_rmii_clk_sel(struct phy_device *phydev, bool val)
222 ctrl = phy_read(phydev, MII_KSZPHY_CTRL);
227 ctrl |= KSZPHY_RMII_REF_CLK_SEL;
229 ctrl &= ~KSZPHY_RMII_REF_CLK_SEL;
231 return phy_write(phydev, MII_KSZPHY_CTRL, ctrl);
234 static int kszphy_setup_led(struct phy_device *phydev, u32 reg, int val)
239 case MII_KSZPHY_CTRL_1:
242 case MII_KSZPHY_CTRL_2:
249 temp = phy_read(phydev, reg);
255 temp &= ~(3 << shift);
256 temp |= val << shift;
257 rc = phy_write(phydev, reg, temp);
260 phydev_err(phydev, "failed to set led mode\n");
265 /* Disable PHY address 0 as the broadcast address, so that it can be used as a
266 * unique (non-broadcast) address on a shared bus.
268 static int kszphy_broadcast_disable(struct phy_device *phydev)
272 ret = phy_read(phydev, MII_KSZPHY_OMSO);
276 ret = phy_write(phydev, MII_KSZPHY_OMSO, ret | KSZPHY_OMSO_B_CAST_OFF);
279 phydev_err(phydev, "failed to disable broadcast address\n");
284 static int kszphy_nand_tree_disable(struct phy_device *phydev)
288 ret = phy_read(phydev, MII_KSZPHY_OMSO);
292 if (!(ret & KSZPHY_OMSO_NAND_TREE_ON))
295 ret = phy_write(phydev, MII_KSZPHY_OMSO,
296 ret & ~KSZPHY_OMSO_NAND_TREE_ON);
299 phydev_err(phydev, "failed to disable NAND tree mode\n");
304 /* Some config bits need to be set again on resume, handle them here. */
305 static int kszphy_config_reset(struct phy_device *phydev)
307 struct kszphy_priv *priv = phydev->priv;
310 if (priv->rmii_ref_clk_sel) {
311 ret = kszphy_rmii_clk_sel(phydev, priv->rmii_ref_clk_sel_val);
314 "failed to set rmii reference clock\n");
319 if (priv->led_mode >= 0)
320 kszphy_setup_led(phydev, priv->type->led_mode_reg, priv->led_mode);
325 static int kszphy_config_init(struct phy_device *phydev)
327 struct kszphy_priv *priv = phydev->priv;
328 const struct kszphy_type *type;
335 if (type->has_broadcast_disable)
336 kszphy_broadcast_disable(phydev);
338 if (type->has_nand_tree_disable)
339 kszphy_nand_tree_disable(phydev);
341 return kszphy_config_reset(phydev);
344 static int ksz8041_fiber_mode(struct phy_device *phydev)
346 struct device_node *of_node = phydev->mdio.dev.of_node;
348 return of_property_read_bool(of_node, "micrel,fiber-mode");
351 static int ksz8041_config_init(struct phy_device *phydev)
353 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
355 /* Limit supported and advertised modes in fiber mode */
356 if (ksz8041_fiber_mode(phydev)) {
357 phydev->dev_flags |= MICREL_PHY_FXEN;
358 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, mask);
359 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, mask);
361 linkmode_and(phydev->supported, phydev->supported, mask);
362 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
364 linkmode_and(phydev->advertising, phydev->advertising, mask);
365 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
366 phydev->advertising);
367 phydev->autoneg = AUTONEG_DISABLE;
370 return kszphy_config_init(phydev);
373 static int ksz8041_config_aneg(struct phy_device *phydev)
375 /* Skip auto-negotiation in fiber mode */
376 if (phydev->dev_flags & MICREL_PHY_FXEN) {
377 phydev->speed = SPEED_100;
381 return genphy_config_aneg(phydev);
384 static int ksz8051_ksz8795_match_phy_device(struct phy_device *phydev,
385 const u32 ksz_phy_id)
389 if ((phydev->phy_id & MICREL_PHY_ID_MASK) != ksz_phy_id)
392 ret = phy_read(phydev, MII_BMSR);
396 /* KSZ8051 PHY and KSZ8794/KSZ8795/KSZ8765 switch share the same
397 * exact PHY ID. However, they can be told apart by the extended
398 * capability registers presence. The KSZ8051 PHY has them while
399 * the switch does not.
402 if (ksz_phy_id == PHY_ID_KSZ8051)
408 static int ksz8051_match_phy_device(struct phy_device *phydev)
410 return ksz8051_ksz8795_match_phy_device(phydev, PHY_ID_KSZ8051);
413 static int ksz8081_config_init(struct phy_device *phydev)
415 /* KSZPHY_OMSO_FACTORY_TEST is set at de-assertion of the reset line
416 * based on the RXER (KSZ8081RNA/RND) or TXC (KSZ8081MNX/RNB) pin. If a
417 * pull-down is missing, the factory test mode should be cleared by
418 * manually writing a 0.
420 phy_clear_bits(phydev, MII_KSZPHY_OMSO, KSZPHY_OMSO_FACTORY_TEST);
422 return kszphy_config_init(phydev);
425 static int ksz8061_config_init(struct phy_device *phydev)
429 ret = phy_write_mmd(phydev, MDIO_MMD_PMAPMD, MDIO_DEVID1, 0xB61A);
433 return kszphy_config_init(phydev);
436 static int ksz8795_match_phy_device(struct phy_device *phydev)
438 return ksz8051_ksz8795_match_phy_device(phydev, PHY_ID_KSZ87XX);
441 static int ksz9021_load_values_from_of(struct phy_device *phydev,
442 const struct device_node *of_node,
444 const char *field1, const char *field2,
445 const char *field3, const char *field4)
454 if (!of_property_read_u32(of_node, field1, &val1))
457 if (!of_property_read_u32(of_node, field2, &val2))
460 if (!of_property_read_u32(of_node, field3, &val3))
463 if (!of_property_read_u32(of_node, field4, &val4))
470 newval = kszphy_extended_read(phydev, reg);
475 newval = ((newval & 0xfff0) | ((val1 / PS_TO_REG) & 0xf) << 0);
478 newval = ((newval & 0xff0f) | ((val2 / PS_TO_REG) & 0xf) << 4);
481 newval = ((newval & 0xf0ff) | ((val3 / PS_TO_REG) & 0xf) << 8);
484 newval = ((newval & 0x0fff) | ((val4 / PS_TO_REG) & 0xf) << 12);
486 return kszphy_extended_write(phydev, reg, newval);
489 static int ksz9021_config_init(struct phy_device *phydev)
491 const struct device *dev = &phydev->mdio.dev;
492 const struct device_node *of_node = dev->of_node;
493 const struct device *dev_walker;
495 /* The Micrel driver has a deprecated option to place phy OF
496 * properties in the MAC node. Walk up the tree of devices to
497 * find a device with an OF node.
499 dev_walker = &phydev->mdio.dev;
501 of_node = dev_walker->of_node;
502 dev_walker = dev_walker->parent;
504 } while (!of_node && dev_walker);
507 ksz9021_load_values_from_of(phydev, of_node,
508 MII_KSZPHY_CLK_CONTROL_PAD_SKEW,
509 "txen-skew-ps", "txc-skew-ps",
510 "rxdv-skew-ps", "rxc-skew-ps");
511 ksz9021_load_values_from_of(phydev, of_node,
512 MII_KSZPHY_RX_DATA_PAD_SKEW,
513 "rxd0-skew-ps", "rxd1-skew-ps",
514 "rxd2-skew-ps", "rxd3-skew-ps");
515 ksz9021_load_values_from_of(phydev, of_node,
516 MII_KSZPHY_TX_DATA_PAD_SKEW,
517 "txd0-skew-ps", "txd1-skew-ps",
518 "txd2-skew-ps", "txd3-skew-ps");
523 #define KSZ9031_PS_TO_REG 60
525 /* Extended registers */
526 /* MMD Address 0x0 */
527 #define MII_KSZ9031RN_FLP_BURST_TX_LO 3
528 #define MII_KSZ9031RN_FLP_BURST_TX_HI 4
530 /* MMD Address 0x2 */
531 #define MII_KSZ9031RN_CONTROL_PAD_SKEW 4
532 #define MII_KSZ9031RN_RX_CTL_M GENMASK(7, 4)
533 #define MII_KSZ9031RN_TX_CTL_M GENMASK(3, 0)
535 #define MII_KSZ9031RN_RX_DATA_PAD_SKEW 5
536 #define MII_KSZ9031RN_RXD3 GENMASK(15, 12)
537 #define MII_KSZ9031RN_RXD2 GENMASK(11, 8)
538 #define MII_KSZ9031RN_RXD1 GENMASK(7, 4)
539 #define MII_KSZ9031RN_RXD0 GENMASK(3, 0)
541 #define MII_KSZ9031RN_TX_DATA_PAD_SKEW 6
542 #define MII_KSZ9031RN_TXD3 GENMASK(15, 12)
543 #define MII_KSZ9031RN_TXD2 GENMASK(11, 8)
544 #define MII_KSZ9031RN_TXD1 GENMASK(7, 4)
545 #define MII_KSZ9031RN_TXD0 GENMASK(3, 0)
547 #define MII_KSZ9031RN_CLK_PAD_SKEW 8
548 #define MII_KSZ9031RN_GTX_CLK GENMASK(9, 5)
549 #define MII_KSZ9031RN_RX_CLK GENMASK(4, 0)
551 /* KSZ9031 has internal RGMII_IDRX = 1.2ns and RGMII_IDTX = 0ns. To
552 * provide different RGMII options we need to configure delay offset
553 * for each pad relative to build in delay.
555 /* keep rx as "No delay adjustment" and set rx_clk to +0.60ns to get delays of
559 #define RX_CLK_ID 0x19
561 /* set rx to +0.30ns and rx_clk to -0.90ns to compensate the
562 * internal 1.2ns delay.
565 #define RX_CLK_ND 0x0
567 /* set tx to -0.42ns and tx_clk to +0.96ns to get 1.38ns delay */
569 #define TX_CLK_ID 0x1f
571 /* set tx and tx_clk to "No delay adjustment" to keep 0ns
575 #define TX_CLK_ND 0xf
577 /* MMD Address 0x1C */
578 #define MII_KSZ9031RN_EDPD 0x23
579 #define MII_KSZ9031RN_EDPD_ENABLE BIT(0)
581 static int ksz9031_of_load_skew_values(struct phy_device *phydev,
582 const struct device_node *of_node,
583 u16 reg, size_t field_sz,
584 const char *field[], u8 numfields,
587 int val[4] = {-1, -2, -3, -4};
594 for (i = 0; i < numfields; i++)
595 if (!of_property_read_u32(of_node, field[i], val + i))
603 if (matches < numfields)
604 newval = phy_read_mmd(phydev, 2, reg);
608 maxval = (field_sz == 4) ? 0xf : 0x1f;
609 for (i = 0; i < numfields; i++)
610 if (val[i] != -(i + 1)) {
612 mask ^= maxval << (field_sz * i);
613 newval = (newval & mask) |
614 (((val[i] / KSZ9031_PS_TO_REG) & maxval)
618 return phy_write_mmd(phydev, 2, reg, newval);
621 /* Center KSZ9031RNX FLP timing at 16ms. */
622 static int ksz9031_center_flp_timing(struct phy_device *phydev)
626 result = phy_write_mmd(phydev, 0, MII_KSZ9031RN_FLP_BURST_TX_HI,
631 result = phy_write_mmd(phydev, 0, MII_KSZ9031RN_FLP_BURST_TX_LO,
636 return genphy_restart_aneg(phydev);
639 /* Enable energy-detect power-down mode */
640 static int ksz9031_enable_edpd(struct phy_device *phydev)
644 reg = phy_read_mmd(phydev, 0x1C, MII_KSZ9031RN_EDPD);
647 return phy_write_mmd(phydev, 0x1C, MII_KSZ9031RN_EDPD,
648 reg | MII_KSZ9031RN_EDPD_ENABLE);
651 static int ksz9031_config_rgmii_delay(struct phy_device *phydev)
653 u16 rx, tx, rx_clk, tx_clk;
656 switch (phydev->interface) {
657 case PHY_INTERFACE_MODE_RGMII:
663 case PHY_INTERFACE_MODE_RGMII_ID:
669 case PHY_INTERFACE_MODE_RGMII_RXID:
675 case PHY_INTERFACE_MODE_RGMII_TXID:
685 ret = phy_write_mmd(phydev, 2, MII_KSZ9031RN_CONTROL_PAD_SKEW,
686 FIELD_PREP(MII_KSZ9031RN_RX_CTL_M, rx) |
687 FIELD_PREP(MII_KSZ9031RN_TX_CTL_M, tx));
691 ret = phy_write_mmd(phydev, 2, MII_KSZ9031RN_RX_DATA_PAD_SKEW,
692 FIELD_PREP(MII_KSZ9031RN_RXD3, rx) |
693 FIELD_PREP(MII_KSZ9031RN_RXD2, rx) |
694 FIELD_PREP(MII_KSZ9031RN_RXD1, rx) |
695 FIELD_PREP(MII_KSZ9031RN_RXD0, rx));
699 ret = phy_write_mmd(phydev, 2, MII_KSZ9031RN_TX_DATA_PAD_SKEW,
700 FIELD_PREP(MII_KSZ9031RN_TXD3, tx) |
701 FIELD_PREP(MII_KSZ9031RN_TXD2, tx) |
702 FIELD_PREP(MII_KSZ9031RN_TXD1, tx) |
703 FIELD_PREP(MII_KSZ9031RN_TXD0, tx));
707 return phy_write_mmd(phydev, 2, MII_KSZ9031RN_CLK_PAD_SKEW,
708 FIELD_PREP(MII_KSZ9031RN_GTX_CLK, tx_clk) |
709 FIELD_PREP(MII_KSZ9031RN_RX_CLK, rx_clk));
712 static int ksz9031_config_init(struct phy_device *phydev)
714 const struct device *dev = &phydev->mdio.dev;
715 const struct device_node *of_node = dev->of_node;
716 static const char *clk_skews[2] = {"rxc-skew-ps", "txc-skew-ps"};
717 static const char *rx_data_skews[4] = {
718 "rxd0-skew-ps", "rxd1-skew-ps",
719 "rxd2-skew-ps", "rxd3-skew-ps"
721 static const char *tx_data_skews[4] = {
722 "txd0-skew-ps", "txd1-skew-ps",
723 "txd2-skew-ps", "txd3-skew-ps"
725 static const char *control_skews[2] = {"txen-skew-ps", "rxdv-skew-ps"};
726 const struct device *dev_walker;
729 result = ksz9031_enable_edpd(phydev);
733 /* The Micrel driver has a deprecated option to place phy OF
734 * properties in the MAC node. Walk up the tree of devices to
735 * find a device with an OF node.
737 dev_walker = &phydev->mdio.dev;
739 of_node = dev_walker->of_node;
740 dev_walker = dev_walker->parent;
741 } while (!of_node && dev_walker);
746 if (phy_interface_is_rgmii(phydev)) {
747 result = ksz9031_config_rgmii_delay(phydev);
752 ksz9031_of_load_skew_values(phydev, of_node,
753 MII_KSZ9031RN_CLK_PAD_SKEW, 5,
754 clk_skews, 2, &update);
756 ksz9031_of_load_skew_values(phydev, of_node,
757 MII_KSZ9031RN_CONTROL_PAD_SKEW, 4,
758 control_skews, 2, &update);
760 ksz9031_of_load_skew_values(phydev, of_node,
761 MII_KSZ9031RN_RX_DATA_PAD_SKEW, 4,
762 rx_data_skews, 4, &update);
764 ksz9031_of_load_skew_values(phydev, of_node,
765 MII_KSZ9031RN_TX_DATA_PAD_SKEW, 4,
766 tx_data_skews, 4, &update);
768 if (update && phydev->interface != PHY_INTERFACE_MODE_RGMII)
770 "*-skew-ps values should be used only with phy-mode = \"rgmii\"\n");
772 /* Silicon Errata Sheet (DS80000691D or DS80000692D):
773 * When the device links in the 1000BASE-T slave mode only,
774 * the optional 125MHz reference output clock (CLK125_NDO)
775 * has wide duty cycle variation.
777 * The optional CLK125_NDO clock does not meet the RGMII
778 * 45/55 percent (min/max) duty cycle requirement and therefore
779 * cannot be used directly by the MAC side for clocking
780 * applications that have setup/hold time requirements on
781 * rising and falling clock edges.
784 * Force the phy to be the master to receive a stable clock
785 * which meets the duty cycle requirement.
787 if (of_property_read_bool(of_node, "micrel,force-master")) {
788 result = phy_read(phydev, MII_CTRL1000);
790 goto err_force_master;
792 /* enable master mode, config & prefer master */
793 result |= CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER;
794 result = phy_write(phydev, MII_CTRL1000, result);
796 goto err_force_master;
800 return ksz9031_center_flp_timing(phydev);
803 phydev_err(phydev, "failed to force the phy to master mode\n");
807 #define KSZ9131_SKEW_5BIT_MAX 2400
808 #define KSZ9131_SKEW_4BIT_MAX 800
809 #define KSZ9131_OFFSET 700
810 #define KSZ9131_STEP 100
812 static int ksz9131_of_load_skew_values(struct phy_device *phydev,
813 struct device_node *of_node,
814 u16 reg, size_t field_sz,
815 char *field[], u8 numfields)
817 int val[4] = {-(1 + KSZ9131_OFFSET), -(2 + KSZ9131_OFFSET),
818 -(3 + KSZ9131_OFFSET), -(4 + KSZ9131_OFFSET)};
819 int skewval, skewmax = 0;
826 /* psec properties in dts should mean x pico seconds */
828 skewmax = KSZ9131_SKEW_5BIT_MAX;
830 skewmax = KSZ9131_SKEW_4BIT_MAX;
832 for (i = 0; i < numfields; i++)
833 if (!of_property_read_s32(of_node, field[i], &skewval)) {
834 if (skewval < -KSZ9131_OFFSET)
835 skewval = -KSZ9131_OFFSET;
836 else if (skewval > skewmax)
839 val[i] = skewval + KSZ9131_OFFSET;
846 if (matches < numfields)
847 newval = phy_read_mmd(phydev, 2, reg);
851 maxval = (field_sz == 4) ? 0xf : 0x1f;
852 for (i = 0; i < numfields; i++)
853 if (val[i] != -(i + 1 + KSZ9131_OFFSET)) {
855 mask ^= maxval << (field_sz * i);
856 newval = (newval & mask) |
857 (((val[i] / KSZ9131_STEP) & maxval)
861 return phy_write_mmd(phydev, 2, reg, newval);
864 #define KSZ9131RN_MMD_COMMON_CTRL_REG 2
865 #define KSZ9131RN_RXC_DLL_CTRL 76
866 #define KSZ9131RN_TXC_DLL_CTRL 77
867 #define KSZ9131RN_DLL_CTRL_BYPASS BIT_MASK(12)
868 #define KSZ9131RN_DLL_ENABLE_DELAY 0
869 #define KSZ9131RN_DLL_DISABLE_DELAY BIT(12)
871 static int ksz9131_config_rgmii_delay(struct phy_device *phydev)
873 u16 rxcdll_val, txcdll_val;
876 switch (phydev->interface) {
877 case PHY_INTERFACE_MODE_RGMII:
878 rxcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
879 txcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
881 case PHY_INTERFACE_MODE_RGMII_ID:
882 rxcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
883 txcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
885 case PHY_INTERFACE_MODE_RGMII_RXID:
886 rxcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
887 txcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
889 case PHY_INTERFACE_MODE_RGMII_TXID:
890 rxcdll_val = KSZ9131RN_DLL_DISABLE_DELAY;
891 txcdll_val = KSZ9131RN_DLL_ENABLE_DELAY;
897 ret = phy_modify_mmd(phydev, KSZ9131RN_MMD_COMMON_CTRL_REG,
898 KSZ9131RN_RXC_DLL_CTRL, KSZ9131RN_DLL_CTRL_BYPASS,
903 return phy_modify_mmd(phydev, KSZ9131RN_MMD_COMMON_CTRL_REG,
904 KSZ9131RN_TXC_DLL_CTRL, KSZ9131RN_DLL_CTRL_BYPASS,
908 static int ksz9131_config_init(struct phy_device *phydev)
910 const struct device *dev = &phydev->mdio.dev;
911 struct device_node *of_node = dev->of_node;
912 char *clk_skews[2] = {"rxc-skew-psec", "txc-skew-psec"};
913 char *rx_data_skews[4] = {
914 "rxd0-skew-psec", "rxd1-skew-psec",
915 "rxd2-skew-psec", "rxd3-skew-psec"
917 char *tx_data_skews[4] = {
918 "txd0-skew-psec", "txd1-skew-psec",
919 "txd2-skew-psec", "txd3-skew-psec"
921 char *control_skews[2] = {"txen-skew-psec", "rxdv-skew-psec"};
922 const struct device *dev_walker;
925 dev_walker = &phydev->mdio.dev;
927 of_node = dev_walker->of_node;
928 dev_walker = dev_walker->parent;
929 } while (!of_node && dev_walker);
934 if (phy_interface_is_rgmii(phydev)) {
935 ret = ksz9131_config_rgmii_delay(phydev);
940 ret = ksz9131_of_load_skew_values(phydev, of_node,
941 MII_KSZ9031RN_CLK_PAD_SKEW, 5,
946 ret = ksz9131_of_load_skew_values(phydev, of_node,
947 MII_KSZ9031RN_CONTROL_PAD_SKEW, 4,
952 ret = ksz9131_of_load_skew_values(phydev, of_node,
953 MII_KSZ9031RN_RX_DATA_PAD_SKEW, 4,
958 ret = ksz9131_of_load_skew_values(phydev, of_node,
959 MII_KSZ9031RN_TX_DATA_PAD_SKEW, 4,
967 #define KSZ8873MLL_GLOBAL_CONTROL_4 0x06
968 #define KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX BIT(6)
969 #define KSZ8873MLL_GLOBAL_CONTROL_4_SPEED BIT(4)
970 static int ksz8873mll_read_status(struct phy_device *phydev)
975 regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
977 regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
979 if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX)
980 phydev->duplex = DUPLEX_HALF;
982 phydev->duplex = DUPLEX_FULL;
984 if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_SPEED)
985 phydev->speed = SPEED_10;
987 phydev->speed = SPEED_100;
990 phydev->pause = phydev->asym_pause = 0;
995 static int ksz9031_get_features(struct phy_device *phydev)
999 ret = genphy_read_abilities(phydev);
1003 /* Silicon Errata Sheet (DS80000691D or DS80000692D):
1004 * Whenever the device's Asymmetric Pause capability is set to 1,
1005 * link-up may fail after a link-up to link-down transition.
1007 * The Errata Sheet is for ksz9031, but ksz9021 has the same issue
1010 * Do not enable the Asymmetric Pause capability bit.
1012 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
1014 /* We force setting the Pause capability as the core will force the
1015 * Asymmetric Pause capability to 1 otherwise.
1017 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
1022 static int ksz9031_read_status(struct phy_device *phydev)
1027 err = genphy_read_status(phydev);
1031 /* Make sure the PHY is not broken. Read idle error count,
1032 * and reset the PHY if it is maxed out.
1034 regval = phy_read(phydev, MII_STAT1000);
1035 if ((regval & 0xFF) == 0xFF) {
1036 phy_init_hw(phydev);
1038 if (phydev->drv->config_intr && phy_interrupt_is_valid(phydev))
1039 phydev->drv->config_intr(phydev);
1040 return genphy_config_aneg(phydev);
1046 static int ksz8873mll_config_aneg(struct phy_device *phydev)
1051 static int kszphy_get_sset_count(struct phy_device *phydev)
1053 return ARRAY_SIZE(kszphy_hw_stats);
1056 static void kszphy_get_strings(struct phy_device *phydev, u8 *data)
1060 for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++) {
1061 strlcpy(data + i * ETH_GSTRING_LEN,
1062 kszphy_hw_stats[i].string, ETH_GSTRING_LEN);
1066 static u64 kszphy_get_stat(struct phy_device *phydev, int i)
1068 struct kszphy_hw_stat stat = kszphy_hw_stats[i];
1069 struct kszphy_priv *priv = phydev->priv;
1073 val = phy_read(phydev, stat.reg);
1077 val = val & ((1 << stat.bits) - 1);
1078 priv->stats[i] += val;
1079 ret = priv->stats[i];
1085 static void kszphy_get_stats(struct phy_device *phydev,
1086 struct ethtool_stats *stats, u64 *data)
1090 for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++)
1091 data[i] = kszphy_get_stat(phydev, i);
1094 static int kszphy_suspend(struct phy_device *phydev)
1096 /* Disable PHY Interrupts */
1097 if (phy_interrupt_is_valid(phydev)) {
1098 phydev->interrupts = PHY_INTERRUPT_DISABLED;
1099 if (phydev->drv->config_intr)
1100 phydev->drv->config_intr(phydev);
1103 return genphy_suspend(phydev);
1106 static int kszphy_resume(struct phy_device *phydev)
1110 genphy_resume(phydev);
1112 /* After switching from power-down to normal mode, an internal global
1113 * reset is automatically generated. Wait a minimum of 1 ms before
1114 * read/write access to the PHY registers.
1116 usleep_range(1000, 2000);
1118 ret = kszphy_config_reset(phydev);
1122 /* Enable PHY Interrupts */
1123 if (phy_interrupt_is_valid(phydev)) {
1124 phydev->interrupts = PHY_INTERRUPT_ENABLED;
1125 if (phydev->drv->config_intr)
1126 phydev->drv->config_intr(phydev);
1132 static int kszphy_probe(struct phy_device *phydev)
1134 const struct kszphy_type *type = phydev->drv->driver_data;
1135 const struct device_node *np = phydev->mdio.dev.of_node;
1136 struct kszphy_priv *priv;
1140 priv = devm_kzalloc(&phydev->mdio.dev, sizeof(*priv), GFP_KERNEL);
1144 phydev->priv = priv;
1148 if (type->led_mode_reg) {
1149 ret = of_property_read_u32(np, "micrel,led-mode",
1152 priv->led_mode = -1;
1154 if (priv->led_mode > 3) {
1155 phydev_err(phydev, "invalid led mode: 0x%02x\n",
1157 priv->led_mode = -1;
1160 priv->led_mode = -1;
1163 clk = devm_clk_get(&phydev->mdio.dev, "rmii-ref");
1164 /* NOTE: clk may be NULL if building without CONFIG_HAVE_CLK */
1165 if (!IS_ERR_OR_NULL(clk)) {
1166 unsigned long rate = clk_get_rate(clk);
1167 bool rmii_ref_clk_sel_25_mhz;
1169 priv->rmii_ref_clk_sel = type->has_rmii_ref_clk_sel;
1170 rmii_ref_clk_sel_25_mhz = of_property_read_bool(np,
1171 "micrel,rmii-reference-clock-select-25-mhz");
1173 if (rate > 24500000 && rate < 25500000) {
1174 priv->rmii_ref_clk_sel_val = rmii_ref_clk_sel_25_mhz;
1175 } else if (rate > 49500000 && rate < 50500000) {
1176 priv->rmii_ref_clk_sel_val = !rmii_ref_clk_sel_25_mhz;
1178 phydev_err(phydev, "Clock rate out of range: %ld\n",
1184 if (ksz8041_fiber_mode(phydev))
1185 phydev->port = PORT_FIBRE;
1187 /* Support legacy board-file configuration */
1188 if (phydev->dev_flags & MICREL_PHY_50MHZ_CLK) {
1189 priv->rmii_ref_clk_sel = true;
1190 priv->rmii_ref_clk_sel_val = true;
1196 static struct phy_driver ksphy_driver[] = {
1198 .phy_id = PHY_ID_KS8737,
1199 .phy_id_mask = MICREL_PHY_ID_MASK,
1200 .name = "Micrel KS8737",
1201 /* PHY_BASIC_FEATURES */
1202 .driver_data = &ks8737_type,
1203 .config_init = kszphy_config_init,
1204 .config_intr = kszphy_config_intr,
1205 .handle_interrupt = kszphy_handle_interrupt,
1206 .suspend = genphy_suspend,
1207 .resume = genphy_resume,
1209 .phy_id = PHY_ID_KSZ8021,
1210 .phy_id_mask = 0x00ffffff,
1211 .name = "Micrel KSZ8021 or KSZ8031",
1212 /* PHY_BASIC_FEATURES */
1213 .driver_data = &ksz8021_type,
1214 .probe = kszphy_probe,
1215 .config_init = kszphy_config_init,
1216 .config_intr = kszphy_config_intr,
1217 .handle_interrupt = kszphy_handle_interrupt,
1218 .get_sset_count = kszphy_get_sset_count,
1219 .get_strings = kszphy_get_strings,
1220 .get_stats = kszphy_get_stats,
1221 .suspend = genphy_suspend,
1222 .resume = genphy_resume,
1224 .phy_id = PHY_ID_KSZ8031,
1225 .phy_id_mask = 0x00ffffff,
1226 .name = "Micrel KSZ8031",
1227 /* PHY_BASIC_FEATURES */
1228 .driver_data = &ksz8021_type,
1229 .probe = kszphy_probe,
1230 .config_init = kszphy_config_init,
1231 .config_intr = kszphy_config_intr,
1232 .handle_interrupt = kszphy_handle_interrupt,
1233 .get_sset_count = kszphy_get_sset_count,
1234 .get_strings = kszphy_get_strings,
1235 .get_stats = kszphy_get_stats,
1236 .suspend = genphy_suspend,
1237 .resume = genphy_resume,
1239 .phy_id = PHY_ID_KSZ8041,
1240 .phy_id_mask = MICREL_PHY_ID_MASK,
1241 .name = "Micrel KSZ8041",
1242 /* PHY_BASIC_FEATURES */
1243 .driver_data = &ksz8041_type,
1244 .probe = kszphy_probe,
1245 .config_init = ksz8041_config_init,
1246 .config_aneg = ksz8041_config_aneg,
1247 .config_intr = kszphy_config_intr,
1248 .handle_interrupt = kszphy_handle_interrupt,
1249 .get_sset_count = kszphy_get_sset_count,
1250 .get_strings = kszphy_get_strings,
1251 .get_stats = kszphy_get_stats,
1252 .suspend = genphy_suspend,
1253 .resume = genphy_resume,
1255 .phy_id = PHY_ID_KSZ8041RNLI,
1256 .phy_id_mask = MICREL_PHY_ID_MASK,
1257 .name = "Micrel KSZ8041RNLI",
1258 /* PHY_BASIC_FEATURES */
1259 .driver_data = &ksz8041_type,
1260 .probe = kszphy_probe,
1261 .config_init = kszphy_config_init,
1262 .config_intr = kszphy_config_intr,
1263 .handle_interrupt = kszphy_handle_interrupt,
1264 .get_sset_count = kszphy_get_sset_count,
1265 .get_strings = kszphy_get_strings,
1266 .get_stats = kszphy_get_stats,
1267 .suspend = genphy_suspend,
1268 .resume = genphy_resume,
1270 .name = "Micrel KSZ8051",
1271 /* PHY_BASIC_FEATURES */
1272 .driver_data = &ksz8051_type,
1273 .probe = kszphy_probe,
1274 .config_init = kszphy_config_init,
1275 .config_intr = kszphy_config_intr,
1276 .handle_interrupt = kszphy_handle_interrupt,
1277 .get_sset_count = kszphy_get_sset_count,
1278 .get_strings = kszphy_get_strings,
1279 .get_stats = kszphy_get_stats,
1280 .match_phy_device = ksz8051_match_phy_device,
1281 .suspend = genphy_suspend,
1282 .resume = genphy_resume,
1284 .phy_id = PHY_ID_KSZ8001,
1285 .name = "Micrel KSZ8001 or KS8721",
1286 .phy_id_mask = 0x00fffffc,
1287 /* PHY_BASIC_FEATURES */
1288 .driver_data = &ksz8041_type,
1289 .probe = kszphy_probe,
1290 .config_init = kszphy_config_init,
1291 .config_intr = kszphy_config_intr,
1292 .handle_interrupt = kszphy_handle_interrupt,
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,
1299 .phy_id = PHY_ID_KSZ8081,
1300 .name = "Micrel KSZ8081 or KSZ8091",
1301 .phy_id_mask = MICREL_PHY_ID_MASK,
1302 /* PHY_BASIC_FEATURES */
1303 .driver_data = &ksz8081_type,
1304 .probe = kszphy_probe,
1305 .config_init = ksz8081_config_init,
1306 .soft_reset = genphy_soft_reset,
1307 .config_intr = kszphy_config_intr,
1308 .handle_interrupt = kszphy_handle_interrupt,
1309 .get_sset_count = kszphy_get_sset_count,
1310 .get_strings = kszphy_get_strings,
1311 .get_stats = kszphy_get_stats,
1312 .suspend = kszphy_suspend,
1313 .resume = kszphy_resume,
1315 .phy_id = PHY_ID_KSZ8061,
1316 .name = "Micrel KSZ8061",
1317 .phy_id_mask = MICREL_PHY_ID_MASK,
1318 /* PHY_BASIC_FEATURES */
1319 .config_init = ksz8061_config_init,
1320 .config_intr = kszphy_config_intr,
1321 .handle_interrupt = kszphy_handle_interrupt,
1322 .suspend = genphy_suspend,
1323 .resume = genphy_resume,
1325 .phy_id = PHY_ID_KSZ9021,
1326 .phy_id_mask = 0x000ffffe,
1327 .name = "Micrel KSZ9021 Gigabit PHY",
1328 /* PHY_GBIT_FEATURES */
1329 .driver_data = &ksz9021_type,
1330 .probe = kszphy_probe,
1331 .get_features = ksz9031_get_features,
1332 .config_init = ksz9021_config_init,
1333 .config_intr = kszphy_config_intr,
1334 .handle_interrupt = kszphy_handle_interrupt,
1335 .get_sset_count = kszphy_get_sset_count,
1336 .get_strings = kszphy_get_strings,
1337 .get_stats = kszphy_get_stats,
1338 .suspend = genphy_suspend,
1339 .resume = genphy_resume,
1340 .read_mmd = genphy_read_mmd_unsupported,
1341 .write_mmd = genphy_write_mmd_unsupported,
1343 .phy_id = PHY_ID_KSZ9031,
1344 .phy_id_mask = MICREL_PHY_ID_MASK,
1345 .name = "Micrel KSZ9031 Gigabit PHY",
1346 .driver_data = &ksz9021_type,
1347 .probe = kszphy_probe,
1348 .get_features = ksz9031_get_features,
1349 .config_init = ksz9031_config_init,
1350 .soft_reset = genphy_soft_reset,
1351 .read_status = ksz9031_read_status,
1352 .config_intr = kszphy_config_intr,
1353 .handle_interrupt = kszphy_handle_interrupt,
1354 .get_sset_count = kszphy_get_sset_count,
1355 .get_strings = kszphy_get_strings,
1356 .get_stats = kszphy_get_stats,
1357 .suspend = genphy_suspend,
1358 .resume = kszphy_resume,
1360 .phy_id = PHY_ID_LAN8814,
1361 .phy_id_mask = MICREL_PHY_ID_MASK,
1362 .name = "Microchip INDY Gigabit Quad PHY",
1363 .driver_data = &ksz9021_type,
1364 .probe = kszphy_probe,
1365 .soft_reset = genphy_soft_reset,
1366 .read_status = ksz9031_read_status,
1367 .get_sset_count = kszphy_get_sset_count,
1368 .get_strings = kszphy_get_strings,
1369 .get_stats = kszphy_get_stats,
1370 .suspend = genphy_suspend,
1371 .resume = kszphy_resume,
1373 .phy_id = PHY_ID_KSZ9131,
1374 .phy_id_mask = MICREL_PHY_ID_MASK,
1375 .name = "Microchip KSZ9131 Gigabit PHY",
1376 /* PHY_GBIT_FEATURES */
1377 .driver_data = &ksz9021_type,
1378 .probe = kszphy_probe,
1379 .config_init = ksz9131_config_init,
1380 .config_intr = kszphy_config_intr,
1381 .handle_interrupt = kszphy_handle_interrupt,
1382 .get_sset_count = kszphy_get_sset_count,
1383 .get_strings = kszphy_get_strings,
1384 .get_stats = kszphy_get_stats,
1385 .suspend = genphy_suspend,
1386 .resume = kszphy_resume,
1388 .phy_id = PHY_ID_KSZ8873MLL,
1389 .phy_id_mask = MICREL_PHY_ID_MASK,
1390 .name = "Micrel KSZ8873MLL Switch",
1391 /* PHY_BASIC_FEATURES */
1392 .config_init = kszphy_config_init,
1393 .config_aneg = ksz8873mll_config_aneg,
1394 .read_status = ksz8873mll_read_status,
1395 .suspend = genphy_suspend,
1396 .resume = genphy_resume,
1398 .phy_id = PHY_ID_KSZ886X,
1399 .phy_id_mask = MICREL_PHY_ID_MASK,
1400 .name = "Micrel KSZ8851 Ethernet MAC or KSZ886X Switch",
1401 /* PHY_BASIC_FEATURES */
1402 .config_init = kszphy_config_init,
1403 .suspend = genphy_suspend,
1404 .resume = genphy_resume,
1406 .name = "Micrel KSZ87XX Switch",
1407 /* PHY_BASIC_FEATURES */
1408 .config_init = kszphy_config_init,
1409 .config_aneg = ksz8873mll_config_aneg,
1410 .read_status = ksz8873mll_read_status,
1411 .match_phy_device = ksz8795_match_phy_device,
1412 .suspend = genphy_suspend,
1413 .resume = genphy_resume,
1415 .phy_id = PHY_ID_KSZ9477,
1416 .phy_id_mask = MICREL_PHY_ID_MASK,
1417 .name = "Microchip KSZ9477",
1418 /* PHY_GBIT_FEATURES */
1419 .config_init = kszphy_config_init,
1420 .suspend = genphy_suspend,
1421 .resume = genphy_resume,
1424 module_phy_driver(ksphy_driver);
1426 MODULE_DESCRIPTION("Micrel PHY driver");
1427 MODULE_AUTHOR("David J. Choi");
1428 MODULE_LICENSE("GPL");
1430 static struct mdio_device_id __maybe_unused micrel_tbl[] = {
1431 { PHY_ID_KSZ9021, 0x000ffffe },
1432 { PHY_ID_KSZ9031, MICREL_PHY_ID_MASK },
1433 { PHY_ID_KSZ9131, MICREL_PHY_ID_MASK },
1434 { PHY_ID_KSZ8001, 0x00fffffc },
1435 { PHY_ID_KS8737, MICREL_PHY_ID_MASK },
1436 { PHY_ID_KSZ8021, 0x00ffffff },
1437 { PHY_ID_KSZ8031, 0x00ffffff },
1438 { PHY_ID_KSZ8041, MICREL_PHY_ID_MASK },
1439 { PHY_ID_KSZ8051, MICREL_PHY_ID_MASK },
1440 { PHY_ID_KSZ8061, MICREL_PHY_ID_MASK },
1441 { PHY_ID_KSZ8081, MICREL_PHY_ID_MASK },
1442 { PHY_ID_KSZ8873MLL, MICREL_PHY_ID_MASK },
1443 { PHY_ID_KSZ886X, MICREL_PHY_ID_MASK },
1444 { PHY_ID_LAN8814, MICREL_PHY_ID_MASK },
1448 MODULE_DEVICE_TABLE(mdio, micrel_tbl);