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/timer.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
41static const char *phy_speed_to_str(int speed)
42{
43 switch (speed) {
44 case SPEED_10:
45 return "10Mbps";
46 case SPEED_100:
47 return "100Mbps";
48 case SPEED_1000:
49 return "1Gbps";
50 case SPEED_2500:
51 return "2.5Gbps";
52 case SPEED_10000:
53 return "10Gbps";
54 case SPEED_UNKNOWN:
55 return "Unknown";
56 default:
57 return "Unsupported (update phy.c)";
58 }
59}
60
61/**
62 * phy_print_status - Convenience function to print out the current phy status
63 * @phydev: the phy_device struct
64 */
65void phy_print_status(struct phy_device *phydev)
66{
67 if (phydev->link) {
68 netdev_info(phydev->attached_dev,
69 "Link is Up - %s/%s - flow control %s\n",
70 phy_speed_to_str(phydev->speed),
71 DUPLEX_FULL == phydev->duplex ? "Full" : "Half",
72 phydev->pause ? "rx/tx" : "off");
73 } else {
74 netdev_info(phydev->attached_dev, "Link is Down\n");
75 }
76}
77EXPORT_SYMBOL(phy_print_status);
78
79/**
80 * phy_clear_interrupt - Ack the phy device's interrupt
81 * @phydev: the phy_device struct
82 *
83 * If the @phydev driver has an ack_interrupt function, call it to
84 * ack and clear the phy device's interrupt.
85 *
86 * Returns 0 on success or < 0 on error.
87 */
88static int phy_clear_interrupt(struct phy_device *phydev)
89{
90 if (phydev->drv->ack_interrupt)
91 return phydev->drv->ack_interrupt(phydev);
92
93 return 0;
94}
95
96/**
97 * phy_config_interrupt - configure the PHY device for the requested interrupts
98 * @phydev: the phy_device struct
99 * @interrupts: interrupt flags to configure for this @phydev
100 *
101 * Returns 0 on success or < 0 on error.
102 */
103static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
104{
105 phydev->interrupts = interrupts;
106 if (phydev->drv->config_intr)
107 return phydev->drv->config_intr(phydev);
108
109 return 0;
110}
111
112
113/**
114 * phy_aneg_done - return auto-negotiation status
115 * @phydev: target phy_device struct
116 *
117 * Description: Return the auto-negotiation status from this @phydev
118 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
119 * is still pending.
120 */
121static inline int phy_aneg_done(struct phy_device *phydev)
122{
123 if (phydev->drv->aneg_done)
124 return phydev->drv->aneg_done(phydev);
125
126 return genphy_aneg_done(phydev);
127}
128
129/* A structure for mapping a particular speed and duplex
130 * combination to a particular SUPPORTED and ADVERTISED value
131 */
132struct phy_setting {
133 int speed;
134 int duplex;
135 u32 setting;
136};
137
138/* A mapping of all SUPPORTED settings to speed/duplex */
139static const struct phy_setting settings[] = {
140 {
141 .speed = 10000,
142 .duplex = DUPLEX_FULL,
143 .setting = SUPPORTED_10000baseT_Full,
144 },
145 {
146 .speed = SPEED_1000,
147 .duplex = DUPLEX_FULL,
148 .setting = SUPPORTED_1000baseT_Full,
149 },
150 {
151 .speed = SPEED_1000,
152 .duplex = DUPLEX_HALF,
153 .setting = SUPPORTED_1000baseT_Half,
154 },
155 {
156 .speed = SPEED_100,
157 .duplex = DUPLEX_FULL,
158 .setting = SUPPORTED_100baseT_Full,
159 },
160 {
161 .speed = SPEED_100,
162 .duplex = DUPLEX_HALF,
163 .setting = SUPPORTED_100baseT_Half,
164 },
165 {
166 .speed = SPEED_10,
167 .duplex = DUPLEX_FULL,
168 .setting = SUPPORTED_10baseT_Full,
169 },
170 {
171 .speed = SPEED_10,
172 .duplex = DUPLEX_HALF,
173 .setting = SUPPORTED_10baseT_Half,
174 },
175};
176
177#define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
178
179/**
180 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
181 * @speed: speed to match
182 * @duplex: duplex to match
183 *
184 * Description: Searches the settings array for the setting which
185 * matches the desired speed and duplex, and returns the index
186 * of that setting. Returns the index of the last setting if
187 * none of the others match.
188 */
189static inline unsigned int phy_find_setting(int speed, int duplex)
190{
191 unsigned int idx = 0;
192
193 while (idx < ARRAY_SIZE(settings) &&
194 (settings[idx].speed != speed || settings[idx].duplex != duplex))
195 idx++;
196
197 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
198}
199
200/**
201 * phy_find_valid - find a PHY setting that matches the requested features mask
202 * @idx: The first index in settings[] to search
203 * @features: A mask of the valid settings
204 *
205 * Description: Returns the index of the first valid setting less
206 * than or equal to the one pointed to by idx, as determined by
207 * the mask in features. Returns the index of the last setting
208 * if nothing else matches.
209 */
210static inline unsigned int phy_find_valid(unsigned int idx, u32 features)
211{
212 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
213 idx++;
214
215 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
216}
217
218/**
219 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
220 * @phydev: the target phy_device struct
221 *
222 * Description: Make sure the PHY is set to supported speeds and
223 * duplexes. Drop down by one in this order: 1000/FULL,
224 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
225 */
226static void phy_sanitize_settings(struct phy_device *phydev)
227{
228 u32 features = phydev->supported;
229 unsigned int idx;
230
231 /* Sanitize settings based on PHY capabilities */
232 if ((features & SUPPORTED_Autoneg) == 0)
233 phydev->autoneg = AUTONEG_DISABLE;
234
235 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
236 features);
237
238 phydev->speed = settings[idx].speed;
239 phydev->duplex = settings[idx].duplex;
240}
241
242/**
243 * phy_ethtool_sset - generic ethtool sset function, handles all the details
244 * @phydev: target phy_device struct
245 * @cmd: ethtool_cmd
246 *
247 * A few notes about parameter checking:
248 * - We don't set port or transceiver, so we don't care what they
249 * were set to.
250 * - phy_start_aneg() will make sure forced settings are sane, and
251 * choose the next best ones from the ones selected, so we don't
252 * care if ethtool tries to give us bad values.
253 */
254int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
255{
256 u32 speed = ethtool_cmd_speed(cmd);
257
258 if (cmd->phy_address != phydev->addr)
259 return -EINVAL;
260
261 /* We make sure that we don't pass unsupported values in to the PHY */
262 cmd->advertising &= phydev->supported;
263
264 /* Verify the settings we care about. */
265 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
266 return -EINVAL;
267
268 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
269 return -EINVAL;
270
271 if (cmd->autoneg == AUTONEG_DISABLE &&
272 ((speed != SPEED_1000 &&
273 speed != SPEED_100 &&
274 speed != SPEED_10) ||
275 (cmd->duplex != DUPLEX_HALF &&
276 cmd->duplex != DUPLEX_FULL)))
277 return -EINVAL;
278
279 phydev->autoneg = cmd->autoneg;
280
281 phydev->speed = speed;
282
283 phydev->advertising = cmd->advertising;
284
285 if (AUTONEG_ENABLE == cmd->autoneg)
286 phydev->advertising |= ADVERTISED_Autoneg;
287 else
288 phydev->advertising &= ~ADVERTISED_Autoneg;
289
290 phydev->duplex = cmd->duplex;
291
292 /* Restart the PHY */
293 phy_start_aneg(phydev);
294
295 return 0;
296}
297EXPORT_SYMBOL(phy_ethtool_sset);
298
299int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
300{
301 cmd->supported = phydev->supported;
302
303 cmd->advertising = phydev->advertising;
304 cmd->lp_advertising = phydev->lp_advertising;
305
306 ethtool_cmd_speed_set(cmd, phydev->speed);
307 cmd->duplex = phydev->duplex;
308 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
309 cmd->port = PORT_BNC;
310 else
311 cmd->port = PORT_MII;
312 cmd->phy_address = phydev->addr;
313 cmd->transceiver = phy_is_internal(phydev) ?
314 XCVR_INTERNAL : XCVR_EXTERNAL;
315 cmd->autoneg = phydev->autoneg;
316
317 return 0;
318}
319EXPORT_SYMBOL(phy_ethtool_gset);
320
321/**
322 * phy_mii_ioctl - generic PHY MII ioctl interface
323 * @phydev: the phy_device struct
324 * @ifr: &struct ifreq for socket ioctl's
325 * @cmd: ioctl cmd to execute
326 *
327 * Note that this function is currently incompatible with the
328 * PHYCONTROL layer. It changes registers without regard to
329 * current state. Use at own risk.
330 */
331int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
332{
333 struct mii_ioctl_data *mii_data = if_mii(ifr);
334 u16 val = mii_data->val_in;
335
336 switch (cmd) {
337 case SIOCGMIIPHY:
338 mii_data->phy_id = phydev->addr;
339 /* fall through */
340
341 case SIOCGMIIREG:
342 mii_data->val_out = mdiobus_read(phydev->bus, mii_data->phy_id,
343 mii_data->reg_num);
344 return 0;
345
346 case SIOCSMIIREG:
347 if (mii_data->phy_id == phydev->addr) {
348 switch (mii_data->reg_num) {
349 case MII_BMCR:
350 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0)
351 phydev->autoneg = AUTONEG_DISABLE;
352 else
353 phydev->autoneg = AUTONEG_ENABLE;
354 if (!phydev->autoneg && (val & BMCR_FULLDPLX))
355 phydev->duplex = DUPLEX_FULL;
356 else
357 phydev->duplex = DUPLEX_HALF;
358 if (!phydev->autoneg && (val & BMCR_SPEED1000))
359 phydev->speed = SPEED_1000;
360 else if (!phydev->autoneg &&
361 (val & BMCR_SPEED100))
362 phydev->speed = SPEED_100;
363 break;
364 case MII_ADVERTISE:
365 phydev->advertising = val;
366 break;
367 default:
368 /* do nothing */
369 break;
370 }
371 }
372
373 mdiobus_write(phydev->bus, mii_data->phy_id,
374 mii_data->reg_num, val);
375
376 if (mii_data->reg_num == MII_BMCR &&
377 val & BMCR_RESET)
378 return phy_init_hw(phydev);
379 return 0;
380
381 case SIOCSHWTSTAMP:
382 if (phydev->drv->hwtstamp)
383 return phydev->drv->hwtstamp(phydev, ifr);
384 /* fall through */
385
386 default:
387 return -EOPNOTSUPP;
388 }
389}
390EXPORT_SYMBOL(phy_mii_ioctl);
391
392/**
393 * phy_start_aneg - start auto-negotiation for this PHY device
394 * @phydev: the phy_device struct
395 *
396 * Description: Sanitizes the settings (if we're not autonegotiating
397 * them), and then calls the driver's config_aneg function.
398 * If the PHYCONTROL Layer is operating, we change the state to
399 * reflect the beginning of Auto-negotiation or forcing.
400 */
401int phy_start_aneg(struct phy_device *phydev)
402{
403 int err;
404
405 mutex_lock(&phydev->lock);
406
407 if (AUTONEG_DISABLE == phydev->autoneg)
408 phy_sanitize_settings(phydev);
409
410 err = phydev->drv->config_aneg(phydev);
411 if (err < 0)
412 goto out_unlock;
413
414 if (phydev->state != PHY_HALTED) {
415 if (AUTONEG_ENABLE == phydev->autoneg) {
416 phydev->state = PHY_AN;
417 phydev->link_timeout = PHY_AN_TIMEOUT;
418 } else {
419 phydev->state = PHY_FORCING;
420 phydev->link_timeout = PHY_FORCE_TIMEOUT;
421 }
422 }
423
424out_unlock:
425 mutex_unlock(&phydev->lock);
426 return err;
427}
428EXPORT_SYMBOL(phy_start_aneg);
429
430/**
431 * phy_start_machine - start PHY state machine tracking
432 * @phydev: the phy_device struct
433 *
434 * Description: The PHY infrastructure can run a state machine
435 * which tracks whether the PHY is starting up, negotiating,
436 * etc. This function starts the timer which tracks the state
437 * of the PHY. If you want to maintain your own state machine,
438 * do not call this function.
439 */
440void phy_start_machine(struct phy_device *phydev)
441{
442 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
443}
444
445/**
446 * phy_stop_machine - stop the PHY state machine tracking
447 * @phydev: target phy_device struct
448 *
449 * Description: Stops the state machine timer, sets the state to UP
450 * (unless it wasn't up yet). This function must be called BEFORE
451 * phy_detach.
452 */
453void phy_stop_machine(struct phy_device *phydev)
454{
455 cancel_delayed_work_sync(&phydev->state_queue);
456
457 mutex_lock(&phydev->lock);
458 if (phydev->state > PHY_UP)
459 phydev->state = PHY_UP;
460 mutex_unlock(&phydev->lock);
461}
462
463/**
464 * phy_error - enter HALTED state for this PHY device
465 * @phydev: target phy_device struct
466 *
467 * Moves the PHY to the HALTED state in response to a read
468 * or write error, and tells the controller the link is down.
469 * Must not be called from interrupt context, or while the
470 * phydev->lock is held.
471 */
472static void phy_error(struct phy_device *phydev)
473{
474 mutex_lock(&phydev->lock);
475 phydev->state = PHY_HALTED;
476 mutex_unlock(&phydev->lock);
477}
478
479/**
480 * phy_interrupt - PHY interrupt handler
481 * @irq: interrupt line
482 * @phy_dat: phy_device pointer
483 *
484 * Description: When a PHY interrupt occurs, the handler disables
485 * interrupts, and schedules a work task to clear the interrupt.
486 */
487static irqreturn_t phy_interrupt(int irq, void *phy_dat)
488{
489 struct phy_device *phydev = phy_dat;
490
491 if (PHY_HALTED == phydev->state)
492 return IRQ_NONE; /* It can't be ours. */
493
494 /* The MDIO bus is not allowed to be written in interrupt
495 * context, so we need to disable the irq here. A work
496 * queue will write the PHY to disable and clear the
497 * interrupt, and then reenable the irq line.
498 */
499 disable_irq_nosync(irq);
500 atomic_inc(&phydev->irq_disable);
501
502 queue_work(system_power_efficient_wq, &phydev->phy_queue);
503
504 return IRQ_HANDLED;
505}
506
507/**
508 * phy_enable_interrupts - Enable the interrupts from the PHY side
509 * @phydev: target phy_device struct
510 */
511static int phy_enable_interrupts(struct phy_device *phydev)
512{
513 int err = phy_clear_interrupt(phydev);
514
515 if (err < 0)
516 return err;
517
518 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
519}
520
521/**
522 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
523 * @phydev: target phy_device struct
524 */
525static int phy_disable_interrupts(struct phy_device *phydev)
526{
527 int err;
528
529 /* Disable PHY interrupts */
530 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
531 if (err)
532 goto phy_err;
533
534 /* Clear the interrupt */
535 err = phy_clear_interrupt(phydev);
536 if (err)
537 goto phy_err;
538
539 return 0;
540
541phy_err:
542 phy_error(phydev);
543
544 return err;
545}
546
547/**
548 * phy_start_interrupts - request and enable interrupts for a PHY device
549 * @phydev: target phy_device struct
550 *
551 * Description: Request the interrupt for the given PHY.
552 * If this fails, then we set irq to PHY_POLL.
553 * Otherwise, we enable the interrupts in the PHY.
554 * This should only be called with a valid IRQ number.
555 * Returns 0 on success or < 0 on error.
556 */
557int phy_start_interrupts(struct phy_device *phydev)
558{
559 atomic_set(&phydev->irq_disable, 0);
560 if (request_irq(phydev->irq, phy_interrupt, 0, "phy_interrupt",
561 phydev) < 0) {
562 pr_warn("%s: Can't get IRQ %d (PHY)\n",
563 phydev->bus->name, phydev->irq);
564 phydev->irq = PHY_POLL;
565 return 0;
566 }
567
568 return phy_enable_interrupts(phydev);
569}
570EXPORT_SYMBOL(phy_start_interrupts);
571
572/**
573 * phy_stop_interrupts - disable interrupts from a PHY device
574 * @phydev: target phy_device struct
575 */
576int phy_stop_interrupts(struct phy_device *phydev)
577{
578 int err = phy_disable_interrupts(phydev);
579
580 if (err)
581 phy_error(phydev);
582
583 free_irq(phydev->irq, phydev);
584
585 /* Cannot call flush_scheduled_work() here as desired because
586 * of rtnl_lock(), but we do not really care about what would
587 * be done, except from enable_irq(), so cancel any work
588 * possibly pending and take care of the matter below.
589 */
590 cancel_work_sync(&phydev->phy_queue);
591 /* If work indeed has been cancelled, disable_irq() will have
592 * been left unbalanced from phy_interrupt() and enable_irq()
593 * has to be called so that other devices on the line work.
594 */
595 while (atomic_dec_return(&phydev->irq_disable) >= 0)
596 enable_irq(phydev->irq);
597
598 return err;
599}
600EXPORT_SYMBOL(phy_stop_interrupts);
601
602/**
603 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
604 * @work: work_struct that describes the work to be done
605 */
606void phy_change(struct work_struct *work)
607{
608 struct phy_device *phydev =
609 container_of(work, struct phy_device, phy_queue);
610
611 if (phydev->drv->did_interrupt &&
612 !phydev->drv->did_interrupt(phydev))
613 goto ignore;
614
615 if (phy_disable_interrupts(phydev))
616 goto phy_err;
617
618 mutex_lock(&phydev->lock);
619 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
620 phydev->state = PHY_CHANGELINK;
621 mutex_unlock(&phydev->lock);
622
623 atomic_dec(&phydev->irq_disable);
624 enable_irq(phydev->irq);
625
626 /* Reenable interrupts */
627 if (PHY_HALTED != phydev->state &&
628 phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED))
629 goto irq_enable_err;
630
631 /* reschedule state queue work to run as soon as possible */
632 cancel_delayed_work_sync(&phydev->state_queue);
633 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
634 return;
635
636ignore:
637 atomic_dec(&phydev->irq_disable);
638 enable_irq(phydev->irq);
639 return;
640
641irq_enable_err:
642 disable_irq(phydev->irq);
643 atomic_inc(&phydev->irq_disable);
644phy_err:
645 phy_error(phydev);
646}
647
648/**
649 * phy_stop - Bring down the PHY link, and stop checking the status
650 * @phydev: target phy_device struct
651 */
652void phy_stop(struct phy_device *phydev)
653{
654 mutex_lock(&phydev->lock);
655
656 if (PHY_HALTED == phydev->state)
657 goto out_unlock;
658
659 if (phy_interrupt_is_valid(phydev)) {
660 /* Disable PHY Interrupts */
661 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
662
663 /* Clear any pending interrupts */
664 phy_clear_interrupt(phydev);
665 }
666
667 phydev->state = PHY_HALTED;
668
669out_unlock:
670 mutex_unlock(&phydev->lock);
671
672 /* Cannot call flush_scheduled_work() here as desired because
673 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
674 * will not reenable interrupts.
675 */
676}
677EXPORT_SYMBOL(phy_stop);
678
679/**
680 * phy_start - start or restart a PHY device
681 * @phydev: target phy_device struct
682 *
683 * Description: Indicates the attached device's readiness to
684 * handle PHY-related work. Used during startup to start the
685 * PHY, and after a call to phy_stop() to resume operation.
686 * Also used to indicate the MDIO bus has cleared an error
687 * condition.
688 */
689void phy_start(struct phy_device *phydev)
690{
691 mutex_lock(&phydev->lock);
692
693 switch (phydev->state) {
694 case PHY_STARTING:
695 phydev->state = PHY_PENDING;
696 break;
697 case PHY_READY:
698 phydev->state = PHY_UP;
699 break;
700 case PHY_HALTED:
701 phydev->state = PHY_RESUMING;
702 default:
703 break;
704 }
705 mutex_unlock(&phydev->lock);
706}
707EXPORT_SYMBOL(phy_start);
708
709/**
710 * phy_state_machine - Handle the state machine
711 * @work: work_struct that describes the work to be done
712 */
713void phy_state_machine(struct work_struct *work)
714{
715 struct delayed_work *dwork = to_delayed_work(work);
716 struct phy_device *phydev =
717 container_of(dwork, struct phy_device, state_queue);
718 bool needs_aneg = false, do_suspend = false, do_resume = false;
719 int err = 0;
720
721 mutex_lock(&phydev->lock);
722
723 switch (phydev->state) {
724 case PHY_DOWN:
725 case PHY_STARTING:
726 case PHY_READY:
727 case PHY_PENDING:
728 break;
729 case PHY_UP:
730 needs_aneg = true;
731
732 phydev->link_timeout = PHY_AN_TIMEOUT;
733
734 break;
735 case PHY_AN:
736 err = phy_read_status(phydev);
737 if (err < 0)
738 break;
739
740 /* If the link is down, give up on negotiation for now */
741 if (!phydev->link) {
742 phydev->state = PHY_NOLINK;
743 netif_carrier_off(phydev->attached_dev);
744 phydev->adjust_link(phydev->attached_dev);
745 break;
746 }
747
748 /* Check if negotiation is done. Break if there's an error */
749 err = phy_aneg_done(phydev);
750 if (err < 0)
751 break;
752
753 /* If AN is done, we're running */
754 if (err > 0) {
755 phydev->state = PHY_RUNNING;
756 netif_carrier_on(phydev->attached_dev);
757 phydev->adjust_link(phydev->attached_dev);
758
759 } else if (0 == phydev->link_timeout--)
760 needs_aneg = true;
761 break;
762 case PHY_NOLINK:
763 err = phy_read_status(phydev);
764 if (err)
765 break;
766
767 if (phydev->link) {
768 if (AUTONEG_ENABLE == phydev->autoneg) {
769 err = phy_aneg_done(phydev);
770 if (err < 0)
771 break;
772
773 if (!err) {
774 phydev->state = PHY_AN;
775 phydev->link_timeout = PHY_AN_TIMEOUT;
776 break;
777 }
778 }
779 phydev->state = PHY_RUNNING;
780 netif_carrier_on(phydev->attached_dev);
781 phydev->adjust_link(phydev->attached_dev);
782 }
783 break;
784 case PHY_FORCING:
785 err = genphy_update_link(phydev);
786 if (err)
787 break;
788
789 if (phydev->link) {
790 phydev->state = PHY_RUNNING;
791 netif_carrier_on(phydev->attached_dev);
792 } else {
793 if (0 == phydev->link_timeout--)
794 needs_aneg = true;
795 }
796
797 phydev->adjust_link(phydev->attached_dev);
798 break;
799 case PHY_RUNNING:
800 /* Only register a CHANGE if we are
801 * polling or ignoring interrupts
802 */
803 if (!phy_interrupt_is_valid(phydev))
804 phydev->state = PHY_CHANGELINK;
805 break;
806 case PHY_CHANGELINK:
807 err = phy_read_status(phydev);
808 if (err)
809 break;
810
811 if (phydev->link) {
812 phydev->state = PHY_RUNNING;
813 netif_carrier_on(phydev->attached_dev);
814 } else {
815 phydev->state = PHY_NOLINK;
816 netif_carrier_off(phydev->attached_dev);
817 }
818
819 phydev->adjust_link(phydev->attached_dev);
820
821 if (phy_interrupt_is_valid(phydev))
822 err = phy_config_interrupt(phydev,
823 PHY_INTERRUPT_ENABLED);
824 break;
825 case PHY_HALTED:
826 if (phydev->link) {
827 phydev->link = 0;
828 netif_carrier_off(phydev->attached_dev);
829 phydev->adjust_link(phydev->attached_dev);
830 do_suspend = true;
831 }
832 break;
833 case PHY_RESUMING:
834 err = phy_clear_interrupt(phydev);
835 if (err)
836 break;
837
838 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
839 if (err)
840 break;
841
842 if (AUTONEG_ENABLE == phydev->autoneg) {
843 err = phy_aneg_done(phydev);
844 if (err < 0)
845 break;
846
847 /* err > 0 if AN is done.
848 * Otherwise, it's 0, and we're still waiting for AN
849 */
850 if (err > 0) {
851 err = phy_read_status(phydev);
852 if (err)
853 break;
854
855 if (phydev->link) {
856 phydev->state = PHY_RUNNING;
857 netif_carrier_on(phydev->attached_dev);
858 } else {
859 phydev->state = PHY_NOLINK;
860 }
861 phydev->adjust_link(phydev->attached_dev);
862 } else {
863 phydev->state = PHY_AN;
864 phydev->link_timeout = PHY_AN_TIMEOUT;
865 }
866 } else {
867 err = phy_read_status(phydev);
868 if (err)
869 break;
870
871 if (phydev->link) {
872 phydev->state = PHY_RUNNING;
873 netif_carrier_on(phydev->attached_dev);
874 } else {
875 phydev->state = PHY_NOLINK;
876 }
877 phydev->adjust_link(phydev->attached_dev);
878 }
879 do_resume = true;
880 break;
881 }
882
883 mutex_unlock(&phydev->lock);
884
885 if (needs_aneg)
886 err = phy_start_aneg(phydev);
887 else if (do_suspend)
888 phy_suspend(phydev);
889 else if (do_resume)
890 phy_resume(phydev);
891
892 if (err < 0)
893 phy_error(phydev);
894
895 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
896 PHY_STATE_TIME * HZ);
897}
898
899void phy_mac_interrupt(struct phy_device *phydev, int new_link)
900{
901 cancel_work_sync(&phydev->phy_queue);
902 phydev->link = new_link;
903 schedule_work(&phydev->phy_queue);
904}
905EXPORT_SYMBOL(phy_mac_interrupt);
906
907static inline void mmd_phy_indirect(struct mii_bus *bus, int prtad, int devad,
908 int addr)
909{
910 /* Write the desired MMD Devad */
911 bus->write(bus, addr, MII_MMD_CTRL, devad);
912
913 /* Write the desired MMD register address */
914 bus->write(bus, addr, MII_MMD_DATA, prtad);
915
916 /* Select the Function : DATA with no post increment */
917 bus->write(bus, addr, MII_MMD_CTRL, (devad | MII_MMD_CTRL_NOINCR));
918}
919
920/**
921 * phy_read_mmd_indirect - reads data from the MMD registers
922 * @bus: the target MII bus
923 * @prtad: MMD Address
924 * @devad: MMD DEVAD
925 * @addr: PHY address on the MII bus
926 *
927 * Description: it reads data from the MMD registers (clause 22 to access to
928 * clause 45) of the specified phy address.
929 * To read these register we have:
930 * 1) Write reg 13 // DEVAD
931 * 2) Write reg 14 // MMD Address
932 * 3) Write reg 13 // MMD Data Command for MMD DEVAD
933 * 3) Read reg 14 // Read MMD data
934 */
935static int phy_read_mmd_indirect(struct mii_bus *bus, int prtad, int devad,
936 int addr)
937{
938 mmd_phy_indirect(bus, prtad, devad, addr);
939
940 /* Read the content of the MMD's selected register */
941 return bus->read(bus, addr, MII_MMD_DATA);
942}
943
944/**
945 * phy_write_mmd_indirect - writes data to the MMD registers
946 * @bus: the target MII bus
947 * @prtad: MMD Address
948 * @devad: MMD DEVAD
949 * @addr: PHY address on the MII bus
950 * @data: data to write in the MMD register
951 *
952 * Description: Write data from the MMD registers of the specified
953 * phy address.
954 * To write these register we have:
955 * 1) Write reg 13 // DEVAD
956 * 2) Write reg 14 // MMD Address
957 * 3) Write reg 13 // MMD Data Command for MMD DEVAD
958 * 3) Write reg 14 // Write MMD data
959 */
960static void phy_write_mmd_indirect(struct mii_bus *bus, int prtad, int devad,
961 int addr, u32 data)
962{
963 mmd_phy_indirect(bus, prtad, devad, addr);
964
965 /* Write the data into MMD's selected register */
966 bus->write(bus, addr, MII_MMD_DATA, data);
967}
968
969/**
970 * phy_init_eee - init and check the EEE feature
971 * @phydev: target phy_device struct
972 * @clk_stop_enable: PHY may stop the clock during LPI
973 *
974 * Description: it checks if the Energy-Efficient Ethernet (EEE)
975 * is supported by looking at the MMD registers 3.20 and 7.60/61
976 * and it programs the MMD register 3.0 setting the "Clock stop enable"
977 * bit if required.
978 */
979int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
980{
981 /* According to 802.3az,the EEE is supported only in full duplex-mode.
982 * Also EEE feature is active when core is operating with MII, GMII
983 * or RGMII.
984 */
985 if ((phydev->duplex == DUPLEX_FULL) &&
986 ((phydev->interface == PHY_INTERFACE_MODE_MII) ||
987 (phydev->interface == PHY_INTERFACE_MODE_GMII) ||
988 (phydev->interface == PHY_INTERFACE_MODE_RGMII))) {
989 int eee_lp, eee_cap, eee_adv;
990 u32 lp, cap, adv;
991 int status;
992 unsigned int idx;
993
994 /* Read phy status to properly get the right settings */
995 status = phy_read_status(phydev);
996 if (status)
997 return status;
998
999 /* First check if the EEE ability is supported */
1000 eee_cap = phy_read_mmd_indirect(phydev->bus, MDIO_PCS_EEE_ABLE,
1001 MDIO_MMD_PCS, phydev->addr);
1002 if (eee_cap < 0)
1003 return eee_cap;
1004
1005 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1006 if (!cap)
1007 return -EPROTONOSUPPORT;
1008
1009 /* Check which link settings negotiated and verify it in
1010 * the EEE advertising registers.
1011 */
1012 eee_lp = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_LPABLE,
1013 MDIO_MMD_AN, phydev->addr);
1014 if (eee_lp < 0)
1015 return eee_lp;
1016
1017 eee_adv = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_ADV,
1018 MDIO_MMD_AN, phydev->addr);
1019 if (eee_adv < 0)
1020 return eee_adv;
1021
1022 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1023 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1024 idx = phy_find_setting(phydev->speed, phydev->duplex);
1025 if (!(lp & adv & settings[idx].setting))
1026 return -EPROTONOSUPPORT;
1027
1028 if (clk_stop_enable) {
1029 /* Configure the PHY to stop receiving xMII
1030 * clock while it is signaling LPI.
1031 */
1032 int val = phy_read_mmd_indirect(phydev->bus, MDIO_CTRL1,
1033 MDIO_MMD_PCS,
1034 phydev->addr);
1035 if (val < 0)
1036 return val;
1037
1038 val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1039 phy_write_mmd_indirect(phydev->bus, MDIO_CTRL1,
1040 MDIO_MMD_PCS, phydev->addr, val);
1041 }
1042
1043 return 0; /* EEE supported */
1044 }
1045
1046 return -EPROTONOSUPPORT;
1047}
1048EXPORT_SYMBOL(phy_init_eee);
1049
1050/**
1051 * phy_get_eee_err - report the EEE wake error count
1052 * @phydev: target phy_device struct
1053 *
1054 * Description: it is to report the number of time where the PHY
1055 * failed to complete its normal wake sequence.
1056 */
1057int phy_get_eee_err(struct phy_device *phydev)
1058{
1059 return phy_read_mmd_indirect(phydev->bus, MDIO_PCS_EEE_WK_ERR,
1060 MDIO_MMD_PCS, phydev->addr);
1061}
1062EXPORT_SYMBOL(phy_get_eee_err);
1063
1064/**
1065 * phy_ethtool_get_eee - get EEE supported and status
1066 * @phydev: target phy_device struct
1067 * @data: ethtool_eee data
1068 *
1069 * Description: it reportes the Supported/Advertisement/LP Advertisement
1070 * capabilities.
1071 */
1072int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1073{
1074 int val;
1075
1076 /* Get Supported EEE */
1077 val = phy_read_mmd_indirect(phydev->bus, MDIO_PCS_EEE_ABLE,
1078 MDIO_MMD_PCS, phydev->addr);
1079 if (val < 0)
1080 return val;
1081 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1082
1083 /* Get advertisement EEE */
1084 val = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_ADV,
1085 MDIO_MMD_AN, phydev->addr);
1086 if (val < 0)
1087 return val;
1088 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1089
1090 /* Get LP advertisement EEE */
1091 val = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_LPABLE,
1092 MDIO_MMD_AN, phydev->addr);
1093 if (val < 0)
1094 return val;
1095 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1096
1097 return 0;
1098}
1099EXPORT_SYMBOL(phy_ethtool_get_eee);
1100
1101/**
1102 * phy_ethtool_set_eee - set EEE supported and status
1103 * @phydev: target phy_device struct
1104 * @data: ethtool_eee data
1105 *
1106 * Description: it is to program the Advertisement EEE register.
1107 */
1108int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1109{
1110 int val = ethtool_adv_to_mmd_eee_adv_t(data->advertised);
1111
1112 phy_write_mmd_indirect(phydev->bus, MDIO_AN_EEE_ADV, MDIO_MMD_AN,
1113 phydev->addr, val);
1114
1115 return 0;
1116}
1117EXPORT_SYMBOL(phy_ethtool_set_eee);
1118
1119int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1120{
1121 if (phydev->drv->set_wol)
1122 return phydev->drv->set_wol(phydev, wol);
1123
1124 return -EOPNOTSUPP;
1125}
1126EXPORT_SYMBOL(phy_ethtool_set_wol);
1127
1128void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1129{
1130 if (phydev->drv->get_wol)
1131 phydev->drv->get_wol(phydev, wol);
1132}
1133EXPORT_SYMBOL(phy_ethtool_get_wol);