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 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
185 pl->link_config.lp_advertising);
186 if (fwnode_property_read_bool(fixed_node, "asym-pause"))
187 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
188 pl->link_config.lp_advertising);
191 desc = fwnode_gpiod_get_index(fixed_node, "link", 0,
195 pl->link_gpio = desc;
196 else if (desc == ERR_PTR(-EPROBE_DEFER))
199 fwnode_handle_put(fixed_node);
206 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
208 if (ret != ARRAY_SIZE(prop)) {
209 phylink_err(pl, "broken fixed-link?\n");
213 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
214 prop, ARRAY_SIZE(prop));
216 pl->link_config.duplex = prop[1] ?
217 DUPLEX_FULL : DUPLEX_HALF;
218 pl->link_config.speed = prop[2];
220 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
221 pl->link_config.lp_advertising);
223 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
224 pl->link_config.lp_advertising);
228 if (pl->link_config.speed > SPEED_1000 &&
229 pl->link_config.duplex != DUPLEX_FULL)
230 phylink_warn(pl, "fixed link specifies half duplex for %dMbps link?\n",
231 pl->link_config.speed);
233 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
234 linkmode_copy(pl->link_config.advertising, pl->supported);
235 phylink_validate(pl, pl->supported, &pl->link_config);
237 s = phy_lookup_setting(pl->link_config.speed, pl->link_config.duplex,
238 pl->supported, true);
239 linkmode_zero(pl->supported);
240 phylink_set(pl->supported, MII);
241 phylink_set(pl->supported, Pause);
242 phylink_set(pl->supported, Asym_Pause);
244 __set_bit(s->bit, pl->supported);
246 phylink_warn(pl, "fixed link %s duplex %dMbps not recognised\n",
247 pl->link_config.duplex == DUPLEX_FULL ? "full" : "half",
248 pl->link_config.speed);
251 linkmode_and(pl->link_config.advertising, pl->link_config.advertising,
254 pl->link_config.link = 1;
255 pl->link_config.an_complete = 1;
260 static int phylink_parse_mode(struct phylink *pl, struct fwnode_handle *fwnode)
262 struct fwnode_handle *dn;
265 dn = fwnode_get_named_child_node(fwnode, "fixed-link");
266 if (dn || fwnode_property_present(fwnode, "fixed-link"))
267 pl->cfg_link_an_mode = MLO_AN_FIXED;
268 fwnode_handle_put(dn);
270 if (fwnode_property_read_string(fwnode, "managed", &managed) == 0 &&
271 strcmp(managed, "in-band-status") == 0) {
272 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
274 "can't use both fixed-link and in-band-status\n");
278 linkmode_zero(pl->supported);
279 phylink_set(pl->supported, MII);
280 phylink_set(pl->supported, Autoneg);
281 phylink_set(pl->supported, Asym_Pause);
282 phylink_set(pl->supported, Pause);
283 pl->link_config.an_enabled = true;
284 pl->cfg_link_an_mode = MLO_AN_INBAND;
286 switch (pl->link_config.interface) {
287 case PHY_INTERFACE_MODE_SGMII:
288 case PHY_INTERFACE_MODE_QSGMII:
289 phylink_set(pl->supported, 10baseT_Half);
290 phylink_set(pl->supported, 10baseT_Full);
291 phylink_set(pl->supported, 100baseT_Half);
292 phylink_set(pl->supported, 100baseT_Full);
293 phylink_set(pl->supported, 1000baseT_Half);
294 phylink_set(pl->supported, 1000baseT_Full);
297 case PHY_INTERFACE_MODE_1000BASEX:
298 phylink_set(pl->supported, 1000baseX_Full);
301 case PHY_INTERFACE_MODE_2500BASEX:
302 phylink_set(pl->supported, 2500baseX_Full);
305 case PHY_INTERFACE_MODE_USXGMII:
306 case PHY_INTERFACE_MODE_10GKR:
307 case PHY_INTERFACE_MODE_10GBASER:
308 phylink_set(pl->supported, 10baseT_Half);
309 phylink_set(pl->supported, 10baseT_Full);
310 phylink_set(pl->supported, 100baseT_Half);
311 phylink_set(pl->supported, 100baseT_Full);
312 phylink_set(pl->supported, 1000baseT_Half);
313 phylink_set(pl->supported, 1000baseT_Full);
314 phylink_set(pl->supported, 1000baseX_Full);
315 phylink_set(pl->supported, 2500baseT_Full);
316 phylink_set(pl->supported, 2500baseX_Full);
317 phylink_set(pl->supported, 5000baseT_Full);
318 phylink_set(pl->supported, 10000baseT_Full);
319 phylink_set(pl->supported, 10000baseKR_Full);
320 phylink_set(pl->supported, 10000baseCR_Full);
321 phylink_set(pl->supported, 10000baseSR_Full);
322 phylink_set(pl->supported, 10000baseLR_Full);
323 phylink_set(pl->supported, 10000baseLRM_Full);
324 phylink_set(pl->supported, 10000baseER_Full);
329 "incorrect link mode %s for in-band status\n",
330 phy_modes(pl->link_config.interface));
334 linkmode_copy(pl->link_config.advertising, pl->supported);
336 if (phylink_validate(pl, pl->supported, &pl->link_config)) {
338 "failed to validate link configuration for in-band status\n");
346 static void phylink_apply_manual_flow(struct phylink *pl,
347 struct phylink_link_state *state)
349 /* If autoneg is disabled, pause AN is also disabled */
350 if (!state->an_enabled)
351 state->pause &= ~MLO_PAUSE_AN;
353 /* Manual configuration of pause modes */
354 if (!(pl->link_config.pause & MLO_PAUSE_AN))
355 state->pause = pl->link_config.pause;
358 static void phylink_resolve_flow(struct phylink_link_state *state)
360 bool tx_pause, rx_pause;
362 state->pause = MLO_PAUSE_NONE;
363 if (state->duplex == DUPLEX_FULL) {
364 linkmode_resolve_pause(state->advertising,
365 state->lp_advertising,
366 &tx_pause, &rx_pause);
368 state->pause |= MLO_PAUSE_TX;
370 state->pause |= MLO_PAUSE_RX;
374 static void phylink_mac_config(struct phylink *pl,
375 const struct phylink_link_state *state)
378 "%s: mode=%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
379 __func__, phylink_an_mode_str(pl->cur_link_an_mode),
380 phy_modes(state->interface),
381 phy_speed_to_str(state->speed),
382 phy_duplex_to_str(state->duplex),
383 __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
384 state->pause, state->link, state->an_enabled);
386 pl->ops->mac_config(pl->config, pl->cur_link_an_mode, state);
389 static void phylink_mac_config_up(struct phylink *pl,
390 const struct phylink_link_state *state)
393 phylink_mac_config(pl, state);
396 static void phylink_mac_an_restart(struct phylink *pl)
398 if (pl->link_config.an_enabled &&
399 phy_interface_mode_is_8023z(pl->link_config.interface))
400 pl->ops->mac_an_restart(pl->config);
403 static void phylink_mac_pcs_get_state(struct phylink *pl,
404 struct phylink_link_state *state)
406 linkmode_copy(state->advertising, pl->link_config.advertising);
407 linkmode_zero(state->lp_advertising);
408 state->interface = pl->link_config.interface;
409 state->an_enabled = pl->link_config.an_enabled;
410 state->speed = SPEED_UNKNOWN;
411 state->duplex = DUPLEX_UNKNOWN;
412 state->pause = MLO_PAUSE_NONE;
413 state->an_complete = 0;
416 pl->ops->mac_pcs_get_state(pl->config, state);
419 /* The fixed state is... fixed except for the link state,
420 * which may be determined by a GPIO or a callback.
422 static void phylink_get_fixed_state(struct phylink *pl,
423 struct phylink_link_state *state)
425 *state = pl->link_config;
426 if (pl->get_fixed_state)
427 pl->get_fixed_state(pl->netdev, state);
428 else if (pl->link_gpio)
429 state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
431 phylink_resolve_flow(state);
434 static const char *phylink_pause_to_str(int pause)
436 switch (pause & MLO_PAUSE_TXRX_MASK) {
437 case MLO_PAUSE_TX | MLO_PAUSE_RX:
448 static void phylink_mac_link_up(struct phylink *pl,
449 struct phylink_link_state link_state)
451 struct net_device *ndev = pl->netdev;
453 pl->cur_interface = link_state.interface;
454 pl->ops->mac_link_up(pl->config, pl->cur_link_an_mode,
455 pl->cur_interface, pl->phydev);
458 netif_carrier_on(ndev);
461 "Link is Up - %s/%s - flow control %s\n",
462 phy_speed_to_str(link_state.speed),
463 phy_duplex_to_str(link_state.duplex),
464 phylink_pause_to_str(link_state.pause));
467 static void phylink_mac_link_down(struct phylink *pl)
469 struct net_device *ndev = pl->netdev;
472 netif_carrier_off(ndev);
473 pl->ops->mac_link_down(pl->config, pl->cur_link_an_mode,
475 phylink_info(pl, "Link is Down\n");
478 static void phylink_resolve(struct work_struct *w)
480 struct phylink *pl = container_of(w, struct phylink, resolve);
481 struct phylink_link_state link_state;
482 struct net_device *ndev = pl->netdev;
485 mutex_lock(&pl->state_mutex);
486 if (pl->phylink_disable_state) {
487 pl->mac_link_dropped = false;
488 link_state.link = false;
489 } else if (pl->mac_link_dropped) {
490 link_state.link = false;
492 switch (pl->cur_link_an_mode) {
494 link_state = pl->phy_state;
495 phylink_apply_manual_flow(pl, &link_state);
496 phylink_mac_config_up(pl, &link_state);
500 phylink_get_fixed_state(pl, &link_state);
501 phylink_mac_config_up(pl, &link_state);
505 phylink_mac_pcs_get_state(pl, &link_state);
507 /* If we have a phy, the "up" state is the union of
508 * both the PHY and the MAC */
510 link_state.link &= pl->phy_state.link;
512 /* Only update if the PHY link is up */
513 if (pl->phydev && pl->phy_state.link) {
514 link_state.interface = pl->phy_state.interface;
516 /* If we have a PHY, we need to update with
517 * the PHY flow control bits. */
518 link_state.pause = pl->phy_state.pause;
519 phylink_apply_manual_flow(pl, &link_state);
520 phylink_mac_config(pl, &link_state);
527 link_changed = (link_state.link != netif_carrier_ok(ndev));
529 link_changed = (link_state.link != pl->old_link_state);
532 pl->old_link_state = link_state.link;
533 if (!link_state.link)
534 phylink_mac_link_down(pl);
536 phylink_mac_link_up(pl, link_state);
538 if (!link_state.link && pl->mac_link_dropped) {
539 pl->mac_link_dropped = false;
540 queue_work(system_power_efficient_wq, &pl->resolve);
542 mutex_unlock(&pl->state_mutex);
545 static void phylink_run_resolve(struct phylink *pl)
547 if (!pl->phylink_disable_state)
548 queue_work(system_power_efficient_wq, &pl->resolve);
551 static void phylink_run_resolve_and_disable(struct phylink *pl, int bit)
553 unsigned long state = pl->phylink_disable_state;
555 set_bit(bit, &pl->phylink_disable_state);
557 queue_work(system_power_efficient_wq, &pl->resolve);
558 flush_work(&pl->resolve);
562 static void phylink_fixed_poll(struct timer_list *t)
564 struct phylink *pl = container_of(t, struct phylink, link_poll);
566 mod_timer(t, jiffies + HZ);
568 phylink_run_resolve(pl);
571 static const struct sfp_upstream_ops sfp_phylink_ops;
573 static int phylink_register_sfp(struct phylink *pl,
574 struct fwnode_handle *fwnode)
582 bus = sfp_bus_find_fwnode(fwnode);
585 phylink_err(pl, "unable to attach SFP bus: %d\n", ret);
591 ret = sfp_bus_add_upstream(bus, pl, &sfp_phylink_ops);
598 * phylink_create() - create a phylink instance
599 * @config: a pointer to the target &struct phylink_config
600 * @fwnode: a pointer to a &struct fwnode_handle describing the network
602 * @iface: the desired link mode defined by &typedef phy_interface_t
603 * @ops: a pointer to a &struct phylink_mac_ops for the MAC.
605 * Create a new phylink instance, and parse the link parameters found in @np.
606 * This will parse in-band modes, fixed-link or SFP configuration.
608 * Note: the rtnl lock must not be held when calling this function.
610 * Returns a pointer to a &struct phylink, or an error-pointer value. Users
611 * must use IS_ERR() to check for errors from this function.
613 struct phylink *phylink_create(struct phylink_config *config,
614 struct fwnode_handle *fwnode,
615 phy_interface_t iface,
616 const struct phylink_mac_ops *ops)
621 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
623 return ERR_PTR(-ENOMEM);
625 mutex_init(&pl->state_mutex);
626 INIT_WORK(&pl->resolve, phylink_resolve);
629 if (config->type == PHYLINK_NETDEV) {
630 pl->netdev = to_net_dev(config->dev);
631 } else if (config->type == PHYLINK_DEV) {
632 pl->dev = config->dev;
635 return ERR_PTR(-EINVAL);
638 pl->phy_state.interface = iface;
639 pl->link_interface = iface;
640 if (iface == PHY_INTERFACE_MODE_MOCA)
641 pl->link_port = PORT_BNC;
643 pl->link_port = PORT_MII;
644 pl->link_config.interface = iface;
645 pl->link_config.pause = MLO_PAUSE_AN;
646 pl->link_config.speed = SPEED_UNKNOWN;
647 pl->link_config.duplex = DUPLEX_UNKNOWN;
648 pl->link_config.an_enabled = true;
650 __set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
651 timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
653 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
654 linkmode_copy(pl->link_config.advertising, pl->supported);
655 phylink_validate(pl, pl->supported, &pl->link_config);
657 ret = phylink_parse_mode(pl, fwnode);
663 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
664 ret = phylink_parse_fixedlink(pl, fwnode);
671 pl->cur_link_an_mode = pl->cfg_link_an_mode;
673 ret = phylink_register_sfp(pl, fwnode);
681 EXPORT_SYMBOL_GPL(phylink_create);
684 * phylink_destroy() - cleanup and destroy the phylink instance
685 * @pl: a pointer to a &struct phylink returned from phylink_create()
687 * Destroy a phylink instance. Any PHY that has been attached must have been
688 * cleaned up via phylink_disconnect_phy() prior to calling this function.
690 * Note: the rtnl lock must not be held when calling this function.
692 void phylink_destroy(struct phylink *pl)
694 sfp_bus_del_upstream(pl->sfp_bus);
696 gpiod_put(pl->link_gpio);
698 cancel_work_sync(&pl->resolve);
701 EXPORT_SYMBOL_GPL(phylink_destroy);
703 static void phylink_phy_change(struct phy_device *phydev, bool up,
706 struct phylink *pl = phydev->phylink;
707 bool tx_pause, rx_pause;
709 phy_get_pause(phydev, &tx_pause, &rx_pause);
711 mutex_lock(&pl->state_mutex);
712 pl->phy_state.speed = phydev->speed;
713 pl->phy_state.duplex = phydev->duplex;
714 pl->phy_state.pause = MLO_PAUSE_NONE;
716 pl->phy_state.pause |= MLO_PAUSE_TX;
718 pl->phy_state.pause |= MLO_PAUSE_RX;
719 pl->phy_state.interface = phydev->interface;
720 pl->phy_state.link = up;
721 mutex_unlock(&pl->state_mutex);
723 phylink_run_resolve(pl);
725 phylink_dbg(pl, "phy link %s %s/%s/%s\n", up ? "up" : "down",
726 phy_modes(phydev->interface),
727 phy_speed_to_str(phydev->speed),
728 phy_duplex_to_str(phydev->duplex));
731 static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy,
732 phy_interface_t interface)
734 struct phylink_link_state config;
735 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
740 * This is the new way of dealing with flow control for PHYs,
741 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
742 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
743 * using our validate call to the MAC, we rely upon the MAC
744 * clearing the bits from both supported and advertising fields.
746 phy_support_asym_pause(phy);
748 memset(&config, 0, sizeof(config));
749 linkmode_copy(supported, phy->supported);
750 linkmode_copy(config.advertising, phy->advertising);
752 /* Clause 45 PHYs switch their Serdes lane between several different
753 * modes, normally 10GBASE-R, SGMII. Some use 2500BASE-X for 2.5G
754 * speeds. We really need to know which interface modes the PHY and
755 * MAC supports to properly work out which linkmodes can be supported.
758 interface != PHY_INTERFACE_MODE_RXAUI &&
759 interface != PHY_INTERFACE_MODE_XAUI &&
760 interface != PHY_INTERFACE_MODE_USXGMII)
761 config.interface = PHY_INTERFACE_MODE_NA;
763 config.interface = interface;
765 ret = phylink_validate(pl, supported, &config);
770 phy->phy_link_change = phylink_phy_change;
772 irq_str = phy_attached_info_irq(phy);
774 "PHY [%s] driver [%s] (irq=%s)\n",
775 dev_name(&phy->mdio.dev), phy->drv->name, irq_str);
778 mutex_lock(&phy->lock);
779 mutex_lock(&pl->state_mutex);
781 pl->phy_state.interface = interface;
782 linkmode_copy(pl->supported, supported);
783 linkmode_copy(pl->link_config.advertising, config.advertising);
785 /* Restrict the phy advertisement according to the MAC support. */
786 linkmode_copy(phy->advertising, config.advertising);
787 mutex_unlock(&pl->state_mutex);
788 mutex_unlock(&phy->lock);
791 "phy: setting supported %*pb advertising %*pb\n",
792 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
793 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->advertising);
795 if (phy_interrupt_is_valid(phy))
796 phy_request_interrupt(phy);
801 static int phylink_attach_phy(struct phylink *pl, struct phy_device *phy,
802 phy_interface_t interface)
804 if (WARN_ON(pl->cfg_link_an_mode == MLO_AN_FIXED ||
805 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
806 phy_interface_mode_is_8023z(interface))))
812 return phy_attach_direct(pl->netdev, phy, 0, interface);
816 * phylink_connect_phy() - connect a PHY to the phylink instance
817 * @pl: a pointer to a &struct phylink returned from phylink_create()
818 * @phy: a pointer to a &struct phy_device.
820 * Connect @phy to the phylink instance specified by @pl by calling
821 * phy_attach_direct(). Configure the @phy according to the MAC driver's
822 * capabilities, start the PHYLIB state machine and enable any interrupts
823 * that the PHY supports.
825 * This updates the phylink's ethtool supported and advertising link mode
828 * Returns 0 on success or a negative errno.
830 int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
834 /* Use PHY device/driver interface */
835 if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
836 pl->link_interface = phy->interface;
837 pl->link_config.interface = pl->link_interface;
840 ret = phylink_attach_phy(pl, phy, pl->link_interface);
844 ret = phylink_bringup_phy(pl, phy, pl->link_config.interface);
850 EXPORT_SYMBOL_GPL(phylink_connect_phy);
853 * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
854 * @pl: a pointer to a &struct phylink returned from phylink_create()
855 * @dn: a pointer to a &struct device_node.
856 * @flags: PHY-specific flags to communicate to the PHY device driver
858 * Connect the phy specified in the device node @dn to the phylink instance
859 * specified by @pl. Actions specified in phylink_connect_phy() will be
862 * Returns 0 on success or a negative errno.
864 int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
867 struct device_node *phy_node;
868 struct phy_device *phy_dev;
871 /* Fixed links and 802.3z are handled without needing a PHY */
872 if (pl->cfg_link_an_mode == MLO_AN_FIXED ||
873 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
874 phy_interface_mode_is_8023z(pl->link_interface)))
877 phy_node = of_parse_phandle(dn, "phy-handle", 0);
879 phy_node = of_parse_phandle(dn, "phy", 0);
881 phy_node = of_parse_phandle(dn, "phy-device", 0);
884 if (pl->cfg_link_an_mode == MLO_AN_PHY)
889 phy_dev = of_phy_find_device(phy_node);
890 /* We're done with the phy_node handle */
891 of_node_put(phy_node);
895 ret = phy_attach_direct(pl->netdev, phy_dev, flags,
900 ret = phylink_bringup_phy(pl, phy_dev, pl->link_config.interface);
906 EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
909 * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
911 * @pl: a pointer to a &struct phylink returned from phylink_create()
913 * Disconnect any current PHY from the phylink instance described by @pl.
915 void phylink_disconnect_phy(struct phylink *pl)
917 struct phy_device *phy;
923 mutex_lock(&phy->lock);
924 mutex_lock(&pl->state_mutex);
926 mutex_unlock(&pl->state_mutex);
927 mutex_unlock(&phy->lock);
928 flush_work(&pl->resolve);
933 EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
936 * phylink_fixed_state_cb() - allow setting a fixed link callback
937 * @pl: a pointer to a &struct phylink returned from phylink_create()
938 * @cb: callback to execute to determine the fixed link state.
940 * The MAC driver should call this driver when the state of its link
941 * can be determined through e.g: an out of band MMIO register.
943 int phylink_fixed_state_cb(struct phylink *pl,
944 void (*cb)(struct net_device *dev,
945 struct phylink_link_state *state))
947 /* It does not make sense to let the link be overriden unless we use
950 if (pl->cfg_link_an_mode != MLO_AN_FIXED)
953 mutex_lock(&pl->state_mutex);
954 pl->get_fixed_state = cb;
955 mutex_unlock(&pl->state_mutex);
959 EXPORT_SYMBOL_GPL(phylink_fixed_state_cb);
962 * phylink_mac_change() - notify phylink of a change in MAC state
963 * @pl: a pointer to a &struct phylink returned from phylink_create()
964 * @up: indicates whether the link is currently up.
966 * The MAC driver should call this driver when the state of its link
967 * changes (eg, link failure, new negotiation results, etc.)
969 void phylink_mac_change(struct phylink *pl, bool up)
972 pl->mac_link_dropped = true;
973 phylink_run_resolve(pl);
974 phylink_dbg(pl, "mac link %s\n", up ? "up" : "down");
976 EXPORT_SYMBOL_GPL(phylink_mac_change);
978 static irqreturn_t phylink_link_handler(int irq, void *data)
980 struct phylink *pl = data;
982 phylink_run_resolve(pl);
988 * phylink_start() - start a phylink instance
989 * @pl: a pointer to a &struct phylink returned from phylink_create()
991 * Start the phylink instance specified by @pl, configuring the MAC for the
992 * desired link mode(s) and negotiation style. This should be called from the
993 * network device driver's &struct net_device_ops ndo_open() method.
995 void phylink_start(struct phylink *pl)
999 phylink_info(pl, "configuring for %s/%s link mode\n",
1000 phylink_an_mode_str(pl->cur_link_an_mode),
1001 phy_modes(pl->link_config.interface));
1003 /* Always set the carrier off */
1005 netif_carrier_off(pl->netdev);
1007 /* Apply the link configuration to the MAC when starting. This allows
1008 * a fixed-link to start with the correct parameters, and also
1009 * ensures that we set the appropriate advertisement for Serdes links.
1011 phylink_mac_config(pl, &pl->link_config);
1013 /* Restart autonegotiation if using 802.3z to ensure that the link
1014 * parameters are properly negotiated. This is necessary for DSA
1015 * switches using 802.3z negotiation to ensure they see our modes.
1017 phylink_mac_an_restart(pl);
1019 clear_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
1020 phylink_run_resolve(pl);
1022 if (pl->cfg_link_an_mode == MLO_AN_FIXED && pl->link_gpio) {
1023 int irq = gpiod_to_irq(pl->link_gpio);
1026 if (!request_irq(irq, phylink_link_handler,
1027 IRQF_TRIGGER_RISING |
1028 IRQF_TRIGGER_FALLING,
1035 mod_timer(&pl->link_poll, jiffies + HZ);
1037 if ((pl->cfg_link_an_mode == MLO_AN_FIXED && pl->get_fixed_state) ||
1038 pl->config->pcs_poll)
1039 mod_timer(&pl->link_poll, jiffies + HZ);
1041 phy_start(pl->phydev);
1043 sfp_upstream_start(pl->sfp_bus);
1045 EXPORT_SYMBOL_GPL(phylink_start);
1048 * phylink_stop() - stop a phylink instance
1049 * @pl: a pointer to a &struct phylink returned from phylink_create()
1051 * Stop the phylink instance specified by @pl. This should be called from the
1052 * network device driver's &struct net_device_ops ndo_stop() method. The
1053 * network device's carrier state should not be changed prior to calling this
1056 void phylink_stop(struct phylink *pl)
1061 sfp_upstream_stop(pl->sfp_bus);
1063 phy_stop(pl->phydev);
1064 del_timer_sync(&pl->link_poll);
1066 free_irq(pl->link_irq, pl);
1070 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_STOPPED);
1072 EXPORT_SYMBOL_GPL(phylink_stop);
1075 * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
1076 * @pl: a pointer to a &struct phylink returned from phylink_create()
1077 * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
1079 * Read the wake on lan parameters from the PHY attached to the phylink
1080 * instance specified by @pl. If no PHY is currently attached, report no
1081 * support for wake on lan.
1083 void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1091 phy_ethtool_get_wol(pl->phydev, wol);
1093 EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
1096 * phylink_ethtool_set_wol() - set wake on lan parameters
1097 * @pl: a pointer to a &struct phylink returned from phylink_create()
1098 * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
1100 * Set the wake on lan parameters for the PHY attached to the phylink
1101 * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
1104 * Returns zero on success or negative errno code.
1106 int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1108 int ret = -EOPNOTSUPP;
1113 ret = phy_ethtool_set_wol(pl->phydev, wol);
1117 EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
1119 static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
1121 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
1123 linkmode_zero(mask);
1124 phylink_set_port_modes(mask);
1126 linkmode_and(dst, dst, mask);
1127 linkmode_or(dst, dst, b);
1130 static void phylink_get_ksettings(const struct phylink_link_state *state,
1131 struct ethtool_link_ksettings *kset)
1133 phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
1134 linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
1135 kset->base.speed = state->speed;
1136 kset->base.duplex = state->duplex;
1137 kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
1142 * phylink_ethtool_ksettings_get() - get the current link settings
1143 * @pl: a pointer to a &struct phylink returned from phylink_create()
1144 * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
1146 * Read the current link settings for the phylink instance specified by @pl.
1147 * This will be the link settings read from the MAC, PHY or fixed link
1148 * settings depending on the current negotiation mode.
1150 int phylink_ethtool_ksettings_get(struct phylink *pl,
1151 struct ethtool_link_ksettings *kset)
1153 struct phylink_link_state link_state;
1158 phy_ethtool_ksettings_get(pl->phydev, kset);
1160 kset->base.port = pl->link_port;
1163 linkmode_copy(kset->link_modes.supported, pl->supported);
1165 switch (pl->cur_link_an_mode) {
1167 /* We are using fixed settings. Report these as the
1168 * current link settings - and note that these also
1169 * represent the supported speeds/duplex/pause modes.
1171 phylink_get_fixed_state(pl, &link_state);
1172 phylink_get_ksettings(&link_state, kset);
1176 /* If there is a phy attached, then use the reported
1177 * settings from the phy with no modification.
1182 phylink_mac_pcs_get_state(pl, &link_state);
1184 /* The MAC is reporting the link results from its own PCS
1185 * layer via in-band status. Report these as the current
1188 phylink_get_ksettings(&link_state, kset);
1194 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
1197 * phylink_ethtool_ksettings_set() - set the link settings
1198 * @pl: a pointer to a &struct phylink returned from phylink_create()
1199 * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
1201 int phylink_ethtool_ksettings_set(struct phylink *pl,
1202 const struct ethtool_link_ksettings *kset)
1204 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1205 struct ethtool_link_ksettings our_kset;
1206 struct phylink_link_state config;
1211 if (kset->base.autoneg != AUTONEG_DISABLE &&
1212 kset->base.autoneg != AUTONEG_ENABLE)
1215 linkmode_copy(support, pl->supported);
1216 config = pl->link_config;
1218 /* Mask out unsupported advertisements */
1219 linkmode_and(config.advertising, kset->link_modes.advertising,
1222 /* FIXME: should we reject autoneg if phy/mac does not support it? */
1223 if (kset->base.autoneg == AUTONEG_DISABLE) {
1224 const struct phy_setting *s;
1226 /* Autonegotiation disabled, select a suitable speed and
1229 s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
1234 /* If we have a fixed link (as specified by firmware), refuse
1235 * to change link parameters.
1237 if (pl->cur_link_an_mode == MLO_AN_FIXED &&
1238 (s->speed != pl->link_config.speed ||
1239 s->duplex != pl->link_config.duplex))
1242 config.speed = s->speed;
1243 config.duplex = s->duplex;
1244 config.an_enabled = false;
1246 __clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1248 /* If we have a fixed link, refuse to enable autonegotiation */
1249 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1252 config.speed = SPEED_UNKNOWN;
1253 config.duplex = DUPLEX_UNKNOWN;
1254 config.an_enabled = true;
1256 __set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1260 /* If we have a PHY, we process the kset change via phylib.
1261 * phylib will call our link state function if the PHY
1262 * parameters have changed, which will trigger a resolve
1263 * and update the MAC configuration.
1266 linkmode_copy(our_kset.link_modes.advertising,
1267 config.advertising);
1268 our_kset.base.speed = config.speed;
1269 our_kset.base.duplex = config.duplex;
1271 ret = phy_ethtool_ksettings_set(pl->phydev, &our_kset);
1275 mutex_lock(&pl->state_mutex);
1276 /* Save the new configuration */
1277 linkmode_copy(pl->link_config.advertising,
1278 our_kset.link_modes.advertising);
1279 pl->link_config.interface = config.interface;
1280 pl->link_config.speed = our_kset.base.speed;
1281 pl->link_config.duplex = our_kset.base.duplex;
1282 pl->link_config.an_enabled = our_kset.base.autoneg !=
1284 mutex_unlock(&pl->state_mutex);
1286 /* For a fixed link, this isn't able to change any parameters,
1287 * which just leaves inband mode.
1289 if (phylink_validate(pl, support, &config))
1292 /* If autonegotiation is enabled, we must have an advertisement */
1293 if (config.an_enabled &&
1294 phylink_is_empty_linkmode(config.advertising))
1297 mutex_lock(&pl->state_mutex);
1298 linkmode_copy(pl->link_config.advertising, config.advertising);
1299 pl->link_config.interface = config.interface;
1300 pl->link_config.speed = config.speed;
1301 pl->link_config.duplex = config.duplex;
1302 pl->link_config.an_enabled = kset->base.autoneg !=
1305 if (pl->cur_link_an_mode == MLO_AN_INBAND &&
1306 !test_bit(PHYLINK_DISABLE_STOPPED,
1307 &pl->phylink_disable_state)) {
1308 /* If in 802.3z mode, this updates the advertisement.
1310 * If we are in SGMII mode without a PHY, there is no
1311 * advertisement; the only thing we have is the pause
1312 * modes which can only come from a PHY.
1314 phylink_mac_config(pl, &pl->link_config);
1315 phylink_mac_an_restart(pl);
1317 mutex_unlock(&pl->state_mutex);
1322 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
1325 * phylink_ethtool_nway_reset() - restart negotiation
1326 * @pl: a pointer to a &struct phylink returned from phylink_create()
1328 * Restart negotiation for the phylink instance specified by @pl. This will
1329 * cause any attached phy to restart negotiation with the link partner, and
1330 * if the MAC is in a BaseX mode, the MAC will also be requested to restart
1333 * Returns zero on success, or negative error code.
1335 int phylink_ethtool_nway_reset(struct phylink *pl)
1342 ret = phy_restart_aneg(pl->phydev);
1343 phylink_mac_an_restart(pl);
1347 EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
1350 * phylink_ethtool_get_pauseparam() - get the current pause parameters
1351 * @pl: a pointer to a &struct phylink returned from phylink_create()
1352 * @pause: a pointer to a &struct ethtool_pauseparam
1354 void phylink_ethtool_get_pauseparam(struct phylink *pl,
1355 struct ethtool_pauseparam *pause)
1359 pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
1360 pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
1361 pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
1363 EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
1366 * phylink_ethtool_set_pauseparam() - set the current pause parameters
1367 * @pl: a pointer to a &struct phylink returned from phylink_create()
1368 * @pause: a pointer to a &struct ethtool_pauseparam
1370 int phylink_ethtool_set_pauseparam(struct phylink *pl,
1371 struct ethtool_pauseparam *pause)
1373 struct phylink_link_state *config = &pl->link_config;
1377 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1380 if (!phylink_test(pl->supported, Pause) &&
1381 !phylink_test(pl->supported, Asym_Pause))
1384 if (!phylink_test(pl->supported, Asym_Pause) &&
1385 !pause->autoneg && pause->rx_pause != pause->tx_pause)
1390 config->pause |= MLO_PAUSE_AN;
1391 if (pause->rx_pause)
1392 config->pause |= MLO_PAUSE_RX;
1393 if (pause->tx_pause)
1394 config->pause |= MLO_PAUSE_TX;
1396 /* If we have a PHY, phylib will call our link state function if the
1397 * mode has changed, which will trigger a resolve and update the MAC
1401 phy_set_asym_pause(pl->phydev, pause->rx_pause,
1403 } else if (!test_bit(PHYLINK_DISABLE_STOPPED,
1404 &pl->phylink_disable_state)) {
1405 phylink_mac_config(pl, &pl->link_config);
1406 phylink_mac_an_restart(pl);
1411 EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
1414 * phylink_ethtool_get_eee_err() - read the energy efficient ethernet error
1416 * @pl: a pointer to a &struct phylink returned from phylink_create().
1418 * Read the Energy Efficient Ethernet error counter from the PHY associated
1419 * with the phylink instance specified by @pl.
1421 * Returns positive error counter value, or negative error code.
1423 int phylink_get_eee_err(struct phylink *pl)
1430 ret = phy_get_eee_err(pl->phydev);
1434 EXPORT_SYMBOL_GPL(phylink_get_eee_err);
1437 * phylink_init_eee() - init and check the EEE features
1438 * @pl: a pointer to a &struct phylink returned from phylink_create()
1439 * @clk_stop_enable: allow PHY to stop receive clock
1441 * Must be called either with RTNL held or within mac_link_up()
1443 int phylink_init_eee(struct phylink *pl, bool clk_stop_enable)
1445 int ret = -EOPNOTSUPP;
1448 ret = phy_init_eee(pl->phydev, clk_stop_enable);
1452 EXPORT_SYMBOL_GPL(phylink_init_eee);
1455 * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
1456 * @pl: a pointer to a &struct phylink returned from phylink_create()
1457 * @eee: a pointer to a &struct ethtool_eee for the read parameters
1459 int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
1461 int ret = -EOPNOTSUPP;
1466 ret = phy_ethtool_get_eee(pl->phydev, eee);
1470 EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
1473 * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
1474 * @pl: a pointer to a &struct phylink returned from phylink_create()
1475 * @eee: a pointer to a &struct ethtool_eee for the desired parameters
1477 int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
1479 int ret = -EOPNOTSUPP;
1484 ret = phy_ethtool_set_eee(pl->phydev, eee);
1488 EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
1490 /* This emulates MII registers for a fixed-mode phy operating as per the
1491 * passed in state. "aneg" defines if we report negotiation is possible.
1493 * FIXME: should deal with negotiation state too.
1495 static int phylink_mii_emul_read(unsigned int reg,
1496 struct phylink_link_state *state)
1498 struct fixed_phy_status fs;
1499 unsigned long *lpa = state->lp_advertising;
1502 fs.link = state->link;
1503 fs.speed = state->speed;
1504 fs.duplex = state->duplex;
1505 fs.pause = test_bit(ETHTOOL_LINK_MODE_Pause_BIT, lpa);
1506 fs.asym_pause = test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, lpa);
1508 val = swphy_read_reg(reg, &fs);
1509 if (reg == MII_BMSR) {
1510 if (!state->an_complete)
1511 val &= ~BMSR_ANEGCOMPLETE;
1516 static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
1519 struct phy_device *phydev = pl->phydev;
1522 if (mdio_phy_id_is_c45(phy_id)) {
1523 prtad = mdio_phy_id_prtad(phy_id);
1524 devad = mdio_phy_id_devad(phy_id);
1525 devad = MII_ADDR_C45 | devad << 16 | reg;
1526 } else if (phydev->is_c45) {
1532 devad = __ffs(phydev->c45_ids.devices_in_package);
1536 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1538 devad = MDIO_MMD_AN;
1539 if (reg == MII_ADVERTISE)
1540 reg = MDIO_AN_ADVERTISE;
1548 devad = MII_ADDR_C45 | devad << 16 | reg;
1553 return mdiobus_read(pl->phydev->mdio.bus, prtad, devad);
1556 static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
1557 unsigned int reg, unsigned int val)
1559 struct phy_device *phydev = pl->phydev;
1562 if (mdio_phy_id_is_c45(phy_id)) {
1563 prtad = mdio_phy_id_prtad(phy_id);
1564 devad = mdio_phy_id_devad(phy_id);
1565 devad = MII_ADDR_C45 | devad << 16 | reg;
1566 } else if (phydev->is_c45) {
1572 devad = __ffs(phydev->c45_ids.devices_in_package);
1576 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1578 devad = MDIO_MMD_AN;
1579 if (reg == MII_ADVERTISE)
1580 reg = MDIO_AN_ADVERTISE;
1588 devad = MII_ADDR_C45 | devad << 16 | reg;
1594 return mdiobus_write(phydev->mdio.bus, prtad, devad, val);
1597 static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
1600 struct phylink_link_state state;
1603 switch (pl->cur_link_an_mode) {
1606 phylink_get_fixed_state(pl, &state);
1607 val = phylink_mii_emul_read(reg, &state);
1616 phylink_mac_pcs_get_state(pl, &state);
1617 val = phylink_mii_emul_read(reg, &state);
1622 return val & 0xffff;
1625 static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
1626 unsigned int reg, unsigned int val)
1628 switch (pl->cur_link_an_mode) {
1643 * phylink_mii_ioctl() - generic mii ioctl interface
1644 * @pl: a pointer to a &struct phylink returned from phylink_create()
1645 * @ifr: a pointer to a &struct ifreq for socket ioctls
1646 * @cmd: ioctl cmd to execute
1648 * Perform the specified MII ioctl on the PHY attached to the phylink instance
1649 * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
1651 * Returns: zero on success or negative error code.
1654 * read register from the current PHY.
1656 * read register from the specified PHY.
1658 * set a register on the specified PHY.
1660 int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
1662 struct mii_ioctl_data *mii = if_mii(ifr);
1668 /* PHYs only exist for MLO_AN_PHY and SGMII */
1671 mii->phy_id = pl->phydev->mdio.addr;
1675 ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
1683 ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
1688 ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
1698 ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
1706 ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
1718 EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
1720 static void phylink_sfp_attach(void *upstream, struct sfp_bus *bus)
1722 struct phylink *pl = upstream;
1724 pl->netdev->sfp_bus = bus;
1727 static void phylink_sfp_detach(void *upstream, struct sfp_bus *bus)
1729 struct phylink *pl = upstream;
1731 pl->netdev->sfp_bus = NULL;
1734 static int phylink_sfp_config(struct phylink *pl, u8 mode,
1735 const unsigned long *supported,
1736 const unsigned long *advertising)
1738 __ETHTOOL_DECLARE_LINK_MODE_MASK(support1);
1739 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1740 struct phylink_link_state config;
1741 phy_interface_t iface;
1745 linkmode_copy(support, supported);
1747 memset(&config, 0, sizeof(config));
1748 linkmode_copy(config.advertising, advertising);
1749 config.interface = PHY_INTERFACE_MODE_NA;
1750 config.speed = SPEED_UNKNOWN;
1751 config.duplex = DUPLEX_UNKNOWN;
1752 config.pause = MLO_PAUSE_AN;
1753 config.an_enabled = pl->link_config.an_enabled;
1755 /* Ignore errors if we're expecting a PHY to attach later */
1756 ret = phylink_validate(pl, support, &config);
1758 phylink_err(pl, "validation with support %*pb failed: %d\n",
1759 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1763 iface = sfp_select_interface(pl->sfp_bus, config.advertising);
1764 if (iface == PHY_INTERFACE_MODE_NA) {
1766 "selection of interface failed, advertisement %*pb\n",
1767 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
1771 config.interface = iface;
1772 linkmode_copy(support1, support);
1773 ret = phylink_validate(pl, support1, &config);
1775 phylink_err(pl, "validation of %s/%s with support %*pb failed: %d\n",
1776 phylink_an_mode_str(mode),
1777 phy_modes(config.interface),
1778 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1782 phylink_dbg(pl, "requesting link mode %s/%s with support %*pb\n",
1783 phylink_an_mode_str(mode), phy_modes(config.interface),
1784 __ETHTOOL_LINK_MODE_MASK_NBITS, support);
1786 if (phy_interface_mode_is_8023z(iface) && pl->phydev)
1789 changed = !linkmode_equal(pl->supported, support);
1791 linkmode_copy(pl->supported, support);
1792 linkmode_copy(pl->link_config.advertising, config.advertising);
1795 if (pl->cur_link_an_mode != mode ||
1796 pl->link_config.interface != config.interface) {
1797 pl->link_config.interface = config.interface;
1798 pl->cur_link_an_mode = mode;
1802 phylink_info(pl, "switched to %s/%s link mode\n",
1803 phylink_an_mode_str(mode),
1804 phy_modes(config.interface));
1807 pl->link_port = pl->sfp_port;
1809 if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
1810 &pl->phylink_disable_state))
1811 phylink_mac_config(pl, &pl->link_config);
1816 static int phylink_sfp_module_insert(void *upstream,
1817 const struct sfp_eeprom_id *id)
1819 struct phylink *pl = upstream;
1820 unsigned long *support = pl->sfp_support;
1824 linkmode_zero(support);
1825 sfp_parse_support(pl->sfp_bus, id, support);
1826 pl->sfp_port = sfp_parse_port(pl->sfp_bus, id, support);
1828 /* If this module may have a PHY connecting later, defer until later */
1829 pl->sfp_may_have_phy = sfp_may_have_phy(pl->sfp_bus, id);
1830 if (pl->sfp_may_have_phy)
1833 return phylink_sfp_config(pl, MLO_AN_INBAND, support, support);
1836 static int phylink_sfp_module_start(void *upstream)
1838 struct phylink *pl = upstream;
1840 /* If this SFP module has a PHY, start the PHY now. */
1842 phy_start(pl->phydev);
1846 /* If the module may have a PHY but we didn't detect one we
1847 * need to configure the MAC here.
1849 if (!pl->sfp_may_have_phy)
1852 return phylink_sfp_config(pl, MLO_AN_INBAND,
1853 pl->sfp_support, pl->sfp_support);
1856 static void phylink_sfp_module_stop(void *upstream)
1858 struct phylink *pl = upstream;
1860 /* If this SFP module has a PHY, stop it. */
1862 phy_stop(pl->phydev);
1865 static void phylink_sfp_link_down(void *upstream)
1867 struct phylink *pl = upstream;
1871 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_LINK);
1874 static void phylink_sfp_link_up(void *upstream)
1876 struct phylink *pl = upstream;
1880 clear_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
1881 phylink_run_resolve(pl);
1884 /* The Broadcom BCM84881 in the Methode DM7052 is unable to provide a SGMII
1885 * or 802.3z control word, so inband will not work.
1887 static bool phylink_phy_no_inband(struct phy_device *phy)
1889 return phy->is_c45 &&
1890 (phy->c45_ids.device_ids[1] & 0xfffffff0) == 0xae025150;
1893 static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
1895 struct phylink *pl = upstream;
1896 phy_interface_t interface;
1901 * This is the new way of dealing with flow control for PHYs,
1902 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
1903 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
1904 * using our validate call to the MAC, we rely upon the MAC
1905 * clearing the bits from both supported and advertising fields.
1907 phy_support_asym_pause(phy);
1909 if (phylink_phy_no_inband(phy))
1912 mode = MLO_AN_INBAND;
1914 /* Do the initial configuration */
1915 ret = phylink_sfp_config(pl, mode, phy->supported, phy->advertising);
1919 interface = pl->link_config.interface;
1920 ret = phylink_attach_phy(pl, phy, interface);
1924 ret = phylink_bringup_phy(pl, phy, interface);
1931 static void phylink_sfp_disconnect_phy(void *upstream)
1933 phylink_disconnect_phy(upstream);
1936 static const struct sfp_upstream_ops sfp_phylink_ops = {
1937 .attach = phylink_sfp_attach,
1938 .detach = phylink_sfp_detach,
1939 .module_insert = phylink_sfp_module_insert,
1940 .module_start = phylink_sfp_module_start,
1941 .module_stop = phylink_sfp_module_stop,
1942 .link_up = phylink_sfp_link_up,
1943 .link_down = phylink_sfp_link_down,
1944 .connect_phy = phylink_sfp_connect_phy,
1945 .disconnect_phy = phylink_sfp_disconnect_phy,
1948 /* Helpers for MAC drivers */
1951 * phylink_helper_basex_speed() - 1000BaseX/2500BaseX helper
1952 * @state: a pointer to a &struct phylink_link_state
1954 * Inspect the interface mode, advertising mask or forced speed and
1955 * decide whether to run at 2.5Gbit or 1Gbit appropriately, switching
1956 * the interface mode to suit. @state->interface is appropriately
1957 * updated, and the advertising mask has the "other" baseX_Full flag
1960 void phylink_helper_basex_speed(struct phylink_link_state *state)
1962 if (phy_interface_mode_is_8023z(state->interface)) {
1963 bool want_2500 = state->an_enabled ?
1964 phylink_test(state->advertising, 2500baseX_Full) :
1965 state->speed == SPEED_2500;
1968 phylink_clear(state->advertising, 1000baseX_Full);
1969 state->interface = PHY_INTERFACE_MODE_2500BASEX;
1971 phylink_clear(state->advertising, 2500baseX_Full);
1972 state->interface = PHY_INTERFACE_MODE_1000BASEX;
1976 EXPORT_SYMBOL_GPL(phylink_helper_basex_speed);
1978 MODULE_LICENSE("GPL v2");