1 // SPDX-License-Identifier: GPL-2.0
3 * phylink models the MAC to optional PHY connection, supporting
4 * technologies such as SFP cages where the PHY is hot-pluggable.
6 * Copyright (C) 2015 Russell King
8 #include <linux/ethtool.h>
9 #include <linux/export.h>
10 #include <linux/gpio/consumer.h>
11 #include <linux/netdevice.h>
13 #include <linux/of_mdio.h>
14 #include <linux/phy.h>
15 #include <linux/phy_fixed.h>
16 #include <linux/phylink.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/spinlock.h>
19 #include <linux/timer.h>
20 #include <linux/workqueue.h>
25 #define SUPPORTED_INTERFACES \
26 (SUPPORTED_TP | SUPPORTED_MII | SUPPORTED_FIBRE | \
27 SUPPORTED_BNC | SUPPORTED_AUI | SUPPORTED_Backplane)
28 #define ADVERTISED_INTERFACES \
29 (ADVERTISED_TP | ADVERTISED_MII | ADVERTISED_FIBRE | \
30 ADVERTISED_BNC | ADVERTISED_AUI | ADVERTISED_Backplane)
33 PHYLINK_DISABLE_STOPPED,
38 * struct phylink - internal data type for phylink
42 struct net_device *netdev;
43 const struct phylink_mac_ops *ops;
44 struct phylink_config *config;
46 unsigned int old_link_state:1;
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 cfg_link_an_mode; /* MLO_AN_xxx */
53 u8 link_port; /* The current non-phy ethtool port */
54 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
56 /* The link configuration settings */
57 struct phylink_link_state link_config;
59 /* The current settings */
60 phy_interface_t cur_interface;
62 struct gpio_desc *link_gpio;
63 unsigned int link_irq;
64 struct timer_list link_poll;
65 void (*get_fixed_state)(struct net_device *dev,
66 struct phylink_link_state *s);
68 struct mutex state_mutex;
69 struct phylink_link_state phy_state;
70 struct work_struct resolve;
72 bool mac_link_dropped;
74 struct sfp_bus *sfp_bus;
75 bool sfp_may_have_phy;
76 __ETHTOOL_DECLARE_LINK_MODE_MASK(sfp_support);
80 #define phylink_printk(level, pl, fmt, ...) \
82 if ((pl)->config->type == PHYLINK_NETDEV) \
83 netdev_printk(level, (pl)->netdev, fmt, ##__VA_ARGS__); \
84 else if ((pl)->config->type == PHYLINK_DEV) \
85 dev_printk(level, (pl)->dev, fmt, ##__VA_ARGS__); \
88 #define phylink_err(pl, fmt, ...) \
89 phylink_printk(KERN_ERR, pl, fmt, ##__VA_ARGS__)
90 #define phylink_warn(pl, fmt, ...) \
91 phylink_printk(KERN_WARNING, pl, fmt, ##__VA_ARGS__)
92 #define phylink_info(pl, fmt, ...) \
93 phylink_printk(KERN_INFO, pl, fmt, ##__VA_ARGS__)
94 #if defined(CONFIG_DYNAMIC_DEBUG)
95 #define phylink_dbg(pl, fmt, ...) \
97 if ((pl)->config->type == PHYLINK_NETDEV) \
98 netdev_dbg((pl)->netdev, fmt, ##__VA_ARGS__); \
99 else if ((pl)->config->type == PHYLINK_DEV) \
100 dev_dbg((pl)->dev, fmt, ##__VA_ARGS__); \
103 #define phylink_dbg(pl, fmt, ...) \
104 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__)
106 #define phylink_dbg(pl, fmt, ...) \
109 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__); \
114 * phylink_set_port_modes() - set the port type modes in the ethtool mask
115 * @mask: ethtool link mode mask
117 * Sets all the port type modes in the ethtool mask. MAC drivers should
118 * use this in their 'validate' callback.
120 void phylink_set_port_modes(unsigned long *mask)
122 phylink_set(mask, TP);
123 phylink_set(mask, AUI);
124 phylink_set(mask, MII);
125 phylink_set(mask, FIBRE);
126 phylink_set(mask, BNC);
127 phylink_set(mask, Backplane);
129 EXPORT_SYMBOL_GPL(phylink_set_port_modes);
131 static int phylink_is_empty_linkmode(const unsigned long *linkmode)
133 __ETHTOOL_DECLARE_LINK_MODE_MASK(tmp) = { 0, };
135 phylink_set_port_modes(tmp);
136 phylink_set(tmp, Autoneg);
137 phylink_set(tmp, Pause);
138 phylink_set(tmp, Asym_Pause);
140 return linkmode_subset(linkmode, tmp);
143 static const char *phylink_an_mode_str(unsigned int mode)
145 static const char *modestr[] = {
146 [MLO_AN_PHY] = "phy",
147 [MLO_AN_FIXED] = "fixed",
148 [MLO_AN_INBAND] = "inband",
151 return mode < ARRAY_SIZE(modestr) ? modestr[mode] : "unknown";
154 static int phylink_validate(struct phylink *pl, unsigned long *supported,
155 struct phylink_link_state *state)
157 pl->ops->validate(pl->config, supported, state);
159 return phylink_is_empty_linkmode(supported) ? -EINVAL : 0;
162 static int phylink_parse_fixedlink(struct phylink *pl,
163 struct fwnode_handle *fwnode)
165 struct fwnode_handle *fixed_node;
166 const struct phy_setting *s;
167 struct gpio_desc *desc;
171 fixed_node = fwnode_get_named_child_node(fwnode, "fixed-link");
173 ret = fwnode_property_read_u32(fixed_node, "speed", &speed);
175 pl->link_config.speed = speed;
176 pl->link_config.duplex = DUPLEX_HALF;
178 if (fwnode_property_read_bool(fixed_node, "full-duplex"))
179 pl->link_config.duplex = DUPLEX_FULL;
181 /* We treat the "pause" and "asym-pause" terminology as
182 * defining the link partner's ability. */
183 if (fwnode_property_read_bool(fixed_node, "pause"))
184 pl->link_config.pause |= MLO_PAUSE_SYM;
185 if (fwnode_property_read_bool(fixed_node, "asym-pause"))
186 pl->link_config.pause |= MLO_PAUSE_ASYM;
189 desc = fwnode_gpiod_get_index(fixed_node, "link", 0,
193 pl->link_gpio = desc;
194 else if (desc == ERR_PTR(-EPROBE_DEFER))
197 fwnode_handle_put(fixed_node);
204 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
206 if (ret != ARRAY_SIZE(prop)) {
207 phylink_err(pl, "broken fixed-link?\n");
211 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
212 prop, ARRAY_SIZE(prop));
214 pl->link_config.duplex = prop[1] ?
215 DUPLEX_FULL : DUPLEX_HALF;
216 pl->link_config.speed = prop[2];
218 pl->link_config.pause |= MLO_PAUSE_SYM;
220 pl->link_config.pause |= MLO_PAUSE_ASYM;
224 if (pl->link_config.speed > SPEED_1000 &&
225 pl->link_config.duplex != DUPLEX_FULL)
226 phylink_warn(pl, "fixed link specifies half duplex for %dMbps link?\n",
227 pl->link_config.speed);
229 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
230 linkmode_copy(pl->link_config.advertising, pl->supported);
231 phylink_validate(pl, pl->supported, &pl->link_config);
233 s = phy_lookup_setting(pl->link_config.speed, pl->link_config.duplex,
234 pl->supported, true);
235 linkmode_zero(pl->supported);
236 phylink_set(pl->supported, MII);
237 phylink_set(pl->supported, Pause);
238 phylink_set(pl->supported, Asym_Pause);
240 __set_bit(s->bit, pl->supported);
242 phylink_warn(pl, "fixed link %s duplex %dMbps not recognised\n",
243 pl->link_config.duplex == DUPLEX_FULL ? "full" : "half",
244 pl->link_config.speed);
247 linkmode_and(pl->link_config.advertising, pl->link_config.advertising,
250 pl->link_config.link = 1;
251 pl->link_config.an_complete = 1;
256 static int phylink_parse_mode(struct phylink *pl, struct fwnode_handle *fwnode)
258 struct fwnode_handle *dn;
261 dn = fwnode_get_named_child_node(fwnode, "fixed-link");
262 if (dn || fwnode_property_present(fwnode, "fixed-link"))
263 pl->cfg_link_an_mode = MLO_AN_FIXED;
264 fwnode_handle_put(dn);
266 if (fwnode_property_read_string(fwnode, "managed", &managed) == 0 &&
267 strcmp(managed, "in-band-status") == 0) {
268 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
270 "can't use both fixed-link and in-band-status\n");
274 linkmode_zero(pl->supported);
275 phylink_set(pl->supported, MII);
276 phylink_set(pl->supported, Autoneg);
277 phylink_set(pl->supported, Asym_Pause);
278 phylink_set(pl->supported, Pause);
279 pl->link_config.an_enabled = true;
280 pl->cfg_link_an_mode = MLO_AN_INBAND;
282 switch (pl->link_config.interface) {
283 case PHY_INTERFACE_MODE_SGMII:
284 case PHY_INTERFACE_MODE_QSGMII:
285 phylink_set(pl->supported, 10baseT_Half);
286 phylink_set(pl->supported, 10baseT_Full);
287 phylink_set(pl->supported, 100baseT_Half);
288 phylink_set(pl->supported, 100baseT_Full);
289 phylink_set(pl->supported, 1000baseT_Half);
290 phylink_set(pl->supported, 1000baseT_Full);
293 case PHY_INTERFACE_MODE_1000BASEX:
294 phylink_set(pl->supported, 1000baseX_Full);
297 case PHY_INTERFACE_MODE_2500BASEX:
298 phylink_set(pl->supported, 2500baseX_Full);
301 case PHY_INTERFACE_MODE_USXGMII:
302 case PHY_INTERFACE_MODE_10GKR:
303 case PHY_INTERFACE_MODE_10GBASER:
304 phylink_set(pl->supported, 10baseT_Half);
305 phylink_set(pl->supported, 10baseT_Full);
306 phylink_set(pl->supported, 100baseT_Half);
307 phylink_set(pl->supported, 100baseT_Full);
308 phylink_set(pl->supported, 1000baseT_Half);
309 phylink_set(pl->supported, 1000baseT_Full);
310 phylink_set(pl->supported, 1000baseX_Full);
311 phylink_set(pl->supported, 2500baseT_Full);
312 phylink_set(pl->supported, 2500baseX_Full);
313 phylink_set(pl->supported, 5000baseT_Full);
314 phylink_set(pl->supported, 10000baseT_Full);
315 phylink_set(pl->supported, 10000baseKR_Full);
316 phylink_set(pl->supported, 10000baseCR_Full);
317 phylink_set(pl->supported, 10000baseSR_Full);
318 phylink_set(pl->supported, 10000baseLR_Full);
319 phylink_set(pl->supported, 10000baseLRM_Full);
320 phylink_set(pl->supported, 10000baseER_Full);
325 "incorrect link mode %s for in-band status\n",
326 phy_modes(pl->link_config.interface));
330 linkmode_copy(pl->link_config.advertising, pl->supported);
332 if (phylink_validate(pl, pl->supported, &pl->link_config)) {
334 "failed to validate link configuration for in-band status\n");
342 static void phylink_mac_config(struct phylink *pl,
343 const struct phylink_link_state *state)
346 "%s: mode=%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
347 __func__, phylink_an_mode_str(pl->cur_link_an_mode),
348 phy_modes(state->interface),
349 phy_speed_to_str(state->speed),
350 phy_duplex_to_str(state->duplex),
351 __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
352 state->pause, state->link, state->an_enabled);
354 pl->ops->mac_config(pl->config, pl->cur_link_an_mode, state);
357 static void phylink_mac_config_up(struct phylink *pl,
358 const struct phylink_link_state *state)
361 phylink_mac_config(pl, state);
364 static void phylink_mac_an_restart(struct phylink *pl)
366 if (pl->link_config.an_enabled &&
367 phy_interface_mode_is_8023z(pl->link_config.interface))
368 pl->ops->mac_an_restart(pl->config);
371 static void phylink_mac_pcs_get_state(struct phylink *pl,
372 struct phylink_link_state *state)
374 linkmode_copy(state->advertising, pl->link_config.advertising);
375 linkmode_zero(state->lp_advertising);
376 state->interface = pl->link_config.interface;
377 state->an_enabled = pl->link_config.an_enabled;
378 state->speed = SPEED_UNKNOWN;
379 state->duplex = DUPLEX_UNKNOWN;
380 state->pause = MLO_PAUSE_NONE;
381 state->an_complete = 0;
384 pl->ops->mac_pcs_get_state(pl->config, state);
387 /* The fixed state is... fixed except for the link state,
388 * which may be determined by a GPIO or a callback.
390 static void phylink_get_fixed_state(struct phylink *pl, struct phylink_link_state *state)
392 *state = pl->link_config;
393 if (pl->get_fixed_state)
394 pl->get_fixed_state(pl->netdev, state);
395 else if (pl->link_gpio)
396 state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
399 /* Flow control is resolved according to our and the link partners
400 * advertisements using the following drawn from the 802.3 specs:
401 * Local device Link partner
402 * Pause AsymDir Pause AsymDir Result
407 static void phylink_resolve_flow(struct phylink *pl,
408 struct phylink_link_state *state)
412 if (pl->link_config.pause & MLO_PAUSE_AN) {
415 if (phylink_test(pl->link_config.advertising, Pause))
416 pause |= MLO_PAUSE_SYM;
417 if (phylink_test(pl->link_config.advertising, Asym_Pause))
418 pause |= MLO_PAUSE_ASYM;
420 pause &= state->pause;
422 if (pause & MLO_PAUSE_SYM)
423 new_pause = MLO_PAUSE_TX | MLO_PAUSE_RX;
424 else if (pause & MLO_PAUSE_ASYM)
425 new_pause = state->pause & MLO_PAUSE_SYM ?
426 MLO_PAUSE_TX : MLO_PAUSE_RX;
428 new_pause = pl->link_config.pause & MLO_PAUSE_TXRX_MASK;
431 state->pause &= ~MLO_PAUSE_TXRX_MASK;
432 state->pause |= new_pause;
435 static const char *phylink_pause_to_str(int pause)
437 switch (pause & MLO_PAUSE_TXRX_MASK) {
438 case MLO_PAUSE_TX | MLO_PAUSE_RX:
449 static void phylink_mac_link_up(struct phylink *pl,
450 struct phylink_link_state link_state)
452 struct net_device *ndev = pl->netdev;
454 pl->cur_interface = link_state.interface;
455 pl->ops->mac_link_up(pl->config, pl->cur_link_an_mode,
456 pl->cur_interface, pl->phydev);
459 netif_carrier_on(ndev);
462 "Link is Up - %s/%s - flow control %s\n",
463 phy_speed_to_str(link_state.speed),
464 phy_duplex_to_str(link_state.duplex),
465 phylink_pause_to_str(link_state.pause));
468 static void phylink_mac_link_down(struct phylink *pl)
470 struct net_device *ndev = pl->netdev;
473 netif_carrier_off(ndev);
474 pl->ops->mac_link_down(pl->config, pl->cur_link_an_mode,
476 phylink_info(pl, "Link is Down\n");
479 static void phylink_resolve(struct work_struct *w)
481 struct phylink *pl = container_of(w, struct phylink, resolve);
482 struct phylink_link_state link_state;
483 struct net_device *ndev = pl->netdev;
486 mutex_lock(&pl->state_mutex);
487 if (pl->phylink_disable_state) {
488 pl->mac_link_dropped = false;
489 link_state.link = false;
490 } else if (pl->mac_link_dropped) {
491 link_state.link = false;
493 switch (pl->cur_link_an_mode) {
495 link_state = pl->phy_state;
496 phylink_resolve_flow(pl, &link_state);
497 phylink_mac_config_up(pl, &link_state);
501 phylink_get_fixed_state(pl, &link_state);
502 phylink_mac_config_up(pl, &link_state);
506 phylink_mac_pcs_get_state(pl, &link_state);
508 /* If we have a phy, the "up" state is the union of
509 * both the PHY and the MAC */
511 link_state.link &= pl->phy_state.link;
513 /* Only update if the PHY link is up */
514 if (pl->phydev && pl->phy_state.link) {
515 link_state.interface = pl->phy_state.interface;
517 /* If we have a PHY, we need to update with
518 * the pause mode bits. */
519 link_state.pause |= pl->phy_state.pause;
520 phylink_resolve_flow(pl, &link_state);
521 phylink_mac_config(pl, &link_state);
528 link_changed = (link_state.link != netif_carrier_ok(ndev));
530 link_changed = (link_state.link != pl->old_link_state);
533 pl->old_link_state = link_state.link;
534 if (!link_state.link)
535 phylink_mac_link_down(pl);
537 phylink_mac_link_up(pl, link_state);
539 if (!link_state.link && pl->mac_link_dropped) {
540 pl->mac_link_dropped = false;
541 queue_work(system_power_efficient_wq, &pl->resolve);
543 mutex_unlock(&pl->state_mutex);
546 static void phylink_run_resolve(struct phylink *pl)
548 if (!pl->phylink_disable_state)
549 queue_work(system_power_efficient_wq, &pl->resolve);
552 static void phylink_run_resolve_and_disable(struct phylink *pl, int bit)
554 unsigned long state = pl->phylink_disable_state;
556 set_bit(bit, &pl->phylink_disable_state);
558 queue_work(system_power_efficient_wq, &pl->resolve);
559 flush_work(&pl->resolve);
563 static void phylink_fixed_poll(struct timer_list *t)
565 struct phylink *pl = container_of(t, struct phylink, link_poll);
567 mod_timer(t, jiffies + HZ);
569 phylink_run_resolve(pl);
572 static const struct sfp_upstream_ops sfp_phylink_ops;
574 static int phylink_register_sfp(struct phylink *pl,
575 struct fwnode_handle *fwnode)
583 bus = sfp_bus_find_fwnode(fwnode);
586 phylink_err(pl, "unable to attach SFP bus: %d\n", ret);
592 ret = sfp_bus_add_upstream(bus, pl, &sfp_phylink_ops);
599 * phylink_create() - create a phylink instance
600 * @config: a pointer to the target &struct phylink_config
601 * @fwnode: a pointer to a &struct fwnode_handle describing the network
603 * @iface: the desired link mode defined by &typedef phy_interface_t
604 * @ops: a pointer to a &struct phylink_mac_ops for the MAC.
606 * Create a new phylink instance, and parse the link parameters found in @np.
607 * This will parse in-band modes, fixed-link or SFP configuration.
609 * Note: the rtnl lock must not be held when calling this function.
611 * Returns a pointer to a &struct phylink, or an error-pointer value. Users
612 * must use IS_ERR() to check for errors from this function.
614 struct phylink *phylink_create(struct phylink_config *config,
615 struct fwnode_handle *fwnode,
616 phy_interface_t iface,
617 const struct phylink_mac_ops *ops)
622 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
624 return ERR_PTR(-ENOMEM);
626 mutex_init(&pl->state_mutex);
627 INIT_WORK(&pl->resolve, phylink_resolve);
630 if (config->type == PHYLINK_NETDEV) {
631 pl->netdev = to_net_dev(config->dev);
632 } else if (config->type == PHYLINK_DEV) {
633 pl->dev = config->dev;
636 return ERR_PTR(-EINVAL);
639 pl->phy_state.interface = iface;
640 pl->link_interface = iface;
641 if (iface == PHY_INTERFACE_MODE_MOCA)
642 pl->link_port = PORT_BNC;
644 pl->link_port = PORT_MII;
645 pl->link_config.interface = iface;
646 pl->link_config.pause = MLO_PAUSE_AN;
647 pl->link_config.speed = SPEED_UNKNOWN;
648 pl->link_config.duplex = DUPLEX_UNKNOWN;
649 pl->link_config.an_enabled = true;
651 __set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
652 timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
654 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
655 linkmode_copy(pl->link_config.advertising, pl->supported);
656 phylink_validate(pl, pl->supported, &pl->link_config);
658 ret = phylink_parse_mode(pl, fwnode);
664 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
665 ret = phylink_parse_fixedlink(pl, fwnode);
672 pl->cur_link_an_mode = pl->cfg_link_an_mode;
674 ret = phylink_register_sfp(pl, fwnode);
682 EXPORT_SYMBOL_GPL(phylink_create);
685 * phylink_destroy() - cleanup and destroy the phylink instance
686 * @pl: a pointer to a &struct phylink returned from phylink_create()
688 * Destroy a phylink instance. Any PHY that has been attached must have been
689 * cleaned up via phylink_disconnect_phy() prior to calling this function.
691 * Note: the rtnl lock must not be held when calling this function.
693 void phylink_destroy(struct phylink *pl)
695 sfp_bus_del_upstream(pl->sfp_bus);
697 gpiod_put(pl->link_gpio);
699 cancel_work_sync(&pl->resolve);
702 EXPORT_SYMBOL_GPL(phylink_destroy);
704 static void phylink_phy_change(struct phy_device *phydev, bool up,
707 struct phylink *pl = phydev->phylink;
709 mutex_lock(&pl->state_mutex);
710 pl->phy_state.speed = phydev->speed;
711 pl->phy_state.duplex = phydev->duplex;
712 pl->phy_state.pause = MLO_PAUSE_NONE;
714 pl->phy_state.pause |= MLO_PAUSE_SYM;
715 if (phydev->asym_pause)
716 pl->phy_state.pause |= MLO_PAUSE_ASYM;
717 pl->phy_state.interface = phydev->interface;
718 pl->phy_state.link = up;
719 mutex_unlock(&pl->state_mutex);
721 phylink_run_resolve(pl);
723 phylink_dbg(pl, "phy link %s %s/%s/%s\n", up ? "up" : "down",
724 phy_modes(phydev->interface),
725 phy_speed_to_str(phydev->speed),
726 phy_duplex_to_str(phydev->duplex));
729 static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy,
730 phy_interface_t interface)
732 struct phylink_link_state config;
733 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
738 * This is the new way of dealing with flow control for PHYs,
739 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
740 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
741 * using our validate call to the MAC, we rely upon the MAC
742 * clearing the bits from both supported and advertising fields.
744 phy_support_asym_pause(phy);
746 memset(&config, 0, sizeof(config));
747 linkmode_copy(supported, phy->supported);
748 linkmode_copy(config.advertising, phy->advertising);
750 /* Clause 45 PHYs switch their Serdes lane between several different
751 * modes, normally 10GBASE-R, SGMII. Some use 2500BASE-X for 2.5G
752 * speeds. We really need to know which interface modes the PHY and
753 * MAC supports to properly work out which linkmodes can be supported.
756 interface != PHY_INTERFACE_MODE_RXAUI &&
757 interface != PHY_INTERFACE_MODE_XAUI &&
758 interface != PHY_INTERFACE_MODE_USXGMII)
759 config.interface = PHY_INTERFACE_MODE_NA;
761 config.interface = interface;
763 ret = phylink_validate(pl, supported, &config);
765 phylink_warn(pl, "validation of %s with support %*pb and advertisement %*pb failed: %d\n",
766 phy_modes(config.interface),
767 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->supported,
768 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising,
774 phy->phy_link_change = phylink_phy_change;
776 irq_str = phy_attached_info_irq(phy);
778 "PHY [%s] driver [%s] (irq=%s)\n",
779 dev_name(&phy->mdio.dev), phy->drv->name, irq_str);
782 mutex_lock(&phy->lock);
783 mutex_lock(&pl->state_mutex);
785 pl->phy_state.interface = interface;
786 linkmode_copy(pl->supported, supported);
787 linkmode_copy(pl->link_config.advertising, config.advertising);
789 /* Restrict the phy advertisement according to the MAC support. */
790 linkmode_copy(phy->advertising, config.advertising);
791 mutex_unlock(&pl->state_mutex);
792 mutex_unlock(&phy->lock);
795 "phy: setting supported %*pb advertising %*pb\n",
796 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
797 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->advertising);
799 if (phy_interrupt_is_valid(phy))
800 phy_request_interrupt(phy);
805 static int phylink_attach_phy(struct phylink *pl, struct phy_device *phy,
806 phy_interface_t interface)
808 if (WARN_ON(pl->cfg_link_an_mode == MLO_AN_FIXED ||
809 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
810 phy_interface_mode_is_8023z(interface))))
816 return phy_attach_direct(pl->netdev, phy, 0, interface);
820 * phylink_connect_phy() - connect a PHY to the phylink instance
821 * @pl: a pointer to a &struct phylink returned from phylink_create()
822 * @phy: a pointer to a &struct phy_device.
824 * Connect @phy to the phylink instance specified by @pl by calling
825 * phy_attach_direct(). Configure the @phy according to the MAC driver's
826 * capabilities, start the PHYLIB state machine and enable any interrupts
827 * that the PHY supports.
829 * This updates the phylink's ethtool supported and advertising link mode
832 * Returns 0 on success or a negative errno.
834 int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
838 /* Use PHY device/driver interface */
839 if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
840 pl->link_interface = phy->interface;
841 pl->link_config.interface = pl->link_interface;
844 ret = phylink_attach_phy(pl, phy, pl->link_interface);
848 ret = phylink_bringup_phy(pl, phy, pl->link_config.interface);
854 EXPORT_SYMBOL_GPL(phylink_connect_phy);
857 * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
858 * @pl: a pointer to a &struct phylink returned from phylink_create()
859 * @dn: a pointer to a &struct device_node.
860 * @flags: PHY-specific flags to communicate to the PHY device driver
862 * Connect the phy specified in the device node @dn to the phylink instance
863 * specified by @pl. Actions specified in phylink_connect_phy() will be
866 * Returns 0 on success or a negative errno.
868 int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
871 struct device_node *phy_node;
872 struct phy_device *phy_dev;
875 /* Fixed links and 802.3z are handled without needing a PHY */
876 if (pl->cfg_link_an_mode == MLO_AN_FIXED ||
877 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
878 phy_interface_mode_is_8023z(pl->link_interface)))
881 phy_node = of_parse_phandle(dn, "phy-handle", 0);
883 phy_node = of_parse_phandle(dn, "phy", 0);
885 phy_node = of_parse_phandle(dn, "phy-device", 0);
888 if (pl->cfg_link_an_mode == MLO_AN_PHY)
893 phy_dev = of_phy_find_device(phy_node);
894 /* We're done with the phy_node handle */
895 of_node_put(phy_node);
899 ret = phy_attach_direct(pl->netdev, phy_dev, flags,
904 ret = phylink_bringup_phy(pl, phy_dev, pl->link_config.interface);
910 EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
913 * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
915 * @pl: a pointer to a &struct phylink returned from phylink_create()
917 * Disconnect any current PHY from the phylink instance described by @pl.
919 void phylink_disconnect_phy(struct phylink *pl)
921 struct phy_device *phy;
927 mutex_lock(&phy->lock);
928 mutex_lock(&pl->state_mutex);
930 mutex_unlock(&pl->state_mutex);
931 mutex_unlock(&phy->lock);
932 flush_work(&pl->resolve);
937 EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
940 * phylink_fixed_state_cb() - allow setting a fixed link callback
941 * @pl: a pointer to a &struct phylink returned from phylink_create()
942 * @cb: callback to execute to determine the fixed link state.
944 * The MAC driver should call this driver when the state of its link
945 * can be determined through e.g: an out of band MMIO register.
947 int phylink_fixed_state_cb(struct phylink *pl,
948 void (*cb)(struct net_device *dev,
949 struct phylink_link_state *state))
951 /* It does not make sense to let the link be overriden unless we use
954 if (pl->cfg_link_an_mode != MLO_AN_FIXED)
957 mutex_lock(&pl->state_mutex);
958 pl->get_fixed_state = cb;
959 mutex_unlock(&pl->state_mutex);
963 EXPORT_SYMBOL_GPL(phylink_fixed_state_cb);
966 * phylink_mac_change() - notify phylink of a change in MAC state
967 * @pl: a pointer to a &struct phylink returned from phylink_create()
968 * @up: indicates whether the link is currently up.
970 * The MAC driver should call this driver when the state of its link
971 * changes (eg, link failure, new negotiation results, etc.)
973 void phylink_mac_change(struct phylink *pl, bool up)
976 pl->mac_link_dropped = true;
977 phylink_run_resolve(pl);
978 phylink_dbg(pl, "mac link %s\n", up ? "up" : "down");
980 EXPORT_SYMBOL_GPL(phylink_mac_change);
982 static irqreturn_t phylink_link_handler(int irq, void *data)
984 struct phylink *pl = data;
986 phylink_run_resolve(pl);
992 * phylink_start() - start a phylink instance
993 * @pl: a pointer to a &struct phylink returned from phylink_create()
995 * Start the phylink instance specified by @pl, configuring the MAC for the
996 * desired link mode(s) and negotiation style. This should be called from the
997 * network device driver's &struct net_device_ops ndo_open() method.
999 void phylink_start(struct phylink *pl)
1003 phylink_info(pl, "configuring for %s/%s link mode\n",
1004 phylink_an_mode_str(pl->cur_link_an_mode),
1005 phy_modes(pl->link_config.interface));
1007 /* Always set the carrier off */
1009 netif_carrier_off(pl->netdev);
1011 /* Apply the link configuration to the MAC when starting. This allows
1012 * a fixed-link to start with the correct parameters, and also
1013 * ensures that we set the appropriate advertisement for Serdes links.
1015 phylink_resolve_flow(pl, &pl->link_config);
1016 phylink_mac_config(pl, &pl->link_config);
1018 /* Restart autonegotiation if using 802.3z to ensure that the link
1019 * parameters are properly negotiated. This is necessary for DSA
1020 * switches using 802.3z negotiation to ensure they see our modes.
1022 phylink_mac_an_restart(pl);
1024 clear_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
1025 phylink_run_resolve(pl);
1027 if (pl->cfg_link_an_mode == MLO_AN_FIXED && pl->link_gpio) {
1028 int irq = gpiod_to_irq(pl->link_gpio);
1031 if (!request_irq(irq, phylink_link_handler,
1032 IRQF_TRIGGER_RISING |
1033 IRQF_TRIGGER_FALLING,
1040 mod_timer(&pl->link_poll, jiffies + HZ);
1042 if ((pl->cfg_link_an_mode == MLO_AN_FIXED && pl->get_fixed_state) ||
1043 pl->config->pcs_poll)
1044 mod_timer(&pl->link_poll, jiffies + HZ);
1046 phy_start(pl->phydev);
1048 sfp_upstream_start(pl->sfp_bus);
1050 EXPORT_SYMBOL_GPL(phylink_start);
1053 * phylink_stop() - stop a phylink instance
1054 * @pl: a pointer to a &struct phylink returned from phylink_create()
1056 * Stop the phylink instance specified by @pl. This should be called from the
1057 * network device driver's &struct net_device_ops ndo_stop() method. The
1058 * network device's carrier state should not be changed prior to calling this
1061 void phylink_stop(struct phylink *pl)
1066 sfp_upstream_stop(pl->sfp_bus);
1068 phy_stop(pl->phydev);
1069 del_timer_sync(&pl->link_poll);
1071 free_irq(pl->link_irq, pl);
1075 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_STOPPED);
1077 EXPORT_SYMBOL_GPL(phylink_stop);
1080 * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
1081 * @pl: a pointer to a &struct phylink returned from phylink_create()
1082 * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
1084 * Read the wake on lan parameters from the PHY attached to the phylink
1085 * instance specified by @pl. If no PHY is currently attached, report no
1086 * support for wake on lan.
1088 void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1096 phy_ethtool_get_wol(pl->phydev, wol);
1098 EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
1101 * phylink_ethtool_set_wol() - set wake on lan parameters
1102 * @pl: a pointer to a &struct phylink returned from phylink_create()
1103 * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
1105 * Set the wake on lan parameters for the PHY attached to the phylink
1106 * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
1109 * Returns zero on success or negative errno code.
1111 int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1113 int ret = -EOPNOTSUPP;
1118 ret = phy_ethtool_set_wol(pl->phydev, wol);
1122 EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
1124 static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
1126 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
1128 linkmode_zero(mask);
1129 phylink_set_port_modes(mask);
1131 linkmode_and(dst, dst, mask);
1132 linkmode_or(dst, dst, b);
1135 static void phylink_get_ksettings(const struct phylink_link_state *state,
1136 struct ethtool_link_ksettings *kset)
1138 phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
1139 linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
1140 kset->base.speed = state->speed;
1141 kset->base.duplex = state->duplex;
1142 kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
1147 * phylink_ethtool_ksettings_get() - get the current link settings
1148 * @pl: a pointer to a &struct phylink returned from phylink_create()
1149 * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
1151 * Read the current link settings for the phylink instance specified by @pl.
1152 * This will be the link settings read from the MAC, PHY or fixed link
1153 * settings depending on the current negotiation mode.
1155 int phylink_ethtool_ksettings_get(struct phylink *pl,
1156 struct ethtool_link_ksettings *kset)
1158 struct phylink_link_state link_state;
1163 phy_ethtool_ksettings_get(pl->phydev, kset);
1165 kset->base.port = pl->link_port;
1168 linkmode_copy(kset->link_modes.supported, pl->supported);
1170 switch (pl->cur_link_an_mode) {
1172 /* We are using fixed settings. Report these as the
1173 * current link settings - and note that these also
1174 * represent the supported speeds/duplex/pause modes.
1176 phylink_get_fixed_state(pl, &link_state);
1177 phylink_get_ksettings(&link_state, kset);
1181 /* If there is a phy attached, then use the reported
1182 * settings from the phy with no modification.
1187 phylink_mac_pcs_get_state(pl, &link_state);
1189 /* The MAC is reporting the link results from its own PCS
1190 * layer via in-band status. Report these as the current
1193 phylink_get_ksettings(&link_state, kset);
1199 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
1202 * phylink_ethtool_ksettings_set() - set the link settings
1203 * @pl: a pointer to a &struct phylink returned from phylink_create()
1204 * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
1206 int phylink_ethtool_ksettings_set(struct phylink *pl,
1207 const struct ethtool_link_ksettings *kset)
1209 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1210 struct ethtool_link_ksettings our_kset;
1211 struct phylink_link_state config;
1216 if (kset->base.autoneg != AUTONEG_DISABLE &&
1217 kset->base.autoneg != AUTONEG_ENABLE)
1220 linkmode_copy(support, pl->supported);
1221 config = pl->link_config;
1223 /* Mask out unsupported advertisements */
1224 linkmode_and(config.advertising, kset->link_modes.advertising,
1227 /* FIXME: should we reject autoneg if phy/mac does not support it? */
1228 if (kset->base.autoneg == AUTONEG_DISABLE) {
1229 const struct phy_setting *s;
1231 /* Autonegotiation disabled, select a suitable speed and
1234 s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
1239 /* If we have a fixed link (as specified by firmware), refuse
1240 * to change link parameters.
1242 if (pl->cur_link_an_mode == MLO_AN_FIXED &&
1243 (s->speed != pl->link_config.speed ||
1244 s->duplex != pl->link_config.duplex))
1247 config.speed = s->speed;
1248 config.duplex = s->duplex;
1249 config.an_enabled = false;
1251 __clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1253 /* If we have a fixed link, refuse to enable autonegotiation */
1254 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1257 config.speed = SPEED_UNKNOWN;
1258 config.duplex = DUPLEX_UNKNOWN;
1259 config.an_enabled = true;
1261 __set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1265 /* If we have a PHY, we process the kset change via phylib.
1266 * phylib will call our link state function if the PHY
1267 * parameters have changed, which will trigger a resolve
1268 * and update the MAC configuration.
1271 linkmode_copy(our_kset.link_modes.advertising,
1272 config.advertising);
1273 our_kset.base.speed = config.speed;
1274 our_kset.base.duplex = config.duplex;
1276 ret = phy_ethtool_ksettings_set(pl->phydev, &our_kset);
1280 mutex_lock(&pl->state_mutex);
1281 /* Save the new configuration */
1282 linkmode_copy(pl->link_config.advertising,
1283 our_kset.link_modes.advertising);
1284 pl->link_config.interface = config.interface;
1285 pl->link_config.speed = our_kset.base.speed;
1286 pl->link_config.duplex = our_kset.base.duplex;
1287 pl->link_config.an_enabled = our_kset.base.autoneg !=
1289 mutex_unlock(&pl->state_mutex);
1291 /* For a fixed link, this isn't able to change any parameters,
1292 * which just leaves inband mode.
1294 if (phylink_validate(pl, support, &config))
1297 /* If autonegotiation is enabled, we must have an advertisement */
1298 if (config.an_enabled &&
1299 phylink_is_empty_linkmode(config.advertising))
1302 mutex_lock(&pl->state_mutex);
1303 linkmode_copy(pl->link_config.advertising, config.advertising);
1304 pl->link_config.interface = config.interface;
1305 pl->link_config.speed = config.speed;
1306 pl->link_config.duplex = config.duplex;
1307 pl->link_config.an_enabled = kset->base.autoneg !=
1310 if (pl->cur_link_an_mode == MLO_AN_INBAND &&
1311 !test_bit(PHYLINK_DISABLE_STOPPED,
1312 &pl->phylink_disable_state)) {
1313 /* If in 802.3z mode, this updates the advertisement.
1315 * If we are in SGMII mode without a PHY, there is no
1316 * advertisement; the only thing we have is the pause
1317 * modes which can only come from a PHY.
1319 phylink_mac_config(pl, &pl->link_config);
1320 phylink_mac_an_restart(pl);
1322 mutex_unlock(&pl->state_mutex);
1327 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
1330 * phylink_ethtool_nway_reset() - restart negotiation
1331 * @pl: a pointer to a &struct phylink returned from phylink_create()
1333 * Restart negotiation for the phylink instance specified by @pl. This will
1334 * cause any attached phy to restart negotiation with the link partner, and
1335 * if the MAC is in a BaseX mode, the MAC will also be requested to restart
1338 * Returns zero on success, or negative error code.
1340 int phylink_ethtool_nway_reset(struct phylink *pl)
1347 ret = phy_restart_aneg(pl->phydev);
1348 phylink_mac_an_restart(pl);
1352 EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
1355 * phylink_ethtool_get_pauseparam() - get the current pause parameters
1356 * @pl: a pointer to a &struct phylink returned from phylink_create()
1357 * @pause: a pointer to a &struct ethtool_pauseparam
1359 void phylink_ethtool_get_pauseparam(struct phylink *pl,
1360 struct ethtool_pauseparam *pause)
1364 pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
1365 pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
1366 pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
1368 EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
1371 * phylink_ethtool_set_pauseparam() - set the current pause parameters
1372 * @pl: a pointer to a &struct phylink returned from phylink_create()
1373 * @pause: a pointer to a &struct ethtool_pauseparam
1375 int phylink_ethtool_set_pauseparam(struct phylink *pl,
1376 struct ethtool_pauseparam *pause)
1378 struct phylink_link_state *config = &pl->link_config;
1382 if (!phylink_test(pl->supported, Pause) &&
1383 !phylink_test(pl->supported, Asym_Pause))
1386 if (!phylink_test(pl->supported, Asym_Pause) &&
1387 !pause->autoneg && pause->rx_pause != pause->tx_pause)
1390 config->pause &= ~(MLO_PAUSE_AN | MLO_PAUSE_TXRX_MASK);
1393 config->pause |= MLO_PAUSE_AN;
1394 if (pause->rx_pause)
1395 config->pause |= MLO_PAUSE_RX;
1396 if (pause->tx_pause)
1397 config->pause |= MLO_PAUSE_TX;
1399 /* If we have a PHY, phylib will call our link state function if the
1400 * mode has changed, which will trigger a resolve and update the MAC
1404 phy_set_asym_pause(pl->phydev, pause->rx_pause,
1406 } else if (!test_bit(PHYLINK_DISABLE_STOPPED,
1407 &pl->phylink_disable_state)) {
1408 switch (pl->cur_link_an_mode) {
1410 /* Should we allow fixed links to change against the config? */
1411 phylink_resolve_flow(pl, config);
1412 phylink_mac_config(pl, config);
1416 phylink_mac_config(pl, config);
1417 phylink_mac_an_restart(pl);
1424 EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
1427 * phylink_ethtool_get_eee_err() - read the energy efficient ethernet error
1429 * @pl: a pointer to a &struct phylink returned from phylink_create().
1431 * Read the Energy Efficient Ethernet error counter from the PHY associated
1432 * with the phylink instance specified by @pl.
1434 * Returns positive error counter value, or negative error code.
1436 int phylink_get_eee_err(struct phylink *pl)
1443 ret = phy_get_eee_err(pl->phydev);
1447 EXPORT_SYMBOL_GPL(phylink_get_eee_err);
1450 * phylink_init_eee() - init and check the EEE features
1451 * @pl: a pointer to a &struct phylink returned from phylink_create()
1452 * @clk_stop_enable: allow PHY to stop receive clock
1454 * Must be called either with RTNL held or within mac_link_up()
1456 int phylink_init_eee(struct phylink *pl, bool clk_stop_enable)
1458 int ret = -EOPNOTSUPP;
1461 ret = phy_init_eee(pl->phydev, clk_stop_enable);
1465 EXPORT_SYMBOL_GPL(phylink_init_eee);
1468 * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
1469 * @pl: a pointer to a &struct phylink returned from phylink_create()
1470 * @eee: a pointer to a &struct ethtool_eee for the read parameters
1472 int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
1474 int ret = -EOPNOTSUPP;
1479 ret = phy_ethtool_get_eee(pl->phydev, eee);
1483 EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
1486 * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
1487 * @pl: a pointer to a &struct phylink returned from phylink_create()
1488 * @eee: a pointer to a &struct ethtool_eee for the desired parameters
1490 int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
1492 int ret = -EOPNOTSUPP;
1497 ret = phy_ethtool_set_eee(pl->phydev, eee);
1501 EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
1503 /* This emulates MII registers for a fixed-mode phy operating as per the
1504 * passed in state. "aneg" defines if we report negotiation is possible.
1506 * FIXME: should deal with negotiation state too.
1508 static int phylink_mii_emul_read(unsigned int reg,
1509 struct phylink_link_state *state)
1511 struct fixed_phy_status fs;
1514 fs.link = state->link;
1515 fs.speed = state->speed;
1516 fs.duplex = state->duplex;
1517 fs.pause = state->pause & MLO_PAUSE_SYM;
1518 fs.asym_pause = state->pause & MLO_PAUSE_ASYM;
1520 val = swphy_read_reg(reg, &fs);
1521 if (reg == MII_BMSR) {
1522 if (!state->an_complete)
1523 val &= ~BMSR_ANEGCOMPLETE;
1528 static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
1531 struct phy_device *phydev = pl->phydev;
1534 if (mdio_phy_id_is_c45(phy_id)) {
1535 prtad = mdio_phy_id_prtad(phy_id);
1536 devad = mdio_phy_id_devad(phy_id);
1537 devad = MII_ADDR_C45 | devad << 16 | reg;
1538 } else if (phydev->is_c45) {
1544 devad = __ffs(phydev->c45_ids.devices_in_package);
1548 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1550 devad = MDIO_MMD_AN;
1551 if (reg == MII_ADVERTISE)
1552 reg = MDIO_AN_ADVERTISE;
1560 devad = MII_ADDR_C45 | devad << 16 | reg;
1565 return mdiobus_read(pl->phydev->mdio.bus, prtad, devad);
1568 static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
1569 unsigned int reg, unsigned int val)
1571 struct phy_device *phydev = pl->phydev;
1574 if (mdio_phy_id_is_c45(phy_id)) {
1575 prtad = mdio_phy_id_prtad(phy_id);
1576 devad = mdio_phy_id_devad(phy_id);
1577 devad = MII_ADDR_C45 | devad << 16 | reg;
1578 } else if (phydev->is_c45) {
1584 devad = __ffs(phydev->c45_ids.devices_in_package);
1588 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1590 devad = MDIO_MMD_AN;
1591 if (reg == MII_ADVERTISE)
1592 reg = MDIO_AN_ADVERTISE;
1600 devad = MII_ADDR_C45 | devad << 16 | reg;
1606 return mdiobus_write(phydev->mdio.bus, prtad, devad, val);
1609 static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
1612 struct phylink_link_state state;
1615 switch (pl->cur_link_an_mode) {
1618 phylink_get_fixed_state(pl, &state);
1619 val = phylink_mii_emul_read(reg, &state);
1628 phylink_mac_pcs_get_state(pl, &state);
1629 val = phylink_mii_emul_read(reg, &state);
1634 return val & 0xffff;
1637 static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
1638 unsigned int reg, unsigned int val)
1640 switch (pl->cur_link_an_mode) {
1655 * phylink_mii_ioctl() - generic mii ioctl interface
1656 * @pl: a pointer to a &struct phylink returned from phylink_create()
1657 * @ifr: a pointer to a &struct ifreq for socket ioctls
1658 * @cmd: ioctl cmd to execute
1660 * Perform the specified MII ioctl on the PHY attached to the phylink instance
1661 * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
1663 * Returns: zero on success or negative error code.
1666 * read register from the current PHY.
1668 * read register from the specified PHY.
1670 * set a register on the specified PHY.
1672 int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
1674 struct mii_ioctl_data *mii = if_mii(ifr);
1680 /* PHYs only exist for MLO_AN_PHY and SGMII */
1683 mii->phy_id = pl->phydev->mdio.addr;
1687 ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
1695 ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
1700 ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
1710 ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
1718 ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
1730 EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
1732 static void phylink_sfp_attach(void *upstream, struct sfp_bus *bus)
1734 struct phylink *pl = upstream;
1736 pl->netdev->sfp_bus = bus;
1739 static void phylink_sfp_detach(void *upstream, struct sfp_bus *bus)
1741 struct phylink *pl = upstream;
1743 pl->netdev->sfp_bus = NULL;
1746 static int phylink_sfp_config(struct phylink *pl, u8 mode,
1747 const unsigned long *supported,
1748 const unsigned long *advertising)
1750 __ETHTOOL_DECLARE_LINK_MODE_MASK(support1);
1751 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1752 struct phylink_link_state config;
1753 phy_interface_t iface;
1757 linkmode_copy(support, supported);
1759 memset(&config, 0, sizeof(config));
1760 linkmode_copy(config.advertising, advertising);
1761 config.interface = PHY_INTERFACE_MODE_NA;
1762 config.speed = SPEED_UNKNOWN;
1763 config.duplex = DUPLEX_UNKNOWN;
1764 config.pause = MLO_PAUSE_AN;
1765 config.an_enabled = pl->link_config.an_enabled;
1767 /* Ignore errors if we're expecting a PHY to attach later */
1768 ret = phylink_validate(pl, support, &config);
1770 phylink_err(pl, "validation with support %*pb failed: %d\n",
1771 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1775 iface = sfp_select_interface(pl->sfp_bus, config.advertising);
1776 if (iface == PHY_INTERFACE_MODE_NA) {
1778 "selection of interface failed, advertisement %*pb\n",
1779 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
1783 config.interface = iface;
1784 linkmode_copy(support1, support);
1785 ret = phylink_validate(pl, support1, &config);
1787 phylink_err(pl, "validation of %s/%s with support %*pb failed: %d\n",
1788 phylink_an_mode_str(mode),
1789 phy_modes(config.interface),
1790 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1794 phylink_dbg(pl, "requesting link mode %s/%s with support %*pb\n",
1795 phylink_an_mode_str(mode), phy_modes(config.interface),
1796 __ETHTOOL_LINK_MODE_MASK_NBITS, support);
1798 if (phy_interface_mode_is_8023z(iface) && pl->phydev)
1801 changed = !linkmode_equal(pl->supported, support);
1803 linkmode_copy(pl->supported, support);
1804 linkmode_copy(pl->link_config.advertising, config.advertising);
1807 if (pl->cur_link_an_mode != mode ||
1808 pl->link_config.interface != config.interface) {
1809 pl->link_config.interface = config.interface;
1810 pl->cur_link_an_mode = mode;
1814 phylink_info(pl, "switched to %s/%s link mode\n",
1815 phylink_an_mode_str(mode),
1816 phy_modes(config.interface));
1819 pl->link_port = pl->sfp_port;
1821 if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
1822 &pl->phylink_disable_state))
1823 phylink_mac_config(pl, &pl->link_config);
1828 static int phylink_sfp_module_insert(void *upstream,
1829 const struct sfp_eeprom_id *id)
1831 struct phylink *pl = upstream;
1832 unsigned long *support = pl->sfp_support;
1836 linkmode_zero(support);
1837 sfp_parse_support(pl->sfp_bus, id, support);
1838 pl->sfp_port = sfp_parse_port(pl->sfp_bus, id, support);
1840 /* If this module may have a PHY connecting later, defer until later */
1841 pl->sfp_may_have_phy = sfp_may_have_phy(pl->sfp_bus, id);
1842 if (pl->sfp_may_have_phy)
1845 return phylink_sfp_config(pl, MLO_AN_INBAND, support, support);
1848 static int phylink_sfp_module_start(void *upstream)
1850 struct phylink *pl = upstream;
1852 /* If this SFP module has a PHY, start the PHY now. */
1854 phy_start(pl->phydev);
1858 /* If the module may have a PHY but we didn't detect one we
1859 * need to configure the MAC here.
1861 if (!pl->sfp_may_have_phy)
1864 return phylink_sfp_config(pl, MLO_AN_INBAND,
1865 pl->sfp_support, pl->sfp_support);
1868 static void phylink_sfp_module_stop(void *upstream)
1870 struct phylink *pl = upstream;
1872 /* If this SFP module has a PHY, stop it. */
1874 phy_stop(pl->phydev);
1877 static void phylink_sfp_link_down(void *upstream)
1879 struct phylink *pl = upstream;
1883 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_LINK);
1886 static void phylink_sfp_link_up(void *upstream)
1888 struct phylink *pl = upstream;
1892 clear_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
1893 phylink_run_resolve(pl);
1896 /* The Broadcom BCM84881 in the Methode DM7052 is unable to provide a SGMII
1897 * or 802.3z control word, so inband will not work.
1899 static bool phylink_phy_no_inband(struct phy_device *phy)
1901 return phy->is_c45 &&
1902 (phy->c45_ids.device_ids[1] & 0xfffffff0) == 0xae025150;
1905 static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
1907 struct phylink *pl = upstream;
1908 phy_interface_t interface;
1913 * This is the new way of dealing with flow control for PHYs,
1914 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
1915 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
1916 * using our validate call to the MAC, we rely upon the MAC
1917 * clearing the bits from both supported and advertising fields.
1919 phy_support_asym_pause(phy);
1921 if (phylink_phy_no_inband(phy))
1924 mode = MLO_AN_INBAND;
1926 /* Do the initial configuration */
1927 ret = phylink_sfp_config(pl, mode, phy->supported, phy->advertising);
1931 interface = pl->link_config.interface;
1932 ret = phylink_attach_phy(pl, phy, interface);
1936 ret = phylink_bringup_phy(pl, phy, interface);
1943 static void phylink_sfp_disconnect_phy(void *upstream)
1945 phylink_disconnect_phy(upstream);
1948 static const struct sfp_upstream_ops sfp_phylink_ops = {
1949 .attach = phylink_sfp_attach,
1950 .detach = phylink_sfp_detach,
1951 .module_insert = phylink_sfp_module_insert,
1952 .module_start = phylink_sfp_module_start,
1953 .module_stop = phylink_sfp_module_stop,
1954 .link_up = phylink_sfp_link_up,
1955 .link_down = phylink_sfp_link_down,
1956 .connect_phy = phylink_sfp_connect_phy,
1957 .disconnect_phy = phylink_sfp_disconnect_phy,
1960 /* Helpers for MAC drivers */
1963 * phylink_helper_basex_speed() - 1000BaseX/2500BaseX helper
1964 * @state: a pointer to a &struct phylink_link_state
1966 * Inspect the interface mode, advertising mask or forced speed and
1967 * decide whether to run at 2.5Gbit or 1Gbit appropriately, switching
1968 * the interface mode to suit. @state->interface is appropriately
1969 * updated, and the advertising mask has the "other" baseX_Full flag
1972 void phylink_helper_basex_speed(struct phylink_link_state *state)
1974 if (phy_interface_mode_is_8023z(state->interface)) {
1975 bool want_2500 = state->an_enabled ?
1976 phylink_test(state->advertising, 2500baseX_Full) :
1977 state->speed == SPEED_2500;
1980 phylink_clear(state->advertising, 1000baseX_Full);
1981 state->interface = PHY_INTERFACE_MODE_2500BASEX;
1983 phylink_clear(state->advertising, 2500baseX_Full);
1984 state->interface = PHY_INTERFACE_MODE_1000BASEX;
1988 EXPORT_SYMBOL_GPL(phylink_helper_basex_speed);
1990 MODULE_LICENSE("GPL v2");