2
* drivers/net/phy/phy.c
4
* Framework for configuring and reading PHY devices
5
* Based on code in sungem_phy.c and gianfar_phy.c
9
* Copyright (c) 2004 Freescale Semiconductor, Inc.
10
* Copyright (c) 2006, 2007 Maciej W. Rozycki
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.
18
#include <linux/kernel.h>
19
#include <linux/string.h>
20
#include <linux/errno.h>
21
#include <linux/unistd.h>
22
#include <linux/slab.h>
23
#include <linux/interrupt.h>
24
#include <linux/init.h>
25
#include <linux/delay.h>
26
#include <linux/netdevice.h>
27
#include <linux/etherdevice.h>
28
#include <linux/skbuff.h>
30
#include <linux/module.h>
31
#include <linux/mii.h>
32
#include <linux/ethtool.h>
33
#include <linux/phy.h>
34
#include <linux/timer.h>
35
#include <linux/workqueue.h>
37
#include <asm/atomic.h>
40
#include <asm/uaccess.h>
43
* phy_print_status - Convenience function to print out the current phy status
44
* @phydev: the phy_device struct
46
void phy_print_status(struct phy_device *phydev)
48
pr_info("PHY: %s - Link is %s", dev_name(&phydev->dev),
49
phydev->link ? "Up" : "Down");
51
printk(" - %d/%s", phydev->speed,
52
DUPLEX_FULL == phydev->duplex ?
57
EXPORT_SYMBOL(phy_print_status);
61
* phy_clear_interrupt - Ack the phy device's interrupt
62
* @phydev: the phy_device struct
64
* If the @phydev driver has an ack_interrupt function, call it to
65
* ack and clear the phy device's interrupt.
67
* Returns 0 on success on < 0 on error.
69
int phy_clear_interrupt(struct phy_device *phydev)
73
if (phydev->drv->ack_interrupt)
74
err = phydev->drv->ack_interrupt(phydev);
80
* phy_config_interrupt - configure the PHY device for the requested interrupts
81
* @phydev: the phy_device struct
82
* @interrupts: interrupt flags to configure for this @phydev
84
* Returns 0 on success on < 0 on error.
86
int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
90
phydev->interrupts = interrupts;
91
if (phydev->drv->config_intr)
92
err = phydev->drv->config_intr(phydev);
99
* phy_aneg_done - return auto-negotiation status
100
* @phydev: target phy_device struct
102
* Description: Reads the status register and returns 0 either if
103
* auto-negotiation is incomplete, or if there was an error.
104
* Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
106
static inline int phy_aneg_done(struct phy_device *phydev)
110
retval = phy_read(phydev, MII_BMSR);
112
return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
115
/* A structure for mapping a particular speed and duplex
116
* combination to a particular SUPPORTED and ADVERTISED value */
123
/* A mapping of all SUPPORTED settings to speed/duplex */
124
static const struct phy_setting settings[] = {
127
.duplex = DUPLEX_FULL,
128
.setting = SUPPORTED_10000baseT_Full,
132
.duplex = DUPLEX_FULL,
133
.setting = SUPPORTED_1000baseT_Full,
137
.duplex = DUPLEX_HALF,
138
.setting = SUPPORTED_1000baseT_Half,
142
.duplex = DUPLEX_FULL,
143
.setting = SUPPORTED_100baseT_Full,
147
.duplex = DUPLEX_HALF,
148
.setting = SUPPORTED_100baseT_Half,
152
.duplex = DUPLEX_FULL,
153
.setting = SUPPORTED_10baseT_Full,
157
.duplex = DUPLEX_HALF,
158
.setting = SUPPORTED_10baseT_Half,
162
#define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
165
* phy_find_setting - find a PHY settings array entry that matches speed & duplex
166
* @speed: speed to match
167
* @duplex: duplex to match
169
* Description: Searches the settings array for the setting which
170
* matches the desired speed and duplex, and returns the index
171
* of that setting. Returns the index of the last setting if
172
* none of the others match.
174
static inline int phy_find_setting(int speed, int duplex)
178
while (idx < ARRAY_SIZE(settings) &&
179
(settings[idx].speed != speed ||
180
settings[idx].duplex != duplex))
183
return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
187
* phy_find_valid - find a PHY setting that matches the requested features mask
188
* @idx: The first index in settings[] to search
189
* @features: A mask of the valid settings
191
* Description: Returns the index of the first valid setting less
192
* than or equal to the one pointed to by idx, as determined by
193
* the mask in features. Returns the index of the last setting
194
* if nothing else matches.
196
static inline int phy_find_valid(int idx, u32 features)
198
while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
201
return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
205
* phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
206
* @phydev: the target phy_device struct
208
* Description: Make sure the PHY is set to supported speeds and
209
* duplexes. Drop down by one in this order: 1000/FULL,
210
* 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
212
void phy_sanitize_settings(struct phy_device *phydev)
214
u32 features = phydev->supported;
217
/* Sanitize settings based on PHY capabilities */
218
if ((features & SUPPORTED_Autoneg) == 0)
219
phydev->autoneg = AUTONEG_DISABLE;
221
idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
224
phydev->speed = settings[idx].speed;
225
phydev->duplex = settings[idx].duplex;
227
EXPORT_SYMBOL(phy_sanitize_settings);
230
* phy_ethtool_sset - generic ethtool sset function, handles all the details
231
* @phydev: target phy_device struct
234
* A few notes about parameter checking:
235
* - We don't set port or transceiver, so we don't care what they
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.
241
int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
243
if (cmd->phy_address != phydev->addr)
246
/* We make sure that we don't pass unsupported
247
* values in to the PHY */
248
cmd->advertising &= phydev->supported;
250
/* Verify the settings we care about. */
251
if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
254
if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
257
if (cmd->autoneg == AUTONEG_DISABLE &&
258
((cmd->speed != SPEED_1000 &&
259
cmd->speed != SPEED_100 &&
260
cmd->speed != SPEED_10) ||
261
(cmd->duplex != DUPLEX_HALF &&
262
cmd->duplex != DUPLEX_FULL)))
265
phydev->autoneg = cmd->autoneg;
267
phydev->speed = cmd->speed;
269
phydev->advertising = cmd->advertising;
271
if (AUTONEG_ENABLE == cmd->autoneg)
272
phydev->advertising |= ADVERTISED_Autoneg;
274
phydev->advertising &= ~ADVERTISED_Autoneg;
276
phydev->duplex = cmd->duplex;
278
/* Restart the PHY */
279
phy_start_aneg(phydev);
283
EXPORT_SYMBOL(phy_ethtool_sset);
285
int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
287
cmd->supported = phydev->supported;
289
cmd->advertising = phydev->advertising;
291
cmd->speed = 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;
300
EXPORT_SYMBOL(phy_ethtool_gset);
303
* phy_mii_ioctl - generic PHY MII ioctl interface
304
* @phydev: the phy_device struct
305
* @mii_data: MII ioctl data
306
* @cmd: ioctl cmd to execute
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.
312
int phy_mii_ioctl(struct phy_device *phydev,
313
struct mii_ioctl_data *mii_data, int cmd)
315
u16 val = mii_data->val_in;
319
mii_data->phy_id = phydev->addr;
323
mii_data->val_out = phy_read(phydev, mii_data->reg_num);
327
if (mii_data->phy_id == phydev->addr) {
328
switch(mii_data->reg_num) {
330
if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
331
phydev->autoneg = AUTONEG_DISABLE;
333
phydev->autoneg = AUTONEG_ENABLE;
334
if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
335
phydev->duplex = DUPLEX_FULL;
337
phydev->duplex = DUPLEX_HALF;
338
if ((!phydev->autoneg) &&
339
(val & BMCR_SPEED1000))
340
phydev->speed = SPEED_1000;
341
else if ((!phydev->autoneg) &&
342
(val & BMCR_SPEED100))
343
phydev->speed = SPEED_100;
346
phydev->advertising = val;
354
phy_write(phydev, mii_data->reg_num, val);
356
if (mii_data->reg_num == MII_BMCR &&
358
phydev->drv->config_init) {
359
phy_scan_fixups(phydev);
360
phydev->drv->config_init(phydev);
370
EXPORT_SYMBOL(phy_mii_ioctl);
373
* phy_start_aneg - start auto-negotiation for this PHY device
374
* @phydev: the phy_device struct
376
* Description: Sanitizes the settings (if we're not autonegotiating
377
* them), and then calls the driver's config_aneg function.
378
* If the PHYCONTROL Layer is operating, we change the state to
379
* reflect the beginning of Auto-negotiation or forcing.
381
int phy_start_aneg(struct phy_device *phydev)
385
mutex_lock(&phydev->lock);
387
if (AUTONEG_DISABLE == phydev->autoneg)
388
phy_sanitize_settings(phydev);
390
err = phydev->drv->config_aneg(phydev);
395
if (phydev->state != PHY_HALTED) {
396
if (AUTONEG_ENABLE == phydev->autoneg) {
397
phydev->state = PHY_AN;
398
phydev->link_timeout = PHY_AN_TIMEOUT;
400
phydev->state = PHY_FORCING;
401
phydev->link_timeout = PHY_FORCE_TIMEOUT;
406
mutex_unlock(&phydev->lock);
409
EXPORT_SYMBOL(phy_start_aneg);
412
static void phy_change(struct work_struct *work);
415
* phy_start_machine - start PHY state machine tracking
416
* @phydev: the phy_device struct
417
* @handler: callback function for state change notifications
419
* Description: The PHY infrastructure can run a state machine
420
* which tracks whether the PHY is starting up, negotiating,
421
* etc. This function starts the timer which tracks the state
422
* of the PHY. If you want to be notified when the state changes,
423
* pass in the callback @handler, otherwise, pass NULL. If you
424
* want to maintain your own state machine, do not call this
427
void phy_start_machine(struct phy_device *phydev,
428
void (*handler)(struct net_device *))
430
phydev->adjust_state = handler;
432
schedule_delayed_work(&phydev->state_queue, HZ);
436
* phy_stop_machine - stop the PHY state machine tracking
437
* @phydev: target phy_device struct
439
* Description: Stops the state machine timer, sets the state to UP
440
* (unless it wasn't up yet). This function must be called BEFORE
443
void phy_stop_machine(struct phy_device *phydev)
445
cancel_delayed_work_sync(&phydev->state_queue);
447
mutex_lock(&phydev->lock);
448
if (phydev->state > PHY_UP)
449
phydev->state = PHY_UP;
450
mutex_unlock(&phydev->lock);
452
phydev->adjust_state = NULL;
456
* phy_force_reduction - reduce PHY speed/duplex settings by one step
457
* @phydev: target phy_device struct
459
* Description: Reduces the speed/duplex settings by one notch,
461
* 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
462
* The function bottoms out at 10/HALF.
464
static void phy_force_reduction(struct phy_device *phydev)
468
idx = phy_find_setting(phydev->speed, phydev->duplex);
472
idx = phy_find_valid(idx, phydev->supported);
474
phydev->speed = settings[idx].speed;
475
phydev->duplex = settings[idx].duplex;
477
pr_info("Trying %d/%s\n", phydev->speed,
478
DUPLEX_FULL == phydev->duplex ?
484
* phy_error - enter HALTED state for this PHY device
485
* @phydev: target phy_device struct
487
* Moves the PHY to the HALTED state in response to a read
488
* or write error, and tells the controller the link is down.
489
* Must not be called from interrupt context, or while the
490
* phydev->lock is held.
492
static void phy_error(struct phy_device *phydev)
494
mutex_lock(&phydev->lock);
495
phydev->state = PHY_HALTED;
496
mutex_unlock(&phydev->lock);
500
* phy_interrupt - PHY interrupt handler
501
* @irq: interrupt line
502
* @phy_dat: phy_device pointer
504
* Description: When a PHY interrupt occurs, the handler disables
505
* interrupts, and schedules a work task to clear the interrupt.
507
static irqreturn_t phy_interrupt(int irq, void *phy_dat)
509
struct phy_device *phydev = phy_dat;
511
if (PHY_HALTED == phydev->state)
512
return IRQ_NONE; /* It can't be ours. */
514
/* The MDIO bus is not allowed to be written in interrupt
515
* context, so we need to disable the irq here. A work
516
* queue will write the PHY to disable and clear the
517
* interrupt, and then reenable the irq line. */
518
disable_irq_nosync(irq);
519
atomic_inc(&phydev->irq_disable);
521
schedule_work(&phydev->phy_queue);
527
* phy_enable_interrupts - Enable the interrupts from the PHY side
528
* @phydev: target phy_device struct
530
int phy_enable_interrupts(struct phy_device *phydev)
534
err = phy_clear_interrupt(phydev);
539
err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
543
EXPORT_SYMBOL(phy_enable_interrupts);
546
* phy_disable_interrupts - Disable the PHY interrupts from the PHY side
547
* @phydev: target phy_device struct
549
int phy_disable_interrupts(struct phy_device *phydev)
553
/* Disable PHY interrupts */
554
err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
559
/* Clear the interrupt */
560
err = phy_clear_interrupt(phydev);
572
EXPORT_SYMBOL(phy_disable_interrupts);
575
* phy_start_interrupts - request and enable interrupts for a PHY device
576
* @phydev: target phy_device struct
578
* Description: Request the interrupt for the given PHY.
579
* If this fails, then we set irq to PHY_POLL.
580
* Otherwise, we enable the interrupts in the PHY.
581
* This should only be called with a valid IRQ number.
582
* Returns 0 on success or < 0 on error.
584
int phy_start_interrupts(struct phy_device *phydev)
588
INIT_WORK(&phydev->phy_queue, phy_change);
590
atomic_set(&phydev->irq_disable, 0);
591
if (request_irq(phydev->irq, phy_interrupt,
595
printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
598
phydev->irq = PHY_POLL;
602
err = phy_enable_interrupts(phydev);
606
EXPORT_SYMBOL(phy_start_interrupts);
609
* phy_stop_interrupts - disable interrupts from a PHY device
610
* @phydev: target phy_device struct
612
int phy_stop_interrupts(struct phy_device *phydev)
616
err = phy_disable_interrupts(phydev);
621
free_irq(phydev->irq, phydev);
624
* Cannot call flush_scheduled_work() here as desired because
625
* of rtnl_lock(), but we do not really care about what would
626
* be done, except from enable_irq(), so cancel any work
627
* possibly pending and take care of the matter below.
629
cancel_work_sync(&phydev->phy_queue);
631
* If work indeed has been cancelled, disable_irq() will have
632
* been left unbalanced from phy_interrupt() and enable_irq()
633
* has to be called so that other devices on the line work.
635
while (atomic_dec_return(&phydev->irq_disable) >= 0)
636
enable_irq(phydev->irq);
640
EXPORT_SYMBOL(phy_stop_interrupts);
644
* phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
645
* @work: work_struct that describes the work to be done
647
static void phy_change(struct work_struct *work)
650
struct phy_device *phydev =
651
container_of(work, struct phy_device, phy_queue);
653
if (phydev->drv->did_interrupt &&
654
!phydev->drv->did_interrupt(phydev))
657
err = phy_disable_interrupts(phydev);
662
mutex_lock(&phydev->lock);
663
if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
664
phydev->state = PHY_CHANGELINK;
665
mutex_unlock(&phydev->lock);
667
atomic_dec(&phydev->irq_disable);
668
enable_irq(phydev->irq);
670
/* Reenable interrupts */
671
if (PHY_HALTED != phydev->state)
672
err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
677
/* reschedule state queue work to run as soon as possible */
678
cancel_delayed_work_sync(&phydev->state_queue);
679
schedule_delayed_work(&phydev->state_queue, 0);
684
atomic_dec(&phydev->irq_disable);
685
enable_irq(phydev->irq);
689
disable_irq(phydev->irq);
690
atomic_inc(&phydev->irq_disable);
696
* phy_stop - Bring down the PHY link, and stop checking the status
697
* @phydev: target phy_device struct
699
void phy_stop(struct phy_device *phydev)
701
mutex_lock(&phydev->lock);
703
if (PHY_HALTED == phydev->state)
706
if (phydev->irq != PHY_POLL) {
707
/* Disable PHY Interrupts */
708
phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
710
/* Clear any pending interrupts */
711
phy_clear_interrupt(phydev);
714
phydev->state = PHY_HALTED;
717
mutex_unlock(&phydev->lock);
720
* Cannot call flush_scheduled_work() here as desired because
721
* of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
722
* will not reenable interrupts.
728
* phy_start - start or restart a PHY device
729
* @phydev: target phy_device struct
731
* Description: Indicates the attached device's readiness to
732
* handle PHY-related work. Used during startup to start the
733
* PHY, and after a call to phy_stop() to resume operation.
734
* Also used to indicate the MDIO bus has cleared an error
737
void phy_start(struct phy_device *phydev)
739
mutex_lock(&phydev->lock);
741
switch (phydev->state) {
743
phydev->state = PHY_PENDING;
746
phydev->state = PHY_UP;
749
phydev->state = PHY_RESUMING;
753
mutex_unlock(&phydev->lock);
755
EXPORT_SYMBOL(phy_stop);
756
EXPORT_SYMBOL(phy_start);
759
* phy_state_machine - Handle the state machine
760
* @work: work_struct that describes the work to be done
762
void phy_state_machine(struct work_struct *work)
764
struct delayed_work *dwork = to_delayed_work(work);
765
struct phy_device *phydev =
766
container_of(dwork, struct phy_device, state_queue);
770
mutex_lock(&phydev->lock);
772
if (phydev->adjust_state)
773
phydev->adjust_state(phydev->attached_dev);
775
switch(phydev->state) {
784
phydev->link_timeout = PHY_AN_TIMEOUT;
788
err = phy_read_status(phydev);
793
/* If the link is down, give up on
794
* negotiation for now */
796
phydev->state = PHY_NOLINK;
797
netif_carrier_off(phydev->attached_dev);
798
phydev->adjust_link(phydev->attached_dev);
802
/* Check if negotiation is done. Break
803
* if there's an error */
804
err = phy_aneg_done(phydev);
808
/* If AN is done, we're running */
810
phydev->state = PHY_RUNNING;
811
netif_carrier_on(phydev->attached_dev);
812
phydev->adjust_link(phydev->attached_dev);
814
} else if (0 == phydev->link_timeout--) {
818
/* If we have the magic_aneg bit,
820
if (phydev->drv->flags & PHY_HAS_MAGICANEG)
823
/* The timer expired, and we still
824
* don't have a setting, so we try
825
* forcing it until we find one that
826
* works, starting from the fastest speed,
827
* and working our way down */
828
idx = phy_find_valid(0, phydev->supported);
830
phydev->speed = settings[idx].speed;
831
phydev->duplex = settings[idx].duplex;
833
phydev->autoneg = AUTONEG_DISABLE;
835
pr_info("Trying %d/%s\n", phydev->speed,
842
err = phy_read_status(phydev);
848
phydev->state = PHY_RUNNING;
849
netif_carrier_on(phydev->attached_dev);
850
phydev->adjust_link(phydev->attached_dev);
854
err = genphy_update_link(phydev);
860
phydev->state = PHY_RUNNING;
861
netif_carrier_on(phydev->attached_dev);
863
if (0 == phydev->link_timeout--) {
864
phy_force_reduction(phydev);
869
phydev->adjust_link(phydev->attached_dev);
872
/* Only register a CHANGE if we are
874
if (PHY_POLL == phydev->irq)
875
phydev->state = PHY_CHANGELINK;
878
err = phy_read_status(phydev);
884
phydev->state = PHY_RUNNING;
885
netif_carrier_on(phydev->attached_dev);
887
phydev->state = PHY_NOLINK;
888
netif_carrier_off(phydev->attached_dev);
891
phydev->adjust_link(phydev->attached_dev);
893
if (PHY_POLL != phydev->irq)
894
err = phy_config_interrupt(phydev,
895
PHY_INTERRUPT_ENABLED);
900
netif_carrier_off(phydev->attached_dev);
901
phydev->adjust_link(phydev->attached_dev);
906
err = phy_clear_interrupt(phydev);
911
err = phy_config_interrupt(phydev,
912
PHY_INTERRUPT_ENABLED);
917
if (AUTONEG_ENABLE == phydev->autoneg) {
918
err = phy_aneg_done(phydev);
922
/* err > 0 if AN is done.
923
* Otherwise, it's 0, and we're
924
* still waiting for AN */
926
err = phy_read_status(phydev);
931
phydev->state = PHY_RUNNING;
932
netif_carrier_on(phydev->attached_dev);
934
phydev->state = PHY_NOLINK;
935
phydev->adjust_link(phydev->attached_dev);
937
phydev->state = PHY_AN;
938
phydev->link_timeout = PHY_AN_TIMEOUT;
941
err = phy_read_status(phydev);
946
phydev->state = PHY_RUNNING;
947
netif_carrier_on(phydev->attached_dev);
949
phydev->state = PHY_NOLINK;
950
phydev->adjust_link(phydev->attached_dev);
955
mutex_unlock(&phydev->lock);
958
err = phy_start_aneg(phydev);
963
schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);