blob: a8445c72fc13aeb7066c3f1a2b930126935c2bda [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)
Uwe Kleine-Königa40c9f82010-11-23 22:57:47 +000050 printk(KERN_CONT " - %d/%s", phydev->speed,
Andy Fleminge1393452005-08-24 18:46:21 -050051 DUPLEX_FULL == phydev->duplex ?
52 "Full" : "Half");
53
Uwe Kleine-Königa40c9f82010-11-23 22:57:47 +000054 printk(KERN_CONT "\n");
Andy Fleminge1393452005-08-24 18:46:21 -050055}
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 */
stephen hemminger89ff05e2010-10-21 08:37:41 +000068static int phy_clear_interrupt(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -040069{
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 */
stephen hemminger89ff05e2010-10-21 08:37:41 +000085static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
Andy Fleming00db8182005-07-30 19:31:23 -040086{
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 */
stephen hemminger89ff05e2010-10-21 08:37:41 +0000211static void 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 Fleming00db8182005-07-30 19:31:23 -0400226
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800227/**
228 * phy_ethtool_sset - generic ethtool sset function, handles all the details
229 * @phydev: target phy_device struct
230 * @cmd: ethtool_cmd
Andy Fleming00db8182005-07-30 19:31:23 -0400231 *
232 * A few notes about parameter checking:
233 * - We don't set port or transceiver, so we don't care what they
234 * were set to.
235 * - phy_start_aneg() will make sure forced settings are sane, and
236 * choose the next best ones from the ones selected, so we don't
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800237 * care if ethtool tries to give us bad values.
Andy Fleming00db8182005-07-30 19:31:23 -0400238 */
239int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
240{
241 if (cmd->phy_address != phydev->addr)
242 return -EINVAL;
243
244 /* We make sure that we don't pass unsupported
245 * values in to the PHY */
246 cmd->advertising &= phydev->supported;
247
248 /* Verify the settings we care about. */
249 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
250 return -EINVAL;
251
252 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
253 return -EINVAL;
254
Joe Perches8e95a202009-12-03 07:58:21 +0000255 if (cmd->autoneg == AUTONEG_DISABLE &&
256 ((cmd->speed != SPEED_1000 &&
257 cmd->speed != SPEED_100 &&
258 cmd->speed != SPEED_10) ||
259 (cmd->duplex != DUPLEX_HALF &&
260 cmd->duplex != DUPLEX_FULL)))
Andy Fleming00db8182005-07-30 19:31:23 -0400261 return -EINVAL;
262
263 phydev->autoneg = cmd->autoneg;
264
265 phydev->speed = cmd->speed;
266
267 phydev->advertising = cmd->advertising;
268
269 if (AUTONEG_ENABLE == cmd->autoneg)
270 phydev->advertising |= ADVERTISED_Autoneg;
271 else
272 phydev->advertising &= ~ADVERTISED_Autoneg;
273
274 phydev->duplex = cmd->duplex;
275
276 /* Restart the PHY */
277 phy_start_aneg(phydev);
278
279 return 0;
280}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600281EXPORT_SYMBOL(phy_ethtool_sset);
Andy Fleming00db8182005-07-30 19:31:23 -0400282
283int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
284{
285 cmd->supported = phydev->supported;
286
287 cmd->advertising = phydev->advertising;
288
289 cmd->speed = phydev->speed;
290 cmd->duplex = phydev->duplex;
291 cmd->port = PORT_MII;
292 cmd->phy_address = phydev->addr;
293 cmd->transceiver = XCVR_EXTERNAL;
294 cmd->autoneg = phydev->autoneg;
295
296 return 0;
297}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600298EXPORT_SYMBOL(phy_ethtool_gset);
Andy Fleming00db8182005-07-30 19:31:23 -0400299
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800300/**
301 * phy_mii_ioctl - generic PHY MII ioctl interface
302 * @phydev: the phy_device struct
Randy Dunlap00c7d922010-08-09 13:41:59 +0000303 * @ifr: &struct ifreq for socket ioctl's
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800304 * @cmd: ioctl cmd to execute
305 *
306 * Note that this function is currently incompatible with the
Andy Fleming00db8182005-07-30 19:31:23 -0400307 * PHYCONTROL layer. It changes registers without regard to
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800308 * current state. Use at own risk.
Andy Fleming00db8182005-07-30 19:31:23 -0400309 */
310int phy_mii_ioctl(struct phy_device *phydev,
Richard Cochran28b04112010-07-17 08:48:55 +0000311 struct ifreq *ifr, int cmd)
Andy Fleming00db8182005-07-30 19:31:23 -0400312{
Richard Cochran28b04112010-07-17 08:48:55 +0000313 struct mii_ioctl_data *mii_data = if_mii(ifr);
Andy Fleming00db8182005-07-30 19:31:23 -0400314 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
Richard Cochranc1f19b52010-07-17 08:49:36 +0000363 case SIOCSHWTSTAMP:
364 if (phydev->drv->hwtstamp)
365 return phydev->drv->hwtstamp(phydev, ifr);
366 /* fall through */
367
David Woodhousedda93b42007-11-28 19:56:34 +0000368 default:
Lennert Buytenhekc6d6a512008-09-18 03:06:52 +0000369 return -EOPNOTSUPP;
Andy Fleming00db8182005-07-30 19:31:23 -0400370 }
371
372 return 0;
373}
Domen Puncer680e9fe2007-09-17 22:21:40 +0200374EXPORT_SYMBOL(phy_mii_ioctl);
Andy Fleming00db8182005-07-30 19:31:23 -0400375
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800376/**
377 * phy_start_aneg - start auto-negotiation for this PHY device
378 * @phydev: the phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500379 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800380 * Description: Sanitizes the settings (if we're not autonegotiating
381 * them), and then calls the driver's config_aneg function.
382 * If the PHYCONTROL Layer is operating, we change the state to
383 * reflect the beginning of Auto-negotiation or forcing.
Andy Fleminge1393452005-08-24 18:46:21 -0500384 */
385int phy_start_aneg(struct phy_device *phydev)
386{
387 int err;
388
Nate Case35b5f6b2008-01-29 10:05:09 -0600389 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500390
391 if (AUTONEG_DISABLE == phydev->autoneg)
392 phy_sanitize_settings(phydev);
393
394 err = phydev->drv->config_aneg(phydev);
395
Andy Fleminge1393452005-08-24 18:46:21 -0500396 if (err < 0)
397 goto out_unlock;
398
399 if (phydev->state != PHY_HALTED) {
400 if (AUTONEG_ENABLE == phydev->autoneg) {
401 phydev->state = PHY_AN;
402 phydev->link_timeout = PHY_AN_TIMEOUT;
403 } else {
404 phydev->state = PHY_FORCING;
405 phydev->link_timeout = PHY_FORCE_TIMEOUT;
406 }
407 }
408
409out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600410 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500411 return err;
412}
413EXPORT_SYMBOL(phy_start_aneg);
414
415
David Howellsc4028952006-11-22 14:57:56 +0000416static void phy_change(struct work_struct *work);
Andy Fleminge1393452005-08-24 18:46:21 -0500417
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800418/**
419 * phy_start_machine - start PHY state machine tracking
420 * @phydev: the phy_device struct
421 * @handler: callback function for state change notifications
Andy Fleming00db8182005-07-30 19:31:23 -0400422 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800423 * Description: The PHY infrastructure can run a state machine
Andy Fleming00db8182005-07-30 19:31:23 -0400424 * which tracks whether the PHY is starting up, negotiating,
425 * etc. This function starts the timer which tracks the state
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800426 * of the PHY. If you want to be notified when the state changes,
427 * pass in the callback @handler, otherwise, pass NULL. If you
Andy Fleming00db8182005-07-30 19:31:23 -0400428 * want to maintain your own state machine, do not call this
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800429 * function.
430 */
Andy Fleming00db8182005-07-30 19:31:23 -0400431void phy_start_machine(struct phy_device *phydev,
432 void (*handler)(struct net_device *))
433{
434 phydev->adjust_state = handler;
435
Atsushi Nemoto36640902009-04-16 02:43:37 -0700436 schedule_delayed_work(&phydev->state_queue, HZ);
Andy Fleming00db8182005-07-30 19:31:23 -0400437}
438
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800439/**
440 * phy_stop_machine - stop the PHY state machine tracking
441 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400442 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800443 * Description: Stops the state machine timer, sets the state to UP
Sergei Shtylylov817acf52006-07-26 00:53:53 +0400444 * (unless it wasn't up yet). This function must be called BEFORE
Andy Fleming00db8182005-07-30 19:31:23 -0400445 * phy_detach.
446 */
447void phy_stop_machine(struct phy_device *phydev)
448{
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700449 cancel_delayed_work_sync(&phydev->state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400450
Nate Case35b5f6b2008-01-29 10:05:09 -0600451 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400452 if (phydev->state > PHY_UP)
453 phydev->state = PHY_UP;
Nate Case35b5f6b2008-01-29 10:05:09 -0600454 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400455
Andy Fleming00db8182005-07-30 19:31:23 -0400456 phydev->adjust_state = NULL;
457}
458
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800459/**
460 * phy_force_reduction - reduce PHY speed/duplex settings by one step
461 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500462 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800463 * Description: Reduces the speed/duplex settings by one notch,
464 * in this order--
465 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
466 * The function bottoms out at 10/HALF.
Andy Fleminge1393452005-08-24 18:46:21 -0500467 */
468static void phy_force_reduction(struct phy_device *phydev)
469{
470 int idx;
471
472 idx = phy_find_setting(phydev->speed, phydev->duplex);
473
474 idx++;
475
476 idx = phy_find_valid(idx, phydev->supported);
477
478 phydev->speed = settings[idx].speed;
479 phydev->duplex = settings[idx].duplex;
480
481 pr_info("Trying %d/%s\n", phydev->speed,
482 DUPLEX_FULL == phydev->duplex ?
483 "FULL" : "HALF");
484}
485
486
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800487/**
488 * phy_error - enter HALTED state for this PHY device
489 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400490 *
491 * Moves the PHY to the HALTED state in response to a read
492 * or write error, and tells the controller the link is down.
493 * Must not be called from interrupt context, or while the
494 * phydev->lock is held.
495 */
Andy Fleming9b9a8bf2008-05-02 13:00:51 -0500496static void phy_error(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400497{
Nate Case35b5f6b2008-01-29 10:05:09 -0600498 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400499 phydev->state = PHY_HALTED;
Nate Case35b5f6b2008-01-29 10:05:09 -0600500 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400501}
502
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800503/**
504 * phy_interrupt - PHY interrupt handler
505 * @irq: interrupt line
506 * @phy_dat: phy_device pointer
Andy Fleminge1393452005-08-24 18:46:21 -0500507 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800508 * Description: When a PHY interrupt occurs, the handler disables
Andy Fleminge1393452005-08-24 18:46:21 -0500509 * interrupts, and schedules a work task to clear the interrupt.
510 */
David Howells7d12e782006-10-05 14:55:46 +0100511static irqreturn_t phy_interrupt(int irq, void *phy_dat)
Andy Fleminge1393452005-08-24 18:46:21 -0500512{
513 struct phy_device *phydev = phy_dat;
514
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100515 if (PHY_HALTED == phydev->state)
516 return IRQ_NONE; /* It can't be ours. */
517
Andy Fleminge1393452005-08-24 18:46:21 -0500518 /* The MDIO bus is not allowed to be written in interrupt
519 * context, so we need to disable the irq here. A work
520 * queue will write the PHY to disable and clear the
521 * interrupt, and then reenable the irq line. */
522 disable_irq_nosync(irq);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700523 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500524
525 schedule_work(&phydev->phy_queue);
526
527 return IRQ_HANDLED;
528}
529
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800530/**
531 * phy_enable_interrupts - Enable the interrupts from the PHY side
532 * @phydev: target phy_device struct
533 */
stephen hemminger89ff05e2010-10-21 08:37:41 +0000534static int phy_enable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400535{
536 int err;
537
Andy Fleminge1393452005-08-24 18:46:21 -0500538 err = phy_clear_interrupt(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400539
Andy Fleminge1393452005-08-24 18:46:21 -0500540 if (err < 0)
541 return err;
Andy Fleming00db8182005-07-30 19:31:23 -0400542
Andy Fleminge1393452005-08-24 18:46:21 -0500543 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleming00db8182005-07-30 19:31:23 -0400544
545 return err;
546}
Andy Fleming00db8182005-07-30 19:31:23 -0400547
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800548/**
549 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
550 * @phydev: target phy_device struct
551 */
stephen hemminger89ff05e2010-10-21 08:37:41 +0000552static int phy_disable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400553{
554 int err;
555
556 /* Disable PHY interrupts */
557 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
558
559 if (err)
560 goto phy_err;
561
562 /* Clear the interrupt */
563 err = phy_clear_interrupt(phydev);
564
565 if (err)
566 goto phy_err;
567
568 return 0;
569
570phy_err:
571 phy_error(phydev);
572
573 return err;
574}
Andy Fleminge1393452005-08-24 18:46:21 -0500575
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800576/**
577 * phy_start_interrupts - request and enable interrupts for a PHY device
578 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500579 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800580 * Description: Request the interrupt for the given PHY.
581 * If this fails, then we set irq to PHY_POLL.
Andy Fleminge1393452005-08-24 18:46:21 -0500582 * Otherwise, we enable the interrupts in the PHY.
Andy Fleminge1393452005-08-24 18:46:21 -0500583 * This should only be called with a valid IRQ number.
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800584 * Returns 0 on success or < 0 on error.
Andy Fleminge1393452005-08-24 18:46:21 -0500585 */
586int phy_start_interrupts(struct phy_device *phydev)
587{
588 int err = 0;
589
David Howellsc4028952006-11-22 14:57:56 +0000590 INIT_WORK(&phydev->phy_queue, phy_change);
Andy Fleminge1393452005-08-24 18:46:21 -0500591
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700592 atomic_set(&phydev->irq_disable, 0);
Andy Fleminge1393452005-08-24 18:46:21 -0500593 if (request_irq(phydev->irq, phy_interrupt,
Thomas Gleixner1fb9df52006-07-01 19:29:39 -0700594 IRQF_SHARED,
Andy Fleminge1393452005-08-24 18:46:21 -0500595 "phy_interrupt",
596 phydev) < 0) {
597 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
598 phydev->bus->name,
599 phydev->irq);
600 phydev->irq = PHY_POLL;
601 return 0;
602 }
603
604 err = phy_enable_interrupts(phydev);
605
606 return err;
607}
608EXPORT_SYMBOL(phy_start_interrupts);
609
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800610/**
611 * phy_stop_interrupts - disable interrupts from a PHY device
612 * @phydev: target phy_device struct
613 */
Andy Fleminge1393452005-08-24 18:46:21 -0500614int phy_stop_interrupts(struct phy_device *phydev)
615{
616 int err;
617
618 err = phy_disable_interrupts(phydev);
619
620 if (err)
621 phy_error(phydev);
622
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700623 free_irq(phydev->irq, phydev);
624
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100625 /*
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700626 * Cannot call flush_scheduled_work() here as desired because
627 * of rtnl_lock(), but we do not really care about what would
628 * be done, except from enable_irq(), so cancel any work
629 * possibly pending and take care of the matter below.
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100630 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700631 cancel_work_sync(&phydev->phy_queue);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700632 /*
633 * If work indeed has been cancelled, disable_irq() will have
634 * been left unbalanced from phy_interrupt() and enable_irq()
635 * has to be called so that other devices on the line work.
636 */
637 while (atomic_dec_return(&phydev->irq_disable) >= 0)
638 enable_irq(phydev->irq);
Andy Fleminge1393452005-08-24 18:46:21 -0500639
640 return err;
641}
642EXPORT_SYMBOL(phy_stop_interrupts);
643
644
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800645/**
646 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
647 * @work: work_struct that describes the work to be done
648 */
David Howellsc4028952006-11-22 14:57:56 +0000649static void phy_change(struct work_struct *work)
Andy Fleminge1393452005-08-24 18:46:21 -0500650{
651 int err;
David Howellsc4028952006-11-22 14:57:56 +0000652 struct phy_device *phydev =
653 container_of(work, struct phy_device, phy_queue);
Andy Fleminge1393452005-08-24 18:46:21 -0500654
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000655 if (phydev->drv->did_interrupt &&
656 !phydev->drv->did_interrupt(phydev))
657 goto ignore;
658
Andy Fleminge1393452005-08-24 18:46:21 -0500659 err = phy_disable_interrupts(phydev);
660
661 if (err)
662 goto phy_err;
663
Nate Case35b5f6b2008-01-29 10:05:09 -0600664 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500665 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
666 phydev->state = PHY_CHANGELINK;
Nate Case35b5f6b2008-01-29 10:05:09 -0600667 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500668
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700669 atomic_dec(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500670 enable_irq(phydev->irq);
671
672 /* Reenable interrupts */
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100673 if (PHY_HALTED != phydev->state)
674 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500675
676 if (err)
677 goto irq_enable_err;
678
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700679 /* reschedule state queue work to run as soon as possible */
680 cancel_delayed_work_sync(&phydev->state_queue);
681 schedule_delayed_work(&phydev->state_queue, 0);
Trent Piepho0acb2832008-10-08 15:46:57 -0700682
Andy Fleminge1393452005-08-24 18:46:21 -0500683 return;
684
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000685ignore:
686 atomic_dec(&phydev->irq_disable);
687 enable_irq(phydev->irq);
688 return;
689
Andy Fleminge1393452005-08-24 18:46:21 -0500690irq_enable_err:
691 disable_irq(phydev->irq);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700692 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500693phy_err:
694 phy_error(phydev);
695}
696
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800697/**
698 * phy_stop - Bring down the PHY link, and stop checking the status
699 * @phydev: target phy_device struct
700 */
Andy Fleminge1393452005-08-24 18:46:21 -0500701void phy_stop(struct phy_device *phydev)
702{
Nate Case35b5f6b2008-01-29 10:05:09 -0600703 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500704
705 if (PHY_HALTED == phydev->state)
706 goto out_unlock;
707
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100708 if (phydev->irq != PHY_POLL) {
Andy Fleminge1393452005-08-24 18:46:21 -0500709 /* Disable PHY Interrupts */
710 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500711
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100712 /* Clear any pending interrupts */
713 phy_clear_interrupt(phydev);
714 }
Andy Fleminge1393452005-08-24 18:46:21 -0500715
Maciej W. Rozycki6daf6532007-09-28 22:42:15 -0700716 phydev->state = PHY_HALTED;
717
Andy Fleminge1393452005-08-24 18:46:21 -0500718out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600719 mutex_unlock(&phydev->lock);
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100720
721 /*
722 * Cannot call flush_scheduled_work() here as desired because
723 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
724 * will not reenable interrupts.
725 */
Andy Fleminge1393452005-08-24 18:46:21 -0500726}
727
728
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800729/**
730 * phy_start - start or restart a PHY device
731 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500732 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800733 * Description: Indicates the attached device's readiness to
Andy Fleminge1393452005-08-24 18:46:21 -0500734 * handle PHY-related work. Used during startup to start the
735 * PHY, and after a call to phy_stop() to resume operation.
736 * Also used to indicate the MDIO bus has cleared an error
737 * condition.
738 */
739void phy_start(struct phy_device *phydev)
740{
Nate Case35b5f6b2008-01-29 10:05:09 -0600741 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500742
743 switch (phydev->state) {
744 case PHY_STARTING:
745 phydev->state = PHY_PENDING;
746 break;
747 case PHY_READY:
748 phydev->state = PHY_UP;
749 break;
750 case PHY_HALTED:
751 phydev->state = PHY_RESUMING;
752 default:
753 break;
754 }
Nate Case35b5f6b2008-01-29 10:05:09 -0600755 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500756}
757EXPORT_SYMBOL(phy_stop);
758EXPORT_SYMBOL(phy_start);
Jeff Garzik67c4f3f2005-08-11 02:07:25 -0400759
Nate Case35b5f6b2008-01-29 10:05:09 -0600760/**
761 * phy_state_machine - Handle the state machine
762 * @work: work_struct that describes the work to be done
Nate Case35b5f6b2008-01-29 10:05:09 -0600763 */
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000764void phy_state_machine(struct work_struct *work)
Andy Fleming00db8182005-07-30 19:31:23 -0400765{
Jean Delvarebf6aede2009-04-02 16:56:54 -0700766 struct delayed_work *dwork = to_delayed_work(work);
Nate Case35b5f6b2008-01-29 10:05:09 -0600767 struct phy_device *phydev =
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700768 container_of(dwork, struct phy_device, state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400769 int needs_aneg = 0;
770 int err = 0;
771
Nate Case35b5f6b2008-01-29 10:05:09 -0600772 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400773
774 if (phydev->adjust_state)
775 phydev->adjust_state(phydev->attached_dev);
776
777 switch(phydev->state) {
778 case PHY_DOWN:
779 case PHY_STARTING:
780 case PHY_READY:
781 case PHY_PENDING:
782 break;
783 case PHY_UP:
784 needs_aneg = 1;
785
786 phydev->link_timeout = PHY_AN_TIMEOUT;
787
788 break;
789 case PHY_AN:
Andy Fleming6b655522006-10-16 16:19:17 -0500790 err = phy_read_status(phydev);
791
792 if (err < 0)
793 break;
794
795 /* If the link is down, give up on
796 * negotiation for now */
797 if (!phydev->link) {
798 phydev->state = PHY_NOLINK;
799 netif_carrier_off(phydev->attached_dev);
800 phydev->adjust_link(phydev->attached_dev);
801 break;
802 }
803
Andy Fleming00db8182005-07-30 19:31:23 -0400804 /* Check if negotiation is done. Break
805 * if there's an error */
806 err = phy_aneg_done(phydev);
807 if (err < 0)
808 break;
809
Andy Fleming6b655522006-10-16 16:19:17 -0500810 /* If AN is done, we're running */
Andy Fleming00db8182005-07-30 19:31:23 -0400811 if (err > 0) {
Andy Fleming6b655522006-10-16 16:19:17 -0500812 phydev->state = PHY_RUNNING;
813 netif_carrier_on(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400814 phydev->adjust_link(phydev->attached_dev);
815
816 } else if (0 == phydev->link_timeout--) {
Andy Fleming6b655522006-10-16 16:19:17 -0500817 int idx;
Andy Fleming00db8182005-07-30 19:31:23 -0400818
819 needs_aneg = 1;
Andy Fleming6b655522006-10-16 16:19:17 -0500820 /* If we have the magic_aneg bit,
821 * we try again */
822 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
823 break;
824
825 /* The timer expired, and we still
826 * don't have a setting, so we try
827 * forcing it until we find one that
828 * works, starting from the fastest speed,
829 * and working our way down */
830 idx = phy_find_valid(0, phydev->supported);
831
832 phydev->speed = settings[idx].speed;
833 phydev->duplex = settings[idx].duplex;
834
835 phydev->autoneg = AUTONEG_DISABLE;
836
837 pr_info("Trying %d/%s\n", phydev->speed,
838 DUPLEX_FULL ==
839 phydev->duplex ?
840 "FULL" : "HALF");
Andy Fleming00db8182005-07-30 19:31:23 -0400841 }
842 break;
843 case PHY_NOLINK:
844 err = phy_read_status(phydev);
845
846 if (err)
847 break;
848
849 if (phydev->link) {
850 phydev->state = PHY_RUNNING;
851 netif_carrier_on(phydev->attached_dev);
852 phydev->adjust_link(phydev->attached_dev);
853 }
854 break;
855 case PHY_FORCING:
Andy Fleming6b655522006-10-16 16:19:17 -0500856 err = genphy_update_link(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400857
858 if (err)
859 break;
860
861 if (phydev->link) {
862 phydev->state = PHY_RUNNING;
863 netif_carrier_on(phydev->attached_dev);
864 } else {
865 if (0 == phydev->link_timeout--) {
866 phy_force_reduction(phydev);
867 needs_aneg = 1;
868 }
869 }
870
871 phydev->adjust_link(phydev->attached_dev);
872 break;
873 case PHY_RUNNING:
874 /* Only register a CHANGE if we are
875 * polling */
876 if (PHY_POLL == phydev->irq)
877 phydev->state = PHY_CHANGELINK;
878 break;
879 case PHY_CHANGELINK:
880 err = phy_read_status(phydev);
881
882 if (err)
883 break;
884
885 if (phydev->link) {
886 phydev->state = PHY_RUNNING;
887 netif_carrier_on(phydev->attached_dev);
888 } else {
889 phydev->state = PHY_NOLINK;
890 netif_carrier_off(phydev->attached_dev);
891 }
892
893 phydev->adjust_link(phydev->attached_dev);
894
895 if (PHY_POLL != phydev->irq)
896 err = phy_config_interrupt(phydev,
897 PHY_INTERRUPT_ENABLED);
898 break;
899 case PHY_HALTED:
900 if (phydev->link) {
901 phydev->link = 0;
902 netif_carrier_off(phydev->attached_dev);
903 phydev->adjust_link(phydev->attached_dev);
904 }
905 break;
906 case PHY_RESUMING:
907
908 err = phy_clear_interrupt(phydev);
909
910 if (err)
911 break;
912
913 err = phy_config_interrupt(phydev,
914 PHY_INTERRUPT_ENABLED);
915
916 if (err)
917 break;
918
919 if (AUTONEG_ENABLE == phydev->autoneg) {
920 err = phy_aneg_done(phydev);
921 if (err < 0)
922 break;
923
924 /* err > 0 if AN is done.
925 * Otherwise, it's 0, and we're
926 * still waiting for AN */
927 if (err > 0) {
Wade Farnsworth42caa072009-07-01 13:00:34 +0000928 err = phy_read_status(phydev);
929 if (err)
930 break;
931
932 if (phydev->link) {
933 phydev->state = PHY_RUNNING;
934 netif_carrier_on(phydev->attached_dev);
935 } else
936 phydev->state = PHY_NOLINK;
937 phydev->adjust_link(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400938 } else {
939 phydev->state = PHY_AN;
940 phydev->link_timeout = PHY_AN_TIMEOUT;
941 }
Wade Farnsworth42caa072009-07-01 13:00:34 +0000942 } else {
943 err = phy_read_status(phydev);
944 if (err)
945 break;
946
947 if (phydev->link) {
948 phydev->state = PHY_RUNNING;
949 netif_carrier_on(phydev->attached_dev);
950 } else
951 phydev->state = PHY_NOLINK;
952 phydev->adjust_link(phydev->attached_dev);
953 }
Andy Fleming00db8182005-07-30 19:31:23 -0400954 break;
955 }
956
Nate Case35b5f6b2008-01-29 10:05:09 -0600957 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400958
959 if (needs_aneg)
960 err = phy_start_aneg(phydev);
961
962 if (err < 0)
963 phy_error(phydev);
964
Atsushi Nemoto36640902009-04-16 02:43:37 -0700965 schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);
Nate Case35b5f6b2008-01-29 10:05:09 -0600966}