linux/drivers/net/phy/micrel.c
<<
>>
Prefs
   1/*
   2 * drivers/net/phy/micrel.c
   3 *
   4 * Driver for Micrel PHYs
   5 *
   6 * Author: David J. Choi
   7 *
   8 * Copyright (c) 2010-2013 Micrel, Inc.
   9 * Copyright (c) 2014 Johan Hovold <johan@kernel.org>
  10 *
  11 * This program is free software; you can redistribute  it and/or modify it
  12 * under  the terms of  the GNU General  Public License as published by the
  13 * Free Software Foundation;  either version 2 of the  License, or (at your
  14 * option) any later version.
  15 *
  16 * Support : Micrel Phys:
  17 *              Giga phys: ksz9021, ksz9031
  18 *              100/10 Phys : ksz8001, ksz8721, ksz8737, ksz8041
  19 *                         ksz8021, ksz8031, ksz8051,
  20 *                         ksz8081, ksz8091,
  21 *                         ksz8061,
  22 *              Switch : ksz8873, ksz886x
  23 *                       ksz9477
  24 */
  25
  26#include <linux/kernel.h>
  27#include <linux/module.h>
  28#include <linux/phy.h>
  29#include <linux/micrel_phy.h>
  30#include <linux/of.h>
  31#include <linux/clk.h>
  32
  33/* Operation Mode Strap Override */
  34#define MII_KSZPHY_OMSO                         0x16
  35#define KSZPHY_OMSO_B_CAST_OFF                  BIT(9)
  36#define KSZPHY_OMSO_NAND_TREE_ON                BIT(5)
  37#define KSZPHY_OMSO_RMII_OVERRIDE               BIT(1)
  38#define KSZPHY_OMSO_MII_OVERRIDE                BIT(0)
  39
  40/* general Interrupt control/status reg in vendor specific block. */
  41#define MII_KSZPHY_INTCS                        0x1B
  42#define KSZPHY_INTCS_JABBER                     BIT(15)
  43#define KSZPHY_INTCS_RECEIVE_ERR                BIT(14)
  44#define KSZPHY_INTCS_PAGE_RECEIVE               BIT(13)
  45#define KSZPHY_INTCS_PARELLEL                   BIT(12)
  46#define KSZPHY_INTCS_LINK_PARTNER_ACK           BIT(11)
  47#define KSZPHY_INTCS_LINK_DOWN                  BIT(10)
  48#define KSZPHY_INTCS_REMOTE_FAULT               BIT(9)
  49#define KSZPHY_INTCS_LINK_UP                    BIT(8)
  50#define KSZPHY_INTCS_ALL                        (KSZPHY_INTCS_LINK_UP |\
  51                                                KSZPHY_INTCS_LINK_DOWN)
  52
  53/* PHY Control 1 */
  54#define MII_KSZPHY_CTRL_1                       0x1e
  55
  56/* PHY Control 2 / PHY Control (if no PHY Control 1) */
  57#define MII_KSZPHY_CTRL_2                       0x1f
  58#define MII_KSZPHY_CTRL                         MII_KSZPHY_CTRL_2
  59/* bitmap of PHY register to set interrupt mode */
  60#define KSZPHY_CTRL_INT_ACTIVE_HIGH             BIT(9)
  61#define KSZPHY_RMII_REF_CLK_SEL                 BIT(7)
  62
  63/* Write/read to/from extended registers */
  64#define MII_KSZPHY_EXTREG                       0x0b
  65#define KSZPHY_EXTREG_WRITE                     0x8000
  66
  67#define MII_KSZPHY_EXTREG_WRITE                 0x0c
  68#define MII_KSZPHY_EXTREG_READ                  0x0d
  69
  70/* Extended registers */
  71#define MII_KSZPHY_CLK_CONTROL_PAD_SKEW         0x104
  72#define MII_KSZPHY_RX_DATA_PAD_SKEW             0x105
  73#define MII_KSZPHY_TX_DATA_PAD_SKEW             0x106
  74
  75#define PS_TO_REG                               200
  76
  77struct kszphy_hw_stat {
  78        const char *string;
  79        u8 reg;
  80        u8 bits;
  81};
  82
  83static struct kszphy_hw_stat kszphy_hw_stats[] = {
  84        { "phy_receive_errors", 21, 16},
  85        { "phy_idle_errors", 10, 8 },
  86};
  87
  88struct kszphy_type {
  89        u32 led_mode_reg;
  90        u16 interrupt_level_mask;
  91        bool has_broadcast_disable;
  92        bool has_nand_tree_disable;
  93        bool has_rmii_ref_clk_sel;
  94};
  95
  96struct kszphy_priv {
  97        const struct kszphy_type *type;
  98        int led_mode;
  99        bool rmii_ref_clk_sel;
 100        bool rmii_ref_clk_sel_val;
 101        u64 stats[ARRAY_SIZE(kszphy_hw_stats)];
 102};
 103
 104static const struct kszphy_type ksz8021_type = {
 105        .led_mode_reg           = MII_KSZPHY_CTRL_2,
 106        .has_broadcast_disable  = true,
 107        .has_nand_tree_disable  = true,
 108        .has_rmii_ref_clk_sel   = true,
 109};
 110
 111static const struct kszphy_type ksz8041_type = {
 112        .led_mode_reg           = MII_KSZPHY_CTRL_1,
 113};
 114
 115static const struct kszphy_type ksz8051_type = {
 116        .led_mode_reg           = MII_KSZPHY_CTRL_2,
 117        .has_nand_tree_disable  = true,
 118};
 119
 120static const struct kszphy_type ksz8081_type = {
 121        .led_mode_reg           = MII_KSZPHY_CTRL_2,
 122        .has_broadcast_disable  = true,
 123        .has_nand_tree_disable  = true,
 124        .has_rmii_ref_clk_sel   = true,
 125};
 126
 127static const struct kszphy_type ks8737_type = {
 128        .interrupt_level_mask   = BIT(14),
 129};
 130
 131static const struct kszphy_type ksz9021_type = {
 132        .interrupt_level_mask   = BIT(14),
 133};
 134
 135static int kszphy_extended_write(struct phy_device *phydev,
 136                                u32 regnum, u16 val)
 137{
 138        phy_write(phydev, MII_KSZPHY_EXTREG, KSZPHY_EXTREG_WRITE | regnum);
 139        return phy_write(phydev, MII_KSZPHY_EXTREG_WRITE, val);
 140}
 141
 142static int kszphy_extended_read(struct phy_device *phydev,
 143                                u32 regnum)
 144{
 145        phy_write(phydev, MII_KSZPHY_EXTREG, regnum);
 146        return phy_read(phydev, MII_KSZPHY_EXTREG_READ);
 147}
 148
 149static int kszphy_ack_interrupt(struct phy_device *phydev)
 150{
 151        /* bit[7..0] int status, which is a read and clear register. */
 152        int rc;
 153
 154        rc = phy_read(phydev, MII_KSZPHY_INTCS);
 155
 156        return (rc < 0) ? rc : 0;
 157}
 158
 159static int kszphy_config_intr(struct phy_device *phydev)
 160{
 161        const struct kszphy_type *type = phydev->drv->driver_data;
 162        int temp;
 163        u16 mask;
 164
 165        if (type && type->interrupt_level_mask)
 166                mask = type->interrupt_level_mask;
 167        else
 168                mask = KSZPHY_CTRL_INT_ACTIVE_HIGH;
 169
 170        /* set the interrupt pin active low */
 171        temp = phy_read(phydev, MII_KSZPHY_CTRL);
 172        if (temp < 0)
 173                return temp;
 174        temp &= ~mask;
 175        phy_write(phydev, MII_KSZPHY_CTRL, temp);
 176
 177        /* enable / disable interrupts */
 178        if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
 179                temp = KSZPHY_INTCS_ALL;
 180        else
 181                temp = 0;
 182
 183        return phy_write(phydev, MII_KSZPHY_INTCS, temp);
 184}
 185
 186static int kszphy_rmii_clk_sel(struct phy_device *phydev, bool val)
 187{
 188        int ctrl;
 189
 190        ctrl = phy_read(phydev, MII_KSZPHY_CTRL);
 191        if (ctrl < 0)
 192                return ctrl;
 193
 194        if (val)
 195                ctrl |= KSZPHY_RMII_REF_CLK_SEL;
 196        else
 197                ctrl &= ~KSZPHY_RMII_REF_CLK_SEL;
 198
 199        return phy_write(phydev, MII_KSZPHY_CTRL, ctrl);
 200}
 201
 202static int kszphy_setup_led(struct phy_device *phydev, u32 reg, int val)
 203{
 204        int rc, temp, shift;
 205
 206        switch (reg) {
 207        case MII_KSZPHY_CTRL_1:
 208                shift = 14;
 209                break;
 210        case MII_KSZPHY_CTRL_2:
 211                shift = 4;
 212                break;
 213        default:
 214                return -EINVAL;
 215        }
 216
 217        temp = phy_read(phydev, reg);
 218        if (temp < 0) {
 219                rc = temp;
 220                goto out;
 221        }
 222
 223        temp &= ~(3 << shift);
 224        temp |= val << shift;
 225        rc = phy_write(phydev, reg, temp);
 226out:
 227        if (rc < 0)
 228                phydev_err(phydev, "failed to set led mode\n");
 229
 230        return rc;
 231}
 232
 233/* Disable PHY address 0 as the broadcast address, so that it can be used as a
 234 * unique (non-broadcast) address on a shared bus.
 235 */
 236static int kszphy_broadcast_disable(struct phy_device *phydev)
 237{
 238        int ret;
 239
 240        ret = phy_read(phydev, MII_KSZPHY_OMSO);
 241        if (ret < 0)
 242                goto out;
 243
 244        ret = phy_write(phydev, MII_KSZPHY_OMSO, ret | KSZPHY_OMSO_B_CAST_OFF);
 245out:
 246        if (ret)
 247                phydev_err(phydev, "failed to disable broadcast address\n");
 248
 249        return ret;
 250}
 251
 252static int kszphy_nand_tree_disable(struct phy_device *phydev)
 253{
 254        int ret;
 255
 256        ret = phy_read(phydev, MII_KSZPHY_OMSO);
 257        if (ret < 0)
 258                goto out;
 259
 260        if (!(ret & KSZPHY_OMSO_NAND_TREE_ON))
 261                return 0;
 262
 263        ret = phy_write(phydev, MII_KSZPHY_OMSO,
 264                        ret & ~KSZPHY_OMSO_NAND_TREE_ON);
 265out:
 266        if (ret)
 267                phydev_err(phydev, "failed to disable NAND tree mode\n");
 268
 269        return ret;
 270}
 271
 272/* Some config bits need to be set again on resume, handle them here. */
 273static int kszphy_config_reset(struct phy_device *phydev)
 274{
 275        struct kszphy_priv *priv = phydev->priv;
 276        int ret;
 277
 278        if (priv->rmii_ref_clk_sel) {
 279                ret = kszphy_rmii_clk_sel(phydev, priv->rmii_ref_clk_sel_val);
 280                if (ret) {
 281                        phydev_err(phydev,
 282                                   "failed to set rmii reference clock\n");
 283                        return ret;
 284                }
 285        }
 286
 287        if (priv->led_mode >= 0)
 288                kszphy_setup_led(phydev, priv->type->led_mode_reg, priv->led_mode);
 289
 290        return 0;
 291}
 292
 293static int kszphy_config_init(struct phy_device *phydev)
 294{
 295        struct kszphy_priv *priv = phydev->priv;
 296        const struct kszphy_type *type;
 297
 298        if (!priv)
 299                return 0;
 300
 301        type = priv->type;
 302
 303        if (type->has_broadcast_disable)
 304                kszphy_broadcast_disable(phydev);
 305
 306        if (type->has_nand_tree_disable)
 307                kszphy_nand_tree_disable(phydev);
 308
 309        return kszphy_config_reset(phydev);
 310}
 311
 312static int ksz8041_config_init(struct phy_device *phydev)
 313{
 314        struct device_node *of_node = phydev->mdio.dev.of_node;
 315
 316        /* Limit supported and advertised modes in fiber mode */
 317        if (of_property_read_bool(of_node, "micrel,fiber-mode")) {
 318                phydev->dev_flags |= MICREL_PHY_FXEN;
 319                phydev->supported &= SUPPORTED_100baseT_Full |
 320                                     SUPPORTED_100baseT_Half;
 321                phydev->supported |= SUPPORTED_FIBRE;
 322                phydev->advertising &= ADVERTISED_100baseT_Full |
 323                                       ADVERTISED_100baseT_Half;
 324                phydev->advertising |= ADVERTISED_FIBRE;
 325                phydev->autoneg = AUTONEG_DISABLE;
 326        }
 327
 328        return kszphy_config_init(phydev);
 329}
 330
 331static int ksz8041_config_aneg(struct phy_device *phydev)
 332{
 333        /* Skip auto-negotiation in fiber mode */
 334        if (phydev->dev_flags & MICREL_PHY_FXEN) {
 335                phydev->speed = SPEED_100;
 336                return 0;
 337        }
 338
 339        return genphy_config_aneg(phydev);
 340}
 341
 342static int ksz9021_load_values_from_of(struct phy_device *phydev,
 343                                       const struct device_node *of_node,
 344                                       u16 reg,
 345                                       const char *field1, const char *field2,
 346                                       const char *field3, const char *field4)
 347{
 348        int val1 = -1;
 349        int val2 = -2;
 350        int val3 = -3;
 351        int val4 = -4;
 352        int newval;
 353        int matches = 0;
 354
 355        if (!of_property_read_u32(of_node, field1, &val1))
 356                matches++;
 357
 358        if (!of_property_read_u32(of_node, field2, &val2))
 359                matches++;
 360
 361        if (!of_property_read_u32(of_node, field3, &val3))
 362                matches++;
 363
 364        if (!of_property_read_u32(of_node, field4, &val4))
 365                matches++;
 366
 367        if (!matches)
 368                return 0;
 369
 370        if (matches < 4)
 371                newval = kszphy_extended_read(phydev, reg);
 372        else
 373                newval = 0;
 374
 375        if (val1 != -1)
 376                newval = ((newval & 0xfff0) | ((val1 / PS_TO_REG) & 0xf) << 0);
 377
 378        if (val2 != -2)
 379                newval = ((newval & 0xff0f) | ((val2 / PS_TO_REG) & 0xf) << 4);
 380
 381        if (val3 != -3)
 382                newval = ((newval & 0xf0ff) | ((val3 / PS_TO_REG) & 0xf) << 8);
 383
 384        if (val4 != -4)
 385                newval = ((newval & 0x0fff) | ((val4 / PS_TO_REG) & 0xf) << 12);
 386
 387        return kszphy_extended_write(phydev, reg, newval);
 388}
 389
 390static int ksz9021_config_init(struct phy_device *phydev)
 391{
 392        const struct device *dev = &phydev->mdio.dev;
 393        const struct device_node *of_node = dev->of_node;
 394        const struct device *dev_walker;
 395
 396        /* The Micrel driver has a deprecated option to place phy OF
 397         * properties in the MAC node. Walk up the tree of devices to
 398         * find a device with an OF node.
 399         */
 400        dev_walker = &phydev->mdio.dev;
 401        do {
 402                of_node = dev_walker->of_node;
 403                dev_walker = dev_walker->parent;
 404
 405        } while (!of_node && dev_walker);
 406
 407        if (of_node) {
 408                ksz9021_load_values_from_of(phydev, of_node,
 409                                    MII_KSZPHY_CLK_CONTROL_PAD_SKEW,
 410                                    "txen-skew-ps", "txc-skew-ps",
 411                                    "rxdv-skew-ps", "rxc-skew-ps");
 412                ksz9021_load_values_from_of(phydev, of_node,
 413                                    MII_KSZPHY_RX_DATA_PAD_SKEW,
 414                                    "rxd0-skew-ps", "rxd1-skew-ps",
 415                                    "rxd2-skew-ps", "rxd3-skew-ps");
 416                ksz9021_load_values_from_of(phydev, of_node,
 417                                    MII_KSZPHY_TX_DATA_PAD_SKEW,
 418                                    "txd0-skew-ps", "txd1-skew-ps",
 419                                    "txd2-skew-ps", "txd3-skew-ps");
 420        }
 421        return 0;
 422}
 423
 424#define MII_KSZ9031RN_MMD_CTRL_REG      0x0d
 425#define MII_KSZ9031RN_MMD_REGDATA_REG   0x0e
 426#define OP_DATA                         1
 427#define KSZ9031_PS_TO_REG               60
 428
 429/* Extended registers */
 430/* MMD Address 0x0 */
 431#define MII_KSZ9031RN_FLP_BURST_TX_LO   3
 432#define MII_KSZ9031RN_FLP_BURST_TX_HI   4
 433
 434/* MMD Address 0x2 */
 435#define MII_KSZ9031RN_CONTROL_PAD_SKEW  4
 436#define MII_KSZ9031RN_RX_DATA_PAD_SKEW  5
 437#define MII_KSZ9031RN_TX_DATA_PAD_SKEW  6
 438#define MII_KSZ9031RN_CLK_PAD_SKEW      8
 439
 440/* MMD Address 0x1C */
 441#define MII_KSZ9031RN_EDPD              0x23
 442#define MII_KSZ9031RN_EDPD_ENABLE       BIT(0)
 443
 444static int ksz9031_extended_write(struct phy_device *phydev,
 445                                  u8 mode, u32 dev_addr, u32 regnum, u16 val)
 446{
 447        phy_write(phydev, MII_KSZ9031RN_MMD_CTRL_REG, dev_addr);
 448        phy_write(phydev, MII_KSZ9031RN_MMD_REGDATA_REG, regnum);
 449        phy_write(phydev, MII_KSZ9031RN_MMD_CTRL_REG, (mode << 14) | dev_addr);
 450        return phy_write(phydev, MII_KSZ9031RN_MMD_REGDATA_REG, val);
 451}
 452
 453static int ksz9031_extended_read(struct phy_device *phydev,
 454                                 u8 mode, u32 dev_addr, u32 regnum)
 455{
 456        phy_write(phydev, MII_KSZ9031RN_MMD_CTRL_REG, dev_addr);
 457        phy_write(phydev, MII_KSZ9031RN_MMD_REGDATA_REG, regnum);
 458        phy_write(phydev, MII_KSZ9031RN_MMD_CTRL_REG, (mode << 14) | dev_addr);
 459        return phy_read(phydev, MII_KSZ9031RN_MMD_REGDATA_REG);
 460}
 461
 462static int ksz9031_of_load_skew_values(struct phy_device *phydev,
 463                                       const struct device_node *of_node,
 464                                       u16 reg, size_t field_sz,
 465                                       const char *field[], u8 numfields)
 466{
 467        int val[4] = {-1, -2, -3, -4};
 468        int matches = 0;
 469        u16 mask;
 470        u16 maxval;
 471        u16 newval;
 472        int i;
 473
 474        for (i = 0; i < numfields; i++)
 475                if (!of_property_read_u32(of_node, field[i], val + i))
 476                        matches++;
 477
 478        if (!matches)
 479                return 0;
 480
 481        if (matches < numfields)
 482                newval = ksz9031_extended_read(phydev, OP_DATA, 2, reg);
 483        else
 484                newval = 0;
 485
 486        maxval = (field_sz == 4) ? 0xf : 0x1f;
 487        for (i = 0; i < numfields; i++)
 488                if (val[i] != -(i + 1)) {
 489                        mask = 0xffff;
 490                        mask ^= maxval << (field_sz * i);
 491                        newval = (newval & mask) |
 492                                (((val[i] / KSZ9031_PS_TO_REG) & maxval)
 493                                        << (field_sz * i));
 494                }
 495
 496        return ksz9031_extended_write(phydev, OP_DATA, 2, reg, newval);
 497}
 498
 499/* Center KSZ9031RNX FLP timing at 16ms. */
 500static int ksz9031_center_flp_timing(struct phy_device *phydev)
 501{
 502        int result;
 503
 504        result = ksz9031_extended_write(phydev, OP_DATA, 0,
 505                                        MII_KSZ9031RN_FLP_BURST_TX_HI, 0x0006);
 506        if (result)
 507                return result;
 508
 509        result = ksz9031_extended_write(phydev, OP_DATA, 0,
 510                                        MII_KSZ9031RN_FLP_BURST_TX_LO, 0x1A80);
 511        if (result)
 512                return result;
 513
 514        return genphy_restart_aneg(phydev);
 515}
 516
 517/* Enable energy-detect power-down mode */
 518static int ksz9031_enable_edpd(struct phy_device *phydev)
 519{
 520        int reg;
 521
 522        reg = ksz9031_extended_read(phydev, OP_DATA, 0x1C, MII_KSZ9031RN_EDPD);
 523        if (reg < 0)
 524                return reg;
 525        return ksz9031_extended_write(phydev, OP_DATA, 0x1C, MII_KSZ9031RN_EDPD,
 526                                      reg | MII_KSZ9031RN_EDPD_ENABLE);
 527}
 528
 529static int ksz9031_config_init(struct phy_device *phydev)
 530{
 531        const struct device *dev = &phydev->mdio.dev;
 532        const struct device_node *of_node = dev->of_node;
 533        static const char *clk_skews[2] = {"rxc-skew-ps", "txc-skew-ps"};
 534        static const char *rx_data_skews[4] = {
 535                "rxd0-skew-ps", "rxd1-skew-ps",
 536                "rxd2-skew-ps", "rxd3-skew-ps"
 537        };
 538        static const char *tx_data_skews[4] = {
 539                "txd0-skew-ps", "txd1-skew-ps",
 540                "txd2-skew-ps", "txd3-skew-ps"
 541        };
 542        static const char *control_skews[2] = {"txen-skew-ps", "rxdv-skew-ps"};
 543        const struct device *dev_walker;
 544        int result;
 545
 546        result = ksz9031_enable_edpd(phydev);
 547        if (result < 0)
 548                return result;
 549
 550        /* The Micrel driver has a deprecated option to place phy OF
 551         * properties in the MAC node. Walk up the tree of devices to
 552         * find a device with an OF node.
 553         */
 554        dev_walker = &phydev->mdio.dev;
 555        do {
 556                of_node = dev_walker->of_node;
 557                dev_walker = dev_walker->parent;
 558        } while (!of_node && dev_walker);
 559
 560        if (of_node) {
 561                ksz9031_of_load_skew_values(phydev, of_node,
 562                                MII_KSZ9031RN_CLK_PAD_SKEW, 5,
 563                                clk_skews, 2);
 564
 565                ksz9031_of_load_skew_values(phydev, of_node,
 566                                MII_KSZ9031RN_CONTROL_PAD_SKEW, 4,
 567                                control_skews, 2);
 568
 569                ksz9031_of_load_skew_values(phydev, of_node,
 570                                MII_KSZ9031RN_RX_DATA_PAD_SKEW, 4,
 571                                rx_data_skews, 4);
 572
 573                ksz9031_of_load_skew_values(phydev, of_node,
 574                                MII_KSZ9031RN_TX_DATA_PAD_SKEW, 4,
 575                                tx_data_skews, 4);
 576
 577                /* Silicon Errata Sheet (DS80000691D or DS80000692D):
 578                 * When the device links in the 1000BASE-T slave mode only,
 579                 * the optional 125MHz reference output clock (CLK125_NDO)
 580                 * has wide duty cycle variation.
 581                 *
 582                 * The optional CLK125_NDO clock does not meet the RGMII
 583                 * 45/55 percent (min/max) duty cycle requirement and therefore
 584                 * cannot be used directly by the MAC side for clocking
 585                 * applications that have setup/hold time requirements on
 586                 * rising and falling clock edges.
 587                 *
 588                 * Workaround:
 589                 * Force the phy to be the master to receive a stable clock
 590                 * which meets the duty cycle requirement.
 591                 */
 592                if (of_property_read_bool(of_node, "micrel,force-master")) {
 593                        result = phy_read(phydev, MII_CTRL1000);
 594                        if (result < 0)
 595                                goto err_force_master;
 596
 597                        /* enable master mode, config & prefer master */
 598                        result |= CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER;
 599                        result = phy_write(phydev, MII_CTRL1000, result);
 600                        if (result < 0)
 601                                goto err_force_master;
 602                }
 603        }
 604
 605        return ksz9031_center_flp_timing(phydev);
 606
 607err_force_master:
 608        phydev_err(phydev, "failed to force the phy to master mode\n");
 609        return result;
 610}
 611
 612#define KSZ8873MLL_GLOBAL_CONTROL_4     0x06
 613#define KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX      BIT(6)
 614#define KSZ8873MLL_GLOBAL_CONTROL_4_SPEED       BIT(4)
 615static int ksz8873mll_read_status(struct phy_device *phydev)
 616{
 617        int regval;
 618
 619        /* dummy read */
 620        regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
 621
 622        regval = phy_read(phydev, KSZ8873MLL_GLOBAL_CONTROL_4);
 623
 624        if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_DUPLEX)
 625                phydev->duplex = DUPLEX_HALF;
 626        else
 627                phydev->duplex = DUPLEX_FULL;
 628
 629        if (regval & KSZ8873MLL_GLOBAL_CONTROL_4_SPEED)
 630                phydev->speed = SPEED_10;
 631        else
 632                phydev->speed = SPEED_100;
 633
 634        phydev->link = 1;
 635        phydev->pause = phydev->asym_pause = 0;
 636
 637        return 0;
 638}
 639
 640static int ksz9031_read_status(struct phy_device *phydev)
 641{
 642        int err;
 643        int regval;
 644
 645        err = genphy_read_status(phydev);
 646        if (err)
 647                return err;
 648
 649        /* Make sure the PHY is not broken. Read idle error count,
 650         * and reset the PHY if it is maxed out.
 651         */
 652        regval = phy_read(phydev, MII_STAT1000);
 653        if ((regval & 0xFF) == 0xFF) {
 654                phy_init_hw(phydev);
 655                phydev->link = 0;
 656                if (phydev->drv->config_intr && phy_interrupt_is_valid(phydev))
 657                        phydev->drv->config_intr(phydev);
 658                return genphy_config_aneg(phydev);
 659        }
 660
 661        return 0;
 662}
 663
 664static int ksz8873mll_config_aneg(struct phy_device *phydev)
 665{
 666        return 0;
 667}
 668
 669static int kszphy_get_sset_count(struct phy_device *phydev)
 670{
 671        return ARRAY_SIZE(kszphy_hw_stats);
 672}
 673
 674static void kszphy_get_strings(struct phy_device *phydev, u8 *data)
 675{
 676        int i;
 677
 678        for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++) {
 679                strlcpy(data + i * ETH_GSTRING_LEN,
 680                        kszphy_hw_stats[i].string, ETH_GSTRING_LEN);
 681        }
 682}
 683
 684static u64 kszphy_get_stat(struct phy_device *phydev, int i)
 685{
 686        struct kszphy_hw_stat stat = kszphy_hw_stats[i];
 687        struct kszphy_priv *priv = phydev->priv;
 688        int val;
 689        u64 ret;
 690
 691        val = phy_read(phydev, stat.reg);
 692        if (val < 0) {
 693                ret = U64_MAX;
 694        } else {
 695                val = val & ((1 << stat.bits) - 1);
 696                priv->stats[i] += val;
 697                ret = priv->stats[i];
 698        }
 699
 700        return ret;
 701}
 702
 703static void kszphy_get_stats(struct phy_device *phydev,
 704                             struct ethtool_stats *stats, u64 *data)
 705{
 706        int i;
 707
 708        for (i = 0; i < ARRAY_SIZE(kszphy_hw_stats); i++)
 709                data[i] = kszphy_get_stat(phydev, i);
 710}
 711
 712static int kszphy_suspend(struct phy_device *phydev)
 713{
 714        /* Disable PHY Interrupts */
 715        if (phy_interrupt_is_valid(phydev)) {
 716                phydev->interrupts = PHY_INTERRUPT_DISABLED;
 717                if (phydev->drv->config_intr)
 718                        phydev->drv->config_intr(phydev);
 719        }
 720
 721        return genphy_suspend(phydev);
 722}
 723
 724static int kszphy_resume(struct phy_device *phydev)
 725{
 726        int ret;
 727
 728        genphy_resume(phydev);
 729
 730        ret = kszphy_config_reset(phydev);
 731        if (ret)
 732                return ret;
 733
 734        /* Enable PHY Interrupts */
 735        if (phy_interrupt_is_valid(phydev)) {
 736                phydev->interrupts = PHY_INTERRUPT_ENABLED;
 737                if (phydev->drv->config_intr)
 738                        phydev->drv->config_intr(phydev);
 739        }
 740
 741        return 0;
 742}
 743
 744static int kszphy_probe(struct phy_device *phydev)
 745{
 746        const struct kszphy_type *type = phydev->drv->driver_data;
 747        const struct device_node *np = phydev->mdio.dev.of_node;
 748        struct kszphy_priv *priv;
 749        struct clk *clk;
 750        int ret;
 751
 752        priv = devm_kzalloc(&phydev->mdio.dev, sizeof(*priv), GFP_KERNEL);
 753        if (!priv)
 754                return -ENOMEM;
 755
 756        phydev->priv = priv;
 757
 758        priv->type = type;
 759
 760        if (type->led_mode_reg) {
 761                ret = of_property_read_u32(np, "micrel,led-mode",
 762                                &priv->led_mode);
 763                if (ret)
 764                        priv->led_mode = -1;
 765
 766                if (priv->led_mode > 3) {
 767                        phydev_err(phydev, "invalid led mode: 0x%02x\n",
 768                                   priv->led_mode);
 769                        priv->led_mode = -1;
 770                }
 771        } else {
 772                priv->led_mode = -1;
 773        }
 774
 775        clk = devm_clk_get(&phydev->mdio.dev, "rmii-ref");
 776        /* NOTE: clk may be NULL if building without CONFIG_HAVE_CLK */
 777        if (!IS_ERR_OR_NULL(clk)) {
 778                unsigned long rate = clk_get_rate(clk);
 779                bool rmii_ref_clk_sel_25_mhz;
 780
 781                priv->rmii_ref_clk_sel = type->has_rmii_ref_clk_sel;
 782                rmii_ref_clk_sel_25_mhz = of_property_read_bool(np,
 783                                "micrel,rmii-reference-clock-select-25-mhz");
 784
 785                if (rate > 24500000 && rate < 25500000) {
 786                        priv->rmii_ref_clk_sel_val = rmii_ref_clk_sel_25_mhz;
 787                } else if (rate > 49500000 && rate < 50500000) {
 788                        priv->rmii_ref_clk_sel_val = !rmii_ref_clk_sel_25_mhz;
 789                } else {
 790                        phydev_err(phydev, "Clock rate out of range: %ld\n",
 791                                   rate);
 792                        return -EINVAL;
 793                }
 794        }
 795
 796        /* Support legacy board-file configuration */
 797        if (phydev->dev_flags & MICREL_PHY_50MHZ_CLK) {
 798                priv->rmii_ref_clk_sel = true;
 799                priv->rmii_ref_clk_sel_val = true;
 800        }
 801
 802        return 0;
 803}
 804
 805static struct phy_driver ksphy_driver[] = {
 806{
 807        .phy_id         = PHY_ID_KS8737,
 808        .phy_id_mask    = MICREL_PHY_ID_MASK,
 809        .name           = "Micrel KS8737",
 810        .features       = PHY_BASIC_FEATURES,
 811        .flags          = PHY_HAS_INTERRUPT,
 812        .driver_data    = &ks8737_type,
 813        .config_init    = kszphy_config_init,
 814        .ack_interrupt  = kszphy_ack_interrupt,
 815        .config_intr    = kszphy_config_intr,
 816        .suspend        = genphy_suspend,
 817        .resume         = genphy_resume,
 818}, {
 819        .phy_id         = PHY_ID_KSZ8021,
 820        .phy_id_mask    = 0x00ffffff,
 821        .name           = "Micrel KSZ8021 or KSZ8031",
 822        .features       = PHY_BASIC_FEATURES,
 823        .flags          = PHY_HAS_INTERRUPT,
 824        .driver_data    = &ksz8021_type,
 825        .probe          = kszphy_probe,
 826        .config_init    = kszphy_config_init,
 827        .ack_interrupt  = kszphy_ack_interrupt,
 828        .config_intr    = kszphy_config_intr,
 829        .get_sset_count = kszphy_get_sset_count,
 830        .get_strings    = kszphy_get_strings,
 831        .get_stats      = kszphy_get_stats,
 832        .suspend        = genphy_suspend,
 833        .resume         = genphy_resume,
 834}, {
 835        .phy_id         = PHY_ID_KSZ8031,
 836        .phy_id_mask    = 0x00ffffff,
 837        .name           = "Micrel KSZ8031",
 838        .features       = PHY_BASIC_FEATURES,
 839        .flags          = PHY_HAS_INTERRUPT,
 840        .driver_data    = &ksz8021_type,
 841        .probe          = kszphy_probe,
 842        .config_init    = kszphy_config_init,
 843        .ack_interrupt  = kszphy_ack_interrupt,
 844        .config_intr    = kszphy_config_intr,
 845        .get_sset_count = kszphy_get_sset_count,
 846        .get_strings    = kszphy_get_strings,
 847        .get_stats      = kszphy_get_stats,
 848        .suspend        = genphy_suspend,
 849        .resume         = genphy_resume,
 850}, {
 851        .phy_id         = PHY_ID_KSZ8041,
 852        .phy_id_mask    = MICREL_PHY_ID_MASK,
 853        .name           = "Micrel KSZ8041",
 854        .features       = PHY_BASIC_FEATURES,
 855        .flags          = PHY_HAS_INTERRUPT,
 856        .driver_data    = &ksz8041_type,
 857        .probe          = kszphy_probe,
 858        .config_init    = ksz8041_config_init,
 859        .config_aneg    = ksz8041_config_aneg,
 860        .ack_interrupt  = kszphy_ack_interrupt,
 861        .config_intr    = kszphy_config_intr,
 862        .get_sset_count = kszphy_get_sset_count,
 863        .get_strings    = kszphy_get_strings,
 864        .get_stats      = kszphy_get_stats,
 865        .suspend        = genphy_suspend,
 866        .resume         = genphy_resume,
 867}, {
 868        .phy_id         = PHY_ID_KSZ8041RNLI,
 869        .phy_id_mask    = MICREL_PHY_ID_MASK,
 870        .name           = "Micrel KSZ8041RNLI",
 871        .features       = PHY_BASIC_FEATURES,
 872        .flags          = PHY_HAS_INTERRUPT,
 873        .driver_data    = &ksz8041_type,
 874        .probe          = kszphy_probe,
 875        .config_init    = kszphy_config_init,
 876        .ack_interrupt  = kszphy_ack_interrupt,
 877        .config_intr    = kszphy_config_intr,
 878        .get_sset_count = kszphy_get_sset_count,
 879        .get_strings    = kszphy_get_strings,
 880        .get_stats      = kszphy_get_stats,
 881        .suspend        = genphy_suspend,
 882        .resume         = genphy_resume,
 883}, {
 884        .phy_id         = PHY_ID_KSZ8051,
 885        .phy_id_mask    = MICREL_PHY_ID_MASK,
 886        .name           = "Micrel KSZ8051",
 887        .features       = PHY_BASIC_FEATURES,
 888        .flags          = PHY_HAS_INTERRUPT,
 889        .driver_data    = &ksz8051_type,
 890        .probe          = kszphy_probe,
 891        .config_init    = kszphy_config_init,
 892        .ack_interrupt  = kszphy_ack_interrupt,
 893        .config_intr    = kszphy_config_intr,
 894        .get_sset_count = kszphy_get_sset_count,
 895        .get_strings    = kszphy_get_strings,
 896        .get_stats      = kszphy_get_stats,
 897        .suspend        = genphy_suspend,
 898        .resume         = genphy_resume,
 899}, {
 900        .phy_id         = PHY_ID_KSZ8001,
 901        .name           = "Micrel KSZ8001 or KS8721",
 902        .phy_id_mask    = 0x00fffffc,
 903        .features       = PHY_BASIC_FEATURES,
 904        .flags          = PHY_HAS_INTERRUPT,
 905        .driver_data    = &ksz8041_type,
 906        .probe          = kszphy_probe,
 907        .config_init    = kszphy_config_init,
 908        .ack_interrupt  = kszphy_ack_interrupt,
 909        .config_intr    = kszphy_config_intr,
 910        .get_sset_count = kszphy_get_sset_count,
 911        .get_strings    = kszphy_get_strings,
 912        .get_stats      = kszphy_get_stats,
 913        .suspend        = genphy_suspend,
 914        .resume         = genphy_resume,
 915}, {
 916        .phy_id         = PHY_ID_KSZ8081,
 917        .name           = "Micrel KSZ8081 or KSZ8091",
 918        .phy_id_mask    = MICREL_PHY_ID_MASK,
 919        .features       = PHY_BASIC_FEATURES,
 920        .flags          = PHY_HAS_INTERRUPT,
 921        .driver_data    = &ksz8081_type,
 922        .probe          = kszphy_probe,
 923        .config_init    = kszphy_config_init,
 924        .ack_interrupt  = kszphy_ack_interrupt,
 925        .config_intr    = kszphy_config_intr,
 926        .get_sset_count = kszphy_get_sset_count,
 927        .get_strings    = kszphy_get_strings,
 928        .get_stats      = kszphy_get_stats,
 929        .suspend        = kszphy_suspend,
 930        .resume         = kszphy_resume,
 931}, {
 932        .phy_id         = PHY_ID_KSZ8061,
 933        .name           = "Micrel KSZ8061",
 934        .phy_id_mask    = MICREL_PHY_ID_MASK,
 935        .features       = PHY_BASIC_FEATURES,
 936        .flags          = PHY_HAS_INTERRUPT,
 937        .config_init    = kszphy_config_init,
 938        .ack_interrupt  = kszphy_ack_interrupt,
 939        .config_intr    = kszphy_config_intr,
 940        .suspend        = genphy_suspend,
 941        .resume         = genphy_resume,
 942}, {
 943        .phy_id         = PHY_ID_KSZ9021,
 944        .phy_id_mask    = 0x000ffffe,
 945        .name           = "Micrel KSZ9021 Gigabit PHY",
 946        .features       = PHY_GBIT_FEATURES,
 947        .flags          = PHY_HAS_INTERRUPT,
 948        .driver_data    = &ksz9021_type,
 949        .probe          = kszphy_probe,
 950        .config_init    = ksz9021_config_init,
 951        .ack_interrupt  = kszphy_ack_interrupt,
 952        .config_intr    = kszphy_config_intr,
 953        .get_sset_count = kszphy_get_sset_count,
 954        .get_strings    = kszphy_get_strings,
 955        .get_stats      = kszphy_get_stats,
 956        .suspend        = genphy_suspend,
 957        .resume         = genphy_resume,
 958        .read_mmd       = genphy_read_mmd_unsupported,
 959        .write_mmd      = genphy_write_mmd_unsupported,
 960}, {
 961        .phy_id         = PHY_ID_KSZ9031,
 962        .phy_id_mask    = MICREL_PHY_ID_MASK,
 963        .name           = "Micrel KSZ9031 Gigabit PHY",
 964        .features       = PHY_GBIT_FEATURES,
 965        .flags          = PHY_HAS_INTERRUPT,
 966        .driver_data    = &ksz9021_type,
 967        .probe          = kszphy_probe,
 968        .config_init    = ksz9031_config_init,
 969        .read_status    = ksz9031_read_status,
 970        .ack_interrupt  = kszphy_ack_interrupt,
 971        .config_intr    = kszphy_config_intr,
 972        .get_sset_count = kszphy_get_sset_count,
 973        .get_strings    = kszphy_get_strings,
 974        .get_stats      = kszphy_get_stats,
 975        .suspend        = genphy_suspend,
 976        .resume         = kszphy_resume,
 977}, {
 978        .phy_id         = PHY_ID_KSZ8873MLL,
 979        .phy_id_mask    = MICREL_PHY_ID_MASK,
 980        .name           = "Micrel KSZ8873MLL Switch",
 981        .config_init    = kszphy_config_init,
 982        .config_aneg    = ksz8873mll_config_aneg,
 983        .read_status    = ksz8873mll_read_status,
 984        .suspend        = genphy_suspend,
 985        .resume         = genphy_resume,
 986}, {
 987        .phy_id         = PHY_ID_KSZ886X,
 988        .phy_id_mask    = MICREL_PHY_ID_MASK,
 989        .name           = "Micrel KSZ886X Switch",
 990        .features       = PHY_BASIC_FEATURES,
 991        .flags          = PHY_HAS_INTERRUPT,
 992        .config_init    = kszphy_config_init,
 993        .suspend        = genphy_suspend,
 994        .resume         = genphy_resume,
 995}, {
 996        .phy_id         = PHY_ID_KSZ8795,
 997        .phy_id_mask    = MICREL_PHY_ID_MASK,
 998        .name           = "Micrel KSZ8795",
 999        .features       = PHY_BASIC_FEATURES,
1000        .flags          = PHY_HAS_INTERRUPT,
1001        .config_init    = kszphy_config_init,
1002        .config_aneg    = ksz8873mll_config_aneg,
1003        .read_status    = ksz8873mll_read_status,
1004        .suspend        = genphy_suspend,
1005        .resume         = genphy_resume,
1006}, {
1007        .phy_id         = PHY_ID_KSZ9477,
1008        .phy_id_mask    = MICREL_PHY_ID_MASK,
1009        .name           = "Microchip KSZ9477",
1010        .features       = PHY_GBIT_FEATURES,
1011        .config_init    = kszphy_config_init,
1012        .suspend        = genphy_suspend,
1013        .resume         = genphy_resume,
1014} };
1015
1016module_phy_driver(ksphy_driver);
1017
1018MODULE_DESCRIPTION("Micrel PHY driver");
1019MODULE_AUTHOR("David J. Choi");
1020MODULE_LICENSE("GPL");
1021
1022static struct mdio_device_id __maybe_unused micrel_tbl[] = {
1023        { PHY_ID_KSZ9021, 0x000ffffe },
1024        { PHY_ID_KSZ9031, MICREL_PHY_ID_MASK },
1025        { PHY_ID_KSZ8001, 0x00fffffc },
1026        { PHY_ID_KS8737, MICREL_PHY_ID_MASK },
1027        { PHY_ID_KSZ8021, 0x00ffffff },
1028        { PHY_ID_KSZ8031, 0x00ffffff },
1029        { PHY_ID_KSZ8041, MICREL_PHY_ID_MASK },
1030        { PHY_ID_KSZ8051, MICREL_PHY_ID_MASK },
1031        { PHY_ID_KSZ8061, MICREL_PHY_ID_MASK },
1032        { PHY_ID_KSZ8081, MICREL_PHY_ID_MASK },
1033        { PHY_ID_KSZ8873MLL, MICREL_PHY_ID_MASK },
1034        { PHY_ID_KSZ886X, MICREL_PHY_ID_MASK },
1035        { }
1036};
1037
1038MODULE_DEVICE_TABLE(mdio, micrel_tbl);
1039