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 *mac_ops;
44 const struct phylink_pcs_ops *pcs_ops;
45 struct phylink_config *config;
47 unsigned int old_link_state:1;
49 unsigned long phylink_disable_state; /* bitmask of disables */
50 struct phy_device *phydev;
51 phy_interface_t link_interface; /* PHY_INTERFACE_xxx */
52 u8 cfg_link_an_mode; /* MLO_AN_xxx */
54 u8 link_port; /* The current non-phy ethtool port */
55 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
57 /* The link configuration settings */
58 struct phylink_link_state link_config;
60 /* The current settings */
61 phy_interface_t cur_interface;
63 struct gpio_desc *link_gpio;
64 unsigned int link_irq;
65 struct timer_list link_poll;
66 void (*get_fixed_state)(struct net_device *dev,
67 struct phylink_link_state *s);
69 struct mutex state_mutex;
70 struct phylink_link_state phy_state;
71 struct work_struct resolve;
73 bool mac_link_dropped;
75 struct sfp_bus *sfp_bus;
76 bool sfp_may_have_phy;
77 __ETHTOOL_DECLARE_LINK_MODE_MASK(sfp_support);
81 #define phylink_printk(level, pl, fmt, ...) \
83 if ((pl)->config->type == PHYLINK_NETDEV) \
84 netdev_printk(level, (pl)->netdev, fmt, ##__VA_ARGS__); \
85 else if ((pl)->config->type == PHYLINK_DEV) \
86 dev_printk(level, (pl)->dev, fmt, ##__VA_ARGS__); \
89 #define phylink_err(pl, fmt, ...) \
90 phylink_printk(KERN_ERR, pl, fmt, ##__VA_ARGS__)
91 #define phylink_warn(pl, fmt, ...) \
92 phylink_printk(KERN_WARNING, pl, fmt, ##__VA_ARGS__)
93 #define phylink_info(pl, fmt, ...) \
94 phylink_printk(KERN_INFO, pl, fmt, ##__VA_ARGS__)
95 #if defined(CONFIG_DYNAMIC_DEBUG)
96 #define phylink_dbg(pl, fmt, ...) \
98 if ((pl)->config->type == PHYLINK_NETDEV) \
99 netdev_dbg((pl)->netdev, fmt, ##__VA_ARGS__); \
100 else if ((pl)->config->type == PHYLINK_DEV) \
101 dev_dbg((pl)->dev, fmt, ##__VA_ARGS__); \
104 #define phylink_dbg(pl, fmt, ...) \
105 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__)
107 #define phylink_dbg(pl, fmt, ...) \
110 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__); \
115 * phylink_set_port_modes() - set the port type modes in the ethtool mask
116 * @mask: ethtool link mode mask
118 * Sets all the port type modes in the ethtool mask. MAC drivers should
119 * use this in their 'validate' callback.
121 void phylink_set_port_modes(unsigned long *mask)
123 phylink_set(mask, TP);
124 phylink_set(mask, AUI);
125 phylink_set(mask, MII);
126 phylink_set(mask, FIBRE);
127 phylink_set(mask, BNC);
128 phylink_set(mask, Backplane);
130 EXPORT_SYMBOL_GPL(phylink_set_port_modes);
132 static int phylink_is_empty_linkmode(const unsigned long *linkmode)
134 __ETHTOOL_DECLARE_LINK_MODE_MASK(tmp) = { 0, };
136 phylink_set_port_modes(tmp);
137 phylink_set(tmp, Autoneg);
138 phylink_set(tmp, Pause);
139 phylink_set(tmp, Asym_Pause);
141 return linkmode_subset(linkmode, tmp);
144 static const char *phylink_an_mode_str(unsigned int mode)
146 static const char *modestr[] = {
147 [MLO_AN_PHY] = "phy",
148 [MLO_AN_FIXED] = "fixed",
149 [MLO_AN_INBAND] = "inband",
152 return mode < ARRAY_SIZE(modestr) ? modestr[mode] : "unknown";
155 static int phylink_validate(struct phylink *pl, unsigned long *supported,
156 struct phylink_link_state *state)
158 pl->mac_ops->validate(pl->config, supported, state);
160 return phylink_is_empty_linkmode(supported) ? -EINVAL : 0;
163 static int phylink_parse_fixedlink(struct phylink *pl,
164 struct fwnode_handle *fwnode)
166 struct fwnode_handle *fixed_node;
167 const struct phy_setting *s;
168 struct gpio_desc *desc;
172 fixed_node = fwnode_get_named_child_node(fwnode, "fixed-link");
174 ret = fwnode_property_read_u32(fixed_node, "speed", &speed);
176 pl->link_config.speed = speed;
177 pl->link_config.duplex = DUPLEX_HALF;
179 if (fwnode_property_read_bool(fixed_node, "full-duplex"))
180 pl->link_config.duplex = DUPLEX_FULL;
182 /* We treat the "pause" and "asym-pause" terminology as
183 * defining the link partner's ability. */
184 if (fwnode_property_read_bool(fixed_node, "pause"))
185 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
186 pl->link_config.lp_advertising);
187 if (fwnode_property_read_bool(fixed_node, "asym-pause"))
188 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
189 pl->link_config.lp_advertising);
192 desc = fwnode_gpiod_get_index(fixed_node, "link", 0,
196 pl->link_gpio = desc;
197 else if (desc == ERR_PTR(-EPROBE_DEFER))
200 fwnode_handle_put(fixed_node);
207 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
209 if (ret != ARRAY_SIZE(prop)) {
210 phylink_err(pl, "broken fixed-link?\n");
214 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
215 prop, ARRAY_SIZE(prop));
217 pl->link_config.duplex = prop[1] ?
218 DUPLEX_FULL : DUPLEX_HALF;
219 pl->link_config.speed = prop[2];
221 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
222 pl->link_config.lp_advertising);
224 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
225 pl->link_config.lp_advertising);
229 if (pl->link_config.speed > SPEED_1000 &&
230 pl->link_config.duplex != DUPLEX_FULL)
231 phylink_warn(pl, "fixed link specifies half duplex for %dMbps link?\n",
232 pl->link_config.speed);
234 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
235 linkmode_copy(pl->link_config.advertising, pl->supported);
236 phylink_validate(pl, pl->supported, &pl->link_config);
238 s = phy_lookup_setting(pl->link_config.speed, pl->link_config.duplex,
239 pl->supported, true);
240 linkmode_zero(pl->supported);
241 phylink_set(pl->supported, MII);
242 phylink_set(pl->supported, Pause);
243 phylink_set(pl->supported, Asym_Pause);
245 __set_bit(s->bit, pl->supported);
247 phylink_warn(pl, "fixed link %s duplex %dMbps not recognised\n",
248 pl->link_config.duplex == DUPLEX_FULL ? "full" : "half",
249 pl->link_config.speed);
252 linkmode_and(pl->link_config.advertising, pl->link_config.advertising,
255 pl->link_config.link = 1;
256 pl->link_config.an_complete = 1;
261 static int phylink_parse_mode(struct phylink *pl, struct fwnode_handle *fwnode)
263 struct fwnode_handle *dn;
266 dn = fwnode_get_named_child_node(fwnode, "fixed-link");
267 if (dn || fwnode_property_present(fwnode, "fixed-link"))
268 pl->cfg_link_an_mode = MLO_AN_FIXED;
269 fwnode_handle_put(dn);
271 if (fwnode_property_read_string(fwnode, "managed", &managed) == 0 &&
272 strcmp(managed, "in-band-status") == 0) {
273 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
275 "can't use both fixed-link and in-band-status\n");
279 linkmode_zero(pl->supported);
280 phylink_set(pl->supported, MII);
281 phylink_set(pl->supported, Autoneg);
282 phylink_set(pl->supported, Asym_Pause);
283 phylink_set(pl->supported, Pause);
284 pl->link_config.an_enabled = true;
285 pl->cfg_link_an_mode = MLO_AN_INBAND;
287 switch (pl->link_config.interface) {
288 case PHY_INTERFACE_MODE_SGMII:
289 case PHY_INTERFACE_MODE_QSGMII:
290 phylink_set(pl->supported, 10baseT_Half);
291 phylink_set(pl->supported, 10baseT_Full);
292 phylink_set(pl->supported, 100baseT_Half);
293 phylink_set(pl->supported, 100baseT_Full);
294 phylink_set(pl->supported, 1000baseT_Half);
295 phylink_set(pl->supported, 1000baseT_Full);
298 case PHY_INTERFACE_MODE_1000BASEX:
299 phylink_set(pl->supported, 1000baseX_Full);
302 case PHY_INTERFACE_MODE_2500BASEX:
303 phylink_set(pl->supported, 2500baseX_Full);
306 case PHY_INTERFACE_MODE_USXGMII:
307 case PHY_INTERFACE_MODE_10GKR:
308 case PHY_INTERFACE_MODE_10GBASER:
309 phylink_set(pl->supported, 10baseT_Half);
310 phylink_set(pl->supported, 10baseT_Full);
311 phylink_set(pl->supported, 100baseT_Half);
312 phylink_set(pl->supported, 100baseT_Full);
313 phylink_set(pl->supported, 1000baseT_Half);
314 phylink_set(pl->supported, 1000baseT_Full);
315 phylink_set(pl->supported, 1000baseX_Full);
316 phylink_set(pl->supported, 1000baseKX_Full);
317 phylink_set(pl->supported, 2500baseT_Full);
318 phylink_set(pl->supported, 2500baseX_Full);
319 phylink_set(pl->supported, 5000baseT_Full);
320 phylink_set(pl->supported, 10000baseT_Full);
321 phylink_set(pl->supported, 10000baseKR_Full);
322 phylink_set(pl->supported, 10000baseKX4_Full);
323 phylink_set(pl->supported, 10000baseCR_Full);
324 phylink_set(pl->supported, 10000baseSR_Full);
325 phylink_set(pl->supported, 10000baseLR_Full);
326 phylink_set(pl->supported, 10000baseLRM_Full);
327 phylink_set(pl->supported, 10000baseER_Full);
330 case PHY_INTERFACE_MODE_XLGMII:
331 phylink_set(pl->supported, 25000baseCR_Full);
332 phylink_set(pl->supported, 25000baseKR_Full);
333 phylink_set(pl->supported, 25000baseSR_Full);
334 phylink_set(pl->supported, 40000baseKR4_Full);
335 phylink_set(pl->supported, 40000baseCR4_Full);
336 phylink_set(pl->supported, 40000baseSR4_Full);
337 phylink_set(pl->supported, 40000baseLR4_Full);
338 phylink_set(pl->supported, 50000baseCR2_Full);
339 phylink_set(pl->supported, 50000baseKR2_Full);
340 phylink_set(pl->supported, 50000baseSR2_Full);
341 phylink_set(pl->supported, 50000baseKR_Full);
342 phylink_set(pl->supported, 50000baseSR_Full);
343 phylink_set(pl->supported, 50000baseCR_Full);
344 phylink_set(pl->supported, 50000baseLR_ER_FR_Full);
345 phylink_set(pl->supported, 50000baseDR_Full);
346 phylink_set(pl->supported, 100000baseKR4_Full);
347 phylink_set(pl->supported, 100000baseSR4_Full);
348 phylink_set(pl->supported, 100000baseCR4_Full);
349 phylink_set(pl->supported, 100000baseLR4_ER4_Full);
350 phylink_set(pl->supported, 100000baseKR2_Full);
351 phylink_set(pl->supported, 100000baseSR2_Full);
352 phylink_set(pl->supported, 100000baseCR2_Full);
353 phylink_set(pl->supported, 100000baseLR2_ER2_FR2_Full);
354 phylink_set(pl->supported, 100000baseDR2_Full);
359 "incorrect link mode %s for in-band status\n",
360 phy_modes(pl->link_config.interface));
364 linkmode_copy(pl->link_config.advertising, pl->supported);
366 if (phylink_validate(pl, pl->supported, &pl->link_config)) {
368 "failed to validate link configuration for in-band status\n");
372 /* Check if MAC/PCS also supports Autoneg. */
373 pl->link_config.an_enabled = phylink_test(pl->supported, Autoneg);
379 static void phylink_apply_manual_flow(struct phylink *pl,
380 struct phylink_link_state *state)
382 /* If autoneg is disabled, pause AN is also disabled */
383 if (!state->an_enabled)
384 state->pause &= ~MLO_PAUSE_AN;
386 /* Manual configuration of pause modes */
387 if (!(pl->link_config.pause & MLO_PAUSE_AN))
388 state->pause = pl->link_config.pause;
391 static void phylink_resolve_flow(struct phylink_link_state *state)
393 bool tx_pause, rx_pause;
395 state->pause = MLO_PAUSE_NONE;
396 if (state->duplex == DUPLEX_FULL) {
397 linkmode_resolve_pause(state->advertising,
398 state->lp_advertising,
399 &tx_pause, &rx_pause);
401 state->pause |= MLO_PAUSE_TX;
403 state->pause |= MLO_PAUSE_RX;
407 static void phylink_mac_config(struct phylink *pl,
408 const struct phylink_link_state *state)
411 "%s: mode=%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
412 __func__, phylink_an_mode_str(pl->cur_link_an_mode),
413 phy_modes(state->interface),
414 phy_speed_to_str(state->speed),
415 phy_duplex_to_str(state->duplex),
416 __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
417 state->pause, state->link, state->an_enabled);
419 pl->mac_ops->mac_config(pl->config, pl->cur_link_an_mode, state);
422 static void phylink_mac_config_up(struct phylink *pl,
423 const struct phylink_link_state *state)
426 phylink_mac_config(pl, state);
429 static void phylink_mac_pcs_an_restart(struct phylink *pl)
431 if (pl->link_config.an_enabled &&
432 phy_interface_mode_is_8023z(pl->link_config.interface)) {
434 pl->pcs_ops->pcs_an_restart(pl->config);
436 pl->mac_ops->mac_an_restart(pl->config);
440 static void phylink_pcs_config(struct phylink *pl, bool force_restart,
441 const struct phylink_link_state *state)
443 bool restart = force_restart;
445 if (pl->pcs_ops && pl->pcs_ops->pcs_config(pl->config,
446 pl->cur_link_an_mode,
451 phylink_mac_config(pl, state);
454 phylink_mac_pcs_an_restart(pl);
457 static void phylink_mac_pcs_get_state(struct phylink *pl,
458 struct phylink_link_state *state)
460 linkmode_copy(state->advertising, pl->link_config.advertising);
461 linkmode_zero(state->lp_advertising);
462 state->interface = pl->link_config.interface;
463 state->an_enabled = pl->link_config.an_enabled;
464 state->speed = SPEED_UNKNOWN;
465 state->duplex = DUPLEX_UNKNOWN;
466 state->pause = MLO_PAUSE_NONE;
467 state->an_complete = 0;
471 pl->pcs_ops->pcs_get_state(pl->config, state);
473 pl->mac_ops->mac_pcs_get_state(pl->config, state);
476 /* The fixed state is... fixed except for the link state,
477 * which may be determined by a GPIO or a callback.
479 static void phylink_get_fixed_state(struct phylink *pl,
480 struct phylink_link_state *state)
482 *state = pl->link_config;
483 if (pl->config->get_fixed_state)
484 pl->config->get_fixed_state(pl->config, state);
485 else if (pl->link_gpio)
486 state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
488 phylink_resolve_flow(state);
491 static void phylink_mac_initial_config(struct phylink *pl, bool force_restart)
493 struct phylink_link_state link_state;
495 switch (pl->cur_link_an_mode) {
497 link_state = pl->phy_state;
501 phylink_get_fixed_state(pl, &link_state);
505 link_state = pl->link_config;
506 if (link_state.interface == PHY_INTERFACE_MODE_SGMII)
507 link_state.pause = MLO_PAUSE_NONE;
510 default: /* can't happen */
514 link_state.link = false;
516 phylink_apply_manual_flow(pl, &link_state);
517 phylink_pcs_config(pl, force_restart, &link_state);
520 static const char *phylink_pause_to_str(int pause)
522 switch (pause & MLO_PAUSE_TXRX_MASK) {
523 case MLO_PAUSE_TX | MLO_PAUSE_RX:
534 static void phylink_link_up(struct phylink *pl,
535 struct phylink_link_state link_state)
537 struct net_device *ndev = pl->netdev;
539 pl->cur_interface = link_state.interface;
541 if (pl->pcs_ops && pl->pcs_ops->pcs_link_up)
542 pl->pcs_ops->pcs_link_up(pl->config, pl->cur_link_an_mode,
544 link_state.speed, link_state.duplex);
546 pl->mac_ops->mac_link_up(pl->config, pl->phydev,
547 pl->cur_link_an_mode, pl->cur_interface,
548 link_state.speed, link_state.duplex,
549 !!(link_state.pause & MLO_PAUSE_TX),
550 !!(link_state.pause & MLO_PAUSE_RX));
553 netif_carrier_on(ndev);
556 "Link is Up - %s/%s - flow control %s\n",
557 phy_speed_to_str(link_state.speed),
558 phy_duplex_to_str(link_state.duplex),
559 phylink_pause_to_str(link_state.pause));
562 static void phylink_link_down(struct phylink *pl)
564 struct net_device *ndev = pl->netdev;
567 netif_carrier_off(ndev);
568 pl->mac_ops->mac_link_down(pl->config, pl->cur_link_an_mode,
570 phylink_info(pl, "Link is Down\n");
573 static void phylink_resolve(struct work_struct *w)
575 struct phylink *pl = container_of(w, struct phylink, resolve);
576 struct phylink_link_state link_state;
577 struct net_device *ndev = pl->netdev;
580 mutex_lock(&pl->state_mutex);
581 if (pl->phylink_disable_state) {
582 pl->mac_link_dropped = false;
583 link_state.link = false;
584 } else if (pl->mac_link_dropped) {
585 link_state.link = false;
587 switch (pl->cur_link_an_mode) {
589 link_state = pl->phy_state;
590 phylink_apply_manual_flow(pl, &link_state);
591 phylink_mac_config_up(pl, &link_state);
595 phylink_get_fixed_state(pl, &link_state);
596 phylink_mac_config_up(pl, &link_state);
600 phylink_mac_pcs_get_state(pl, &link_state);
602 /* If we have a phy, the "up" state is the union of
603 * both the PHY and the MAC */
605 link_state.link &= pl->phy_state.link;
607 /* Only update if the PHY link is up */
608 if (pl->phydev && pl->phy_state.link) {
609 link_state.interface = pl->phy_state.interface;
611 /* If we have a PHY, we need to update with
612 * the PHY flow control bits. */
613 link_state.pause = pl->phy_state.pause;
614 phylink_apply_manual_flow(pl, &link_state);
615 phylink_mac_config(pl, &link_state);
617 phylink_apply_manual_flow(pl, &link_state);
624 link_changed = (link_state.link != netif_carrier_ok(ndev));
626 link_changed = (link_state.link != pl->old_link_state);
629 pl->old_link_state = link_state.link;
630 if (!link_state.link)
631 phylink_link_down(pl);
633 phylink_link_up(pl, link_state);
635 if (!link_state.link && pl->mac_link_dropped) {
636 pl->mac_link_dropped = false;
637 queue_work(system_power_efficient_wq, &pl->resolve);
639 mutex_unlock(&pl->state_mutex);
642 static void phylink_run_resolve(struct phylink *pl)
644 if (!pl->phylink_disable_state)
645 queue_work(system_power_efficient_wq, &pl->resolve);
648 static void phylink_run_resolve_and_disable(struct phylink *pl, int bit)
650 unsigned long state = pl->phylink_disable_state;
652 set_bit(bit, &pl->phylink_disable_state);
654 queue_work(system_power_efficient_wq, &pl->resolve);
655 flush_work(&pl->resolve);
659 static void phylink_fixed_poll(struct timer_list *t)
661 struct phylink *pl = container_of(t, struct phylink, link_poll);
663 mod_timer(t, jiffies + HZ);
665 phylink_run_resolve(pl);
668 static const struct sfp_upstream_ops sfp_phylink_ops;
670 static int phylink_register_sfp(struct phylink *pl,
671 struct fwnode_handle *fwnode)
679 bus = sfp_bus_find_fwnode(fwnode);
682 phylink_err(pl, "unable to attach SFP bus: %d\n", ret);
688 ret = sfp_bus_add_upstream(bus, pl, &sfp_phylink_ops);
695 * phylink_create() - create a phylink instance
696 * @config: a pointer to the target &struct phylink_config
697 * @fwnode: a pointer to a &struct fwnode_handle describing the network
699 * @iface: the desired link mode defined by &typedef phy_interface_t
700 * @mac_ops: a pointer to a &struct phylink_mac_ops for the MAC.
702 * Create a new phylink instance, and parse the link parameters found in @np.
703 * This will parse in-band modes, fixed-link or SFP configuration.
705 * Note: the rtnl lock must not be held when calling this function.
707 * Returns a pointer to a &struct phylink, or an error-pointer value. Users
708 * must use IS_ERR() to check for errors from this function.
710 struct phylink *phylink_create(struct phylink_config *config,
711 struct fwnode_handle *fwnode,
712 phy_interface_t iface,
713 const struct phylink_mac_ops *mac_ops)
718 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
720 return ERR_PTR(-ENOMEM);
722 mutex_init(&pl->state_mutex);
723 INIT_WORK(&pl->resolve, phylink_resolve);
726 if (config->type == PHYLINK_NETDEV) {
727 pl->netdev = to_net_dev(config->dev);
728 } else if (config->type == PHYLINK_DEV) {
729 pl->dev = config->dev;
732 return ERR_PTR(-EINVAL);
735 pl->phy_state.interface = iface;
736 pl->link_interface = iface;
737 if (iface == PHY_INTERFACE_MODE_MOCA)
738 pl->link_port = PORT_BNC;
740 pl->link_port = PORT_MII;
741 pl->link_config.interface = iface;
742 pl->link_config.pause = MLO_PAUSE_AN;
743 pl->link_config.speed = SPEED_UNKNOWN;
744 pl->link_config.duplex = DUPLEX_UNKNOWN;
745 pl->link_config.an_enabled = true;
746 pl->mac_ops = mac_ops;
747 __set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
748 timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
750 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
751 linkmode_copy(pl->link_config.advertising, pl->supported);
752 phylink_validate(pl, pl->supported, &pl->link_config);
754 ret = phylink_parse_mode(pl, fwnode);
760 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
761 ret = phylink_parse_fixedlink(pl, fwnode);
768 pl->cur_link_an_mode = pl->cfg_link_an_mode;
770 ret = phylink_register_sfp(pl, fwnode);
778 EXPORT_SYMBOL_GPL(phylink_create);
780 void phylink_add_pcs(struct phylink *pl, const struct phylink_pcs_ops *ops)
784 EXPORT_SYMBOL_GPL(phylink_add_pcs);
787 * phylink_destroy() - cleanup and destroy the phylink instance
788 * @pl: a pointer to a &struct phylink returned from phylink_create()
790 * Destroy a phylink instance. Any PHY that has been attached must have been
791 * cleaned up via phylink_disconnect_phy() prior to calling this function.
793 * Note: the rtnl lock must not be held when calling this function.
795 void phylink_destroy(struct phylink *pl)
797 sfp_bus_del_upstream(pl->sfp_bus);
799 gpiod_put(pl->link_gpio);
801 cancel_work_sync(&pl->resolve);
804 EXPORT_SYMBOL_GPL(phylink_destroy);
806 static void phylink_phy_change(struct phy_device *phydev, bool up)
808 struct phylink *pl = phydev->phylink;
809 bool tx_pause, rx_pause;
811 phy_get_pause(phydev, &tx_pause, &rx_pause);
813 mutex_lock(&pl->state_mutex);
814 pl->phy_state.speed = phydev->speed;
815 pl->phy_state.duplex = phydev->duplex;
816 pl->phy_state.pause = MLO_PAUSE_NONE;
818 pl->phy_state.pause |= MLO_PAUSE_TX;
820 pl->phy_state.pause |= MLO_PAUSE_RX;
821 pl->phy_state.interface = phydev->interface;
822 pl->phy_state.link = up;
823 mutex_unlock(&pl->state_mutex);
825 phylink_run_resolve(pl);
827 phylink_dbg(pl, "phy link %s %s/%s/%s\n", up ? "up" : "down",
828 phy_modes(phydev->interface),
829 phy_speed_to_str(phydev->speed),
830 phy_duplex_to_str(phydev->duplex));
833 static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy,
834 phy_interface_t interface)
836 struct phylink_link_state config;
837 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
842 * This is the new way of dealing with flow control for PHYs,
843 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
844 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
845 * using our validate call to the MAC, we rely upon the MAC
846 * clearing the bits from both supported and advertising fields.
848 phy_support_asym_pause(phy);
850 memset(&config, 0, sizeof(config));
851 linkmode_copy(supported, phy->supported);
852 linkmode_copy(config.advertising, phy->advertising);
854 /* Clause 45 PHYs switch their Serdes lane between several different
855 * modes, normally 10GBASE-R, SGMII. Some use 2500BASE-X for 2.5G
856 * speeds. We really need to know which interface modes the PHY and
857 * MAC supports to properly work out which linkmodes can be supported.
860 interface != PHY_INTERFACE_MODE_RXAUI &&
861 interface != PHY_INTERFACE_MODE_XAUI &&
862 interface != PHY_INTERFACE_MODE_USXGMII)
863 config.interface = PHY_INTERFACE_MODE_NA;
865 config.interface = interface;
867 ret = phylink_validate(pl, supported, &config);
869 phylink_warn(pl, "validation of %s with support %*pb and advertisement %*pb failed: %d\n",
870 phy_modes(config.interface),
871 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->supported,
872 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising,
878 phy->phy_link_change = phylink_phy_change;
880 irq_str = phy_attached_info_irq(phy);
882 "PHY [%s] driver [%s] (irq=%s)\n",
883 dev_name(&phy->mdio.dev), phy->drv->name, irq_str);
886 mutex_lock(&phy->lock);
887 mutex_lock(&pl->state_mutex);
889 pl->phy_state.interface = interface;
890 pl->phy_state.pause = MLO_PAUSE_NONE;
891 pl->phy_state.speed = SPEED_UNKNOWN;
892 pl->phy_state.duplex = DUPLEX_UNKNOWN;
893 linkmode_copy(pl->supported, supported);
894 linkmode_copy(pl->link_config.advertising, config.advertising);
896 /* Restrict the phy advertisement according to the MAC support. */
897 linkmode_copy(phy->advertising, config.advertising);
898 mutex_unlock(&pl->state_mutex);
899 mutex_unlock(&phy->lock);
902 "phy: setting supported %*pb advertising %*pb\n",
903 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
904 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->advertising);
906 if (phy_interrupt_is_valid(phy))
907 phy_request_interrupt(phy);
912 static int phylink_attach_phy(struct phylink *pl, struct phy_device *phy,
913 phy_interface_t interface)
915 if (WARN_ON(pl->cfg_link_an_mode == MLO_AN_FIXED ||
916 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
917 phy_interface_mode_is_8023z(interface))))
923 return phy_attach_direct(pl->netdev, phy, 0, interface);
927 * phylink_connect_phy() - connect a PHY to the phylink instance
928 * @pl: a pointer to a &struct phylink returned from phylink_create()
929 * @phy: a pointer to a &struct phy_device.
931 * Connect @phy to the phylink instance specified by @pl by calling
932 * phy_attach_direct(). Configure the @phy according to the MAC driver's
933 * capabilities, start the PHYLIB state machine and enable any interrupts
934 * that the PHY supports.
936 * This updates the phylink's ethtool supported and advertising link mode
939 * Returns 0 on success or a negative errno.
941 int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
945 /* Use PHY device/driver interface */
946 if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
947 pl->link_interface = phy->interface;
948 pl->link_config.interface = pl->link_interface;
951 ret = phylink_attach_phy(pl, phy, pl->link_interface);
955 ret = phylink_bringup_phy(pl, phy, pl->link_config.interface);
961 EXPORT_SYMBOL_GPL(phylink_connect_phy);
964 * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
965 * @pl: a pointer to a &struct phylink returned from phylink_create()
966 * @dn: a pointer to a &struct device_node.
967 * @flags: PHY-specific flags to communicate to the PHY device driver
969 * Connect the phy specified in the device node @dn to the phylink instance
970 * specified by @pl. Actions specified in phylink_connect_phy() will be
973 * Returns 0 on success or a negative errno.
975 int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
978 struct device_node *phy_node;
979 struct phy_device *phy_dev;
982 /* Fixed links and 802.3z are handled without needing a PHY */
983 if (pl->cfg_link_an_mode == MLO_AN_FIXED ||
984 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
985 phy_interface_mode_is_8023z(pl->link_interface)))
988 phy_node = of_parse_phandle(dn, "phy-handle", 0);
990 phy_node = of_parse_phandle(dn, "phy", 0);
992 phy_node = of_parse_phandle(dn, "phy-device", 0);
995 if (pl->cfg_link_an_mode == MLO_AN_PHY)
1000 phy_dev = of_phy_find_device(phy_node);
1001 /* We're done with the phy_node handle */
1002 of_node_put(phy_node);
1006 ret = phy_attach_direct(pl->netdev, phy_dev, flags,
1007 pl->link_interface);
1011 ret = phylink_bringup_phy(pl, phy_dev, pl->link_config.interface);
1013 phy_detach(phy_dev);
1017 EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
1020 * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
1022 * @pl: a pointer to a &struct phylink returned from phylink_create()
1024 * Disconnect any current PHY from the phylink instance described by @pl.
1026 void phylink_disconnect_phy(struct phylink *pl)
1028 struct phy_device *phy;
1034 mutex_lock(&phy->lock);
1035 mutex_lock(&pl->state_mutex);
1037 mutex_unlock(&pl->state_mutex);
1038 mutex_unlock(&phy->lock);
1039 flush_work(&pl->resolve);
1041 phy_disconnect(phy);
1044 EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
1047 * phylink_mac_change() - notify phylink of a change in MAC state
1048 * @pl: a pointer to a &struct phylink returned from phylink_create()
1049 * @up: indicates whether the link is currently up.
1051 * The MAC driver should call this driver when the state of its link
1052 * changes (eg, link failure, new negotiation results, etc.)
1054 void phylink_mac_change(struct phylink *pl, bool up)
1057 pl->mac_link_dropped = true;
1058 phylink_run_resolve(pl);
1059 phylink_dbg(pl, "mac link %s\n", up ? "up" : "down");
1061 EXPORT_SYMBOL_GPL(phylink_mac_change);
1063 static irqreturn_t phylink_link_handler(int irq, void *data)
1065 struct phylink *pl = data;
1067 phylink_run_resolve(pl);
1073 * phylink_start() - start a phylink instance
1074 * @pl: a pointer to a &struct phylink returned from phylink_create()
1076 * Start the phylink instance specified by @pl, configuring the MAC for the
1077 * desired link mode(s) and negotiation style. This should be called from the
1078 * network device driver's &struct net_device_ops ndo_open() method.
1080 void phylink_start(struct phylink *pl)
1086 phylink_info(pl, "configuring for %s/%s link mode\n",
1087 phylink_an_mode_str(pl->cur_link_an_mode),
1088 phy_modes(pl->link_config.interface));
1090 /* Always set the carrier off */
1092 netif_carrier_off(pl->netdev);
1094 /* Apply the link configuration to the MAC when starting. This allows
1095 * a fixed-link to start with the correct parameters, and also
1096 * ensures that we set the appropriate advertisement for Serdes links.
1098 * Restart autonegotiation if using 802.3z to ensure that the link
1099 * parameters are properly negotiated. This is necessary for DSA
1100 * switches using 802.3z negotiation to ensure they see our modes.
1102 phylink_mac_initial_config(pl, true);
1104 clear_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
1105 phylink_run_resolve(pl);
1107 if (pl->cfg_link_an_mode == MLO_AN_FIXED && pl->link_gpio) {
1108 int irq = gpiod_to_irq(pl->link_gpio);
1111 if (!request_irq(irq, phylink_link_handler,
1112 IRQF_TRIGGER_RISING |
1113 IRQF_TRIGGER_FALLING,
1123 switch (pl->cfg_link_an_mode) {
1125 poll |= pl->config->poll_fixed_state;
1128 poll |= pl->config->pcs_poll;
1132 mod_timer(&pl->link_poll, jiffies + HZ);
1134 phy_start(pl->phydev);
1136 sfp_upstream_start(pl->sfp_bus);
1138 EXPORT_SYMBOL_GPL(phylink_start);
1141 * phylink_stop() - stop a phylink instance
1142 * @pl: a pointer to a &struct phylink returned from phylink_create()
1144 * Stop the phylink instance specified by @pl. This should be called from the
1145 * network device driver's &struct net_device_ops ndo_stop() method. The
1146 * network device's carrier state should not be changed prior to calling this
1149 void phylink_stop(struct phylink *pl)
1154 sfp_upstream_stop(pl->sfp_bus);
1156 phy_stop(pl->phydev);
1157 del_timer_sync(&pl->link_poll);
1159 free_irq(pl->link_irq, pl);
1163 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_STOPPED);
1165 EXPORT_SYMBOL_GPL(phylink_stop);
1168 * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
1169 * @pl: a pointer to a &struct phylink returned from phylink_create()
1170 * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
1172 * Read the wake on lan parameters from the PHY attached to the phylink
1173 * instance specified by @pl. If no PHY is currently attached, report no
1174 * support for wake on lan.
1176 void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1184 phy_ethtool_get_wol(pl->phydev, wol);
1186 EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
1189 * phylink_ethtool_set_wol() - set wake on lan parameters
1190 * @pl: a pointer to a &struct phylink returned from phylink_create()
1191 * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
1193 * Set the wake on lan parameters for the PHY attached to the phylink
1194 * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
1197 * Returns zero on success or negative errno code.
1199 int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1201 int ret = -EOPNOTSUPP;
1206 ret = phy_ethtool_set_wol(pl->phydev, wol);
1210 EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
1212 static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
1214 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
1216 linkmode_zero(mask);
1217 phylink_set_port_modes(mask);
1219 linkmode_and(dst, dst, mask);
1220 linkmode_or(dst, dst, b);
1223 static void phylink_get_ksettings(const struct phylink_link_state *state,
1224 struct ethtool_link_ksettings *kset)
1226 phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
1227 linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
1228 kset->base.speed = state->speed;
1229 kset->base.duplex = state->duplex;
1230 kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
1235 * phylink_ethtool_ksettings_get() - get the current link settings
1236 * @pl: a pointer to a &struct phylink returned from phylink_create()
1237 * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
1239 * Read the current link settings for the phylink instance specified by @pl.
1240 * This will be the link settings read from the MAC, PHY or fixed link
1241 * settings depending on the current negotiation mode.
1243 int phylink_ethtool_ksettings_get(struct phylink *pl,
1244 struct ethtool_link_ksettings *kset)
1246 struct phylink_link_state link_state;
1251 phy_ethtool_ksettings_get(pl->phydev, kset);
1253 kset->base.port = pl->link_port;
1256 linkmode_copy(kset->link_modes.supported, pl->supported);
1258 switch (pl->cur_link_an_mode) {
1260 /* We are using fixed settings. Report these as the
1261 * current link settings - and note that these also
1262 * represent the supported speeds/duplex/pause modes.
1264 phylink_get_fixed_state(pl, &link_state);
1265 phylink_get_ksettings(&link_state, kset);
1269 /* If there is a phy attached, then use the reported
1270 * settings from the phy with no modification.
1275 phylink_mac_pcs_get_state(pl, &link_state);
1277 /* The MAC is reporting the link results from its own PCS
1278 * layer via in-band status. Report these as the current
1281 phylink_get_ksettings(&link_state, kset);
1287 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
1290 * phylink_ethtool_ksettings_set() - set the link settings
1291 * @pl: a pointer to a &struct phylink returned from phylink_create()
1292 * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
1294 int phylink_ethtool_ksettings_set(struct phylink *pl,
1295 const struct ethtool_link_ksettings *kset)
1297 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1298 struct ethtool_link_ksettings our_kset;
1299 struct phylink_link_state config;
1304 if (kset->base.autoneg != AUTONEG_DISABLE &&
1305 kset->base.autoneg != AUTONEG_ENABLE)
1308 linkmode_copy(support, pl->supported);
1309 config = pl->link_config;
1311 /* Mask out unsupported advertisements */
1312 linkmode_and(config.advertising, kset->link_modes.advertising,
1315 /* FIXME: should we reject autoneg if phy/mac does not support it? */
1316 if (kset->base.autoneg == AUTONEG_DISABLE) {
1317 const struct phy_setting *s;
1319 /* Autonegotiation disabled, select a suitable speed and
1322 s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
1327 /* If we have a fixed link (as specified by firmware), refuse
1328 * to change link parameters.
1330 if (pl->cur_link_an_mode == MLO_AN_FIXED &&
1331 (s->speed != pl->link_config.speed ||
1332 s->duplex != pl->link_config.duplex))
1335 config.speed = s->speed;
1336 config.duplex = s->duplex;
1337 config.an_enabled = false;
1339 __clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1341 /* If we have a fixed link, refuse to enable autonegotiation */
1342 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1345 config.speed = SPEED_UNKNOWN;
1346 config.duplex = DUPLEX_UNKNOWN;
1347 config.an_enabled = true;
1349 __set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising);
1353 /* If we have a PHY, we process the kset change via phylib.
1354 * phylib will call our link state function if the PHY
1355 * parameters have changed, which will trigger a resolve
1356 * and update the MAC configuration.
1359 linkmode_copy(our_kset.link_modes.advertising,
1360 config.advertising);
1361 our_kset.base.speed = config.speed;
1362 our_kset.base.duplex = config.duplex;
1364 ret = phy_ethtool_ksettings_set(pl->phydev, &our_kset);
1368 mutex_lock(&pl->state_mutex);
1369 /* Save the new configuration */
1370 linkmode_copy(pl->link_config.advertising,
1371 our_kset.link_modes.advertising);
1372 pl->link_config.interface = config.interface;
1373 pl->link_config.speed = our_kset.base.speed;
1374 pl->link_config.duplex = our_kset.base.duplex;
1375 pl->link_config.an_enabled = our_kset.base.autoneg !=
1377 mutex_unlock(&pl->state_mutex);
1379 /* For a fixed link, this isn't able to change any parameters,
1380 * which just leaves inband mode.
1382 if (phylink_validate(pl, support, &config))
1385 /* If autonegotiation is enabled, we must have an advertisement */
1386 if (config.an_enabled &&
1387 phylink_is_empty_linkmode(config.advertising))
1390 mutex_lock(&pl->state_mutex);
1391 linkmode_copy(pl->link_config.advertising, config.advertising);
1392 pl->link_config.interface = config.interface;
1393 pl->link_config.speed = config.speed;
1394 pl->link_config.duplex = config.duplex;
1395 pl->link_config.an_enabled = kset->base.autoneg !=
1398 if (pl->cur_link_an_mode == MLO_AN_INBAND &&
1399 !test_bit(PHYLINK_DISABLE_STOPPED,
1400 &pl->phylink_disable_state)) {
1401 /* If in 802.3z mode, this updates the advertisement.
1403 * If we are in SGMII mode without a PHY, there is no
1404 * advertisement; the only thing we have is the pause
1405 * modes which can only come from a PHY.
1407 phylink_pcs_config(pl, true, &pl->link_config);
1409 mutex_unlock(&pl->state_mutex);
1414 EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
1417 * phylink_ethtool_nway_reset() - restart negotiation
1418 * @pl: a pointer to a &struct phylink returned from phylink_create()
1420 * Restart negotiation for the phylink instance specified by @pl. This will
1421 * cause any attached phy to restart negotiation with the link partner, and
1422 * if the MAC is in a BaseX mode, the MAC will also be requested to restart
1425 * Returns zero on success, or negative error code.
1427 int phylink_ethtool_nway_reset(struct phylink *pl)
1434 ret = phy_restart_aneg(pl->phydev);
1435 phylink_mac_pcs_an_restart(pl);
1439 EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
1442 * phylink_ethtool_get_pauseparam() - get the current pause parameters
1443 * @pl: a pointer to a &struct phylink returned from phylink_create()
1444 * @pause: a pointer to a &struct ethtool_pauseparam
1446 void phylink_ethtool_get_pauseparam(struct phylink *pl,
1447 struct ethtool_pauseparam *pause)
1451 pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
1452 pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
1453 pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
1455 EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
1458 * phylink_ethtool_set_pauseparam() - set the current pause parameters
1459 * @pl: a pointer to a &struct phylink returned from phylink_create()
1460 * @pause: a pointer to a &struct ethtool_pauseparam
1462 int phylink_ethtool_set_pauseparam(struct phylink *pl,
1463 struct ethtool_pauseparam *pause)
1465 struct phylink_link_state *config = &pl->link_config;
1466 bool manual_changed;
1471 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1474 if (!phylink_test(pl->supported, Pause) &&
1475 !phylink_test(pl->supported, Asym_Pause))
1478 if (!phylink_test(pl->supported, Asym_Pause) &&
1479 !pause->autoneg && pause->rx_pause != pause->tx_pause)
1484 pause_state |= MLO_PAUSE_AN;
1485 if (pause->rx_pause)
1486 pause_state |= MLO_PAUSE_RX;
1487 if (pause->tx_pause)
1488 pause_state |= MLO_PAUSE_TX;
1490 mutex_lock(&pl->state_mutex);
1492 * See the comments for linkmode_set_pause(), wrt the deficiencies
1493 * with the current implementation. A solution to this issue would
1495 * ethtool Local device
1496 * rx tx Pause AsymDir
1501 * and then use the ethtool rx/tx enablement status to mask the
1502 * rx/tx pause resolution.
1504 linkmode_set_pause(config->advertising, pause->tx_pause,
1507 manual_changed = (config->pause ^ pause_state) & MLO_PAUSE_AN ||
1508 (!(pause_state & MLO_PAUSE_AN) &&
1509 (config->pause ^ pause_state) & MLO_PAUSE_TXRX_MASK);
1511 config->pause = pause_state;
1513 if (!pl->phydev && !test_bit(PHYLINK_DISABLE_STOPPED,
1514 &pl->phylink_disable_state))
1515 phylink_pcs_config(pl, true, &pl->link_config);
1517 mutex_unlock(&pl->state_mutex);
1519 /* If we have a PHY, a change of the pause frame advertisement will
1520 * cause phylib to renegotiate (if AN is enabled) which will in turn
1521 * call our phylink_phy_change() and trigger a resolve. Note that
1522 * we can't hold our state mutex while calling phy_set_asym_pause().
1525 phy_set_asym_pause(pl->phydev, pause->rx_pause,
1528 /* If the manual pause settings changed, make sure we trigger a
1529 * resolve to update their state; we can not guarantee that the
1532 if (manual_changed) {
1533 pl->mac_link_dropped = true;
1534 phylink_run_resolve(pl);
1539 EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
1542 * phylink_ethtool_get_eee_err() - read the energy efficient ethernet error
1544 * @pl: a pointer to a &struct phylink returned from phylink_create().
1546 * Read the Energy Efficient Ethernet error counter from the PHY associated
1547 * with the phylink instance specified by @pl.
1549 * Returns positive error counter value, or negative error code.
1551 int phylink_get_eee_err(struct phylink *pl)
1558 ret = phy_get_eee_err(pl->phydev);
1562 EXPORT_SYMBOL_GPL(phylink_get_eee_err);
1565 * phylink_init_eee() - init and check the EEE features
1566 * @pl: a pointer to a &struct phylink returned from phylink_create()
1567 * @clk_stop_enable: allow PHY to stop receive clock
1569 * Must be called either with RTNL held or within mac_link_up()
1571 int phylink_init_eee(struct phylink *pl, bool clk_stop_enable)
1573 int ret = -EOPNOTSUPP;
1576 ret = phy_init_eee(pl->phydev, clk_stop_enable);
1580 EXPORT_SYMBOL_GPL(phylink_init_eee);
1583 * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
1584 * @pl: a pointer to a &struct phylink returned from phylink_create()
1585 * @eee: a pointer to a &struct ethtool_eee for the read parameters
1587 int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
1589 int ret = -EOPNOTSUPP;
1594 ret = phy_ethtool_get_eee(pl->phydev, eee);
1598 EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
1601 * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
1602 * @pl: a pointer to a &struct phylink returned from phylink_create()
1603 * @eee: a pointer to a &struct ethtool_eee for the desired parameters
1605 int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
1607 int ret = -EOPNOTSUPP;
1612 ret = phy_ethtool_set_eee(pl->phydev, eee);
1616 EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
1618 /* This emulates MII registers for a fixed-mode phy operating as per the
1619 * passed in state. "aneg" defines if we report negotiation is possible.
1621 * FIXME: should deal with negotiation state too.
1623 static int phylink_mii_emul_read(unsigned int reg,
1624 struct phylink_link_state *state)
1626 struct fixed_phy_status fs;
1627 unsigned long *lpa = state->lp_advertising;
1630 fs.link = state->link;
1631 fs.speed = state->speed;
1632 fs.duplex = state->duplex;
1633 fs.pause = test_bit(ETHTOOL_LINK_MODE_Pause_BIT, lpa);
1634 fs.asym_pause = test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, lpa);
1636 val = swphy_read_reg(reg, &fs);
1637 if (reg == MII_BMSR) {
1638 if (!state->an_complete)
1639 val &= ~BMSR_ANEGCOMPLETE;
1644 static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
1647 struct phy_device *phydev = pl->phydev;
1650 if (mdio_phy_id_is_c45(phy_id)) {
1651 prtad = mdio_phy_id_prtad(phy_id);
1652 devad = mdio_phy_id_devad(phy_id);
1653 devad = mdiobus_c45_addr(devad, reg);
1654 } else if (phydev->is_c45) {
1660 devad = __ffs(phydev->c45_ids.devices_in_package);
1664 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1666 devad = MDIO_MMD_AN;
1667 if (reg == MII_ADVERTISE)
1668 reg = MDIO_AN_ADVERTISE;
1676 devad = mdiobus_c45_addr(devad, reg);
1681 return mdiobus_read(pl->phydev->mdio.bus, prtad, devad);
1684 static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
1685 unsigned int reg, unsigned int val)
1687 struct phy_device *phydev = pl->phydev;
1690 if (mdio_phy_id_is_c45(phy_id)) {
1691 prtad = mdio_phy_id_prtad(phy_id);
1692 devad = mdio_phy_id_devad(phy_id);
1693 devad = mdiobus_c45_addr(devad, reg);
1694 } else if (phydev->is_c45) {
1700 devad = __ffs(phydev->c45_ids.devices_in_package);
1704 if (!(phydev->c45_ids.devices_in_package & MDIO_DEVS_AN))
1706 devad = MDIO_MMD_AN;
1707 if (reg == MII_ADVERTISE)
1708 reg = MDIO_AN_ADVERTISE;
1716 devad = mdiobus_c45_addr(devad, reg);
1722 return mdiobus_write(phydev->mdio.bus, prtad, devad, val);
1725 static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
1728 struct phylink_link_state state;
1731 switch (pl->cur_link_an_mode) {
1734 phylink_get_fixed_state(pl, &state);
1735 val = phylink_mii_emul_read(reg, &state);
1744 phylink_mac_pcs_get_state(pl, &state);
1745 val = phylink_mii_emul_read(reg, &state);
1750 return val & 0xffff;
1753 static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
1754 unsigned int reg, unsigned int val)
1756 switch (pl->cur_link_an_mode) {
1771 * phylink_mii_ioctl() - generic mii ioctl interface
1772 * @pl: a pointer to a &struct phylink returned from phylink_create()
1773 * @ifr: a pointer to a &struct ifreq for socket ioctls
1774 * @cmd: ioctl cmd to execute
1776 * Perform the specified MII ioctl on the PHY attached to the phylink instance
1777 * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
1779 * Returns: zero on success or negative error code.
1782 * read register from the current PHY.
1784 * read register from the specified PHY.
1786 * set a register on the specified PHY.
1788 int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
1790 struct mii_ioctl_data *mii = if_mii(ifr);
1796 /* PHYs only exist for MLO_AN_PHY and SGMII */
1799 mii->phy_id = pl->phydev->mdio.addr;
1803 ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
1811 ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
1816 ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
1826 ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
1834 ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
1846 EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
1848 static void phylink_sfp_attach(void *upstream, struct sfp_bus *bus)
1850 struct phylink *pl = upstream;
1852 pl->netdev->sfp_bus = bus;
1855 static void phylink_sfp_detach(void *upstream, struct sfp_bus *bus)
1857 struct phylink *pl = upstream;
1859 pl->netdev->sfp_bus = NULL;
1862 static int phylink_sfp_config(struct phylink *pl, u8 mode,
1863 const unsigned long *supported,
1864 const unsigned long *advertising)
1866 __ETHTOOL_DECLARE_LINK_MODE_MASK(support1);
1867 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1868 struct phylink_link_state config;
1869 phy_interface_t iface;
1873 linkmode_copy(support, supported);
1875 memset(&config, 0, sizeof(config));
1876 linkmode_copy(config.advertising, advertising);
1877 config.interface = PHY_INTERFACE_MODE_NA;
1878 config.speed = SPEED_UNKNOWN;
1879 config.duplex = DUPLEX_UNKNOWN;
1880 config.pause = MLO_PAUSE_AN;
1881 config.an_enabled = pl->link_config.an_enabled;
1883 /* Ignore errors if we're expecting a PHY to attach later */
1884 ret = phylink_validate(pl, support, &config);
1886 phylink_err(pl, "validation with support %*pb failed: %d\n",
1887 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1891 iface = sfp_select_interface(pl->sfp_bus, config.advertising);
1892 if (iface == PHY_INTERFACE_MODE_NA) {
1894 "selection of interface failed, advertisement %*pb\n",
1895 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
1899 config.interface = iface;
1900 linkmode_copy(support1, support);
1901 ret = phylink_validate(pl, support1, &config);
1903 phylink_err(pl, "validation of %s/%s with support %*pb failed: %d\n",
1904 phylink_an_mode_str(mode),
1905 phy_modes(config.interface),
1906 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
1910 phylink_dbg(pl, "requesting link mode %s/%s with support %*pb\n",
1911 phylink_an_mode_str(mode), phy_modes(config.interface),
1912 __ETHTOOL_LINK_MODE_MASK_NBITS, support);
1914 if (phy_interface_mode_is_8023z(iface) && pl->phydev)
1917 changed = !linkmode_equal(pl->supported, support);
1919 linkmode_copy(pl->supported, support);
1920 linkmode_copy(pl->link_config.advertising, config.advertising);
1923 if (pl->cur_link_an_mode != mode ||
1924 pl->link_config.interface != config.interface) {
1925 pl->link_config.interface = config.interface;
1926 pl->cur_link_an_mode = mode;
1930 phylink_info(pl, "switched to %s/%s link mode\n",
1931 phylink_an_mode_str(mode),
1932 phy_modes(config.interface));
1935 pl->link_port = pl->sfp_port;
1937 if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
1938 &pl->phylink_disable_state))
1939 phylink_mac_initial_config(pl, false);
1944 static int phylink_sfp_module_insert(void *upstream,
1945 const struct sfp_eeprom_id *id)
1947 struct phylink *pl = upstream;
1948 unsigned long *support = pl->sfp_support;
1952 linkmode_zero(support);
1953 sfp_parse_support(pl->sfp_bus, id, support);
1954 pl->sfp_port = sfp_parse_port(pl->sfp_bus, id, support);
1956 /* If this module may have a PHY connecting later, defer until later */
1957 pl->sfp_may_have_phy = sfp_may_have_phy(pl->sfp_bus, id);
1958 if (pl->sfp_may_have_phy)
1961 return phylink_sfp_config(pl, MLO_AN_INBAND, support, support);
1964 static int phylink_sfp_module_start(void *upstream)
1966 struct phylink *pl = upstream;
1968 /* If this SFP module has a PHY, start the PHY now. */
1970 phy_start(pl->phydev);
1974 /* If the module may have a PHY but we didn't detect one we
1975 * need to configure the MAC here.
1977 if (!pl->sfp_may_have_phy)
1980 return phylink_sfp_config(pl, MLO_AN_INBAND,
1981 pl->sfp_support, pl->sfp_support);
1984 static void phylink_sfp_module_stop(void *upstream)
1986 struct phylink *pl = upstream;
1988 /* If this SFP module has a PHY, stop it. */
1990 phy_stop(pl->phydev);
1993 static void phylink_sfp_link_down(void *upstream)
1995 struct phylink *pl = upstream;
1999 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_LINK);
2002 static void phylink_sfp_link_up(void *upstream)
2004 struct phylink *pl = upstream;
2008 clear_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
2009 phylink_run_resolve(pl);
2012 /* The Broadcom BCM84881 in the Methode DM7052 is unable to provide a SGMII
2013 * or 802.3z control word, so inband will not work.
2015 static bool phylink_phy_no_inband(struct phy_device *phy)
2017 return phy->is_c45 &&
2018 (phy->c45_ids.device_ids[1] & 0xfffffff0) == 0xae025150;
2021 static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
2023 struct phylink *pl = upstream;
2024 phy_interface_t interface;
2029 * This is the new way of dealing with flow control for PHYs,
2030 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
2031 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
2032 * using our validate call to the MAC, we rely upon the MAC
2033 * clearing the bits from both supported and advertising fields.
2035 phy_support_asym_pause(phy);
2037 if (phylink_phy_no_inband(phy))
2040 mode = MLO_AN_INBAND;
2042 /* Do the initial configuration */
2043 ret = phylink_sfp_config(pl, mode, phy->supported, phy->advertising);
2047 interface = pl->link_config.interface;
2048 ret = phylink_attach_phy(pl, phy, interface);
2052 ret = phylink_bringup_phy(pl, phy, interface);
2059 static void phylink_sfp_disconnect_phy(void *upstream)
2061 phylink_disconnect_phy(upstream);
2064 static const struct sfp_upstream_ops sfp_phylink_ops = {
2065 .attach = phylink_sfp_attach,
2066 .detach = phylink_sfp_detach,
2067 .module_insert = phylink_sfp_module_insert,
2068 .module_start = phylink_sfp_module_start,
2069 .module_stop = phylink_sfp_module_stop,
2070 .link_up = phylink_sfp_link_up,
2071 .link_down = phylink_sfp_link_down,
2072 .connect_phy = phylink_sfp_connect_phy,
2073 .disconnect_phy = phylink_sfp_disconnect_phy,
2076 /* Helpers for MAC drivers */
2079 * phylink_helper_basex_speed() - 1000BaseX/2500BaseX helper
2080 * @state: a pointer to a &struct phylink_link_state
2082 * Inspect the interface mode, advertising mask or forced speed and
2083 * decide whether to run at 2.5Gbit or 1Gbit appropriately, switching
2084 * the interface mode to suit. @state->interface is appropriately
2085 * updated, and the advertising mask has the "other" baseX_Full flag
2088 void phylink_helper_basex_speed(struct phylink_link_state *state)
2090 if (phy_interface_mode_is_8023z(state->interface)) {
2091 bool want_2500 = state->an_enabled ?
2092 phylink_test(state->advertising, 2500baseX_Full) :
2093 state->speed == SPEED_2500;
2096 phylink_clear(state->advertising, 1000baseX_Full);
2097 state->interface = PHY_INTERFACE_MODE_2500BASEX;
2099 phylink_clear(state->advertising, 2500baseX_Full);
2100 state->interface = PHY_INTERFACE_MODE_1000BASEX;
2104 EXPORT_SYMBOL_GPL(phylink_helper_basex_speed);
2106 static void phylink_decode_c37_word(struct phylink_link_state *state,
2107 uint16_t config_reg, int speed)
2109 bool tx_pause, rx_pause;
2112 if (speed == SPEED_2500)
2113 fd_bit = ETHTOOL_LINK_MODE_2500baseX_Full_BIT;
2115 fd_bit = ETHTOOL_LINK_MODE_1000baseX_Full_BIT;
2117 mii_lpa_mod_linkmode_x(state->lp_advertising, config_reg, fd_bit);
2119 if (linkmode_test_bit(fd_bit, state->advertising) &&
2120 linkmode_test_bit(fd_bit, state->lp_advertising)) {
2121 state->speed = speed;
2122 state->duplex = DUPLEX_FULL;
2124 /* negotiation failure */
2125 state->link = false;
2128 linkmode_resolve_pause(state->advertising, state->lp_advertising,
2129 &tx_pause, &rx_pause);
2132 state->pause |= MLO_PAUSE_TX;
2134 state->pause |= MLO_PAUSE_RX;
2137 static void phylink_decode_sgmii_word(struct phylink_link_state *state,
2138 uint16_t config_reg)
2140 if (!(config_reg & LPA_SGMII_LINK)) {
2141 state->link = false;
2145 switch (config_reg & LPA_SGMII_SPD_MASK) {
2147 state->speed = SPEED_10;
2150 state->speed = SPEED_100;
2152 case LPA_SGMII_1000:
2153 state->speed = SPEED_1000;
2156 state->link = false;
2159 if (config_reg & LPA_SGMII_FULL_DUPLEX)
2160 state->duplex = DUPLEX_FULL;
2162 state->duplex = DUPLEX_HALF;
2166 * phylink_mii_c22_pcs_get_state() - read the MAC PCS state
2167 * @pcs: a pointer to a &struct mdio_device.
2168 * @state: a pointer to a &struct phylink_link_state.
2170 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2171 * clause 37 negotiation and/or SGMII control.
2173 * Read the MAC PCS state from the MII device configured in @config and
2174 * parse the Clause 37 or Cisco SGMII link partner negotiation word into
2175 * the phylink @state structure. This is suitable to be directly plugged
2176 * into the mac_pcs_get_state() member of the struct phylink_mac_ops
2179 void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
2180 struct phylink_link_state *state)
2182 struct mii_bus *bus = pcs->bus;
2183 int addr = pcs->addr;
2186 bmsr = mdiobus_read(bus, addr, MII_BMSR);
2187 lpa = mdiobus_read(bus, addr, MII_LPA);
2188 if (bmsr < 0 || lpa < 0) {
2189 state->link = false;
2193 state->link = !!(bmsr & BMSR_LSTATUS);
2194 state->an_complete = !!(bmsr & BMSR_ANEGCOMPLETE);
2198 switch (state->interface) {
2199 case PHY_INTERFACE_MODE_1000BASEX:
2200 phylink_decode_c37_word(state, lpa, SPEED_1000);
2203 case PHY_INTERFACE_MODE_2500BASEX:
2204 phylink_decode_c37_word(state, lpa, SPEED_2500);
2207 case PHY_INTERFACE_MODE_SGMII:
2208 phylink_decode_sgmii_word(state, lpa);
2212 state->link = false;
2216 EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_get_state);
2219 * phylink_mii_c22_pcs_set_advertisement() - configure the clause 37 PCS
2221 * @pcs: a pointer to a &struct mdio_device.
2222 * @interface: the PHY interface mode being configured
2223 * @advertising: the ethtool advertisement mask
2225 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2226 * clause 37 negotiation and/or SGMII control.
2228 * Configure the clause 37 PCS advertisement as specified by @state. This
2229 * does not trigger a renegotiation; phylink will do that via the
2230 * mac_an_restart() method of the struct phylink_mac_ops structure.
2232 * Returns negative error code on failure to configure the advertisement,
2233 * zero if no change has been made, or one if the advertisement has changed.
2235 int phylink_mii_c22_pcs_set_advertisement(struct mdio_device *pcs,
2236 phy_interface_t interface,
2237 const unsigned long *advertising)
2239 struct mii_bus *bus = pcs->bus;
2240 int addr = pcs->addr;
2244 switch (interface) {
2245 case PHY_INTERFACE_MODE_1000BASEX:
2246 case PHY_INTERFACE_MODE_2500BASEX:
2247 adv = ADVERTISE_1000XFULL;
2248 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2250 adv |= ADVERTISE_1000XPAUSE;
2251 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2253 adv |= ADVERTISE_1000XPSE_ASYM;
2255 val = mdiobus_read(bus, addr, MII_ADVERTISE);
2262 ret = mdiobus_write(bus, addr, MII_ADVERTISE, adv);
2268 case PHY_INTERFACE_MODE_SGMII:
2269 val = mdiobus_read(bus, addr, MII_ADVERTISE);
2276 ret = mdiobus_write(bus, addr, MII_ADVERTISE, 0x0001);
2283 /* Nothing to do for other modes */
2287 EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_set_advertisement);
2290 * phylink_mii_c22_pcs_an_restart() - restart 802.3z autonegotiation
2291 * @pcs: a pointer to a &struct mdio_device.
2293 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2294 * clause 37 negotiation.
2296 * Restart the clause 37 negotiation with the link partner. This is
2297 * suitable to be directly plugged into the mac_pcs_get_state() member
2298 * of the struct phylink_mac_ops structure.
2300 void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs)
2302 struct mii_bus *bus = pcs->bus;
2303 int val, addr = pcs->addr;
2305 val = mdiobus_read(bus, addr, MII_BMCR);
2307 val |= BMCR_ANRESTART;
2309 mdiobus_write(bus, addr, MII_BMCR, val);
2312 EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_an_restart);
2314 void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
2315 struct phylink_link_state *state)
2317 struct mii_bus *bus = pcs->bus;
2318 int addr = pcs->addr;
2321 stat = mdiobus_c45_read(bus, addr, MDIO_MMD_PCS, MDIO_STAT1);
2323 state->link = false;
2327 state->link = !!(stat & MDIO_STAT1_LSTATUS);
2331 switch (state->interface) {
2332 case PHY_INTERFACE_MODE_10GBASER:
2333 state->speed = SPEED_10000;
2334 state->duplex = DUPLEX_FULL;
2341 EXPORT_SYMBOL_GPL(phylink_mii_c45_pcs_get_state);
2343 MODULE_LICENSE("GPL v2");