dmaengine: imx-sdma: Let the core do the device node validation
[linux/fpc-iii.git] / drivers / net / phy / micrel.c
blob3c8186f269f9e088cee19bd509ba03e84ed58e1c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * drivers/net/phy/micrel.c
5 * Driver for Micrel PHYs
7 * Author: David J. Choi
9 * Copyright (c) 2010-2013 Micrel, Inc.
10 * Copyright (c) 2014 Johan Hovold <johan@kernel.org>
12 * Support : Micrel Phys:
13 * Giga phys: ksz9021, ksz9031, ksz9131
14 * 100/10 Phys : ksz8001, ksz8721, ksz8737, ksz8041
15 * ksz8021, ksz8031, ksz8051,
16 * ksz8081, ksz8091,
17 * ksz8061,
18 * Switch : ksz8873, ksz886x
19 * ksz9477
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/phy.h>
25 #include <linux/micrel_phy.h>
26 #include <linux/of.h>
27 #include <linux/clk.h>
29 /* Operation Mode Strap Override */
30 #define MII_KSZPHY_OMSO 0x16
31 #define KSZPHY_OMSO_FACTORY_TEST BIT(15)
32 #define KSZPHY_OMSO_B_CAST_OFF BIT(9)
33 #define KSZPHY_OMSO_NAND_TREE_ON BIT(5)
34 #define KSZPHY_OMSO_RMII_OVERRIDE BIT(1)
35 #define KSZPHY_OMSO_MII_OVERRIDE BIT(0)
37 /* general Interrupt control/status reg in vendor specific block. */
38 #define MII_KSZPHY_INTCS 0x1B
39 #define KSZPHY_INTCS_JABBER BIT(15)
40 #define KSZPHY_INTCS_RECEIVE_ERR BIT(14)
41 #define KSZPHY_INTCS_PAGE_RECEIVE BIT(13)
42 #define KSZPHY_INTCS_PARELLEL BIT(12)
43 #define KSZPHY_INTCS_LINK_PARTNER_ACK BIT(11)
44 #define KSZPHY_INTCS_LINK_DOWN BIT(10)
45 #define KSZPHY_INTCS_REMOTE_FAULT BIT(9)
46 #define KSZPHY_INTCS_LINK_UP BIT(8)
47 #define KSZPHY_INTCS_ALL (KSZPHY_INTCS_LINK_UP |\
48 KSZPHY_INTCS_LINK_DOWN)
50 /* PHY Control 1 */
51 #define MII_KSZPHY_CTRL_1 0x1e
53 /* PHY Control 2 / PHY Control (if no PHY Control 1) */
54 #define MII_KSZPHY_CTRL_2 0x1f
55 #define MII_KSZPHY_CTRL MII_KSZPHY_CTRL_2
56 /* bitmap of PHY register to set interrupt mode */
57 #define KSZPHY_CTRL_INT_ACTIVE_HIGH BIT(9)
58 #define KSZPHY_RMII_REF_CLK_SEL BIT(7)
60 /* Write/read to/from extended registers */
61 #define MII_KSZPHY_EXTREG 0x0b
62 #define KSZPHY_EXTREG_WRITE 0x8000
64 #define MII_KSZPHY_EXTREG_WRITE 0x0c
65 #define MII_KSZPHY_EXTREG_READ 0x0d
67 /* Extended registers */
68 #define MII_KSZPHY_CLK_CONTROL_PAD_SKEW 0x104
69 #define MII_KSZPHY_RX_DATA_PAD_SKEW 0x105
70 #define MII_KSZPHY_TX_DATA_PAD_SKEW 0x106
72 #define PS_TO_REG 200
74 struct kszphy_hw_stat {
75 const char *string;
76 u8 reg;
77 u8 bits;
80 static struct kszphy_hw_stat kszphy_hw_stats[] = {
81 { "phy_receive_errors", 21, 16},
82 { "phy_idle_errors", 10, 8 },
85 struct kszphy_type {
86 u32 led_mode_reg;
87 u16 interrupt_level_mask;
88 bool has_broadcast_disable;
89 bool has_nand_tree_disable;
90 bool has_rmii_ref_clk_sel;
93 struct kszphy_priv {
94 const struct kszphy_type *type;
95 int led_mode;
96 bool rmii_ref_clk_sel;
97 bool rmii_ref_clk_sel_val;
98 u64 stats[ARRAY_SIZE(kszphy_hw_stats)];
101 static const struct kszphy_type ksz8021_type = {
102 .led_mode_reg = MII_KSZPHY_CTRL_2,
103 .has_broadcast_disable = true,
104 .has_nand_tree_disable = true,
105 .has_rmii_ref_clk_sel = true,
108 static const struct kszphy_type ksz8041_type = {
109 .led_mode_reg = MII_KSZPHY_CTRL_1,
112 static const struct kszphy_type ksz8051_type = {
113 .led_mode_reg = MII_KSZPHY_CTRL_2,
114 .has_nand_tree_disable = true,
117 static const struct kszphy_type ksz8081_type = {
118 .led_mode_reg = MII_KSZPHY_CTRL_2,
119 .has_broadcast_disable = true,
120 .has_nand_tree_disable = true,
121 .has_rmii_ref_clk_sel = true,
124 static const struct kszphy_type ks8737_type = {
125 .interrupt_level_mask = BIT(14),
128 static const struct kszphy_type ksz9021_type = {
129 .interrupt_level_mask = BIT(14),
132 static int kszphy_extended_write(struct phy_device *phydev,
133 u32 regnum, u16 val)
135 phy_write(phydev, MII_KSZPHY_EXTREG, KSZPHY_EXTREG_WRITE | regnum);
136 return phy_write(phydev, MII_KSZPHY_EXTREG_WRITE, val);
139 static int kszphy_extended_read(struct phy_device *phydev,
140 u32 regnum)
142 phy_write(phydev, MII_KSZPHY_EXTREG, regnum);
143 return phy_read(phydev, MII_KSZPHY_EXTREG_READ);
146 static int kszphy_ack_interrupt(struct phy_device *phydev)
148 /* bit[7..0] int status, which is a read and clear register. */
149 int rc;
151 rc = phy_read(phydev, MII_KSZPHY_INTCS);
153 return (rc < 0) ? rc : 0;
156 static int kszphy_config_intr(struct phy_device *phydev)
158 const struct kszphy_type *type = phydev->drv->driver_data;
159 int temp;
160 u16 mask;
162 if (type && type->interrupt_level_mask)
163 mask = type->interrupt_level_mask;
164 else
165 mask = KSZPHY_CTRL_INT_ACTIVE_HIGH;
167 /* set the interrupt pin active low */
168 temp = phy_read(phydev, MII_KSZPHY_CTRL);
169 if (temp < 0)
170 return temp;
171 temp &= ~mask;
172 phy_write(phydev, MII_KSZPHY_CTRL, temp);
174 /* enable / disable interrupts */
175 if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
176 temp = KSZPHY_INTCS_ALL;
177 else
178 temp = 0;
180 return phy_write(phydev, MII_KSZPHY_INTCS, temp);
183 static int kszphy_rmii_clk_sel(struct phy_device *phydev, bool val)
185 int ctrl;
187 ctrl = phy_read(phydev, MII_KSZPHY_CTRL);
188 if (ctrl < 0)
189 return ctrl;
191 if (val)
192 ctrl |= KSZPHY_RMII_REF_CLK_SEL;
193 else
194 ctrl &= ~KSZPHY_RMII_REF_CLK_SEL;
196 return phy_write(phydev, MII_KSZPHY_CTRL, ctrl);
199 static int kszphy_setup_led(struct phy_device *phydev, u32 reg, int val)
201 int rc, temp, shift;
203 switch (reg) {
204 case MII_KSZPHY_CTRL_1:
205 shift = 14;
206 break;
207 case MII_KSZPHY_CTRL_2:
208 shift = 4;
209 break;
210 default:
211 return -EINVAL;
214 temp = phy_read(phydev, reg);
215 if (temp < 0) {
216 rc = temp;
217 goto out;
220 temp &= ~(3 << shift);
221 temp |= val << shift;
222 rc = phy_write(phydev, reg, temp);
223 out:
224 if (rc < 0)
225 phydev_err(phydev, "failed to set led mode\n");
227 return rc;
230 /* Disable PHY address 0 as the broadcast address, so that it can be used as a
231 * unique (non-broadcast) address on a shared bus.
233 static int kszphy_broadcast_disable(struct phy_device *phydev)
235 int ret;
237 ret = phy_read(phydev, MII_KSZPHY_OMSO);
238 if (ret < 0)
239 goto out;
241 ret = phy_write(phydev, MII_KSZPHY_OMSO, ret | KSZPHY_OMSO_B_CAST_OFF);
242 out:
243 if (ret)
244 phydev_err(phydev, "failed to disable broadcast address\n");
246 return ret;
249 static int kszphy_nand_tree_disable(struct phy_device *phydev)
251 int ret;
253 ret = phy_read(phydev, MII_KSZPHY_OMSO);
254 if (ret < 0)
255 goto out;
257 if (!(ret & KSZPHY_OMSO_NAND_TREE_ON))
258 return 0;
260 ret = phy_write(phydev, MII_KSZPHY_OMSO,
261 ret & ~KSZPHY_OMSO_NAND_TREE_ON);
262 out:
263 if (ret)
264 phydev_err(phydev, "failed to disable NAND tree mode\n");
266 return ret;
269 /* Some config bits need to be set again on resume, handle them here. */
270 static int kszphy_config_reset(struct phy_device *phydev)
272 struct kszphy_priv *priv = phydev->priv;
273 int ret;
275 if (priv->rmii_ref_clk_sel) {
276 ret = kszphy_rmii_clk_sel(phydev, priv->rmii_ref_clk_sel_val);
277 if (ret) {
278 phydev_err(phydev,
279 "failed to set rmii reference clock\n");
280 return ret;
284 if (priv->led_mode >= 0)
285 kszphy_setup_led(phydev, priv->type->led_mode_reg, priv->led_mode);
287 return 0;
290 static int kszphy_config_init(struct phy_device *phydev)
292 struct kszphy_priv *priv = phydev->priv;
293 const struct kszphy_type *type;
295 if (!priv)
296 return 0;
298 type = priv->type;
300 if (type->has_broadcast_disable)
301 kszphy_broadcast_disable(phydev);
303 if (type->has_nand_tree_disable)
304 kszphy_nand_tree_disable(phydev);
306 return kszphy_config_reset(phydev);
309 static int ksz8041_config_init(struct phy_device *phydev)
311 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
313 struct device_node *of_node = phydev->mdio.dev.of_node;
315 /* Limit supported and advertised modes in fiber mode */
316 if (of_property_read_bool(of_node, "micrel,fiber-mode")) {
317 phydev->dev_flags |= MICREL_PHY_FXEN;
318 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, mask);
319 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, mask);
321 linkmode_and(phydev->supported, phydev->supported, mask);
322 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
323 phydev->supported);
324 linkmode_and(phydev->advertising, phydev->advertising, mask);
325 linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT,
326 phydev->advertising);
327 phydev->autoneg = AUTONEG_DISABLE;
330 return kszphy_config_init(phydev);
333 static int ksz8041_config_aneg(struct phy_device *phydev)
335 /* Skip auto-negotiation in fiber mode */
336 if (phydev->dev_flags & MICREL_PHY_FXEN) {
337 phydev->speed = SPEED_100;
338 return 0;
341 return genphy_config_aneg(phydev);
344 static int ksz8081_config_init(struct phy_device *phydev)
346 /* KSZPHY_OMSO_FACTORY_TEST is set at de-assertion of the reset line
347 * based on the RXER (KSZ8081RNA/RND) or TXC (KSZ8081MNX/RNB) pin. If a
348 * pull-down is missing, the factory test mode should be cleared by
349 * manually writing a 0.
351 phy_clear_bits(phydev, MII_KSZPHY_OMSO, KSZPHY_OMSO_FACTORY_TEST);
353 return kszphy_config_init(phydev);
356 static int ksz8061_config_init(struct phy_device *phydev)
358 int ret;
360 ret = phy_write_mmd(phydev, MDIO_MMD_PMAPMD, MDIO_DEVID1, 0xB61A);
361 if (ret)
362 return ret;
364 return kszphy_config_init(phydev);
367 static int ksz9021_load_values_from_of(struct phy_device *phydev,
368 const struct device_node *of_node,
369 u16 reg,
370 const char *field1, const char *field2,
371 const char *field3, const char *field4)
373 int val1 = -1;
374 int val2 = -2;
375 int val3 = -3;
376 int val4 = -4;
377 int newval;
378 int matches = 0;
380 if (!of_property_read_u32(of_node, field1, &val1))
381 matches++;
383 if (!of_property_read_u32(of_node, field2, &val2))
384 matches++;
386 if (!of_property_read_u32(of_node, field3, &val3))
387 matches++;
389 if (!of_property_read_u32(of_node, field4, &val4))
390 matches++;
392 if (!matches)
393 return 0;
395 if (matches < 4)
396 newval = kszphy_extended_read(phydev, reg);
397 else
398 newval = 0;
400 if (val1 != -1)
401 newval = ((newval & 0xfff0) | ((val1 / PS_TO_REG) & 0xf) << 0);
403 if (val2 != -2)
404 newval = ((newval & 0xff0f) | ((val2 / PS_TO_REG) & 0xf) << 4);
406 if (val3 != -3)
407 newval = ((newval & 0xf0ff) | ((val3 / PS_TO_REG) & 0xf) << 8);
409 if (val4 != -4)
410 newval = ((newval & 0x0fff) | ((val4 / PS_TO_REG) & 0xf) << 12);
412 return kszphy_extended_write(phydev, reg, newval);
415 static int ksz9021_config_init(struct phy_device *phydev)
417 const struct device *dev = &phydev->mdio.dev;
418 const struct device_node *of_node = dev->of_node;
419 const struct device *dev_walker;
421 /* The Micrel driver has a deprecated option to place phy OF
422 * properties in the MAC node. Walk up the tree of devices to
423 * find a device with an OF node.
425 dev_walker = &phydev->mdio.dev;
426 do {
427 of_node = dev_walker->of_node;
428 dev_walker = dev_walker->parent;
430 } while (!of_node && dev_walker);
432 if (of_node) {
433 ksz9021_load_values_from_of(phydev, of_node,
434 MII_KSZPHY_CLK_CONTROL_PAD_SKEW,
435 "txen-skew-ps", "txc-skew-ps",
436 "rxdv-skew-ps", "rxc-skew-ps");
437 ksz9021_load_values_from_of(phydev, of_node,
438 MII_KSZPHY_RX_DATA_PAD_SKEW,
439 "rxd0-skew-ps", "rxd1-skew-ps",
440 "rxd2-skew-ps", "rxd3-skew-ps");
441 ksz9021_load_values_from_of(phydev, of_node,
442 MII_KSZPHY_TX_DATA_PAD_SKEW,
443 "txd0-skew-ps", "txd1-skew-ps",
444 "txd2-skew-ps", "txd3-skew-ps");
446 return 0;
449 #define KSZ9031_PS_TO_REG 60
451 /* Extended registers */
452 /* MMD Address 0x0 */
453 #define MII_KSZ9031RN_FLP_BURST_TX_LO 3
454 #define MII_KSZ9031RN_FLP_BURST_TX_HI 4
456 /* MMD Address 0x2 */
457 #define MII_KSZ9031RN_CONTROL_PAD_SKEW 4
458 #define MII_KSZ9031RN_RX_DATA_PAD_SKEW 5
459 #define MII_KSZ9031RN_TX_DATA_PAD_SKEW 6
460 #define MII_KSZ9031RN_CLK_PAD_SKEW 8
462 /* MMD Address 0x1C */
463 #define MII_KSZ9031RN_EDPD 0x23
464 #define MII_KSZ9031RN_EDPD_ENABLE BIT(0)
466 static int ksz9031_of_load_skew_values(struct phy_device *phydev,
467 const struct device_node *of_node,
468 u16 reg, size_t field_sz,
469 const char *field[], u8 numfields)
471 int val[4] = {-1, -2, -3, -4};
472 int matches = 0;
473 u16 mask;
474 u16 maxval;
475 u16 newval;
476 int i;
478 for (i = 0; i < numfields; i++)
479 if (!of_property_read_u32(of_node, field[i], val + i))
480 matches++;
482 if (!matches)
483 return 0;
485 if (matches < numfields)
486 newval = phy_read_mmd(phydev, 2, reg);
487 else
488 newval = 0;
490 maxval = (field_sz == 4) ? 0xf : 0x1f;
491 for (i = 0; i < numfields; i++)
492 if (val[i] != -(i + 1)) {
493 mask = 0xffff;
494 mask ^= maxval << (field_sz * i);
495 newval = (newval & mask) |
496 (((val[i] / KSZ9031_PS_TO_REG) & maxval)
497 << (field_sz * i));
500 return phy_write_mmd(phydev, 2, reg, newval);
503 /* Center KSZ9031RNX FLP timing at 16ms. */
504 static int ksz9031_center_flp_timing(struct phy_device *phydev)
506 int result;
508 result = phy_write_mmd(phydev, 0, MII_KSZ9031RN_FLP_BURST_TX_HI,
509 0x0006);
510 if (result)
511 return result;
513 result = phy_write_mmd(phydev, 0, MII_KSZ9031RN_FLP_BURST_TX_LO,
514 0x1A80);
515 if (result)
516 return result;
518 return genphy_restart_aneg(phydev);
521 /* Enable energy-detect power-down mode */
522 static int ksz9031_enable_edpd(struct phy_device *phydev)
524 int reg;
526 reg = phy_read_mmd(phydev, 0x1C, MII_KSZ9031RN_EDPD);
527 if (reg < 0)
528 return reg;
529 return phy_write_mmd(phydev, 0x1C, MII_KSZ9031RN_EDPD,
530 reg | MII_KSZ9031RN_EDPD_ENABLE);
533 static int ksz9031_config_init(struct phy_device *phydev)
535 const struct device *dev = &phydev->mdio.dev;
536 const struct device_node *of_node = dev->of_node;
537 static const char *clk_skews[2] = {"rxc-skew-ps", "txc-skew-ps"};
538 static const char *rx_data_skews[4] = {
539 "rxd0-skew-ps", "rxd1-skew-ps",
540 "rxd2-skew-ps", "rxd3-skew-ps"
542 static const char *tx_data_skews[4] = {
543 "txd0-skew-ps", "txd1-skew-ps",
544 "txd2-skew-ps", "txd3-skew-ps"
546 static const char *control_skews[2] = {"txen-skew-ps", "rxdv-skew-ps"};
547 const struct device *dev_walker;
548 int result;
550 result = ksz9031_enable_edpd(phydev);
551 if (result < 0)
552 return result;
554 /* The Micrel driver has a deprecated option to place phy OF
555 * properties in the MAC node. Walk up the tree of devices to
556 * find a device with an OF node.
558 dev_walker = &phydev->mdio.dev;
559 do {
560 of_node = dev_walker->of_node;
561 dev_walker = dev_walker->parent;
562 } while (!of_node && dev_walker);
564 if (of_node) {
565 ksz9031_of_load_skew_values(phydev, of_node,
566 MII_KSZ9031RN_CLK_PAD_SKEW, 5,
567 clk_skews, 2);
569 ksz9031_of_load_skew_values(phydev, of_node,
570 MII_KSZ9031RN_CONTROL_PAD_SKEW, 4,
571 control_skews, 2);
573 ksz9031_of_load_skew_values(phydev, of_node,
574 MII_KSZ9031RN_RX_DATA_PAD_SKEW, 4,
575 rx_data_skews, 4);
577 ksz9031_of_load_skew_values(phydev, of_node,
578 MII_KSZ9031RN_TX_DATA_PAD_SKEW, 4,
579 tx_data_skews, 4);
581 /* Silicon Errata Sheet (DS80000691D or DS80000692D):
582 * When the device links in the 1000BASE-T slave mode only,
583 * the optional 125MHz reference output clock (CLK125_NDO)
584 * has wide duty cycle variation.
586 * The optional CLK125_NDO clock does not meet the RGMII
587 * 45/55 percent (min/max) duty cycle requirement and therefore
588 * cannot be used directly by the MAC side for clocking
589 * applications that have setup/hold time requirements on
590 * rising and falling clock edges.
592 * Workaround:
593 * Force the phy to be the master to receive a stable clock
594 * which meets the duty cycle requirement.
596 if (of_property_read_bool(of_node, "micrel,force-master")) {
597 result = phy_read(phydev, MII_CTRL1000);
598 if (result < 0)
599 goto err_force_master;
601 /* enable master mode, config & prefer master */
602 result |= CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER;
603 result = phy_write(phydev, MII_CTRL1000, result);
604 if (result < 0)
605 goto err_force_master;
609 return ksz9031_center_flp_timing(phydev);
611 err_force_master:
612 phydev_err(phydev, "failed to force the phy to master mode\n");
613 return result;
616 #define KSZ9131_SKEW_5BIT_MAX 2400
617 #define KSZ9131_SKEW_4BIT_MAX 800
618 #define KSZ9131_OFFSET 700
619 #define KSZ9131_STEP 100
621 static int ksz9131_of_load_skew_values(struct phy_device *phydev,
622 struct device_node *of_node,
623 u16 reg, size_t field_sz,
624 char *field[], u8 numfields)
626 int val[4] = {-(1 + KSZ9131_OFFSET), -(2 + KSZ9131_OFFSET),
627 -(3 + KSZ9131_OFFSET), -(4 + KSZ9131_OFFSET)};
628 int skewval, skewmax = 0;
629 int matches = 0;
630 u16 maxval;
631 u16 newval;
632 u16 mask;
633 int i;
635 /* psec properties in dts should mean x pico seconds */
636 if (field_sz == 5)
637 skewmax = KSZ9131_SKEW_5BIT_MAX;
638 else
639 skewmax = KSZ9131_SKEW_4BIT_MAX;
641 for (i = 0; i < numfields; i++)
642 if (!of_property_read_s32(of_node, field[i], &skewval)) {
643 if (skewval < -KSZ9131_OFFSET)
644 skewval = -KSZ9131_OFFSET;
645 else if (skewval > skewmax)
646 skewval = skewmax;
648 val[i] = skewval + KSZ9131_OFFSET;
649 matches++;
652 if (!matches)
653 return 0;
655 if (matches < numfields)
656 newval = phy_read_mmd(phydev, 2, reg);
657 else
658 newval = 0;
660 maxval = (field_sz == 4) ? 0xf : 0x1f;
661 for (i = 0; i < numfields; i++)
662 if (val[i] != -(i + 1 + KSZ9131_OFFSET)) {
663 mask = 0xffff;
664 mask ^= maxval << (field_sz * i);
665 newval = (newval & mask) |
666 (((val[i] / KSZ9131_STEP) & maxval)
667 << (field_sz * i));
670 return phy_write_mmd(phydev, 2, reg, newval);
673 static int ksz9131_config_init(struct phy_device *phydev)
675 const struct device *dev = &phydev->mdio.dev;
676 struct device_node *of_node = dev->of_node;
677 char *clk_skews[2] = {"rxc-skew-psec", "txc-skew-psec"};
678 char *rx_data_skews[4] = {
679 "rxd0-skew-psec", "rxd1-skew-psec",
680 "rxd2-skew-psec", "rxd3-skew-psec"
682 char *tx_data_skews[4] = {
683 "txd0-skew-psec", "txd1-skew-psec",
684 "txd2-skew-psec", "txd3-skew-psec"
686 char *control_skews[2] = {"txen-skew-psec", "rxdv-skew-psec"};
687 const struct device *dev_walker;
688 int ret;
690 dev_walker = &phydev->mdio.dev;
691 do {
692 of_node = dev_walker->of_node;
693 dev_walker = dev_walker->parent;
694 } while (!of_node && dev_walker);
696 if (!of_node)
697 return 0;
699 ret = ksz9131_of_load_skew_values(phydev, of_node,
700 MII_KSZ9031RN_CLK_PAD_SKEW, 5,
701 clk_skews, 2);
702 if (ret < 0)
703 return ret;
705 ret = ksz9131_of_load_skew_values(phydev, of_node,
706 MII_KSZ9031RN_CONTROL_PAD_SKEW, 4,
707 control_skews, 2);
708 if (ret < 0)
709 return ret;
711 ret = ksz9131_of_load_skew_values(phydev, of_node,
712 MII_KSZ9031RN_RX_DATA_PAD_SKEW, 4,
713 rx_data_skews, 4);
714 if (ret < 0)
715 return ret;
717 ret = ksz9131_of_load_skew_values(phydev, of_node,
718 MII_KSZ9031RN_TX_DATA_PAD_SKEW, 4,
719 tx_data_skews, 4);
720 if (ret < 0)
721 return ret;
723 return 0;
726 #define KSZ8873MLL_GLOBAL_CONTROL_4 0x06
727 #define KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX BIT(6)
728 #define KSZ8873MLL_GLOBAL_CONTROL_4_SPEED BIT(4)
729 static int ksz8873mll_read_status(struct phy_device *phydev)
731 int regval;
733 /* dummy read */
734 regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
736 regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
738 if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX)
739 phydev->duplex = DUPLEX_HALF;
740 else
741 phydev->duplex = DUPLEX_FULL;
743 if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_SPEED)
744 phydev->speed = SPEED_10;
745 else
746 phydev->speed = SPEED_100;
748 phydev->link = 1;
749 phydev->pause = phydev->asym_pause = 0;
751 return 0;
754 static int ksz9031_get_features(struct phy_device *phydev)
756 int ret;
758 ret = genphy_read_abilities(phydev);
759 if (ret < 0)
760 return ret;
762 /* Silicon Errata Sheet (DS80000691D or DS80000692D):
763 * Whenever the device's Asymmetric Pause capability is set to 1,
764 * link-up may fail after a link-up to link-down transition.
766 * Workaround:
767 * Do not enable the Asymmetric Pause capability bit.
769 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
771 /* We force setting the Pause capability as the core will force the
772 * Asymmetric Pause capability to 1 otherwise.
774 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
776 return 0;
779 static int ksz9031_read_status(struct phy_device *phydev)
781 int err;
782 int regval;
784 err = genphy_read_status(phydev);
785 if (err)
786 return err;
788 /* Make sure the PHY is not broken. Read idle error count,
789 * and reset the PHY if it is maxed out.
791 regval = phy_read(phydev, MII_STAT1000);
792 if ((regval & 0xFF) == 0xFF) {
793 phy_init_hw(phydev);
794 phydev->link = 0;
795 if (phydev->drv->config_intr && phy_interrupt_is_valid(phydev))
796 phydev->drv->config_intr(phydev);
797 return genphy_config_aneg(phydev);
800 return 0;
803 static int ksz8873mll_config_aneg(struct phy_device *phydev)
805 return 0;
808 static int kszphy_get_sset_count(struct phy_device *phydev)
810 return ARRAY_SIZE(kszphy_hw_stats);
813 static void kszphy_get_strings(struct phy_device *phydev, u8 *data)
815 int i;
817 for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++) {
818 strlcpy(data + i * ETH_GSTRING_LEN,
819 kszphy_hw_stats[i].string, ETH_GSTRING_LEN);
823 static u64 kszphy_get_stat(struct phy_device *phydev, int i)
825 struct kszphy_hw_stat stat = kszphy_hw_stats[i];
826 struct kszphy_priv *priv = phydev->priv;
827 int val;
828 u64 ret;
830 val = phy_read(phydev, stat.reg);
831 if (val < 0) {
832 ret = U64_MAX;
833 } else {
834 val = val & ((1 << stat.bits) - 1);
835 priv->stats[i] += val;
836 ret = priv->stats[i];
839 return ret;
842 static void kszphy_get_stats(struct phy_device *phydev,
843 struct ethtool_stats *stats, u64 *data)
845 int i;
847 for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++)
848 data[i] = kszphy_get_stat(phydev, i);
851 static int kszphy_suspend(struct phy_device *phydev)
853 /* Disable PHY Interrupts */
854 if (phy_interrupt_is_valid(phydev)) {
855 phydev->interrupts = PHY_INTERRUPT_DISABLED;
856 if (phydev->drv->config_intr)
857 phydev->drv->config_intr(phydev);
860 return genphy_suspend(phydev);
863 static int kszphy_resume(struct phy_device *phydev)
865 int ret;
867 genphy_resume(phydev);
869 ret = kszphy_config_reset(phydev);
870 if (ret)
871 return ret;
873 /* Enable PHY Interrupts */
874 if (phy_interrupt_is_valid(phydev)) {
875 phydev->interrupts = PHY_INTERRUPT_ENABLED;
876 if (phydev->drv->config_intr)
877 phydev->drv->config_intr(phydev);
880 return 0;
883 static int kszphy_probe(struct phy_device *phydev)
885 const struct kszphy_type *type = phydev->drv->driver_data;
886 const struct device_node *np = phydev->mdio.dev.of_node;
887 struct kszphy_priv *priv;
888 struct clk *clk;
889 int ret;
891 priv = devm_kzalloc(&phydev->mdio.dev, sizeof(*priv), GFP_KERNEL);
892 if (!priv)
893 return -ENOMEM;
895 phydev->priv = priv;
897 priv->type = type;
899 if (type->led_mode_reg) {
900 ret = of_property_read_u32(np, "micrel,led-mode",
901 &priv->led_mode);
902 if (ret)
903 priv->led_mode = -1;
905 if (priv->led_mode > 3) {
906 phydev_err(phydev, "invalid led mode: 0x%02x\n",
907 priv->led_mode);
908 priv->led_mode = -1;
910 } else {
911 priv->led_mode = -1;
914 clk = devm_clk_get(&phydev->mdio.dev, "rmii-ref");
915 /* NOTE: clk may be NULL if building without CONFIG_HAVE_CLK */
916 if (!IS_ERR_OR_NULL(clk)) {
917 unsigned long rate = clk_get_rate(clk);
918 bool rmii_ref_clk_sel_25_mhz;
920 priv->rmii_ref_clk_sel = type->has_rmii_ref_clk_sel;
921 rmii_ref_clk_sel_25_mhz = of_property_read_bool(np,
922 "micrel,rmii-reference-clock-select-25-mhz");
924 if (rate > 24500000 && rate < 25500000) {
925 priv->rmii_ref_clk_sel_val = rmii_ref_clk_sel_25_mhz;
926 } else if (rate > 49500000 && rate < 50500000) {
927 priv->rmii_ref_clk_sel_val = !rmii_ref_clk_sel_25_mhz;
928 } else {
929 phydev_err(phydev, "Clock rate out of range: %ld\n",
930 rate);
931 return -EINVAL;
935 /* Support legacy board-file configuration */
936 if (phydev->dev_flags & MICREL_PHY_50MHZ_CLK) {
937 priv->rmii_ref_clk_sel = true;
938 priv->rmii_ref_clk_sel_val = true;
941 return 0;
944 static struct phy_driver ksphy_driver[] = {
946 .phy_id = PHY_ID_KS8737,
947 .phy_id_mask = MICREL_PHY_ID_MASK,
948 .name = "Micrel KS8737",
949 /* PHY_BASIC_FEATURES */
950 .driver_data = &ks8737_type,
951 .config_init = kszphy_config_init,
952 .ack_interrupt = kszphy_ack_interrupt,
953 .config_intr = kszphy_config_intr,
954 .suspend = genphy_suspend,
955 .resume = genphy_resume,
956 }, {
957 .phy_id = PHY_ID_KSZ8021,
958 .phy_id_mask = 0x00ffffff,
959 .name = "Micrel KSZ8021 or KSZ8031",
960 /* PHY_BASIC_FEATURES */
961 .driver_data = &ksz8021_type,
962 .probe = kszphy_probe,
963 .config_init = kszphy_config_init,
964 .ack_interrupt = kszphy_ack_interrupt,
965 .config_intr = kszphy_config_intr,
966 .get_sset_count = kszphy_get_sset_count,
967 .get_strings = kszphy_get_strings,
968 .get_stats = kszphy_get_stats,
969 .suspend = genphy_suspend,
970 .resume = genphy_resume,
971 }, {
972 .phy_id = PHY_ID_KSZ8031,
973 .phy_id_mask = 0x00ffffff,
974 .name = "Micrel KSZ8031",
975 /* PHY_BASIC_FEATURES */
976 .driver_data = &ksz8021_type,
977 .probe = kszphy_probe,
978 .config_init = kszphy_config_init,
979 .ack_interrupt = kszphy_ack_interrupt,
980 .config_intr = kszphy_config_intr,
981 .get_sset_count = kszphy_get_sset_count,
982 .get_strings = kszphy_get_strings,
983 .get_stats = kszphy_get_stats,
984 .suspend = genphy_suspend,
985 .resume = genphy_resume,
986 }, {
987 .phy_id = PHY_ID_KSZ8041,
988 .phy_id_mask = MICREL_PHY_ID_MASK,
989 .name = "Micrel KSZ8041",
990 /* PHY_BASIC_FEATURES */
991 .driver_data = &ksz8041_type,
992 .probe = kszphy_probe,
993 .config_init = ksz8041_config_init,
994 .config_aneg = ksz8041_config_aneg,
995 .ack_interrupt = kszphy_ack_interrupt,
996 .config_intr = kszphy_config_intr,
997 .get_sset_count = kszphy_get_sset_count,
998 .get_strings = kszphy_get_strings,
999 .get_stats = kszphy_get_stats,
1000 .suspend = genphy_suspend,
1001 .resume = genphy_resume,
1002 }, {
1003 .phy_id = PHY_ID_KSZ8041RNLI,
1004 .phy_id_mask = MICREL_PHY_ID_MASK,
1005 .name = "Micrel KSZ8041RNLI",
1006 /* PHY_BASIC_FEATURES */
1007 .driver_data = &ksz8041_type,
1008 .probe = kszphy_probe,
1009 .config_init = kszphy_config_init,
1010 .ack_interrupt = kszphy_ack_interrupt,
1011 .config_intr = kszphy_config_intr,
1012 .get_sset_count = kszphy_get_sset_count,
1013 .get_strings = kszphy_get_strings,
1014 .get_stats = kszphy_get_stats,
1015 .suspend = genphy_suspend,
1016 .resume = genphy_resume,
1017 }, {
1018 .phy_id = PHY_ID_KSZ8051,
1019 .phy_id_mask = MICREL_PHY_ID_MASK,
1020 .name = "Micrel KSZ8051",
1021 /* PHY_BASIC_FEATURES */
1022 .driver_data = &ksz8051_type,
1023 .probe = kszphy_probe,
1024 .config_init = kszphy_config_init,
1025 .ack_interrupt = kszphy_ack_interrupt,
1026 .config_intr = kszphy_config_intr,
1027 .get_sset_count = kszphy_get_sset_count,
1028 .get_strings = kszphy_get_strings,
1029 .get_stats = kszphy_get_stats,
1030 .suspend = genphy_suspend,
1031 .resume = genphy_resume,
1032 }, {
1033 .phy_id = PHY_ID_KSZ8001,
1034 .name = "Micrel KSZ8001 or KS8721",
1035 .phy_id_mask = 0x00fffffc,
1036 /* PHY_BASIC_FEATURES */
1037 .driver_data = &ksz8041_type,
1038 .probe = kszphy_probe,
1039 .config_init = kszphy_config_init,
1040 .ack_interrupt = kszphy_ack_interrupt,
1041 .config_intr = kszphy_config_intr,
1042 .get_sset_count = kszphy_get_sset_count,
1043 .get_strings = kszphy_get_strings,
1044 .get_stats = kszphy_get_stats,
1045 .suspend = genphy_suspend,
1046 .resume = genphy_resume,
1047 }, {
1048 .phy_id = PHY_ID_KSZ8081,
1049 .name = "Micrel KSZ8081 or KSZ8091",
1050 .phy_id_mask = MICREL_PHY_ID_MASK,
1051 /* PHY_BASIC_FEATURES */
1052 .driver_data = &ksz8081_type,
1053 .probe = kszphy_probe,
1054 .config_init = ksz8081_config_init,
1055 .ack_interrupt = kszphy_ack_interrupt,
1056 .config_intr = kszphy_config_intr,
1057 .get_sset_count = kszphy_get_sset_count,
1058 .get_strings = kszphy_get_strings,
1059 .get_stats = kszphy_get_stats,
1060 .suspend = kszphy_suspend,
1061 .resume = kszphy_resume,
1062 }, {
1063 .phy_id = PHY_ID_KSZ8061,
1064 .name = "Micrel KSZ8061",
1065 .phy_id_mask = MICREL_PHY_ID_MASK,
1066 /* PHY_BASIC_FEATURES */
1067 .config_init = ksz8061_config_init,
1068 .ack_interrupt = kszphy_ack_interrupt,
1069 .config_intr = kszphy_config_intr,
1070 .suspend = genphy_suspend,
1071 .resume = genphy_resume,
1072 }, {
1073 .phy_id = PHY_ID_KSZ9021,
1074 .phy_id_mask = 0x000ffffe,
1075 .name = "Micrel KSZ9021 Gigabit PHY",
1076 /* PHY_GBIT_FEATURES */
1077 .driver_data = &ksz9021_type,
1078 .probe = kszphy_probe,
1079 .config_init = ksz9021_config_init,
1080 .ack_interrupt = kszphy_ack_interrupt,
1081 .config_intr = kszphy_config_intr,
1082 .get_sset_count = kszphy_get_sset_count,
1083 .get_strings = kszphy_get_strings,
1084 .get_stats = kszphy_get_stats,
1085 .suspend = genphy_suspend,
1086 .resume = genphy_resume,
1087 .read_mmd = genphy_read_mmd_unsupported,
1088 .write_mmd = genphy_write_mmd_unsupported,
1089 }, {
1090 .phy_id = PHY_ID_KSZ9031,
1091 .phy_id_mask = MICREL_PHY_ID_MASK,
1092 .name = "Micrel KSZ9031 Gigabit PHY",
1093 .driver_data = &ksz9021_type,
1094 .probe = kszphy_probe,
1095 .get_features = ksz9031_get_features,
1096 .config_init = ksz9031_config_init,
1097 .soft_reset = genphy_soft_reset,
1098 .read_status = ksz9031_read_status,
1099 .ack_interrupt = kszphy_ack_interrupt,
1100 .config_intr = kszphy_config_intr,
1101 .get_sset_count = kszphy_get_sset_count,
1102 .get_strings = kszphy_get_strings,
1103 .get_stats = kszphy_get_stats,
1104 .suspend = genphy_suspend,
1105 .resume = kszphy_resume,
1106 }, {
1107 .phy_id = PHY_ID_KSZ9131,
1108 .phy_id_mask = MICREL_PHY_ID_MASK,
1109 .name = "Microchip KSZ9131 Gigabit PHY",
1110 /* PHY_GBIT_FEATURES */
1111 .driver_data = &ksz9021_type,
1112 .probe = kszphy_probe,
1113 .config_init = ksz9131_config_init,
1114 .read_status = ksz9031_read_status,
1115 .ack_interrupt = kszphy_ack_interrupt,
1116 .config_intr = kszphy_config_intr,
1117 .get_sset_count = kszphy_get_sset_count,
1118 .get_strings = kszphy_get_strings,
1119 .get_stats = kszphy_get_stats,
1120 .suspend = genphy_suspend,
1121 .resume = kszphy_resume,
1122 }, {
1123 .phy_id = PHY_ID_KSZ8873MLL,
1124 .phy_id_mask = MICREL_PHY_ID_MASK,
1125 .name = "Micrel KSZ8873MLL Switch",
1126 /* PHY_BASIC_FEATURES */
1127 .config_init = kszphy_config_init,
1128 .config_aneg = ksz8873mll_config_aneg,
1129 .read_status = ksz8873mll_read_status,
1130 .suspend = genphy_suspend,
1131 .resume = genphy_resume,
1132 }, {
1133 .phy_id = PHY_ID_KSZ886X,
1134 .phy_id_mask = MICREL_PHY_ID_MASK,
1135 .name = "Micrel KSZ886X Switch",
1136 /* PHY_BASIC_FEATURES */
1137 .config_init = kszphy_config_init,
1138 .suspend = genphy_suspend,
1139 .resume = genphy_resume,
1140 }, {
1141 .phy_id = PHY_ID_KSZ8795,
1142 .phy_id_mask = MICREL_PHY_ID_MASK,
1143 .name = "Micrel KSZ8795",
1144 /* PHY_BASIC_FEATURES */
1145 .config_init = kszphy_config_init,
1146 .config_aneg = ksz8873mll_config_aneg,
1147 .read_status = ksz8873mll_read_status,
1148 .suspend = genphy_suspend,
1149 .resume = genphy_resume,
1150 }, {
1151 .phy_id = PHY_ID_KSZ9477,
1152 .phy_id_mask = MICREL_PHY_ID_MASK,
1153 .name = "Microchip KSZ9477",
1154 /* PHY_GBIT_FEATURES */
1155 .config_init = kszphy_config_init,
1156 .suspend = genphy_suspend,
1157 .resume = genphy_resume,
1158 } };
1160 module_phy_driver(ksphy_driver);
1162 MODULE_DESCRIPTION("Micrel PHY driver");
1163 MODULE_AUTHOR("David J. Choi");
1164 MODULE_LICENSE("GPL");
1166 static struct mdio_device_id __maybe_unused micrel_tbl[] = {
1167 { PHY_ID_KSZ9021, 0x000ffffe },
1168 { PHY_ID_KSZ9031, MICREL_PHY_ID_MASK },
1169 { PHY_ID_KSZ9131, MICREL_PHY_ID_MASK },
1170 { PHY_ID_KSZ8001, 0x00fffffc },
1171 { PHY_ID_KS8737, MICREL_PHY_ID_MASK },
1172 { PHY_ID_KSZ8021, 0x00ffffff },
1173 { PHY_ID_KSZ8031, 0x00ffffff },
1174 { PHY_ID_KSZ8041, MICREL_PHY_ID_MASK },
1175 { PHY_ID_KSZ8051, MICREL_PHY_ID_MASK },
1176 { PHY_ID_KSZ8061, MICREL_PHY_ID_MASK },
1177 { PHY_ID_KSZ8081, MICREL_PHY_ID_MASK },
1178 { PHY_ID_KSZ8873MLL, MICREL_PHY_ID_MASK },
1179 { PHY_ID_KSZ886X, MICREL_PHY_ID_MASK },
1183 MODULE_DEVICE_TABLE(mdio, micrel_tbl);