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