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