drivers/net/phy/phylink.c

   1 /*
   2  * phylink models the MAC to optional PHY connection, supporting
   3  * technologies such as SFP cages where the PHY is hot-pluggable.
   4  *
   5  * Copyright (C) 2015 Russell King
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11 #include <linux/ethtool.h>
  12 #include <linux/export.h>
  13 #include <linux/gpio/consumer.h>
  14 #include <linux/netdevice.h>
  15 #include <linux/of.h>
  16 #include <linux/of_mdio.h>
  17 #include <linux/phy.h>
  18 #include <linux/phy_fixed.h>
  19 #include <linux/phylink.h>
  20 #include <linux/rtnetlink.h>
  21 #include <linux/spinlock.h>
  22 #include <linux/timer.h>
  23 #include <linux/workqueue.h>
  24
  25 #include "sfp.h"
  26 #include "swphy.h"
  27
  28 #define SUPPORTED_INTERFACES \
  29         (SUPPORTED_TP | SUPPORTED_MII | SUPPORTED_FIBRE | \
  30          SUPPORTED_BNC | SUPPORTED_AUI | SUPPORTED_Backplane)
  31 #define ADVERTISED_INTERFACES \
  32         (ADVERTISED_TP | ADVERTISED_MII | ADVERTISED_FIBRE | \
  33          ADVERTISED_BNC | ADVERTISED_AUI | ADVERTISED_Backplane)
  34
  35 enum {
  36         PHYLINK_DISABLE_STOPPED,
  37         PHYLINK_DISABLE_LINK,
  38 };
  39
  40 /**
  41  * struct phylink - internal data type for phylink
  42  */
  43 struct phylink {
  44         /* private: */
  45         struct net_device *netdev;
  46         const struct phylink_mac_ops *ops;
  47
  48         unsigned long phylink_disable_state; /* bitmask of disables */
  49         struct phy_device *phydev;
  50         phy_interface_t link_interface; /* PHY_INTERFACE_xxx */
  51         u8 link_an_mode;                /* MLO_AN_xxx */
  52         u8 link_port;                   /* The current non-phy ethtool port */
  53         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
  54
  55         /* The link configuration settings */
  56         struct phylink_link_state link_config;
  57         struct gpio_desc *link_gpio;
  58         struct timer_list link_poll;
  59         void (*get_fixed_state)(struct net_device *dev,
  60                                 struct phylink_link_state *s);
  61
  62         struct mutex state_mutex;
  63         struct phylink_link_state phy_state;
  64         struct work_struct resolve;
  65
  66         bool mac_link_dropped;
  67
  68         struct sfp_bus *sfp_bus;
  69 };
  70
  71 /**
  72  * phylink_set_port_modes() - set the port type modes in the ethtool mask
  73  * @mask: ethtool link mode mask
  74  *
  75  * Sets all the port type modes in the ethtool mask.  MAC drivers should
  76  * use this in their 'validate' callback.
  77  */
  78 void phylink_set_port_modes(unsigned long *mask)
  79 {
  80         phylink_set(mask, TP);
  81         phylink_set(mask, AUI);
  82         phylink_set(mask, MII);
  83         phylink_set(mask, FIBRE);
  84         phylink_set(mask, BNC);
  85         phylink_set(mask, Backplane);
  86 }
  87 EXPORT_SYMBOL_GPL(phylink_set_port_modes);
  88
  89 static int phylink_is_empty_linkmode(const unsigned long *linkmode)
  90 {
  91         __ETHTOOL_DECLARE_LINK_MODE_MASK(tmp) = { 0, };
  92
  93         phylink_set_port_modes(tmp);
  94         phylink_set(tmp, Autoneg);
  95         phylink_set(tmp, Pause);
  96         phylink_set(tmp, Asym_Pause);
  97
  98         bitmap_andnot(tmp, linkmode, tmp, __ETHTOOL_LINK_MODE_MASK_NBITS);
  99
 100         return linkmode_empty(tmp);
 101 }
 102
 103 static const char *phylink_an_mode_str(unsigned int mode)
 104 {
 105         static const char *modestr[] = {
 106                 [MLO_AN_PHY] = "phy",
 107                 [MLO_AN_FIXED] = "fixed",
 108                 [MLO_AN_INBAND] = "inband",
 109         };
 110
 111         return mode < ARRAY_SIZE(modestr) ? modestr[mode] : "unknown";
 112 }
 113
 114 static int phylink_validate(struct phylink *pl, unsigned long *supported,
 115                             struct phylink_link_state *state)
 116 {
 117         pl->ops->validate(pl->netdev, supported, state);
 118
 119         return phylink_is_empty_linkmode(supported) ? -EINVAL : 0;
 120 }
 121
 122 static int phylink_parse_fixedlink(struct phylink *pl,
 123                                    struct fwnode_handle *fwnode)
 124 {
 125         struct fwnode_handle *fixed_node;
 126         const struct phy_setting *s;
 127         struct gpio_desc *desc;
 128         u32 speed;
 129         int ret;
 130
 131         fixed_node = fwnode_get_named_child_node(fwnode, "fixed-link");
 132         if (fixed_node) {
 133                 ret = fwnode_property_read_u32(fixed_node, "speed", &speed);
 134
 135                 pl->link_config.speed = speed;
 136                 pl->link_config.duplex = DUPLEX_HALF;
 137
 138                 if (fwnode_property_read_bool(fixed_node, "full-duplex"))
 139                         pl->link_config.duplex = DUPLEX_FULL;
 140
 141                 /* We treat the "pause" and "asym-pause" terminology as
 142                  * defining the link partner's ability. */
 143                 if (fwnode_property_read_bool(fixed_node, "pause"))
 144                         pl->link_config.pause |= MLO_PAUSE_SYM;
 145                 if (fwnode_property_read_bool(fixed_node, "asym-pause"))
 146                         pl->link_config.pause |= MLO_PAUSE_ASYM;
 147
 148                 if (ret == 0) {
 149                         desc = fwnode_get_named_gpiod(fixed_node, "link-gpios",
 150                                                       0, GPIOD_IN, "?");
 151
 152                         if (!IS_ERR(desc))
 153                                 pl->link_gpio = desc;
 154                         else if (desc == ERR_PTR(-EPROBE_DEFER))
 155                                 ret = -EPROBE_DEFER;
 156                 }
 157                 fwnode_handle_put(fixed_node);
 158
 159                 if (ret)
 160                         return ret;
 161         } else {
 162                 u32 prop[5];
 163
 164                 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
 165                                                      NULL, 0);
 166                 if (ret != ARRAY_SIZE(prop)) {
 167                         netdev_err(pl->netdev, "broken fixed-link?\n");
 168                         return -EINVAL;
 169                 }
 170
 171                 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
 172                                                      prop, ARRAY_SIZE(prop));
 173                 if (!ret) {
 174                         pl->link_config.duplex = prop[1] ?
 175                                                 DUPLEX_FULL : DUPLEX_HALF;
 176                         pl->link_config.speed = prop[2];
 177                         if (prop[3])
 178                                 pl->link_config.pause |= MLO_PAUSE_SYM;
 179                         if (prop[4])
 180                                 pl->link_config.pause |= MLO_PAUSE_ASYM;
 181                 }
 182         }
 183
 184         if (pl->link_config.speed > SPEED_1000 &&
 185             pl->link_config.duplex != DUPLEX_FULL)
 186                 netdev_warn(pl->netdev, "fixed link specifies half duplex for %dMbps link?\n",
 187                             pl->link_config.speed);
 188
 189         bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
 190         linkmode_copy(pl->link_config.advertising, pl->supported);
 191         phylink_validate(pl, pl->supported, &pl->link_config);
 192
 193         s = phy_lookup_setting(pl->link_config.speed, pl->link_config.duplex,
 194                                pl->supported,
 195                                __ETHTOOL_LINK_MODE_MASK_NBITS, true);
 196         linkmode_zero(pl->supported);
 197         phylink_set(pl->supported, MII);
 198         if (s) {
 199                 __set_bit(s->bit, pl->supported);
 200         } else {
 201                 netdev_warn(pl->netdev, "fixed link %s duplex %dMbps not recognised\n",
 202                             pl->link_config.duplex == DUPLEX_FULL ? "full" : "half",
 203                             pl->link_config.speed);
 204         }
 205
 206         linkmode_and(pl->link_config.advertising, pl->link_config.advertising,
 207                      pl->supported);
 208
 209         pl->link_config.link = 1;
 210         pl->link_config.an_complete = 1;
 211
 212         return 0;
 213 }
 214
 215 static int phylink_parse_mode(struct phylink *pl, struct fwnode_handle *fwnode)
 216 {
 217         struct fwnode_handle *dn;
 218         const char *managed;
 219
 220         dn = fwnode_get_named_child_node(fwnode, "fixed-link");
 221         if (dn || fwnode_property_present(fwnode, "fixed-link"))
 222                 pl->link_an_mode = MLO_AN_FIXED;
 223         fwnode_handle_put(dn);
 224
 225         if (fwnode_property_read_string(fwnode, "managed", &managed) == 0 &&
 226             strcmp(managed, "in-band-status") == 0) {
 227                 if (pl->link_an_mode == MLO_AN_FIXED) {
 228                         netdev_err(pl->netdev,
 229                                    "can't use both fixed-link and in-band-status\n");
 230                         return -EINVAL;
 231                 }
 232
 233                 linkmode_zero(pl->supported);
 234                 phylink_set(pl->supported, MII);
 235                 phylink_set(pl->supported, Autoneg);
 236                 phylink_set(pl->supported, Asym_Pause);
 237                 phylink_set(pl->supported, Pause);
 238                 pl->link_config.an_enabled = true;
 239                 pl->link_an_mode = MLO_AN_INBAND;
 240
 241                 switch (pl->link_config.interface) {
 242                 case PHY_INTERFACE_MODE_SGMII:
 243                         phylink_set(pl->supported, 10baseT_Half);
 244                         phylink_set(pl->supported, 10baseT_Full);
 245                         phylink_set(pl->supported, 100baseT_Half);
 246                         phylink_set(pl->supported, 100baseT_Full);
 247                         phylink_set(pl->supported, 1000baseT_Half);
 248                         phylink_set(pl->supported, 1000baseT_Full);
 249                         break;
 250
 251                 case PHY_INTERFACE_MODE_1000BASEX:
 252                         phylink_set(pl->supported, 1000baseX_Full);
 253                         break;
 254
 255                 case PHY_INTERFACE_MODE_2500BASEX:
 256                         phylink_set(pl->supported, 2500baseX_Full);
 257                         break;
 258
 259                 case PHY_INTERFACE_MODE_10GKR:
 260                         phylink_set(pl->supported, 10baseT_Half);
 261                         phylink_set(pl->supported, 10baseT_Full);
 262                         phylink_set(pl->supported, 100baseT_Half);
 263                         phylink_set(pl->supported, 100baseT_Full);
 264                         phylink_set(pl->supported, 1000baseT_Half);
 265                         phylink_set(pl->supported, 1000baseT_Full);
 266                         phylink_set(pl->supported, 1000baseX_Full);
 267                         phylink_set(pl->supported, 10000baseKR_Full);
 268                         phylink_set(pl->supported, 10000baseCR_Full);
 269                         phylink_set(pl->supported, 10000baseSR_Full);
 270                         phylink_set(pl->supported, 10000baseLR_Full);
 271                         phylink_set(pl->supported, 10000baseLRM_Full);
 272                         phylink_set(pl->supported, 10000baseER_Full);
 273                         break;
 274
 275                 default:
 276                         netdev_err(pl->netdev,
 277                                    "incorrect link mode %s for in-band status\n",
 278                                    phy_modes(pl->link_config.interface));
 279                         return -EINVAL;
 280                 }
 281
 282                 linkmode_copy(pl->link_config.advertising, pl->supported);
 283
 284                 if (phylink_validate(pl, pl->supported, &pl->link_config)) {
 285                         netdev_err(pl->netdev,
 286                                    "failed to validate link configuration for in-band status\n");
 287                         return -EINVAL;
 288                 }
 289         }
 290
 291         return 0;
 292 }
 293
 294 static void phylink_mac_config(struct phylink *pl,
 295                                const struct phylink_link_state *state)
 296 {
 297         netdev_dbg(pl->netdev,
 298                    "%s: mode=%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
 299                    __func__, phylink_an_mode_str(pl->link_an_mode),
 300                    phy_modes(state->interface),
 301                    phy_speed_to_str(state->speed),
 302                    phy_duplex_to_str(state->duplex),
 303                    __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
 304                    state->pause, state->link, state->an_enabled);
 305
 306         pl->ops->mac_config(pl->netdev, pl->link_an_mode, state);
 307 }
 308
 309 static void phylink_mac_an_restart(struct phylink *pl)
 310 {
 311         if (pl->link_config.an_enabled &&
 312             phy_interface_mode_is_8023z(pl->link_config.interface))
 313                 pl->ops->mac_an_restart(pl->netdev);
 314 }
 315
 316 static int phylink_get_mac_state(struct phylink *pl, struct phylink_link_state *state)
 317 {
 318         struct net_device *ndev = pl->netdev;
 319
 320         linkmode_copy(state->advertising, pl->link_config.advertising);
 321         linkmode_zero(state->lp_advertising);
 322         state->interface = pl->link_config.interface;
 323         state->an_enabled = pl->link_config.an_enabled;
 324         state->link = 1;
 325
 326         return pl->ops->mac_link_state(ndev, state);
 327 }
 328
 329 /* The fixed state is... fixed except for the link state,
 330  * which may be determined by a GPIO or a callback.
 331  */
 332 static void phylink_get_fixed_state(struct phylink *pl, struct phylink_link_state *state)
 333 {
 334         *state = pl->link_config;
 335         if (pl->get_fixed_state)
 336                 pl->get_fixed_state(pl->netdev, state);
 337         else if (pl->link_gpio)
 338                 state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
 339 }
 340
 341 /* Flow control is resolved according to our and the link partners
 342  * advertisements using the following drawn from the 802.3 specs:
 343  *  Local device  Link partner
 344  *  Pause AsymDir Pause AsymDir Result
 345  *    1     X       1     X     TX+RX
 346  *    0     1       1     1     RX
 347  *    1     1       0     1     TX
 348  */
 349 static void phylink_resolve_flow(struct phylink *pl,
 350                                  struct phylink_link_state *state)
 351 {
 352         int new_pause = 0;
 353
 354         if (pl->link_config.pause & MLO_PAUSE_AN) {
 355                 int pause = 0;
 356
 357                 if (phylink_test(pl->link_config.advertising, Pause))
 358                         pause |= MLO_PAUSE_SYM;
 359                 if (phylink_test(pl->link_config.advertising, Asym_Pause))
 360                         pause |= MLO_PAUSE_ASYM;
 361
 362                 pause &= state->pause;
 363
 364                 if (pause & MLO_PAUSE_SYM)
 365                         new_pause = MLO_PAUSE_TX | MLO_PAUSE_RX;
 366                 else if (pause & MLO_PAUSE_ASYM)
 367                         new_pause = state->pause & MLO_PAUSE_SYM ?
 368                                  MLO_PAUSE_RX : MLO_PAUSE_TX;
 369         } else {
 370                 new_pause = pl->link_config.pause & MLO_PAUSE_TXRX_MASK;
 371         }
 372
 373         state->pause &= ~MLO_PAUSE_TXRX_MASK;
 374         state->pause |= new_pause;
 375 }
 376
 377 static const char *phylink_pause_to_str(int pause)
 378 {
 379         switch (pause & MLO_PAUSE_TXRX_MASK) {
 380         case MLO_PAUSE_TX | MLO_PAUSE_RX:
 381                 return "rx/tx";
 382         case MLO_PAUSE_TX:
 383                 return "tx";
 384         case MLO_PAUSE_RX:
 385                 return "rx";
 386         default:
 387                 return "off";
 388         }
 389 }
 390
 391 static void phylink_resolve(struct work_struct *w)
 392 {
 393         struct phylink *pl = container_of(w, struct phylink, resolve);
 394         struct phylink_link_state link_state;
 395         struct net_device *ndev = pl->netdev;
 396
 397         mutex_lock(&pl->state_mutex);
 398         if (pl->phylink_disable_state) {
 399                 pl->mac_link_dropped = false;
 400                 link_state.link = false;
 401         } else if (pl->mac_link_dropped) {
 402                 link_state.link = false;
 403         } else {
 404                 switch (pl->link_an_mode) {
 405                 case MLO_AN_PHY:
 406                         link_state = pl->phy_state;
 407                         phylink_resolve_flow(pl, &link_state);
 408                         phylink_mac_config(pl, &link_state);
 409                         break;
 410
 411                 case MLO_AN_FIXED:
 412                         phylink_get_fixed_state(pl, &link_state);
 413                         phylink_mac_config(pl, &link_state);
 414                         break;
 415
 416                 case MLO_AN_INBAND:
 417                         phylink_get_mac_state(pl, &link_state);
 418                         if (pl->phydev) {
 419                                 bool changed = false;
 420
 421                                 link_state.link = link_state.link &&
 422                                                   pl->phy_state.link;
 423
 424                                 if (pl->phy_state.interface !=
 425                                     link_state.interface) {
 426                                         link_state.interface = pl->phy_state.interface;
 427                                         changed = true;
 428                                 }
 429
 430                                 /* Propagate the flow control from the PHY
 431                                  * to the MAC. Also propagate the interface
 432                                  * if changed.
 433                                  */
 434                                 if (pl->phy_state.link || changed) {
 435                                         link_state.pause |= pl->phy_state.pause;
 436                                         phylink_resolve_flow(pl, &link_state);
 437
 438                                         phylink_mac_config(pl, &link_state);
 439                                 }
 440                         }
 441                         break;
 442                 }
 443         }
 444
 445         if (link_state.link != netif_carrier_ok(ndev)) {
 446                 if (!link_state.link) {
 447                         netif_carrier_off(ndev);
 448                         pl->ops->mac_link_down(ndev, pl->link_an_mode,
 449                                                pl->phy_state.interface);
 450                         netdev_info(ndev, "Link is Down\n");
 451                 } else {
 452                         pl->ops->mac_link_up(ndev, pl->link_an_mode,
 453                                              pl->phy_state.interface,
 454                                              pl->phydev);
 455
 456                         netif_carrier_on(ndev);
 457
 458                         netdev_info(ndev,
 459                                     "Link is Up - %s/%s - flow control %s\n",
 460                                     phy_speed_to_str(link_state.speed),
 461                                     phy_duplex_to_str(link_state.duplex),
 462                                     phylink_pause_to_str(link_state.pause));
 463                 }
 464         }
 465         if (!link_state.link && pl->mac_link_dropped) {
 466                 pl->mac_link_dropped = false;
 467                 queue_work(system_power_efficient_wq, &pl->resolve);
 468         }
 469         mutex_unlock(&pl->state_mutex);
 470 }
 471
 472 static void phylink_run_resolve(struct phylink *pl)
 473 {
 474         if (!pl->phylink_disable_state)
 475                 queue_work(system_power_efficient_wq, &pl->resolve);
 476 }
 477
 478 static void phylink_fixed_poll(struct timer_list *t)
 479 {
 480         struct phylink *pl = container_of(t, struct phylink, link_poll);
 481
 482         mod_timer(t, jiffies + HZ);
 483
 484         phylink_run_resolve(pl);
 485 }
 486
 487 static const struct sfp_upstream_ops sfp_phylink_ops;
 488
 489 static int phylink_register_sfp(struct phylink *pl,
 490                                 struct fwnode_handle *fwnode)
 491 {
 492         struct fwnode_reference_args ref;
 493         int ret;
 494
 495         if (!fwnode)
 496                 return 0;
 497
 498         ret = fwnode_property_get_reference_args(fwnode, "sfp", NULL,
 499                                                  0, 0, &ref);
 500         if (ret < 0) {
 501                 if (ret == -ENOENT)
 502                         return 0;
 503
 504                 netdev_err(pl->netdev, "unable to parse \"sfp\" node: %d\n",
 505                            ret);
 506                 return ret;
 507         }
 508
 509         pl->sfp_bus = sfp_register_upstream(ref.fwnode, pl->netdev, pl,
 510                                             &sfp_phylink_ops);
 511         if (!pl->sfp_bus)
 512                 return -ENOMEM;
 513
 514         return 0;
 515 }
 516
 517 /**
 518  * phylink_create() - create a phylink instance
 519  * @ndev: a pointer to the &struct net_device
 520  * @fwnode: a pointer to a &struct fwnode_handle describing the network
 521  *      interface
 522  * @iface: the desired link mode defined by &typedef phy_interface_t
 523  * @ops: a pointer to a &struct phylink_mac_ops for the MAC.
 524  *
 525  * Create a new phylink instance, and parse the link parameters found in @np.
 526  * This will parse in-band modes, fixed-link or SFP configuration.
 527  *
 528  * Returns a pointer to a &struct phylink, or an error-pointer value. Users
 529  * must use IS_ERR() to check for errors from this function.
 530  */
 531 struct phylink *phylink_create(struct net_device *ndev,
 532                                struct fwnode_handle *fwnode,
 533                                phy_interface_t iface,
 534                                const struct phylink_mac_ops *ops)
 535 {
 536         struct phylink *pl;
 537         int ret;
 538
 539         pl = kzalloc(sizeof(*pl), GFP_KERNEL);
 540         if (!pl)
 541                 return ERR_PTR(-ENOMEM);
 542
 543         mutex_init(&pl->state_mutex);
 544         INIT_WORK(&pl->resolve, phylink_resolve);
 545         pl->netdev = ndev;
 546         pl->phy_state.interface = iface;
 547         pl->link_interface = iface;
 548         if (iface == PHY_INTERFACE_MODE_MOCA)
 549                 pl->link_port = PORT_BNC;
 550         else
 551                 pl->link_port = PORT_MII;
 552         pl->link_config.interface = iface;
 553         pl->link_config.pause = MLO_PAUSE_AN;
 554         pl->link_config.speed = SPEED_UNKNOWN;
 555         pl->link_config.duplex = DUPLEX_UNKNOWN;
 556         pl->link_config.an_enabled = true;
 557         pl->ops = ops;
 558         __set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
 559         timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
 560
 561         bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
 562         linkmode_copy(pl->link_config.advertising, pl->supported);
 563         phylink_validate(pl, pl->supported, &pl->link_config);
 564
 565         ret = phylink_parse_mode(pl, fwnode);
 566         if (ret < 0) {
 567                 kfree(pl);
 568                 return ERR_PTR(ret);
 569         }
 570
 571         if (pl->link_an_mode == MLO_AN_FIXED) {
 572                 ret = phylink_parse_fixedlink(pl, fwnode);
 573                 if (ret < 0) {
 574                         kfree(pl);
 575                         return ERR_PTR(ret);
 576                 }
 577         }
 578
 579         ret = phylink_register_sfp(pl, fwnode);
 580         if (ret < 0) {
 581                 kfree(pl);
 582                 return ERR_PTR(ret);
 583         }
 584
 585         return pl;
 586 }
 587 EXPORT_SYMBOL_GPL(phylink_create);
 588
 589 /**
 590  * phylink_destroy() - cleanup and destroy the phylink instance
 591  * @pl: a pointer to a &struct phylink returned from phylink_create()
 592  *
 593  * Destroy a phylink instance. Any PHY that has been attached must have been
 594  * cleaned up via phylink_disconnect_phy() prior to calling this function.
 595  */
 596 void phylink_destroy(struct phylink *pl)
 597 {
 598         if (pl->sfp_bus)
 599                 sfp_unregister_upstream(pl->sfp_bus);
 600         if (!IS_ERR_OR_NULL(pl->link_gpio))
 601                 gpiod_put(pl->link_gpio);
 602
 603         cancel_work_sync(&pl->resolve);
 604         kfree(pl);
 605 }
 606 EXPORT_SYMBOL_GPL(phylink_destroy);
 607
 608 static void phylink_phy_change(struct phy_device *phydev, bool up,
 609                                bool do_carrier)
 610 {
 611         struct phylink *pl = phydev->phylink;
 612
 613         mutex_lock(&pl->state_mutex);
 614         pl->phy_state.speed = phydev->speed;
 615         pl->phy_state.duplex = phydev->duplex;
 616         pl->phy_state.pause = MLO_PAUSE_NONE;
 617         if (phydev->pause)
 618                 pl->phy_state.pause |= MLO_PAUSE_SYM;
 619         if (phydev->asym_pause)
 620                 pl->phy_state.pause |= MLO_PAUSE_ASYM;
 621         pl->phy_state.interface = phydev->interface;
 622         pl->phy_state.link = up;
 623         mutex_unlock(&pl->state_mutex);
 624
 625         phylink_run_resolve(pl);
 626
 627         netdev_dbg(pl->netdev, "phy link %s %s/%s/%s\n", up ? "up" : "down",
 628                    phy_modes(phydev->interface),
 629                    phy_speed_to_str(phydev->speed),
 630                    phy_duplex_to_str(phydev->duplex));
 631 }
 632
 633 static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy)
 634 {
 635         struct phylink_link_state config;
 636         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 637         u32 advertising;
 638         int ret;
 639
 640         memset(&config, 0, sizeof(config));
 641         ethtool_convert_legacy_u32_to_link_mode(supported, phy->supported);
 642         ethtool_convert_legacy_u32_to_link_mode(config.advertising,
 643                                                 phy->advertising);
 644         config.interface = pl->link_config.interface;
 645
 646         /*
 647          * This is the new way of dealing with flow control for PHYs,
 648          * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
 649          * phy drivers should not set SUPPORTED_[Asym_]Pause") except
 650          * using our validate call to the MAC, we rely upon the MAC
 651          * clearing the bits from both supported and advertising fields.
 652          */
 653         if (phylink_test(supported, Pause))
 654                 phylink_set(config.advertising, Pause);
 655         if (phylink_test(supported, Asym_Pause))
 656                 phylink_set(config.advertising, Asym_Pause);
 657
 658         ret = phylink_validate(pl, supported, &config);
 659         if (ret)
 660                 return ret;
 661
 662         phy->phylink = pl;
 663         phy->phy_link_change = phylink_phy_change;
 664
 665         netdev_info(pl->netdev,
 666                     "PHY [%s] driver [%s]\n", dev_name(&phy->mdio.dev),
 667                     phy->drv->name);
 668
 669         mutex_lock(&phy->lock);
 670         mutex_lock(&pl->state_mutex);
 671         pl->phydev = phy;
 672         linkmode_copy(pl->supported, supported);
 673         linkmode_copy(pl->link_config.advertising, config.advertising);
 674
 675         /* Restrict the phy advertisement according to the MAC support. */
 676         ethtool_convert_link_mode_to_legacy_u32(&advertising, config.advertising);
 677         phy->advertising = advertising;
 678         mutex_unlock(&pl->state_mutex);
 679         mutex_unlock(&phy->lock);
 680
 681         netdev_dbg(pl->netdev,
 682                    "phy: setting supported %*pb advertising 0x%08x\n",
 683                    __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
 684                    phy->advertising);
 685
 686         phy_start_machine(phy);
 687         if (phy->irq > 0)
 688                 phy_start_interrupts(phy);
 689
 690         return 0;
 691 }
 692
 693 static int __phylink_connect_phy(struct phylink *pl, struct phy_device *phy,
 694                 phy_interface_t interface)
 695 {
 696         int ret;
 697
 698         if (WARN_ON(pl->link_an_mode == MLO_AN_FIXED ||
 699                     (pl->link_an_mode == MLO_AN_INBAND &&
 700                      phy_interface_mode_is_8023z(interface))))
 701                 return -EINVAL;
 702
 703         if (pl->phydev)
 704                 return -EBUSY;
 705
 706         ret = phy_attach_direct(pl->netdev, phy, 0, interface);
 707         if (ret)
 708                 return ret;
 709
 710         ret = phylink_bringup_phy(pl, phy);
 711         if (ret)
 712                 phy_detach(phy);
 713
 714         return ret;
 715 }
 716
 717 /**
 718  * phylink_connect_phy() - connect a PHY to the phylink instance
 719  * @pl: a pointer to a &struct phylink returned from phylink_create()
 720  * @phy: a pointer to a &struct phy_device.
 721  *
 722  * Connect @phy to the phylink instance specified by @pl by calling
 723  * phy_attach_direct(). Configure the @phy according to the MAC driver's
 724  * capabilities, start the PHYLIB state machine and enable any interrupts
 725  * that the PHY supports.
 726  *
 727  * This updates the phylink's ethtool supported and advertising link mode
 728  * masks.
 729  *
 730  * Returns 0 on success or a negative errno.
 731  */
 732 int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
 733 {
 734         /* Use PHY device/driver interface */
 735         if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
 736                 pl->link_interface = phy->interface;
 737                 pl->link_config.interface = pl->link_interface;
 738         }
 739
 740         return __phylink_connect_phy(pl, phy, pl->link_interface);
 741 }
 742 EXPORT_SYMBOL_GPL(phylink_connect_phy);
 743
 744 /**
 745  * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
 746  * @pl: a pointer to a &struct phylink returned from phylink_create()
 747  * @dn: a pointer to a &struct device_node.
 748  * @flags: PHY-specific flags to communicate to the PHY device driver
 749  *
 750  * Connect the phy specified in the device node @dn to the phylink instance
 751  * specified by @pl. Actions specified in phylink_connect_phy() will be
 752  * performed.
 753  *
 754  * Returns 0 on success or a negative errno.
 755  */
 756 int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
 757                            u32 flags)
 758 {
 759         struct device_node *phy_node;
 760         struct phy_device *phy_dev;
 761         int ret;
 762
 763         /* Fixed links and 802.3z are handled without needing a PHY */
 764         if (pl->link_an_mode == MLO_AN_FIXED ||
 765             (pl->link_an_mode == MLO_AN_INBAND &&
 766              phy_interface_mode_is_8023z(pl->link_interface)))
 767                 return 0;
 768
 769         phy_node = of_parse_phandle(dn, "phy-handle", 0);
 770         if (!phy_node)
 771                 phy_node = of_parse_phandle(dn, "phy", 0);
 772         if (!phy_node)
 773                 phy_node = of_parse_phandle(dn, "phy-device", 0);
 774
 775         if (!phy_node) {
 776                 if (pl->link_an_mode == MLO_AN_PHY)
 777                         return -ENODEV;
 778                 return 0;
 779         }
 780
 781         phy_dev = of_phy_attach(pl->netdev, phy_node, flags,
 782                                 pl->link_interface);
 783         /* We're done with the phy_node handle */
 784         of_node_put(phy_node);
 785
 786         if (!phy_dev)
 787                 return -ENODEV;
 788
 789         ret = phylink_bringup_phy(pl, phy_dev);
 790         if (ret)
 791                 phy_detach(phy_dev);
 792
 793         return ret;
 794 }
 795 EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
 796
 797 /**
 798  * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
 799  *   instance.
 800  * @pl: a pointer to a &struct phylink returned from phylink_create()
 801  *
 802  * Disconnect any current PHY from the phylink instance described by @pl.
 803  */
 804 void phylink_disconnect_phy(struct phylink *pl)
 805 {
 806         struct phy_device *phy;
 807
 808         ASSERT_RTNL();
 809
 810         phy = pl->phydev;
 811         if (phy) {
 812                 mutex_lock(&phy->lock);
 813                 mutex_lock(&pl->state_mutex);
 814                 pl->phydev = NULL;
 815                 mutex_unlock(&pl->state_mutex);
 816                 mutex_unlock(&phy->lock);
 817                 flush_work(&pl->resolve);
 818
 819                 phy_disconnect(phy);
 820         }
 821 }
 822 EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
 823
 824 /**
 825  * phylink_fixed_state_cb() - allow setting a fixed link callback
 826  * @pl: a pointer to a &struct phylink returned from phylink_create()
 827  * @cb: callback to execute to determine the fixed link state.
 828  *
 829  * The MAC driver should call this driver when the state of its link
 830  * can be determined through e.g: an out of band MMIO register.
 831  */
 832 int phylink_fixed_state_cb(struct phylink *pl,
 833                            void (*cb)(struct net_device *dev,
 834                                       struct phylink_link_state *state))
 835 {
 836         /* It does not make sense to let the link be overriden unless we use
 837          * MLO_AN_FIXED
 838          */
 839         if (pl->link_an_mode != MLO_AN_FIXED)
 840                 return -EINVAL;
 841
 842         mutex_lock(&pl->state_mutex);
 843         pl->get_fixed_state = cb;
 844         mutex_unlock(&pl->state_mutex);
 845
 846         return 0;
 847 }
 848 EXPORT_SYMBOL_GPL(phylink_fixed_state_cb);
 849
 850 /**
 851  * phylink_mac_change() - notify phylink of a change in MAC state
 852  * @pl: a pointer to a &struct phylink returned from phylink_create()
 853  * @up: indicates whether the link is currently up.
 854  *
 855  * The MAC driver should call this driver when the state of its link
 856  * changes (eg, link failure, new negotiation results, etc.)
 857  */
 858 void phylink_mac_change(struct phylink *pl, bool up)
 859 {
 860         if (!up)
 861                 pl->mac_link_dropped = true;
 862         phylink_run_resolve(pl);
 863         netdev_dbg(pl->netdev, "mac link %s\n", up ? "up" : "down");
 864 }
 865 EXPORT_SYMBOL_GPL(phylink_mac_change);
 866
 867 /**
 868  * phylink_start() - start a phylink instance
 869  * @pl: a pointer to a &struct phylink returned from phylink_create()
 870  *
 871  * Start the phylink instance specified by @pl, configuring the MAC for the
 872  * desired link mode(s) and negotiation style. This should be called from the
 873  * network device driver's &struct net_device_ops ndo_open() method.
 874  */
 875 void phylink_start(struct phylink *pl)
 876 {
 877         ASSERT_RTNL();
 878
 879         netdev_info(pl->netdev, "configuring for %s/%s link mode\n",
 880                     phylink_an_mode_str(pl->link_an_mode),
 881                     phy_modes(pl->link_config.interface));
 882
 883         /* Always set the carrier off */
 884         netif_carrier_off(pl->netdev);
 885
 886         /* Apply the link configuration to the MAC when starting. This allows
 887          * a fixed-link to start with the correct parameters, and also
 888          * ensures that we set the appropriate advertisement for Serdes links.
 889          */
 890         phylink_resolve_flow(pl, &pl->link_config);
 891         phylink_mac_config(pl, &pl->link_config);
 892
 893         /* Restart autonegotiation if using 802.3z to ensure that the link
 894          * parameters are properly negotiated.  This is necessary for DSA
 895          * switches using 802.3z negotiation to ensure they see our modes.
 896          */
 897         phylink_mac_an_restart(pl);
 898
 899         clear_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
 900         phylink_run_resolve(pl);
 901
 902         if (pl->link_an_mode == MLO_AN_FIXED && !IS_ERR(pl->link_gpio))
 903                 mod_timer(&pl->link_poll, jiffies + HZ);
 904         if (pl->sfp_bus)
 905                 sfp_upstream_start(pl->sfp_bus);
 906         if (pl->phydev)
 907                 phy_start(pl->phydev);
 908 }
 909 EXPORT_SYMBOL_GPL(phylink_start);
 910
 911 /**
 912  * phylink_stop() - stop a phylink instance
 913  * @pl: a pointer to a &struct phylink returned from phylink_create()
 914  *
 915  * Stop the phylink instance specified by @pl. This should be called from the
 916  * network device driver's &struct net_device_ops ndo_stop() method.  The
 917  * network device's carrier state should not be changed prior to calling this
 918  * function.
 919  */
 920 void phylink_stop(struct phylink *pl)
 921 {
 922         ASSERT_RTNL();
 923
 924         if (pl->phydev)
 925                 phy_stop(pl->phydev);
 926         if (pl->sfp_bus)
 927                 sfp_upstream_stop(pl->sfp_bus);
 928         if (pl->link_an_mode == MLO_AN_FIXED && !IS_ERR(pl->link_gpio))
 929                 del_timer_sync(&pl->link_poll);
 930
 931         set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
 932         queue_work(system_power_efficient_wq, &pl->resolve);
 933         flush_work(&pl->resolve);
 934 }
 935 EXPORT_SYMBOL_GPL(phylink_stop);
 936
 937 /**
 938  * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
 939  * @pl: a pointer to a &struct phylink returned from phylink_create()
 940  * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
 941  *
 942  * Read the wake on lan parameters from the PHY attached to the phylink
 943  * instance specified by @pl. If no PHY is currently attached, report no
 944  * support for wake on lan.
 945  */
 946 void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
 947 {
 948         ASSERT_RTNL();
 949
 950         wol->supported = 0;
 951         wol->wolopts = 0;
 952
 953         if (pl->phydev)
 954                 phy_ethtool_get_wol(pl->phydev, wol);
 955 }
 956 EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
 957
 958 /**
 959  * phylink_ethtool_set_wol() - set wake on lan parameters
 960  * @pl: a pointer to a &struct phylink returned from phylink_create()
 961  * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
 962  *
 963  * Set the wake on lan parameters for the PHY attached to the phylink
 964  * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
 965  * error.
 966  *
 967  * Returns zero on success or negative errno code.
 968  */
 969 int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
 970 {
 971         int ret = -EOPNOTSUPP;
 972
 973         ASSERT_RTNL();
 974
 975         if (pl->phydev)
 976                 ret = phy_ethtool_set_wol(pl->phydev, wol);
 977
 978         return ret;
 979 }
 980 EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
 981
 982 static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
 983 {
 984         __ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
 985
 986         linkmode_zero(mask);
 987         phylink_set_port_modes(mask);
 988
 989         linkmode_and(dst, dst, mask);
 990         linkmode_or(dst, dst, b);
 991 }
 992
 993 static void phylink_get_ksettings(const struct phylink_link_state *state,
 994                                   struct ethtool_link_ksettings *kset)
 995 {
 996         phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
 997         linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
 998         kset->base.speed = state->speed;
 999         kset->base.duplex = state->duplex;
1000         kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
1001                                 AUTONEG_DISABLE;
1002 }
1003
1004 /**
1005  * phylink_ethtool_ksettings_get() - get the current link settings
1006  * @pl: a pointer to a &struct phylink returned from phylink_create()
1007  * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
1008  *
1009  * Read the current link settings for the phylink instance specified by @pl.
1010  * This will be the link settings read from the MAC, PHY or fixed link
1011  * settings depending on the current negotiation mode.
1012  */
1013 int phylink_ethtool_ksettings_get(struct phylink *pl,
1014                                   struct ethtool_link_ksettings *kset)
1015 {
1016         struct phylink_link_state link_state;
1017
1018         ASSERT_RTNL();
1019
1020         if (pl->phydev) {
1021                 phy_ethtool_ksettings_get(pl->phydev, kset);
1022         } else {
1023                 kset->base.port = pl->link_port;
1024         }
1025
1026         linkmode_copy(kset->link_modes.supported, pl->supported);
1027
1028         switch (pl->link_an_mode) {
1029         case MLO_AN_FIXED:
1030                 /* We are using fixed settings. Report these as the
1031                  * current link settings - and note that these also
1032                  * represent the supported speeds/duplex/pause modes.
1033                  */
1034                 phylink_get_fixed_state(pl, &link_state);
1035                 phylink_get_ksettings(&link_state, kset);
1036                 break;
1037
1038         case MLO_AN_INBAND:
1039                 /* If there is a phy attached, then use the reported
1040                  * settings from the phy with no modification.
1041                  */
1042                 if (pl->phydev)
1043                         break;
1044
1045                 phylink_get_mac_state(pl, &link_state);
1046
1047                 /* The MAC is reporting the link results from its own PCS
1048                  * layer via in-band status. Report these as the current
1049                  * link settings.
1050                  */
1051                 phylink_get_ksettings(&link_state, kset);
1052                 break;
1053         }
1054
1055         return 0;
1056 }
1057 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
1058
1059 /**
1060  * phylink_ethtool_ksettings_set() - set the link settings
1061  * @pl: a pointer to a &struct phylink returned from phylink_create()
1062  * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
1063  */
1064 int phylink_ethtool_ksettings_set(struct phylink *pl,
1065                                   const struct ethtool_link_ksettings *kset)
1066 {
1067         struct ethtool_link_ksettings our_kset;
1068         struct phylink_link_state config;
1069         int ret;
1070
1071         ASSERT_RTNL();
1072
1073         if (kset->base.autoneg != AUTONEG_DISABLE &&
1074             kset->base.autoneg != AUTONEG_ENABLE)
1075                 return -EINVAL;
1076
1077         config = pl->link_config;
1078
1079         /* Mask out unsupported advertisements */
1080         linkmode_and(config.advertising, kset->link_modes.advertising,
1081                      pl->supported);
1082
1083         /* FIXME: should we reject autoneg if phy/mac does not support it? */
1084         if (kset->base.autoneg == AUTONEG_DISABLE) {
1085                 const struct phy_setting *s;
1086
1087                 /* Autonegotiation disabled, select a suitable speed and
1088                  * duplex.
1089                  */
1090                 s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
1091                                        pl->supported,
1092                                        __ETHTOOL_LINK_MODE_MASK_NBITS, false);
1093                 if (!s)
1094                         return -EINVAL;
1095
1096                 /* If we have a fixed link (as specified by firmware), refuse
1097                  * to change link parameters.
1098                  */
1099                 if (pl->link_an_mode == MLO_AN_FIXED &&
1100                     (s->speed != pl->link_config.speed ||
1101                      s->duplex != pl->link_config.duplex))
1102                         return -EINVAL;
1103
1104                 config.speed = s->speed;
1105                 config.duplex = s->duplex;
1106                 config.an_enabled = false;
1107
1108                 __clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1109         } else {
1110                 /* If we have a fixed link, refuse to enable autonegotiation */
1111                 if (pl->link_an_mode == MLO_AN_FIXED)
1112                         return -EINVAL;
1113
1114                 config.speed = SPEED_UNKNOWN;
1115                 config.duplex = DUPLEX_UNKNOWN;
1116                 config.an_enabled = true;
1117
1118                 __set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1119         }
1120
1121         if (phylink_validate(pl, pl->supported, &config))
1122                 return -EINVAL;
1123
1124         /* If autonegotiation is enabled, we must have an advertisement */
1125         if (config.an_enabled && phylink_is_empty_linkmode(config.advertising))
1126                 return -EINVAL;
1127
1128         our_kset = *kset;
1129         linkmode_copy(our_kset.link_modes.advertising, config.advertising);
1130         our_kset.base.speed = config.speed;
1131         our_kset.base.duplex = config.duplex;
1132
1133         /* If we have a PHY, configure the phy */
1134         if (pl->phydev) {
1135                 ret = phy_ethtool_ksettings_set(pl->phydev, &our_kset);
1136                 if (ret)
1137                         return ret;
1138         }
1139
1140         mutex_lock(&pl->state_mutex);
1141         /* Configure the MAC to match the new settings */
1142         linkmode_copy(pl->link_config.advertising, our_kset.link_modes.advertising);
1143         pl->link_config.interface = config.interface;
1144         pl->link_config.speed = our_kset.base.speed;
1145         pl->link_config.duplex = our_kset.base.duplex;
1146         pl->link_config.an_enabled = our_kset.base.autoneg != AUTONEG_DISABLE;
1147
1148         if (!test_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state)) {
1149                 phylink_mac_config(pl, &pl->link_config);
1150                 phylink_mac_an_restart(pl);
1151         }
1152         mutex_unlock(&pl->state_mutex);
1153
1154         return 0;
1155 }
1156 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
1157
1158 /**
1159  * phylink_ethtool_nway_reset() - restart negotiation
1160  * @pl: a pointer to a &struct phylink returned from phylink_create()
1161  *
1162  * Restart negotiation for the phylink instance specified by @pl. This will
1163  * cause any attached phy to restart negotiation with the link partner, and
1164  * if the MAC is in a BaseX mode, the MAC will also be requested to restart
1165  * negotiation.
1166  *
1167  * Returns zero on success, or negative error code.
1168  */
1169 int phylink_ethtool_nway_reset(struct phylink *pl)
1170 {
1171         int ret = 0;
1172
1173         ASSERT_RTNL();
1174
1175         if (pl->phydev)
1176                 ret = phy_restart_aneg(pl->phydev);
1177         phylink_mac_an_restart(pl);
1178
1179         return ret;
1180 }
1181 EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
1182
1183 /**
1184  * phylink_ethtool_get_pauseparam() - get the current pause parameters
1185  * @pl: a pointer to a &struct phylink returned from phylink_create()
1186  * @pause: a pointer to a &struct ethtool_pauseparam
1187  */
1188 void phylink_ethtool_get_pauseparam(struct phylink *pl,
1189                                     struct ethtool_pauseparam *pause)
1190 {
1191         ASSERT_RTNL();
1192
1193         pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
1194         pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
1195         pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
1196 }
1197 EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
1198
1199 /**
1200  * phylink_ethtool_set_pauseparam() - set the current pause parameters
1201  * @pl: a pointer to a &struct phylink returned from phylink_create()
1202  * @pause: a pointer to a &struct ethtool_pauseparam
1203  */
1204 int phylink_ethtool_set_pauseparam(struct phylink *pl,
1205                                    struct ethtool_pauseparam *pause)
1206 {
1207         struct phylink_link_state *config = &pl->link_config;
1208
1209         ASSERT_RTNL();
1210
1211         if (!phylink_test(pl->supported, Pause) &&
1212             !phylink_test(pl->supported, Asym_Pause))
1213                 return -EOPNOTSUPP;
1214
1215         if (!phylink_test(pl->supported, Asym_Pause) &&
1216             !pause->autoneg && pause->rx_pause != pause->tx_pause)
1217                 return -EINVAL;
1218
1219         config->pause &= ~(MLO_PAUSE_AN | MLO_PAUSE_TXRX_MASK);
1220
1221         if (pause->autoneg)
1222                 config->pause |= MLO_PAUSE_AN;
1223         if (pause->rx_pause)
1224                 config->pause |= MLO_PAUSE_RX;
1225         if (pause->tx_pause)
1226                 config->pause |= MLO_PAUSE_TX;
1227
1228         if (!test_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state)) {
1229                 switch (pl->link_an_mode) {
1230                 case MLO_AN_PHY:
1231                         /* Silently mark the carrier down, and then trigger a resolve */
1232                         netif_carrier_off(pl->netdev);
1233                         phylink_run_resolve(pl);
1234                         break;
1235
1236                 case MLO_AN_FIXED:
1237                         /* Should we allow fixed links to change against the config? */
1238                         phylink_resolve_flow(pl, config);
1239                         phylink_mac_config(pl, config);
1240                         break;
1241
1242                 case MLO_AN_INBAND:
1243                         phylink_mac_config(pl, config);
1244                         phylink_mac_an_restart(pl);
1245                         break;
1246                 }
1247         }
1248
1249         return 0;
1250 }
1251 EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
1252
1253 /**
1254  * phylink_ethtool_get_eee_err() - read the energy efficient ethernet error
1255  *   counter
1256  * @pl: a pointer to a &struct phylink returned from phylink_create().
1257  *
1258  * Read the Energy Efficient Ethernet error counter from the PHY associated
1259  * with the phylink instance specified by @pl.
1260  *
1261  * Returns positive error counter value, or negative error code.
1262  */
1263 int phylink_get_eee_err(struct phylink *pl)
1264 {
1265         int ret = 0;
1266
1267         ASSERT_RTNL();
1268
1269         if (pl->phydev)
1270                 ret = phy_get_eee_err(pl->phydev);
1271
1272         return ret;
1273 }
1274 EXPORT_SYMBOL_GPL(phylink_get_eee_err);
1275
1276 /**
1277  * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
1278  * @pl: a pointer to a &struct phylink returned from phylink_create()
1279  * @eee: a pointer to a &struct ethtool_eee for the read parameters
1280  */
1281 int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
1282 {
1283         int ret = -EOPNOTSUPP;
1284
1285         ASSERT_RTNL();
1286
1287         if (pl->phydev)
1288                 ret = phy_ethtool_get_eee(pl->phydev, eee);
1289
1290         return ret;
1291 }
1292 EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
1293
1294 /**
1295  * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
1296  * @pl: a pointer to a &struct phylink returned from phylink_create()
1297  * @eee: a pointer to a &struct ethtool_eee for the desired parameters
1298  */
1299 int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
1300 {
1301         int ret = -EOPNOTSUPP;
1302
1303         ASSERT_RTNL();
1304
1305         if (pl->phydev)
1306                 ret = phy_ethtool_set_eee(pl->phydev, eee);
1307
1308         return ret;
1309 }
1310 EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
1311
1312 /* This emulates MII registers for a fixed-mode phy operating as per the
1313  * passed in state. "aneg" defines if we report negotiation is possible.
1314  *
1315  * FIXME: should deal with negotiation state too.
1316  */
1317 static int phylink_mii_emul_read(struct net_device *ndev, unsigned int reg,
1318                                  struct phylink_link_state *state, bool aneg)
1319 {
1320         struct fixed_phy_status fs;
1321         int val;
1322
1323         fs.link = state->link;
1324         fs.speed = state->speed;
1325         fs.duplex = state->duplex;
1326         fs.pause = state->pause & MLO_PAUSE_SYM;
1327         fs.asym_pause = state->pause & MLO_PAUSE_ASYM;
1328
1329         val = swphy_read_reg(reg, &fs);
1330         if (reg == MII_BMSR) {
1331                 if (!state->an_complete)
1332                         val &= ~BMSR_ANEGCOMPLETE;
1333                 if (!aneg)
1334                         val &= ~BMSR_ANEGCAPABLE;
1335         }
1336         return val;
1337 }
1338
1339 static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
1340                             unsigned int reg)
1341 {
1342         struct phy_device *phydev = pl->phydev;
1343         int prtad, devad;
1344
1345         if (mdio_phy_id_is_c45(phy_id)) {
1346                 prtad = mdio_phy_id_prtad(phy_id);
1347                 devad = mdio_phy_id_devad(phy_id);
1348                 devad = MII_ADDR_C45 | devad << 16 | reg;
1349         } else if (phydev->is_c45) {
1350                 switch (reg) {
1351                 case MII_BMCR:
1352                 case MII_BMSR:
1353                 case MII_PHYSID1:
1354                 case MII_PHYSID2:
1355                         devad = __ffs(phydev->c45_ids.devices_in_package);
1356                         break;
1357                 case MII_ADVERTISE:
1358                 case MII_LPA:
1359                         if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1360                                 return -EINVAL;
1361                         devad = MDIO_MMD_AN;
1362                         if (reg == MII_ADVERTISE)
1363                                 reg = MDIO_AN_ADVERTISE;
1364                         else
1365                                 reg = MDIO_AN_LPA;
1366                         break;
1367                 default:
1368                         return -EINVAL;
1369                 }
1370                 prtad = phy_id;
1371                 devad = MII_ADDR_C45 | devad << 16 | reg;
1372         } else {
1373                 prtad = phy_id;
1374                 devad = reg;
1375         }
1376         return mdiobus_read(pl->phydev->mdio.bus, prtad, devad);
1377 }
1378
1379 static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
1380                              unsigned int reg, unsigned int val)
1381 {
1382         struct phy_device *phydev = pl->phydev;
1383         int prtad, devad;
1384
1385         if (mdio_phy_id_is_c45(phy_id)) {
1386                 prtad = mdio_phy_id_prtad(phy_id);
1387                 devad = mdio_phy_id_devad(phy_id);
1388                 devad = MII_ADDR_C45 | devad << 16 | reg;
1389         } else if (phydev->is_c45) {
1390                 switch (reg) {
1391                 case MII_BMCR:
1392                 case MII_BMSR:
1393                 case MII_PHYSID1:
1394                 case MII_PHYSID2:
1395                         devad = __ffs(phydev->c45_ids.devices_in_package);
1396                         break;
1397                 case MII_ADVERTISE:
1398                 case MII_LPA:
1399                         if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1400                                 return -EINVAL;
1401                         devad = MDIO_MMD_AN;
1402                         if (reg == MII_ADVERTISE)
1403                                 reg = MDIO_AN_ADVERTISE;
1404                         else
1405                                 reg = MDIO_AN_LPA;
1406                         break;
1407                 default:
1408                         return -EINVAL;
1409                 }
1410                 prtad = phy_id;
1411                 devad = MII_ADDR_C45 | devad << 16 | reg;
1412         } else {
1413                 prtad = phy_id;
1414                 devad = reg;
1415         }
1416
1417         return mdiobus_write(phydev->mdio.bus, prtad, devad, val);
1418 }
1419
1420 static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
1421                             unsigned int reg)
1422 {
1423         struct phylink_link_state state;
1424         int val = 0xffff;
1425
1426         switch (pl->link_an_mode) {
1427         case MLO_AN_FIXED:
1428                 if (phy_id == 0) {
1429                         phylink_get_fixed_state(pl, &state);
1430                         val = phylink_mii_emul_read(pl->netdev, reg, &state,
1431                                                     true);
1432                 }
1433                 break;
1434
1435         case MLO_AN_PHY:
1436                 return -EOPNOTSUPP;
1437
1438         case MLO_AN_INBAND:
1439                 if (phy_id == 0) {
1440                         val = phylink_get_mac_state(pl, &state);
1441                         if (val < 0)
1442                                 return val;
1443
1444                         val = phylink_mii_emul_read(pl->netdev, reg, &state,
1445                                                     true);
1446                 }
1447                 break;
1448         }
1449
1450         return val & 0xffff;
1451 }
1452
1453 static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
1454                              unsigned int reg, unsigned int val)
1455 {
1456         switch (pl->link_an_mode) {
1457         case MLO_AN_FIXED:
1458                 break;
1459
1460         case MLO_AN_PHY:
1461                 return -EOPNOTSUPP;
1462
1463         case MLO_AN_INBAND:
1464                 break;
1465         }
1466
1467         return 0;
1468 }
1469
1470 /**
1471  * phylink_mii_ioctl() - generic mii ioctl interface
1472  * @pl: a pointer to a &struct phylink returned from phylink_create()
1473  * @ifr: a pointer to a &struct ifreq for socket ioctls
1474  * @cmd: ioctl cmd to execute
1475  *
1476  * Perform the specified MII ioctl on the PHY attached to the phylink instance
1477  * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
1478  *
1479  * Returns: zero on success or negative error code.
1480  *
1481  * %SIOCGMIIPHY:
1482  *  read register from the current PHY.
1483  * %SIOCGMIIREG:
1484  *  read register from the specified PHY.
1485  * %SIOCSMIIREG:
1486  *  set a register on the specified PHY.
1487  */
1488 int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
1489 {
1490         struct mii_ioctl_data *mii = if_mii(ifr);
1491         int  ret;
1492
1493         ASSERT_RTNL();
1494
1495         if (pl->phydev) {
1496                 /* PHYs only exist for MLO_AN_PHY and SGMII */
1497                 switch (cmd) {
1498                 case SIOCGMIIPHY:
1499                         mii->phy_id = pl->phydev->mdio.addr;
1500                         /* fall through */
1501
1502                 case SIOCGMIIREG:
1503                         ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
1504                         if (ret >= 0) {
1505                                 mii->val_out = ret;
1506                                 ret = 0;
1507                         }
1508                         break;
1509
1510                 case SIOCSMIIREG:
1511                         ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
1512                                                 mii->val_in);
1513                         break;
1514
1515                 default:
1516                         ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
1517                         break;
1518                 }
1519         } else {
1520                 switch (cmd) {
1521                 case SIOCGMIIPHY:
1522                         mii->phy_id = 0;
1523                         /* fall through */
1524
1525                 case SIOCGMIIREG:
1526                         ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
1527                         if (ret >= 0) {
1528                                 mii->val_out = ret;
1529                                 ret = 0;
1530                         }
1531                         break;
1532
1533                 case SIOCSMIIREG:
1534                         ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
1535                                                 mii->val_in);
1536                         break;
1537
1538                 default:
1539                         ret = -EOPNOTSUPP;
1540                         break;
1541                 }
1542         }
1543
1544         return ret;
1545 }
1546 EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
1547
1548 static int phylink_sfp_module_insert(void *upstream,
1549                                      const struct sfp_eeprom_id *id)
1550 {
1551         struct phylink *pl = upstream;
1552         __ETHTOOL_DECLARE_LINK_MODE_MASK(support) = { 0, };
1553         struct phylink_link_state config;
1554         phy_interface_t iface;
1555         int ret = 0;
1556         bool changed;
1557         u8 port;
1558
1559         ASSERT_RTNL();
1560
1561         sfp_parse_support(pl->sfp_bus, id, support);
1562         port = sfp_parse_port(pl->sfp_bus, id, support);
1563
1564         memset(&config, 0, sizeof(config));
1565         linkmode_copy(config.advertising, support);
1566         config.interface = PHY_INTERFACE_MODE_NA;
1567         config.speed = SPEED_UNKNOWN;
1568         config.duplex = DUPLEX_UNKNOWN;
1569         config.pause = MLO_PAUSE_AN;
1570         config.an_enabled = pl->link_config.an_enabled;
1571
1572         /* Ignore errors if we're expecting a PHY to attach later */
1573         ret = phylink_validate(pl, support, &config);
1574         if (ret) {
1575                 netdev_err(pl->netdev, "validation with support %*pb failed: %d\n",
1576                            __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1577                 return ret;
1578         }
1579
1580         iface = sfp_select_interface(pl->sfp_bus, id, config.advertising);
1581         if (iface == PHY_INTERFACE_MODE_NA) {
1582                 netdev_err(pl->netdev,
1583                            "selection of interface failed, advertisement %*pb\n",
1584                            __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
1585                 return -EINVAL;
1586         }
1587
1588         config.interface = iface;
1589         ret = phylink_validate(pl, support, &config);
1590         if (ret) {
1591                 netdev_err(pl->netdev, "validation of %s/%s with support %*pb failed: %d\n",
1592                            phylink_an_mode_str(MLO_AN_INBAND),
1593                            phy_modes(config.interface),
1594                            __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1595                 return ret;
1596         }
1597
1598         netdev_dbg(pl->netdev, "requesting link mode %s/%s with support %*pb\n",
1599                    phylink_an_mode_str(MLO_AN_INBAND),
1600                    phy_modes(config.interface),
1601                    __ETHTOOL_LINK_MODE_MASK_NBITS, support);
1602
1603         if (phy_interface_mode_is_8023z(iface) && pl->phydev)
1604                 return -EINVAL;
1605
1606         changed = !bitmap_equal(pl->supported, support,
1607                                 __ETHTOOL_LINK_MODE_MASK_NBITS);
1608         if (changed) {
1609                 linkmode_copy(pl->supported, support);
1610                 linkmode_copy(pl->link_config.advertising, config.advertising);
1611         }
1612
1613         if (pl->link_an_mode != MLO_AN_INBAND ||
1614             pl->link_config.interface != config.interface) {
1615                 pl->link_config.interface = config.interface;
1616                 pl->link_an_mode = MLO_AN_INBAND;
1617
1618                 changed = true;
1619
1620                 netdev_info(pl->netdev, "switched to %s/%s link mode\n",
1621                             phylink_an_mode_str(MLO_AN_INBAND),
1622                             phy_modes(config.interface));
1623         }
1624
1625         pl->link_port = port;
1626
1627         if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
1628                                  &pl->phylink_disable_state))
1629                 phylink_mac_config(pl, &pl->link_config);
1630
1631         return ret;
1632 }
1633
1634 static void phylink_sfp_link_down(void *upstream)
1635 {
1636         struct phylink *pl = upstream;
1637
1638         ASSERT_RTNL();
1639
1640         set_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
1641         queue_work(system_power_efficient_wq, &pl->resolve);
1642         flush_work(&pl->resolve);
1643 }
1644
1645 static void phylink_sfp_link_up(void *upstream)
1646 {
1647         struct phylink *pl = upstream;
1648
1649         ASSERT_RTNL();
1650
1651         clear_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
1652         phylink_run_resolve(pl);
1653 }
1654
1655 static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
1656 {
1657         struct phylink *pl = upstream;
1658
1659         return __phylink_connect_phy(upstream, phy, pl->link_config.interface);
1660 }
1661
1662 static void phylink_sfp_disconnect_phy(void *upstream)
1663 {
1664         phylink_disconnect_phy(upstream);
1665 }
1666
1667 static const struct sfp_upstream_ops sfp_phylink_ops = {
1668         .module_insert = phylink_sfp_module_insert,
1669         .link_up = phylink_sfp_link_up,
1670         .link_down = phylink_sfp_link_down,
1671         .connect_phy = phylink_sfp_connect_phy,
1672         .disconnect_phy = phylink_sfp_disconnect_phy,
1673 };
1674
1675 /* Helpers for MAC drivers */
1676
1677 /**
1678  * phylink_helper_basex_speed() - 1000BaseX/2500BaseX helper
1679  * @state: a pointer to a &struct phylink_link_state
1680  *
1681  * Inspect the interface mode, advertising mask or forced speed and
1682  * decide whether to run at 2.5Gbit or 1Gbit appropriately, switching
1683  * the interface mode to suit.  @state->interface is appropriately
1684  * updated, and the advertising mask has the "other" baseX_Full flag
1685  * cleared.
1686  */
1687 void phylink_helper_basex_speed(struct phylink_link_state *state)
1688 {
1689         if (phy_interface_mode_is_8023z(state->interface)) {
1690                 bool want_2500 = state->an_enabled ?
1691                         phylink_test(state->advertising, 2500baseX_Full) :
1692                         state->speed == SPEED_2500;
1693
1694                 if (want_2500) {
1695                         phylink_clear(state->advertising, 1000baseX_Full);
1696                         state->interface = PHY_INTERFACE_MODE_2500BASEX;
1697                 } else {
1698                         phylink_clear(state->advertising, 2500baseX_Full);
1699                         state->interface = PHY_INTERFACE_MODE_1000BASEX;
1700                 }
1701         }
1702 }
1703 EXPORT_SYMBOL_GPL(phylink_helper_basex_speed);
1704
1705 MODULE_LICENSE("GPL");