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