Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * phylink models the MAC to optional PHY connection, supporting
4 * technologies such as SFP cages where the PHY is hot-pluggable.
5 *
6 * Copyright (C) 2015 Russell King
7 */
8#include <linux/ethtool.h>
9#include <linux/export.h>
10#include <linux/gpio/consumer.h>
11#include <linux/netdevice.h>
12#include <linux/of.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>
21
22#include "sfp.h"
23#include "swphy.h"
24
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)
31
32enum {
33 PHYLINK_DISABLE_STOPPED,
34 PHYLINK_DISABLE_LINK,
35};
36
37/**
38 * struct phylink - internal data type for phylink
39 */
40struct phylink {
41 /* private: */
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;
46 struct phylink_pcs *pcs;
47 struct device *dev;
48 unsigned int old_link_state:1;
49
50 unsigned long phylink_disable_state; /* bitmask of disables */
51 struct phy_device *phydev;
52 phy_interface_t link_interface; /* PHY_INTERFACE_xxx */
53 u8 cfg_link_an_mode; /* MLO_AN_xxx */
54 u8 cur_link_an_mode;
55 u8 link_port; /* The current non-phy ethtool port */
56 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
57
58 /* The link configuration settings */
59 struct phylink_link_state link_config;
60
61 /* The current settings */
62 phy_interface_t cur_interface;
63
64 struct gpio_desc *link_gpio;
65 unsigned int link_irq;
66 struct timer_list link_poll;
67 void (*get_fixed_state)(struct net_device *dev,
68 struct phylink_link_state *s);
69
70 struct mutex state_mutex;
71 struct phylink_link_state phy_state;
72 struct work_struct resolve;
73
74 bool mac_link_dropped;
75
76 struct sfp_bus *sfp_bus;
77 bool sfp_may_have_phy;
78 __ETHTOOL_DECLARE_LINK_MODE_MASK(sfp_support);
79 u8 sfp_port;
80};
81
82#define phylink_printk(level, pl, fmt, ...) \
83 do { \
84 if ((pl)->config->type == PHYLINK_NETDEV) \
85 netdev_printk(level, (pl)->netdev, fmt, ##__VA_ARGS__); \
86 else if ((pl)->config->type == PHYLINK_DEV) \
87 dev_printk(level, (pl)->dev, fmt, ##__VA_ARGS__); \
88 } while (0)
89
90#define phylink_err(pl, fmt, ...) \
91 phylink_printk(KERN_ERR, pl, fmt, ##__VA_ARGS__)
92#define phylink_warn(pl, fmt, ...) \
93 phylink_printk(KERN_WARNING, pl, fmt, ##__VA_ARGS__)
94#define phylink_info(pl, fmt, ...) \
95 phylink_printk(KERN_INFO, pl, fmt, ##__VA_ARGS__)
96#if defined(CONFIG_DYNAMIC_DEBUG)
97#define phylink_dbg(pl, fmt, ...) \
98do { \
99 if ((pl)->config->type == PHYLINK_NETDEV) \
100 netdev_dbg((pl)->netdev, fmt, ##__VA_ARGS__); \
101 else if ((pl)->config->type == PHYLINK_DEV) \
102 dev_dbg((pl)->dev, fmt, ##__VA_ARGS__); \
103} while (0)
104#elif defined(DEBUG)
105#define phylink_dbg(pl, fmt, ...) \
106 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__)
107#else
108#define phylink_dbg(pl, fmt, ...) \
109({ \
110 if (0) \
111 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__); \
112})
113#endif
114
115/**
116 * phylink_set_port_modes() - set the port type modes in the ethtool mask
117 * @mask: ethtool link mode mask
118 *
119 * Sets all the port type modes in the ethtool mask. MAC drivers should
120 * use this in their 'validate' callback.
121 */
122void phylink_set_port_modes(unsigned long *mask)
123{
124 phylink_set(mask, TP);
125 phylink_set(mask, AUI);
126 phylink_set(mask, MII);
127 phylink_set(mask, FIBRE);
128 phylink_set(mask, BNC);
129 phylink_set(mask, Backplane);
130}
131EXPORT_SYMBOL_GPL(phylink_set_port_modes);
132
133static int phylink_is_empty_linkmode(const unsigned long *linkmode)
134{
135 __ETHTOOL_DECLARE_LINK_MODE_MASK(tmp) = { 0, };
136
137 phylink_set_port_modes(tmp);
138 phylink_set(tmp, Autoneg);
139 phylink_set(tmp, Pause);
140 phylink_set(tmp, Asym_Pause);
141
142 return linkmode_subset(linkmode, tmp);
143}
144
145static const char *phylink_an_mode_str(unsigned int mode)
146{
147 static const char *modestr[] = {
148 [MLO_AN_PHY] = "phy",
149 [MLO_AN_FIXED] = "fixed",
150 [MLO_AN_INBAND] = "inband",
151 };
152
153 return mode < ARRAY_SIZE(modestr) ? modestr[mode] : "unknown";
154}
155
156static int phylink_validate(struct phylink *pl, unsigned long *supported,
157 struct phylink_link_state *state)
158{
159 pl->mac_ops->validate(pl->config, supported, state);
160
161 return phylink_is_empty_linkmode(supported) ? -EINVAL : 0;
162}
163
164static int phylink_parse_fixedlink(struct phylink *pl,
165 struct fwnode_handle *fwnode)
166{
167 struct fwnode_handle *fixed_node;
168 const struct phy_setting *s;
169 struct gpio_desc *desc;
170 u32 speed;
171 int ret;
172
173 fixed_node = fwnode_get_named_child_node(fwnode, "fixed-link");
174 if (fixed_node) {
175 ret = fwnode_property_read_u32(fixed_node, "speed", &speed);
176
177 pl->link_config.speed = speed;
178 pl->link_config.duplex = DUPLEX_HALF;
179
180 if (fwnode_property_read_bool(fixed_node, "full-duplex"))
181 pl->link_config.duplex = DUPLEX_FULL;
182
183 /* We treat the "pause" and "asym-pause" terminology as
184 * defining the link partner's ability. */
185 if (fwnode_property_read_bool(fixed_node, "pause"))
186 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
187 pl->link_config.lp_advertising);
188 if (fwnode_property_read_bool(fixed_node, "asym-pause"))
189 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
190 pl->link_config.lp_advertising);
191
192 if (ret == 0) {
193 desc = fwnode_gpiod_get_index(fixed_node, "link", 0,
194 GPIOD_IN, "?");
195
196 if (!IS_ERR(desc))
197 pl->link_gpio = desc;
198 else if (desc == ERR_PTR(-EPROBE_DEFER))
199 ret = -EPROBE_DEFER;
200 }
201 fwnode_handle_put(fixed_node);
202
203 if (ret)
204 return ret;
205 } else {
206 u32 prop[5];
207
208 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
209 NULL, 0);
210 if (ret != ARRAY_SIZE(prop)) {
211 phylink_err(pl, "broken fixed-link?\n");
212 return -EINVAL;
213 }
214
215 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
216 prop, ARRAY_SIZE(prop));
217 if (!ret) {
218 pl->link_config.duplex = prop[1] ?
219 DUPLEX_FULL : DUPLEX_HALF;
220 pl->link_config.speed = prop[2];
221 if (prop[3])
222 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
223 pl->link_config.lp_advertising);
224 if (prop[4])
225 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
226 pl->link_config.lp_advertising);
227 }
228 }
229
230 if (pl->link_config.speed > SPEED_1000 &&
231 pl->link_config.duplex != DUPLEX_FULL)
232 phylink_warn(pl, "fixed link specifies half duplex for %dMbps link?\n",
233 pl->link_config.speed);
234
235 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
236 linkmode_copy(pl->link_config.advertising, pl->supported);
237 phylink_validate(pl, pl->supported, &pl->link_config);
238
239 s = phy_lookup_setting(pl->link_config.speed, pl->link_config.duplex,
240 pl->supported, true);
241 linkmode_zero(pl->supported);
242 phylink_set(pl->supported, MII);
243 phylink_set(pl->supported, Pause);
244 phylink_set(pl->supported, Asym_Pause);
245 phylink_set(pl->supported, Autoneg);
246 if (s) {
247 __set_bit(s->bit, pl->supported);
248 __set_bit(s->bit, pl->link_config.lp_advertising);
249 } else {
250 phylink_warn(pl, "fixed link %s duplex %dMbps not recognised\n",
251 pl->link_config.duplex == DUPLEX_FULL ? "full" : "half",
252 pl->link_config.speed);
253 }
254
255 linkmode_and(pl->link_config.advertising, pl->link_config.advertising,
256 pl->supported);
257
258 pl->link_config.link = 1;
259 pl->link_config.an_complete = 1;
260
261 return 0;
262}
263
264static int phylink_parse_mode(struct phylink *pl, struct fwnode_handle *fwnode)
265{
266 struct fwnode_handle *dn;
267 const char *managed;
268
269 dn = fwnode_get_named_child_node(fwnode, "fixed-link");
270 if (dn || fwnode_property_present(fwnode, "fixed-link"))
271 pl->cfg_link_an_mode = MLO_AN_FIXED;
272 fwnode_handle_put(dn);
273
274 if (fwnode_property_read_string(fwnode, "managed", &managed) == 0 &&
275 strcmp(managed, "in-band-status") == 0) {
276 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
277 phylink_err(pl,
278 "can't use both fixed-link and in-band-status\n");
279 return -EINVAL;
280 }
281
282 linkmode_zero(pl->supported);
283 phylink_set(pl->supported, MII);
284 phylink_set(pl->supported, Autoneg);
285 phylink_set(pl->supported, Asym_Pause);
286 phylink_set(pl->supported, Pause);
287 pl->link_config.an_enabled = true;
288 pl->cfg_link_an_mode = MLO_AN_INBAND;
289
290 switch (pl->link_config.interface) {
291 case PHY_INTERFACE_MODE_SGMII:
292 case PHY_INTERFACE_MODE_QSGMII:
293 phylink_set(pl->supported, 10baseT_Half);
294 phylink_set(pl->supported, 10baseT_Full);
295 phylink_set(pl->supported, 100baseT_Half);
296 phylink_set(pl->supported, 100baseT_Full);
297 phylink_set(pl->supported, 1000baseT_Half);
298 phylink_set(pl->supported, 1000baseT_Full);
299 break;
300
301 case PHY_INTERFACE_MODE_1000BASEX:
302 phylink_set(pl->supported, 1000baseX_Full);
303 break;
304
305 case PHY_INTERFACE_MODE_2500BASEX:
306 phylink_set(pl->supported, 2500baseX_Full);
307 break;
308
309 case PHY_INTERFACE_MODE_USXGMII:
310 case PHY_INTERFACE_MODE_10GKR:
311 case PHY_INTERFACE_MODE_10GBASER:
312 phylink_set(pl->supported, 10baseT_Half);
313 phylink_set(pl->supported, 10baseT_Full);
314 phylink_set(pl->supported, 100baseT_Half);
315 phylink_set(pl->supported, 100baseT_Full);
316 phylink_set(pl->supported, 1000baseT_Half);
317 phylink_set(pl->supported, 1000baseT_Full);
318 phylink_set(pl->supported, 1000baseX_Full);
319 phylink_set(pl->supported, 1000baseKX_Full);
320 phylink_set(pl->supported, 2500baseT_Full);
321 phylink_set(pl->supported, 2500baseX_Full);
322 phylink_set(pl->supported, 5000baseT_Full);
323 phylink_set(pl->supported, 10000baseT_Full);
324 phylink_set(pl->supported, 10000baseKR_Full);
325 phylink_set(pl->supported, 10000baseKX4_Full);
326 phylink_set(pl->supported, 10000baseCR_Full);
327 phylink_set(pl->supported, 10000baseSR_Full);
328 phylink_set(pl->supported, 10000baseLR_Full);
329 phylink_set(pl->supported, 10000baseLRM_Full);
330 phylink_set(pl->supported, 10000baseER_Full);
331 break;
332
333 case PHY_INTERFACE_MODE_XLGMII:
334 phylink_set(pl->supported, 25000baseCR_Full);
335 phylink_set(pl->supported, 25000baseKR_Full);
336 phylink_set(pl->supported, 25000baseSR_Full);
337 phylink_set(pl->supported, 40000baseKR4_Full);
338 phylink_set(pl->supported, 40000baseCR4_Full);
339 phylink_set(pl->supported, 40000baseSR4_Full);
340 phylink_set(pl->supported, 40000baseLR4_Full);
341 phylink_set(pl->supported, 50000baseCR2_Full);
342 phylink_set(pl->supported, 50000baseKR2_Full);
343 phylink_set(pl->supported, 50000baseSR2_Full);
344 phylink_set(pl->supported, 50000baseKR_Full);
345 phylink_set(pl->supported, 50000baseSR_Full);
346 phylink_set(pl->supported, 50000baseCR_Full);
347 phylink_set(pl->supported, 50000baseLR_ER_FR_Full);
348 phylink_set(pl->supported, 50000baseDR_Full);
349 phylink_set(pl->supported, 100000baseKR4_Full);
350 phylink_set(pl->supported, 100000baseSR4_Full);
351 phylink_set(pl->supported, 100000baseCR4_Full);
352 phylink_set(pl->supported, 100000baseLR4_ER4_Full);
353 phylink_set(pl->supported, 100000baseKR2_Full);
354 phylink_set(pl->supported, 100000baseSR2_Full);
355 phylink_set(pl->supported, 100000baseCR2_Full);
356 phylink_set(pl->supported, 100000baseLR2_ER2_FR2_Full);
357 phylink_set(pl->supported, 100000baseDR2_Full);
358 break;
359
360 default:
361 phylink_err(pl,
362 "incorrect link mode %s for in-band status\n",
363 phy_modes(pl->link_config.interface));
364 return -EINVAL;
365 }
366
367 linkmode_copy(pl->link_config.advertising, pl->supported);
368
369 if (phylink_validate(pl, pl->supported, &pl->link_config)) {
370 phylink_err(pl,
371 "failed to validate link configuration for in-band status\n");
372 return -EINVAL;
373 }
374
375 /* Check if MAC/PCS also supports Autoneg. */
376 pl->link_config.an_enabled = phylink_test(pl->supported, Autoneg);
377 }
378
379 return 0;
380}
381
382static void phylink_apply_manual_flow(struct phylink *pl,
383 struct phylink_link_state *state)
384{
385 /* If autoneg is disabled, pause AN is also disabled */
386 if (!state->an_enabled)
387 state->pause &= ~MLO_PAUSE_AN;
388
389 /* Manual configuration of pause modes */
390 if (!(pl->link_config.pause & MLO_PAUSE_AN))
391 state->pause = pl->link_config.pause;
392}
393
394static void phylink_resolve_flow(struct phylink_link_state *state)
395{
396 bool tx_pause, rx_pause;
397
398 state->pause = MLO_PAUSE_NONE;
399 if (state->duplex == DUPLEX_FULL) {
400 linkmode_resolve_pause(state->advertising,
401 state->lp_advertising,
402 &tx_pause, &rx_pause);
403 if (tx_pause)
404 state->pause |= MLO_PAUSE_TX;
405 if (rx_pause)
406 state->pause |= MLO_PAUSE_RX;
407 }
408}
409
410static void phylink_mac_config(struct phylink *pl,
411 const struct phylink_link_state *state)
412{
413 phylink_dbg(pl,
414 "%s: mode=%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
415 __func__, phylink_an_mode_str(pl->cur_link_an_mode),
416 phy_modes(state->interface),
417 phy_speed_to_str(state->speed),
418 phy_duplex_to_str(state->duplex),
419 __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
420 state->pause, state->link, state->an_enabled);
421
422 pl->mac_ops->mac_config(pl->config, pl->cur_link_an_mode, state);
423}
424
425static void phylink_mac_pcs_an_restart(struct phylink *pl)
426{
427 if (pl->link_config.an_enabled &&
428 phy_interface_mode_is_8023z(pl->link_config.interface) &&
429 phylink_autoneg_inband(pl->cur_link_an_mode)) {
430 if (pl->pcs_ops)
431 pl->pcs_ops->pcs_an_restart(pl->pcs);
432 else
433 pl->mac_ops->mac_an_restart(pl->config);
434 }
435}
436
437static void phylink_major_config(struct phylink *pl, bool restart,
438 const struct phylink_link_state *state)
439{
440 int err;
441
442 phylink_dbg(pl, "major config %s\n", phy_modes(state->interface));
443
444 if (pl->mac_ops->mac_prepare) {
445 err = pl->mac_ops->mac_prepare(pl->config, pl->cur_link_an_mode,
446 state->interface);
447 if (err < 0) {
448 phylink_err(pl, "mac_prepare failed: %pe\n",
449 ERR_PTR(err));
450 return;
451 }
452 }
453
454 phylink_mac_config(pl, state);
455
456 if (pl->pcs_ops) {
457 err = pl->pcs_ops->pcs_config(pl->pcs, pl->cur_link_an_mode,
458 state->interface,
459 state->advertising,
460 !!(pl->link_config.pause &
461 MLO_PAUSE_AN));
462 if (err < 0)
463 phylink_err(pl, "pcs_config failed: %pe\n",
464 ERR_PTR(err));
465 if (err > 0)
466 restart = true;
467 }
468 if (restart)
469 phylink_mac_pcs_an_restart(pl);
470
471 if (pl->mac_ops->mac_finish) {
472 err = pl->mac_ops->mac_finish(pl->config, pl->cur_link_an_mode,
473 state->interface);
474 if (err < 0)
475 phylink_err(pl, "mac_prepare failed: %pe\n",
476 ERR_PTR(err));
477 }
478}
479
480/*
481 * Reconfigure for a change of inband advertisement.
482 * If we have a separate PCS, we only need to call its pcs_config() method,
483 * and then restart AN if it indicates something changed. Otherwise, we do
484 * the full MAC reconfiguration.
485 */
486static int phylink_change_inband_advert(struct phylink *pl)
487{
488 int ret;
489
490 if (test_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state))
491 return 0;
492
493 if (!pl->pcs_ops) {
494 /* Legacy method */
495 phylink_mac_config(pl, &pl->link_config);
496 phylink_mac_pcs_an_restart(pl);
497 return 0;
498 }
499
500 phylink_dbg(pl, "%s: mode=%s/%s adv=%*pb pause=%02x\n", __func__,
501 phylink_an_mode_str(pl->cur_link_an_mode),
502 phy_modes(pl->link_config.interface),
503 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->link_config.advertising,
504 pl->link_config.pause);
505
506 /* Modern PCS-based method; update the advert at the PCS, and
507 * restart negotiation if the pcs_config() helper indicates that
508 * the programmed advertisement has changed.
509 */
510 ret = pl->pcs_ops->pcs_config(pl->pcs, pl->cur_link_an_mode,
511 pl->link_config.interface,
512 pl->link_config.advertising,
513 !!(pl->link_config.pause & MLO_PAUSE_AN));
514 if (ret < 0)
515 return ret;
516
517 if (ret > 0)
518 phylink_mac_pcs_an_restart(pl);
519
520 return 0;
521}
522
523static void phylink_mac_pcs_get_state(struct phylink *pl,
524 struct phylink_link_state *state)
525{
526 linkmode_copy(state->advertising, pl->link_config.advertising);
527 linkmode_zero(state->lp_advertising);
528 state->interface = pl->link_config.interface;
529 state->an_enabled = pl->link_config.an_enabled;
530 state->speed = SPEED_UNKNOWN;
531 state->duplex = DUPLEX_UNKNOWN;
532 state->pause = MLO_PAUSE_NONE;
533 state->an_complete = 0;
534 state->link = 1;
535
536 if (pl->pcs_ops)
537 pl->pcs_ops->pcs_get_state(pl->pcs, state);
538 else
539 pl->mac_ops->mac_pcs_get_state(pl->config, state);
540}
541
542/* The fixed state is... fixed except for the link state,
543 * which may be determined by a GPIO or a callback.
544 */
545static void phylink_get_fixed_state(struct phylink *pl,
546 struct phylink_link_state *state)
547{
548 *state = pl->link_config;
549 if (pl->config->get_fixed_state)
550 pl->config->get_fixed_state(pl->config, state);
551 else if (pl->link_gpio)
552 state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
553
554 phylink_resolve_flow(state);
555}
556
557static void phylink_mac_initial_config(struct phylink *pl, bool force_restart)
558{
559 struct phylink_link_state link_state;
560
561 switch (pl->cur_link_an_mode) {
562 case MLO_AN_PHY:
563 link_state = pl->phy_state;
564 break;
565
566 case MLO_AN_FIXED:
567 phylink_get_fixed_state(pl, &link_state);
568 break;
569
570 case MLO_AN_INBAND:
571 link_state = pl->link_config;
572 if (link_state.interface == PHY_INTERFACE_MODE_SGMII)
573 link_state.pause = MLO_PAUSE_NONE;
574 break;
575
576 default: /* can't happen */
577 return;
578 }
579
580 link_state.link = false;
581
582 phylink_apply_manual_flow(pl, &link_state);
583 phylink_major_config(pl, force_restart, &link_state);
584}
585
586static const char *phylink_pause_to_str(int pause)
587{
588 switch (pause & MLO_PAUSE_TXRX_MASK) {
589 case MLO_PAUSE_TX | MLO_PAUSE_RX:
590 return "rx/tx";
591 case MLO_PAUSE_TX:
592 return "tx";
593 case MLO_PAUSE_RX:
594 return "rx";
595 default:
596 return "off";
597 }
598}
599
600static void phylink_link_up(struct phylink *pl,
601 struct phylink_link_state link_state)
602{
603 struct net_device *ndev = pl->netdev;
604
605 pl->cur_interface = link_state.interface;
606
607 if (pl->pcs_ops && pl->pcs_ops->pcs_link_up)
608 pl->pcs_ops->pcs_link_up(pl->pcs, pl->cur_link_an_mode,
609 pl->cur_interface,
610 link_state.speed, link_state.duplex);
611
612 pl->mac_ops->mac_link_up(pl->config, pl->phydev,
613 pl->cur_link_an_mode, pl->cur_interface,
614 link_state.speed, link_state.duplex,
615 !!(link_state.pause & MLO_PAUSE_TX),
616 !!(link_state.pause & MLO_PAUSE_RX));
617
618 if (ndev)
619 netif_carrier_on(ndev);
620
621 phylink_info(pl,
622 "Link is Up - %s/%s - flow control %s\n",
623 phy_speed_to_str(link_state.speed),
624 phy_duplex_to_str(link_state.duplex),
625 phylink_pause_to_str(link_state.pause));
626}
627
628static void phylink_link_down(struct phylink *pl)
629{
630 struct net_device *ndev = pl->netdev;
631
632 if (ndev)
633 netif_carrier_off(ndev);
634 pl->mac_ops->mac_link_down(pl->config, pl->cur_link_an_mode,
635 pl->cur_interface);
636 phylink_info(pl, "Link is Down\n");
637}
638
639static void phylink_resolve(struct work_struct *w)
640{
641 struct phylink *pl = container_of(w, struct phylink, resolve);
642 struct phylink_link_state link_state;
643 struct net_device *ndev = pl->netdev;
644 bool mac_config = false;
645 bool cur_link_state;
646
647 mutex_lock(&pl->state_mutex);
648 if (pl->netdev)
649 cur_link_state = netif_carrier_ok(ndev);
650 else
651 cur_link_state = pl->old_link_state;
652
653 if (pl->phylink_disable_state) {
654 pl->mac_link_dropped = false;
655 link_state.link = false;
656 } else if (pl->mac_link_dropped) {
657 link_state.link = false;
658 } else {
659 switch (pl->cur_link_an_mode) {
660 case MLO_AN_PHY:
661 link_state = pl->phy_state;
662 phylink_apply_manual_flow(pl, &link_state);
663 mac_config = link_state.link;
664 break;
665
666 case MLO_AN_FIXED:
667 phylink_get_fixed_state(pl, &link_state);
668 mac_config = link_state.link;
669 break;
670
671 case MLO_AN_INBAND:
672 phylink_mac_pcs_get_state(pl, &link_state);
673
674 /* If we have a phy, the "up" state is the union of
675 * both the PHY and the MAC */
676 if (pl->phydev)
677 link_state.link &= pl->phy_state.link;
678
679 /* Only update if the PHY link is up */
680 if (pl->phydev && pl->phy_state.link) {
681 link_state.interface = pl->phy_state.interface;
682
683 /* If we have a PHY, we need to update with
684 * the PHY flow control bits. */
685 link_state.pause = pl->phy_state.pause;
686 mac_config = true;
687 }
688 phylink_apply_manual_flow(pl, &link_state);
689 break;
690 }
691 }
692
693 if (mac_config) {
694 if (link_state.interface != pl->link_config.interface) {
695 /* The interface has changed, force the link down and
696 * then reconfigure.
697 */
698 if (cur_link_state) {
699 phylink_link_down(pl);
700 cur_link_state = false;
701 }
702 phylink_major_config(pl, false, &link_state);
703 pl->link_config.interface = link_state.interface;
704 } else if (!pl->pcs_ops) {
705 /* The interface remains unchanged, only the speed,
706 * duplex or pause settings have changed. Call the
707 * old mac_config() method to configure the MAC/PCS
708 * only if we do not have a PCS installed (an
709 * unconverted user.)
710 */
711 phylink_mac_config(pl, &link_state);
712 }
713 }
714
715 if (link_state.link != cur_link_state) {
716 pl->old_link_state = link_state.link;
717 if (!link_state.link)
718 phylink_link_down(pl);
719 else
720 phylink_link_up(pl, link_state);
721 }
722 if (!link_state.link && pl->mac_link_dropped) {
723 pl->mac_link_dropped = false;
724 queue_work(system_power_efficient_wq, &pl->resolve);
725 }
726 mutex_unlock(&pl->state_mutex);
727}
728
729static void phylink_run_resolve(struct phylink *pl)
730{
731 if (!pl->phylink_disable_state)
732 queue_work(system_power_efficient_wq, &pl->resolve);
733}
734
735static void phylink_run_resolve_and_disable(struct phylink *pl, int bit)
736{
737 unsigned long state = pl->phylink_disable_state;
738
739 set_bit(bit, &pl->phylink_disable_state);
740 if (state == 0) {
741 queue_work(system_power_efficient_wq, &pl->resolve);
742 flush_work(&pl->resolve);
743 }
744}
745
746static void phylink_fixed_poll(struct timer_list *t)
747{
748 struct phylink *pl = container_of(t, struct phylink, link_poll);
749
750 mod_timer(t, jiffies + HZ);
751
752 phylink_run_resolve(pl);
753}
754
755static const struct sfp_upstream_ops sfp_phylink_ops;
756
757static int phylink_register_sfp(struct phylink *pl,
758 struct fwnode_handle *fwnode)
759{
760 struct sfp_bus *bus;
761 int ret;
762
763 if (!fwnode)
764 return 0;
765
766 bus = sfp_bus_find_fwnode(fwnode);
767 if (IS_ERR(bus)) {
768 ret = PTR_ERR(bus);
769 phylink_err(pl, "unable to attach SFP bus: %d\n", ret);
770 return ret;
771 }
772
773 pl->sfp_bus = bus;
774
775 ret = sfp_bus_add_upstream(bus, pl, &sfp_phylink_ops);
776 sfp_bus_put(bus);
777
778 return ret;
779}
780
781/**
782 * phylink_create() - create a phylink instance
783 * @config: a pointer to the target &struct phylink_config
784 * @fwnode: a pointer to a &struct fwnode_handle describing the network
785 * interface
786 * @iface: the desired link mode defined by &typedef phy_interface_t
787 * @mac_ops: a pointer to a &struct phylink_mac_ops for the MAC.
788 *
789 * Create a new phylink instance, and parse the link parameters found in @np.
790 * This will parse in-band modes, fixed-link or SFP configuration.
791 *
792 * Note: the rtnl lock must not be held when calling this function.
793 *
794 * Returns a pointer to a &struct phylink, or an error-pointer value. Users
795 * must use IS_ERR() to check for errors from this function.
796 */
797struct phylink *phylink_create(struct phylink_config *config,
798 struct fwnode_handle *fwnode,
799 phy_interface_t iface,
800 const struct phylink_mac_ops *mac_ops)
801{
802 struct phylink *pl;
803 int ret;
804
805 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
806 if (!pl)
807 return ERR_PTR(-ENOMEM);
808
809 mutex_init(&pl->state_mutex);
810 INIT_WORK(&pl->resolve, phylink_resolve);
811
812 pl->config = config;
813 if (config->type == PHYLINK_NETDEV) {
814 pl->netdev = to_net_dev(config->dev);
815 } else if (config->type == PHYLINK_DEV) {
816 pl->dev = config->dev;
817 } else {
818 kfree(pl);
819 return ERR_PTR(-EINVAL);
820 }
821
822 pl->phy_state.interface = iface;
823 pl->link_interface = iface;
824 if (iface == PHY_INTERFACE_MODE_MOCA)
825 pl->link_port = PORT_BNC;
826 else
827 pl->link_port = PORT_MII;
828 pl->link_config.interface = iface;
829 pl->link_config.pause = MLO_PAUSE_AN;
830 pl->link_config.speed = SPEED_UNKNOWN;
831 pl->link_config.duplex = DUPLEX_UNKNOWN;
832 pl->link_config.an_enabled = true;
833 pl->mac_ops = mac_ops;
834 __set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
835 timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
836
837 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
838 linkmode_copy(pl->link_config.advertising, pl->supported);
839 phylink_validate(pl, pl->supported, &pl->link_config);
840
841 ret = phylink_parse_mode(pl, fwnode);
842 if (ret < 0) {
843 kfree(pl);
844 return ERR_PTR(ret);
845 }
846
847 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
848 ret = phylink_parse_fixedlink(pl, fwnode);
849 if (ret < 0) {
850 kfree(pl);
851 return ERR_PTR(ret);
852 }
853 }
854
855 pl->cur_link_an_mode = pl->cfg_link_an_mode;
856
857 ret = phylink_register_sfp(pl, fwnode);
858 if (ret < 0) {
859 kfree(pl);
860 return ERR_PTR(ret);
861 }
862
863 return pl;
864}
865EXPORT_SYMBOL_GPL(phylink_create);
866
867/**
868 * phylink_set_pcs() - set the current PCS for phylink to use
869 * @pl: a pointer to a &struct phylink returned from phylink_create()
870 * @pcs: a pointer to the &struct phylink_pcs
871 *
872 * Bind the MAC PCS to phylink. This may be called after phylink_create(),
873 * in mac_prepare() or mac_config() methods if it is desired to dynamically
874 * change the PCS.
875 *
876 * Please note that there are behavioural changes with the mac_config()
877 * callback if a PCS is present (denoting a newer setup) so removing a PCS
878 * is not supported, and if a PCS is going to be used, it must be registered
879 * by calling phylink_set_pcs() at the latest in the first mac_config() call.
880 */
881void phylink_set_pcs(struct phylink *pl, struct phylink_pcs *pcs)
882{
883 pl->pcs = pcs;
884 pl->pcs_ops = pcs->ops;
885}
886EXPORT_SYMBOL_GPL(phylink_set_pcs);
887
888/**
889 * phylink_destroy() - cleanup and destroy the phylink instance
890 * @pl: a pointer to a &struct phylink returned from phylink_create()
891 *
892 * Destroy a phylink instance. Any PHY that has been attached must have been
893 * cleaned up via phylink_disconnect_phy() prior to calling this function.
894 *
895 * Note: the rtnl lock must not be held when calling this function.
896 */
897void phylink_destroy(struct phylink *pl)
898{
899 sfp_bus_del_upstream(pl->sfp_bus);
900 if (pl->link_gpio)
901 gpiod_put(pl->link_gpio);
902
903 cancel_work_sync(&pl->resolve);
904 kfree(pl);
905}
906EXPORT_SYMBOL_GPL(phylink_destroy);
907
908static void phylink_phy_change(struct phy_device *phydev, bool up)
909{
910 struct phylink *pl = phydev->phylink;
911 bool tx_pause, rx_pause;
912
913 phy_get_pause(phydev, &tx_pause, &rx_pause);
914
915 mutex_lock(&pl->state_mutex);
916 pl->phy_state.speed = phydev->speed;
917 pl->phy_state.duplex = phydev->duplex;
918 pl->phy_state.pause = MLO_PAUSE_NONE;
919 if (tx_pause)
920 pl->phy_state.pause |= MLO_PAUSE_TX;
921 if (rx_pause)
922 pl->phy_state.pause |= MLO_PAUSE_RX;
923 pl->phy_state.interface = phydev->interface;
924 pl->phy_state.link = up;
925 mutex_unlock(&pl->state_mutex);
926
927 phylink_run_resolve(pl);
928
929 phylink_dbg(pl, "phy link %s %s/%s/%s\n", up ? "up" : "down",
930 phy_modes(phydev->interface),
931 phy_speed_to_str(phydev->speed),
932 phy_duplex_to_str(phydev->duplex));
933}
934
935static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy,
936 phy_interface_t interface)
937{
938 struct phylink_link_state config;
939 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
940 char *irq_str;
941 int ret;
942
943 /*
944 * This is the new way of dealing with flow control for PHYs,
945 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
946 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
947 * using our validate call to the MAC, we rely upon the MAC
948 * clearing the bits from both supported and advertising fields.
949 */
950 phy_support_asym_pause(phy);
951
952 memset(&config, 0, sizeof(config));
953 linkmode_copy(supported, phy->supported);
954 linkmode_copy(config.advertising, phy->advertising);
955
956 /* Clause 45 PHYs switch their Serdes lane between several different
957 * modes, normally 10GBASE-R, SGMII. Some use 2500BASE-X for 2.5G
958 * speeds. We really need to know which interface modes the PHY and
959 * MAC supports to properly work out which linkmodes can be supported.
960 */
961 if (phy->is_c45 &&
962 interface != PHY_INTERFACE_MODE_RXAUI &&
963 interface != PHY_INTERFACE_MODE_XAUI &&
964 interface != PHY_INTERFACE_MODE_USXGMII)
965 config.interface = PHY_INTERFACE_MODE_NA;
966 else
967 config.interface = interface;
968
969 ret = phylink_validate(pl, supported, &config);
970 if (ret) {
971 phylink_warn(pl, "validation of %s with support %*pb and advertisement %*pb failed: %d\n",
972 phy_modes(config.interface),
973 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->supported,
974 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising,
975 ret);
976 return ret;
977 }
978
979 phy->phylink = pl;
980 phy->phy_link_change = phylink_phy_change;
981
982 irq_str = phy_attached_info_irq(phy);
983 phylink_info(pl,
984 "PHY [%s] driver [%s] (irq=%s)\n",
985 dev_name(&phy->mdio.dev), phy->drv->name, irq_str);
986 kfree(irq_str);
987
988 mutex_lock(&phy->lock);
989 mutex_lock(&pl->state_mutex);
990 pl->phydev = phy;
991 pl->phy_state.interface = interface;
992 pl->phy_state.pause = MLO_PAUSE_NONE;
993 pl->phy_state.speed = SPEED_UNKNOWN;
994 pl->phy_state.duplex = DUPLEX_UNKNOWN;
995 linkmode_copy(pl->supported, supported);
996 linkmode_copy(pl->link_config.advertising, config.advertising);
997
998 /* Restrict the phy advertisement according to the MAC support. */
999 linkmode_copy(phy->advertising, config.advertising);
1000 mutex_unlock(&pl->state_mutex);
1001 mutex_unlock(&phy->lock);
1002
1003 phylink_dbg(pl,
1004 "phy: setting supported %*pb advertising %*pb\n",
1005 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
1006 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->advertising);
1007
1008 if (phy_interrupt_is_valid(phy))
1009 phy_request_interrupt(phy);
1010
1011 return 0;
1012}
1013
1014static int phylink_attach_phy(struct phylink *pl, struct phy_device *phy,
1015 phy_interface_t interface)
1016{
1017 if (WARN_ON(pl->cfg_link_an_mode == MLO_AN_FIXED ||
1018 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
1019 phy_interface_mode_is_8023z(interface))))
1020 return -EINVAL;
1021
1022 if (pl->phydev)
1023 return -EBUSY;
1024
1025 return phy_attach_direct(pl->netdev, phy, 0, interface);
1026}
1027
1028/**
1029 * phylink_connect_phy() - connect a PHY to the phylink instance
1030 * @pl: a pointer to a &struct phylink returned from phylink_create()
1031 * @phy: a pointer to a &struct phy_device.
1032 *
1033 * Connect @phy to the phylink instance specified by @pl by calling
1034 * phy_attach_direct(). Configure the @phy according to the MAC driver's
1035 * capabilities, start the PHYLIB state machine and enable any interrupts
1036 * that the PHY supports.
1037 *
1038 * This updates the phylink's ethtool supported and advertising link mode
1039 * masks.
1040 *
1041 * Returns 0 on success or a negative errno.
1042 */
1043int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
1044{
1045 int ret;
1046
1047 /* Use PHY device/driver interface */
1048 if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
1049 pl->link_interface = phy->interface;
1050 pl->link_config.interface = pl->link_interface;
1051 }
1052
1053 ret = phylink_attach_phy(pl, phy, pl->link_interface);
1054 if (ret < 0)
1055 return ret;
1056
1057 ret = phylink_bringup_phy(pl, phy, pl->link_config.interface);
1058 if (ret)
1059 phy_detach(phy);
1060
1061 return ret;
1062}
1063EXPORT_SYMBOL_GPL(phylink_connect_phy);
1064
1065/**
1066 * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
1067 * @pl: a pointer to a &struct phylink returned from phylink_create()
1068 * @dn: a pointer to a &struct device_node.
1069 * @flags: PHY-specific flags to communicate to the PHY device driver
1070 *
1071 * Connect the phy specified in the device node @dn to the phylink instance
1072 * specified by @pl. Actions specified in phylink_connect_phy() will be
1073 * performed.
1074 *
1075 * Returns 0 on success or a negative errno.
1076 */
1077int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
1078 u32 flags)
1079{
1080 struct device_node *phy_node;
1081 struct phy_device *phy_dev;
1082 int ret;
1083
1084 /* Fixed links and 802.3z are handled without needing a PHY */
1085 if (pl->cfg_link_an_mode == MLO_AN_FIXED ||
1086 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
1087 phy_interface_mode_is_8023z(pl->link_interface)))
1088 return 0;
1089
1090 phy_node = of_parse_phandle(dn, "phy-handle", 0);
1091 if (!phy_node)
1092 phy_node = of_parse_phandle(dn, "phy", 0);
1093 if (!phy_node)
1094 phy_node = of_parse_phandle(dn, "phy-device", 0);
1095
1096 if (!phy_node) {
1097 if (pl->cfg_link_an_mode == MLO_AN_PHY)
1098 return -ENODEV;
1099 return 0;
1100 }
1101
1102 phy_dev = of_phy_find_device(phy_node);
1103 /* We're done with the phy_node handle */
1104 of_node_put(phy_node);
1105 if (!phy_dev)
1106 return -ENODEV;
1107
1108 ret = phy_attach_direct(pl->netdev, phy_dev, flags,
1109 pl->link_interface);
1110 if (ret)
1111 return ret;
1112
1113 ret = phylink_bringup_phy(pl, phy_dev, pl->link_config.interface);
1114 if (ret)
1115 phy_detach(phy_dev);
1116
1117 return ret;
1118}
1119EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
1120
1121/**
1122 * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
1123 * instance.
1124 * @pl: a pointer to a &struct phylink returned from phylink_create()
1125 *
1126 * Disconnect any current PHY from the phylink instance described by @pl.
1127 */
1128void phylink_disconnect_phy(struct phylink *pl)
1129{
1130 struct phy_device *phy;
1131
1132 ASSERT_RTNL();
1133
1134 phy = pl->phydev;
1135 if (phy) {
1136 mutex_lock(&phy->lock);
1137 mutex_lock(&pl->state_mutex);
1138 pl->phydev = NULL;
1139 mutex_unlock(&pl->state_mutex);
1140 mutex_unlock(&phy->lock);
1141 flush_work(&pl->resolve);
1142
1143 phy_disconnect(phy);
1144 }
1145}
1146EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
1147
1148/**
1149 * phylink_mac_change() - notify phylink of a change in MAC state
1150 * @pl: a pointer to a &struct phylink returned from phylink_create()
1151 * @up: indicates whether the link is currently up.
1152 *
1153 * The MAC driver should call this driver when the state of its link
1154 * changes (eg, link failure, new negotiation results, etc.)
1155 */
1156void phylink_mac_change(struct phylink *pl, bool up)
1157{
1158 if (!up)
1159 pl->mac_link_dropped = true;
1160 phylink_run_resolve(pl);
1161 phylink_dbg(pl, "mac link %s\n", up ? "up" : "down");
1162}
1163EXPORT_SYMBOL_GPL(phylink_mac_change);
1164
1165static irqreturn_t phylink_link_handler(int irq, void *data)
1166{
1167 struct phylink *pl = data;
1168
1169 phylink_run_resolve(pl);
1170
1171 return IRQ_HANDLED;
1172}
1173
1174/**
1175 * phylink_start() - start a phylink instance
1176 * @pl: a pointer to a &struct phylink returned from phylink_create()
1177 *
1178 * Start the phylink instance specified by @pl, configuring the MAC for the
1179 * desired link mode(s) and negotiation style. This should be called from the
1180 * network device driver's &struct net_device_ops ndo_open() method.
1181 */
1182void phylink_start(struct phylink *pl)
1183{
1184 bool poll = false;
1185
1186 ASSERT_RTNL();
1187
1188 phylink_info(pl, "configuring for %s/%s link mode\n",
1189 phylink_an_mode_str(pl->cur_link_an_mode),
1190 phy_modes(pl->link_config.interface));
1191
1192 /* Always set the carrier off */
1193 if (pl->netdev)
1194 netif_carrier_off(pl->netdev);
1195
1196 /* Apply the link configuration to the MAC when starting. This allows
1197 * a fixed-link to start with the correct parameters, and also
1198 * ensures that we set the appropriate advertisement for Serdes links.
1199 *
1200 * Restart autonegotiation if using 802.3z to ensure that the link
1201 * parameters are properly negotiated. This is necessary for DSA
1202 * switches using 802.3z negotiation to ensure they see our modes.
1203 */
1204 phylink_mac_initial_config(pl, true);
1205
1206 clear_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
1207 phylink_run_resolve(pl);
1208
1209 if (pl->cfg_link_an_mode == MLO_AN_FIXED && pl->link_gpio) {
1210 int irq = gpiod_to_irq(pl->link_gpio);
1211
1212 if (irq > 0) {
1213 if (!request_irq(irq, phylink_link_handler,
1214 IRQF_TRIGGER_RISING |
1215 IRQF_TRIGGER_FALLING,
1216 "netdev link", pl))
1217 pl->link_irq = irq;
1218 else
1219 irq = 0;
1220 }
1221 if (irq <= 0)
1222 poll = true;
1223 }
1224
1225 switch (pl->cfg_link_an_mode) {
1226 case MLO_AN_FIXED:
1227 poll |= pl->config->poll_fixed_state;
1228 break;
1229 case MLO_AN_INBAND:
1230 poll |= pl->config->pcs_poll;
1231 if (pl->pcs)
1232 poll |= pl->pcs->poll;
1233 break;
1234 }
1235 if (poll)
1236 mod_timer(&pl->link_poll, jiffies + HZ);
1237 if (pl->phydev)
1238 phy_start(pl->phydev);
1239 if (pl->sfp_bus)
1240 sfp_upstream_start(pl->sfp_bus);
1241}
1242EXPORT_SYMBOL_GPL(phylink_start);
1243
1244/**
1245 * phylink_stop() - stop a phylink instance
1246 * @pl: a pointer to a &struct phylink returned from phylink_create()
1247 *
1248 * Stop the phylink instance specified by @pl. This should be called from the
1249 * network device driver's &struct net_device_ops ndo_stop() method. The
1250 * network device's carrier state should not be changed prior to calling this
1251 * function.
1252 */
1253void phylink_stop(struct phylink *pl)
1254{
1255 ASSERT_RTNL();
1256
1257 if (pl->sfp_bus)
1258 sfp_upstream_stop(pl->sfp_bus);
1259 if (pl->phydev)
1260 phy_stop(pl->phydev);
1261 del_timer_sync(&pl->link_poll);
1262 if (pl->link_irq) {
1263 free_irq(pl->link_irq, pl);
1264 pl->link_irq = 0;
1265 }
1266
1267 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_STOPPED);
1268}
1269EXPORT_SYMBOL_GPL(phylink_stop);
1270
1271/**
1272 * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
1273 * @pl: a pointer to a &struct phylink returned from phylink_create()
1274 * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
1275 *
1276 * Read the wake on lan parameters from the PHY attached to the phylink
1277 * instance specified by @pl. If no PHY is currently attached, report no
1278 * support for wake on lan.
1279 */
1280void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1281{
1282 ASSERT_RTNL();
1283
1284 wol->supported = 0;
1285 wol->wolopts = 0;
1286
1287 if (pl->phydev)
1288 phy_ethtool_get_wol(pl->phydev, wol);
1289}
1290EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
1291
1292/**
1293 * phylink_ethtool_set_wol() - set wake on lan parameters
1294 * @pl: a pointer to a &struct phylink returned from phylink_create()
1295 * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
1296 *
1297 * Set the wake on lan parameters for the PHY attached to the phylink
1298 * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
1299 * error.
1300 *
1301 * Returns zero on success or negative errno code.
1302 */
1303int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1304{
1305 int ret = -EOPNOTSUPP;
1306
1307 ASSERT_RTNL();
1308
1309 if (pl->phydev)
1310 ret = phy_ethtool_set_wol(pl->phydev, wol);
1311
1312 return ret;
1313}
1314EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
1315
1316static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
1317{
1318 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
1319
1320 linkmode_zero(mask);
1321 phylink_set_port_modes(mask);
1322
1323 linkmode_and(dst, dst, mask);
1324 linkmode_or(dst, dst, b);
1325}
1326
1327static void phylink_get_ksettings(const struct phylink_link_state *state,
1328 struct ethtool_link_ksettings *kset)
1329{
1330 phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
1331 linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
1332 kset->base.speed = state->speed;
1333 kset->base.duplex = state->duplex;
1334 kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
1335 AUTONEG_DISABLE;
1336}
1337
1338/**
1339 * phylink_ethtool_ksettings_get() - get the current link settings
1340 * @pl: a pointer to a &struct phylink returned from phylink_create()
1341 * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
1342 *
1343 * Read the current link settings for the phylink instance specified by @pl.
1344 * This will be the link settings read from the MAC, PHY or fixed link
1345 * settings depending on the current negotiation mode.
1346 */
1347int phylink_ethtool_ksettings_get(struct phylink *pl,
1348 struct ethtool_link_ksettings *kset)
1349{
1350 struct phylink_link_state link_state;
1351
1352 ASSERT_RTNL();
1353
1354 if (pl->phydev) {
1355 phy_ethtool_ksettings_get(pl->phydev, kset);
1356 } else {
1357 kset->base.port = pl->link_port;
1358 }
1359
1360 linkmode_copy(kset->link_modes.supported, pl->supported);
1361
1362 switch (pl->cur_link_an_mode) {
1363 case MLO_AN_FIXED:
1364 /* We are using fixed settings. Report these as the
1365 * current link settings - and note that these also
1366 * represent the supported speeds/duplex/pause modes.
1367 */
1368 phylink_get_fixed_state(pl, &link_state);
1369 phylink_get_ksettings(&link_state, kset);
1370 break;
1371
1372 case MLO_AN_INBAND:
1373 /* If there is a phy attached, then use the reported
1374 * settings from the phy with no modification.
1375 */
1376 if (pl->phydev)
1377 break;
1378
1379 phylink_mac_pcs_get_state(pl, &link_state);
1380
1381 /* The MAC is reporting the link results from its own PCS
1382 * layer via in-band status. Report these as the current
1383 * link settings.
1384 */
1385 phylink_get_ksettings(&link_state, kset);
1386 break;
1387 }
1388
1389 return 0;
1390}
1391EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
1392
1393/**
1394 * phylink_ethtool_ksettings_set() - set the link settings
1395 * @pl: a pointer to a &struct phylink returned from phylink_create()
1396 * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
1397 */
1398int phylink_ethtool_ksettings_set(struct phylink *pl,
1399 const struct ethtool_link_ksettings *kset)
1400{
1401 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1402 struct phylink_link_state config;
1403 const struct phy_setting *s;
1404
1405 ASSERT_RTNL();
1406
1407 if (pl->phydev) {
1408 /* We can rely on phylib for this update; we also do not need
1409 * to update the pl->link_config settings:
1410 * - the configuration returned via ksettings_get() will come
1411 * from phylib whenever a PHY is present.
1412 * - link_config.interface will be updated by the PHY calling
1413 * back via phylink_phy_change() and a subsequent resolve.
1414 * - initial link configuration for PHY mode comes from the
1415 * last phy state updated via phylink_phy_change().
1416 * - other configuration changes (e.g. pause modes) are
1417 * performed directly via phylib.
1418 * - if in in-band mode with a PHY, the link configuration
1419 * is passed on the link from the PHY, and all of
1420 * link_config.{speed,duplex,an_enabled,pause} are not used.
1421 * - the only possible use would be link_config.advertising
1422 * pause modes when in 1000base-X mode with a PHY, but in
1423 * the presence of a PHY, this should not be changed as that
1424 * should be determined from the media side advertisement.
1425 */
1426 return phy_ethtool_ksettings_set(pl->phydev, kset);
1427 }
1428
1429 linkmode_copy(support, pl->supported);
1430 config = pl->link_config;
1431 config.an_enabled = kset->base.autoneg == AUTONEG_ENABLE;
1432
1433 /* Mask out unsupported advertisements, and force the autoneg bit */
1434 linkmode_and(config.advertising, kset->link_modes.advertising,
1435 support);
1436 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising,
1437 config.an_enabled);
1438
1439 /* FIXME: should we reject autoneg if phy/mac does not support it? */
1440 switch (kset->base.autoneg) {
1441 case AUTONEG_DISABLE:
1442 /* Autonegotiation disabled, select a suitable speed and
1443 * duplex.
1444 */
1445 s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
1446 support, false);
1447 if (!s)
1448 return -EINVAL;
1449
1450 /* If we have a fixed link, refuse to change link parameters.
1451 * If the link parameters match, accept them but do nothing.
1452 */
1453 if (pl->cur_link_an_mode == MLO_AN_FIXED) {
1454 if (s->speed != pl->link_config.speed ||
1455 s->duplex != pl->link_config.duplex)
1456 return -EINVAL;
1457 return 0;
1458 }
1459
1460 config.speed = s->speed;
1461 config.duplex = s->duplex;
1462 break;
1463
1464 case AUTONEG_ENABLE:
1465 /* If we have a fixed link, allow autonegotiation (since that
1466 * is our default case) but do not allow the advertisement to
1467 * be changed. If the advertisement matches, simply return.
1468 */
1469 if (pl->cur_link_an_mode == MLO_AN_FIXED) {
1470 if (!linkmode_equal(config.advertising,
1471 pl->link_config.advertising))
1472 return -EINVAL;
1473 return 0;
1474 }
1475
1476 config.speed = SPEED_UNKNOWN;
1477 config.duplex = DUPLEX_UNKNOWN;
1478 break;
1479
1480 default:
1481 return -EINVAL;
1482 }
1483
1484 /* We have ruled out the case with a PHY attached, and the
1485 * fixed-link cases. All that is left are in-band links.
1486 */
1487 if (phylink_validate(pl, support, &config))
1488 return -EINVAL;
1489
1490 /* If autonegotiation is enabled, we must have an advertisement */
1491 if (config.an_enabled && phylink_is_empty_linkmode(config.advertising))
1492 return -EINVAL;
1493
1494 mutex_lock(&pl->state_mutex);
1495 pl->link_config.speed = config.speed;
1496 pl->link_config.duplex = config.duplex;
1497 pl->link_config.an_enabled = config.an_enabled;
1498
1499 if (pl->link_config.interface != config.interface) {
1500 /* The interface changed, e.g. 1000base-X <-> 2500base-X */
1501 /* We need to force the link down, then change the interface */
1502 if (pl->old_link_state) {
1503 phylink_link_down(pl);
1504 pl->old_link_state = false;
1505 }
1506 if (!test_bit(PHYLINK_DISABLE_STOPPED,
1507 &pl->phylink_disable_state))
1508 phylink_major_config(pl, false, &config);
1509 pl->link_config.interface = config.interface;
1510 linkmode_copy(pl->link_config.advertising, config.advertising);
1511 } else if (!linkmode_equal(pl->link_config.advertising,
1512 config.advertising)) {
1513 linkmode_copy(pl->link_config.advertising, config.advertising);
1514 phylink_change_inband_advert(pl);
1515 }
1516 mutex_unlock(&pl->state_mutex);
1517
1518 return 0;
1519}
1520EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
1521
1522/**
1523 * phylink_ethtool_nway_reset() - restart negotiation
1524 * @pl: a pointer to a &struct phylink returned from phylink_create()
1525 *
1526 * Restart negotiation for the phylink instance specified by @pl. This will
1527 * cause any attached phy to restart negotiation with the link partner, and
1528 * if the MAC is in a BaseX mode, the MAC will also be requested to restart
1529 * negotiation.
1530 *
1531 * Returns zero on success, or negative error code.
1532 */
1533int phylink_ethtool_nway_reset(struct phylink *pl)
1534{
1535 int ret = 0;
1536
1537 ASSERT_RTNL();
1538
1539 if (pl->phydev)
1540 ret = phy_restart_aneg(pl->phydev);
1541 phylink_mac_pcs_an_restart(pl);
1542
1543 return ret;
1544}
1545EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
1546
1547/**
1548 * phylink_ethtool_get_pauseparam() - get the current pause parameters
1549 * @pl: a pointer to a &struct phylink returned from phylink_create()
1550 * @pause: a pointer to a &struct ethtool_pauseparam
1551 */
1552void phylink_ethtool_get_pauseparam(struct phylink *pl,
1553 struct ethtool_pauseparam *pause)
1554{
1555 ASSERT_RTNL();
1556
1557 pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
1558 pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
1559 pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
1560}
1561EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
1562
1563/**
1564 * phylink_ethtool_set_pauseparam() - set the current pause parameters
1565 * @pl: a pointer to a &struct phylink returned from phylink_create()
1566 * @pause: a pointer to a &struct ethtool_pauseparam
1567 */
1568int phylink_ethtool_set_pauseparam(struct phylink *pl,
1569 struct ethtool_pauseparam *pause)
1570{
1571 struct phylink_link_state *config = &pl->link_config;
1572 bool manual_changed;
1573 int pause_state;
1574
1575 ASSERT_RTNL();
1576
1577 if (pl->cur_link_an_mode == MLO_AN_FIXED)
1578 return -EOPNOTSUPP;
1579
1580 if (!phylink_test(pl->supported, Pause) &&
1581 !phylink_test(pl->supported, Asym_Pause))
1582 return -EOPNOTSUPP;
1583
1584 if (!phylink_test(pl->supported, Asym_Pause) &&
1585 !pause->autoneg && pause->rx_pause != pause->tx_pause)
1586 return -EINVAL;
1587
1588 pause_state = 0;
1589 if (pause->autoneg)
1590 pause_state |= MLO_PAUSE_AN;
1591 if (pause->rx_pause)
1592 pause_state |= MLO_PAUSE_RX;
1593 if (pause->tx_pause)
1594 pause_state |= MLO_PAUSE_TX;
1595
1596 mutex_lock(&pl->state_mutex);
1597 /*
1598 * See the comments for linkmode_set_pause(), wrt the deficiencies
1599 * with the current implementation. A solution to this issue would
1600 * be:
1601 * ethtool Local device
1602 * rx tx Pause AsymDir
1603 * 0 0 0 0
1604 * 1 0 1 1
1605 * 0 1 0 1
1606 * 1 1 1 1
1607 * and then use the ethtool rx/tx enablement status to mask the
1608 * rx/tx pause resolution.
1609 */
1610 linkmode_set_pause(config->advertising, pause->tx_pause,
1611 pause->rx_pause);
1612
1613 manual_changed = (config->pause ^ pause_state) & MLO_PAUSE_AN ||
1614 (!(pause_state & MLO_PAUSE_AN) &&
1615 (config->pause ^ pause_state) & MLO_PAUSE_TXRX_MASK);
1616
1617 config->pause = pause_state;
1618
1619 /* Update our in-band advertisement, triggering a renegotiation if
1620 * the advertisement changed.
1621 */
1622 if (!pl->phydev)
1623 phylink_change_inband_advert(pl);
1624
1625 mutex_unlock(&pl->state_mutex);
1626
1627 /* If we have a PHY, a change of the pause frame advertisement will
1628 * cause phylib to renegotiate (if AN is enabled) which will in turn
1629 * call our phylink_phy_change() and trigger a resolve. Note that
1630 * we can't hold our state mutex while calling phy_set_asym_pause().
1631 */
1632 if (pl->phydev)
1633 phy_set_asym_pause(pl->phydev, pause->rx_pause,
1634 pause->tx_pause);
1635
1636 /* If the manual pause settings changed, make sure we trigger a
1637 * resolve to update their state; we can not guarantee that the
1638 * link will cycle.
1639 */
1640 if (manual_changed) {
1641 pl->mac_link_dropped = true;
1642 phylink_run_resolve(pl);
1643 }
1644
1645 return 0;
1646}
1647EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
1648
1649/**
1650 * phylink_ethtool_get_eee_err() - read the energy efficient ethernet error
1651 * counter
1652 * @pl: a pointer to a &struct phylink returned from phylink_create().
1653 *
1654 * Read the Energy Efficient Ethernet error counter from the PHY associated
1655 * with the phylink instance specified by @pl.
1656 *
1657 * Returns positive error counter value, or negative error code.
1658 */
1659int phylink_get_eee_err(struct phylink *pl)
1660{
1661 int ret = 0;
1662
1663 ASSERT_RTNL();
1664
1665 if (pl->phydev)
1666 ret = phy_get_eee_err(pl->phydev);
1667
1668 return ret;
1669}
1670EXPORT_SYMBOL_GPL(phylink_get_eee_err);
1671
1672/**
1673 * phylink_init_eee() - init and check the EEE features
1674 * @pl: a pointer to a &struct phylink returned from phylink_create()
1675 * @clk_stop_enable: allow PHY to stop receive clock
1676 *
1677 * Must be called either with RTNL held or within mac_link_up()
1678 */
1679int phylink_init_eee(struct phylink *pl, bool clk_stop_enable)
1680{
1681 int ret = -EOPNOTSUPP;
1682
1683 if (pl->phydev)
1684 ret = phy_init_eee(pl->phydev, clk_stop_enable);
1685
1686 return ret;
1687}
1688EXPORT_SYMBOL_GPL(phylink_init_eee);
1689
1690/**
1691 * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
1692 * @pl: a pointer to a &struct phylink returned from phylink_create()
1693 * @eee: a pointer to a &struct ethtool_eee for the read parameters
1694 */
1695int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
1696{
1697 int ret = -EOPNOTSUPP;
1698
1699 ASSERT_RTNL();
1700
1701 if (pl->phydev)
1702 ret = phy_ethtool_get_eee(pl->phydev, eee);
1703
1704 return ret;
1705}
1706EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
1707
1708/**
1709 * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
1710 * @pl: a pointer to a &struct phylink returned from phylink_create()
1711 * @eee: a pointer to a &struct ethtool_eee for the desired parameters
1712 */
1713int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
1714{
1715 int ret = -EOPNOTSUPP;
1716
1717 ASSERT_RTNL();
1718
1719 if (pl->phydev)
1720 ret = phy_ethtool_set_eee(pl->phydev, eee);
1721
1722 return ret;
1723}
1724EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
1725
1726/* This emulates MII registers for a fixed-mode phy operating as per the
1727 * passed in state. "aneg" defines if we report negotiation is possible.
1728 *
1729 * FIXME: should deal with negotiation state too.
1730 */
1731static int phylink_mii_emul_read(unsigned int reg,
1732 struct phylink_link_state *state)
1733{
1734 struct fixed_phy_status fs;
1735 unsigned long *lpa = state->lp_advertising;
1736 int val;
1737
1738 fs.link = state->link;
1739 fs.speed = state->speed;
1740 fs.duplex = state->duplex;
1741 fs.pause = test_bit(ETHTOOL_LINK_MODE_Pause_BIT, lpa);
1742 fs.asym_pause = test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, lpa);
1743
1744 val = swphy_read_reg(reg, &fs);
1745 if (reg == MII_BMSR) {
1746 if (!state->an_complete)
1747 val &= ~BMSR_ANEGCOMPLETE;
1748 }
1749 return val;
1750}
1751
1752static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
1753 unsigned int reg)
1754{
1755 struct phy_device *phydev = pl->phydev;
1756 int prtad, devad;
1757
1758 if (mdio_phy_id_is_c45(phy_id)) {
1759 prtad = mdio_phy_id_prtad(phy_id);
1760 devad = mdio_phy_id_devad(phy_id);
1761 devad = mdiobus_c45_addr(devad, reg);
1762 } else if (phydev->is_c45) {
1763 switch (reg) {
1764 case MII_BMCR:
1765 case MII_BMSR:
1766 case MII_PHYSID1:
1767 case MII_PHYSID2:
1768 devad = __ffs(phydev->c45_ids.mmds_present);
1769 break;
1770 case MII_ADVERTISE:
1771 case MII_LPA:
1772 if (!(phydev->c45_ids.mmds_present & MDIO_DEVS_AN))
1773 return -EINVAL;
1774 devad = MDIO_MMD_AN;
1775 if (reg == MII_ADVERTISE)
1776 reg = MDIO_AN_ADVERTISE;
1777 else
1778 reg = MDIO_AN_LPA;
1779 break;
1780 default:
1781 return -EINVAL;
1782 }
1783 prtad = phy_id;
1784 devad = mdiobus_c45_addr(devad, reg);
1785 } else {
1786 prtad = phy_id;
1787 devad = reg;
1788 }
1789 return mdiobus_read(pl->phydev->mdio.bus, prtad, devad);
1790}
1791
1792static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
1793 unsigned int reg, unsigned int val)
1794{
1795 struct phy_device *phydev = pl->phydev;
1796 int prtad, devad;
1797
1798 if (mdio_phy_id_is_c45(phy_id)) {
1799 prtad = mdio_phy_id_prtad(phy_id);
1800 devad = mdio_phy_id_devad(phy_id);
1801 devad = mdiobus_c45_addr(devad, reg);
1802 } else if (phydev->is_c45) {
1803 switch (reg) {
1804 case MII_BMCR:
1805 case MII_BMSR:
1806 case MII_PHYSID1:
1807 case MII_PHYSID2:
1808 devad = __ffs(phydev->c45_ids.mmds_present);
1809 break;
1810 case MII_ADVERTISE:
1811 case MII_LPA:
1812 if (!(phydev->c45_ids.mmds_present & MDIO_DEVS_AN))
1813 return -EINVAL;
1814 devad = MDIO_MMD_AN;
1815 if (reg == MII_ADVERTISE)
1816 reg = MDIO_AN_ADVERTISE;
1817 else
1818 reg = MDIO_AN_LPA;
1819 break;
1820 default:
1821 return -EINVAL;
1822 }
1823 prtad = phy_id;
1824 devad = mdiobus_c45_addr(devad, reg);
1825 } else {
1826 prtad = phy_id;
1827 devad = reg;
1828 }
1829
1830 return mdiobus_write(phydev->mdio.bus, prtad, devad, val);
1831}
1832
1833static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
1834 unsigned int reg)
1835{
1836 struct phylink_link_state state;
1837 int val = 0xffff;
1838
1839 switch (pl->cur_link_an_mode) {
1840 case MLO_AN_FIXED:
1841 if (phy_id == 0) {
1842 phylink_get_fixed_state(pl, &state);
1843 val = phylink_mii_emul_read(reg, &state);
1844 }
1845 break;
1846
1847 case MLO_AN_PHY:
1848 return -EOPNOTSUPP;
1849
1850 case MLO_AN_INBAND:
1851 if (phy_id == 0) {
1852 phylink_mac_pcs_get_state(pl, &state);
1853 val = phylink_mii_emul_read(reg, &state);
1854 }
1855 break;
1856 }
1857
1858 return val & 0xffff;
1859}
1860
1861static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
1862 unsigned int reg, unsigned int val)
1863{
1864 switch (pl->cur_link_an_mode) {
1865 case MLO_AN_FIXED:
1866 break;
1867
1868 case MLO_AN_PHY:
1869 return -EOPNOTSUPP;
1870
1871 case MLO_AN_INBAND:
1872 break;
1873 }
1874
1875 return 0;
1876}
1877
1878/**
1879 * phylink_mii_ioctl() - generic mii ioctl interface
1880 * @pl: a pointer to a &struct phylink returned from phylink_create()
1881 * @ifr: a pointer to a &struct ifreq for socket ioctls
1882 * @cmd: ioctl cmd to execute
1883 *
1884 * Perform the specified MII ioctl on the PHY attached to the phylink instance
1885 * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
1886 *
1887 * Returns: zero on success or negative error code.
1888 *
1889 * %SIOCGMIIPHY:
1890 * read register from the current PHY.
1891 * %SIOCGMIIREG:
1892 * read register from the specified PHY.
1893 * %SIOCSMIIREG:
1894 * set a register on the specified PHY.
1895 */
1896int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
1897{
1898 struct mii_ioctl_data *mii = if_mii(ifr);
1899 int ret;
1900
1901 ASSERT_RTNL();
1902
1903 if (pl->phydev) {
1904 /* PHYs only exist for MLO_AN_PHY and SGMII */
1905 switch (cmd) {
1906 case SIOCGMIIPHY:
1907 mii->phy_id = pl->phydev->mdio.addr;
1908 fallthrough;
1909
1910 case SIOCGMIIREG:
1911 ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
1912 if (ret >= 0) {
1913 mii->val_out = ret;
1914 ret = 0;
1915 }
1916 break;
1917
1918 case SIOCSMIIREG:
1919 ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
1920 mii->val_in);
1921 break;
1922
1923 default:
1924 ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
1925 break;
1926 }
1927 } else {
1928 switch (cmd) {
1929 case SIOCGMIIPHY:
1930 mii->phy_id = 0;
1931 fallthrough;
1932
1933 case SIOCGMIIREG:
1934 ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
1935 if (ret >= 0) {
1936 mii->val_out = ret;
1937 ret = 0;
1938 }
1939 break;
1940
1941 case SIOCSMIIREG:
1942 ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
1943 mii->val_in);
1944 break;
1945
1946 default:
1947 ret = -EOPNOTSUPP;
1948 break;
1949 }
1950 }
1951
1952 return ret;
1953}
1954EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
1955
1956/**
1957 * phylink_speed_down() - set the non-SFP PHY to lowest speed supported by both
1958 * link partners
1959 * @pl: a pointer to a &struct phylink returned from phylink_create()
1960 * @sync: perform action synchronously
1961 *
1962 * If we have a PHY that is not part of a SFP module, then set the speed
1963 * as described in the phy_speed_down() function. Please see this function
1964 * for a description of the @sync parameter.
1965 *
1966 * Returns zero if there is no PHY, otherwise as per phy_speed_down().
1967 */
1968int phylink_speed_down(struct phylink *pl, bool sync)
1969{
1970 int ret = 0;
1971
1972 ASSERT_RTNL();
1973
1974 if (!pl->sfp_bus && pl->phydev)
1975 ret = phy_speed_down(pl->phydev, sync);
1976
1977 return ret;
1978}
1979EXPORT_SYMBOL_GPL(phylink_speed_down);
1980
1981/**
1982 * phylink_speed_up() - restore the advertised speeds prior to the call to
1983 * phylink_speed_down()
1984 * @pl: a pointer to a &struct phylink returned from phylink_create()
1985 *
1986 * If we have a PHY that is not part of a SFP module, then restore the
1987 * PHY speeds as per phy_speed_up().
1988 *
1989 * Returns zero if there is no PHY, otherwise as per phy_speed_up().
1990 */
1991int phylink_speed_up(struct phylink *pl)
1992{
1993 int ret = 0;
1994
1995 ASSERT_RTNL();
1996
1997 if (!pl->sfp_bus && pl->phydev)
1998 ret = phy_speed_up(pl->phydev);
1999
2000 return ret;
2001}
2002EXPORT_SYMBOL_GPL(phylink_speed_up);
2003
2004static void phylink_sfp_attach(void *upstream, struct sfp_bus *bus)
2005{
2006 struct phylink *pl = upstream;
2007
2008 pl->netdev->sfp_bus = bus;
2009}
2010
2011static void phylink_sfp_detach(void *upstream, struct sfp_bus *bus)
2012{
2013 struct phylink *pl = upstream;
2014
2015 pl->netdev->sfp_bus = NULL;
2016}
2017
2018static int phylink_sfp_config(struct phylink *pl, u8 mode,
2019 const unsigned long *supported,
2020 const unsigned long *advertising)
2021{
2022 __ETHTOOL_DECLARE_LINK_MODE_MASK(support1);
2023 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
2024 struct phylink_link_state config;
2025 phy_interface_t iface;
2026 bool changed;
2027 int ret;
2028
2029 linkmode_copy(support, supported);
2030
2031 memset(&config, 0, sizeof(config));
2032 linkmode_copy(config.advertising, advertising);
2033 config.interface = PHY_INTERFACE_MODE_NA;
2034 config.speed = SPEED_UNKNOWN;
2035 config.duplex = DUPLEX_UNKNOWN;
2036 config.pause = MLO_PAUSE_AN;
2037 config.an_enabled = pl->link_config.an_enabled;
2038
2039 /* Ignore errors if we're expecting a PHY to attach later */
2040 ret = phylink_validate(pl, support, &config);
2041 if (ret) {
2042 phylink_err(pl, "validation with support %*pb failed: %d\n",
2043 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
2044 return ret;
2045 }
2046
2047 iface = sfp_select_interface(pl->sfp_bus, config.advertising);
2048 if (iface == PHY_INTERFACE_MODE_NA) {
2049 phylink_err(pl,
2050 "selection of interface failed, advertisement %*pb\n",
2051 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
2052 return -EINVAL;
2053 }
2054
2055 config.interface = iface;
2056 linkmode_copy(support1, support);
2057 ret = phylink_validate(pl, support1, &config);
2058 if (ret) {
2059 phylink_err(pl, "validation of %s/%s with support %*pb failed: %d\n",
2060 phylink_an_mode_str(mode),
2061 phy_modes(config.interface),
2062 __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
2063 return ret;
2064 }
2065
2066 phylink_dbg(pl, "requesting link mode %s/%s with support %*pb\n",
2067 phylink_an_mode_str(mode), phy_modes(config.interface),
2068 __ETHTOOL_LINK_MODE_MASK_NBITS, support);
2069
2070 if (phy_interface_mode_is_8023z(iface) && pl->phydev)
2071 return -EINVAL;
2072
2073 changed = !linkmode_equal(pl->supported, support);
2074 if (changed) {
2075 linkmode_copy(pl->supported, support);
2076 linkmode_copy(pl->link_config.advertising, config.advertising);
2077 }
2078
2079 if (pl->cur_link_an_mode != mode ||
2080 pl->link_config.interface != config.interface) {
2081 pl->link_config.interface = config.interface;
2082 pl->cur_link_an_mode = mode;
2083
2084 changed = true;
2085
2086 phylink_info(pl, "switched to %s/%s link mode\n",
2087 phylink_an_mode_str(mode),
2088 phy_modes(config.interface));
2089 }
2090
2091 pl->link_port = pl->sfp_port;
2092
2093 if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
2094 &pl->phylink_disable_state))
2095 phylink_mac_initial_config(pl, false);
2096
2097 return ret;
2098}
2099
2100static int phylink_sfp_module_insert(void *upstream,
2101 const struct sfp_eeprom_id *id)
2102{
2103 struct phylink *pl = upstream;
2104 unsigned long *support = pl->sfp_support;
2105
2106 ASSERT_RTNL();
2107
2108 linkmode_zero(support);
2109 sfp_parse_support(pl->sfp_bus, id, support);
2110 pl->sfp_port = sfp_parse_port(pl->sfp_bus, id, support);
2111
2112 /* If this module may have a PHY connecting later, defer until later */
2113 pl->sfp_may_have_phy = sfp_may_have_phy(pl->sfp_bus, id);
2114 if (pl->sfp_may_have_phy)
2115 return 0;
2116
2117 return phylink_sfp_config(pl, MLO_AN_INBAND, support, support);
2118}
2119
2120static int phylink_sfp_module_start(void *upstream)
2121{
2122 struct phylink *pl = upstream;
2123
2124 /* If this SFP module has a PHY, start the PHY now. */
2125 if (pl->phydev) {
2126 phy_start(pl->phydev);
2127 return 0;
2128 }
2129
2130 /* If the module may have a PHY but we didn't detect one we
2131 * need to configure the MAC here.
2132 */
2133 if (!pl->sfp_may_have_phy)
2134 return 0;
2135
2136 return phylink_sfp_config(pl, MLO_AN_INBAND,
2137 pl->sfp_support, pl->sfp_support);
2138}
2139
2140static void phylink_sfp_module_stop(void *upstream)
2141{
2142 struct phylink *pl = upstream;
2143
2144 /* If this SFP module has a PHY, stop it. */
2145 if (pl->phydev)
2146 phy_stop(pl->phydev);
2147}
2148
2149static void phylink_sfp_link_down(void *upstream)
2150{
2151 struct phylink *pl = upstream;
2152
2153 ASSERT_RTNL();
2154
2155 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_LINK);
2156}
2157
2158static void phylink_sfp_link_up(void *upstream)
2159{
2160 struct phylink *pl = upstream;
2161
2162 ASSERT_RTNL();
2163
2164 clear_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
2165 phylink_run_resolve(pl);
2166}
2167
2168/* The Broadcom BCM84881 in the Methode DM7052 is unable to provide a SGMII
2169 * or 802.3z control word, so inband will not work.
2170 */
2171static bool phylink_phy_no_inband(struct phy_device *phy)
2172{
2173 return phy->is_c45 &&
2174 (phy->c45_ids.device_ids[1] & 0xfffffff0) == 0xae025150;
2175}
2176
2177static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
2178{
2179 struct phylink *pl = upstream;
2180 phy_interface_t interface;
2181 u8 mode;
2182 int ret;
2183
2184 /*
2185 * This is the new way of dealing with flow control for PHYs,
2186 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
2187 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
2188 * using our validate call to the MAC, we rely upon the MAC
2189 * clearing the bits from both supported and advertising fields.
2190 */
2191 phy_support_asym_pause(phy);
2192
2193 if (phylink_phy_no_inband(phy))
2194 mode = MLO_AN_PHY;
2195 else
2196 mode = MLO_AN_INBAND;
2197
2198 /* Do the initial configuration */
2199 ret = phylink_sfp_config(pl, mode, phy->supported, phy->advertising);
2200 if (ret < 0)
2201 return ret;
2202
2203 interface = pl->link_config.interface;
2204 ret = phylink_attach_phy(pl, phy, interface);
2205 if (ret < 0)
2206 return ret;
2207
2208 ret = phylink_bringup_phy(pl, phy, interface);
2209 if (ret)
2210 phy_detach(phy);
2211
2212 return ret;
2213}
2214
2215static void phylink_sfp_disconnect_phy(void *upstream)
2216{
2217 phylink_disconnect_phy(upstream);
2218}
2219
2220static const struct sfp_upstream_ops sfp_phylink_ops = {
2221 .attach = phylink_sfp_attach,
2222 .detach = phylink_sfp_detach,
2223 .module_insert = phylink_sfp_module_insert,
2224 .module_start = phylink_sfp_module_start,
2225 .module_stop = phylink_sfp_module_stop,
2226 .link_up = phylink_sfp_link_up,
2227 .link_down = phylink_sfp_link_down,
2228 .connect_phy = phylink_sfp_connect_phy,
2229 .disconnect_phy = phylink_sfp_disconnect_phy,
2230};
2231
2232/* Helpers for MAC drivers */
2233
2234/**
2235 * phylink_helper_basex_speed() - 1000BaseX/2500BaseX helper
2236 * @state: a pointer to a &struct phylink_link_state
2237 *
2238 * Inspect the interface mode, advertising mask or forced speed and
2239 * decide whether to run at 2.5Gbit or 1Gbit appropriately, switching
2240 * the interface mode to suit. @state->interface is appropriately
2241 * updated, and the advertising mask has the "other" baseX_Full flag
2242 * cleared.
2243 */
2244void phylink_helper_basex_speed(struct phylink_link_state *state)
2245{
2246 if (phy_interface_mode_is_8023z(state->interface)) {
2247 bool want_2500 = state->an_enabled ?
2248 phylink_test(state->advertising, 2500baseX_Full) :
2249 state->speed == SPEED_2500;
2250
2251 if (want_2500) {
2252 phylink_clear(state->advertising, 1000baseX_Full);
2253 state->interface = PHY_INTERFACE_MODE_2500BASEX;
2254 } else {
2255 phylink_clear(state->advertising, 2500baseX_Full);
2256 state->interface = PHY_INTERFACE_MODE_1000BASEX;
2257 }
2258 }
2259}
2260EXPORT_SYMBOL_GPL(phylink_helper_basex_speed);
2261
2262static void phylink_decode_c37_word(struct phylink_link_state *state,
2263 uint16_t config_reg, int speed)
2264{
2265 bool tx_pause, rx_pause;
2266 int fd_bit;
2267
2268 if (speed == SPEED_2500)
2269 fd_bit = ETHTOOL_LINK_MODE_2500baseX_Full_BIT;
2270 else
2271 fd_bit = ETHTOOL_LINK_MODE_1000baseX_Full_BIT;
2272
2273 mii_lpa_mod_linkmode_x(state->lp_advertising, config_reg, fd_bit);
2274
2275 if (linkmode_test_bit(fd_bit, state->advertising) &&
2276 linkmode_test_bit(fd_bit, state->lp_advertising)) {
2277 state->speed = speed;
2278 state->duplex = DUPLEX_FULL;
2279 } else {
2280 /* negotiation failure */
2281 state->link = false;
2282 }
2283
2284 linkmode_resolve_pause(state->advertising, state->lp_advertising,
2285 &tx_pause, &rx_pause);
2286
2287 if (tx_pause)
2288 state->pause |= MLO_PAUSE_TX;
2289 if (rx_pause)
2290 state->pause |= MLO_PAUSE_RX;
2291}
2292
2293static void phylink_decode_sgmii_word(struct phylink_link_state *state,
2294 uint16_t config_reg)
2295{
2296 if (!(config_reg & LPA_SGMII_LINK)) {
2297 state->link = false;
2298 return;
2299 }
2300
2301 switch (config_reg & LPA_SGMII_SPD_MASK) {
2302 case LPA_SGMII_10:
2303 state->speed = SPEED_10;
2304 break;
2305 case LPA_SGMII_100:
2306 state->speed = SPEED_100;
2307 break;
2308 case LPA_SGMII_1000:
2309 state->speed = SPEED_1000;
2310 break;
2311 default:
2312 state->link = false;
2313 return;
2314 }
2315 if (config_reg & LPA_SGMII_FULL_DUPLEX)
2316 state->duplex = DUPLEX_FULL;
2317 else
2318 state->duplex = DUPLEX_HALF;
2319}
2320
2321/**
2322 * phylink_mii_c22_pcs_get_state() - read the MAC PCS state
2323 * @pcs: a pointer to a &struct mdio_device.
2324 * @state: a pointer to a &struct phylink_link_state.
2325 *
2326 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2327 * clause 37 negotiation and/or SGMII control.
2328 *
2329 * Read the MAC PCS state from the MII device configured in @config and
2330 * parse the Clause 37 or Cisco SGMII link partner negotiation word into
2331 * the phylink @state structure. This is suitable to be directly plugged
2332 * into the mac_pcs_get_state() member of the struct phylink_mac_ops
2333 * structure.
2334 */
2335void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
2336 struct phylink_link_state *state)
2337{
2338 struct mii_bus *bus = pcs->bus;
2339 int addr = pcs->addr;
2340 int bmsr, lpa;
2341
2342 bmsr = mdiobus_read(bus, addr, MII_BMSR);
2343 lpa = mdiobus_read(bus, addr, MII_LPA);
2344 if (bmsr < 0 || lpa < 0) {
2345 state->link = false;
2346 return;
2347 }
2348
2349 state->link = !!(bmsr & BMSR_LSTATUS);
2350 state->an_complete = !!(bmsr & BMSR_ANEGCOMPLETE);
2351 if (!state->link)
2352 return;
2353
2354 switch (state->interface) {
2355 case PHY_INTERFACE_MODE_1000BASEX:
2356 phylink_decode_c37_word(state, lpa, SPEED_1000);
2357 break;
2358
2359 case PHY_INTERFACE_MODE_2500BASEX:
2360 phylink_decode_c37_word(state, lpa, SPEED_2500);
2361 break;
2362
2363 case PHY_INTERFACE_MODE_SGMII:
2364 phylink_decode_sgmii_word(state, lpa);
2365 break;
2366
2367 default:
2368 state->link = false;
2369 break;
2370 }
2371}
2372EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_get_state);
2373
2374/**
2375 * phylink_mii_c22_pcs_set_advertisement() - configure the clause 37 PCS
2376 * advertisement
2377 * @pcs: a pointer to a &struct mdio_device.
2378 * @interface: the PHY interface mode being configured
2379 * @advertising: the ethtool advertisement mask
2380 *
2381 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2382 * clause 37 negotiation and/or SGMII control.
2383 *
2384 * Configure the clause 37 PCS advertisement as specified by @state. This
2385 * does not trigger a renegotiation; phylink will do that via the
2386 * mac_an_restart() method of the struct phylink_mac_ops structure.
2387 *
2388 * Returns negative error code on failure to configure the advertisement,
2389 * zero if no change has been made, or one if the advertisement has changed.
2390 */
2391int phylink_mii_c22_pcs_set_advertisement(struct mdio_device *pcs,
2392 phy_interface_t interface,
2393 const unsigned long *advertising)
2394{
2395 struct mii_bus *bus = pcs->bus;
2396 int addr = pcs->addr;
2397 int val, ret;
2398 u16 adv;
2399
2400 switch (interface) {
2401 case PHY_INTERFACE_MODE_1000BASEX:
2402 case PHY_INTERFACE_MODE_2500BASEX:
2403 adv = ADVERTISE_1000XFULL;
2404 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2405 advertising))
2406 adv |= ADVERTISE_1000XPAUSE;
2407 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2408 advertising))
2409 adv |= ADVERTISE_1000XPSE_ASYM;
2410
2411 val = mdiobus_read(bus, addr, MII_ADVERTISE);
2412 if (val < 0)
2413 return val;
2414
2415 if (val == adv)
2416 return 0;
2417
2418 ret = mdiobus_write(bus, addr, MII_ADVERTISE, adv);
2419 if (ret < 0)
2420 return ret;
2421
2422 return 1;
2423
2424 case PHY_INTERFACE_MODE_SGMII:
2425 val = mdiobus_read(bus, addr, MII_ADVERTISE);
2426 if (val < 0)
2427 return val;
2428
2429 if (val == 0x0001)
2430 return 0;
2431
2432 ret = mdiobus_write(bus, addr, MII_ADVERTISE, 0x0001);
2433 if (ret < 0)
2434 return ret;
2435
2436 return 1;
2437
2438 default:
2439 /* Nothing to do for other modes */
2440 return 0;
2441 }
2442}
2443EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_set_advertisement);
2444
2445/**
2446 * phylink_mii_c22_pcs_config() - configure clause 22 PCS
2447 * @pcs: a pointer to a &struct mdio_device.
2448 * @mode: link autonegotiation mode
2449 * @interface: the PHY interface mode being configured
2450 * @advertising: the ethtool advertisement mask
2451 *
2452 * Configure a Clause 22 PCS PHY with the appropriate negotiation
2453 * parameters for the @mode, @interface and @advertising parameters.
2454 * Returns negative error number on failure, zero if the advertisement
2455 * has not changed, or positive if there is a change.
2456 */
2457int phylink_mii_c22_pcs_config(struct mdio_device *pcs, unsigned int mode,
2458 phy_interface_t interface,
2459 const unsigned long *advertising)
2460{
2461 bool changed;
2462 u16 bmcr;
2463 int ret;
2464
2465 ret = phylink_mii_c22_pcs_set_advertisement(pcs, interface,
2466 advertising);
2467 if (ret < 0)
2468 return ret;
2469
2470 changed = ret > 0;
2471
2472 bmcr = mode == MLO_AN_INBAND ? BMCR_ANENABLE : 0;
2473 ret = mdiobus_modify(pcs->bus, pcs->addr, MII_BMCR,
2474 BMCR_ANENABLE, bmcr);
2475 if (ret < 0)
2476 return ret;
2477
2478 return changed ? 1 : 0;
2479}
2480EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_config);
2481
2482/**
2483 * phylink_mii_c22_pcs_an_restart() - restart 802.3z autonegotiation
2484 * @pcs: a pointer to a &struct mdio_device.
2485 *
2486 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2487 * clause 37 negotiation.
2488 *
2489 * Restart the clause 37 negotiation with the link partner. This is
2490 * suitable to be directly plugged into the mac_pcs_get_state() member
2491 * of the struct phylink_mac_ops structure.
2492 */
2493void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs)
2494{
2495 struct mii_bus *bus = pcs->bus;
2496 int val, addr = pcs->addr;
2497
2498 val = mdiobus_read(bus, addr, MII_BMCR);
2499 if (val >= 0) {
2500 val |= BMCR_ANRESTART;
2501
2502 mdiobus_write(bus, addr, MII_BMCR, val);
2503 }
2504}
2505EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_an_restart);
2506
2507void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
2508 struct phylink_link_state *state)
2509{
2510 struct mii_bus *bus = pcs->bus;
2511 int addr = pcs->addr;
2512 int stat;
2513
2514 stat = mdiobus_c45_read(bus, addr, MDIO_MMD_PCS, MDIO_STAT1);
2515 if (stat < 0) {
2516 state->link = false;
2517 return;
2518 }
2519
2520 state->link = !!(stat & MDIO_STAT1_LSTATUS);
2521 if (!state->link)
2522 return;
2523
2524 switch (state->interface) {
2525 case PHY_INTERFACE_MODE_10GBASER:
2526 state->speed = SPEED_10000;
2527 state->duplex = DUPLEX_FULL;
2528 break;
2529
2530 default:
2531 break;
2532 }
2533}
2534EXPORT_SYMBOL_GPL(phylink_mii_c45_pcs_get_state);
2535
2536MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * phylink models the MAC to optional PHY connection, supporting
4 * technologies such as SFP cages where the PHY is hot-pluggable.
5 *
6 * Copyright (C) 2015 Russell King
7 */
8#include <linux/acpi.h>
9#include <linux/ethtool.h>
10#include <linux/export.h>
11#include <linux/gpio/consumer.h>
12#include <linux/netdevice.h>
13#include <linux/of.h>
14#include <linux/of_mdio.h>
15#include <linux/phy.h>
16#include <linux/phy_fixed.h>
17#include <linux/phylink.h>
18#include <linux/rtnetlink.h>
19#include <linux/spinlock.h>
20#include <linux/timer.h>
21#include <linux/workqueue.h>
22
23#include "sfp.h"
24#include "swphy.h"
25
26#define SUPPORTED_INTERFACES \
27 (SUPPORTED_TP | SUPPORTED_MII | SUPPORTED_FIBRE | \
28 SUPPORTED_BNC | SUPPORTED_AUI | SUPPORTED_Backplane)
29#define ADVERTISED_INTERFACES \
30 (ADVERTISED_TP | ADVERTISED_MII | ADVERTISED_FIBRE | \
31 ADVERTISED_BNC | ADVERTISED_AUI | ADVERTISED_Backplane)
32
33enum {
34 PHYLINK_DISABLE_STOPPED,
35 PHYLINK_DISABLE_LINK,
36 PHYLINK_DISABLE_MAC_WOL,
37};
38
39/**
40 * struct phylink - internal data type for phylink
41 */
42struct phylink {
43 /* private: */
44 struct net_device *netdev;
45 const struct phylink_mac_ops *mac_ops;
46 struct phylink_config *config;
47 struct phylink_pcs *pcs;
48 struct device *dev;
49 unsigned int old_link_state:1;
50
51 unsigned long phylink_disable_state; /* bitmask of disables */
52 struct phy_device *phydev;
53 phy_interface_t link_interface; /* PHY_INTERFACE_xxx */
54 u8 cfg_link_an_mode; /* MLO_AN_xxx */
55 u8 cur_link_an_mode;
56 u8 link_port; /* The current non-phy ethtool port */
57 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
58
59 /* The link configuration settings */
60 struct phylink_link_state link_config;
61
62 /* The current settings */
63 phy_interface_t cur_interface;
64
65 struct gpio_desc *link_gpio;
66 unsigned int link_irq;
67 struct timer_list link_poll;
68 void (*get_fixed_state)(struct net_device *dev,
69 struct phylink_link_state *s);
70
71 struct mutex state_mutex;
72 struct phylink_link_state phy_state;
73 struct work_struct resolve;
74
75 bool mac_link_dropped;
76 bool using_mac_select_pcs;
77
78 struct sfp_bus *sfp_bus;
79 bool sfp_may_have_phy;
80 DECLARE_PHY_INTERFACE_MASK(sfp_interfaces);
81 __ETHTOOL_DECLARE_LINK_MODE_MASK(sfp_support);
82 u8 sfp_port;
83};
84
85#define phylink_printk(level, pl, fmt, ...) \
86 do { \
87 if ((pl)->config->type == PHYLINK_NETDEV) \
88 netdev_printk(level, (pl)->netdev, fmt, ##__VA_ARGS__); \
89 else if ((pl)->config->type == PHYLINK_DEV) \
90 dev_printk(level, (pl)->dev, fmt, ##__VA_ARGS__); \
91 } while (0)
92
93#define phylink_err(pl, fmt, ...) \
94 phylink_printk(KERN_ERR, pl, fmt, ##__VA_ARGS__)
95#define phylink_warn(pl, fmt, ...) \
96 phylink_printk(KERN_WARNING, pl, fmt, ##__VA_ARGS__)
97#define phylink_info(pl, fmt, ...) \
98 phylink_printk(KERN_INFO, pl, fmt, ##__VA_ARGS__)
99#if defined(CONFIG_DYNAMIC_DEBUG)
100#define phylink_dbg(pl, fmt, ...) \
101do { \
102 if ((pl)->config->type == PHYLINK_NETDEV) \
103 netdev_dbg((pl)->netdev, fmt, ##__VA_ARGS__); \
104 else if ((pl)->config->type == PHYLINK_DEV) \
105 dev_dbg((pl)->dev, fmt, ##__VA_ARGS__); \
106} while (0)
107#elif defined(DEBUG)
108#define phylink_dbg(pl, fmt, ...) \
109 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__)
110#else
111#define phylink_dbg(pl, fmt, ...) \
112({ \
113 if (0) \
114 phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__); \
115})
116#endif
117
118/**
119 * phylink_set_port_modes() - set the port type modes in the ethtool mask
120 * @mask: ethtool link mode mask
121 *
122 * Sets all the port type modes in the ethtool mask. MAC drivers should
123 * use this in their 'validate' callback.
124 */
125void phylink_set_port_modes(unsigned long *mask)
126{
127 phylink_set(mask, TP);
128 phylink_set(mask, AUI);
129 phylink_set(mask, MII);
130 phylink_set(mask, FIBRE);
131 phylink_set(mask, BNC);
132 phylink_set(mask, Backplane);
133}
134EXPORT_SYMBOL_GPL(phylink_set_port_modes);
135
136static int phylink_is_empty_linkmode(const unsigned long *linkmode)
137{
138 __ETHTOOL_DECLARE_LINK_MODE_MASK(tmp) = { 0, };
139
140 phylink_set_port_modes(tmp);
141 phylink_set(tmp, Autoneg);
142 phylink_set(tmp, Pause);
143 phylink_set(tmp, Asym_Pause);
144
145 return linkmode_subset(linkmode, tmp);
146}
147
148static const char *phylink_an_mode_str(unsigned int mode)
149{
150 static const char *modestr[] = {
151 [MLO_AN_PHY] = "phy",
152 [MLO_AN_FIXED] = "fixed",
153 [MLO_AN_INBAND] = "inband",
154 };
155
156 return mode < ARRAY_SIZE(modestr) ? modestr[mode] : "unknown";
157}
158
159/**
160 * phylink_interface_max_speed() - get the maximum speed of a phy interface
161 * @interface: phy interface mode defined by &typedef phy_interface_t
162 *
163 * Determine the maximum speed of a phy interface. This is intended to help
164 * determine the correct speed to pass to the MAC when the phy is performing
165 * rate matching.
166 *
167 * Return: The maximum speed of @interface
168 */
169static int phylink_interface_max_speed(phy_interface_t interface)
170{
171 switch (interface) {
172 case PHY_INTERFACE_MODE_100BASEX:
173 case PHY_INTERFACE_MODE_REVRMII:
174 case PHY_INTERFACE_MODE_RMII:
175 case PHY_INTERFACE_MODE_SMII:
176 case PHY_INTERFACE_MODE_REVMII:
177 case PHY_INTERFACE_MODE_MII:
178 return SPEED_100;
179
180 case PHY_INTERFACE_MODE_TBI:
181 case PHY_INTERFACE_MODE_MOCA:
182 case PHY_INTERFACE_MODE_RTBI:
183 case PHY_INTERFACE_MODE_1000BASEX:
184 case PHY_INTERFACE_MODE_1000BASEKX:
185 case PHY_INTERFACE_MODE_TRGMII:
186 case PHY_INTERFACE_MODE_RGMII_TXID:
187 case PHY_INTERFACE_MODE_RGMII_RXID:
188 case PHY_INTERFACE_MODE_RGMII_ID:
189 case PHY_INTERFACE_MODE_RGMII:
190 case PHY_INTERFACE_MODE_QSGMII:
191 case PHY_INTERFACE_MODE_SGMII:
192 case PHY_INTERFACE_MODE_GMII:
193 return SPEED_1000;
194
195 case PHY_INTERFACE_MODE_2500BASEX:
196 return SPEED_2500;
197
198 case PHY_INTERFACE_MODE_5GBASER:
199 return SPEED_5000;
200
201 case PHY_INTERFACE_MODE_XGMII:
202 case PHY_INTERFACE_MODE_RXAUI:
203 case PHY_INTERFACE_MODE_XAUI:
204 case PHY_INTERFACE_MODE_10GBASER:
205 case PHY_INTERFACE_MODE_10GKR:
206 case PHY_INTERFACE_MODE_USXGMII:
207 case PHY_INTERFACE_MODE_QUSGMII:
208 return SPEED_10000;
209
210 case PHY_INTERFACE_MODE_25GBASER:
211 return SPEED_25000;
212
213 case PHY_INTERFACE_MODE_XLGMII:
214 return SPEED_40000;
215
216 case PHY_INTERFACE_MODE_INTERNAL:
217 case PHY_INTERFACE_MODE_NA:
218 case PHY_INTERFACE_MODE_MAX:
219 /* No idea! Garbage in, unknown out */
220 return SPEED_UNKNOWN;
221 }
222
223 /* If we get here, someone forgot to add an interface mode above */
224 WARN_ON_ONCE(1);
225 return SPEED_UNKNOWN;
226}
227
228/**
229 * phylink_caps_to_linkmodes() - Convert capabilities to ethtool link modes
230 * @linkmodes: ethtool linkmode mask (must be already initialised)
231 * @caps: bitmask of MAC capabilities
232 *
233 * Set all possible pause, speed and duplex linkmodes in @linkmodes that are
234 * supported by the @caps. @linkmodes must have been initialised previously.
235 */
236void phylink_caps_to_linkmodes(unsigned long *linkmodes, unsigned long caps)
237{
238 if (caps & MAC_SYM_PAUSE)
239 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT, linkmodes);
240
241 if (caps & MAC_ASYM_PAUSE)
242 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, linkmodes);
243
244 if (caps & MAC_10HD)
245 __set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, linkmodes);
246
247 if (caps & MAC_10FD) {
248 __set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, linkmodes);
249 __set_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT, linkmodes);
250 }
251
252 if (caps & MAC_100HD) {
253 __set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, linkmodes);
254 __set_bit(ETHTOOL_LINK_MODE_100baseFX_Half_BIT, linkmodes);
255 }
256
257 if (caps & MAC_100FD) {
258 __set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, linkmodes);
259 __set_bit(ETHTOOL_LINK_MODE_100baseT1_Full_BIT, linkmodes);
260 __set_bit(ETHTOOL_LINK_MODE_100baseFX_Full_BIT, linkmodes);
261 }
262
263 if (caps & MAC_1000HD)
264 __set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, linkmodes);
265
266 if (caps & MAC_1000FD) {
267 __set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, linkmodes);
268 __set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT, linkmodes);
269 __set_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT, linkmodes);
270 __set_bit(ETHTOOL_LINK_MODE_1000baseT1_Full_BIT, linkmodes);
271 }
272
273 if (caps & MAC_2500FD) {
274 __set_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT, linkmodes);
275 __set_bit(ETHTOOL_LINK_MODE_2500baseX_Full_BIT, linkmodes);
276 }
277
278 if (caps & MAC_5000FD)
279 __set_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT, linkmodes);
280
281 if (caps & MAC_10000FD) {
282 __set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT, linkmodes);
283 __set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT, linkmodes);
284 __set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT, linkmodes);
285 __set_bit(ETHTOOL_LINK_MODE_10000baseR_FEC_BIT, linkmodes);
286 __set_bit(ETHTOOL_LINK_MODE_10000baseCR_Full_BIT, linkmodes);
287 __set_bit(ETHTOOL_LINK_MODE_10000baseSR_Full_BIT, linkmodes);
288 __set_bit(ETHTOOL_LINK_MODE_10000baseLR_Full_BIT, linkmodes);
289 __set_bit(ETHTOOL_LINK_MODE_10000baseLRM_Full_BIT, linkmodes);
290 __set_bit(ETHTOOL_LINK_MODE_10000baseER_Full_BIT, linkmodes);
291 }
292
293 if (caps & MAC_25000FD) {
294 __set_bit(ETHTOOL_LINK_MODE_25000baseCR_Full_BIT, linkmodes);
295 __set_bit(ETHTOOL_LINK_MODE_25000baseKR_Full_BIT, linkmodes);
296 __set_bit(ETHTOOL_LINK_MODE_25000baseSR_Full_BIT, linkmodes);
297 }
298
299 if (caps & MAC_40000FD) {
300 __set_bit(ETHTOOL_LINK_MODE_40000baseKR4_Full_BIT, linkmodes);
301 __set_bit(ETHTOOL_LINK_MODE_40000baseCR4_Full_BIT, linkmodes);
302 __set_bit(ETHTOOL_LINK_MODE_40000baseSR4_Full_BIT, linkmodes);
303 __set_bit(ETHTOOL_LINK_MODE_40000baseLR4_Full_BIT, linkmodes);
304 }
305
306 if (caps & MAC_50000FD) {
307 __set_bit(ETHTOOL_LINK_MODE_50000baseCR2_Full_BIT, linkmodes);
308 __set_bit(ETHTOOL_LINK_MODE_50000baseKR2_Full_BIT, linkmodes);
309 __set_bit(ETHTOOL_LINK_MODE_50000baseSR2_Full_BIT, linkmodes);
310 __set_bit(ETHTOOL_LINK_MODE_50000baseKR_Full_BIT, linkmodes);
311 __set_bit(ETHTOOL_LINK_MODE_50000baseSR_Full_BIT, linkmodes);
312 __set_bit(ETHTOOL_LINK_MODE_50000baseCR_Full_BIT, linkmodes);
313 __set_bit(ETHTOOL_LINK_MODE_50000baseLR_ER_FR_Full_BIT,
314 linkmodes);
315 __set_bit(ETHTOOL_LINK_MODE_50000baseDR_Full_BIT, linkmodes);
316 }
317
318 if (caps & MAC_56000FD) {
319 __set_bit(ETHTOOL_LINK_MODE_56000baseKR4_Full_BIT, linkmodes);
320 __set_bit(ETHTOOL_LINK_MODE_56000baseCR4_Full_BIT, linkmodes);
321 __set_bit(ETHTOOL_LINK_MODE_56000baseSR4_Full_BIT, linkmodes);
322 __set_bit(ETHTOOL_LINK_MODE_56000baseLR4_Full_BIT, linkmodes);
323 }
324
325 if (caps & MAC_100000FD) {
326 __set_bit(ETHTOOL_LINK_MODE_100000baseKR4_Full_BIT, linkmodes);
327 __set_bit(ETHTOOL_LINK_MODE_100000baseSR4_Full_BIT, linkmodes);
328 __set_bit(ETHTOOL_LINK_MODE_100000baseCR4_Full_BIT, linkmodes);
329 __set_bit(ETHTOOL_LINK_MODE_100000baseLR4_ER4_Full_BIT,
330 linkmodes);
331 __set_bit(ETHTOOL_LINK_MODE_100000baseKR2_Full_BIT, linkmodes);
332 __set_bit(ETHTOOL_LINK_MODE_100000baseSR2_Full_BIT, linkmodes);
333 __set_bit(ETHTOOL_LINK_MODE_100000baseCR2_Full_BIT, linkmodes);
334 __set_bit(ETHTOOL_LINK_MODE_100000baseLR2_ER2_FR2_Full_BIT,
335 linkmodes);
336 __set_bit(ETHTOOL_LINK_MODE_100000baseDR2_Full_BIT, linkmodes);
337 __set_bit(ETHTOOL_LINK_MODE_100000baseKR_Full_BIT, linkmodes);
338 __set_bit(ETHTOOL_LINK_MODE_100000baseSR_Full_BIT, linkmodes);
339 __set_bit(ETHTOOL_LINK_MODE_100000baseLR_ER_FR_Full_BIT,
340 linkmodes);
341 __set_bit(ETHTOOL_LINK_MODE_100000baseCR_Full_BIT, linkmodes);
342 __set_bit(ETHTOOL_LINK_MODE_100000baseDR_Full_BIT, linkmodes);
343 }
344
345 if (caps & MAC_200000FD) {
346 __set_bit(ETHTOOL_LINK_MODE_200000baseKR4_Full_BIT, linkmodes);
347 __set_bit(ETHTOOL_LINK_MODE_200000baseSR4_Full_BIT, linkmodes);
348 __set_bit(ETHTOOL_LINK_MODE_200000baseLR4_ER4_FR4_Full_BIT,
349 linkmodes);
350 __set_bit(ETHTOOL_LINK_MODE_200000baseDR4_Full_BIT, linkmodes);
351 __set_bit(ETHTOOL_LINK_MODE_200000baseCR4_Full_BIT, linkmodes);
352 __set_bit(ETHTOOL_LINK_MODE_200000baseKR2_Full_BIT, linkmodes);
353 __set_bit(ETHTOOL_LINK_MODE_200000baseSR2_Full_BIT, linkmodes);
354 __set_bit(ETHTOOL_LINK_MODE_200000baseLR2_ER2_FR2_Full_BIT,
355 linkmodes);
356 __set_bit(ETHTOOL_LINK_MODE_200000baseDR2_Full_BIT, linkmodes);
357 __set_bit(ETHTOOL_LINK_MODE_200000baseCR2_Full_BIT, linkmodes);
358 }
359
360 if (caps & MAC_400000FD) {
361 __set_bit(ETHTOOL_LINK_MODE_400000baseKR8_Full_BIT, linkmodes);
362 __set_bit(ETHTOOL_LINK_MODE_400000baseSR8_Full_BIT, linkmodes);
363 __set_bit(ETHTOOL_LINK_MODE_400000baseLR8_ER8_FR8_Full_BIT,
364 linkmodes);
365 __set_bit(ETHTOOL_LINK_MODE_400000baseDR8_Full_BIT, linkmodes);
366 __set_bit(ETHTOOL_LINK_MODE_400000baseCR8_Full_BIT, linkmodes);
367 __set_bit(ETHTOOL_LINK_MODE_400000baseKR4_Full_BIT, linkmodes);
368 __set_bit(ETHTOOL_LINK_MODE_400000baseSR4_Full_BIT, linkmodes);
369 __set_bit(ETHTOOL_LINK_MODE_400000baseLR4_ER4_FR4_Full_BIT,
370 linkmodes);
371 __set_bit(ETHTOOL_LINK_MODE_400000baseDR4_Full_BIT, linkmodes);
372 __set_bit(ETHTOOL_LINK_MODE_400000baseCR4_Full_BIT, linkmodes);
373 }
374}
375EXPORT_SYMBOL_GPL(phylink_caps_to_linkmodes);
376
377static struct {
378 unsigned long mask;
379 int speed;
380 unsigned int duplex;
381} phylink_caps_params[] = {
382 { MAC_400000FD, SPEED_400000, DUPLEX_FULL },
383 { MAC_200000FD, SPEED_200000, DUPLEX_FULL },
384 { MAC_100000FD, SPEED_100000, DUPLEX_FULL },
385 { MAC_56000FD, SPEED_56000, DUPLEX_FULL },
386 { MAC_50000FD, SPEED_50000, DUPLEX_FULL },
387 { MAC_40000FD, SPEED_40000, DUPLEX_FULL },
388 { MAC_25000FD, SPEED_25000, DUPLEX_FULL },
389 { MAC_20000FD, SPEED_20000, DUPLEX_FULL },
390 { MAC_10000FD, SPEED_10000, DUPLEX_FULL },
391 { MAC_5000FD, SPEED_5000, DUPLEX_FULL },
392 { MAC_2500FD, SPEED_2500, DUPLEX_FULL },
393 { MAC_1000FD, SPEED_1000, DUPLEX_FULL },
394 { MAC_1000HD, SPEED_1000, DUPLEX_HALF },
395 { MAC_100FD, SPEED_100, DUPLEX_FULL },
396 { MAC_100HD, SPEED_100, DUPLEX_HALF },
397 { MAC_10FD, SPEED_10, DUPLEX_FULL },
398 { MAC_10HD, SPEED_10, DUPLEX_HALF },
399};
400
401/**
402 * phylink_cap_from_speed_duplex - Get mac capability from speed/duplex
403 * @speed: the speed to search for
404 * @duplex: the duplex to search for
405 *
406 * Find the mac capability for a given speed and duplex.
407 *
408 * Return: A mask with the mac capability patching @speed and @duplex, or 0 if
409 * there were no matches.
410 */
411static unsigned long phylink_cap_from_speed_duplex(int speed,
412 unsigned int duplex)
413{
414 int i;
415
416 for (i = 0; i < ARRAY_SIZE(phylink_caps_params); i++) {
417 if (speed == phylink_caps_params[i].speed &&
418 duplex == phylink_caps_params[i].duplex)
419 return phylink_caps_params[i].mask;
420 }
421
422 return 0;
423}
424
425/**
426 * phylink_get_capabilities() - get capabilities for a given MAC
427 * @interface: phy interface mode defined by &typedef phy_interface_t
428 * @mac_capabilities: bitmask of MAC capabilities
429 * @rate_matching: type of rate matching being performed
430 *
431 * Get the MAC capabilities that are supported by the @interface mode and
432 * @mac_capabilities.
433 */
434unsigned long phylink_get_capabilities(phy_interface_t interface,
435 unsigned long mac_capabilities,
436 int rate_matching)
437{
438 int max_speed = phylink_interface_max_speed(interface);
439 unsigned long caps = MAC_SYM_PAUSE | MAC_ASYM_PAUSE;
440 unsigned long matched_caps = 0;
441
442 switch (interface) {
443 case PHY_INTERFACE_MODE_USXGMII:
444 caps |= MAC_10000FD | MAC_5000FD | MAC_2500FD;
445 fallthrough;
446
447 case PHY_INTERFACE_MODE_RGMII_TXID:
448 case PHY_INTERFACE_MODE_RGMII_RXID:
449 case PHY_INTERFACE_MODE_RGMII_ID:
450 case PHY_INTERFACE_MODE_RGMII:
451 case PHY_INTERFACE_MODE_QSGMII:
452 case PHY_INTERFACE_MODE_QUSGMII:
453 case PHY_INTERFACE_MODE_SGMII:
454 case PHY_INTERFACE_MODE_GMII:
455 caps |= MAC_1000HD | MAC_1000FD;
456 fallthrough;
457
458 case PHY_INTERFACE_MODE_REVRMII:
459 case PHY_INTERFACE_MODE_RMII:
460 case PHY_INTERFACE_MODE_SMII:
461 case PHY_INTERFACE_MODE_REVMII:
462 case PHY_INTERFACE_MODE_MII:
463 caps |= MAC_10HD | MAC_10FD;
464 fallthrough;
465
466 case PHY_INTERFACE_MODE_100BASEX:
467 caps |= MAC_100HD | MAC_100FD;
468 break;
469
470 case PHY_INTERFACE_MODE_TBI:
471 case PHY_INTERFACE_MODE_MOCA:
472 case PHY_INTERFACE_MODE_RTBI:
473 case PHY_INTERFACE_MODE_1000BASEX:
474 caps |= MAC_1000HD;
475 fallthrough;
476 case PHY_INTERFACE_MODE_1000BASEKX:
477 case PHY_INTERFACE_MODE_TRGMII:
478 caps |= MAC_1000FD;
479 break;
480
481 case PHY_INTERFACE_MODE_2500BASEX:
482 caps |= MAC_2500FD;
483 break;
484
485 case PHY_INTERFACE_MODE_5GBASER:
486 caps |= MAC_5000FD;
487 break;
488
489 case PHY_INTERFACE_MODE_XGMII:
490 case PHY_INTERFACE_MODE_RXAUI:
491 case PHY_INTERFACE_MODE_XAUI:
492 case PHY_INTERFACE_MODE_10GBASER:
493 case PHY_INTERFACE_MODE_10GKR:
494 caps |= MAC_10000FD;
495 break;
496
497 case PHY_INTERFACE_MODE_25GBASER:
498 caps |= MAC_25000FD;
499 break;
500
501 case PHY_INTERFACE_MODE_XLGMII:
502 caps |= MAC_40000FD;
503 break;
504
505 case PHY_INTERFACE_MODE_INTERNAL:
506 caps |= ~0;
507 break;
508
509 case PHY_INTERFACE_MODE_NA:
510 case PHY_INTERFACE_MODE_MAX:
511 break;
512 }
513
514 switch (rate_matching) {
515 case RATE_MATCH_OPEN_LOOP:
516 /* TODO */
517 fallthrough;
518 case RATE_MATCH_NONE:
519 matched_caps = 0;
520 break;
521 case RATE_MATCH_PAUSE: {
522 /* The MAC must support asymmetric pause towards the local
523 * device for this. We could allow just symmetric pause, but
524 * then we might have to renegotiate if the link partner
525 * doesn't support pause. This is because there's no way to
526 * accept pause frames without transmitting them if we only
527 * support symmetric pause.
528 */
529 if (!(mac_capabilities & MAC_SYM_PAUSE) ||
530 !(mac_capabilities & MAC_ASYM_PAUSE))
531 break;
532
533 /* We can't adapt if the MAC doesn't support the interface's
534 * max speed at full duplex.
535 */
536 if (mac_capabilities &
537 phylink_cap_from_speed_duplex(max_speed, DUPLEX_FULL)) {
538 /* Although a duplex-matching phy might exist, we
539 * conservatively remove these modes because the MAC
540 * will not be aware of the half-duplex nature of the
541 * link.
542 */
543 matched_caps = GENMASK(__fls(caps), __fls(MAC_10HD));
544 matched_caps &= ~(MAC_1000HD | MAC_100HD | MAC_10HD);
545 }
546 break;
547 }
548 case RATE_MATCH_CRS:
549 /* The MAC must support half duplex at the interface's max
550 * speed.
551 */
552 if (mac_capabilities &
553 phylink_cap_from_speed_duplex(max_speed, DUPLEX_HALF)) {
554 matched_caps = GENMASK(__fls(caps), __fls(MAC_10HD));
555 matched_caps &= mac_capabilities;
556 }
557 break;
558 }
559
560 return (caps & mac_capabilities) | matched_caps;
561}
562EXPORT_SYMBOL_GPL(phylink_get_capabilities);
563
564/**
565 * phylink_validate_mask_caps() - Restrict link modes based on caps
566 * @supported: ethtool bitmask for supported link modes.
567 * @state: pointer to a &struct phylink_link_state.
568 * @mac_capabilities: bitmask of MAC capabilities
569 *
570 * Calculate the supported link modes based on @mac_capabilities, and restrict
571 * @supported and @state based on that. Use this function if your capabiliies
572 * aren't constant, such as if they vary depending on the interface.
573 */
574void phylink_validate_mask_caps(unsigned long *supported,
575 struct phylink_link_state *state,
576 unsigned long mac_capabilities)
577{
578 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
579 unsigned long caps;
580
581 phylink_set_port_modes(mask);
582 phylink_set(mask, Autoneg);
583 caps = phylink_get_capabilities(state->interface, mac_capabilities,
584 state->rate_matching);
585 phylink_caps_to_linkmodes(mask, caps);
586
587 linkmode_and(supported, supported, mask);
588 linkmode_and(state->advertising, state->advertising, mask);
589}
590EXPORT_SYMBOL_GPL(phylink_validate_mask_caps);
591
592/**
593 * phylink_generic_validate() - generic validate() callback implementation
594 * @config: a pointer to a &struct phylink_config.
595 * @supported: ethtool bitmask for supported link modes.
596 * @state: a pointer to a &struct phylink_link_state.
597 *
598 * Generic implementation of the validate() callback that MAC drivers can
599 * use when they pass the range of supported interfaces and MAC capabilities.
600 */
601void phylink_generic_validate(struct phylink_config *config,
602 unsigned long *supported,
603 struct phylink_link_state *state)
604{
605 phylink_validate_mask_caps(supported, state, config->mac_capabilities);
606}
607EXPORT_SYMBOL_GPL(phylink_generic_validate);
608
609static int phylink_validate_mac_and_pcs(struct phylink *pl,
610 unsigned long *supported,
611 struct phylink_link_state *state)
612{
613 struct phylink_pcs *pcs;
614 int ret;
615
616 /* Get the PCS for this interface mode */
617 if (pl->using_mac_select_pcs) {
618 pcs = pl->mac_ops->mac_select_pcs(pl->config, state->interface);
619 if (IS_ERR(pcs))
620 return PTR_ERR(pcs);
621 } else {
622 pcs = pl->pcs;
623 }
624
625 if (pcs) {
626 /* The PCS, if present, must be setup before phylink_create()
627 * has been called. If the ops is not initialised, print an
628 * error and backtrace rather than oopsing the kernel.
629 */
630 if (!pcs->ops) {
631 phylink_err(pl, "interface %s: uninitialised PCS\n",
632 phy_modes(state->interface));
633 dump_stack();
634 return -EINVAL;
635 }
636
637 /* Validate the link parameters with the PCS */
638 if (pcs->ops->pcs_validate) {
639 ret = pcs->ops->pcs_validate(pcs, supported, state);
640 if (ret < 0 || phylink_is_empty_linkmode(supported))
641 return -EINVAL;
642
643 /* Ensure the advertising mask is a subset of the
644 * supported mask.
645 */
646 linkmode_and(state->advertising, state->advertising,
647 supported);
648 }
649 }
650
651 /* Then validate the link parameters with the MAC */
652 if (pl->mac_ops->validate)
653 pl->mac_ops->validate(pl->config, supported, state);
654 else
655 phylink_generic_validate(pl->config, supported, state);
656
657 return phylink_is_empty_linkmode(supported) ? -EINVAL : 0;
658}
659
660static int phylink_validate_mask(struct phylink *pl, unsigned long *supported,
661 struct phylink_link_state *state,
662 const unsigned long *interfaces)
663{
664 __ETHTOOL_DECLARE_LINK_MODE_MASK(all_adv) = { 0, };
665 __ETHTOOL_DECLARE_LINK_MODE_MASK(all_s) = { 0, };
666 __ETHTOOL_DECLARE_LINK_MODE_MASK(s);
667 struct phylink_link_state t;
668 int intf;
669
670 for (intf = 0; intf < PHY_INTERFACE_MODE_MAX; intf++) {
671 if (test_bit(intf, interfaces)) {
672 linkmode_copy(s, supported);
673
674 t = *state;
675 t.interface = intf;
676 if (!phylink_validate_mac_and_pcs(pl, s, &t)) {
677 linkmode_or(all_s, all_s, s);
678 linkmode_or(all_adv, all_adv, t.advertising);
679 }
680 }
681 }
682
683 linkmode_copy(supported, all_s);
684 linkmode_copy(state->advertising, all_adv);
685
686 return phylink_is_empty_linkmode(supported) ? -EINVAL : 0;
687}
688
689static int phylink_validate(struct phylink *pl, unsigned long *supported,
690 struct phylink_link_state *state)
691{
692 const unsigned long *interfaces = pl->config->supported_interfaces;
693
694 if (!phy_interface_empty(interfaces)) {
695 if (state->interface == PHY_INTERFACE_MODE_NA)
696 return phylink_validate_mask(pl, supported, state,
697 interfaces);
698
699 if (!test_bit(state->interface, interfaces))
700 return -EINVAL;
701 }
702
703 return phylink_validate_mac_and_pcs(pl, supported, state);
704}
705
706static int phylink_parse_fixedlink(struct phylink *pl,
707 struct fwnode_handle *fwnode)
708{
709 struct fwnode_handle *fixed_node;
710 const struct phy_setting *s;
711 struct gpio_desc *desc;
712 u32 speed;
713 int ret;
714
715 fixed_node = fwnode_get_named_child_node(fwnode, "fixed-link");
716 if (fixed_node) {
717 ret = fwnode_property_read_u32(fixed_node, "speed", &speed);
718
719 pl->link_config.speed = speed;
720 pl->link_config.duplex = DUPLEX_HALF;
721
722 if (fwnode_property_read_bool(fixed_node, "full-duplex"))
723 pl->link_config.duplex = DUPLEX_FULL;
724
725 /* We treat the "pause" and "asym-pause" terminology as
726 * defining the link partner's ability.
727 */
728 if (fwnode_property_read_bool(fixed_node, "pause"))
729 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
730 pl->link_config.lp_advertising);
731 if (fwnode_property_read_bool(fixed_node, "asym-pause"))
732 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
733 pl->link_config.lp_advertising);
734
735 if (ret == 0) {
736 desc = fwnode_gpiod_get_index(fixed_node, "link", 0,
737 GPIOD_IN, "?");
738
739 if (!IS_ERR(desc))
740 pl->link_gpio = desc;
741 else if (desc == ERR_PTR(-EPROBE_DEFER))
742 ret = -EPROBE_DEFER;
743 }
744 fwnode_handle_put(fixed_node);
745
746 if (ret)
747 return ret;
748 } else {
749 u32 prop[5];
750
751 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
752 NULL, 0);
753 if (ret != ARRAY_SIZE(prop)) {
754 phylink_err(pl, "broken fixed-link?\n");
755 return -EINVAL;
756 }
757
758 ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
759 prop, ARRAY_SIZE(prop));
760 if (!ret) {
761 pl->link_config.duplex = prop[1] ?
762 DUPLEX_FULL : DUPLEX_HALF;
763 pl->link_config.speed = prop[2];
764 if (prop[3])
765 __set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
766 pl->link_config.lp_advertising);
767 if (prop[4])
768 __set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
769 pl->link_config.lp_advertising);
770 }
771 }
772
773 if (pl->link_config.speed > SPEED_1000 &&
774 pl->link_config.duplex != DUPLEX_FULL)
775 phylink_warn(pl, "fixed link specifies half duplex for %dMbps link?\n",
776 pl->link_config.speed);
777
778 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
779 linkmode_copy(pl->link_config.advertising, pl->supported);
780 phylink_validate(pl, pl->supported, &pl->link_config);
781
782 s = phy_lookup_setting(pl->link_config.speed, pl->link_config.duplex,
783 pl->supported, true);
784 linkmode_zero(pl->supported);
785 phylink_set(pl->supported, MII);
786 phylink_set(pl->supported, Pause);
787 phylink_set(pl->supported, Asym_Pause);
788 phylink_set(pl->supported, Autoneg);
789 if (s) {
790 __set_bit(s->bit, pl->supported);
791 __set_bit(s->bit, pl->link_config.lp_advertising);
792 } else {
793 phylink_warn(pl, "fixed link %s duplex %dMbps not recognised\n",
794 pl->link_config.duplex == DUPLEX_FULL ? "full" : "half",
795 pl->link_config.speed);
796 }
797
798 linkmode_and(pl->link_config.advertising, pl->link_config.advertising,
799 pl->supported);
800
801 pl->link_config.link = 1;
802 pl->link_config.an_complete = 1;
803
804 return 0;
805}
806
807static int phylink_parse_mode(struct phylink *pl, struct fwnode_handle *fwnode)
808{
809 struct fwnode_handle *dn;
810 const char *managed;
811
812 dn = fwnode_get_named_child_node(fwnode, "fixed-link");
813 if (dn || fwnode_property_present(fwnode, "fixed-link"))
814 pl->cfg_link_an_mode = MLO_AN_FIXED;
815 fwnode_handle_put(dn);
816
817 if ((fwnode_property_read_string(fwnode, "managed", &managed) == 0 &&
818 strcmp(managed, "in-band-status") == 0) ||
819 pl->config->ovr_an_inband) {
820 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
821 phylink_err(pl,
822 "can't use both fixed-link and in-band-status\n");
823 return -EINVAL;
824 }
825
826 linkmode_zero(pl->supported);
827 phylink_set(pl->supported, MII);
828 phylink_set(pl->supported, Autoneg);
829 phylink_set(pl->supported, Asym_Pause);
830 phylink_set(pl->supported, Pause);
831 pl->link_config.an_enabled = true;
832 pl->cfg_link_an_mode = MLO_AN_INBAND;
833
834 switch (pl->link_config.interface) {
835 case PHY_INTERFACE_MODE_SGMII:
836 case PHY_INTERFACE_MODE_QSGMII:
837 case PHY_INTERFACE_MODE_QUSGMII:
838 case PHY_INTERFACE_MODE_RGMII:
839 case PHY_INTERFACE_MODE_RGMII_ID:
840 case PHY_INTERFACE_MODE_RGMII_RXID:
841 case PHY_INTERFACE_MODE_RGMII_TXID:
842 case PHY_INTERFACE_MODE_RTBI:
843 phylink_set(pl->supported, 10baseT_Half);
844 phylink_set(pl->supported, 10baseT_Full);
845 phylink_set(pl->supported, 100baseT_Half);
846 phylink_set(pl->supported, 100baseT_Full);
847 phylink_set(pl->supported, 1000baseT_Half);
848 phylink_set(pl->supported, 1000baseT_Full);
849 break;
850
851 case PHY_INTERFACE_MODE_1000BASEX:
852 phylink_set(pl->supported, 1000baseX_Full);
853 break;
854
855 case PHY_INTERFACE_MODE_2500BASEX:
856 phylink_set(pl->supported, 2500baseX_Full);
857 break;
858
859 case PHY_INTERFACE_MODE_5GBASER:
860 phylink_set(pl->supported, 5000baseT_Full);
861 break;
862
863 case PHY_INTERFACE_MODE_25GBASER:
864 phylink_set(pl->supported, 25000baseCR_Full);
865 phylink_set(pl->supported, 25000baseKR_Full);
866 phylink_set(pl->supported, 25000baseSR_Full);
867 fallthrough;
868 case PHY_INTERFACE_MODE_USXGMII:
869 case PHY_INTERFACE_MODE_10GKR:
870 case PHY_INTERFACE_MODE_10GBASER:
871 phylink_set(pl->supported, 10baseT_Half);
872 phylink_set(pl->supported, 10baseT_Full);
873 phylink_set(pl->supported, 100baseT_Half);
874 phylink_set(pl->supported, 100baseT_Full);
875 phylink_set(pl->supported, 1000baseT_Half);
876 phylink_set(pl->supported, 1000baseT_Full);
877 phylink_set(pl->supported, 1000baseX_Full);
878 phylink_set(pl->supported, 1000baseKX_Full);
879 phylink_set(pl->supported, 2500baseT_Full);
880 phylink_set(pl->supported, 2500baseX_Full);
881 phylink_set(pl->supported, 5000baseT_Full);
882 phylink_set(pl->supported, 10000baseT_Full);
883 phylink_set(pl->supported, 10000baseKR_Full);
884 phylink_set(pl->supported, 10000baseKX4_Full);
885 phylink_set(pl->supported, 10000baseCR_Full);
886 phylink_set(pl->supported, 10000baseSR_Full);
887 phylink_set(pl->supported, 10000baseLR_Full);
888 phylink_set(pl->supported, 10000baseLRM_Full);
889 phylink_set(pl->supported, 10000baseER_Full);
890 break;
891
892 case PHY_INTERFACE_MODE_XLGMII:
893 phylink_set(pl->supported, 25000baseCR_Full);
894 phylink_set(pl->supported, 25000baseKR_Full);
895 phylink_set(pl->supported, 25000baseSR_Full);
896 phylink_set(pl->supported, 40000baseKR4_Full);
897 phylink_set(pl->supported, 40000baseCR4_Full);
898 phylink_set(pl->supported, 40000baseSR4_Full);
899 phylink_set(pl->supported, 40000baseLR4_Full);
900 phylink_set(pl->supported, 50000baseCR2_Full);
901 phylink_set(pl->supported, 50000baseKR2_Full);
902 phylink_set(pl->supported, 50000baseSR2_Full);
903 phylink_set(pl->supported, 50000baseKR_Full);
904 phylink_set(pl->supported, 50000baseSR_Full);
905 phylink_set(pl->supported, 50000baseCR_Full);
906 phylink_set(pl->supported, 50000baseLR_ER_FR_Full);
907 phylink_set(pl->supported, 50000baseDR_Full);
908 phylink_set(pl->supported, 100000baseKR4_Full);
909 phylink_set(pl->supported, 100000baseSR4_Full);
910 phylink_set(pl->supported, 100000baseCR4_Full);
911 phylink_set(pl->supported, 100000baseLR4_ER4_Full);
912 phylink_set(pl->supported, 100000baseKR2_Full);
913 phylink_set(pl->supported, 100000baseSR2_Full);
914 phylink_set(pl->supported, 100000baseCR2_Full);
915 phylink_set(pl->supported, 100000baseLR2_ER2_FR2_Full);
916 phylink_set(pl->supported, 100000baseDR2_Full);
917 break;
918
919 default:
920 phylink_err(pl,
921 "incorrect link mode %s for in-band status\n",
922 phy_modes(pl->link_config.interface));
923 return -EINVAL;
924 }
925
926 linkmode_copy(pl->link_config.advertising, pl->supported);
927
928 if (phylink_validate(pl, pl->supported, &pl->link_config)) {
929 phylink_err(pl,
930 "failed to validate link configuration for in-band status\n");
931 return -EINVAL;
932 }
933
934 /* Check if MAC/PCS also supports Autoneg. */
935 pl->link_config.an_enabled = phylink_test(pl->supported, Autoneg);
936 }
937
938 return 0;
939}
940
941static void phylink_apply_manual_flow(struct phylink *pl,
942 struct phylink_link_state *state)
943{
944 /* If autoneg is disabled, pause AN is also disabled */
945 if (!state->an_enabled)
946 state->pause &= ~MLO_PAUSE_AN;
947
948 /* Manual configuration of pause modes */
949 if (!(pl->link_config.pause & MLO_PAUSE_AN))
950 state->pause = pl->link_config.pause;
951}
952
953static void phylink_resolve_flow(struct phylink_link_state *state)
954{
955 bool tx_pause, rx_pause;
956
957 state->pause = MLO_PAUSE_NONE;
958 if (state->duplex == DUPLEX_FULL) {
959 linkmode_resolve_pause(state->advertising,
960 state->lp_advertising,
961 &tx_pause, &rx_pause);
962 if (tx_pause)
963 state->pause |= MLO_PAUSE_TX;
964 if (rx_pause)
965 state->pause |= MLO_PAUSE_RX;
966 }
967}
968
969static void phylink_pcs_poll_stop(struct phylink *pl)
970{
971 if (pl->cfg_link_an_mode == MLO_AN_INBAND)
972 del_timer(&pl->link_poll);
973}
974
975static void phylink_pcs_poll_start(struct phylink *pl)
976{
977 if (pl->pcs && pl->pcs->poll && pl->cfg_link_an_mode == MLO_AN_INBAND)
978 mod_timer(&pl->link_poll, jiffies + HZ);
979}
980
981static void phylink_mac_config(struct phylink *pl,
982 const struct phylink_link_state *state)
983{
984 phylink_dbg(pl,
985 "%s: mode=%s/%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
986 __func__, phylink_an_mode_str(pl->cur_link_an_mode),
987 phy_modes(state->interface),
988 phy_speed_to_str(state->speed),
989 phy_duplex_to_str(state->duplex),
990 phy_rate_matching_to_str(state->rate_matching),
991 __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
992 state->pause, state->link, state->an_enabled);
993
994 pl->mac_ops->mac_config(pl->config, pl->cur_link_an_mode, state);
995}
996
997static void phylink_mac_pcs_an_restart(struct phylink *pl)
998{
999 if (pl->link_config.an_enabled &&
1000 phy_interface_mode_is_8023z(pl->link_config.interface) &&
1001 phylink_autoneg_inband(pl->cur_link_an_mode)) {
1002 if (pl->pcs)
1003 pl->pcs->ops->pcs_an_restart(pl->pcs);
1004 else if (pl->config->legacy_pre_march2020)
1005 pl->mac_ops->mac_an_restart(pl->config);
1006 }
1007}
1008
1009static void phylink_major_config(struct phylink *pl, bool restart,
1010 const struct phylink_link_state *state)
1011{
1012 struct phylink_pcs *pcs = NULL;
1013 bool pcs_changed = false;
1014 int err;
1015
1016 phylink_dbg(pl, "major config %s\n", phy_modes(state->interface));
1017
1018 if (pl->using_mac_select_pcs) {
1019 pcs = pl->mac_ops->mac_select_pcs(pl->config, state->interface);
1020 if (IS_ERR(pcs)) {
1021 phylink_err(pl,
1022 "mac_select_pcs unexpectedly failed: %pe\n",
1023 pcs);
1024 return;
1025 }
1026
1027 pcs_changed = pcs && pl->pcs != pcs;
1028 }
1029
1030 phylink_pcs_poll_stop(pl);
1031
1032 if (pl->mac_ops->mac_prepare) {
1033 err = pl->mac_ops->mac_prepare(pl->config, pl->cur_link_an_mode,
1034 state->interface);
1035 if (err < 0) {
1036 phylink_err(pl, "mac_prepare failed: %pe\n",
1037 ERR_PTR(err));
1038 return;
1039 }
1040 }
1041
1042 /* If we have a new PCS, switch to the new PCS after preparing the MAC
1043 * for the change.
1044 */
1045 if (pcs_changed)
1046 pl->pcs = pcs;
1047
1048 phylink_mac_config(pl, state);
1049
1050 if (pl->pcs) {
1051 err = pl->pcs->ops->pcs_config(pl->pcs, pl->cur_link_an_mode,
1052 state->interface,
1053 state->advertising,
1054 !!(pl->link_config.pause &
1055 MLO_PAUSE_AN));
1056 if (err < 0)
1057 phylink_err(pl, "pcs_config failed: %pe\n",
1058 ERR_PTR(err));
1059 if (err > 0)
1060 restart = true;
1061 }
1062 if (restart)
1063 phylink_mac_pcs_an_restart(pl);
1064
1065 if (pl->mac_ops->mac_finish) {
1066 err = pl->mac_ops->mac_finish(pl->config, pl->cur_link_an_mode,
1067 state->interface);
1068 if (err < 0)
1069 phylink_err(pl, "mac_finish failed: %pe\n",
1070 ERR_PTR(err));
1071 }
1072
1073 phylink_pcs_poll_start(pl);
1074}
1075
1076/*
1077 * Reconfigure for a change of inband advertisement.
1078 * If we have a separate PCS, we only need to call its pcs_config() method,
1079 * and then restart AN if it indicates something changed. Otherwise, we do
1080 * the full MAC reconfiguration.
1081 */
1082static int phylink_change_inband_advert(struct phylink *pl)
1083{
1084 int ret;
1085
1086 if (test_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state))
1087 return 0;
1088
1089 if (!pl->pcs && pl->config->legacy_pre_march2020) {
1090 /* Legacy method */
1091 phylink_mac_config(pl, &pl->link_config);
1092 phylink_mac_pcs_an_restart(pl);
1093 return 0;
1094 }
1095
1096 phylink_dbg(pl, "%s: mode=%s/%s adv=%*pb pause=%02x\n", __func__,
1097 phylink_an_mode_str(pl->cur_link_an_mode),
1098 phy_modes(pl->link_config.interface),
1099 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->link_config.advertising,
1100 pl->link_config.pause);
1101
1102 /* Modern PCS-based method; update the advert at the PCS, and
1103 * restart negotiation if the pcs_config() helper indicates that
1104 * the programmed advertisement has changed.
1105 */
1106 ret = pl->pcs->ops->pcs_config(pl->pcs, pl->cur_link_an_mode,
1107 pl->link_config.interface,
1108 pl->link_config.advertising,
1109 !!(pl->link_config.pause &
1110 MLO_PAUSE_AN));
1111 if (ret < 0)
1112 return ret;
1113
1114 if (ret > 0)
1115 phylink_mac_pcs_an_restart(pl);
1116
1117 return 0;
1118}
1119
1120static void phylink_mac_pcs_get_state(struct phylink *pl,
1121 struct phylink_link_state *state)
1122{
1123 linkmode_copy(state->advertising, pl->link_config.advertising);
1124 linkmode_zero(state->lp_advertising);
1125 state->interface = pl->link_config.interface;
1126 state->an_enabled = pl->link_config.an_enabled;
1127 state->rate_matching = pl->link_config.rate_matching;
1128 if (state->an_enabled) {
1129 state->speed = SPEED_UNKNOWN;
1130 state->duplex = DUPLEX_UNKNOWN;
1131 state->pause = MLO_PAUSE_NONE;
1132 } else {
1133 state->speed = pl->link_config.speed;
1134 state->duplex = pl->link_config.duplex;
1135 state->pause = pl->link_config.pause;
1136 }
1137 state->an_complete = 0;
1138 state->link = 1;
1139
1140 if (pl->pcs)
1141 pl->pcs->ops->pcs_get_state(pl->pcs, state);
1142 else if (pl->mac_ops->mac_pcs_get_state &&
1143 pl->config->legacy_pre_march2020)
1144 pl->mac_ops->mac_pcs_get_state(pl->config, state);
1145 else
1146 state->link = 0;
1147}
1148
1149/* The fixed state is... fixed except for the link state,
1150 * which may be determined by a GPIO or a callback.
1151 */
1152static void phylink_get_fixed_state(struct phylink *pl,
1153 struct phylink_link_state *state)
1154{
1155 *state = pl->link_config;
1156 if (pl->config->get_fixed_state)
1157 pl->config->get_fixed_state(pl->config, state);
1158 else if (pl->link_gpio)
1159 state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
1160
1161 phylink_resolve_flow(state);
1162}
1163
1164static void phylink_mac_initial_config(struct phylink *pl, bool force_restart)
1165{
1166 struct phylink_link_state link_state;
1167
1168 switch (pl->cur_link_an_mode) {
1169 case MLO_AN_PHY:
1170 link_state = pl->phy_state;
1171 break;
1172
1173 case MLO_AN_FIXED:
1174 phylink_get_fixed_state(pl, &link_state);
1175 break;
1176
1177 case MLO_AN_INBAND:
1178 link_state = pl->link_config;
1179 if (link_state.interface == PHY_INTERFACE_MODE_SGMII)
1180 link_state.pause = MLO_PAUSE_NONE;
1181 break;
1182
1183 default: /* can't happen */
1184 return;
1185 }
1186
1187 link_state.link = false;
1188
1189 phylink_apply_manual_flow(pl, &link_state);
1190 phylink_major_config(pl, force_restart, &link_state);
1191}
1192
1193static const char *phylink_pause_to_str(int pause)
1194{
1195 switch (pause & MLO_PAUSE_TXRX_MASK) {
1196 case MLO_PAUSE_TX | MLO_PAUSE_RX:
1197 return "rx/tx";
1198 case MLO_PAUSE_TX:
1199 return "tx";
1200 case MLO_PAUSE_RX:
1201 return "rx";
1202 default:
1203 return "off";
1204 }
1205}
1206
1207static void phylink_link_up(struct phylink *pl,
1208 struct phylink_link_state link_state)
1209{
1210 struct net_device *ndev = pl->netdev;
1211 int speed, duplex;
1212 bool rx_pause;
1213
1214 speed = link_state.speed;
1215 duplex = link_state.duplex;
1216 rx_pause = !!(link_state.pause & MLO_PAUSE_RX);
1217
1218 switch (link_state.rate_matching) {
1219 case RATE_MATCH_PAUSE:
1220 /* The PHY is doing rate matchion from the media rate (in
1221 * the link_state) to the interface speed, and will send
1222 * pause frames to the MAC to limit its transmission speed.
1223 */
1224 speed = phylink_interface_max_speed(link_state.interface);
1225 duplex = DUPLEX_FULL;
1226 rx_pause = true;
1227 break;
1228
1229 case RATE_MATCH_CRS:
1230 /* The PHY is doing rate matchion from the media rate (in
1231 * the link_state) to the interface speed, and will cause
1232 * collisions to the MAC to limit its transmission speed.
1233 */
1234 speed = phylink_interface_max_speed(link_state.interface);
1235 duplex = DUPLEX_HALF;
1236 break;
1237 }
1238
1239 pl->cur_interface = link_state.interface;
1240
1241 if (pl->pcs && pl->pcs->ops->pcs_link_up)
1242 pl->pcs->ops->pcs_link_up(pl->pcs, pl->cur_link_an_mode,
1243 pl->cur_interface, speed, duplex);
1244
1245 pl->mac_ops->mac_link_up(pl->config, pl->phydev, pl->cur_link_an_mode,
1246 pl->cur_interface, speed, duplex,
1247 !!(link_state.pause & MLO_PAUSE_TX), rx_pause);
1248
1249 if (ndev)
1250 netif_carrier_on(ndev);
1251
1252 phylink_info(pl,
1253 "Link is Up - %s/%s - flow control %s\n",
1254 phy_speed_to_str(link_state.speed),
1255 phy_duplex_to_str(link_state.duplex),
1256 phylink_pause_to_str(link_state.pause));
1257}
1258
1259static void phylink_link_down(struct phylink *pl)
1260{
1261 struct net_device *ndev = pl->netdev;
1262
1263 if (ndev)
1264 netif_carrier_off(ndev);
1265 pl->mac_ops->mac_link_down(pl->config, pl->cur_link_an_mode,
1266 pl->cur_interface);
1267 phylink_info(pl, "Link is Down\n");
1268}
1269
1270static void phylink_resolve(struct work_struct *w)
1271{
1272 struct phylink *pl = container_of(w, struct phylink, resolve);
1273 struct phylink_link_state link_state;
1274 struct net_device *ndev = pl->netdev;
1275 bool mac_config = false;
1276 bool retrigger = false;
1277 bool cur_link_state;
1278
1279 mutex_lock(&pl->state_mutex);
1280 if (pl->netdev)
1281 cur_link_state = netif_carrier_ok(ndev);
1282 else
1283 cur_link_state = pl->old_link_state;
1284
1285 if (pl->phylink_disable_state) {
1286 pl->mac_link_dropped = false;
1287 link_state.link = false;
1288 } else if (pl->mac_link_dropped) {
1289 link_state.link = false;
1290 retrigger = true;
1291 } else {
1292 switch (pl->cur_link_an_mode) {
1293 case MLO_AN_PHY:
1294 link_state = pl->phy_state;
1295 phylink_apply_manual_flow(pl, &link_state);
1296 mac_config = link_state.link;
1297 break;
1298
1299 case MLO_AN_FIXED:
1300 phylink_get_fixed_state(pl, &link_state);
1301 mac_config = link_state.link;
1302 break;
1303
1304 case MLO_AN_INBAND:
1305 phylink_mac_pcs_get_state(pl, &link_state);
1306
1307 /* The PCS may have a latching link-fail indicator.
1308 * If the link was up, bring the link down and
1309 * re-trigger the resolve. Otherwise, re-read the
1310 * PCS state to get the current status of the link.
1311 */
1312 if (!link_state.link) {
1313 if (cur_link_state)
1314 retrigger = true;
1315 else
1316 phylink_mac_pcs_get_state(pl,
1317 &link_state);
1318 }
1319
1320 /* If we have a phy, the "up" state is the union of
1321 * both the PHY and the MAC
1322 */
1323 if (pl->phydev)
1324 link_state.link &= pl->phy_state.link;
1325
1326 /* Only update if the PHY link is up */
1327 if (pl->phydev && pl->phy_state.link) {
1328 /* If the interface has changed, force a
1329 * link down event if the link isn't already
1330 * down, and re-resolve.
1331 */
1332 if (link_state.interface !=
1333 pl->phy_state.interface) {
1334 retrigger = true;
1335 link_state.link = false;
1336 }
1337 link_state.interface = pl->phy_state.interface;
1338
1339 /* If we are doing rate matching, then the
1340 * link speed/duplex comes from the PHY
1341 */
1342 if (pl->phy_state.rate_matching) {
1343 link_state.rate_matching =
1344 pl->phy_state.rate_matching;
1345 link_state.speed = pl->phy_state.speed;
1346 link_state.duplex =
1347 pl->phy_state.duplex;
1348 }
1349
1350 /* If we have a PHY, we need to update with
1351 * the PHY flow control bits.
1352 */
1353 link_state.pause = pl->phy_state.pause;
1354 mac_config = true;
1355 }
1356 phylink_apply_manual_flow(pl, &link_state);
1357 break;
1358 }
1359 }
1360
1361 if (mac_config) {
1362 if (link_state.interface != pl->link_config.interface) {
1363 /* The interface has changed, force the link down and
1364 * then reconfigure.
1365 */
1366 if (cur_link_state) {
1367 phylink_link_down(pl);
1368 cur_link_state = false;
1369 }
1370 phylink_major_config(pl, false, &link_state);
1371 pl->link_config.interface = link_state.interface;
1372 } else if (!pl->pcs && pl->config->legacy_pre_march2020) {
1373 /* The interface remains unchanged, only the speed,
1374 * duplex or pause settings have changed. Call the
1375 * old mac_config() method to configure the MAC/PCS
1376 * only if we do not have a legacy MAC driver.
1377 */
1378 phylink_mac_config(pl, &link_state);
1379 }
1380 }
1381
1382 if (link_state.link != cur_link_state) {
1383 pl->old_link_state = link_state.link;
1384 if (!link_state.link)
1385 phylink_link_down(pl);
1386 else
1387 phylink_link_up(pl, link_state);
1388 }
1389 if (!link_state.link && retrigger) {
1390 pl->mac_link_dropped = false;
1391 queue_work(system_power_efficient_wq, &pl->resolve);
1392 }
1393 mutex_unlock(&pl->state_mutex);
1394}
1395
1396static void phylink_run_resolve(struct phylink *pl)
1397{
1398 if (!pl->phylink_disable_state)
1399 queue_work(system_power_efficient_wq, &pl->resolve);
1400}
1401
1402static void phylink_run_resolve_and_disable(struct phylink *pl, int bit)
1403{
1404 unsigned long state = pl->phylink_disable_state;
1405
1406 set_bit(bit, &pl->phylink_disable_state);
1407 if (state == 0) {
1408 queue_work(system_power_efficient_wq, &pl->resolve);
1409 flush_work(&pl->resolve);
1410 }
1411}
1412
1413static void phylink_enable_and_run_resolve(struct phylink *pl, int bit)
1414{
1415 clear_bit(bit, &pl->phylink_disable_state);
1416 phylink_run_resolve(pl);
1417}
1418
1419static void phylink_fixed_poll(struct timer_list *t)
1420{
1421 struct phylink *pl = container_of(t, struct phylink, link_poll);
1422
1423 mod_timer(t, jiffies + HZ);
1424
1425 phylink_run_resolve(pl);
1426}
1427
1428static const struct sfp_upstream_ops sfp_phylink_ops;
1429
1430static int phylink_register_sfp(struct phylink *pl,
1431 struct fwnode_handle *fwnode)
1432{
1433 struct sfp_bus *bus;
1434 int ret;
1435
1436 if (!fwnode)
1437 return 0;
1438
1439 bus = sfp_bus_find_fwnode(fwnode);
1440 if (IS_ERR(bus)) {
1441 phylink_err(pl, "unable to attach SFP bus: %pe\n", bus);
1442 return PTR_ERR(bus);
1443 }
1444
1445 pl->sfp_bus = bus;
1446
1447 ret = sfp_bus_add_upstream(bus, pl, &sfp_phylink_ops);
1448 sfp_bus_put(bus);
1449
1450 return ret;
1451}
1452
1453/**
1454 * phylink_create() - create a phylink instance
1455 * @config: a pointer to the target &struct phylink_config
1456 * @fwnode: a pointer to a &struct fwnode_handle describing the network
1457 * interface
1458 * @iface: the desired link mode defined by &typedef phy_interface_t
1459 * @mac_ops: a pointer to a &struct phylink_mac_ops for the MAC.
1460 *
1461 * Create a new phylink instance, and parse the link parameters found in @np.
1462 * This will parse in-band modes, fixed-link or SFP configuration.
1463 *
1464 * Note: the rtnl lock must not be held when calling this function.
1465 *
1466 * Returns a pointer to a &struct phylink, or an error-pointer value. Users
1467 * must use IS_ERR() to check for errors from this function.
1468 */
1469struct phylink *phylink_create(struct phylink_config *config,
1470 struct fwnode_handle *fwnode,
1471 phy_interface_t iface,
1472 const struct phylink_mac_ops *mac_ops)
1473{
1474 bool using_mac_select_pcs = false;
1475 struct phylink *pl;
1476 int ret;
1477
1478 if (mac_ops->mac_select_pcs &&
1479 mac_ops->mac_select_pcs(config, PHY_INTERFACE_MODE_NA) !=
1480 ERR_PTR(-EOPNOTSUPP))
1481 using_mac_select_pcs = true;
1482
1483 /* Validate the supplied configuration */
1484 if (using_mac_select_pcs &&
1485 phy_interface_empty(config->supported_interfaces)) {
1486 dev_err(config->dev,
1487 "phylink: error: empty supported_interfaces but mac_select_pcs() method present\n");
1488 return ERR_PTR(-EINVAL);
1489 }
1490
1491 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
1492 if (!pl)
1493 return ERR_PTR(-ENOMEM);
1494
1495 mutex_init(&pl->state_mutex);
1496 INIT_WORK(&pl->resolve, phylink_resolve);
1497
1498 pl->config = config;
1499 if (config->type == PHYLINK_NETDEV) {
1500 pl->netdev = to_net_dev(config->dev);
1501 } else if (config->type == PHYLINK_DEV) {
1502 pl->dev = config->dev;
1503 } else {
1504 kfree(pl);
1505 return ERR_PTR(-EINVAL);
1506 }
1507
1508 pl->using_mac_select_pcs = using_mac_select_pcs;
1509 pl->phy_state.interface = iface;
1510 pl->link_interface = iface;
1511 if (iface == PHY_INTERFACE_MODE_MOCA)
1512 pl->link_port = PORT_BNC;
1513 else
1514 pl->link_port = PORT_MII;
1515 pl->link_config.interface = iface;
1516 pl->link_config.pause = MLO_PAUSE_AN;
1517 pl->link_config.speed = SPEED_UNKNOWN;
1518 pl->link_config.duplex = DUPLEX_UNKNOWN;
1519 pl->link_config.an_enabled = true;
1520 pl->mac_ops = mac_ops;
1521 __set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
1522 timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
1523
1524 bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
1525 linkmode_copy(pl->link_config.advertising, pl->supported);
1526 phylink_validate(pl, pl->supported, &pl->link_config);
1527
1528 ret = phylink_parse_mode(pl, fwnode);
1529 if (ret < 0) {
1530 kfree(pl);
1531 return ERR_PTR(ret);
1532 }
1533
1534 if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
1535 ret = phylink_parse_fixedlink(pl, fwnode);
1536 if (ret < 0) {
1537 kfree(pl);
1538 return ERR_PTR(ret);
1539 }
1540 }
1541
1542 pl->cur_link_an_mode = pl->cfg_link_an_mode;
1543
1544 ret = phylink_register_sfp(pl, fwnode);
1545 if (ret < 0) {
1546 kfree(pl);
1547 return ERR_PTR(ret);
1548 }
1549
1550 return pl;
1551}
1552EXPORT_SYMBOL_GPL(phylink_create);
1553
1554/**
1555 * phylink_destroy() - cleanup and destroy the phylink instance
1556 * @pl: a pointer to a &struct phylink returned from phylink_create()
1557 *
1558 * Destroy a phylink instance. Any PHY that has been attached must have been
1559 * cleaned up via phylink_disconnect_phy() prior to calling this function.
1560 *
1561 * Note: the rtnl lock must not be held when calling this function.
1562 */
1563void phylink_destroy(struct phylink *pl)
1564{
1565 sfp_bus_del_upstream(pl->sfp_bus);
1566 if (pl->link_gpio)
1567 gpiod_put(pl->link_gpio);
1568
1569 cancel_work_sync(&pl->resolve);
1570 kfree(pl);
1571}
1572EXPORT_SYMBOL_GPL(phylink_destroy);
1573
1574static void phylink_phy_change(struct phy_device *phydev, bool up)
1575{
1576 struct phylink *pl = phydev->phylink;
1577 bool tx_pause, rx_pause;
1578
1579 phy_get_pause(phydev, &tx_pause, &rx_pause);
1580
1581 mutex_lock(&pl->state_mutex);
1582 pl->phy_state.speed = phydev->speed;
1583 pl->phy_state.duplex = phydev->duplex;
1584 pl->phy_state.rate_matching = phydev->rate_matching;
1585 pl->phy_state.pause = MLO_PAUSE_NONE;
1586 if (tx_pause)
1587 pl->phy_state.pause |= MLO_PAUSE_TX;
1588 if (rx_pause)
1589 pl->phy_state.pause |= MLO_PAUSE_RX;
1590 pl->phy_state.interface = phydev->interface;
1591 pl->phy_state.link = up;
1592 mutex_unlock(&pl->state_mutex);
1593
1594 phylink_run_resolve(pl);
1595
1596 phylink_dbg(pl, "phy link %s %s/%s/%s/%s/%s\n", up ? "up" : "down",
1597 phy_modes(phydev->interface),
1598 phy_speed_to_str(phydev->speed),
1599 phy_duplex_to_str(phydev->duplex),
1600 phy_rate_matching_to_str(phydev->rate_matching),
1601 phylink_pause_to_str(pl->phy_state.pause));
1602}
1603
1604static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy,
1605 phy_interface_t interface)
1606{
1607 struct phylink_link_state config;
1608 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
1609 char *irq_str;
1610 int ret;
1611
1612 /*
1613 * This is the new way of dealing with flow control for PHYs,
1614 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
1615 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
1616 * using our validate call to the MAC, we rely upon the MAC
1617 * clearing the bits from both supported and advertising fields.
1618 */
1619 phy_support_asym_pause(phy);
1620
1621 memset(&config, 0, sizeof(config));
1622 linkmode_copy(supported, phy->supported);
1623 linkmode_copy(config.advertising, phy->advertising);
1624
1625 /* Check whether we would use rate matching for the proposed interface
1626 * mode.
1627 */
1628 config.rate_matching = phy_get_rate_matching(phy, interface);
1629
1630 /* Clause 45 PHYs may switch their Serdes lane between, e.g. 10GBASE-R,
1631 * 5GBASE-R, 2500BASE-X and SGMII if they are not using rate matching.
1632 * For some interface modes (e.g. RXAUI, XAUI and USXGMII) switching
1633 * their Serdes is either unnecessary or not reasonable.
1634 *
1635 * For these which switch interface modes, we really need to know which
1636 * interface modes the PHY supports to properly work out which ethtool
1637 * linkmodes can be supported. For now, as a work-around, we validate
1638 * against all interface modes, which may lead to more ethtool link
1639 * modes being advertised than are actually supported.
1640 */
1641 if (phy->is_c45 && config.rate_matching == RATE_MATCH_NONE &&
1642 interface != PHY_INTERFACE_MODE_RXAUI &&
1643 interface != PHY_INTERFACE_MODE_XAUI &&
1644 interface != PHY_INTERFACE_MODE_USXGMII)
1645 config.interface = PHY_INTERFACE_MODE_NA;
1646 else
1647 config.interface = interface;
1648
1649 ret = phylink_validate(pl, supported, &config);
1650 if (ret) {
1651 phylink_warn(pl, "validation of %s with support %*pb and advertisement %*pb failed: %pe\n",
1652 phy_modes(config.interface),
1653 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->supported,
1654 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising,
1655 ERR_PTR(ret));
1656 return ret;
1657 }
1658
1659 phy->phylink = pl;
1660 phy->phy_link_change = phylink_phy_change;
1661
1662 irq_str = phy_attached_info_irq(phy);
1663 phylink_info(pl,
1664 "PHY [%s] driver [%s] (irq=%s)\n",
1665 dev_name(&phy->mdio.dev), phy->drv->name, irq_str);
1666 kfree(irq_str);
1667
1668 mutex_lock(&phy->lock);
1669 mutex_lock(&pl->state_mutex);
1670 pl->phydev = phy;
1671 pl->phy_state.interface = interface;
1672 pl->phy_state.pause = MLO_PAUSE_NONE;
1673 pl->phy_state.speed = SPEED_UNKNOWN;
1674 pl->phy_state.duplex = DUPLEX_UNKNOWN;
1675 pl->phy_state.rate_matching = RATE_MATCH_NONE;
1676 linkmode_copy(pl->supported, supported);
1677 linkmode_copy(pl->link_config.advertising, config.advertising);
1678
1679 /* Restrict the phy advertisement according to the MAC support. */
1680 linkmode_copy(phy->advertising, config.advertising);
1681 mutex_unlock(&pl->state_mutex);
1682 mutex_unlock(&phy->lock);
1683
1684 phylink_dbg(pl,
1685 "phy: %s setting supported %*pb advertising %*pb\n",
1686 phy_modes(interface),
1687 __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
1688 __ETHTOOL_LINK_MODE_MASK_NBITS, phy->advertising);
1689
1690 if (phy_interrupt_is_valid(phy))
1691 phy_request_interrupt(phy);
1692
1693 if (pl->config->mac_managed_pm)
1694 phy->mac_managed_pm = true;
1695
1696 return 0;
1697}
1698
1699static int phylink_attach_phy(struct phylink *pl, struct phy_device *phy,
1700 phy_interface_t interface)
1701{
1702 if (WARN_ON(pl->cfg_link_an_mode == MLO_AN_FIXED ||
1703 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
1704 phy_interface_mode_is_8023z(interface) && !pl->sfp_bus)))
1705 return -EINVAL;
1706
1707 if (pl->phydev)
1708 return -EBUSY;
1709
1710 return phy_attach_direct(pl->netdev, phy, 0, interface);
1711}
1712
1713/**
1714 * phylink_connect_phy() - connect a PHY to the phylink instance
1715 * @pl: a pointer to a &struct phylink returned from phylink_create()
1716 * @phy: a pointer to a &struct phy_device.
1717 *
1718 * Connect @phy to the phylink instance specified by @pl by calling
1719 * phy_attach_direct(). Configure the @phy according to the MAC driver's
1720 * capabilities, start the PHYLIB state machine and enable any interrupts
1721 * that the PHY supports.
1722 *
1723 * This updates the phylink's ethtool supported and advertising link mode
1724 * masks.
1725 *
1726 * Returns 0 on success or a negative errno.
1727 */
1728int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
1729{
1730 int ret;
1731
1732 /* Use PHY device/driver interface */
1733 if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
1734 pl->link_interface = phy->interface;
1735 pl->link_config.interface = pl->link_interface;
1736 }
1737
1738 ret = phylink_attach_phy(pl, phy, pl->link_interface);
1739 if (ret < 0)
1740 return ret;
1741
1742 ret = phylink_bringup_phy(pl, phy, pl->link_config.interface);
1743 if (ret)
1744 phy_detach(phy);
1745
1746 return ret;
1747}
1748EXPORT_SYMBOL_GPL(phylink_connect_phy);
1749
1750/**
1751 * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
1752 * @pl: a pointer to a &struct phylink returned from phylink_create()
1753 * @dn: a pointer to a &struct device_node.
1754 * @flags: PHY-specific flags to communicate to the PHY device driver
1755 *
1756 * Connect the phy specified in the device node @dn to the phylink instance
1757 * specified by @pl. Actions specified in phylink_connect_phy() will be
1758 * performed.
1759 *
1760 * Returns 0 on success or a negative errno.
1761 */
1762int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
1763 u32 flags)
1764{
1765 return phylink_fwnode_phy_connect(pl, of_fwnode_handle(dn), flags);
1766}
1767EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
1768
1769/**
1770 * phylink_fwnode_phy_connect() - connect the PHY specified in the fwnode.
1771 * @pl: a pointer to a &struct phylink returned from phylink_create()
1772 * @fwnode: a pointer to a &struct fwnode_handle.
1773 * @flags: PHY-specific flags to communicate to the PHY device driver
1774 *
1775 * Connect the phy specified @fwnode to the phylink instance specified
1776 * by @pl.
1777 *
1778 * Returns 0 on success or a negative errno.
1779 */
1780int phylink_fwnode_phy_connect(struct phylink *pl,
1781 struct fwnode_handle *fwnode,
1782 u32 flags)
1783{
1784 struct fwnode_handle *phy_fwnode;
1785 struct phy_device *phy_dev;
1786 int ret;
1787
1788 /* Fixed links and 802.3z are handled without needing a PHY */
1789 if (pl->cfg_link_an_mode == MLO_AN_FIXED ||
1790 (pl->cfg_link_an_mode == MLO_AN_INBAND &&
1791 phy_interface_mode_is_8023z(pl->link_interface)))
1792 return 0;
1793
1794 phy_fwnode = fwnode_get_phy_node(fwnode);
1795 if (IS_ERR(phy_fwnode)) {
1796 if (pl->cfg_link_an_mode == MLO_AN_PHY)
1797 return -ENODEV;
1798 return 0;
1799 }
1800
1801 phy_dev = fwnode_phy_find_device(phy_fwnode);
1802 /* We're done with the phy_node handle */
1803 fwnode_handle_put(phy_fwnode);
1804 if (!phy_dev)
1805 return -ENODEV;
1806
1807 /* Use PHY device/driver interface */
1808 if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
1809 pl->link_interface = phy_dev->interface;
1810 pl->link_config.interface = pl->link_interface;
1811 }
1812
1813 ret = phy_attach_direct(pl->netdev, phy_dev, flags,
1814 pl->link_interface);
1815 phy_device_free(phy_dev);
1816 if (ret)
1817 return ret;
1818
1819 ret = phylink_bringup_phy(pl, phy_dev, pl->link_config.interface);
1820 if (ret)
1821 phy_detach(phy_dev);
1822
1823 return ret;
1824}
1825EXPORT_SYMBOL_GPL(phylink_fwnode_phy_connect);
1826
1827/**
1828 * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
1829 * instance.
1830 * @pl: a pointer to a &struct phylink returned from phylink_create()
1831 *
1832 * Disconnect any current PHY from the phylink instance described by @pl.
1833 */
1834void phylink_disconnect_phy(struct phylink *pl)
1835{
1836 struct phy_device *phy;
1837
1838 ASSERT_RTNL();
1839
1840 phy = pl->phydev;
1841 if (phy) {
1842 mutex_lock(&phy->lock);
1843 mutex_lock(&pl->state_mutex);
1844 pl->phydev = NULL;
1845 mutex_unlock(&pl->state_mutex);
1846 mutex_unlock(&phy->lock);
1847 flush_work(&pl->resolve);
1848
1849 phy_disconnect(phy);
1850 }
1851}
1852EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
1853
1854/**
1855 * phylink_mac_change() - notify phylink of a change in MAC state
1856 * @pl: a pointer to a &struct phylink returned from phylink_create()
1857 * @up: indicates whether the link is currently up.
1858 *
1859 * The MAC driver should call this driver when the state of its link
1860 * changes (eg, link failure, new negotiation results, etc.)
1861 */
1862void phylink_mac_change(struct phylink *pl, bool up)
1863{
1864 if (!up)
1865 pl->mac_link_dropped = true;
1866 phylink_run_resolve(pl);
1867 phylink_dbg(pl, "mac link %s\n", up ? "up" : "down");
1868}
1869EXPORT_SYMBOL_GPL(phylink_mac_change);
1870
1871static irqreturn_t phylink_link_handler(int irq, void *data)
1872{
1873 struct phylink *pl = data;
1874
1875 phylink_run_resolve(pl);
1876
1877 return IRQ_HANDLED;
1878}
1879
1880/**
1881 * phylink_start() - start a phylink instance
1882 * @pl: a pointer to a &struct phylink returned from phylink_create()
1883 *
1884 * Start the phylink instance specified by @pl, configuring the MAC for the
1885 * desired link mode(s) and negotiation style. This should be called from the
1886 * network device driver's &struct net_device_ops ndo_open() method.
1887 */
1888void phylink_start(struct phylink *pl)
1889{
1890 bool poll = false;
1891
1892 ASSERT_RTNL();
1893
1894 phylink_info(pl, "configuring for %s/%s link mode\n",
1895 phylink_an_mode_str(pl->cur_link_an_mode),
1896 phy_modes(pl->link_config.interface));
1897
1898 /* Always set the carrier off */
1899 if (pl->netdev)
1900 netif_carrier_off(pl->netdev);
1901
1902 /* Apply the link configuration to the MAC when starting. This allows
1903 * a fixed-link to start with the correct parameters, and also
1904 * ensures that we set the appropriate advertisement for Serdes links.
1905 *
1906 * Restart autonegotiation if using 802.3z to ensure that the link
1907 * parameters are properly negotiated. This is necessary for DSA
1908 * switches using 802.3z negotiation to ensure they see our modes.
1909 */
1910 phylink_mac_initial_config(pl, true);
1911
1912 phylink_enable_and_run_resolve(pl, PHYLINK_DISABLE_STOPPED);
1913
1914 if (pl->cfg_link_an_mode == MLO_AN_FIXED && pl->link_gpio) {
1915 int irq = gpiod_to_irq(pl->link_gpio);
1916
1917 if (irq > 0) {
1918 if (!request_irq(irq, phylink_link_handler,
1919 IRQF_TRIGGER_RISING |
1920 IRQF_TRIGGER_FALLING,
1921 "netdev link", pl))
1922 pl->link_irq = irq;
1923 else
1924 irq = 0;
1925 }
1926 if (irq <= 0)
1927 poll = true;
1928 }
1929
1930 switch (pl->cfg_link_an_mode) {
1931 case MLO_AN_FIXED:
1932 poll |= pl->config->poll_fixed_state;
1933 break;
1934 case MLO_AN_INBAND:
1935 if (pl->pcs)
1936 poll |= pl->pcs->poll;
1937 break;
1938 }
1939 if (poll)
1940 mod_timer(&pl->link_poll, jiffies + HZ);
1941 if (pl->phydev)
1942 phy_start(pl->phydev);
1943 if (pl->sfp_bus)
1944 sfp_upstream_start(pl->sfp_bus);
1945}
1946EXPORT_SYMBOL_GPL(phylink_start);
1947
1948/**
1949 * phylink_stop() - stop a phylink instance
1950 * @pl: a pointer to a &struct phylink returned from phylink_create()
1951 *
1952 * Stop the phylink instance specified by @pl. This should be called from the
1953 * network device driver's &struct net_device_ops ndo_stop() method. The
1954 * network device's carrier state should not be changed prior to calling this
1955 * function.
1956 *
1957 * This will synchronously bring down the link if the link is not already
1958 * down (in other words, it will trigger a mac_link_down() method call.)
1959 */
1960void phylink_stop(struct phylink *pl)
1961{
1962 ASSERT_RTNL();
1963
1964 if (pl->sfp_bus)
1965 sfp_upstream_stop(pl->sfp_bus);
1966 if (pl->phydev)
1967 phy_stop(pl->phydev);
1968 del_timer_sync(&pl->link_poll);
1969 if (pl->link_irq) {
1970 free_irq(pl->link_irq, pl);
1971 pl->link_irq = 0;
1972 }
1973
1974 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_STOPPED);
1975}
1976EXPORT_SYMBOL_GPL(phylink_stop);
1977
1978/**
1979 * phylink_suspend() - handle a network device suspend event
1980 * @pl: a pointer to a &struct phylink returned from phylink_create()
1981 * @mac_wol: true if the MAC needs to receive packets for Wake-on-Lan
1982 *
1983 * Handle a network device suspend event. There are several cases:
1984 *
1985 * - If Wake-on-Lan is not active, we can bring down the link between
1986 * the MAC and PHY by calling phylink_stop().
1987 * - If Wake-on-Lan is active, and being handled only by the PHY, we
1988 * can also bring down the link between the MAC and PHY.
1989 * - If Wake-on-Lan is active, but being handled by the MAC, the MAC
1990 * still needs to receive packets, so we can not bring the link down.
1991 */
1992void phylink_suspend(struct phylink *pl, bool mac_wol)
1993{
1994 ASSERT_RTNL();
1995
1996 if (mac_wol && (!pl->netdev || pl->netdev->wol_enabled)) {
1997 /* Wake-on-Lan enabled, MAC handling */
1998 mutex_lock(&pl->state_mutex);
1999
2000 /* Stop the resolver bringing the link up */
2001 __set_bit(PHYLINK_DISABLE_MAC_WOL, &pl->phylink_disable_state);
2002
2003 /* Disable the carrier, to prevent transmit timeouts,
2004 * but one would hope all packets have been sent. This
2005 * also means phylink_resolve() will do nothing.
2006 */
2007 if (pl->netdev)
2008 netif_carrier_off(pl->netdev);
2009 else
2010 pl->old_link_state = false;
2011
2012 /* We do not call mac_link_down() here as we want the
2013 * link to remain up to receive the WoL packets.
2014 */
2015 mutex_unlock(&pl->state_mutex);
2016 } else {
2017 phylink_stop(pl);
2018 }
2019}
2020EXPORT_SYMBOL_GPL(phylink_suspend);
2021
2022/**
2023 * phylink_resume() - handle a network device resume event
2024 * @pl: a pointer to a &struct phylink returned from phylink_create()
2025 *
2026 * Undo the effects of phylink_suspend(), returning the link to an
2027 * operational state.
2028 */
2029void phylink_resume(struct phylink *pl)
2030{
2031 ASSERT_RTNL();
2032
2033 if (test_bit(PHYLINK_DISABLE_MAC_WOL, &pl->phylink_disable_state)) {
2034 /* Wake-on-Lan enabled, MAC handling */
2035
2036 /* Call mac_link_down() so we keep the overall state balanced.
2037 * Do this under the state_mutex lock for consistency. This
2038 * will cause a "Link Down" message to be printed during
2039 * resume, which is harmless - the true link state will be
2040 * printed when we run a resolve.
2041 */
2042 mutex_lock(&pl->state_mutex);
2043 phylink_link_down(pl);
2044 mutex_unlock(&pl->state_mutex);
2045
2046 /* Re-apply the link parameters so that all the settings get
2047 * restored to the MAC.
2048 */
2049 phylink_mac_initial_config(pl, true);
2050
2051 /* Re-enable and re-resolve the link parameters */
2052 phylink_enable_and_run_resolve(pl, PHYLINK_DISABLE_MAC_WOL);
2053 } else {
2054 phylink_start(pl);
2055 }
2056}
2057EXPORT_SYMBOL_GPL(phylink_resume);
2058
2059/**
2060 * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
2061 * @pl: a pointer to a &struct phylink returned from phylink_create()
2062 * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
2063 *
2064 * Read the wake on lan parameters from the PHY attached to the phylink
2065 * instance specified by @pl. If no PHY is currently attached, report no
2066 * support for wake on lan.
2067 */
2068void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
2069{
2070 ASSERT_RTNL();
2071
2072 wol->supported = 0;
2073 wol->wolopts = 0;
2074
2075 if (pl->phydev)
2076 phy_ethtool_get_wol(pl->phydev, wol);
2077}
2078EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
2079
2080/**
2081 * phylink_ethtool_set_wol() - set wake on lan parameters
2082 * @pl: a pointer to a &struct phylink returned from phylink_create()
2083 * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
2084 *
2085 * Set the wake on lan parameters for the PHY attached to the phylink
2086 * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
2087 * error.
2088 *
2089 * Returns zero on success or negative errno code.
2090 */
2091int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
2092{
2093 int ret = -EOPNOTSUPP;
2094
2095 ASSERT_RTNL();
2096
2097 if (pl->phydev)
2098 ret = phy_ethtool_set_wol(pl->phydev, wol);
2099
2100 return ret;
2101}
2102EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
2103
2104static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
2105{
2106 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
2107
2108 linkmode_zero(mask);
2109 phylink_set_port_modes(mask);
2110
2111 linkmode_and(dst, dst, mask);
2112 linkmode_or(dst, dst, b);
2113}
2114
2115static void phylink_get_ksettings(const struct phylink_link_state *state,
2116 struct ethtool_link_ksettings *kset)
2117{
2118 phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
2119 linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
2120 if (kset->base.rate_matching == RATE_MATCH_NONE) {
2121 kset->base.speed = state->speed;
2122 kset->base.duplex = state->duplex;
2123 }
2124 kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
2125 AUTONEG_DISABLE;
2126}
2127
2128/**
2129 * phylink_ethtool_ksettings_get() - get the current link settings
2130 * @pl: a pointer to a &struct phylink returned from phylink_create()
2131 * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
2132 *
2133 * Read the current link settings for the phylink instance specified by @pl.
2134 * This will be the link settings read from the MAC, PHY or fixed link
2135 * settings depending on the current negotiation mode.
2136 */
2137int phylink_ethtool_ksettings_get(struct phylink *pl,
2138 struct ethtool_link_ksettings *kset)
2139{
2140 struct phylink_link_state link_state;
2141
2142 ASSERT_RTNL();
2143
2144 if (pl->phydev)
2145 phy_ethtool_ksettings_get(pl->phydev, kset);
2146 else
2147 kset->base.port = pl->link_port;
2148
2149 linkmode_copy(kset->link_modes.supported, pl->supported);
2150
2151 switch (pl->cur_link_an_mode) {
2152 case MLO_AN_FIXED:
2153 /* We are using fixed settings. Report these as the
2154 * current link settings - and note that these also
2155 * represent the supported speeds/duplex/pause modes.
2156 */
2157 phylink_get_fixed_state(pl, &link_state);
2158 phylink_get_ksettings(&link_state, kset);
2159 break;
2160
2161 case MLO_AN_INBAND:
2162 /* If there is a phy attached, then use the reported
2163 * settings from the phy with no modification.
2164 */
2165 if (pl->phydev)
2166 break;
2167
2168 phylink_mac_pcs_get_state(pl, &link_state);
2169
2170 /* The MAC is reporting the link results from its own PCS
2171 * layer via in-band status. Report these as the current
2172 * link settings.
2173 */
2174 phylink_get_ksettings(&link_state, kset);
2175 break;
2176 }
2177
2178 return 0;
2179}
2180EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
2181
2182/**
2183 * phylink_ethtool_ksettings_set() - set the link settings
2184 * @pl: a pointer to a &struct phylink returned from phylink_create()
2185 * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
2186 */
2187int phylink_ethtool_ksettings_set(struct phylink *pl,
2188 const struct ethtool_link_ksettings *kset)
2189{
2190 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
2191 struct phylink_link_state config;
2192 const struct phy_setting *s;
2193
2194 ASSERT_RTNL();
2195
2196 if (pl->phydev) {
2197 /* We can rely on phylib for this update; we also do not need
2198 * to update the pl->link_config settings:
2199 * - the configuration returned via ksettings_get() will come
2200 * from phylib whenever a PHY is present.
2201 * - link_config.interface will be updated by the PHY calling
2202 * back via phylink_phy_change() and a subsequent resolve.
2203 * - initial link configuration for PHY mode comes from the
2204 * last phy state updated via phylink_phy_change().
2205 * - other configuration changes (e.g. pause modes) are
2206 * performed directly via phylib.
2207 * - if in in-band mode with a PHY, the link configuration
2208 * is passed on the link from the PHY, and all of
2209 * link_config.{speed,duplex,an_enabled,pause} are not used.
2210 * - the only possible use would be link_config.advertising
2211 * pause modes when in 1000base-X mode with a PHY, but in
2212 * the presence of a PHY, this should not be changed as that
2213 * should be determined from the media side advertisement.
2214 */
2215 return phy_ethtool_ksettings_set(pl->phydev, kset);
2216 }
2217
2218 config = pl->link_config;
2219
2220 /* Mask out unsupported advertisements */
2221 linkmode_and(config.advertising, kset->link_modes.advertising,
2222 pl->supported);
2223
2224 /* FIXME: should we reject autoneg if phy/mac does not support it? */
2225 switch (kset->base.autoneg) {
2226 case AUTONEG_DISABLE:
2227 /* Autonegotiation disabled, select a suitable speed and
2228 * duplex.
2229 */
2230 s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
2231 pl->supported, false);
2232 if (!s)
2233 return -EINVAL;
2234
2235 /* If we have a fixed link, refuse to change link parameters.
2236 * If the link parameters match, accept them but do nothing.
2237 */
2238 if (pl->cur_link_an_mode == MLO_AN_FIXED) {
2239 if (s->speed != pl->link_config.speed ||
2240 s->duplex != pl->link_config.duplex)
2241 return -EINVAL;
2242 return 0;
2243 }
2244
2245 config.speed = s->speed;
2246 config.duplex = s->duplex;
2247 break;
2248
2249 case AUTONEG_ENABLE:
2250 /* If we have a fixed link, allow autonegotiation (since that
2251 * is our default case) but do not allow the advertisement to
2252 * be changed. If the advertisement matches, simply return.
2253 */
2254 if (pl->cur_link_an_mode == MLO_AN_FIXED) {
2255 if (!linkmode_equal(config.advertising,
2256 pl->link_config.advertising))
2257 return -EINVAL;
2258 return 0;
2259 }
2260
2261 config.speed = SPEED_UNKNOWN;
2262 config.duplex = DUPLEX_UNKNOWN;
2263 break;
2264
2265 default:
2266 return -EINVAL;
2267 }
2268
2269 /* We have ruled out the case with a PHY attached, and the
2270 * fixed-link cases. All that is left are in-band links.
2271 */
2272 config.an_enabled = kset->base.autoneg == AUTONEG_ENABLE;
2273 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising,
2274 config.an_enabled);
2275
2276 /* If this link is with an SFP, ensure that changes to advertised modes
2277 * also cause the associated interface to be selected such that the
2278 * link can be configured correctly.
2279 */
2280 if (pl->sfp_bus) {
2281 config.interface = sfp_select_interface(pl->sfp_bus,
2282 config.advertising);
2283 if (config.interface == PHY_INTERFACE_MODE_NA) {
2284 phylink_err(pl,
2285 "selection of interface failed, advertisement %*pb\n",
2286 __ETHTOOL_LINK_MODE_MASK_NBITS,
2287 config.advertising);
2288 return -EINVAL;
2289 }
2290
2291 /* Revalidate with the selected interface */
2292 linkmode_copy(support, pl->supported);
2293 if (phylink_validate(pl, support, &config)) {
2294 phylink_err(pl, "validation of %s/%s with support %*pb failed\n",
2295 phylink_an_mode_str(pl->cur_link_an_mode),
2296 phy_modes(config.interface),
2297 __ETHTOOL_LINK_MODE_MASK_NBITS, support);
2298 return -EINVAL;
2299 }
2300 } else {
2301 /* Validate without changing the current supported mask. */
2302 linkmode_copy(support, pl->supported);
2303 if (phylink_validate(pl, support, &config))
2304 return -EINVAL;
2305 }
2306
2307 /* If autonegotiation is enabled, we must have an advertisement */
2308 if (config.an_enabled && phylink_is_empty_linkmode(config.advertising))
2309 return -EINVAL;
2310
2311 mutex_lock(&pl->state_mutex);
2312 pl->link_config.speed = config.speed;
2313 pl->link_config.duplex = config.duplex;
2314 pl->link_config.an_enabled = config.an_enabled;
2315
2316 if (pl->link_config.interface != config.interface) {
2317 /* The interface changed, e.g. 1000base-X <-> 2500base-X */
2318 /* We need to force the link down, then change the interface */
2319 if (pl->old_link_state) {
2320 phylink_link_down(pl);
2321 pl->old_link_state = false;
2322 }
2323 if (!test_bit(PHYLINK_DISABLE_STOPPED,
2324 &pl->phylink_disable_state))
2325 phylink_major_config(pl, false, &config);
2326 pl->link_config.interface = config.interface;
2327 linkmode_copy(pl->link_config.advertising, config.advertising);
2328 } else if (!linkmode_equal(pl->link_config.advertising,
2329 config.advertising)) {
2330 linkmode_copy(pl->link_config.advertising, config.advertising);
2331 phylink_change_inband_advert(pl);
2332 }
2333 mutex_unlock(&pl->state_mutex);
2334
2335 return 0;
2336}
2337EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
2338
2339/**
2340 * phylink_ethtool_nway_reset() - restart negotiation
2341 * @pl: a pointer to a &struct phylink returned from phylink_create()
2342 *
2343 * Restart negotiation for the phylink instance specified by @pl. This will
2344 * cause any attached phy to restart negotiation with the link partner, and
2345 * if the MAC is in a BaseX mode, the MAC will also be requested to restart
2346 * negotiation.
2347 *
2348 * Returns zero on success, or negative error code.
2349 */
2350int phylink_ethtool_nway_reset(struct phylink *pl)
2351{
2352 int ret = 0;
2353
2354 ASSERT_RTNL();
2355
2356 if (pl->phydev)
2357 ret = phy_restart_aneg(pl->phydev);
2358 phylink_mac_pcs_an_restart(pl);
2359
2360 return ret;
2361}
2362EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
2363
2364/**
2365 * phylink_ethtool_get_pauseparam() - get the current pause parameters
2366 * @pl: a pointer to a &struct phylink returned from phylink_create()
2367 * @pause: a pointer to a &struct ethtool_pauseparam
2368 */
2369void phylink_ethtool_get_pauseparam(struct phylink *pl,
2370 struct ethtool_pauseparam *pause)
2371{
2372 ASSERT_RTNL();
2373
2374 pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
2375 pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
2376 pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
2377}
2378EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
2379
2380/**
2381 * phylink_ethtool_set_pauseparam() - set the current pause parameters
2382 * @pl: a pointer to a &struct phylink returned from phylink_create()
2383 * @pause: a pointer to a &struct ethtool_pauseparam
2384 */
2385int phylink_ethtool_set_pauseparam(struct phylink *pl,
2386 struct ethtool_pauseparam *pause)
2387{
2388 struct phylink_link_state *config = &pl->link_config;
2389 bool manual_changed;
2390 int pause_state;
2391
2392 ASSERT_RTNL();
2393
2394 if (pl->cur_link_an_mode == MLO_AN_FIXED)
2395 return -EOPNOTSUPP;
2396
2397 if (!phylink_test(pl->supported, Pause) &&
2398 !phylink_test(pl->supported, Asym_Pause))
2399 return -EOPNOTSUPP;
2400
2401 if (!phylink_test(pl->supported, Asym_Pause) &&
2402 pause->rx_pause != pause->tx_pause)
2403 return -EINVAL;
2404
2405 pause_state = 0;
2406 if (pause->autoneg)
2407 pause_state |= MLO_PAUSE_AN;
2408 if (pause->rx_pause)
2409 pause_state |= MLO_PAUSE_RX;
2410 if (pause->tx_pause)
2411 pause_state |= MLO_PAUSE_TX;
2412
2413 mutex_lock(&pl->state_mutex);
2414 /*
2415 * See the comments for linkmode_set_pause(), wrt the deficiencies
2416 * with the current implementation. A solution to this issue would
2417 * be:
2418 * ethtool Local device
2419 * rx tx Pause AsymDir
2420 * 0 0 0 0
2421 * 1 0 1 1
2422 * 0 1 0 1
2423 * 1 1 1 1
2424 * and then use the ethtool rx/tx enablement status to mask the
2425 * rx/tx pause resolution.
2426 */
2427 linkmode_set_pause(config->advertising, pause->tx_pause,
2428 pause->rx_pause);
2429
2430 manual_changed = (config->pause ^ pause_state) & MLO_PAUSE_AN ||
2431 (!(pause_state & MLO_PAUSE_AN) &&
2432 (config->pause ^ pause_state) & MLO_PAUSE_TXRX_MASK);
2433
2434 config->pause = pause_state;
2435
2436 /* Update our in-band advertisement, triggering a renegotiation if
2437 * the advertisement changed.
2438 */
2439 if (!pl->phydev)
2440 phylink_change_inband_advert(pl);
2441
2442 mutex_unlock(&pl->state_mutex);
2443
2444 /* If we have a PHY, a change of the pause frame advertisement will
2445 * cause phylib to renegotiate (if AN is enabled) which will in turn
2446 * call our phylink_phy_change() and trigger a resolve. Note that
2447 * we can't hold our state mutex while calling phy_set_asym_pause().
2448 */
2449 if (pl->phydev)
2450 phy_set_asym_pause(pl->phydev, pause->rx_pause,
2451 pause->tx_pause);
2452
2453 /* If the manual pause settings changed, make sure we trigger a
2454 * resolve to update their state; we can not guarantee that the
2455 * link will cycle.
2456 */
2457 if (manual_changed) {
2458 pl->mac_link_dropped = true;
2459 phylink_run_resolve(pl);
2460 }
2461
2462 return 0;
2463}
2464EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
2465
2466/**
2467 * phylink_get_eee_err() - read the energy efficient ethernet error
2468 * counter
2469 * @pl: a pointer to a &struct phylink returned from phylink_create().
2470 *
2471 * Read the Energy Efficient Ethernet error counter from the PHY associated
2472 * with the phylink instance specified by @pl.
2473 *
2474 * Returns positive error counter value, or negative error code.
2475 */
2476int phylink_get_eee_err(struct phylink *pl)
2477{
2478 int ret = 0;
2479
2480 ASSERT_RTNL();
2481
2482 if (pl->phydev)
2483 ret = phy_get_eee_err(pl->phydev);
2484
2485 return ret;
2486}
2487EXPORT_SYMBOL_GPL(phylink_get_eee_err);
2488
2489/**
2490 * phylink_init_eee() - init and check the EEE features
2491 * @pl: a pointer to a &struct phylink returned from phylink_create()
2492 * @clk_stop_enable: allow PHY to stop receive clock
2493 *
2494 * Must be called either with RTNL held or within mac_link_up()
2495 */
2496int phylink_init_eee(struct phylink *pl, bool clk_stop_enable)
2497{
2498 int ret = -EOPNOTSUPP;
2499
2500 if (pl->phydev)
2501 ret = phy_init_eee(pl->phydev, clk_stop_enable);
2502
2503 return ret;
2504}
2505EXPORT_SYMBOL_GPL(phylink_init_eee);
2506
2507/**
2508 * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
2509 * @pl: a pointer to a &struct phylink returned from phylink_create()
2510 * @eee: a pointer to a &struct ethtool_eee for the read parameters
2511 */
2512int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
2513{
2514 int ret = -EOPNOTSUPP;
2515
2516 ASSERT_RTNL();
2517
2518 if (pl->phydev)
2519 ret = phy_ethtool_get_eee(pl->phydev, eee);
2520
2521 return ret;
2522}
2523EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
2524
2525/**
2526 * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
2527 * @pl: a pointer to a &struct phylink returned from phylink_create()
2528 * @eee: a pointer to a &struct ethtool_eee for the desired parameters
2529 */
2530int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
2531{
2532 int ret = -EOPNOTSUPP;
2533
2534 ASSERT_RTNL();
2535
2536 if (pl->phydev)
2537 ret = phy_ethtool_set_eee(pl->phydev, eee);
2538
2539 return ret;
2540}
2541EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
2542
2543/* This emulates MII registers for a fixed-mode phy operating as per the
2544 * passed in state. "aneg" defines if we report negotiation is possible.
2545 *
2546 * FIXME: should deal with negotiation state too.
2547 */
2548static int phylink_mii_emul_read(unsigned int reg,
2549 struct phylink_link_state *state)
2550{
2551 struct fixed_phy_status fs;
2552 unsigned long *lpa = state->lp_advertising;
2553 int val;
2554
2555 fs.link = state->link;
2556 fs.speed = state->speed;
2557 fs.duplex = state->duplex;
2558 fs.pause = test_bit(ETHTOOL_LINK_MODE_Pause_BIT, lpa);
2559 fs.asym_pause = test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, lpa);
2560
2561 val = swphy_read_reg(reg, &fs);
2562 if (reg == MII_BMSR) {
2563 if (!state->an_complete)
2564 val &= ~BMSR_ANEGCOMPLETE;
2565 }
2566 return val;
2567}
2568
2569static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
2570 unsigned int reg)
2571{
2572 struct phy_device *phydev = pl->phydev;
2573 int prtad, devad;
2574
2575 if (mdio_phy_id_is_c45(phy_id)) {
2576 prtad = mdio_phy_id_prtad(phy_id);
2577 devad = mdio_phy_id_devad(phy_id);
2578 return mdiobus_c45_read(pl->phydev->mdio.bus, prtad, devad,
2579 reg);
2580 }
2581
2582 if (phydev->is_c45) {
2583 switch (reg) {
2584 case MII_BMCR:
2585 case MII_BMSR:
2586 case MII_PHYSID1:
2587 case MII_PHYSID2:
2588 devad = __ffs(phydev->c45_ids.mmds_present);
2589 break;
2590 case MII_ADVERTISE:
2591 case MII_LPA:
2592 if (!(phydev->c45_ids.mmds_present & MDIO_DEVS_AN))
2593 return -EINVAL;
2594 devad = MDIO_MMD_AN;
2595 if (reg == MII_ADVERTISE)
2596 reg = MDIO_AN_ADVERTISE;
2597 else
2598 reg = MDIO_AN_LPA;
2599 break;
2600 default:
2601 return -EINVAL;
2602 }
2603 prtad = phy_id;
2604 return mdiobus_c45_read(pl->phydev->mdio.bus, prtad, devad,
2605 reg);
2606 }
2607
2608 return mdiobus_read(pl->phydev->mdio.bus, phy_id, reg);
2609}
2610
2611static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
2612 unsigned int reg, unsigned int val)
2613{
2614 struct phy_device *phydev = pl->phydev;
2615 int prtad, devad;
2616
2617 if (mdio_phy_id_is_c45(phy_id)) {
2618 prtad = mdio_phy_id_prtad(phy_id);
2619 devad = mdio_phy_id_devad(phy_id);
2620 return mdiobus_c45_write(pl->phydev->mdio.bus, prtad, devad,
2621 reg, val);
2622 }
2623
2624 if (phydev->is_c45) {
2625 switch (reg) {
2626 case MII_BMCR:
2627 case MII_BMSR:
2628 case MII_PHYSID1:
2629 case MII_PHYSID2:
2630 devad = __ffs(phydev->c45_ids.mmds_present);
2631 break;
2632 case MII_ADVERTISE:
2633 case MII_LPA:
2634 if (!(phydev->c45_ids.mmds_present & MDIO_DEVS_AN))
2635 return -EINVAL;
2636 devad = MDIO_MMD_AN;
2637 if (reg == MII_ADVERTISE)
2638 reg = MDIO_AN_ADVERTISE;
2639 else
2640 reg = MDIO_AN_LPA;
2641 break;
2642 default:
2643 return -EINVAL;
2644 }
2645 return mdiobus_c45_write(pl->phydev->mdio.bus, phy_id, devad,
2646 reg, val);
2647 }
2648
2649 return mdiobus_write(phydev->mdio.bus, phy_id, reg, val);
2650}
2651
2652static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
2653 unsigned int reg)
2654{
2655 struct phylink_link_state state;
2656 int val = 0xffff;
2657
2658 switch (pl->cur_link_an_mode) {
2659 case MLO_AN_FIXED:
2660 if (phy_id == 0) {
2661 phylink_get_fixed_state(pl, &state);
2662 val = phylink_mii_emul_read(reg, &state);
2663 }
2664 break;
2665
2666 case MLO_AN_PHY:
2667 return -EOPNOTSUPP;
2668
2669 case MLO_AN_INBAND:
2670 if (phy_id == 0) {
2671 phylink_mac_pcs_get_state(pl, &state);
2672 val = phylink_mii_emul_read(reg, &state);
2673 }
2674 break;
2675 }
2676
2677 return val & 0xffff;
2678}
2679
2680static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
2681 unsigned int reg, unsigned int val)
2682{
2683 switch (pl->cur_link_an_mode) {
2684 case MLO_AN_FIXED:
2685 break;
2686
2687 case MLO_AN_PHY:
2688 return -EOPNOTSUPP;
2689
2690 case MLO_AN_INBAND:
2691 break;
2692 }
2693
2694 return 0;
2695}
2696
2697/**
2698 * phylink_mii_ioctl() - generic mii ioctl interface
2699 * @pl: a pointer to a &struct phylink returned from phylink_create()
2700 * @ifr: a pointer to a &struct ifreq for socket ioctls
2701 * @cmd: ioctl cmd to execute
2702 *
2703 * Perform the specified MII ioctl on the PHY attached to the phylink instance
2704 * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
2705 *
2706 * Returns: zero on success or negative error code.
2707 *
2708 * %SIOCGMIIPHY:
2709 * read register from the current PHY.
2710 * %SIOCGMIIREG:
2711 * read register from the specified PHY.
2712 * %SIOCSMIIREG:
2713 * set a register on the specified PHY.
2714 */
2715int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
2716{
2717 struct mii_ioctl_data *mii = if_mii(ifr);
2718 int ret;
2719
2720 ASSERT_RTNL();
2721
2722 if (pl->phydev) {
2723 /* PHYs only exist for MLO_AN_PHY and SGMII */
2724 switch (cmd) {
2725 case SIOCGMIIPHY:
2726 mii->phy_id = pl->phydev->mdio.addr;
2727 fallthrough;
2728
2729 case SIOCGMIIREG:
2730 ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
2731 if (ret >= 0) {
2732 mii->val_out = ret;
2733 ret = 0;
2734 }
2735 break;
2736
2737 case SIOCSMIIREG:
2738 ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
2739 mii->val_in);
2740 break;
2741
2742 default:
2743 ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
2744 break;
2745 }
2746 } else {
2747 switch (cmd) {
2748 case SIOCGMIIPHY:
2749 mii->phy_id = 0;
2750 fallthrough;
2751
2752 case SIOCGMIIREG:
2753 ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
2754 if (ret >= 0) {
2755 mii->val_out = ret;
2756 ret = 0;
2757 }
2758 break;
2759
2760 case SIOCSMIIREG:
2761 ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
2762 mii->val_in);
2763 break;
2764
2765 default:
2766 ret = -EOPNOTSUPP;
2767 break;
2768 }
2769 }
2770
2771 return ret;
2772}
2773EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
2774
2775/**
2776 * phylink_speed_down() - set the non-SFP PHY to lowest speed supported by both
2777 * link partners
2778 * @pl: a pointer to a &struct phylink returned from phylink_create()
2779 * @sync: perform action synchronously
2780 *
2781 * If we have a PHY that is not part of a SFP module, then set the speed
2782 * as described in the phy_speed_down() function. Please see this function
2783 * for a description of the @sync parameter.
2784 *
2785 * Returns zero if there is no PHY, otherwise as per phy_speed_down().
2786 */
2787int phylink_speed_down(struct phylink *pl, bool sync)
2788{
2789 int ret = 0;
2790
2791 ASSERT_RTNL();
2792
2793 if (!pl->sfp_bus && pl->phydev)
2794 ret = phy_speed_down(pl->phydev, sync);
2795
2796 return ret;
2797}
2798EXPORT_SYMBOL_GPL(phylink_speed_down);
2799
2800/**
2801 * phylink_speed_up() - restore the advertised speeds prior to the call to
2802 * phylink_speed_down()
2803 * @pl: a pointer to a &struct phylink returned from phylink_create()
2804 *
2805 * If we have a PHY that is not part of a SFP module, then restore the
2806 * PHY speeds as per phy_speed_up().
2807 *
2808 * Returns zero if there is no PHY, otherwise as per phy_speed_up().
2809 */
2810int phylink_speed_up(struct phylink *pl)
2811{
2812 int ret = 0;
2813
2814 ASSERT_RTNL();
2815
2816 if (!pl->sfp_bus && pl->phydev)
2817 ret = phy_speed_up(pl->phydev);
2818
2819 return ret;
2820}
2821EXPORT_SYMBOL_GPL(phylink_speed_up);
2822
2823static void phylink_sfp_attach(void *upstream, struct sfp_bus *bus)
2824{
2825 struct phylink *pl = upstream;
2826
2827 pl->netdev->sfp_bus = bus;
2828}
2829
2830static void phylink_sfp_detach(void *upstream, struct sfp_bus *bus)
2831{
2832 struct phylink *pl = upstream;
2833
2834 pl->netdev->sfp_bus = NULL;
2835}
2836
2837static const phy_interface_t phylink_sfp_interface_preference[] = {
2838 PHY_INTERFACE_MODE_25GBASER,
2839 PHY_INTERFACE_MODE_USXGMII,
2840 PHY_INTERFACE_MODE_10GBASER,
2841 PHY_INTERFACE_MODE_5GBASER,
2842 PHY_INTERFACE_MODE_2500BASEX,
2843 PHY_INTERFACE_MODE_SGMII,
2844 PHY_INTERFACE_MODE_1000BASEX,
2845 PHY_INTERFACE_MODE_100BASEX,
2846};
2847
2848static DECLARE_PHY_INTERFACE_MASK(phylink_sfp_interfaces);
2849
2850static phy_interface_t phylink_choose_sfp_interface(struct phylink *pl,
2851 const unsigned long *intf)
2852{
2853 phy_interface_t interface;
2854 size_t i;
2855
2856 interface = PHY_INTERFACE_MODE_NA;
2857 for (i = 0; i < ARRAY_SIZE(phylink_sfp_interface_preference); i++)
2858 if (test_bit(phylink_sfp_interface_preference[i], intf)) {
2859 interface = phylink_sfp_interface_preference[i];
2860 break;
2861 }
2862
2863 return interface;
2864}
2865
2866static void phylink_sfp_set_config(struct phylink *pl, u8 mode,
2867 unsigned long *supported,
2868 struct phylink_link_state *state)
2869{
2870 bool changed = false;
2871
2872 phylink_dbg(pl, "requesting link mode %s/%s with support %*pb\n",
2873 phylink_an_mode_str(mode), phy_modes(state->interface),
2874 __ETHTOOL_LINK_MODE_MASK_NBITS, supported);
2875
2876 if (!linkmode_equal(pl->supported, supported)) {
2877 linkmode_copy(pl->supported, supported);
2878 changed = true;
2879 }
2880
2881 if (!linkmode_equal(pl->link_config.advertising, state->advertising)) {
2882 linkmode_copy(pl->link_config.advertising, state->advertising);
2883 changed = true;
2884 }
2885
2886 if (pl->cur_link_an_mode != mode ||
2887 pl->link_config.interface != state->interface) {
2888 pl->cur_link_an_mode = mode;
2889 pl->link_config.interface = state->interface;
2890
2891 changed = true;
2892
2893 phylink_info(pl, "switched to %s/%s link mode\n",
2894 phylink_an_mode_str(mode),
2895 phy_modes(state->interface));
2896 }
2897
2898 if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
2899 &pl->phylink_disable_state))
2900 phylink_mac_initial_config(pl, false);
2901}
2902
2903static int phylink_sfp_config_phy(struct phylink *pl, u8 mode,
2904 struct phy_device *phy)
2905{
2906 __ETHTOOL_DECLARE_LINK_MODE_MASK(support1);
2907 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
2908 struct phylink_link_state config;
2909 phy_interface_t iface;
2910 int ret;
2911
2912 linkmode_copy(support, phy->supported);
2913
2914 memset(&config, 0, sizeof(config));
2915 linkmode_copy(config.advertising, phy->advertising);
2916 config.interface = PHY_INTERFACE_MODE_NA;
2917 config.speed = SPEED_UNKNOWN;
2918 config.duplex = DUPLEX_UNKNOWN;
2919 config.pause = MLO_PAUSE_AN;
2920 config.an_enabled = pl->link_config.an_enabled;
2921
2922 /* Ignore errors if we're expecting a PHY to attach later */
2923 ret = phylink_validate(pl, support, &config);
2924 if (ret) {
2925 phylink_err(pl, "validation with support %*pb failed: %pe\n",
2926 __ETHTOOL_LINK_MODE_MASK_NBITS, support,
2927 ERR_PTR(ret));
2928 return ret;
2929 }
2930
2931 iface = sfp_select_interface(pl->sfp_bus, config.advertising);
2932 if (iface == PHY_INTERFACE_MODE_NA) {
2933 phylink_err(pl,
2934 "selection of interface failed, advertisement %*pb\n",
2935 __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
2936 return -EINVAL;
2937 }
2938
2939 config.interface = iface;
2940 linkmode_copy(support1, support);
2941 ret = phylink_validate(pl, support1, &config);
2942 if (ret) {
2943 phylink_err(pl,
2944 "validation of %s/%s with support %*pb failed: %pe\n",
2945 phylink_an_mode_str(mode),
2946 phy_modes(config.interface),
2947 __ETHTOOL_LINK_MODE_MASK_NBITS, support,
2948 ERR_PTR(ret));
2949 return ret;
2950 }
2951
2952 pl->link_port = pl->sfp_port;
2953
2954 phylink_sfp_set_config(pl, mode, support, &config);
2955
2956 return 0;
2957}
2958
2959static int phylink_sfp_config_optical(struct phylink *pl)
2960{
2961 __ETHTOOL_DECLARE_LINK_MODE_MASK(support);
2962 DECLARE_PHY_INTERFACE_MASK(interfaces);
2963 struct phylink_link_state config;
2964 phy_interface_t interface;
2965 int ret;
2966
2967 phylink_dbg(pl, "optical SFP: interfaces=[mac=%*pbl, sfp=%*pbl]\n",
2968 (int)PHY_INTERFACE_MODE_MAX,
2969 pl->config->supported_interfaces,
2970 (int)PHY_INTERFACE_MODE_MAX,
2971 pl->sfp_interfaces);
2972
2973 /* Find the union of the supported interfaces by the PCS/MAC and
2974 * the SFP module.
2975 */
2976 phy_interface_and(interfaces, pl->config->supported_interfaces,
2977 pl->sfp_interfaces);
2978 if (phy_interface_empty(interfaces)) {
2979 phylink_err(pl, "unsupported SFP module: no common interface modes\n");
2980 return -EINVAL;
2981 }
2982
2983 memset(&config, 0, sizeof(config));
2984 linkmode_copy(support, pl->sfp_support);
2985 linkmode_copy(config.advertising, pl->sfp_support);
2986 config.speed = SPEED_UNKNOWN;
2987 config.duplex = DUPLEX_UNKNOWN;
2988 config.pause = MLO_PAUSE_AN;
2989 config.an_enabled = true;
2990
2991 /* For all the interfaces that are supported, reduce the sfp_support
2992 * mask to only those link modes that can be supported.
2993 */
2994 ret = phylink_validate_mask(pl, pl->sfp_support, &config, interfaces);
2995 if (ret) {
2996 phylink_err(pl, "unsupported SFP module: validation with support %*pb failed\n",
2997 __ETHTOOL_LINK_MODE_MASK_NBITS, support);
2998 return ret;
2999 }
3000
3001 interface = phylink_choose_sfp_interface(pl, interfaces);
3002 if (interface == PHY_INTERFACE_MODE_NA) {
3003 phylink_err(pl, "failed to select SFP interface\n");
3004 return -EINVAL;
3005 }
3006
3007 phylink_dbg(pl, "optical SFP: chosen %s interface\n",
3008 phy_modes(interface));
3009
3010 config.interface = interface;
3011
3012 /* Ignore errors if we're expecting a PHY to attach later */
3013 ret = phylink_validate(pl, support, &config);
3014 if (ret) {
3015 phylink_err(pl, "validation with support %*pb failed: %pe\n",
3016 __ETHTOOL_LINK_MODE_MASK_NBITS, support,
3017 ERR_PTR(ret));
3018 return ret;
3019 }
3020
3021 pl->link_port = pl->sfp_port;
3022
3023 phylink_sfp_set_config(pl, MLO_AN_INBAND, pl->sfp_support, &config);
3024
3025 return 0;
3026}
3027
3028static int phylink_sfp_module_insert(void *upstream,
3029 const struct sfp_eeprom_id *id)
3030{
3031 struct phylink *pl = upstream;
3032
3033 ASSERT_RTNL();
3034
3035 linkmode_zero(pl->sfp_support);
3036 phy_interface_zero(pl->sfp_interfaces);
3037 sfp_parse_support(pl->sfp_bus, id, pl->sfp_support, pl->sfp_interfaces);
3038 pl->sfp_port = sfp_parse_port(pl->sfp_bus, id, pl->sfp_support);
3039
3040 /* If this module may have a PHY connecting later, defer until later */
3041 pl->sfp_may_have_phy = sfp_may_have_phy(pl->sfp_bus, id);
3042 if (pl->sfp_may_have_phy)
3043 return 0;
3044
3045 return phylink_sfp_config_optical(pl);
3046}
3047
3048static int phylink_sfp_module_start(void *upstream)
3049{
3050 struct phylink *pl = upstream;
3051
3052 /* If this SFP module has a PHY, start the PHY now. */
3053 if (pl->phydev) {
3054 phy_start(pl->phydev);
3055 return 0;
3056 }
3057
3058 /* If the module may have a PHY but we didn't detect one we
3059 * need to configure the MAC here.
3060 */
3061 if (!pl->sfp_may_have_phy)
3062 return 0;
3063
3064 return phylink_sfp_config_optical(pl);
3065}
3066
3067static void phylink_sfp_module_stop(void *upstream)
3068{
3069 struct phylink *pl = upstream;
3070
3071 /* If this SFP module has a PHY, stop it. */
3072 if (pl->phydev)
3073 phy_stop(pl->phydev);
3074}
3075
3076static void phylink_sfp_link_down(void *upstream)
3077{
3078 struct phylink *pl = upstream;
3079
3080 ASSERT_RTNL();
3081
3082 phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_LINK);
3083}
3084
3085static void phylink_sfp_link_up(void *upstream)
3086{
3087 struct phylink *pl = upstream;
3088
3089 ASSERT_RTNL();
3090
3091 phylink_enable_and_run_resolve(pl, PHYLINK_DISABLE_LINK);
3092}
3093
3094/* The Broadcom BCM84881 in the Methode DM7052 is unable to provide a SGMII
3095 * or 802.3z control word, so inband will not work.
3096 */
3097static bool phylink_phy_no_inband(struct phy_device *phy)
3098{
3099 return phy->is_c45 &&
3100 (phy->c45_ids.device_ids[1] & 0xfffffff0) == 0xae025150;
3101}
3102
3103static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
3104{
3105 struct phylink *pl = upstream;
3106 phy_interface_t interface;
3107 u8 mode;
3108 int ret;
3109
3110 /*
3111 * This is the new way of dealing with flow control for PHYs,
3112 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
3113 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
3114 * using our validate call to the MAC, we rely upon the MAC
3115 * clearing the bits from both supported and advertising fields.
3116 */
3117 phy_support_asym_pause(phy);
3118
3119 if (phylink_phy_no_inband(phy))
3120 mode = MLO_AN_PHY;
3121 else
3122 mode = MLO_AN_INBAND;
3123
3124 /* Set the PHY's host supported interfaces */
3125 phy_interface_and(phy->host_interfaces, phylink_sfp_interfaces,
3126 pl->config->supported_interfaces);
3127
3128 /* Do the initial configuration */
3129 ret = phylink_sfp_config_phy(pl, mode, phy);
3130 if (ret < 0)
3131 return ret;
3132
3133 interface = pl->link_config.interface;
3134 ret = phylink_attach_phy(pl, phy, interface);
3135 if (ret < 0)
3136 return ret;
3137
3138 ret = phylink_bringup_phy(pl, phy, interface);
3139 if (ret)
3140 phy_detach(phy);
3141
3142 return ret;
3143}
3144
3145static void phylink_sfp_disconnect_phy(void *upstream)
3146{
3147 phylink_disconnect_phy(upstream);
3148}
3149
3150static const struct sfp_upstream_ops sfp_phylink_ops = {
3151 .attach = phylink_sfp_attach,
3152 .detach = phylink_sfp_detach,
3153 .module_insert = phylink_sfp_module_insert,
3154 .module_start = phylink_sfp_module_start,
3155 .module_stop = phylink_sfp_module_stop,
3156 .link_up = phylink_sfp_link_up,
3157 .link_down = phylink_sfp_link_down,
3158 .connect_phy = phylink_sfp_connect_phy,
3159 .disconnect_phy = phylink_sfp_disconnect_phy,
3160};
3161
3162/* Helpers for MAC drivers */
3163
3164static void phylink_decode_c37_word(struct phylink_link_state *state,
3165 uint16_t config_reg, int speed)
3166{
3167 bool tx_pause, rx_pause;
3168 int fd_bit;
3169
3170 if (speed == SPEED_2500)
3171 fd_bit = ETHTOOL_LINK_MODE_2500baseX_Full_BIT;
3172 else
3173 fd_bit = ETHTOOL_LINK_MODE_1000baseX_Full_BIT;
3174
3175 mii_lpa_mod_linkmode_x(state->lp_advertising, config_reg, fd_bit);
3176
3177 if (linkmode_test_bit(fd_bit, state->advertising) &&
3178 linkmode_test_bit(fd_bit, state->lp_advertising)) {
3179 state->speed = speed;
3180 state->duplex = DUPLEX_FULL;
3181 } else {
3182 /* negotiation failure */
3183 state->link = false;
3184 }
3185
3186 linkmode_resolve_pause(state->advertising, state->lp_advertising,
3187 &tx_pause, &rx_pause);
3188
3189 if (tx_pause)
3190 state->pause |= MLO_PAUSE_TX;
3191 if (rx_pause)
3192 state->pause |= MLO_PAUSE_RX;
3193}
3194
3195static void phylink_decode_sgmii_word(struct phylink_link_state *state,
3196 uint16_t config_reg)
3197{
3198 if (!(config_reg & LPA_SGMII_LINK)) {
3199 state->link = false;
3200 return;
3201 }
3202
3203 switch (config_reg & LPA_SGMII_SPD_MASK) {
3204 case LPA_SGMII_10:
3205 state->speed = SPEED_10;
3206 break;
3207 case LPA_SGMII_100:
3208 state->speed = SPEED_100;
3209 break;
3210 case LPA_SGMII_1000:
3211 state->speed = SPEED_1000;
3212 break;
3213 default:
3214 state->link = false;
3215 return;
3216 }
3217 if (config_reg & LPA_SGMII_FULL_DUPLEX)
3218 state->duplex = DUPLEX_FULL;
3219 else
3220 state->duplex = DUPLEX_HALF;
3221}
3222
3223/**
3224 * phylink_decode_usxgmii_word() - decode the USXGMII word from a MAC PCS
3225 * @state: a pointer to a struct phylink_link_state.
3226 * @lpa: a 16 bit value which stores the USXGMII auto-negotiation word
3227 *
3228 * Helper for MAC PCS supporting the USXGMII protocol and the auto-negotiation
3229 * code word. Decode the USXGMII code word and populate the corresponding fields
3230 * (speed, duplex) into the phylink_link_state structure.
3231 */
3232void phylink_decode_usxgmii_word(struct phylink_link_state *state,
3233 uint16_t lpa)
3234{
3235 switch (lpa & MDIO_USXGMII_SPD_MASK) {
3236 case MDIO_USXGMII_10:
3237 state->speed = SPEED_10;
3238 break;
3239 case MDIO_USXGMII_100:
3240 state->speed = SPEED_100;
3241 break;
3242 case MDIO_USXGMII_1000:
3243 state->speed = SPEED_1000;
3244 break;
3245 case MDIO_USXGMII_2500:
3246 state->speed = SPEED_2500;
3247 break;
3248 case MDIO_USXGMII_5000:
3249 state->speed = SPEED_5000;
3250 break;
3251 case MDIO_USXGMII_10G:
3252 state->speed = SPEED_10000;
3253 break;
3254 default:
3255 state->link = false;
3256 return;
3257 }
3258
3259 if (lpa & MDIO_USXGMII_FULL_DUPLEX)
3260 state->duplex = DUPLEX_FULL;
3261 else
3262 state->duplex = DUPLEX_HALF;
3263}
3264EXPORT_SYMBOL_GPL(phylink_decode_usxgmii_word);
3265
3266/**
3267 * phylink_mii_c22_pcs_decode_state() - Decode MAC PCS state from MII registers
3268 * @state: a pointer to a &struct phylink_link_state.
3269 * @bmsr: The value of the %MII_BMSR register
3270 * @lpa: The value of the %MII_LPA register
3271 *
3272 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
3273 * clause 37 negotiation and/or SGMII control.
3274 *
3275 * Parse the Clause 37 or Cisco SGMII link partner negotiation word into
3276 * the phylink @state structure. This is suitable to be used for implementing
3277 * the mac_pcs_get_state() member of the struct phylink_mac_ops structure if
3278 * accessing @bmsr and @lpa cannot be done with MDIO directly.
3279 */
3280void phylink_mii_c22_pcs_decode_state(struct phylink_link_state *state,
3281 u16 bmsr, u16 lpa)
3282{
3283 state->link = !!(bmsr & BMSR_LSTATUS);
3284 state->an_complete = !!(bmsr & BMSR_ANEGCOMPLETE);
3285 /* If there is no link or autonegotiation is disabled, the LP advertisement
3286 * data is not meaningful, so don't go any further.
3287 */
3288 if (!state->link || !state->an_enabled)
3289 return;
3290
3291 switch (state->interface) {
3292 case PHY_INTERFACE_MODE_1000BASEX:
3293 phylink_decode_c37_word(state, lpa, SPEED_1000);
3294 break;
3295
3296 case PHY_INTERFACE_MODE_2500BASEX:
3297 phylink_decode_c37_word(state, lpa, SPEED_2500);
3298 break;
3299
3300 case PHY_INTERFACE_MODE_SGMII:
3301 case PHY_INTERFACE_MODE_QSGMII:
3302 case PHY_INTERFACE_MODE_QUSGMII:
3303 phylink_decode_sgmii_word(state, lpa);
3304 break;
3305
3306 default:
3307 state->link = false;
3308 break;
3309 }
3310}
3311EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_decode_state);
3312
3313/**
3314 * phylink_mii_c22_pcs_get_state() - read the MAC PCS state
3315 * @pcs: a pointer to a &struct mdio_device.
3316 * @state: a pointer to a &struct phylink_link_state.
3317 *
3318 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
3319 * clause 37 negotiation and/or SGMII control.
3320 *
3321 * Read the MAC PCS state from the MII device configured in @config and
3322 * parse the Clause 37 or Cisco SGMII link partner negotiation word into
3323 * the phylink @state structure. This is suitable to be directly plugged
3324 * into the mac_pcs_get_state() member of the struct phylink_mac_ops
3325 * structure.
3326 */
3327void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
3328 struct phylink_link_state *state)
3329{
3330 int bmsr, lpa;
3331
3332 bmsr = mdiodev_read(pcs, MII_BMSR);
3333 lpa = mdiodev_read(pcs, MII_LPA);
3334 if (bmsr < 0 || lpa < 0) {
3335 state->link = false;
3336 return;
3337 }
3338
3339 phylink_mii_c22_pcs_decode_state(state, bmsr, lpa);
3340}
3341EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_get_state);
3342
3343/**
3344 * phylink_mii_c22_pcs_encode_advertisement() - configure the clause 37 PCS
3345 * advertisement
3346 * @interface: the PHY interface mode being configured
3347 * @advertising: the ethtool advertisement mask
3348 *
3349 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
3350 * clause 37 negotiation and/or SGMII control.
3351 *
3352 * Encode the clause 37 PCS advertisement as specified by @interface and
3353 * @advertising.
3354 *
3355 * Return: The new value for @adv, or ``-EINVAL`` if it should not be changed.
3356 */
3357int phylink_mii_c22_pcs_encode_advertisement(phy_interface_t interface,
3358 const unsigned long *advertising)
3359{
3360 u16 adv;
3361
3362 switch (interface) {
3363 case PHY_INTERFACE_MODE_1000BASEX:
3364 case PHY_INTERFACE_MODE_2500BASEX:
3365 adv = ADVERTISE_1000XFULL;
3366 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3367 advertising))
3368 adv |= ADVERTISE_1000XPAUSE;
3369 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3370 advertising))
3371 adv |= ADVERTISE_1000XPSE_ASYM;
3372 return adv;
3373 case PHY_INTERFACE_MODE_SGMII:
3374 case PHY_INTERFACE_MODE_QSGMII:
3375 return 0x0001;
3376 default:
3377 /* Nothing to do for other modes */
3378 return -EINVAL;
3379 }
3380}
3381EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_encode_advertisement);
3382
3383/**
3384 * phylink_mii_c22_pcs_config() - configure clause 22 PCS
3385 * @pcs: a pointer to a &struct mdio_device.
3386 * @mode: link autonegotiation mode
3387 * @interface: the PHY interface mode being configured
3388 * @advertising: the ethtool advertisement mask
3389 *
3390 * Configure a Clause 22 PCS PHY with the appropriate negotiation
3391 * parameters for the @mode, @interface and @advertising parameters.
3392 * Returns negative error number on failure, zero if the advertisement
3393 * has not changed, or positive if there is a change.
3394 */
3395int phylink_mii_c22_pcs_config(struct mdio_device *pcs, unsigned int mode,
3396 phy_interface_t interface,
3397 const unsigned long *advertising)
3398{
3399 bool changed = 0;
3400 u16 bmcr;
3401 int ret, adv;
3402
3403 adv = phylink_mii_c22_pcs_encode_advertisement(interface, advertising);
3404 if (adv >= 0) {
3405 ret = mdiobus_modify_changed(pcs->bus, pcs->addr,
3406 MII_ADVERTISE, 0xffff, adv);
3407 if (ret < 0)
3408 return ret;
3409 changed = ret;
3410 }
3411
3412 /* Ensure ISOLATE bit is disabled */
3413 if (mode == MLO_AN_INBAND &&
3414 (interface == PHY_INTERFACE_MODE_SGMII ||
3415 interface == PHY_INTERFACE_MODE_QSGMII ||
3416 linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, advertising)))
3417 bmcr = BMCR_ANENABLE;
3418 else
3419 bmcr = 0;
3420
3421 ret = mdiodev_modify(pcs, MII_BMCR, BMCR_ANENABLE | BMCR_ISOLATE, bmcr);
3422 if (ret < 0)
3423 return ret;
3424
3425 return changed;
3426}
3427EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_config);
3428
3429/**
3430 * phylink_mii_c22_pcs_an_restart() - restart 802.3z autonegotiation
3431 * @pcs: a pointer to a &struct mdio_device.
3432 *
3433 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
3434 * clause 37 negotiation.
3435 *
3436 * Restart the clause 37 negotiation with the link partner. This is
3437 * suitable to be directly plugged into the mac_pcs_get_state() member
3438 * of the struct phylink_mac_ops structure.
3439 */
3440void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs)
3441{
3442 int val = mdiodev_read(pcs, MII_BMCR);
3443
3444 if (val >= 0) {
3445 val |= BMCR_ANRESTART;
3446
3447 mdiodev_write(pcs, MII_BMCR, val);
3448 }
3449}
3450EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_an_restart);
3451
3452void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
3453 struct phylink_link_state *state)
3454{
3455 struct mii_bus *bus = pcs->bus;
3456 int addr = pcs->addr;
3457 int stat;
3458
3459 stat = mdiobus_c45_read(bus, addr, MDIO_MMD_PCS, MDIO_STAT1);
3460 if (stat < 0) {
3461 state->link = false;
3462 return;
3463 }
3464
3465 state->link = !!(stat & MDIO_STAT1_LSTATUS);
3466 if (!state->link)
3467 return;
3468
3469 switch (state->interface) {
3470 case PHY_INTERFACE_MODE_10GBASER:
3471 state->speed = SPEED_10000;
3472 state->duplex = DUPLEX_FULL;
3473 break;
3474
3475 default:
3476 break;
3477 }
3478}
3479EXPORT_SYMBOL_GPL(phylink_mii_c45_pcs_get_state);
3480
3481static int __init phylink_init(void)
3482{
3483 for (int i = 0; i < ARRAY_SIZE(phylink_sfp_interface_preference); ++i)
3484 __set_bit(phylink_sfp_interface_preference[i],
3485 phylink_sfp_interfaces);
3486
3487 return 0;
3488}
3489
3490module_init(phylink_init);
3491
3492MODULE_LICENSE("GPL v2");