blob: 0295097d6c4435c7fb720e6fe580bd637be33173 [file] [log] [blame]
Andy Fleming00db8182005-07-30 19:31:23 -04001/*
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.
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -070010 * Copyright (c) 2006, 2007 Maciej W. Rozycki
Andy Fleming00db8182005-07-30 19:31:23 -040011 *
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 */
Andy Fleming00db8182005-07-30 19:31:23 -040018#include <linux/kernel.h>
Andy Fleming00db8182005-07-30 19:31:23 -040019#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>
Andy Fleming00db8182005-07-30 19:31:23 -040029#include <linux/mm.h>
30#include <linux/module.h>
Andy Fleming00db8182005-07-30 19:31:23 -040031#include <linux/mii.h>
32#include <linux/ethtool.h>
33#include <linux/phy.h>
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +010034#include <linux/timer.h>
35#include <linux/workqueue.h>
Andy Fleming00db8182005-07-30 19:31:23 -040036
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -070037#include <asm/atomic.h>
Andy Fleming00db8182005-07-30 19:31:23 -040038#include <asm/io.h>
39#include <asm/irq.h>
40#include <asm/uaccess.h>
41
Randy Dunlapb3df0da2007-03-06 02:41:48 -080042/**
43 * phy_print_status - Convenience function to print out the current phy status
44 * @phydev: the phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -050045 */
46void phy_print_status(struct phy_device *phydev)
47{
Kay Sieversfb28ad32008-11-10 13:55:14 -080048 pr_info("PHY: %s - Link is %s", dev_name(&phydev->dev),
Andy Fleminge1393452005-08-24 18:46:21 -050049 phydev->link ? "Up" : "Down");
50 if (phydev->link)
51 printk(" - %d/%s", phydev->speed,
52 DUPLEX_FULL == phydev->duplex ?
53 "Full" : "Half");
54
55 printk("\n");
56}
57EXPORT_SYMBOL(phy_print_status);
Andy Fleming00db8182005-07-30 19:31:23 -040058
59
Randy Dunlapb3df0da2007-03-06 02:41:48 -080060/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -080061 * phy_clear_interrupt - Ack the phy device's interrupt
62 * @phydev: the phy_device struct
63 *
64 * If the @phydev driver has an ack_interrupt function, call it to
65 * ack and clear the phy device's interrupt.
66 *
67 * Returns 0 on success on < 0 on error.
68 */
Andy Fleming00db8182005-07-30 19:31:23 -040069int phy_clear_interrupt(struct phy_device *phydev)
70{
71 int err = 0;
72
73 if (phydev->drv->ack_interrupt)
74 err = phydev->drv->ack_interrupt(phydev);
75
76 return err;
77}
78
Randy Dunlapb3df0da2007-03-06 02:41:48 -080079/**
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
83 *
84 * Returns 0 on success on < 0 on error.
85 */
Andy Fleming00db8182005-07-30 19:31:23 -040086int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
87{
88 int err = 0;
89
90 phydev->interrupts = interrupts;
91 if (phydev->drv->config_intr)
92 err = phydev->drv->config_intr(phydev);
93
94 return err;
95}
96
97
Randy Dunlapb3df0da2007-03-06 02:41:48 -080098/**
99 * phy_aneg_done - return auto-negotiation status
100 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400101 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800102 * Description: Reads the status register and returns 0 either if
Andy Fleming00db8182005-07-30 19:31:23 -0400103 * auto-negotiation is incomplete, or if there was an error.
104 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
105 */
106static inline int phy_aneg_done(struct phy_device *phydev)
107{
108 int retval;
109
110 retval = phy_read(phydev, MII_BMSR);
111
112 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
113}
114
Andy Fleming00db8182005-07-30 19:31:23 -0400115/* A structure for mapping a particular speed and duplex
116 * combination to a particular SUPPORTED and ADVERTISED value */
117struct phy_setting {
118 int speed;
119 int duplex;
120 u32 setting;
121};
122
123/* A mapping of all SUPPORTED settings to speed/duplex */
Arjan van de Venf71e1302006-03-03 21:33:57 -0500124static const struct phy_setting settings[] = {
Andy Fleming00db8182005-07-30 19:31:23 -0400125 {
126 .speed = 10000,
127 .duplex = DUPLEX_FULL,
128 .setting = SUPPORTED_10000baseT_Full,
129 },
130 {
131 .speed = SPEED_1000,
132 .duplex = DUPLEX_FULL,
133 .setting = SUPPORTED_1000baseT_Full,
134 },
135 {
136 .speed = SPEED_1000,
137 .duplex = DUPLEX_HALF,
138 .setting = SUPPORTED_1000baseT_Half,
139 },
140 {
141 .speed = SPEED_100,
142 .duplex = DUPLEX_FULL,
143 .setting = SUPPORTED_100baseT_Full,
144 },
145 {
146 .speed = SPEED_100,
147 .duplex = DUPLEX_HALF,
148 .setting = SUPPORTED_100baseT_Half,
149 },
150 {
151 .speed = SPEED_10,
152 .duplex = DUPLEX_FULL,
153 .setting = SUPPORTED_10baseT_Full,
154 },
155 {
156 .speed = SPEED_10,
157 .duplex = DUPLEX_HALF,
158 .setting = SUPPORTED_10baseT_Half,
159 },
160};
161
Denis Chengff8ac602007-09-02 18:30:18 +0800162#define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
Andy Fleming00db8182005-07-30 19:31:23 -0400163
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800164/**
165 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
166 * @speed: speed to match
167 * @duplex: duplex to match
Andy Fleming00db8182005-07-30 19:31:23 -0400168 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800169 * Description: Searches the settings array for the setting which
Andy Fleming00db8182005-07-30 19:31:23 -0400170 * 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.
173 */
174static inline int phy_find_setting(int speed, int duplex)
175{
176 int idx = 0;
177
178 while (idx < ARRAY_SIZE(settings) &&
179 (settings[idx].speed != speed ||
180 settings[idx].duplex != duplex))
181 idx++;
182
183 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
184}
185
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800186/**
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
Andy Fleming00db8182005-07-30 19:31:23 -0400190 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800191 * Description: Returns the index of the first valid setting less
Andy Fleming00db8182005-07-30 19:31:23 -0400192 * 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.
195 */
196static inline int phy_find_valid(int idx, u32 features)
197{
198 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
199 idx++;
200
201 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
202}
203
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800204/**
205 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
206 * @phydev: the target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400207 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800208 * Description: Make sure the PHY is set to supported speeds and
Andy Fleming00db8182005-07-30 19:31:23 -0400209 * duplexes. Drop down by one in this order: 1000/FULL,
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800210 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
Andy Fleming00db8182005-07-30 19:31:23 -0400211 */
Andy Fleminge1393452005-08-24 18:46:21 -0500212void phy_sanitize_settings(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400213{
214 u32 features = phydev->supported;
215 int idx;
216
217 /* Sanitize settings based on PHY capabilities */
218 if ((features & SUPPORTED_Autoneg) == 0)
Domen Puncer163642a2007-08-07 12:12:41 +0200219 phydev->autoneg = AUTONEG_DISABLE;
Andy Fleming00db8182005-07-30 19:31:23 -0400220
221 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
222 features);
223
224 phydev->speed = settings[idx].speed;
225 phydev->duplex = settings[idx].duplex;
226}
Andy Fleminge1393452005-08-24 18:46:21 -0500227EXPORT_SYMBOL(phy_sanitize_settings);
Andy Fleming00db8182005-07-30 19:31:23 -0400228
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800229/**
230 * phy_ethtool_sset - generic ethtool sset function, handles all the details
231 * @phydev: target phy_device struct
232 * @cmd: ethtool_cmd
Andy Fleming00db8182005-07-30 19:31:23 -0400233 *
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
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800239 * care if ethtool tries to give us bad values.
Andy Fleming00db8182005-07-30 19:31:23 -0400240 */
241int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *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
Joe Perches8e95a202009-12-03 07:58:21 +0000257 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)))
Andy Fleming00db8182005-07-30 19:31:23 -0400263 return -EINVAL;
264
265 phydev->autoneg = cmd->autoneg;
266
267 phydev->speed = cmd->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}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600283EXPORT_SYMBOL(phy_ethtool_sset);
Andy Fleming00db8182005-07-30 19:31:23 -0400284
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 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;
297
298 return 0;
299}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600300EXPORT_SYMBOL(phy_ethtool_gset);
Andy Fleming00db8182005-07-30 19:31:23 -0400301
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800302/**
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
307 *
308 * Note that this function is currently incompatible with the
Andy Fleming00db8182005-07-30 19:31:23 -0400309 * PHYCONTROL layer. It changes registers without regard to
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800310 * current state. Use at own risk.
Andy Fleming00db8182005-07-30 19:31:23 -0400311 */
312int phy_mii_ioctl(struct phy_device *phydev,
313 struct mii_ioctl_data *mii_data, int cmd)
314{
315 u16 val = mii_data->val_in;
316
317 switch (cmd) {
318 case SIOCGMIIPHY:
319 mii_data->phy_id = phydev->addr;
Lennert Buytenhekc6d6a512008-09-18 03:06:52 +0000320 /* fall through */
321
Andy Fleming00db8182005-07-30 19:31:23 -0400322 case SIOCGMIIREG:
323 mii_data->val_out = phy_read(phydev, mii_data->reg_num);
324 break;
325
326 case SIOCSMIIREG:
Andy Fleming00db8182005-07-30 19:31:23 -0400327 if (mii_data->phy_id == phydev->addr) {
328 switch(mii_data->reg_num) {
329 case MII_BMCR:
Domen Puncer163642a2007-08-07 12:12:41 +0200330 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
Andy Fleming00db8182005-07-30 19:31:23 -0400331 phydev->autoneg = AUTONEG_DISABLE;
332 else
333 phydev->autoneg = AUTONEG_ENABLE;
334 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
335 phydev->duplex = DUPLEX_FULL;
336 else
337 phydev->duplex = DUPLEX_HALF;
Shan Lu024a0a32007-03-06 02:42:03 -0800338 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;
Andy Fleming00db8182005-07-30 19:31:23 -0400344 break;
345 case MII_ADVERTISE:
346 phydev->advertising = val;
347 break;
348 default:
349 /* do nothing */
350 break;
351 }
352 }
353
354 phy_write(phydev, mii_data->reg_num, val);
355
Joe Perches8e95a202009-12-03 07:58:21 +0000356 if (mii_data->reg_num == MII_BMCR &&
357 val & BMCR_RESET &&
358 phydev->drv->config_init) {
Andy Flemingf62220d2008-04-18 17:29:54 -0500359 phy_scan_fixups(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400360 phydev->drv->config_init(phydev);
Andy Flemingf62220d2008-04-18 17:29:54 -0500361 }
Andy Fleming00db8182005-07-30 19:31:23 -0400362 break;
David Woodhousedda93b42007-11-28 19:56:34 +0000363
364 default:
Lennert Buytenhekc6d6a512008-09-18 03:06:52 +0000365 return -EOPNOTSUPP;
Andy Fleming00db8182005-07-30 19:31:23 -0400366 }
367
368 return 0;
369}
Domen Puncer680e9fe2007-09-17 22:21:40 +0200370EXPORT_SYMBOL(phy_mii_ioctl);
Andy Fleming00db8182005-07-30 19:31:23 -0400371
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800372/**
373 * phy_start_aneg - start auto-negotiation for this PHY device
374 * @phydev: the phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500375 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800376 * 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.
Andy Fleminge1393452005-08-24 18:46:21 -0500380 */
381int phy_start_aneg(struct phy_device *phydev)
382{
383 int err;
384
Nate Case35b5f6b2008-01-29 10:05:09 -0600385 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500386
387 if (AUTONEG_DISABLE == phydev->autoneg)
388 phy_sanitize_settings(phydev);
389
390 err = phydev->drv->config_aneg(phydev);
391
Andy Fleminge1393452005-08-24 18:46:21 -0500392 if (err < 0)
393 goto out_unlock;
394
395 if (phydev->state != PHY_HALTED) {
396 if (AUTONEG_ENABLE == phydev->autoneg) {
397 phydev->state = PHY_AN;
398 phydev->link_timeout = PHY_AN_TIMEOUT;
399 } else {
400 phydev->state = PHY_FORCING;
401 phydev->link_timeout = PHY_FORCE_TIMEOUT;
402 }
403 }
404
405out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600406 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500407 return err;
408}
409EXPORT_SYMBOL(phy_start_aneg);
410
411
David Howellsc4028952006-11-22 14:57:56 +0000412static void phy_change(struct work_struct *work);
Andy Fleminge1393452005-08-24 18:46:21 -0500413
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800414/**
415 * phy_start_machine - start PHY state machine tracking
416 * @phydev: the phy_device struct
417 * @handler: callback function for state change notifications
Andy Fleming00db8182005-07-30 19:31:23 -0400418 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800419 * Description: The PHY infrastructure can run a state machine
Andy Fleming00db8182005-07-30 19:31:23 -0400420 * which tracks whether the PHY is starting up, negotiating,
421 * etc. This function starts the timer which tracks the state
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800422 * of the PHY. If you want to be notified when the state changes,
423 * pass in the callback @handler, otherwise, pass NULL. If you
Andy Fleming00db8182005-07-30 19:31:23 -0400424 * want to maintain your own state machine, do not call this
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800425 * function.
426 */
Andy Fleming00db8182005-07-30 19:31:23 -0400427void phy_start_machine(struct phy_device *phydev,
428 void (*handler)(struct net_device *))
429{
430 phydev->adjust_state = handler;
431
Atsushi Nemoto36640902009-04-16 02:43:37 -0700432 schedule_delayed_work(&phydev->state_queue, HZ);
Andy Fleming00db8182005-07-30 19:31:23 -0400433}
434
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800435/**
436 * phy_stop_machine - stop the PHY state machine tracking
437 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400438 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800439 * Description: Stops the state machine timer, sets the state to UP
Sergei Shtylylov817acf52006-07-26 00:53:53 +0400440 * (unless it wasn't up yet). This function must be called BEFORE
Andy Fleming00db8182005-07-30 19:31:23 -0400441 * phy_detach.
442 */
443void phy_stop_machine(struct phy_device *phydev)
444{
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700445 cancel_delayed_work_sync(&phydev->state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400446
Nate Case35b5f6b2008-01-29 10:05:09 -0600447 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400448 if (phydev->state > PHY_UP)
449 phydev->state = PHY_UP;
Nate Case35b5f6b2008-01-29 10:05:09 -0600450 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400451
Andy Fleming00db8182005-07-30 19:31:23 -0400452 phydev->adjust_state = NULL;
453}
454
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800455/**
456 * phy_force_reduction - reduce PHY speed/duplex settings by one step
457 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500458 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800459 * Description: Reduces the speed/duplex settings by one notch,
460 * in this order--
461 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
462 * The function bottoms out at 10/HALF.
Andy Fleminge1393452005-08-24 18:46:21 -0500463 */
464static void phy_force_reduction(struct phy_device *phydev)
465{
466 int idx;
467
468 idx = phy_find_setting(phydev->speed, phydev->duplex);
469
470 idx++;
471
472 idx = phy_find_valid(idx, phydev->supported);
473
474 phydev->speed = settings[idx].speed;
475 phydev->duplex = settings[idx].duplex;
476
477 pr_info("Trying %d/%s\n", phydev->speed,
478 DUPLEX_FULL == phydev->duplex ?
479 "FULL" : "HALF");
480}
481
482
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800483/**
484 * phy_error - enter HALTED state for this PHY device
485 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400486 *
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.
491 */
Andy Fleming9b9a8bf2008-05-02 13:00:51 -0500492static void phy_error(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400493{
Nate Case35b5f6b2008-01-29 10:05:09 -0600494 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400495 phydev->state = PHY_HALTED;
Nate Case35b5f6b2008-01-29 10:05:09 -0600496 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400497}
498
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800499/**
500 * phy_interrupt - PHY interrupt handler
501 * @irq: interrupt line
502 * @phy_dat: phy_device pointer
Andy Fleminge1393452005-08-24 18:46:21 -0500503 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800504 * Description: When a PHY interrupt occurs, the handler disables
Andy Fleminge1393452005-08-24 18:46:21 -0500505 * interrupts, and schedules a work task to clear the interrupt.
506 */
David Howells7d12e782006-10-05 14:55:46 +0100507static irqreturn_t phy_interrupt(int irq, void *phy_dat)
Andy Fleminge1393452005-08-24 18:46:21 -0500508{
509 struct phy_device *phydev = phy_dat;
510
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100511 if (PHY_HALTED == phydev->state)
512 return IRQ_NONE; /* It can't be ours. */
513
Andy Fleminge1393452005-08-24 18:46:21 -0500514 /* 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);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700519 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500520
521 schedule_work(&phydev->phy_queue);
522
523 return IRQ_HANDLED;
524}
525
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800526/**
527 * phy_enable_interrupts - Enable the interrupts from the PHY side
528 * @phydev: target phy_device struct
529 */
Andy Fleminge1393452005-08-24 18:46:21 -0500530int phy_enable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400531{
532 int err;
533
Andy Fleminge1393452005-08-24 18:46:21 -0500534 err = phy_clear_interrupt(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400535
Andy Fleminge1393452005-08-24 18:46:21 -0500536 if (err < 0)
537 return err;
Andy Fleming00db8182005-07-30 19:31:23 -0400538
Andy Fleminge1393452005-08-24 18:46:21 -0500539 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleming00db8182005-07-30 19:31:23 -0400540
541 return err;
542}
Andy Fleminge1393452005-08-24 18:46:21 -0500543EXPORT_SYMBOL(phy_enable_interrupts);
Andy Fleming00db8182005-07-30 19:31:23 -0400544
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800545/**
546 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
547 * @phydev: target phy_device struct
548 */
Andy Fleminge1393452005-08-24 18:46:21 -0500549int phy_disable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400550{
551 int err;
552
553 /* Disable PHY interrupts */
554 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
555
556 if (err)
557 goto phy_err;
558
559 /* Clear the interrupt */
560 err = phy_clear_interrupt(phydev);
561
562 if (err)
563 goto phy_err;
564
565 return 0;
566
567phy_err:
568 phy_error(phydev);
569
570 return err;
571}
Andy Fleminge1393452005-08-24 18:46:21 -0500572EXPORT_SYMBOL(phy_disable_interrupts);
573
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800574/**
575 * phy_start_interrupts - request and enable interrupts for a PHY device
576 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500577 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800578 * Description: Request the interrupt for the given PHY.
579 * If this fails, then we set irq to PHY_POLL.
Andy Fleminge1393452005-08-24 18:46:21 -0500580 * Otherwise, we enable the interrupts in the PHY.
Andy Fleminge1393452005-08-24 18:46:21 -0500581 * This should only be called with a valid IRQ number.
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800582 * Returns 0 on success or < 0 on error.
Andy Fleminge1393452005-08-24 18:46:21 -0500583 */
584int phy_start_interrupts(struct phy_device *phydev)
585{
586 int err = 0;
587
David Howellsc4028952006-11-22 14:57:56 +0000588 INIT_WORK(&phydev->phy_queue, phy_change);
Andy Fleminge1393452005-08-24 18:46:21 -0500589
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700590 atomic_set(&phydev->irq_disable, 0);
Andy Fleminge1393452005-08-24 18:46:21 -0500591 if (request_irq(phydev->irq, phy_interrupt,
Thomas Gleixner1fb9df52006-07-01 19:29:39 -0700592 IRQF_SHARED,
Andy Fleminge1393452005-08-24 18:46:21 -0500593 "phy_interrupt",
594 phydev) < 0) {
595 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
596 phydev->bus->name,
597 phydev->irq);
598 phydev->irq = PHY_POLL;
599 return 0;
600 }
601
602 err = phy_enable_interrupts(phydev);
603
604 return err;
605}
606EXPORT_SYMBOL(phy_start_interrupts);
607
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800608/**
609 * phy_stop_interrupts - disable interrupts from a PHY device
610 * @phydev: target phy_device struct
611 */
Andy Fleminge1393452005-08-24 18:46:21 -0500612int phy_stop_interrupts(struct phy_device *phydev)
613{
614 int err;
615
616 err = phy_disable_interrupts(phydev);
617
618 if (err)
619 phy_error(phydev);
620
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700621 free_irq(phydev->irq, phydev);
622
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100623 /*
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700624 * 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.
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100628 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700629 cancel_work_sync(&phydev->phy_queue);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700630 /*
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.
634 */
635 while (atomic_dec_return(&phydev->irq_disable) >= 0)
636 enable_irq(phydev->irq);
Andy Fleminge1393452005-08-24 18:46:21 -0500637
638 return err;
639}
640EXPORT_SYMBOL(phy_stop_interrupts);
641
642
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800643/**
644 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
645 * @work: work_struct that describes the work to be done
646 */
David Howellsc4028952006-11-22 14:57:56 +0000647static void phy_change(struct work_struct *work)
Andy Fleminge1393452005-08-24 18:46:21 -0500648{
649 int err;
David Howellsc4028952006-11-22 14:57:56 +0000650 struct phy_device *phydev =
651 container_of(work, struct phy_device, phy_queue);
Andy Fleminge1393452005-08-24 18:46:21 -0500652
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000653 if (phydev->drv->did_interrupt &&
654 !phydev->drv->did_interrupt(phydev))
655 goto ignore;
656
Andy Fleminge1393452005-08-24 18:46:21 -0500657 err = phy_disable_interrupts(phydev);
658
659 if (err)
660 goto phy_err;
661
Nate Case35b5f6b2008-01-29 10:05:09 -0600662 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500663 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
664 phydev->state = PHY_CHANGELINK;
Nate Case35b5f6b2008-01-29 10:05:09 -0600665 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500666
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700667 atomic_dec(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500668 enable_irq(phydev->irq);
669
670 /* Reenable interrupts */
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100671 if (PHY_HALTED != phydev->state)
672 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500673
674 if (err)
675 goto irq_enable_err;
676
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700677 /* 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);
Trent Piepho0acb2832008-10-08 15:46:57 -0700680
Andy Fleminge1393452005-08-24 18:46:21 -0500681 return;
682
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000683ignore:
684 atomic_dec(&phydev->irq_disable);
685 enable_irq(phydev->irq);
686 return;
687
Andy Fleminge1393452005-08-24 18:46:21 -0500688irq_enable_err:
689 disable_irq(phydev->irq);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700690 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500691phy_err:
692 phy_error(phydev);
693}
694
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800695/**
696 * phy_stop - Bring down the PHY link, and stop checking the status
697 * @phydev: target phy_device struct
698 */
Andy Fleminge1393452005-08-24 18:46:21 -0500699void phy_stop(struct phy_device *phydev)
700{
Nate Case35b5f6b2008-01-29 10:05:09 -0600701 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500702
703 if (PHY_HALTED == phydev->state)
704 goto out_unlock;
705
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100706 if (phydev->irq != PHY_POLL) {
Andy Fleminge1393452005-08-24 18:46:21 -0500707 /* Disable PHY Interrupts */
708 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500709
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100710 /* Clear any pending interrupts */
711 phy_clear_interrupt(phydev);
712 }
Andy Fleminge1393452005-08-24 18:46:21 -0500713
Maciej W. Rozycki6daf6532007-09-28 22:42:15 -0700714 phydev->state = PHY_HALTED;
715
Andy Fleminge1393452005-08-24 18:46:21 -0500716out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600717 mutex_unlock(&phydev->lock);
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100718
719 /*
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.
723 */
Andy Fleminge1393452005-08-24 18:46:21 -0500724}
725
726
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800727/**
728 * phy_start - start or restart a PHY device
729 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500730 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800731 * Description: Indicates the attached device's readiness to
Andy Fleminge1393452005-08-24 18:46:21 -0500732 * 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
735 * condition.
736 */
737void phy_start(struct phy_device *phydev)
738{
Nate Case35b5f6b2008-01-29 10:05:09 -0600739 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500740
741 switch (phydev->state) {
742 case PHY_STARTING:
743 phydev->state = PHY_PENDING;
744 break;
745 case PHY_READY:
746 phydev->state = PHY_UP;
747 break;
748 case PHY_HALTED:
749 phydev->state = PHY_RESUMING;
750 default:
751 break;
752 }
Nate Case35b5f6b2008-01-29 10:05:09 -0600753 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500754}
755EXPORT_SYMBOL(phy_stop);
756EXPORT_SYMBOL(phy_start);
Jeff Garzik67c4f3f2005-08-11 02:07:25 -0400757
Nate Case35b5f6b2008-01-29 10:05:09 -0600758/**
759 * phy_state_machine - Handle the state machine
760 * @work: work_struct that describes the work to be done
Nate Case35b5f6b2008-01-29 10:05:09 -0600761 */
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000762void phy_state_machine(struct work_struct *work)
Andy Fleming00db8182005-07-30 19:31:23 -0400763{
Jean Delvarebf6aede2009-04-02 16:56:54 -0700764 struct delayed_work *dwork = to_delayed_work(work);
Nate Case35b5f6b2008-01-29 10:05:09 -0600765 struct phy_device *phydev =
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700766 container_of(dwork, struct phy_device, state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400767 int needs_aneg = 0;
768 int err = 0;
769
Nate Case35b5f6b2008-01-29 10:05:09 -0600770 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400771
772 if (phydev->adjust_state)
773 phydev->adjust_state(phydev->attached_dev);
774
775 switch(phydev->state) {
776 case PHY_DOWN:
777 case PHY_STARTING:
778 case PHY_READY:
779 case PHY_PENDING:
780 break;
781 case PHY_UP:
782 needs_aneg = 1;
783
784 phydev->link_timeout = PHY_AN_TIMEOUT;
785
786 break;
787 case PHY_AN:
Andy Fleming6b655522006-10-16 16:19:17 -0500788 err = phy_read_status(phydev);
789
790 if (err < 0)
791 break;
792
793 /* If the link is down, give up on
794 * negotiation for now */
795 if (!phydev->link) {
796 phydev->state = PHY_NOLINK;
797 netif_carrier_off(phydev->attached_dev);
798 phydev->adjust_link(phydev->attached_dev);
799 break;
800 }
801
Andy Fleming00db8182005-07-30 19:31:23 -0400802 /* Check if negotiation is done. Break
803 * if there's an error */
804 err = phy_aneg_done(phydev);
805 if (err < 0)
806 break;
807
Andy Fleming6b655522006-10-16 16:19:17 -0500808 /* If AN is done, we're running */
Andy Fleming00db8182005-07-30 19:31:23 -0400809 if (err > 0) {
Andy Fleming6b655522006-10-16 16:19:17 -0500810 phydev->state = PHY_RUNNING;
811 netif_carrier_on(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400812 phydev->adjust_link(phydev->attached_dev);
813
814 } else if (0 == phydev->link_timeout--) {
Andy Fleming6b655522006-10-16 16:19:17 -0500815 int idx;
Andy Fleming00db8182005-07-30 19:31:23 -0400816
817 needs_aneg = 1;
Andy Fleming6b655522006-10-16 16:19:17 -0500818 /* If we have the magic_aneg bit,
819 * we try again */
820 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
821 break;
822
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);
829
830 phydev->speed = settings[idx].speed;
831 phydev->duplex = settings[idx].duplex;
832
833 phydev->autoneg = AUTONEG_DISABLE;
834
835 pr_info("Trying %d/%s\n", phydev->speed,
836 DUPLEX_FULL ==
837 phydev->duplex ?
838 "FULL" : "HALF");
Andy Fleming00db8182005-07-30 19:31:23 -0400839 }
840 break;
841 case PHY_NOLINK:
842 err = phy_read_status(phydev);
843
844 if (err)
845 break;
846
847 if (phydev->link) {
848 phydev->state = PHY_RUNNING;
849 netif_carrier_on(phydev->attached_dev);
850 phydev->adjust_link(phydev->attached_dev);
851 }
852 break;
853 case PHY_FORCING:
Andy Fleming6b655522006-10-16 16:19:17 -0500854 err = genphy_update_link(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400855
856 if (err)
857 break;
858
859 if (phydev->link) {
860 phydev->state = PHY_RUNNING;
861 netif_carrier_on(phydev->attached_dev);
862 } else {
863 if (0 == phydev->link_timeout--) {
864 phy_force_reduction(phydev);
865 needs_aneg = 1;
866 }
867 }
868
869 phydev->adjust_link(phydev->attached_dev);
870 break;
871 case PHY_RUNNING:
872 /* Only register a CHANGE if we are
873 * polling */
874 if (PHY_POLL == phydev->irq)
875 phydev->state = PHY_CHANGELINK;
876 break;
877 case PHY_CHANGELINK:
878 err = phy_read_status(phydev);
879
880 if (err)
881 break;
882
883 if (phydev->link) {
884 phydev->state = PHY_RUNNING;
885 netif_carrier_on(phydev->attached_dev);
886 } else {
887 phydev->state = PHY_NOLINK;
888 netif_carrier_off(phydev->attached_dev);
889 }
890
891 phydev->adjust_link(phydev->attached_dev);
892
893 if (PHY_POLL != phydev->irq)
894 err = phy_config_interrupt(phydev,
895 PHY_INTERRUPT_ENABLED);
896 break;
897 case PHY_HALTED:
898 if (phydev->link) {
899 phydev->link = 0;
900 netif_carrier_off(phydev->attached_dev);
901 phydev->adjust_link(phydev->attached_dev);
902 }
903 break;
904 case PHY_RESUMING:
905
906 err = phy_clear_interrupt(phydev);
907
908 if (err)
909 break;
910
911 err = phy_config_interrupt(phydev,
912 PHY_INTERRUPT_ENABLED);
913
914 if (err)
915 break;
916
917 if (AUTONEG_ENABLE == phydev->autoneg) {
918 err = phy_aneg_done(phydev);
919 if (err < 0)
920 break;
921
922 /* err > 0 if AN is done.
923 * Otherwise, it's 0, and we're
924 * still waiting for AN */
925 if (err > 0) {
Wade Farnsworth42caa072009-07-01 13:00:34 +0000926 err = phy_read_status(phydev);
927 if (err)
928 break;
929
930 if (phydev->link) {
931 phydev->state = PHY_RUNNING;
932 netif_carrier_on(phydev->attached_dev);
933 } else
934 phydev->state = PHY_NOLINK;
935 phydev->adjust_link(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400936 } else {
937 phydev->state = PHY_AN;
938 phydev->link_timeout = PHY_AN_TIMEOUT;
939 }
Wade Farnsworth42caa072009-07-01 13:00:34 +0000940 } else {
941 err = phy_read_status(phydev);
942 if (err)
943 break;
944
945 if (phydev->link) {
946 phydev->state = PHY_RUNNING;
947 netif_carrier_on(phydev->attached_dev);
948 } else
949 phydev->state = PHY_NOLINK;
950 phydev->adjust_link(phydev->attached_dev);
951 }
Andy Fleming00db8182005-07-30 19:31:23 -0400952 break;
953 }
954
Nate Case35b5f6b2008-01-29 10:05:09 -0600955 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400956
957 if (needs_aneg)
958 err = phy_start_aneg(phydev);
959
960 if (err < 0)
961 phy_error(phydev);
962
Atsushi Nemoto36640902009-04-16 02:43:37 -0700963 schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);
Nate Case35b5f6b2008-01-29 10:05:09 -0600964}