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