1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for configuring and reading PHY devices
3 * Based on code in sungem_phy.c and gianfar_phy.c
4 *
5 * Author: Andy Fleming
6 *
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 * Copyright (c) 2006, 2007 Maciej W. Rozycki
9 */
10
11 #include <linux/kernel.h>
12 #include <linux/string.h>
13 #include <linux/errno.h>
14 #include <linux/unistd.h>
15 #include <linux/interrupt.h>
16 #include <linux/delay.h>
17 #include <linux/netdevice.h>
18 #include <linux/netlink.h>
19 #include <linux/etherdevice.h>
20 #include <linux/skbuff.h>
21 #include <linux/mm.h>
22 #include <linux/module.h>
23 #include <linux/mii.h>
24 #include <linux/ethtool.h>
25 #include <linux/ethtool_netlink.h>
26 #include <linux/phy.h>
27 #include <linux/phy_led_triggers.h>
28 #include <linux/sfp.h>
29 #include <linux/workqueue.h>
30 #include <linux/mdio.h>
31 #include <linux/io.h>
32 #include <linux/uaccess.h>
33 #include <linux/atomic.h>
34 #include <linux/suspend.h>
35 #include <net/netlink.h>
36 #include <net/genetlink.h>
37 #include <net/sock.h>
38
39 #define PHY_STATE_TIME HZ
40
41 #define PHY_STATE_STR(_state) \
42 case PHY_##_state: \
43 return __stringify(_state); \
44
phy_state_to_str(enum phy_state st)45 static const char *phy_state_to_str(enum phy_state st)
46 {
47 switch (st) {
48 PHY_STATE_STR(DOWN)
49 PHY_STATE_STR(READY)
50 PHY_STATE_STR(UP)
51 PHY_STATE_STR(RUNNING)
52 PHY_STATE_STR(NOLINK)
53 PHY_STATE_STR(CABLETEST)
54 PHY_STATE_STR(HALTED)
55 }
56
57 return NULL;
58 }
59
phy_link_up(struct phy_device * phydev)60 static void phy_link_up(struct phy_device *phydev)
61 {
62 phydev->phy_link_change(phydev, true);
63 phy_led_trigger_change_speed(phydev);
64 }
65
phy_link_down(struct phy_device * phydev)66 static void phy_link_down(struct phy_device *phydev)
67 {
68 phydev->phy_link_change(phydev, false);
69 phy_led_trigger_change_speed(phydev);
70 WRITE_ONCE(phydev->link_down_events, phydev->link_down_events + 1);
71 }
72
phy_pause_str(struct phy_device * phydev)73 static const char *phy_pause_str(struct phy_device *phydev)
74 {
75 bool local_pause, local_asym_pause;
76
77 if (phydev->autoneg == AUTONEG_DISABLE)
78 goto no_pause;
79
80 local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
81 phydev->advertising);
82 local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
83 phydev->advertising);
84
85 if (local_pause && phydev->pause)
86 return "rx/tx";
87
88 if (local_asym_pause && phydev->asym_pause) {
89 if (local_pause)
90 return "rx";
91 if (phydev->pause)
92 return "tx";
93 }
94
95 no_pause:
96 return "off";
97 }
98
99 /**
100 * phy_print_status - Convenience function to print out the current phy status
101 * @phydev: the phy_device struct
102 */
phy_print_status(struct phy_device * phydev)103 void phy_print_status(struct phy_device *phydev)
104 {
105 if (phydev->link) {
106 netdev_info(phydev->attached_dev,
107 "Link is Up - %s/%s %s- flow control %s\n",
108 phy_speed_to_str(phydev->speed),
109 phy_duplex_to_str(phydev->duplex),
110 phydev->downshifted_rate ? "(downshifted) " : "",
111 phy_pause_str(phydev));
112 } else {
113 netdev_info(phydev->attached_dev, "Link is Down\n");
114 }
115 }
116 EXPORT_SYMBOL(phy_print_status);
117
118 /**
119 * phy_get_rate_matching - determine if rate matching is supported
120 * @phydev: The phy device to return rate matching for
121 * @iface: The interface mode to use
122 *
123 * This determines the type of rate matching (if any) that @phy supports
124 * using @iface. @iface may be %PHY_INTERFACE_MODE_NA to determine if any
125 * interface supports rate matching.
126 *
127 * Return: The type of rate matching @phy supports for @iface, or
128 * %RATE_MATCH_NONE.
129 */
phy_get_rate_matching(struct phy_device * phydev,phy_interface_t iface)130 int phy_get_rate_matching(struct phy_device *phydev,
131 phy_interface_t iface)
132 {
133 int ret = RATE_MATCH_NONE;
134
135 if (phydev->drv->get_rate_matching) {
136 mutex_lock(&phydev->lock);
137 ret = phydev->drv->get_rate_matching(phydev, iface);
138 mutex_unlock(&phydev->lock);
139 }
140
141 return ret;
142 }
143 EXPORT_SYMBOL_GPL(phy_get_rate_matching);
144
145 /**
146 * phy_config_interrupt - configure the PHY device for the requested interrupts
147 * @phydev: the phy_device struct
148 * @interrupts: interrupt flags to configure for this @phydev
149 *
150 * Returns 0 on success or < 0 on error.
151 */
phy_config_interrupt(struct phy_device * phydev,bool interrupts)152 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
153 {
154 phydev->interrupts = interrupts ? 1 : 0;
155 if (phydev->drv->config_intr)
156 return phydev->drv->config_intr(phydev);
157
158 return 0;
159 }
160
161 /**
162 * phy_restart_aneg - restart auto-negotiation
163 * @phydev: target phy_device struct
164 *
165 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
166 * negative errno on error.
167 */
phy_restart_aneg(struct phy_device * phydev)168 int phy_restart_aneg(struct phy_device *phydev)
169 {
170 int ret;
171
172 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
173 ret = genphy_c45_restart_aneg(phydev);
174 else
175 ret = genphy_restart_aneg(phydev);
176
177 return ret;
178 }
179 EXPORT_SYMBOL_GPL(phy_restart_aneg);
180
181 /**
182 * phy_aneg_done - return auto-negotiation status
183 * @phydev: target phy_device struct
184 *
185 * Description: Return the auto-negotiation status from this @phydev
186 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
187 * is still pending.
188 */
phy_aneg_done(struct phy_device * phydev)189 int phy_aneg_done(struct phy_device *phydev)
190 {
191 if (phydev->drv && phydev->drv->aneg_done)
192 return phydev->drv->aneg_done(phydev);
193 else if (phydev->is_c45)
194 return genphy_c45_aneg_done(phydev);
195 else
196 return genphy_aneg_done(phydev);
197 }
198 EXPORT_SYMBOL(phy_aneg_done);
199
200 /**
201 * phy_find_valid - find a PHY setting that matches the requested parameters
202 * @speed: desired speed
203 * @duplex: desired duplex
204 * @supported: mask of supported link modes
205 *
206 * Locate a supported phy setting that is, in priority order:
207 * - an exact match for the specified speed and duplex mode
208 * - a match for the specified speed, or slower speed
209 * - the slowest supported speed
210 * Returns the matched phy_setting entry, or %NULL if no supported phy
211 * settings were found.
212 */
213 static const struct phy_setting *
phy_find_valid(int speed,int duplex,unsigned long * supported)214 phy_find_valid(int speed, int duplex, unsigned long *supported)
215 {
216 return phy_lookup_setting(speed, duplex, supported, false);
217 }
218
219 /**
220 * phy_supported_speeds - return all speeds currently supported by a phy device
221 * @phy: The phy device to return supported speeds of.
222 * @speeds: buffer to store supported speeds in.
223 * @size: size of speeds buffer.
224 *
225 * Description: Returns the number of supported speeds, and fills the speeds
226 * buffer with the supported speeds. If speeds buffer is too small to contain
227 * all currently supported speeds, will return as many speeds as can fit.
228 */
phy_supported_speeds(struct phy_device * phy,unsigned int * speeds,unsigned int size)229 unsigned int phy_supported_speeds(struct phy_device *phy,
230 unsigned int *speeds,
231 unsigned int size)
232 {
233 return phy_speeds(speeds, size, phy->supported);
234 }
235
236 /**
237 * phy_check_valid - check if there is a valid PHY setting which matches
238 * speed, duplex, and feature mask
239 * @speed: speed to match
240 * @duplex: duplex to match
241 * @features: A mask of the valid settings
242 *
243 * Description: Returns true if there is a valid setting, false otherwise.
244 */
phy_check_valid(int speed,int duplex,unsigned long * features)245 bool phy_check_valid(int speed, int duplex, unsigned long *features)
246 {
247 return !!phy_lookup_setting(speed, duplex, features, true);
248 }
249 EXPORT_SYMBOL(phy_check_valid);
250
251 /**
252 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
253 * @phydev: the target phy_device struct
254 *
255 * Description: Make sure the PHY is set to supported speeds and
256 * duplexes. Drop down by one in this order: 1000/FULL,
257 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
258 */
phy_sanitize_settings(struct phy_device * phydev)259 static void phy_sanitize_settings(struct phy_device *phydev)
260 {
261 const struct phy_setting *setting;
262
263 setting = phy_find_valid(phydev->speed, phydev->duplex,
264 phydev->supported);
265 if (setting) {
266 phydev->speed = setting->speed;
267 phydev->duplex = setting->duplex;
268 } else {
269 /* We failed to find anything (no supported speeds?) */
270 phydev->speed = SPEED_UNKNOWN;
271 phydev->duplex = DUPLEX_UNKNOWN;
272 }
273 }
274
phy_ethtool_ksettings_get(struct phy_device * phydev,struct ethtool_link_ksettings * cmd)275 void phy_ethtool_ksettings_get(struct phy_device *phydev,
276 struct ethtool_link_ksettings *cmd)
277 {
278 mutex_lock(&phydev->lock);
279 linkmode_copy(cmd->link_modes.supported, phydev->supported);
280 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
281 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
282
283 cmd->base.speed = phydev->speed;
284 cmd->base.duplex = phydev->duplex;
285 cmd->base.master_slave_cfg = phydev->master_slave_get;
286 cmd->base.master_slave_state = phydev->master_slave_state;
287 cmd->base.rate_matching = phydev->rate_matching;
288 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
289 cmd->base.port = PORT_BNC;
290 else
291 cmd->base.port = phydev->port;
292 cmd->base.transceiver = phy_is_internal(phydev) ?
293 XCVR_INTERNAL : XCVR_EXTERNAL;
294 cmd->base.phy_address = phydev->mdio.addr;
295 cmd->base.autoneg = phydev->autoneg;
296 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
297 cmd->base.eth_tp_mdix = phydev->mdix;
298 mutex_unlock(&phydev->lock);
299 }
300 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
301
302 /**
303 * phy_mii_ioctl - generic PHY MII ioctl interface
304 * @phydev: the phy_device struct
305 * @ifr: &struct ifreq for socket ioctl's
306 * @cmd: ioctl cmd to execute
307 *
308 * Note that this function is currently incompatible with the
309 * PHYCONTROL layer. It changes registers without regard to
310 * current state. Use at own risk.
311 */
phy_mii_ioctl(struct phy_device * phydev,struct ifreq * ifr,int cmd)312 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
313 {
314 struct mii_ioctl_data *mii_data = if_mii(ifr);
315 u16 val = mii_data->val_in;
316 bool change_autoneg = false;
317 int prtad, devad;
318
319 switch (cmd) {
320 case SIOCGMIIPHY:
321 mii_data->phy_id = phydev->mdio.addr;
322 fallthrough;
323
324 case SIOCGMIIREG:
325 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
326 prtad = mdio_phy_id_prtad(mii_data->phy_id);
327 devad = mdio_phy_id_devad(mii_data->phy_id);
328 mii_data->val_out = mdiobus_c45_read(
329 phydev->mdio.bus, prtad, devad,
330 mii_data->reg_num);
331 } else {
332 mii_data->val_out = mdiobus_read(
333 phydev->mdio.bus, mii_data->phy_id,
334 mii_data->reg_num);
335 }
336 return 0;
337
338 case SIOCSMIIREG:
339 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
340 prtad = mdio_phy_id_prtad(mii_data->phy_id);
341 devad = mdio_phy_id_devad(mii_data->phy_id);
342 } else {
343 prtad = mii_data->phy_id;
344 devad = mii_data->reg_num;
345 }
346 if (prtad == phydev->mdio.addr) {
347 switch (devad) {
348 case MII_BMCR:
349 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
350 if (phydev->autoneg == AUTONEG_ENABLE)
351 change_autoneg = true;
352 phydev->autoneg = AUTONEG_DISABLE;
353 if (val & BMCR_FULLDPLX)
354 phydev->duplex = DUPLEX_FULL;
355 else
356 phydev->duplex = DUPLEX_HALF;
357 if (val & BMCR_SPEED1000)
358 phydev->speed = SPEED_1000;
359 else if (val & BMCR_SPEED100)
360 phydev->speed = SPEED_100;
361 else phydev->speed = SPEED_10;
362 } else {
363 if (phydev->autoneg == AUTONEG_DISABLE)
364 change_autoneg = true;
365 phydev->autoneg = AUTONEG_ENABLE;
366 }
367 break;
368 case MII_ADVERTISE:
369 mii_adv_mod_linkmode_adv_t(phydev->advertising,
370 val);
371 change_autoneg = true;
372 break;
373 case MII_CTRL1000:
374 mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
375 val);
376 change_autoneg = true;
377 break;
378 default:
379 /* do nothing */
380 break;
381 }
382 }
383
384 if (mdio_phy_id_is_c45(mii_data->phy_id))
385 mdiobus_c45_write(phydev->mdio.bus, prtad, devad,
386 mii_data->reg_num, val);
387 else
388 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
389
390 if (prtad == phydev->mdio.addr &&
391 devad == MII_BMCR &&
392 val & BMCR_RESET)
393 return phy_init_hw(phydev);
394
395 if (change_autoneg)
396 return phy_start_aneg(phydev);
397
398 return 0;
399
400 case SIOCSHWTSTAMP:
401 if (phydev->mii_ts && phydev->mii_ts->hwtstamp)
402 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
403 fallthrough;
404
405 default:
406 return -EOPNOTSUPP;
407 }
408 }
409 EXPORT_SYMBOL(phy_mii_ioctl);
410
411 /**
412 * phy_do_ioctl - generic ndo_eth_ioctl implementation
413 * @dev: the net_device struct
414 * @ifr: &struct ifreq for socket ioctl's
415 * @cmd: ioctl cmd to execute
416 */
phy_do_ioctl(struct net_device * dev,struct ifreq * ifr,int cmd)417 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
418 {
419 if (!dev->phydev)
420 return -ENODEV;
421
422 return phy_mii_ioctl(dev->phydev, ifr, cmd);
423 }
424 EXPORT_SYMBOL(phy_do_ioctl);
425
426 /**
427 * phy_do_ioctl_running - generic ndo_eth_ioctl implementation but test first
428 *
429 * @dev: the net_device struct
430 * @ifr: &struct ifreq for socket ioctl's
431 * @cmd: ioctl cmd to execute
432 *
433 * Same as phy_do_ioctl, but ensures that net_device is running before
434 * handling the ioctl.
435 */
phy_do_ioctl_running(struct net_device * dev,struct ifreq * ifr,int cmd)436 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd)
437 {
438 if (!netif_running(dev))
439 return -ENODEV;
440
441 return phy_do_ioctl(dev, ifr, cmd);
442 }
443 EXPORT_SYMBOL(phy_do_ioctl_running);
444
445 /**
446 * phy_queue_state_machine - Trigger the state machine to run soon
447 *
448 * @phydev: the phy_device struct
449 * @jiffies: Run the state machine after these jiffies
450 */
phy_queue_state_machine(struct phy_device * phydev,unsigned long jiffies)451 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
452 {
453 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
454 jiffies);
455 }
456 EXPORT_SYMBOL(phy_queue_state_machine);
457
458 /**
459 * phy_trigger_machine - Trigger the state machine to run now
460 *
461 * @phydev: the phy_device struct
462 */
phy_trigger_machine(struct phy_device * phydev)463 void phy_trigger_machine(struct phy_device *phydev)
464 {
465 phy_queue_state_machine(phydev, 0);
466 }
467 EXPORT_SYMBOL(phy_trigger_machine);
468
phy_abort_cable_test(struct phy_device * phydev)469 static void phy_abort_cable_test(struct phy_device *phydev)
470 {
471 int err;
472
473 ethnl_cable_test_finished(phydev);
474
475 err = phy_init_hw(phydev);
476 if (err)
477 phydev_err(phydev, "Error while aborting cable test");
478 }
479
480 /**
481 * phy_ethtool_get_strings - Get the statistic counter names
482 *
483 * @phydev: the phy_device struct
484 * @data: Where to put the strings
485 */
phy_ethtool_get_strings(struct phy_device * phydev,u8 * data)486 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
487 {
488 if (!phydev->drv)
489 return -EIO;
490
491 mutex_lock(&phydev->lock);
492 phydev->drv->get_strings(phydev, data);
493 mutex_unlock(&phydev->lock);
494
495 return 0;
496 }
497 EXPORT_SYMBOL(phy_ethtool_get_strings);
498
499 /**
500 * phy_ethtool_get_sset_count - Get the number of statistic counters
501 *
502 * @phydev: the phy_device struct
503 */
phy_ethtool_get_sset_count(struct phy_device * phydev)504 int phy_ethtool_get_sset_count(struct phy_device *phydev)
505 {
506 int ret;
507
508 if (!phydev->drv)
509 return -EIO;
510
511 if (phydev->drv->get_sset_count &&
512 phydev->drv->get_strings &&
513 phydev->drv->get_stats) {
514 mutex_lock(&phydev->lock);
515 ret = phydev->drv->get_sset_count(phydev);
516 mutex_unlock(&phydev->lock);
517
518 return ret;
519 }
520
521 return -EOPNOTSUPP;
522 }
523 EXPORT_SYMBOL(phy_ethtool_get_sset_count);
524
525 /**
526 * phy_ethtool_get_stats - Get the statistic counters
527 *
528 * @phydev: the phy_device struct
529 * @stats: What counters to get
530 * @data: Where to store the counters
531 */
phy_ethtool_get_stats(struct phy_device * phydev,struct ethtool_stats * stats,u64 * data)532 int phy_ethtool_get_stats(struct phy_device *phydev,
533 struct ethtool_stats *stats, u64 *data)
534 {
535 if (!phydev->drv)
536 return -EIO;
537
538 mutex_lock(&phydev->lock);
539 phydev->drv->get_stats(phydev, stats, data);
540 mutex_unlock(&phydev->lock);
541
542 return 0;
543 }
544 EXPORT_SYMBOL(phy_ethtool_get_stats);
545
546 /**
547 * phy_ethtool_get_plca_cfg - Get PLCA RS configuration
548 * @phydev: the phy_device struct
549 * @plca_cfg: where to store the retrieved configuration
550 *
551 * Retrieve the PLCA configuration from the PHY. Return 0 on success or a
552 * negative value if an error occurred.
553 */
phy_ethtool_get_plca_cfg(struct phy_device * phydev,struct phy_plca_cfg * plca_cfg)554 int phy_ethtool_get_plca_cfg(struct phy_device *phydev,
555 struct phy_plca_cfg *plca_cfg)
556 {
557 int ret;
558
559 if (!phydev->drv) {
560 ret = -EIO;
561 goto out;
562 }
563
564 if (!phydev->drv->get_plca_cfg) {
565 ret = -EOPNOTSUPP;
566 goto out;
567 }
568
569 mutex_lock(&phydev->lock);
570 ret = phydev->drv->get_plca_cfg(phydev, plca_cfg);
571
572 mutex_unlock(&phydev->lock);
573 out:
574 return ret;
575 }
576
577 /**
578 * plca_check_valid - Check PLCA configuration before enabling
579 * @phydev: the phy_device struct
580 * @plca_cfg: current PLCA configuration
581 * @extack: extack for reporting useful error messages
582 *
583 * Checks whether the PLCA and PHY configuration are consistent and it is safe
584 * to enable PLCA. Returns 0 on success or a negative value if the PLCA or PHY
585 * configuration is not consistent.
586 */
plca_check_valid(struct phy_device * phydev,const struct phy_plca_cfg * plca_cfg,struct netlink_ext_ack * extack)587 static int plca_check_valid(struct phy_device *phydev,
588 const struct phy_plca_cfg *plca_cfg,
589 struct netlink_ext_ack *extack)
590 {
591 int ret = 0;
592
593 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT,
594 phydev->advertising)) {
595 ret = -EOPNOTSUPP;
596 NL_SET_ERR_MSG(extack,
597 "Point to Multi-Point mode is not enabled");
598 } else if (plca_cfg->node_id >= 255) {
599 NL_SET_ERR_MSG(extack, "PLCA node ID is not set");
600 ret = -EINVAL;
601 }
602
603 return ret;
604 }
605
606 /**
607 * phy_ethtool_set_plca_cfg - Set PLCA RS configuration
608 * @phydev: the phy_device struct
609 * @plca_cfg: new PLCA configuration to apply
610 * @extack: extack for reporting useful error messages
611 *
612 * Sets the PLCA configuration in the PHY. Return 0 on success or a
613 * negative value if an error occurred.
614 */
phy_ethtool_set_plca_cfg(struct phy_device * phydev,const struct phy_plca_cfg * plca_cfg,struct netlink_ext_ack * extack)615 int phy_ethtool_set_plca_cfg(struct phy_device *phydev,
616 const struct phy_plca_cfg *plca_cfg,
617 struct netlink_ext_ack *extack)
618 {
619 struct phy_plca_cfg *curr_plca_cfg;
620 int ret;
621
622 if (!phydev->drv) {
623 ret = -EIO;
624 goto out;
625 }
626
627 if (!phydev->drv->set_plca_cfg ||
628 !phydev->drv->get_plca_cfg) {
629 ret = -EOPNOTSUPP;
630 goto out;
631 }
632
633 curr_plca_cfg = kmalloc(sizeof(*curr_plca_cfg), GFP_KERNEL);
634 if (!curr_plca_cfg) {
635 ret = -ENOMEM;
636 goto out;
637 }
638
639 mutex_lock(&phydev->lock);
640
641 ret = phydev->drv->get_plca_cfg(phydev, curr_plca_cfg);
642 if (ret)
643 goto out_drv;
644
645 if (curr_plca_cfg->enabled < 0 && plca_cfg->enabled >= 0) {
646 NL_SET_ERR_MSG(extack,
647 "PHY does not support changing the PLCA 'enable' attribute");
648 ret = -EINVAL;
649 goto out_drv;
650 }
651
652 if (curr_plca_cfg->node_id < 0 && plca_cfg->node_id >= 0) {
653 NL_SET_ERR_MSG(extack,
654 "PHY does not support changing the PLCA 'local node ID' attribute");
655 ret = -EINVAL;
656 goto out_drv;
657 }
658
659 if (curr_plca_cfg->node_cnt < 0 && plca_cfg->node_cnt >= 0) {
660 NL_SET_ERR_MSG(extack,
661 "PHY does not support changing the PLCA 'node count' attribute");
662 ret = -EINVAL;
663 goto out_drv;
664 }
665
666 if (curr_plca_cfg->to_tmr < 0 && plca_cfg->to_tmr >= 0) {
667 NL_SET_ERR_MSG(extack,
668 "PHY does not support changing the PLCA 'TO timer' attribute");
669 ret = -EINVAL;
670 goto out_drv;
671 }
672
673 if (curr_plca_cfg->burst_cnt < 0 && plca_cfg->burst_cnt >= 0) {
674 NL_SET_ERR_MSG(extack,
675 "PHY does not support changing the PLCA 'burst count' attribute");
676 ret = -EINVAL;
677 goto out_drv;
678 }
679
680 if (curr_plca_cfg->burst_tmr < 0 && plca_cfg->burst_tmr >= 0) {
681 NL_SET_ERR_MSG(extack,
682 "PHY does not support changing the PLCA 'burst timer' attribute");
683 ret = -EINVAL;
684 goto out_drv;
685 }
686
687 // if enabling PLCA, perform a few sanity checks
688 if (plca_cfg->enabled > 0) {
689 // allow setting node_id concurrently with enabled
690 if (plca_cfg->node_id >= 0)
691 curr_plca_cfg->node_id = plca_cfg->node_id;
692
693 ret = plca_check_valid(phydev, curr_plca_cfg, extack);
694 if (ret)
695 goto out_drv;
696 }
697
698 ret = phydev->drv->set_plca_cfg(phydev, plca_cfg);
699
700 out_drv:
701 kfree(curr_plca_cfg);
702 mutex_unlock(&phydev->lock);
703 out:
704 return ret;
705 }
706
707 /**
708 * phy_ethtool_get_plca_status - Get PLCA RS status information
709 * @phydev: the phy_device struct
710 * @plca_st: where to store the retrieved status information
711 *
712 * Retrieve the PLCA status information from the PHY. Return 0 on success or a
713 * negative value if an error occurred.
714 */
phy_ethtool_get_plca_status(struct phy_device * phydev,struct phy_plca_status * plca_st)715 int phy_ethtool_get_plca_status(struct phy_device *phydev,
716 struct phy_plca_status *plca_st)
717 {
718 int ret;
719
720 if (!phydev->drv) {
721 ret = -EIO;
722 goto out;
723 }
724
725 if (!phydev->drv->get_plca_status) {
726 ret = -EOPNOTSUPP;
727 goto out;
728 }
729
730 mutex_lock(&phydev->lock);
731 ret = phydev->drv->get_plca_status(phydev, plca_st);
732
733 mutex_unlock(&phydev->lock);
734 out:
735 return ret;
736 }
737
738 /**
739 * phy_start_cable_test - Start a cable test
740 *
741 * @phydev: the phy_device struct
742 * @extack: extack for reporting useful error messages
743 */
phy_start_cable_test(struct phy_device * phydev,struct netlink_ext_ack * extack)744 int phy_start_cable_test(struct phy_device *phydev,
745 struct netlink_ext_ack *extack)
746 {
747 struct net_device *dev = phydev->attached_dev;
748 int err = -ENOMEM;
749
750 if (!(phydev->drv &&
751 phydev->drv->cable_test_start &&
752 phydev->drv->cable_test_get_status)) {
753 NL_SET_ERR_MSG(extack,
754 "PHY driver does not support cable testing");
755 return -EOPNOTSUPP;
756 }
757
758 mutex_lock(&phydev->lock);
759 if (phydev->state == PHY_CABLETEST) {
760 NL_SET_ERR_MSG(extack,
761 "PHY already performing a test");
762 err = -EBUSY;
763 goto out;
764 }
765
766 if (phydev->state < PHY_UP ||
767 phydev->state > PHY_CABLETEST) {
768 NL_SET_ERR_MSG(extack,
769 "PHY not configured. Try setting interface up");
770 err = -EBUSY;
771 goto out;
772 }
773
774 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_NTF);
775 if (err)
776 goto out;
777
778 /* Mark the carrier down until the test is complete */
779 phy_link_down(phydev);
780
781 netif_testing_on(dev);
782 err = phydev->drv->cable_test_start(phydev);
783 if (err) {
784 netif_testing_off(dev);
785 phy_link_up(phydev);
786 goto out_free;
787 }
788
789 phydev->state = PHY_CABLETEST;
790
791 if (phy_polling_mode(phydev))
792 phy_trigger_machine(phydev);
793
794 mutex_unlock(&phydev->lock);
795
796 return 0;
797
798 out_free:
799 ethnl_cable_test_free(phydev);
800 out:
801 mutex_unlock(&phydev->lock);
802
803 return err;
804 }
805 EXPORT_SYMBOL(phy_start_cable_test);
806
807 /**
808 * phy_start_cable_test_tdr - Start a raw TDR cable test
809 *
810 * @phydev: the phy_device struct
811 * @extack: extack for reporting useful error messages
812 * @config: Configuration of the test to run
813 */
phy_start_cable_test_tdr(struct phy_device * phydev,struct netlink_ext_ack * extack,const struct phy_tdr_config * config)814 int phy_start_cable_test_tdr(struct phy_device *phydev,
815 struct netlink_ext_ack *extack,
816 const struct phy_tdr_config *config)
817 {
818 struct net_device *dev = phydev->attached_dev;
819 int err = -ENOMEM;
820
821 if (!(phydev->drv &&
822 phydev->drv->cable_test_tdr_start &&
823 phydev->drv->cable_test_get_status)) {
824 NL_SET_ERR_MSG(extack,
825 "PHY driver does not support cable test TDR");
826 return -EOPNOTSUPP;
827 }
828
829 mutex_lock(&phydev->lock);
830 if (phydev->state == PHY_CABLETEST) {
831 NL_SET_ERR_MSG(extack,
832 "PHY already performing a test");
833 err = -EBUSY;
834 goto out;
835 }
836
837 if (phydev->state < PHY_UP ||
838 phydev->state > PHY_CABLETEST) {
839 NL_SET_ERR_MSG(extack,
840 "PHY not configured. Try setting interface up");
841 err = -EBUSY;
842 goto out;
843 }
844
845 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_TDR_NTF);
846 if (err)
847 goto out;
848
849 /* Mark the carrier down until the test is complete */
850 phy_link_down(phydev);
851
852 netif_testing_on(dev);
853 err = phydev->drv->cable_test_tdr_start(phydev, config);
854 if (err) {
855 netif_testing_off(dev);
856 phy_link_up(phydev);
857 goto out_free;
858 }
859
860 phydev->state = PHY_CABLETEST;
861
862 if (phy_polling_mode(phydev))
863 phy_trigger_machine(phydev);
864
865 mutex_unlock(&phydev->lock);
866
867 return 0;
868
869 out_free:
870 ethnl_cable_test_free(phydev);
871 out:
872 mutex_unlock(&phydev->lock);
873
874 return err;
875 }
876 EXPORT_SYMBOL(phy_start_cable_test_tdr);
877
phy_config_aneg(struct phy_device * phydev)878 int phy_config_aneg(struct phy_device *phydev)
879 {
880 if (phydev->drv->config_aneg)
881 return phydev->drv->config_aneg(phydev);
882
883 /* Clause 45 PHYs that don't implement Clause 22 registers are not
884 * allowed to call genphy_config_aneg()
885 */
886 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
887 return genphy_c45_config_aneg(phydev);
888
889 return genphy_config_aneg(phydev);
890 }
891 EXPORT_SYMBOL(phy_config_aneg);
892
893 /**
894 * phy_check_link_status - check link status and set state accordingly
895 * @phydev: the phy_device struct
896 *
897 * Description: Check for link and whether autoneg was triggered / is running
898 * and set state accordingly
899 */
phy_check_link_status(struct phy_device * phydev)900 static int phy_check_link_status(struct phy_device *phydev)
901 {
902 int err;
903
904 lockdep_assert_held(&phydev->lock);
905
906 /* Keep previous state if loopback is enabled because some PHYs
907 * report that Link is Down when loopback is enabled.
908 */
909 if (phydev->loopback_enabled)
910 return 0;
911
912 err = phy_read_status(phydev);
913 if (err)
914 return err;
915
916 if (phydev->link && phydev->state != PHY_RUNNING) {
917 phy_check_downshift(phydev);
918 phydev->state = PHY_RUNNING;
919 phy_link_up(phydev);
920 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
921 phydev->state = PHY_NOLINK;
922 phy_link_down(phydev);
923 }
924
925 return 0;
926 }
927
928 /**
929 * _phy_start_aneg - start auto-negotiation for this PHY device
930 * @phydev: the phy_device struct
931 *
932 * Description: Sanitizes the settings (if we're not autonegotiating
933 * them), and then calls the driver's config_aneg function.
934 * If the PHYCONTROL Layer is operating, we change the state to
935 * reflect the beginning of Auto-negotiation or forcing.
936 */
_phy_start_aneg(struct phy_device * phydev)937 static int _phy_start_aneg(struct phy_device *phydev)
938 {
939 int err;
940
941 lockdep_assert_held(&phydev->lock);
942
943 if (!phydev->drv)
944 return -EIO;
945
946 if (AUTONEG_DISABLE == phydev->autoneg)
947 phy_sanitize_settings(phydev);
948
949 err = phy_config_aneg(phydev);
950 if (err < 0)
951 return err;
952
953 if (phy_is_started(phydev))
954 err = phy_check_link_status(phydev);
955
956 return err;
957 }
958
959 /**
960 * phy_start_aneg - start auto-negotiation for this PHY device
961 * @phydev: the phy_device struct
962 *
963 * Description: Sanitizes the settings (if we're not autonegotiating
964 * them), and then calls the driver's config_aneg function.
965 * If the PHYCONTROL Layer is operating, we change the state to
966 * reflect the beginning of Auto-negotiation or forcing.
967 */
phy_start_aneg(struct phy_device * phydev)968 int phy_start_aneg(struct phy_device *phydev)
969 {
970 int err;
971
972 mutex_lock(&phydev->lock);
973 err = _phy_start_aneg(phydev);
974 mutex_unlock(&phydev->lock);
975
976 return err;
977 }
978 EXPORT_SYMBOL(phy_start_aneg);
979
phy_poll_aneg_done(struct phy_device * phydev)980 static int phy_poll_aneg_done(struct phy_device *phydev)
981 {
982 unsigned int retries = 100;
983 int ret;
984
985 do {
986 msleep(100);
987 ret = phy_aneg_done(phydev);
988 } while (!ret && --retries);
989
990 if (!ret)
991 return -ETIMEDOUT;
992
993 return ret < 0 ? ret : 0;
994 }
995
phy_ethtool_ksettings_set(struct phy_device * phydev,const struct ethtool_link_ksettings * cmd)996 int phy_ethtool_ksettings_set(struct phy_device *phydev,
997 const struct ethtool_link_ksettings *cmd)
998 {
999 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
1000 u8 autoneg = cmd->base.autoneg;
1001 u8 duplex = cmd->base.duplex;
1002 u32 speed = cmd->base.speed;
1003
1004 if (cmd->base.phy_address != phydev->mdio.addr)
1005 return -EINVAL;
1006
1007 linkmode_copy(advertising, cmd->link_modes.advertising);
1008
1009 /* We make sure that we don't pass unsupported values in to the PHY */
1010 linkmode_and(advertising, advertising, phydev->supported);
1011
1012 /* Verify the settings we care about. */
1013 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
1014 return -EINVAL;
1015
1016 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
1017 return -EINVAL;
1018
1019 if (autoneg == AUTONEG_DISABLE &&
1020 ((speed != SPEED_1000 &&
1021 speed != SPEED_100 &&
1022 speed != SPEED_10) ||
1023 (duplex != DUPLEX_HALF &&
1024 duplex != DUPLEX_FULL)))
1025 return -EINVAL;
1026
1027 mutex_lock(&phydev->lock);
1028 phydev->autoneg = autoneg;
1029
1030 if (autoneg == AUTONEG_DISABLE) {
1031 phydev->speed = speed;
1032 phydev->duplex = duplex;
1033 }
1034
1035 linkmode_copy(phydev->advertising, advertising);
1036
1037 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
1038 phydev->advertising, autoneg == AUTONEG_ENABLE);
1039
1040 phydev->master_slave_set = cmd->base.master_slave_cfg;
1041 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
1042
1043 /* Restart the PHY */
1044 if (phy_is_started(phydev)) {
1045 phydev->state = PHY_UP;
1046 phy_trigger_machine(phydev);
1047 } else {
1048 _phy_start_aneg(phydev);
1049 }
1050
1051 mutex_unlock(&phydev->lock);
1052 return 0;
1053 }
1054 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
1055
1056 /**
1057 * phy_speed_down - set speed to lowest speed supported by both link partners
1058 * @phydev: the phy_device struct
1059 * @sync: perform action synchronously
1060 *
1061 * Description: Typically used to save energy when waiting for a WoL packet
1062 *
1063 * WARNING: Setting sync to false may cause the system being unable to suspend
1064 * in case the PHY generates an interrupt when finishing the autonegotiation.
1065 * This interrupt may wake up the system immediately after suspend.
1066 * Therefore use sync = false only if you're sure it's safe with the respective
1067 * network chip.
1068 */
phy_speed_down(struct phy_device * phydev,bool sync)1069 int phy_speed_down(struct phy_device *phydev, bool sync)
1070 {
1071 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
1072 int ret = 0;
1073
1074 mutex_lock(&phydev->lock);
1075
1076 if (phydev->autoneg != AUTONEG_ENABLE)
1077 goto out;
1078
1079 linkmode_copy(adv_tmp, phydev->advertising);
1080
1081 ret = phy_speed_down_core(phydev);
1082 if (ret)
1083 goto out;
1084
1085 linkmode_copy(phydev->adv_old, adv_tmp);
1086
1087 if (linkmode_equal(phydev->advertising, adv_tmp)) {
1088 ret = 0;
1089 goto out;
1090 }
1091
1092 ret = phy_config_aneg(phydev);
1093 if (ret)
1094 goto out;
1095
1096 ret = sync ? phy_poll_aneg_done(phydev) : 0;
1097 out:
1098 mutex_unlock(&phydev->lock);
1099
1100 return ret;
1101 }
1102 EXPORT_SYMBOL_GPL(phy_speed_down);
1103
1104 /**
1105 * phy_speed_up - (re)set advertised speeds to all supported speeds
1106 * @phydev: the phy_device struct
1107 *
1108 * Description: Used to revert the effect of phy_speed_down
1109 */
phy_speed_up(struct phy_device * phydev)1110 int phy_speed_up(struct phy_device *phydev)
1111 {
1112 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
1113 int ret = 0;
1114
1115 mutex_lock(&phydev->lock);
1116
1117 if (phydev->autoneg != AUTONEG_ENABLE)
1118 goto out;
1119
1120 if (linkmode_empty(phydev->adv_old))
1121 goto out;
1122
1123 linkmode_copy(adv_tmp, phydev->advertising);
1124 linkmode_copy(phydev->advertising, phydev->adv_old);
1125 linkmode_zero(phydev->adv_old);
1126
1127 if (linkmode_equal(phydev->advertising, adv_tmp))
1128 goto out;
1129
1130 ret = phy_config_aneg(phydev);
1131 out:
1132 mutex_unlock(&phydev->lock);
1133
1134 return ret;
1135 }
1136 EXPORT_SYMBOL_GPL(phy_speed_up);
1137
1138 /**
1139 * phy_start_machine - start PHY state machine tracking
1140 * @phydev: the phy_device struct
1141 *
1142 * Description: The PHY infrastructure can run a state machine
1143 * which tracks whether the PHY is starting up, negotiating,
1144 * etc. This function starts the delayed workqueue which tracks
1145 * the state of the PHY. If you want to maintain your own state machine,
1146 * do not call this function.
1147 */
phy_start_machine(struct phy_device * phydev)1148 void phy_start_machine(struct phy_device *phydev)
1149 {
1150 phy_trigger_machine(phydev);
1151 }
1152 EXPORT_SYMBOL_GPL(phy_start_machine);
1153
1154 /**
1155 * phy_stop_machine - stop the PHY state machine tracking
1156 * @phydev: target phy_device struct
1157 *
1158 * Description: Stops the state machine delayed workqueue, sets the
1159 * state to UP (unless it wasn't up yet). This function must be
1160 * called BEFORE phy_detach.
1161 */
phy_stop_machine(struct phy_device * phydev)1162 void phy_stop_machine(struct phy_device *phydev)
1163 {
1164 cancel_delayed_work_sync(&phydev->state_queue);
1165
1166 mutex_lock(&phydev->lock);
1167 if (phy_is_started(phydev))
1168 phydev->state = PHY_UP;
1169 mutex_unlock(&phydev->lock);
1170 }
1171
1172 /**
1173 * phy_error - enter HALTED state for this PHY device
1174 * @phydev: target phy_device struct
1175 *
1176 * Moves the PHY to the HALTED state in response to a read
1177 * or write error, and tells the controller the link is down.
1178 * Must not be called from interrupt context, or while the
1179 * phydev->lock is held.
1180 */
phy_error(struct phy_device * phydev)1181 void phy_error(struct phy_device *phydev)
1182 {
1183 WARN_ON(1);
1184
1185 mutex_lock(&phydev->lock);
1186 phydev->state = PHY_HALTED;
1187 mutex_unlock(&phydev->lock);
1188
1189 phy_trigger_machine(phydev);
1190 }
1191 EXPORT_SYMBOL(phy_error);
1192
1193 /**
1194 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
1195 * @phydev: target phy_device struct
1196 */
phy_disable_interrupts(struct phy_device * phydev)1197 int phy_disable_interrupts(struct phy_device *phydev)
1198 {
1199 /* Disable PHY interrupts */
1200 return phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
1201 }
1202
1203 /**
1204 * phy_interrupt - PHY interrupt handler
1205 * @irq: interrupt line
1206 * @phy_dat: phy_device pointer
1207 *
1208 * Description: Handle PHY interrupt
1209 */
phy_interrupt(int irq,void * phy_dat)1210 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
1211 {
1212 struct phy_device *phydev = phy_dat;
1213 struct phy_driver *drv = phydev->drv;
1214 irqreturn_t ret;
1215
1216 /* Wakeup interrupts may occur during a system sleep transition.
1217 * Postpone handling until the PHY has resumed.
1218 */
1219 if (IS_ENABLED(CONFIG_PM_SLEEP) && phydev->irq_suspended) {
1220 struct net_device *netdev = phydev->attached_dev;
1221
1222 if (netdev) {
1223 struct device *parent = netdev->dev.parent;
1224
1225 if (netdev->wol_enabled)
1226 pm_system_wakeup();
1227 else if (device_may_wakeup(&netdev->dev))
1228 pm_wakeup_dev_event(&netdev->dev, 0, true);
1229 else if (parent && device_may_wakeup(parent))
1230 pm_wakeup_dev_event(parent, 0, true);
1231 }
1232
1233 phydev->irq_rerun = 1;
1234 disable_irq_nosync(irq);
1235 return IRQ_HANDLED;
1236 }
1237
1238 mutex_lock(&phydev->lock);
1239 ret = drv->handle_interrupt(phydev);
1240 mutex_unlock(&phydev->lock);
1241
1242 return ret;
1243 }
1244
1245 /**
1246 * phy_enable_interrupts - Enable the interrupts from the PHY side
1247 * @phydev: target phy_device struct
1248 */
phy_enable_interrupts(struct phy_device * phydev)1249 static int phy_enable_interrupts(struct phy_device *phydev)
1250 {
1251 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
1252 }
1253
1254 /**
1255 * phy_request_interrupt - request and enable interrupt for a PHY device
1256 * @phydev: target phy_device struct
1257 *
1258 * Description: Request and enable the interrupt for the given PHY.
1259 * If this fails, then we set irq to PHY_POLL.
1260 * This should only be called with a valid IRQ number.
1261 */
phy_request_interrupt(struct phy_device * phydev)1262 void phy_request_interrupt(struct phy_device *phydev)
1263 {
1264 int err;
1265
1266 err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
1267 IRQF_ONESHOT | IRQF_SHARED,
1268 phydev_name(phydev), phydev);
1269 if (err) {
1270 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
1271 err, phydev->irq);
1272 phydev->irq = PHY_POLL;
1273 } else {
1274 if (phy_enable_interrupts(phydev)) {
1275 phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
1276 phy_free_interrupt(phydev);
1277 phydev->irq = PHY_POLL;
1278 }
1279 }
1280 }
1281 EXPORT_SYMBOL(phy_request_interrupt);
1282
1283 /**
1284 * phy_free_interrupt - disable and free interrupt for a PHY device
1285 * @phydev: target phy_device struct
1286 *
1287 * Description: Disable and free the interrupt for the given PHY.
1288 * This should only be called with a valid IRQ number.
1289 */
phy_free_interrupt(struct phy_device * phydev)1290 void phy_free_interrupt(struct phy_device *phydev)
1291 {
1292 phy_disable_interrupts(phydev);
1293 free_irq(phydev->irq, phydev);
1294 }
1295 EXPORT_SYMBOL(phy_free_interrupt);
1296
1297 /**
1298 * phy_stop - Bring down the PHY link, and stop checking the status
1299 * @phydev: target phy_device struct
1300 */
phy_stop(struct phy_device * phydev)1301 void phy_stop(struct phy_device *phydev)
1302 {
1303 struct net_device *dev = phydev->attached_dev;
1304
1305 if (!phy_is_started(phydev) && phydev->state != PHY_DOWN) {
1306 WARN(1, "called from state %s\n",
1307 phy_state_to_str(phydev->state));
1308 return;
1309 }
1310
1311 mutex_lock(&phydev->lock);
1312
1313 if (phydev->state == PHY_CABLETEST) {
1314 phy_abort_cable_test(phydev);
1315 netif_testing_off(dev);
1316 }
1317
1318 if (phydev->sfp_bus)
1319 sfp_upstream_stop(phydev->sfp_bus);
1320
1321 phydev->state = PHY_HALTED;
1322
1323 mutex_unlock(&phydev->lock);
1324
1325 phy_state_machine(&phydev->state_queue.work);
1326 phy_stop_machine(phydev);
1327
1328 /* Cannot call flush_scheduled_work() here as desired because
1329 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
1330 * will not reenable interrupts.
1331 */
1332 }
1333 EXPORT_SYMBOL(phy_stop);
1334
1335 /**
1336 * phy_start - start or restart a PHY device
1337 * @phydev: target phy_device struct
1338 *
1339 * Description: Indicates the attached device's readiness to
1340 * handle PHY-related work. Used during startup to start the
1341 * PHY, and after a call to phy_stop() to resume operation.
1342 * Also used to indicate the MDIO bus has cleared an error
1343 * condition.
1344 */
phy_start(struct phy_device * phydev)1345 void phy_start(struct phy_device *phydev)
1346 {
1347 mutex_lock(&phydev->lock);
1348
1349 if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
1350 WARN(1, "called from state %s\n",
1351 phy_state_to_str(phydev->state));
1352 goto out;
1353 }
1354
1355 if (phydev->sfp_bus)
1356 sfp_upstream_start(phydev->sfp_bus);
1357
1358 /* if phy was suspended, bring the physical link up again */
1359 __phy_resume(phydev);
1360
1361 phydev->state = PHY_UP;
1362
1363 phy_start_machine(phydev);
1364 out:
1365 mutex_unlock(&phydev->lock);
1366 }
1367 EXPORT_SYMBOL(phy_start);
1368
1369 /**
1370 * phy_state_machine - Handle the state machine
1371 * @work: work_struct that describes the work to be done
1372 */
phy_state_machine(struct work_struct * work)1373 void phy_state_machine(struct work_struct *work)
1374 {
1375 struct delayed_work *dwork = to_delayed_work(work);
1376 struct phy_device *phydev =
1377 container_of(dwork, struct phy_device, state_queue);
1378 struct net_device *dev = phydev->attached_dev;
1379 bool needs_aneg = false, do_suspend = false;
1380 enum phy_state old_state;
1381 bool finished = false;
1382 int err = 0;
1383
1384 mutex_lock(&phydev->lock);
1385
1386 old_state = phydev->state;
1387
1388 switch (phydev->state) {
1389 case PHY_DOWN:
1390 case PHY_READY:
1391 break;
1392 case PHY_UP:
1393 needs_aneg = true;
1394
1395 break;
1396 case PHY_NOLINK:
1397 case PHY_RUNNING:
1398 err = phy_check_link_status(phydev);
1399 break;
1400 case PHY_CABLETEST:
1401 err = phydev->drv->cable_test_get_status(phydev, &finished);
1402 if (err) {
1403 phy_abort_cable_test(phydev);
1404 netif_testing_off(dev);
1405 needs_aneg = true;
1406 phydev->state = PHY_UP;
1407 break;
1408 }
1409
1410 if (finished) {
1411 ethnl_cable_test_finished(phydev);
1412 netif_testing_off(dev);
1413 needs_aneg = true;
1414 phydev->state = PHY_UP;
1415 }
1416 break;
1417 case PHY_HALTED:
1418 if (phydev->link) {
1419 phydev->link = 0;
1420 phy_link_down(phydev);
1421 }
1422 do_suspend = true;
1423 break;
1424 }
1425
1426 mutex_unlock(&phydev->lock);
1427
1428 if (needs_aneg)
1429 err = phy_start_aneg(phydev);
1430 else if (do_suspend)
1431 phy_suspend(phydev);
1432
1433 if (err == -ENODEV)
1434 return;
1435
1436 if (err < 0)
1437 phy_error(phydev);
1438
1439 if (old_state != phydev->state) {
1440 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1441 phy_state_to_str(old_state),
1442 phy_state_to_str(phydev->state));
1443 if (phydev->drv && phydev->drv->link_change_notify)
1444 phydev->drv->link_change_notify(phydev);
1445 }
1446
1447 /* Only re-schedule a PHY state machine change if we are polling the
1448 * PHY, if PHY_MAC_INTERRUPT is set, then we will be moving
1449 * between states from phy_mac_interrupt().
1450 *
1451 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1452 * state machine would be pointless and possibly error prone when
1453 * called from phy_disconnect() synchronously.
1454 */
1455 mutex_lock(&phydev->lock);
1456 if (phy_polling_mode(phydev) && phy_is_started(phydev))
1457 phy_queue_state_machine(phydev, PHY_STATE_TIME);
1458 mutex_unlock(&phydev->lock);
1459 }
1460
1461 /**
1462 * phy_mac_interrupt - MAC says the link has changed
1463 * @phydev: phy_device struct with changed link
1464 *
1465 * The MAC layer is able to indicate there has been a change in the PHY link
1466 * status. Trigger the state machine and work a work queue.
1467 */
phy_mac_interrupt(struct phy_device * phydev)1468 void phy_mac_interrupt(struct phy_device *phydev)
1469 {
1470 /* Trigger a state machine change */
1471 phy_trigger_machine(phydev);
1472 }
1473 EXPORT_SYMBOL(phy_mac_interrupt);
1474
1475 /**
1476 * phy_init_eee - init and check the EEE feature
1477 * @phydev: target phy_device struct
1478 * @clk_stop_enable: PHY may stop the clock during LPI
1479 *
1480 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1481 * is supported by looking at the MMD registers 3.20 and 7.60/61
1482 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1483 * bit if required.
1484 */
phy_init_eee(struct phy_device * phydev,bool clk_stop_enable)1485 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1486 {
1487 int ret;
1488
1489 if (!phydev->drv)
1490 return -EIO;
1491
1492 ret = genphy_c45_eee_is_active(phydev, NULL, NULL, NULL);
1493 if (ret < 0)
1494 return ret;
1495 if (!ret)
1496 return -EPROTONOSUPPORT;
1497
1498 if (clk_stop_enable)
1499 /* Configure the PHY to stop receiving xMII
1500 * clock while it is signaling LPI.
1501 */
1502 ret = phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1503 MDIO_PCS_CTRL1_CLKSTOP_EN);
1504
1505 return ret < 0 ? ret : 0;
1506 }
1507 EXPORT_SYMBOL(phy_init_eee);
1508
1509 /**
1510 * phy_get_eee_err - report the EEE wake error count
1511 * @phydev: target phy_device struct
1512 *
1513 * Description: it is to report the number of time where the PHY
1514 * failed to complete its normal wake sequence.
1515 */
phy_get_eee_err(struct phy_device * phydev)1516 int phy_get_eee_err(struct phy_device *phydev)
1517 {
1518 int ret;
1519
1520 if (!phydev->drv)
1521 return -EIO;
1522
1523 mutex_lock(&phydev->lock);
1524 ret = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1525 mutex_unlock(&phydev->lock);
1526
1527 return ret;
1528 }
1529 EXPORT_SYMBOL(phy_get_eee_err);
1530
1531 /**
1532 * phy_ethtool_get_eee - get EEE supported and status
1533 * @phydev: target phy_device struct
1534 * @data: ethtool_eee data
1535 *
1536 * Description: it reportes the Supported/Advertisement/LP Advertisement
1537 * capabilities.
1538 */
phy_ethtool_get_eee(struct phy_device * phydev,struct ethtool_eee * data)1539 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1540 {
1541 int ret;
1542
1543 if (!phydev->drv)
1544 return -EIO;
1545
1546 mutex_lock(&phydev->lock);
1547 ret = genphy_c45_ethtool_get_eee(phydev, data);
1548 mutex_unlock(&phydev->lock);
1549
1550 return ret;
1551 }
1552 EXPORT_SYMBOL(phy_ethtool_get_eee);
1553
1554 /**
1555 * phy_ethtool_set_eee - set EEE supported and status
1556 * @phydev: target phy_device struct
1557 * @data: ethtool_eee data
1558 *
1559 * Description: it is to program the Advertisement EEE register.
1560 */
phy_ethtool_set_eee(struct phy_device * phydev,struct ethtool_eee * data)1561 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1562 {
1563 int ret;
1564
1565 if (!phydev->drv)
1566 return -EIO;
1567
1568 mutex_lock(&phydev->lock);
1569 ret = genphy_c45_ethtool_set_eee(phydev, data);
1570 mutex_unlock(&phydev->lock);
1571
1572 return ret;
1573 }
1574 EXPORT_SYMBOL(phy_ethtool_set_eee);
1575
1576 /**
1577 * phy_ethtool_set_wol - Configure Wake On LAN
1578 *
1579 * @phydev: target phy_device struct
1580 * @wol: Configuration requested
1581 */
phy_ethtool_set_wol(struct phy_device * phydev,struct ethtool_wolinfo * wol)1582 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1583 {
1584 int ret;
1585
1586 if (phydev->drv && phydev->drv->set_wol) {
1587 mutex_lock(&phydev->lock);
1588 ret = phydev->drv->set_wol(phydev, wol);
1589 mutex_unlock(&phydev->lock);
1590
1591 return ret;
1592 }
1593
1594 return -EOPNOTSUPP;
1595 }
1596 EXPORT_SYMBOL(phy_ethtool_set_wol);
1597
1598 /**
1599 * phy_ethtool_get_wol - Get the current Wake On LAN configuration
1600 *
1601 * @phydev: target phy_device struct
1602 * @wol: Store the current configuration here
1603 */
phy_ethtool_get_wol(struct phy_device * phydev,struct ethtool_wolinfo * wol)1604 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1605 {
1606 if (phydev->drv && phydev->drv->get_wol) {
1607 mutex_lock(&phydev->lock);
1608 phydev->drv->get_wol(phydev, wol);
1609 mutex_unlock(&phydev->lock);
1610 }
1611 }
1612 EXPORT_SYMBOL(phy_ethtool_get_wol);
1613
phy_ethtool_get_link_ksettings(struct net_device * ndev,struct ethtool_link_ksettings * cmd)1614 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1615 struct ethtool_link_ksettings *cmd)
1616 {
1617 struct phy_device *phydev = ndev->phydev;
1618
1619 if (!phydev)
1620 return -ENODEV;
1621
1622 phy_ethtool_ksettings_get(phydev, cmd);
1623
1624 return 0;
1625 }
1626 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1627
phy_ethtool_set_link_ksettings(struct net_device * ndev,const struct ethtool_link_ksettings * cmd)1628 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1629 const struct ethtool_link_ksettings *cmd)
1630 {
1631 struct phy_device *phydev = ndev->phydev;
1632
1633 if (!phydev)
1634 return -ENODEV;
1635
1636 return phy_ethtool_ksettings_set(phydev, cmd);
1637 }
1638 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1639
1640 /**
1641 * phy_ethtool_nway_reset - Restart auto negotiation
1642 * @ndev: Network device to restart autoneg for
1643 */
phy_ethtool_nway_reset(struct net_device * ndev)1644 int phy_ethtool_nway_reset(struct net_device *ndev)
1645 {
1646 struct phy_device *phydev = ndev->phydev;
1647 int ret;
1648
1649 if (!phydev)
1650 return -ENODEV;
1651
1652 if (!phydev->drv)
1653 return -EIO;
1654
1655 mutex_lock(&phydev->lock);
1656 ret = phy_restart_aneg(phydev);
1657 mutex_unlock(&phydev->lock);
1658
1659 return ret;
1660 }
1661 EXPORT_SYMBOL(phy_ethtool_nway_reset);
1662