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