blob: 64be4664ccab0c906f34ce05f49c66d7cbf6def3 [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>
Andy Fleming00db8182005-07-30 19:31:23 -040022#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>
Andy Fleming00db8182005-07-30 19:31:23 -040028#include <linux/mm.h>
29#include <linux/module.h>
Andy Fleming00db8182005-07-30 19:31:23 -040030#include <linux/mii.h>
31#include <linux/ethtool.h>
32#include <linux/phy.h>
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +010033#include <linux/timer.h>
34#include <linux/workqueue.h>
Andy Fleming00db8182005-07-30 19:31:23 -040035
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -070036#include <asm/atomic.h>
Andy Fleming00db8182005-07-30 19:31:23 -040037#include <asm/io.h>
38#include <asm/irq.h>
39#include <asm/uaccess.h>
40
Randy Dunlapb3df0da2007-03-06 02:41:48 -080041/**
42 * phy_print_status - Convenience function to print out the current phy status
43 * @phydev: the phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -050044 */
45void phy_print_status(struct phy_device *phydev)
46{
Kay Sieversfb28ad32008-11-10 13:55:14 -080047 pr_info("PHY: %s - Link is %s", dev_name(&phydev->dev),
Andy Fleminge1393452005-08-24 18:46:21 -050048 phydev->link ? "Up" : "Down");
49 if (phydev->link)
50 printk(" - %d/%s", phydev->speed,
51 DUPLEX_FULL == phydev->duplex ?
52 "Full" : "Half");
53
54 printk("\n");
55}
56EXPORT_SYMBOL(phy_print_status);
Andy Fleming00db8182005-07-30 19:31:23 -040057
58
Randy Dunlapb3df0da2007-03-06 02:41:48 -080059/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -080060 * 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 */
Andy Fleming00db8182005-07-30 19:31:23 -040068int 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
Randy Dunlapb3df0da2007-03-06 02:41:48 -080078/**
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 */
Andy Fleming00db8182005-07-30 19:31:23 -040085int 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
Randy Dunlapb3df0da2007-03-06 02:41:48 -080097/**
98 * phy_aneg_done - return auto-negotiation status
99 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400100 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800101 * Description: Reads the status register and returns 0 either if
Andy Fleming00db8182005-07-30 19:31:23 -0400102 * 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
Andy Fleming00db8182005-07-30 19:31:23 -0400114/* 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 */
Arjan van de Venf71e1302006-03-03 21:33:57 -0500123static const struct phy_setting settings[] = {
Andy Fleming00db8182005-07-30 19:31:23 -0400124 {
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
Denis Chengff8ac602007-09-02 18:30:18 +0800161#define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
Andy Fleming00db8182005-07-30 19:31:23 -0400162
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800163/**
164 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
165 * @speed: speed to match
166 * @duplex: duplex to match
Andy Fleming00db8182005-07-30 19:31:23 -0400167 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800168 * Description: Searches the settings array for the setting which
Andy Fleming00db8182005-07-30 19:31:23 -0400169 * 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
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800185/**
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
Andy Fleming00db8182005-07-30 19:31:23 -0400189 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800190 * Description: Returns the index of the first valid setting less
Andy Fleming00db8182005-07-30 19:31:23 -0400191 * 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
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800203/**
204 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
205 * @phydev: the target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400206 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800207 * Description: Make sure the PHY is set to supported speeds and
Andy Fleming00db8182005-07-30 19:31:23 -0400208 * duplexes. Drop down by one in this order: 1000/FULL,
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800209 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
Andy Fleming00db8182005-07-30 19:31:23 -0400210 */
Andy Fleminge1393452005-08-24 18:46:21 -0500211void phy_sanitize_settings(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400212{
213 u32 features = phydev->supported;
214 int idx;
215
216 /* Sanitize settings based on PHY capabilities */
217 if ((features & SUPPORTED_Autoneg) == 0)
Domen Puncer163642a2007-08-07 12:12:41 +0200218 phydev->autoneg = AUTONEG_DISABLE;
Andy Fleming00db8182005-07-30 19:31:23 -0400219
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}
Andy Fleminge1393452005-08-24 18:46:21 -0500226EXPORT_SYMBOL(phy_sanitize_settings);
Andy Fleming00db8182005-07-30 19:31:23 -0400227
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800228/**
229 * phy_ethtool_sset - generic ethtool sset function, handles all the details
230 * @phydev: target phy_device struct
231 * @cmd: ethtool_cmd
Andy Fleming00db8182005-07-30 19:31:23 -0400232 *
233 * A few notes about parameter checking:
234 * - We don't set port or transceiver, so we don't care what they
235 * were set to.
236 * - phy_start_aneg() will make sure forced settings are sane, and
237 * choose the next best ones from the ones selected, so we don't
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800238 * care if ethtool tries to give us bad values.
Andy Fleming00db8182005-07-30 19:31:23 -0400239 */
240int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
241{
242 if (cmd->phy_address != phydev->addr)
243 return -EINVAL;
244
245 /* We make sure that we don't pass unsupported
246 * values in to the PHY */
247 cmd->advertising &= phydev->supported;
248
249 /* Verify the settings we care about. */
250 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
251 return -EINVAL;
252
253 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
254 return -EINVAL;
255
Joe Perches8e95a202009-12-03 07:58:21 +0000256 if (cmd->autoneg == AUTONEG_DISABLE &&
257 ((cmd->speed != SPEED_1000 &&
258 cmd->speed != SPEED_100 &&
259 cmd->speed != SPEED_10) ||
260 (cmd->duplex != DUPLEX_HALF &&
261 cmd->duplex != DUPLEX_FULL)))
Andy Fleming00db8182005-07-30 19:31:23 -0400262 return -EINVAL;
263
264 phydev->autoneg = cmd->autoneg;
265
266 phydev->speed = cmd->speed;
267
268 phydev->advertising = cmd->advertising;
269
270 if (AUTONEG_ENABLE == cmd->autoneg)
271 phydev->advertising |= ADVERTISED_Autoneg;
272 else
273 phydev->advertising &= ~ADVERTISED_Autoneg;
274
275 phydev->duplex = cmd->duplex;
276
277 /* Restart the PHY */
278 phy_start_aneg(phydev);
279
280 return 0;
281}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600282EXPORT_SYMBOL(phy_ethtool_sset);
Andy Fleming00db8182005-07-30 19:31:23 -0400283
284int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
285{
286 cmd->supported = phydev->supported;
287
288 cmd->advertising = phydev->advertising;
289
290 cmd->speed = phydev->speed;
291 cmd->duplex = phydev->duplex;
292 cmd->port = PORT_MII;
293 cmd->phy_address = phydev->addr;
294 cmd->transceiver = XCVR_EXTERNAL;
295 cmd->autoneg = phydev->autoneg;
296
297 return 0;
298}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600299EXPORT_SYMBOL(phy_ethtool_gset);
Andy Fleming00db8182005-07-30 19:31:23 -0400300
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800301/**
302 * phy_mii_ioctl - generic PHY MII ioctl interface
303 * @phydev: the phy_device struct
304 * @mii_data: MII ioctl data
305 * @cmd: ioctl cmd to execute
306 *
307 * Note that this function is currently incompatible with the
Andy Fleming00db8182005-07-30 19:31:23 -0400308 * PHYCONTROL layer. It changes registers without regard to
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800309 * current state. Use at own risk.
Andy Fleming00db8182005-07-30 19:31:23 -0400310 */
311int phy_mii_ioctl(struct phy_device *phydev,
312 struct mii_ioctl_data *mii_data, int cmd)
313{
314 u16 val = mii_data->val_in;
315
316 switch (cmd) {
317 case SIOCGMIIPHY:
318 mii_data->phy_id = phydev->addr;
Lennert Buytenhekc6d6a512008-09-18 03:06:52 +0000319 /* fall through */
320
Andy Fleming00db8182005-07-30 19:31:23 -0400321 case SIOCGMIIREG:
322 mii_data->val_out = phy_read(phydev, mii_data->reg_num);
323 break;
324
325 case SIOCSMIIREG:
Andy Fleming00db8182005-07-30 19:31:23 -0400326 if (mii_data->phy_id == phydev->addr) {
327 switch(mii_data->reg_num) {
328 case MII_BMCR:
Domen Puncer163642a2007-08-07 12:12:41 +0200329 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
Andy Fleming00db8182005-07-30 19:31:23 -0400330 phydev->autoneg = AUTONEG_DISABLE;
331 else
332 phydev->autoneg = AUTONEG_ENABLE;
333 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
334 phydev->duplex = DUPLEX_FULL;
335 else
336 phydev->duplex = DUPLEX_HALF;
Shan Lu024a0a32007-03-06 02:42:03 -0800337 if ((!phydev->autoneg) &&
338 (val & BMCR_SPEED1000))
339 phydev->speed = SPEED_1000;
340 else if ((!phydev->autoneg) &&
341 (val & BMCR_SPEED100))
342 phydev->speed = SPEED_100;
Andy Fleming00db8182005-07-30 19:31:23 -0400343 break;
344 case MII_ADVERTISE:
345 phydev->advertising = val;
346 break;
347 default:
348 /* do nothing */
349 break;
350 }
351 }
352
353 phy_write(phydev, mii_data->reg_num, val);
354
Joe Perches8e95a202009-12-03 07:58:21 +0000355 if (mii_data->reg_num == MII_BMCR &&
356 val & BMCR_RESET &&
357 phydev->drv->config_init) {
Andy Flemingf62220d2008-04-18 17:29:54 -0500358 phy_scan_fixups(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400359 phydev->drv->config_init(phydev);
Andy Flemingf62220d2008-04-18 17:29:54 -0500360 }
Andy Fleming00db8182005-07-30 19:31:23 -0400361 break;
David Woodhousedda93b42007-11-28 19:56:34 +0000362
363 default:
Lennert Buytenhekc6d6a512008-09-18 03:06:52 +0000364 return -EOPNOTSUPP;
Andy Fleming00db8182005-07-30 19:31:23 -0400365 }
366
367 return 0;
368}
Domen Puncer680e9fe2007-09-17 22:21:40 +0200369EXPORT_SYMBOL(phy_mii_ioctl);
Andy Fleming00db8182005-07-30 19:31:23 -0400370
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800371/**
372 * phy_start_aneg - start auto-negotiation for this PHY device
373 * @phydev: the phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500374 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800375 * Description: Sanitizes the settings (if we're not autonegotiating
376 * them), and then calls the driver's config_aneg function.
377 * If the PHYCONTROL Layer is operating, we change the state to
378 * reflect the beginning of Auto-negotiation or forcing.
Andy Fleminge1393452005-08-24 18:46:21 -0500379 */
380int phy_start_aneg(struct phy_device *phydev)
381{
382 int err;
383
Nate Case35b5f6b2008-01-29 10:05:09 -0600384 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500385
386 if (AUTONEG_DISABLE == phydev->autoneg)
387 phy_sanitize_settings(phydev);
388
389 err = phydev->drv->config_aneg(phydev);
390
Andy Fleminge1393452005-08-24 18:46:21 -0500391 if (err < 0)
392 goto out_unlock;
393
394 if (phydev->state != PHY_HALTED) {
395 if (AUTONEG_ENABLE == phydev->autoneg) {
396 phydev->state = PHY_AN;
397 phydev->link_timeout = PHY_AN_TIMEOUT;
398 } else {
399 phydev->state = PHY_FORCING;
400 phydev->link_timeout = PHY_FORCE_TIMEOUT;
401 }
402 }
403
404out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600405 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500406 return err;
407}
408EXPORT_SYMBOL(phy_start_aneg);
409
410
David Howellsc4028952006-11-22 14:57:56 +0000411static void phy_change(struct work_struct *work);
Andy Fleminge1393452005-08-24 18:46:21 -0500412
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800413/**
414 * phy_start_machine - start PHY state machine tracking
415 * @phydev: the phy_device struct
416 * @handler: callback function for state change notifications
Andy Fleming00db8182005-07-30 19:31:23 -0400417 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800418 * Description: The PHY infrastructure can run a state machine
Andy Fleming00db8182005-07-30 19:31:23 -0400419 * which tracks whether the PHY is starting up, negotiating,
420 * etc. This function starts the timer which tracks the state
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800421 * of the PHY. If you want to be notified when the state changes,
422 * pass in the callback @handler, otherwise, pass NULL. If you
Andy Fleming00db8182005-07-30 19:31:23 -0400423 * want to maintain your own state machine, do not call this
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800424 * function.
425 */
Andy Fleming00db8182005-07-30 19:31:23 -0400426void phy_start_machine(struct phy_device *phydev,
427 void (*handler)(struct net_device *))
428{
429 phydev->adjust_state = handler;
430
Atsushi Nemoto36640902009-04-16 02:43:37 -0700431 schedule_delayed_work(&phydev->state_queue, HZ);
Andy Fleming00db8182005-07-30 19:31:23 -0400432}
433
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800434/**
435 * phy_stop_machine - stop the PHY state machine tracking
436 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400437 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800438 * Description: Stops the state machine timer, sets the state to UP
Sergei Shtylylov817acf52006-07-26 00:53:53 +0400439 * (unless it wasn't up yet). This function must be called BEFORE
Andy Fleming00db8182005-07-30 19:31:23 -0400440 * phy_detach.
441 */
442void phy_stop_machine(struct phy_device *phydev)
443{
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700444 cancel_delayed_work_sync(&phydev->state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400445
Nate Case35b5f6b2008-01-29 10:05:09 -0600446 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400447 if (phydev->state > PHY_UP)
448 phydev->state = PHY_UP;
Nate Case35b5f6b2008-01-29 10:05:09 -0600449 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400450
Andy Fleming00db8182005-07-30 19:31:23 -0400451 phydev->adjust_state = NULL;
452}
453
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800454/**
455 * phy_force_reduction - reduce PHY speed/duplex settings by one step
456 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500457 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800458 * Description: Reduces the speed/duplex settings by one notch,
459 * in this order--
460 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
461 * The function bottoms out at 10/HALF.
Andy Fleminge1393452005-08-24 18:46:21 -0500462 */
463static void phy_force_reduction(struct phy_device *phydev)
464{
465 int idx;
466
467 idx = phy_find_setting(phydev->speed, phydev->duplex);
468
469 idx++;
470
471 idx = phy_find_valid(idx, phydev->supported);
472
473 phydev->speed = settings[idx].speed;
474 phydev->duplex = settings[idx].duplex;
475
476 pr_info("Trying %d/%s\n", phydev->speed,
477 DUPLEX_FULL == phydev->duplex ?
478 "FULL" : "HALF");
479}
480
481
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800482/**
483 * phy_error - enter HALTED state for this PHY device
484 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400485 *
486 * Moves the PHY to the HALTED state in response to a read
487 * or write error, and tells the controller the link is down.
488 * Must not be called from interrupt context, or while the
489 * phydev->lock is held.
490 */
Andy Fleming9b9a8bf2008-05-02 13:00:51 -0500491static void phy_error(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400492{
Nate Case35b5f6b2008-01-29 10:05:09 -0600493 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400494 phydev->state = PHY_HALTED;
Nate Case35b5f6b2008-01-29 10:05:09 -0600495 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400496}
497
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800498/**
499 * phy_interrupt - PHY interrupt handler
500 * @irq: interrupt line
501 * @phy_dat: phy_device pointer
Andy Fleminge1393452005-08-24 18:46:21 -0500502 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800503 * Description: When a PHY interrupt occurs, the handler disables
Andy Fleminge1393452005-08-24 18:46:21 -0500504 * interrupts, and schedules a work task to clear the interrupt.
505 */
David Howells7d12e782006-10-05 14:55:46 +0100506static irqreturn_t phy_interrupt(int irq, void *phy_dat)
Andy Fleminge1393452005-08-24 18:46:21 -0500507{
508 struct phy_device *phydev = phy_dat;
509
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100510 if (PHY_HALTED == phydev->state)
511 return IRQ_NONE; /* It can't be ours. */
512
Andy Fleminge1393452005-08-24 18:46:21 -0500513 /* The MDIO bus is not allowed to be written in interrupt
514 * context, so we need to disable the irq here. A work
515 * queue will write the PHY to disable and clear the
516 * interrupt, and then reenable the irq line. */
517 disable_irq_nosync(irq);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700518 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500519
520 schedule_work(&phydev->phy_queue);
521
522 return IRQ_HANDLED;
523}
524
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800525/**
526 * phy_enable_interrupts - Enable the interrupts from the PHY side
527 * @phydev: target phy_device struct
528 */
Andy Fleminge1393452005-08-24 18:46:21 -0500529int phy_enable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400530{
531 int err;
532
Andy Fleminge1393452005-08-24 18:46:21 -0500533 err = phy_clear_interrupt(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400534
Andy Fleminge1393452005-08-24 18:46:21 -0500535 if (err < 0)
536 return err;
Andy Fleming00db8182005-07-30 19:31:23 -0400537
Andy Fleminge1393452005-08-24 18:46:21 -0500538 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleming00db8182005-07-30 19:31:23 -0400539
540 return err;
541}
Andy Fleminge1393452005-08-24 18:46:21 -0500542EXPORT_SYMBOL(phy_enable_interrupts);
Andy Fleming00db8182005-07-30 19:31:23 -0400543
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800544/**
545 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
546 * @phydev: target phy_device struct
547 */
Andy Fleminge1393452005-08-24 18:46:21 -0500548int phy_disable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400549{
550 int err;
551
552 /* Disable PHY interrupts */
553 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
554
555 if (err)
556 goto phy_err;
557
558 /* Clear the interrupt */
559 err = phy_clear_interrupt(phydev);
560
561 if (err)
562 goto phy_err;
563
564 return 0;
565
566phy_err:
567 phy_error(phydev);
568
569 return err;
570}
Andy Fleminge1393452005-08-24 18:46:21 -0500571EXPORT_SYMBOL(phy_disable_interrupts);
572
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800573/**
574 * phy_start_interrupts - request and enable interrupts for a PHY device
575 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500576 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800577 * Description: Request the interrupt for the given PHY.
578 * If this fails, then we set irq to PHY_POLL.
Andy Fleminge1393452005-08-24 18:46:21 -0500579 * Otherwise, we enable the interrupts in the PHY.
Andy Fleminge1393452005-08-24 18:46:21 -0500580 * This should only be called with a valid IRQ number.
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800581 * Returns 0 on success or < 0 on error.
Andy Fleminge1393452005-08-24 18:46:21 -0500582 */
583int phy_start_interrupts(struct phy_device *phydev)
584{
585 int err = 0;
586
David Howellsc4028952006-11-22 14:57:56 +0000587 INIT_WORK(&phydev->phy_queue, phy_change);
Andy Fleminge1393452005-08-24 18:46:21 -0500588
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700589 atomic_set(&phydev->irq_disable, 0);
Andy Fleminge1393452005-08-24 18:46:21 -0500590 if (request_irq(phydev->irq, phy_interrupt,
Thomas Gleixner1fb9df52006-07-01 19:29:39 -0700591 IRQF_SHARED,
Andy Fleminge1393452005-08-24 18:46:21 -0500592 "phy_interrupt",
593 phydev) < 0) {
594 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
595 phydev->bus->name,
596 phydev->irq);
597 phydev->irq = PHY_POLL;
598 return 0;
599 }
600
601 err = phy_enable_interrupts(phydev);
602
603 return err;
604}
605EXPORT_SYMBOL(phy_start_interrupts);
606
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800607/**
608 * phy_stop_interrupts - disable interrupts from a PHY device
609 * @phydev: target phy_device struct
610 */
Andy Fleminge1393452005-08-24 18:46:21 -0500611int phy_stop_interrupts(struct phy_device *phydev)
612{
613 int err;
614
615 err = phy_disable_interrupts(phydev);
616
617 if (err)
618 phy_error(phydev);
619
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700620 free_irq(phydev->irq, phydev);
621
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100622 /*
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700623 * Cannot call flush_scheduled_work() here as desired because
624 * of rtnl_lock(), but we do not really care about what would
625 * be done, except from enable_irq(), so cancel any work
626 * possibly pending and take care of the matter below.
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100627 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700628 cancel_work_sync(&phydev->phy_queue);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700629 /*
630 * If work indeed has been cancelled, disable_irq() will have
631 * been left unbalanced from phy_interrupt() and enable_irq()
632 * has to be called so that other devices on the line work.
633 */
634 while (atomic_dec_return(&phydev->irq_disable) >= 0)
635 enable_irq(phydev->irq);
Andy Fleminge1393452005-08-24 18:46:21 -0500636
637 return err;
638}
639EXPORT_SYMBOL(phy_stop_interrupts);
640
641
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800642/**
643 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
644 * @work: work_struct that describes the work to be done
645 */
David Howellsc4028952006-11-22 14:57:56 +0000646static void phy_change(struct work_struct *work)
Andy Fleminge1393452005-08-24 18:46:21 -0500647{
648 int err;
David Howellsc4028952006-11-22 14:57:56 +0000649 struct phy_device *phydev =
650 container_of(work, struct phy_device, phy_queue);
Andy Fleminge1393452005-08-24 18:46:21 -0500651
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000652 if (phydev->drv->did_interrupt &&
653 !phydev->drv->did_interrupt(phydev))
654 goto ignore;
655
Andy Fleminge1393452005-08-24 18:46:21 -0500656 err = phy_disable_interrupts(phydev);
657
658 if (err)
659 goto phy_err;
660
Nate Case35b5f6b2008-01-29 10:05:09 -0600661 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500662 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
663 phydev->state = PHY_CHANGELINK;
Nate Case35b5f6b2008-01-29 10:05:09 -0600664 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500665
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700666 atomic_dec(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500667 enable_irq(phydev->irq);
668
669 /* Reenable interrupts */
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100670 if (PHY_HALTED != phydev->state)
671 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500672
673 if (err)
674 goto irq_enable_err;
675
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700676 /* reschedule state queue work to run as soon as possible */
677 cancel_delayed_work_sync(&phydev->state_queue);
678 schedule_delayed_work(&phydev->state_queue, 0);
Trent Piepho0acb2832008-10-08 15:46:57 -0700679
Andy Fleminge1393452005-08-24 18:46:21 -0500680 return;
681
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000682ignore:
683 atomic_dec(&phydev->irq_disable);
684 enable_irq(phydev->irq);
685 return;
686
Andy Fleminge1393452005-08-24 18:46:21 -0500687irq_enable_err:
688 disable_irq(phydev->irq);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700689 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500690phy_err:
691 phy_error(phydev);
692}
693
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800694/**
695 * phy_stop - Bring down the PHY link, and stop checking the status
696 * @phydev: target phy_device struct
697 */
Andy Fleminge1393452005-08-24 18:46:21 -0500698void phy_stop(struct phy_device *phydev)
699{
Nate Case35b5f6b2008-01-29 10:05:09 -0600700 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500701
702 if (PHY_HALTED == phydev->state)
703 goto out_unlock;
704
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100705 if (phydev->irq != PHY_POLL) {
Andy Fleminge1393452005-08-24 18:46:21 -0500706 /* Disable PHY Interrupts */
707 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500708
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100709 /* Clear any pending interrupts */
710 phy_clear_interrupt(phydev);
711 }
Andy Fleminge1393452005-08-24 18:46:21 -0500712
Maciej W. Rozycki6daf6532007-09-28 22:42:15 -0700713 phydev->state = PHY_HALTED;
714
Andy Fleminge1393452005-08-24 18:46:21 -0500715out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600716 mutex_unlock(&phydev->lock);
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100717
718 /*
719 * Cannot call flush_scheduled_work() here as desired because
720 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
721 * will not reenable interrupts.
722 */
Andy Fleminge1393452005-08-24 18:46:21 -0500723}
724
725
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800726/**
727 * phy_start - start or restart a PHY device
728 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500729 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800730 * Description: Indicates the attached device's readiness to
Andy Fleminge1393452005-08-24 18:46:21 -0500731 * handle PHY-related work. Used during startup to start the
732 * PHY, and after a call to phy_stop() to resume operation.
733 * Also used to indicate the MDIO bus has cleared an error
734 * condition.
735 */
736void phy_start(struct phy_device *phydev)
737{
Nate Case35b5f6b2008-01-29 10:05:09 -0600738 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500739
740 switch (phydev->state) {
741 case PHY_STARTING:
742 phydev->state = PHY_PENDING;
743 break;
744 case PHY_READY:
745 phydev->state = PHY_UP;
746 break;
747 case PHY_HALTED:
748 phydev->state = PHY_RESUMING;
749 default:
750 break;
751 }
Nate Case35b5f6b2008-01-29 10:05:09 -0600752 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500753}
754EXPORT_SYMBOL(phy_stop);
755EXPORT_SYMBOL(phy_start);
Jeff Garzik67c4f3f2005-08-11 02:07:25 -0400756
Nate Case35b5f6b2008-01-29 10:05:09 -0600757/**
758 * phy_state_machine - Handle the state machine
759 * @work: work_struct that describes the work to be done
Nate Case35b5f6b2008-01-29 10:05:09 -0600760 */
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000761void phy_state_machine(struct work_struct *work)
Andy Fleming00db8182005-07-30 19:31:23 -0400762{
Jean Delvarebf6aede2009-04-02 16:56:54 -0700763 struct delayed_work *dwork = to_delayed_work(work);
Nate Case35b5f6b2008-01-29 10:05:09 -0600764 struct phy_device *phydev =
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700765 container_of(dwork, struct phy_device, state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400766 int needs_aneg = 0;
767 int err = 0;
768
Nate Case35b5f6b2008-01-29 10:05:09 -0600769 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400770
771 if (phydev->adjust_state)
772 phydev->adjust_state(phydev->attached_dev);
773
774 switch(phydev->state) {
775 case PHY_DOWN:
776 case PHY_STARTING:
777 case PHY_READY:
778 case PHY_PENDING:
779 break;
780 case PHY_UP:
781 needs_aneg = 1;
782
783 phydev->link_timeout = PHY_AN_TIMEOUT;
784
785 break;
786 case PHY_AN:
Andy Fleming6b655522006-10-16 16:19:17 -0500787 err = phy_read_status(phydev);
788
789 if (err < 0)
790 break;
791
792 /* If the link is down, give up on
793 * negotiation for now */
794 if (!phydev->link) {
795 phydev->state = PHY_NOLINK;
796 netif_carrier_off(phydev->attached_dev);
797 phydev->adjust_link(phydev->attached_dev);
798 break;
799 }
800
Andy Fleming00db8182005-07-30 19:31:23 -0400801 /* Check if negotiation is done. Break
802 * if there's an error */
803 err = phy_aneg_done(phydev);
804 if (err < 0)
805 break;
806
Andy Fleming6b655522006-10-16 16:19:17 -0500807 /* If AN is done, we're running */
Andy Fleming00db8182005-07-30 19:31:23 -0400808 if (err > 0) {
Andy Fleming6b655522006-10-16 16:19:17 -0500809 phydev->state = PHY_RUNNING;
810 netif_carrier_on(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400811 phydev->adjust_link(phydev->attached_dev);
812
813 } else if (0 == phydev->link_timeout--) {
Andy Fleming6b655522006-10-16 16:19:17 -0500814 int idx;
Andy Fleming00db8182005-07-30 19:31:23 -0400815
816 needs_aneg = 1;
Andy Fleming6b655522006-10-16 16:19:17 -0500817 /* If we have the magic_aneg bit,
818 * we try again */
819 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
820 break;
821
822 /* The timer expired, and we still
823 * don't have a setting, so we try
824 * forcing it until we find one that
825 * works, starting from the fastest speed,
826 * and working our way down */
827 idx = phy_find_valid(0, phydev->supported);
828
829 phydev->speed = settings[idx].speed;
830 phydev->duplex = settings[idx].duplex;
831
832 phydev->autoneg = AUTONEG_DISABLE;
833
834 pr_info("Trying %d/%s\n", phydev->speed,
835 DUPLEX_FULL ==
836 phydev->duplex ?
837 "FULL" : "HALF");
Andy Fleming00db8182005-07-30 19:31:23 -0400838 }
839 break;
840 case PHY_NOLINK:
841 err = phy_read_status(phydev);
842
843 if (err)
844 break;
845
846 if (phydev->link) {
847 phydev->state = PHY_RUNNING;
848 netif_carrier_on(phydev->attached_dev);
849 phydev->adjust_link(phydev->attached_dev);
850 }
851 break;
852 case PHY_FORCING:
Andy Fleming6b655522006-10-16 16:19:17 -0500853 err = genphy_update_link(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400854
855 if (err)
856 break;
857
858 if (phydev->link) {
859 phydev->state = PHY_RUNNING;
860 netif_carrier_on(phydev->attached_dev);
861 } else {
862 if (0 == phydev->link_timeout--) {
863 phy_force_reduction(phydev);
864 needs_aneg = 1;
865 }
866 }
867
868 phydev->adjust_link(phydev->attached_dev);
869 break;
870 case PHY_RUNNING:
871 /* Only register a CHANGE if we are
872 * polling */
873 if (PHY_POLL == phydev->irq)
874 phydev->state = PHY_CHANGELINK;
875 break;
876 case PHY_CHANGELINK:
877 err = phy_read_status(phydev);
878
879 if (err)
880 break;
881
882 if (phydev->link) {
883 phydev->state = PHY_RUNNING;
884 netif_carrier_on(phydev->attached_dev);
885 } else {
886 phydev->state = PHY_NOLINK;
887 netif_carrier_off(phydev->attached_dev);
888 }
889
890 phydev->adjust_link(phydev->attached_dev);
891
892 if (PHY_POLL != phydev->irq)
893 err = phy_config_interrupt(phydev,
894 PHY_INTERRUPT_ENABLED);
895 break;
896 case PHY_HALTED:
897 if (phydev->link) {
898 phydev->link = 0;
899 netif_carrier_off(phydev->attached_dev);
900 phydev->adjust_link(phydev->attached_dev);
901 }
902 break;
903 case PHY_RESUMING:
904
905 err = phy_clear_interrupt(phydev);
906
907 if (err)
908 break;
909
910 err = phy_config_interrupt(phydev,
911 PHY_INTERRUPT_ENABLED);
912
913 if (err)
914 break;
915
916 if (AUTONEG_ENABLE == phydev->autoneg) {
917 err = phy_aneg_done(phydev);
918 if (err < 0)
919 break;
920
921 /* err > 0 if AN is done.
922 * Otherwise, it's 0, and we're
923 * still waiting for AN */
924 if (err > 0) {
Wade Farnsworth42caa072009-07-01 13:00:34 +0000925 err = phy_read_status(phydev);
926 if (err)
927 break;
928
929 if (phydev->link) {
930 phydev->state = PHY_RUNNING;
931 netif_carrier_on(phydev->attached_dev);
932 } else
933 phydev->state = PHY_NOLINK;
934 phydev->adjust_link(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400935 } else {
936 phydev->state = PHY_AN;
937 phydev->link_timeout = PHY_AN_TIMEOUT;
938 }
Wade Farnsworth42caa072009-07-01 13:00:34 +0000939 } else {
940 err = phy_read_status(phydev);
941 if (err)
942 break;
943
944 if (phydev->link) {
945 phydev->state = PHY_RUNNING;
946 netif_carrier_on(phydev->attached_dev);
947 } else
948 phydev->state = PHY_NOLINK;
949 phydev->adjust_link(phydev->attached_dev);
950 }
Andy Fleming00db8182005-07-30 19:31:23 -0400951 break;
952 }
953
Nate Case35b5f6b2008-01-29 10:05:09 -0600954 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400955
956 if (needs_aneg)
957 err = phy_start_aneg(phydev);
958
959 if (err < 0)
960 phy_error(phydev);
961
Atsushi Nemoto36640902009-04-16 02:43:37 -0700962 schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);
Nate Case35b5f6b2008-01-29 10:05:09 -0600963}