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_apply_manual_flow(struct phylink *pl,
343 struct phylink_link_state *state)
345 /* If autoneg is disabled, pause AN is also disabled */
346 if (!state->an_enabled)
347 state->pause &= ~MLO_PAUSE_AN;
349 /* Manual configuration of pause modes */
350 if (!(pl->link_config.pause & MLO_PAUSE_AN))
351 state->pause = pl->link_config.pause;
354 static void phylink_mac_config(struct phylink *pl,
355 const struct phylink_link_state *state)
358 "%s: mode=%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
359 __func__, phylink_an_mode_str(pl->cur_link_an_mode),
360 phy_modes(state->interface),
361 phy_speed_to_str(state->speed),
362 phy_duplex_to_str(state->duplex),
363 __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
364 state->pause, state->link, state->an_enabled);
366 pl->ops->mac_config(pl->config, pl->cur_link_an_mode, state);
369 static void phylink_mac_config_up(struct phylink *pl,
370 const struct phylink_link_state *state)
373 phylink_mac_config(pl, state);
376 static void phylink_mac_an_restart(struct phylink *pl)
378 if (pl->link_config.an_enabled &&
379 phy_interface_mode_is_8023z(pl->link_config.interface))
380 pl->ops->mac_an_restart(pl->config);
383 static void phylink_mac_pcs_get_state(struct phylink *pl,
384 struct phylink_link_state *state)
386 linkmode_copy(state->advertising, pl->link_config.advertising);
387 linkmode_zero(state->lp_advertising);
388 state->interface = pl->link_config.interface;
389 state->an_enabled = pl->link_config.an_enabled;
390 state->speed = SPEED_UNKNOWN;
391 state->duplex = DUPLEX_UNKNOWN;
392 state->pause = MLO_PAUSE_NONE;
393 state->an_complete = 0;
396 pl->ops->mac_pcs_get_state(pl->config, state);
399 /* The fixed state is... fixed except for the link state,
400 * which may be determined by a GPIO or a callback.
402 static void phylink_get_fixed_state(struct phylink *pl, struct phylink_link_state *state)
404 *state = pl->link_config;
405 if (pl->get_fixed_state)
406 pl->get_fixed_state(pl->netdev, state);
407 else if (pl->link_gpio)
408 state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
411 /* Flow control is resolved according to our and the link partners
412 * advertisements using the following drawn from the 802.3 specs:
413 * Local device Link partner
414 * Pause AsymDir Pause AsymDir Result
419 static void phylink_resolve_flow(struct phylink *pl,
420 struct phylink_link_state *state)
425 if (phylink_test(pl->link_config.advertising, Pause))
426 pause |= MLO_PAUSE_SYM;
427 if (phylink_test(pl->link_config.advertising, Asym_Pause))
428 pause |= MLO_PAUSE_ASYM;
430 pause &= state->pause;
432 if (pause & MLO_PAUSE_SYM)
433 new_pause = MLO_PAUSE_TX | MLO_PAUSE_RX;
434 else if (pause & MLO_PAUSE_ASYM)
435 new_pause = state->pause & MLO_PAUSE_SYM ?
436 MLO_PAUSE_TX : MLO_PAUSE_RX;
438 state->pause &= ~MLO_PAUSE_TXRX_MASK;
439 state->pause |= new_pause;
442 static const char *phylink_pause_to_str(int pause)
444 switch (pause & MLO_PAUSE_TXRX_MASK) {
445 case MLO_PAUSE_TX | MLO_PAUSE_RX:
456 static void phylink_mac_link_up(struct phylink *pl,
457 struct phylink_link_state link_state)
459 struct net_device *ndev = pl->netdev;
461 pl->cur_interface = link_state.interface;
462 pl->ops->mac_link_up(pl->config, pl->cur_link_an_mode,
463 pl->cur_interface, pl->phydev);
466 netif_carrier_on(ndev);
469 "Link is Up - %s/%s - flow control %s\n",
470 phy_speed_to_str(link_state.speed),
471 phy_duplex_to_str(link_state.duplex),
472 phylink_pause_to_str(link_state.pause));
475 static void phylink_mac_link_down(struct phylink *pl)
477 struct net_device *ndev = pl->netdev;
480 netif_carrier_off(ndev);
481 pl->ops->mac_link_down(pl->config, pl->cur_link_an_mode,
483 phylink_info(pl, "Link is Down\n");
486 static void phylink_resolve(struct work_struct *w)
488 struct phylink *pl = container_of(w, struct phylink, resolve);
489 struct phylink_link_state link_state;
490 struct net_device *ndev = pl->netdev;
493 mutex_lock(&pl->state_mutex);
494 if (pl->phylink_disable_state) {
495 pl->mac_link_dropped = false;
496 link_state.link = false;
497 } else if (pl->mac_link_dropped) {
498 link_state.link = false;
500 switch (pl->cur_link_an_mode) {
502 link_state = pl->phy_state;
503 phylink_apply_manual_flow(pl, &link_state);
504 phylink_mac_config_up(pl, &link_state);
508 phylink_get_fixed_state(pl, &link_state);
509 phylink_mac_config_up(pl, &link_state);
513 phylink_mac_pcs_get_state(pl, &link_state);
515 /* If we have a phy, the "up" state is the union of
516 * both the PHY and the MAC */
518 link_state.link &= pl->phy_state.link;
520 /* Only update if the PHY link is up */
521 if (pl->phydev && pl->phy_state.link) {
522 link_state.interface = pl->phy_state.interface;
524 /* If we have a PHY, we need to update with
525 * the PHY flow control bits. */
526 link_state.pause = pl->phy_state.pause;
527 phylink_apply_manual_flow(pl, &link_state);
528 phylink_mac_config(pl, &link_state);
535 link_changed = (link_state.link != netif_carrier_ok(ndev));
537 link_changed = (link_state.link != pl->old_link_state);
540 pl->old_link_state = link_state.link;
541 if (!link_state.link)
542 phylink_mac_link_down(pl);
544 phylink_mac_link_up(pl, link_state);
546 if (!link_state.link && pl->mac_link_dropped) {
547 pl->mac_link_dropped = false;
548 queue_work(system_power_efficient_wq, &pl->resolve);
550 mutex_unlock(&pl->state_mutex);
553 static void phylink_run_resolve(struct phylink *pl)
555 if (!pl->phylink_disable_state)
556 queue_work(system_power_efficient_wq, &pl->resolve);
559 static void phylink_run_resolve_and_disable(struct phylink *pl, int bit)
561 unsigned long state = pl->phylink_disable_state;
563 set_bit(bit, &pl->phylink_disable_state);
565 queue_work(system_power_efficient_wq, &pl->resolve);
566 flush_work(&pl->resolve);
570 static void phylink_fixed_poll(struct timer_list *t)
572 struct phylink *pl = container_of(t, struct phylink, link_poll);
574 mod_timer(t, jiffies + HZ);
576 phylink_run_resolve(pl);
579 static const struct sfp_upstream_ops sfp_phylink_ops;
581 static int phylink_register_sfp(struct phylink *pl,
582 struct fwnode_handle *fwnode)
590 bus = sfp_bus_find_fwnode(fwnode);
593 phylink_err(pl, "unable to attach SFP bus: %d\n", ret);
599 ret = sfp_bus_add_upstream(bus, pl, &sfp_phylink_ops);
606 * phylink_create() - create a phylink instance
607 * @config: a pointer to the target &struct phylink_config
608 * @fwnode: a pointer to a &struct fwnode_handle describing the network
610 * @iface: the desired link mode defined by &typedef phy_interface_t
611 * @ops: a pointer to a &struct phylink_mac_ops for the MAC.
613 * Create a new phylink instance, and parse the link parameters found in @np.
614 * This will parse in-band modes, fixed-link or SFP configuration.
616 * Note: the rtnl lock must not be held when calling this function.
618 * Returns a pointer to a &struct phylink, or an error-pointer value. Users
619 * must use IS_ERR() to check for errors from this function.
621 struct phylink *phylink_create(struct phylink_config *config,
622 struct fwnode_handle *fwnode,
623 phy_interface_t iface,
624 const struct phylink_mac_ops *ops)
629 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
631 return ERR_PTR(-ENOMEM);
633 mutex_init(&pl->state_mutex);
634 INIT_WORK(&pl->resolve, phylink_resolve);
637 if (config->type == PHYLINK_NETDEV) {
638 pl->netdev = to_net_dev(config->dev);
639 } else if (config->type == PHYLINK_DEV) {
640 pl->dev = config->dev;
643 return ERR_PTR(-EINVAL);
646 pl->phy_state.interface = iface;
647 pl->link_interface = iface;
648 if (iface == PHY_INTERFACE_MODE_MOCA)
649 pl->link_port = PORT_BNC;
651 pl->link_port = PORT_MII;
652 pl->link_config.interface = iface;
653 pl->link_config.pause = MLO_PAUSE_AN;
654 pl->link_config.speed = SPEED_UNKNOWN;
655 pl->link_config.duplex = DUPLEX_UNKNOWN;
656 pl->link_config.an_enabled = true;
658 __set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
659 timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
661 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
662 linkmode_copy(pl->link_config.advertising, pl->supported);
663 phylink_validate(pl, pl->supported, &pl->link_config);
665 ret = phylink_parse_mode(pl, fwnode);
671 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
672 ret = phylink_parse_fixedlink(pl, fwnode);
679 pl->cur_link_an_mode = pl->cfg_link_an_mode;
681 ret = phylink_register_sfp(pl, fwnode);
689 EXPORT_SYMBOL_GPL(phylink_create);
692 * phylink_destroy() - cleanup and destroy the phylink instance
693 * @pl: a pointer to a &struct phylink returned from phylink_create()
695 * Destroy a phylink instance. Any PHY that has been attached must have been
696 * cleaned up via phylink_disconnect_phy() prior to calling this function.
698 * Note: the rtnl lock must not be held when calling this function.
700 void phylink_destroy(struct phylink *pl)
702 sfp_bus_del_upstream(pl->sfp_bus);
704 gpiod_put(pl->link_gpio);
706 cancel_work_sync(&pl->resolve);
709 EXPORT_SYMBOL_GPL(phylink_destroy);
711 static void phylink_phy_change(struct phy_device *phydev, bool up,
714 struct phylink *pl = phydev->phylink;
715 bool tx_pause, rx_pause;
717 phy_get_pause(phydev, &tx_pause, &rx_pause);
719 mutex_lock(&pl->state_mutex);
720 pl->phy_state.speed = phydev->speed;
721 pl->phy_state.duplex = phydev->duplex;
722 pl->phy_state.pause = MLO_PAUSE_NONE;
724 pl->phy_state.pause |= MLO_PAUSE_TX;
726 pl->phy_state.pause |= MLO_PAUSE_RX;
727 pl->phy_state.interface = phydev->interface;
728 pl->phy_state.link = up;
729 mutex_unlock(&pl->state_mutex);
731 phylink_run_resolve(pl);
733 phylink_dbg(pl, "phy link %s %s/%s/%s\n", up ? "up" : "down",
734 phy_modes(phydev->interface),
735 phy_speed_to_str(phydev->speed),
736 phy_duplex_to_str(phydev->duplex));
739 static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy,
740 phy_interface_t interface)
742 struct phylink_link_state config;
743 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
748 * This is the new way of dealing with flow control for PHYs,
749 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
750 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
751 * using our validate call to the MAC, we rely upon the MAC
752 * clearing the bits from both supported and advertising fields.
754 phy_support_asym_pause(phy);
756 memset(&config, 0, sizeof(config));
757 linkmode_copy(supported, phy->supported);
758 linkmode_copy(config.advertising, phy->advertising);
760 /* Clause 45 PHYs switch their Serdes lane between several different
761 * modes, normally 10GBASE-R, SGMII. Some use 2500BASE-X for 2.5G
762 * speeds. We really need to know which interface modes the PHY and
763 * MAC supports to properly work out which linkmodes can be supported.
766 interface != PHY_INTERFACE_MODE_RXAUI &&
767 interface != PHY_INTERFACE_MODE_XAUI &&
768 interface != PHY_INTERFACE_MODE_USXGMII)
769 config.interface = PHY_INTERFACE_MODE_NA;
771 config.interface = interface;
773 ret = phylink_validate(pl, supported, &config);
778 phy->phy_link_change = phylink_phy_change;
780 irq_str = phy_attached_info_irq(phy);
782 "PHY [%s] driver [%s] (irq=%s)\n",
783 dev_name(&phy->mdio.dev), phy->drv->name, irq_str);
786 mutex_lock(&phy->lock);
787 mutex_lock(&pl->state_mutex);
789 pl->phy_state.interface = interface;
790 linkmode_copy(pl->supported, supported);
791 linkmode_copy(pl->link_config.advertising, config.advertising);
793 /* Restrict the phy advertisement according to the MAC support. */
794 linkmode_copy(phy->advertising, config.advertising);
795 mutex_unlock(&pl->state_mutex);
796 mutex_unlock(&phy->lock);
799 "phy: setting supported %*pb advertising %*pb\n",
800 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
801 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->advertising);
803 if (phy_interrupt_is_valid(phy))
804 phy_request_interrupt(phy);
809 static int phylink_attach_phy(struct phylink *pl, struct phy_device *phy,
810 phy_interface_t interface)
812 if (WARN_ON(pl->cfg_link_an_mode == MLO_AN_FIXED ||
813 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
814 phy_interface_mode_is_8023z(interface))))
820 return phy_attach_direct(pl->netdev, phy, 0, interface);
824 * phylink_connect_phy() - connect a PHY to the phylink instance
825 * @pl: a pointer to a &struct phylink returned from phylink_create()
826 * @phy: a pointer to a &struct phy_device.
828 * Connect @phy to the phylink instance specified by @pl by calling
829 * phy_attach_direct(). Configure the @phy according to the MAC driver's
830 * capabilities, start the PHYLIB state machine and enable any interrupts
831 * that the PHY supports.
833 * This updates the phylink's ethtool supported and advertising link mode
836 * Returns 0 on success or a negative errno.
838 int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
842 /* Use PHY device/driver interface */
843 if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
844 pl->link_interface = phy->interface;
845 pl->link_config.interface = pl->link_interface;
848 ret = phylink_attach_phy(pl, phy, pl->link_interface);
852 ret = phylink_bringup_phy(pl, phy, pl->link_config.interface);
858 EXPORT_SYMBOL_GPL(phylink_connect_phy);
861 * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
862 * @pl: a pointer to a &struct phylink returned from phylink_create()
863 * @dn: a pointer to a &struct device_node.
864 * @flags: PHY-specific flags to communicate to the PHY device driver
866 * Connect the phy specified in the device node @dn to the phylink instance
867 * specified by @pl. Actions specified in phylink_connect_phy() will be
870 * Returns 0 on success or a negative errno.
872 int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
875 struct device_node *phy_node;
876 struct phy_device *phy_dev;
879 /* Fixed links and 802.3z are handled without needing a PHY */
880 if (pl->cfg_link_an_mode == MLO_AN_FIXED ||
881 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
882 phy_interface_mode_is_8023z(pl->link_interface)))
885 phy_node = of_parse_phandle(dn, "phy-handle", 0);
887 phy_node = of_parse_phandle(dn, "phy", 0);
889 phy_node = of_parse_phandle(dn, "phy-device", 0);
892 if (pl->cfg_link_an_mode == MLO_AN_PHY)
897 phy_dev = of_phy_find_device(phy_node);
898 /* We're done with the phy_node handle */
899 of_node_put(phy_node);
903 ret = phy_attach_direct(pl->netdev, phy_dev, flags,
908 ret = phylink_bringup_phy(pl, phy_dev, pl->link_config.interface);
914 EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
917 * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
919 * @pl: a pointer to a &struct phylink returned from phylink_create()
921 * Disconnect any current PHY from the phylink instance described by @pl.
923 void phylink_disconnect_phy(struct phylink *pl)
925 struct phy_device *phy;
931 mutex_lock(&phy->lock);
932 mutex_lock(&pl->state_mutex);
934 mutex_unlock(&pl->state_mutex);
935 mutex_unlock(&phy->lock);
936 flush_work(&pl->resolve);
941 EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
944 * phylink_fixed_state_cb() - allow setting a fixed link callback
945 * @pl: a pointer to a &struct phylink returned from phylink_create()
946 * @cb: callback to execute to determine the fixed link state.
948 * The MAC driver should call this driver when the state of its link
949 * can be determined through e.g: an out of band MMIO register.
951 int phylink_fixed_state_cb(struct phylink *pl,
952 void (*cb)(struct net_device *dev,
953 struct phylink_link_state *state))
955 /* It does not make sense to let the link be overriden unless we use
958 if (pl->cfg_link_an_mode != MLO_AN_FIXED)
961 mutex_lock(&pl->state_mutex);
962 pl->get_fixed_state = cb;
963 mutex_unlock(&pl->state_mutex);
967 EXPORT_SYMBOL_GPL(phylink_fixed_state_cb);
970 * phylink_mac_change() - notify phylink of a change in MAC state
971 * @pl: a pointer to a &struct phylink returned from phylink_create()
972 * @up: indicates whether the link is currently up.
974 * The MAC driver should call this driver when the state of its link
975 * changes (eg, link failure, new negotiation results, etc.)
977 void phylink_mac_change(struct phylink *pl, bool up)
980 pl->mac_link_dropped = true;
981 phylink_run_resolve(pl);
982 phylink_dbg(pl, "mac link %s\n", up ? "up" : "down");
984 EXPORT_SYMBOL_GPL(phylink_mac_change);
986 static irqreturn_t phylink_link_handler(int irq, void *data)
988 struct phylink *pl = data;
990 phylink_run_resolve(pl);
996 * phylink_start() - start a phylink instance
997 * @pl: a pointer to a &struct phylink returned from phylink_create()
999 * Start the phylink instance specified by @pl, configuring the MAC for the
1000 * desired link mode(s) and negotiation style. This should be called from the
1001 * network device driver's &struct net_device_ops ndo_open() method.
1003 void phylink_start(struct phylink *pl)
1007 phylink_info(pl, "configuring for %s/%s link mode\n",
1008 phylink_an_mode_str(pl->cur_link_an_mode),
1009 phy_modes(pl->link_config.interface));
1011 /* Always set the carrier off */
1013 netif_carrier_off(pl->netdev);
1015 /* Apply the link configuration to the MAC when starting. This allows
1016 * a fixed-link to start with the correct parameters, and also
1017 * ensures that we set the appropriate advertisement for Serdes links.
1019 phylink_mac_config(pl, &pl->link_config);
1021 /* Restart autonegotiation if using 802.3z to ensure that the link
1022 * parameters are properly negotiated. This is necessary for DSA
1023 * switches using 802.3z negotiation to ensure they see our modes.
1025 phylink_mac_an_restart(pl);
1027 clear_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
1028 phylink_run_resolve(pl);
1030 if (pl->cfg_link_an_mode == MLO_AN_FIXED && pl->link_gpio) {
1031 int irq = gpiod_to_irq(pl->link_gpio);
1034 if (!request_irq(irq, phylink_link_handler,
1035 IRQF_TRIGGER_RISING |
1036 IRQF_TRIGGER_FALLING,
1043 mod_timer(&pl->link_poll, jiffies + HZ);
1045 if ((pl->cfg_link_an_mode == MLO_AN_FIXED && pl->get_fixed_state) ||
1046 pl->config->pcs_poll)
1047 mod_timer(&pl->link_poll, jiffies + HZ);
1049 phy_start(pl->phydev);
1051 sfp_upstream_start(pl->sfp_bus);
1053 EXPORT_SYMBOL_GPL(phylink_start);
1056 * phylink_stop() - stop a phylink instance
1057 * @pl: a pointer to a &struct phylink returned from phylink_create()
1059 * Stop the phylink instance specified by @pl. This should be called from the
1060 * network device driver's &struct net_device_ops ndo_stop() method. The
1061 * network device's carrier state should not be changed prior to calling this
1064 void phylink_stop(struct phylink *pl)
1069 sfp_upstream_stop(pl->sfp_bus);
1071 phy_stop(pl->phydev);
1072 del_timer_sync(&pl->link_poll);
1074 free_irq(pl->link_irq, pl);
1078 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_STOPPED);
1080 EXPORT_SYMBOL_GPL(phylink_stop);
1083 * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
1084 * @pl: a pointer to a &struct phylink returned from phylink_create()
1085 * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
1087 * Read the wake on lan parameters from the PHY attached to the phylink
1088 * instance specified by @pl. If no PHY is currently attached, report no
1089 * support for wake on lan.
1091 void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1099 phy_ethtool_get_wol(pl->phydev, wol);
1101 EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
1104 * phylink_ethtool_set_wol() - set wake on lan parameters
1105 * @pl: a pointer to a &struct phylink returned from phylink_create()
1106 * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
1108 * Set the wake on lan parameters for the PHY attached to the phylink
1109 * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
1112 * Returns zero on success or negative errno code.
1114 int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1116 int ret = -EOPNOTSUPP;
1121 ret = phy_ethtool_set_wol(pl->phydev, wol);
1125 EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
1127 static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
1129 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
1131 linkmode_zero(mask);
1132 phylink_set_port_modes(mask);
1134 linkmode_and(dst, dst, mask);
1135 linkmode_or(dst, dst, b);
1138 static void phylink_get_ksettings(const struct phylink_link_state *state,
1139 struct ethtool_link_ksettings *kset)
1141 phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
1142 linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
1143 kset->base.speed = state->speed;
1144 kset->base.duplex = state->duplex;
1145 kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
1150 * phylink_ethtool_ksettings_get() - get the current link settings
1151 * @pl: a pointer to a &struct phylink returned from phylink_create()
1152 * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
1154 * Read the current link settings for the phylink instance specified by @pl.
1155 * This will be the link settings read from the MAC, PHY or fixed link
1156 * settings depending on the current negotiation mode.
1158 int phylink_ethtool_ksettings_get(struct phylink *pl,
1159 struct ethtool_link_ksettings *kset)
1161 struct phylink_link_state link_state;
1166 phy_ethtool_ksettings_get(pl->phydev, kset);
1168 kset->base.port = pl->link_port;
1171 linkmode_copy(kset->link_modes.supported, pl->supported);
1173 switch (pl->cur_link_an_mode) {
1175 /* We are using fixed settings. Report these as the
1176 * current link settings - and note that these also
1177 * represent the supported speeds/duplex/pause modes.
1179 phylink_get_fixed_state(pl, &link_state);
1180 phylink_get_ksettings(&link_state, kset);
1184 /* If there is a phy attached, then use the reported
1185 * settings from the phy with no modification.
1190 phylink_mac_pcs_get_state(pl, &link_state);
1192 /* The MAC is reporting the link results from its own PCS
1193 * layer via in-band status. Report these as the current
1196 phylink_get_ksettings(&link_state, kset);
1202 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
1205 * phylink_ethtool_ksettings_set() - set the link settings
1206 * @pl: a pointer to a &struct phylink returned from phylink_create()
1207 * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
1209 int phylink_ethtool_ksettings_set(struct phylink *pl,
1210 const struct ethtool_link_ksettings *kset)
1212 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1213 struct ethtool_link_ksettings our_kset;
1214 struct phylink_link_state config;
1219 if (kset->base.autoneg != AUTONEG_DISABLE &&
1220 kset->base.autoneg != AUTONEG_ENABLE)
1223 linkmode_copy(support, pl->supported);
1224 config = pl->link_config;
1226 /* Mask out unsupported advertisements */
1227 linkmode_and(config.advertising, kset->link_modes.advertising,
1230 /* FIXME: should we reject autoneg if phy/mac does not support it? */
1231 if (kset->base.autoneg == AUTONEG_DISABLE) {
1232 const struct phy_setting *s;
1234 /* Autonegotiation disabled, select a suitable speed and
1237 s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
1242 /* If we have a fixed link (as specified by firmware), refuse
1243 * to change link parameters.
1245 if (pl->cur_link_an_mode == MLO_AN_FIXED &&
1246 (s->speed != pl->link_config.speed ||
1247 s->duplex != pl->link_config.duplex))
1250 config.speed = s->speed;
1251 config.duplex = s->duplex;
1252 config.an_enabled = false;
1254 __clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1256 /* If we have a fixed link, refuse to enable autonegotiation */
1257 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1260 config.speed = SPEED_UNKNOWN;
1261 config.duplex = DUPLEX_UNKNOWN;
1262 config.an_enabled = true;
1264 __set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1268 /* If we have a PHY, we process the kset change via phylib.
1269 * phylib will call our link state function if the PHY
1270 * parameters have changed, which will trigger a resolve
1271 * and update the MAC configuration.
1274 linkmode_copy(our_kset.link_modes.advertising,
1275 config.advertising);
1276 our_kset.base.speed = config.speed;
1277 our_kset.base.duplex = config.duplex;
1279 ret = phy_ethtool_ksettings_set(pl->phydev, &our_kset);
1283 mutex_lock(&pl->state_mutex);
1284 /* Save the new configuration */
1285 linkmode_copy(pl->link_config.advertising,
1286 our_kset.link_modes.advertising);
1287 pl->link_config.interface = config.interface;
1288 pl->link_config.speed = our_kset.base.speed;
1289 pl->link_config.duplex = our_kset.base.duplex;
1290 pl->link_config.an_enabled = our_kset.base.autoneg !=
1292 mutex_unlock(&pl->state_mutex);
1294 /* For a fixed link, this isn't able to change any parameters,
1295 * which just leaves inband mode.
1297 if (phylink_validate(pl, support, &config))
1300 /* If autonegotiation is enabled, we must have an advertisement */
1301 if (config.an_enabled &&
1302 phylink_is_empty_linkmode(config.advertising))
1305 mutex_lock(&pl->state_mutex);
1306 linkmode_copy(pl->link_config.advertising, config.advertising);
1307 pl->link_config.interface = config.interface;
1308 pl->link_config.speed = config.speed;
1309 pl->link_config.duplex = config.duplex;
1310 pl->link_config.an_enabled = kset->base.autoneg !=
1313 if (pl->cur_link_an_mode == MLO_AN_INBAND &&
1314 !test_bit(PHYLINK_DISABLE_STOPPED,
1315 &pl->phylink_disable_state)) {
1316 /* If in 802.3z mode, this updates the advertisement.
1318 * If we are in SGMII mode without a PHY, there is no
1319 * advertisement; the only thing we have is the pause
1320 * modes which can only come from a PHY.
1322 phylink_mac_config(pl, &pl->link_config);
1323 phylink_mac_an_restart(pl);
1325 mutex_unlock(&pl->state_mutex);
1330 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
1333 * phylink_ethtool_nway_reset() - restart negotiation
1334 * @pl: a pointer to a &struct phylink returned from phylink_create()
1336 * Restart negotiation for the phylink instance specified by @pl. This will
1337 * cause any attached phy to restart negotiation with the link partner, and
1338 * if the MAC is in a BaseX mode, the MAC will also be requested to restart
1341 * Returns zero on success, or negative error code.
1343 int phylink_ethtool_nway_reset(struct phylink *pl)
1350 ret = phy_restart_aneg(pl->phydev);
1351 phylink_mac_an_restart(pl);
1355 EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
1358 * phylink_ethtool_get_pauseparam() - get the current pause parameters
1359 * @pl: a pointer to a &struct phylink returned from phylink_create()
1360 * @pause: a pointer to a &struct ethtool_pauseparam
1362 void phylink_ethtool_get_pauseparam(struct phylink *pl,
1363 struct ethtool_pauseparam *pause)
1367 pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
1368 pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
1369 pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
1371 EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
1374 * phylink_ethtool_set_pauseparam() - set the current pause parameters
1375 * @pl: a pointer to a &struct phylink returned from phylink_create()
1376 * @pause: a pointer to a &struct ethtool_pauseparam
1378 int phylink_ethtool_set_pauseparam(struct phylink *pl,
1379 struct ethtool_pauseparam *pause)
1381 struct phylink_link_state *config = &pl->link_config;
1385 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1388 if (!phylink_test(pl->supported, Pause) &&
1389 !phylink_test(pl->supported, Asym_Pause))
1392 if (!phylink_test(pl->supported, Asym_Pause) &&
1393 !pause->autoneg && pause->rx_pause != pause->tx_pause)
1396 config->pause &= ~(MLO_PAUSE_AN | MLO_PAUSE_TXRX_MASK);
1399 config->pause |= MLO_PAUSE_AN;
1400 if (pause->rx_pause)
1401 config->pause |= MLO_PAUSE_RX;
1402 if (pause->tx_pause)
1403 config->pause |= MLO_PAUSE_TX;
1405 /* If we have a PHY, phylib will call our link state function if the
1406 * mode has changed, which will trigger a resolve and update the MAC
1410 phy_set_asym_pause(pl->phydev, pause->rx_pause,
1412 } else if (!test_bit(PHYLINK_DISABLE_STOPPED,
1413 &pl->phylink_disable_state)) {
1414 phylink_mac_config(pl, &pl->link_config);
1415 phylink_mac_an_restart(pl);
1420 EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
1423 * phylink_ethtool_get_eee_err() - read the energy efficient ethernet error
1425 * @pl: a pointer to a &struct phylink returned from phylink_create().
1427 * Read the Energy Efficient Ethernet error counter from the PHY associated
1428 * with the phylink instance specified by @pl.
1430 * Returns positive error counter value, or negative error code.
1432 int phylink_get_eee_err(struct phylink *pl)
1439 ret = phy_get_eee_err(pl->phydev);
1443 EXPORT_SYMBOL_GPL(phylink_get_eee_err);
1446 * phylink_init_eee() - init and check the EEE features
1447 * @pl: a pointer to a &struct phylink returned from phylink_create()
1448 * @clk_stop_enable: allow PHY to stop receive clock
1450 * Must be called either with RTNL held or within mac_link_up()
1452 int phylink_init_eee(struct phylink *pl, bool clk_stop_enable)
1454 int ret = -EOPNOTSUPP;
1457 ret = phy_init_eee(pl->phydev, clk_stop_enable);
1461 EXPORT_SYMBOL_GPL(phylink_init_eee);
1464 * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
1465 * @pl: a pointer to a &struct phylink returned from phylink_create()
1466 * @eee: a pointer to a &struct ethtool_eee for the read parameters
1468 int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
1470 int ret = -EOPNOTSUPP;
1475 ret = phy_ethtool_get_eee(pl->phydev, eee);
1479 EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
1482 * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
1483 * @pl: a pointer to a &struct phylink returned from phylink_create()
1484 * @eee: a pointer to a &struct ethtool_eee for the desired parameters
1486 int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
1488 int ret = -EOPNOTSUPP;
1493 ret = phy_ethtool_set_eee(pl->phydev, eee);
1497 EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
1499 /* This emulates MII registers for a fixed-mode phy operating as per the
1500 * passed in state. "aneg" defines if we report negotiation is possible.
1502 * FIXME: should deal with negotiation state too.
1504 static int phylink_mii_emul_read(unsigned int reg,
1505 struct phylink_link_state *state)
1507 struct fixed_phy_status fs;
1510 fs.link = state->link;
1511 fs.speed = state->speed;
1512 fs.duplex = state->duplex;
1513 fs.pause = state->pause & MLO_PAUSE_SYM;
1514 fs.asym_pause = state->pause & MLO_PAUSE_ASYM;
1516 val = swphy_read_reg(reg, &fs);
1517 if (reg == MII_BMSR) {
1518 if (!state->an_complete)
1519 val &= ~BMSR_ANEGCOMPLETE;
1524 static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
1527 struct phy_device *phydev = pl->phydev;
1530 if (mdio_phy_id_is_c45(phy_id)) {
1531 prtad = mdio_phy_id_prtad(phy_id);
1532 devad = mdio_phy_id_devad(phy_id);
1533 devad = MII_ADDR_C45 | devad << 16 | reg;
1534 } else if (phydev->is_c45) {
1540 devad = __ffs(phydev->c45_ids.devices_in_package);
1544 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1546 devad = MDIO_MMD_AN;
1547 if (reg == MII_ADVERTISE)
1548 reg = MDIO_AN_ADVERTISE;
1556 devad = MII_ADDR_C45 | devad << 16 | reg;
1561 return mdiobus_read(pl->phydev->mdio.bus, prtad, devad);
1564 static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
1565 unsigned int reg, unsigned int val)
1567 struct phy_device *phydev = pl->phydev;
1570 if (mdio_phy_id_is_c45(phy_id)) {
1571 prtad = mdio_phy_id_prtad(phy_id);
1572 devad = mdio_phy_id_devad(phy_id);
1573 devad = MII_ADDR_C45 | devad << 16 | reg;
1574 } else if (phydev->is_c45) {
1580 devad = __ffs(phydev->c45_ids.devices_in_package);
1584 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1586 devad = MDIO_MMD_AN;
1587 if (reg == MII_ADVERTISE)
1588 reg = MDIO_AN_ADVERTISE;
1596 devad = MII_ADDR_C45 | devad << 16 | reg;
1602 return mdiobus_write(phydev->mdio.bus, prtad, devad, val);
1605 static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
1608 struct phylink_link_state state;
1611 switch (pl->cur_link_an_mode) {
1614 phylink_get_fixed_state(pl, &state);
1615 val = phylink_mii_emul_read(reg, &state);
1624 phylink_mac_pcs_get_state(pl, &state);
1625 val = phylink_mii_emul_read(reg, &state);
1630 return val & 0xffff;
1633 static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
1634 unsigned int reg, unsigned int val)
1636 switch (pl->cur_link_an_mode) {
1651 * phylink_mii_ioctl() - generic mii ioctl interface
1652 * @pl: a pointer to a &struct phylink returned from phylink_create()
1653 * @ifr: a pointer to a &struct ifreq for socket ioctls
1654 * @cmd: ioctl cmd to execute
1656 * Perform the specified MII ioctl on the PHY attached to the phylink instance
1657 * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
1659 * Returns: zero on success or negative error code.
1662 * read register from the current PHY.
1664 * read register from the specified PHY.
1666 * set a register on the specified PHY.
1668 int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
1670 struct mii_ioctl_data *mii = if_mii(ifr);
1676 /* PHYs only exist for MLO_AN_PHY and SGMII */
1679 mii->phy_id = pl->phydev->mdio.addr;
1683 ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
1691 ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
1696 ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
1706 ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
1714 ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
1726 EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
1728 static void phylink_sfp_attach(void *upstream, struct sfp_bus *bus)
1730 struct phylink *pl = upstream;
1732 pl->netdev->sfp_bus = bus;
1735 static void phylink_sfp_detach(void *upstream, struct sfp_bus *bus)
1737 struct phylink *pl = upstream;
1739 pl->netdev->sfp_bus = NULL;
1742 static int phylink_sfp_config(struct phylink *pl, u8 mode,
1743 const unsigned long *supported,
1744 const unsigned long *advertising)
1746 __ETHTOOL_DECLARE_LINK_MODE_MASK(support1);
1747 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1748 struct phylink_link_state config;
1749 phy_interface_t iface;
1753 linkmode_copy(support, supported);
1755 memset(&config, 0, sizeof(config));
1756 linkmode_copy(config.advertising, advertising);
1757 config.interface = PHY_INTERFACE_MODE_NA;
1758 config.speed = SPEED_UNKNOWN;
1759 config.duplex = DUPLEX_UNKNOWN;
1760 config.pause = MLO_PAUSE_AN;
1761 config.an_enabled = pl->link_config.an_enabled;
1763 /* Ignore errors if we're expecting a PHY to attach later */
1764 ret = phylink_validate(pl, support, &config);
1766 phylink_err(pl, "validation with support %*pb failed: %d\n",
1767 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1771 iface = sfp_select_interface(pl->sfp_bus, config.advertising);
1772 if (iface == PHY_INTERFACE_MODE_NA) {
1774 "selection of interface failed, advertisement %*pb\n",
1775 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
1779 config.interface = iface;
1780 linkmode_copy(support1, support);
1781 ret = phylink_validate(pl, support1, &config);
1783 phylink_err(pl, "validation of %s/%s with support %*pb failed: %d\n",
1784 phylink_an_mode_str(mode),
1785 phy_modes(config.interface),
1786 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1790 phylink_dbg(pl, "requesting link mode %s/%s with support %*pb\n",
1791 phylink_an_mode_str(mode), phy_modes(config.interface),
1792 __ETHTOOL_LINK_MODE_MASK_NBITS, support);
1794 if (phy_interface_mode_is_8023z(iface) && pl->phydev)
1797 changed = !linkmode_equal(pl->supported, support);
1799 linkmode_copy(pl->supported, support);
1800 linkmode_copy(pl->link_config.advertising, config.advertising);
1803 if (pl->cur_link_an_mode != mode ||
1804 pl->link_config.interface != config.interface) {
1805 pl->link_config.interface = config.interface;
1806 pl->cur_link_an_mode = mode;
1810 phylink_info(pl, "switched to %s/%s link mode\n",
1811 phylink_an_mode_str(mode),
1812 phy_modes(config.interface));
1815 pl->link_port = pl->sfp_port;
1817 if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
1818 &pl->phylink_disable_state))
1819 phylink_mac_config(pl, &pl->link_config);
1824 static int phylink_sfp_module_insert(void *upstream,
1825 const struct sfp_eeprom_id *id)
1827 struct phylink *pl = upstream;
1828 unsigned long *support = pl->sfp_support;
1832 linkmode_zero(support);
1833 sfp_parse_support(pl->sfp_bus, id, support);
1834 pl->sfp_port = sfp_parse_port(pl->sfp_bus, id, support);
1836 /* If this module may have a PHY connecting later, defer until later */
1837 pl->sfp_may_have_phy = sfp_may_have_phy(pl->sfp_bus, id);
1838 if (pl->sfp_may_have_phy)
1841 return phylink_sfp_config(pl, MLO_AN_INBAND, support, support);
1844 static int phylink_sfp_module_start(void *upstream)
1846 struct phylink *pl = upstream;
1848 /* If this SFP module has a PHY, start the PHY now. */
1850 phy_start(pl->phydev);
1854 /* If the module may have a PHY but we didn't detect one we
1855 * need to configure the MAC here.
1857 if (!pl->sfp_may_have_phy)
1860 return phylink_sfp_config(pl, MLO_AN_INBAND,
1861 pl->sfp_support, pl->sfp_support);
1864 static void phylink_sfp_module_stop(void *upstream)
1866 struct phylink *pl = upstream;
1868 /* If this SFP module has a PHY, stop it. */
1870 phy_stop(pl->phydev);
1873 static void phylink_sfp_link_down(void *upstream)
1875 struct phylink *pl = upstream;
1879 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_LINK);
1882 static void phylink_sfp_link_up(void *upstream)
1884 struct phylink *pl = upstream;
1888 clear_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
1889 phylink_run_resolve(pl);
1892 /* The Broadcom BCM84881 in the Methode DM7052 is unable to provide a SGMII
1893 * or 802.3z control word, so inband will not work.
1895 static bool phylink_phy_no_inband(struct phy_device *phy)
1897 return phy->is_c45 &&
1898 (phy->c45_ids.device_ids[1] & 0xfffffff0) == 0xae025150;
1901 static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
1903 struct phylink *pl = upstream;
1904 phy_interface_t interface;
1909 * This is the new way of dealing with flow control for PHYs,
1910 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
1911 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
1912 * using our validate call to the MAC, we rely upon the MAC
1913 * clearing the bits from both supported and advertising fields.
1915 phy_support_asym_pause(phy);
1917 if (phylink_phy_no_inband(phy))
1920 mode = MLO_AN_INBAND;
1922 /* Do the initial configuration */
1923 ret = phylink_sfp_config(pl, mode, phy->supported, phy->advertising);
1927 interface = pl->link_config.interface;
1928 ret = phylink_attach_phy(pl, phy, interface);
1932 ret = phylink_bringup_phy(pl, phy, interface);
1939 static void phylink_sfp_disconnect_phy(void *upstream)
1941 phylink_disconnect_phy(upstream);
1944 static const struct sfp_upstream_ops sfp_phylink_ops = {
1945 .attach = phylink_sfp_attach,
1946 .detach = phylink_sfp_detach,
1947 .module_insert = phylink_sfp_module_insert,
1948 .module_start = phylink_sfp_module_start,
1949 .module_stop = phylink_sfp_module_stop,
1950 .link_up = phylink_sfp_link_up,
1951 .link_down = phylink_sfp_link_down,
1952 .connect_phy = phylink_sfp_connect_phy,
1953 .disconnect_phy = phylink_sfp_disconnect_phy,
1956 /* Helpers for MAC drivers */
1959 * phylink_helper_basex_speed() - 1000BaseX/2500BaseX helper
1960 * @state: a pointer to a &struct phylink_link_state
1962 * Inspect the interface mode, advertising mask or forced speed and
1963 * decide whether to run at 2.5Gbit or 1Gbit appropriately, switching
1964 * the interface mode to suit. @state->interface is appropriately
1965 * updated, and the advertising mask has the "other" baseX_Full flag
1968 void phylink_helper_basex_speed(struct phylink_link_state *state)
1970 if (phy_interface_mode_is_8023z(state->interface)) {
1971 bool want_2500 = state->an_enabled ?
1972 phylink_test(state->advertising, 2500baseX_Full) :
1973 state->speed == SPEED_2500;
1976 phylink_clear(state->advertising, 1000baseX_Full);
1977 state->interface = PHY_INTERFACE_MODE_2500BASEX;
1979 phylink_clear(state->advertising, 2500baseX_Full);
1980 state->interface = PHY_INTERFACE_MODE_1000BASEX;
1984 EXPORT_SYMBOL_GPL(phylink_helper_basex_speed);
1986 MODULE_LICENSE("GPL v2");