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