blob: 2e1c23731dedf4d27468987d63ff081c3d97ad8b [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 */
Joe Perches8d242482012-06-09 07:49:07 +000018
19#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
20
Andy Fleming00db8182005-07-30 19:31:23 -040021#include <linux/kernel.h>
Andy Fleming00db8182005-07-30 19:31:23 -040022#include <linux/string.h>
23#include <linux/errno.h>
24#include <linux/unistd.h>
Andy Fleming00db8182005-07-30 19:31:23 -040025#include <linux/interrupt.h>
26#include <linux/init.h>
27#include <linux/delay.h>
28#include <linux/netdevice.h>
29#include <linux/etherdevice.h>
30#include <linux/skbuff.h>
Andy Fleming00db8182005-07-30 19:31:23 -040031#include <linux/mm.h>
32#include <linux/module.h>
Andy Fleming00db8182005-07-30 19:31:23 -040033#include <linux/mii.h>
34#include <linux/ethtool.h>
35#include <linux/phy.h>
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +010036#include <linux/timer.h>
37#include <linux/workqueue.h>
Andy Fleming00db8182005-07-30 19:31:23 -040038
Arun Sharma600634972011-07-26 16:09:06 -070039#include <linux/atomic.h>
Andy Fleming00db8182005-07-30 19:31:23 -040040#include <asm/io.h>
41#include <asm/irq.h>
42#include <asm/uaccess.h>
43
Randy Dunlapb3df0da2007-03-06 02:41:48 -080044/**
45 * phy_print_status - Convenience function to print out the current phy status
46 * @phydev: the phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -050047 */
48void phy_print_status(struct phy_device *phydev)
49{
Andy Fleminge1393452005-08-24 18:46:21 -050050 if (phydev->link)
Joe Perches8d242482012-06-09 07:49:07 +000051 pr_info("%s - Link is Up - %d/%s\n",
52 dev_name(&phydev->dev),
53 phydev->speed,
54 DUPLEX_FULL == phydev->duplex ? "Full" : "Half");
55 else
56 pr_info("%s - Link is Down\n", dev_name(&phydev->dev));
Andy Fleminge1393452005-08-24 18:46:21 -050057}
58EXPORT_SYMBOL(phy_print_status);
Andy Fleming00db8182005-07-30 19:31:23 -040059
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 */
stephen hemminger89ff05e2010-10-21 08:37:41 +000069static int phy_clear_interrupt(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -040070{
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 */
stephen hemminger89ff05e2010-10-21 08:37:41 +000086static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
Andy Fleming00db8182005-07-30 19:31:23 -040087{
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 */
stephen hemminger89ff05e2010-10-21 08:37:41 +0000212static void 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 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{
David Decotigny25db0332011-04-27 18:32:39 +0000242 u32 speed = ethtool_cmd_speed(cmd);
243
Andy Fleming00db8182005-07-30 19:31:23 -0400244 if (cmd->phy_address != phydev->addr)
245 return -EINVAL;
246
247 /* We make sure that we don't pass unsupported
248 * values in to the PHY */
249 cmd->advertising &= phydev->supported;
250
251 /* Verify the settings we care about. */
252 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
253 return -EINVAL;
254
255 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
256 return -EINVAL;
257
Joe Perches8e95a202009-12-03 07:58:21 +0000258 if (cmd->autoneg == AUTONEG_DISABLE &&
David Decotigny25db0332011-04-27 18:32:39 +0000259 ((speed != SPEED_1000 &&
260 speed != SPEED_100 &&
261 speed != SPEED_10) ||
Joe Perches8e95a202009-12-03 07:58:21 +0000262 (cmd->duplex != DUPLEX_HALF &&
263 cmd->duplex != DUPLEX_FULL)))
Andy Fleming00db8182005-07-30 19:31:23 -0400264 return -EINVAL;
265
266 phydev->autoneg = cmd->autoneg;
267
David Decotigny25db0332011-04-27 18:32:39 +0000268 phydev->speed = speed;
Andy Fleming00db8182005-07-30 19:31:23 -0400269
270 phydev->advertising = cmd->advertising;
271
272 if (AUTONEG_ENABLE == cmd->autoneg)
273 phydev->advertising |= ADVERTISED_Autoneg;
274 else
275 phydev->advertising &= ~ADVERTISED_Autoneg;
276
277 phydev->duplex = cmd->duplex;
278
279 /* Restart the PHY */
280 phy_start_aneg(phydev);
281
282 return 0;
283}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600284EXPORT_SYMBOL(phy_ethtool_sset);
Andy Fleming00db8182005-07-30 19:31:23 -0400285
286int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
287{
288 cmd->supported = phydev->supported;
289
290 cmd->advertising = phydev->advertising;
291
David Decotigny70739492011-04-27 18:32:40 +0000292 ethtool_cmd_speed_set(cmd, phydev->speed);
Andy Fleming00db8182005-07-30 19:31:23 -0400293 cmd->duplex = phydev->duplex;
294 cmd->port = PORT_MII;
295 cmd->phy_address = phydev->addr;
296 cmd->transceiver = XCVR_EXTERNAL;
297 cmd->autoneg = phydev->autoneg;
298
299 return 0;
300}
Kumar Gala9f6d55d2007-01-20 16:38:26 -0600301EXPORT_SYMBOL(phy_ethtool_gset);
Andy Fleming00db8182005-07-30 19:31:23 -0400302
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800303/**
304 * phy_mii_ioctl - generic PHY MII ioctl interface
305 * @phydev: the phy_device struct
Randy Dunlap00c7d922010-08-09 13:41:59 +0000306 * @ifr: &struct ifreq for socket ioctl's
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800307 * @cmd: ioctl cmd to execute
308 *
309 * Note that this function is currently incompatible with the
Andy Fleming00db8182005-07-30 19:31:23 -0400310 * PHYCONTROL layer. It changes registers without regard to
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800311 * current state. Use at own risk.
Andy Fleming00db8182005-07-30 19:31:23 -0400312 */
313int phy_mii_ioctl(struct phy_device *phydev,
Richard Cochran28b04112010-07-17 08:48:55 +0000314 struct ifreq *ifr, int cmd)
Andy Fleming00db8182005-07-30 19:31:23 -0400315{
Richard Cochran28b04112010-07-17 08:48:55 +0000316 struct mii_ioctl_data *mii_data = if_mii(ifr);
Andy Fleming00db8182005-07-30 19:31:23 -0400317 u16 val = mii_data->val_in;
318
319 switch (cmd) {
320 case SIOCGMIIPHY:
321 mii_data->phy_id = phydev->addr;
Lennert Buytenhekc6d6a512008-09-18 03:06:52 +0000322 /* fall through */
323
Andy Fleming00db8182005-07-30 19:31:23 -0400324 case SIOCGMIIREG:
Peter Korsgaardaf1dc132011-03-10 06:52:13 +0000325 mii_data->val_out = mdiobus_read(phydev->bus, mii_data->phy_id,
326 mii_data->reg_num);
Andy Fleming00db8182005-07-30 19:31:23 -0400327 break;
328
329 case SIOCSMIIREG:
Andy Fleming00db8182005-07-30 19:31:23 -0400330 if (mii_data->phy_id == phydev->addr) {
331 switch(mii_data->reg_num) {
332 case MII_BMCR:
Domen Puncer163642a2007-08-07 12:12:41 +0200333 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
Andy Fleming00db8182005-07-30 19:31:23 -0400334 phydev->autoneg = AUTONEG_DISABLE;
335 else
336 phydev->autoneg = AUTONEG_ENABLE;
337 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
338 phydev->duplex = DUPLEX_FULL;
339 else
340 phydev->duplex = DUPLEX_HALF;
Shan Lu024a0a32007-03-06 02:42:03 -0800341 if ((!phydev->autoneg) &&
342 (val & BMCR_SPEED1000))
343 phydev->speed = SPEED_1000;
344 else if ((!phydev->autoneg) &&
345 (val & BMCR_SPEED100))
346 phydev->speed = SPEED_100;
Andy Fleming00db8182005-07-30 19:31:23 -0400347 break;
348 case MII_ADVERTISE:
349 phydev->advertising = val;
350 break;
351 default:
352 /* do nothing */
353 break;
354 }
355 }
356
Peter Korsgaardaf1dc132011-03-10 06:52:13 +0000357 mdiobus_write(phydev->bus, mii_data->phy_id,
358 mii_data->reg_num, val);
359
Joe Perches8e95a202009-12-03 07:58:21 +0000360 if (mii_data->reg_num == MII_BMCR &&
361 val & BMCR_RESET &&
362 phydev->drv->config_init) {
Andy Flemingf62220d2008-04-18 17:29:54 -0500363 phy_scan_fixups(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400364 phydev->drv->config_init(phydev);
Andy Flemingf62220d2008-04-18 17:29:54 -0500365 }
Andy Fleming00db8182005-07-30 19:31:23 -0400366 break;
David Woodhousedda93b42007-11-28 19:56:34 +0000367
Richard Cochranc1f19b52010-07-17 08:49:36 +0000368 case SIOCSHWTSTAMP:
369 if (phydev->drv->hwtstamp)
370 return phydev->drv->hwtstamp(phydev, ifr);
371 /* fall through */
372
David Woodhousedda93b42007-11-28 19:56:34 +0000373 default:
Lennert Buytenhekc6d6a512008-09-18 03:06:52 +0000374 return -EOPNOTSUPP;
Andy Fleming00db8182005-07-30 19:31:23 -0400375 }
376
377 return 0;
378}
Domen Puncer680e9fe2007-09-17 22:21:40 +0200379EXPORT_SYMBOL(phy_mii_ioctl);
Andy Fleming00db8182005-07-30 19:31:23 -0400380
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800381/**
382 * phy_start_aneg - start auto-negotiation for this PHY device
383 * @phydev: the phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500384 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800385 * Description: Sanitizes the settings (if we're not autonegotiating
386 * them), and then calls the driver's config_aneg function.
387 * If the PHYCONTROL Layer is operating, we change the state to
388 * reflect the beginning of Auto-negotiation or forcing.
Andy Fleminge1393452005-08-24 18:46:21 -0500389 */
390int phy_start_aneg(struct phy_device *phydev)
391{
392 int err;
393
Nate Case35b5f6b2008-01-29 10:05:09 -0600394 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500395
396 if (AUTONEG_DISABLE == phydev->autoneg)
397 phy_sanitize_settings(phydev);
398
399 err = phydev->drv->config_aneg(phydev);
400
Andy Fleminge1393452005-08-24 18:46:21 -0500401 if (err < 0)
402 goto out_unlock;
403
404 if (phydev->state != PHY_HALTED) {
405 if (AUTONEG_ENABLE == phydev->autoneg) {
406 phydev->state = PHY_AN;
407 phydev->link_timeout = PHY_AN_TIMEOUT;
408 } else {
409 phydev->state = PHY_FORCING;
410 phydev->link_timeout = PHY_FORCE_TIMEOUT;
411 }
412 }
413
414out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600415 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500416 return err;
417}
418EXPORT_SYMBOL(phy_start_aneg);
419
420
David Howellsc4028952006-11-22 14:57:56 +0000421static void phy_change(struct work_struct *work);
Andy Fleminge1393452005-08-24 18:46:21 -0500422
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800423/**
424 * phy_start_machine - start PHY state machine tracking
425 * @phydev: the phy_device struct
426 * @handler: callback function for state change notifications
Andy Fleming00db8182005-07-30 19:31:23 -0400427 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800428 * Description: The PHY infrastructure can run a state machine
Andy Fleming00db8182005-07-30 19:31:23 -0400429 * which tracks whether the PHY is starting up, negotiating,
430 * etc. This function starts the timer which tracks the state
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800431 * of the PHY. If you want to be notified when the state changes,
432 * pass in the callback @handler, otherwise, pass NULL. If you
Andy Fleming00db8182005-07-30 19:31:23 -0400433 * want to maintain your own state machine, do not call this
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800434 * function.
435 */
Andy Fleming00db8182005-07-30 19:31:23 -0400436void phy_start_machine(struct phy_device *phydev,
437 void (*handler)(struct net_device *))
438{
439 phydev->adjust_state = handler;
440
Atsushi Nemoto36640902009-04-16 02:43:37 -0700441 schedule_delayed_work(&phydev->state_queue, HZ);
Andy Fleming00db8182005-07-30 19:31:23 -0400442}
443
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800444/**
445 * phy_stop_machine - stop the PHY state machine tracking
446 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400447 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800448 * Description: Stops the state machine timer, sets the state to UP
Sergei Shtylylov817acf52006-07-26 00:53:53 +0400449 * (unless it wasn't up yet). This function must be called BEFORE
Andy Fleming00db8182005-07-30 19:31:23 -0400450 * phy_detach.
451 */
452void phy_stop_machine(struct phy_device *phydev)
453{
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700454 cancel_delayed_work_sync(&phydev->state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400455
Nate Case35b5f6b2008-01-29 10:05:09 -0600456 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400457 if (phydev->state > PHY_UP)
458 phydev->state = PHY_UP;
Nate Case35b5f6b2008-01-29 10:05:09 -0600459 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400460
Andy Fleming00db8182005-07-30 19:31:23 -0400461 phydev->adjust_state = NULL;
462}
463
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800464/**
465 * phy_force_reduction - reduce PHY speed/duplex settings by one step
466 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500467 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800468 * Description: Reduces the speed/duplex settings by one notch,
469 * in this order--
470 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
471 * The function bottoms out at 10/HALF.
Andy Fleminge1393452005-08-24 18:46:21 -0500472 */
473static void phy_force_reduction(struct phy_device *phydev)
474{
475 int idx;
476
477 idx = phy_find_setting(phydev->speed, phydev->duplex);
478
479 idx++;
480
481 idx = phy_find_valid(idx, phydev->supported);
482
483 phydev->speed = settings[idx].speed;
484 phydev->duplex = settings[idx].duplex;
485
Joe Perches8d242482012-06-09 07:49:07 +0000486 pr_info("Trying %d/%s\n",
487 phydev->speed, DUPLEX_FULL == phydev->duplex ? "FULL" : "HALF");
Andy Fleminge1393452005-08-24 18:46:21 -0500488}
489
490
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800491/**
492 * phy_error - enter HALTED state for this PHY device
493 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400494 *
495 * Moves the PHY to the HALTED state in response to a read
496 * or write error, and tells the controller the link is down.
497 * Must not be called from interrupt context, or while the
498 * phydev->lock is held.
499 */
Andy Fleming9b9a8bf2008-05-02 13:00:51 -0500500static void phy_error(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400501{
Nate Case35b5f6b2008-01-29 10:05:09 -0600502 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400503 phydev->state = PHY_HALTED;
Nate Case35b5f6b2008-01-29 10:05:09 -0600504 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400505}
506
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800507/**
508 * phy_interrupt - PHY interrupt handler
509 * @irq: interrupt line
510 * @phy_dat: phy_device pointer
Andy Fleminge1393452005-08-24 18:46:21 -0500511 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800512 * Description: When a PHY interrupt occurs, the handler disables
Andy Fleminge1393452005-08-24 18:46:21 -0500513 * interrupts, and schedules a work task to clear the interrupt.
514 */
David Howells7d12e782006-10-05 14:55:46 +0100515static irqreturn_t phy_interrupt(int irq, void *phy_dat)
Andy Fleminge1393452005-08-24 18:46:21 -0500516{
517 struct phy_device *phydev = phy_dat;
518
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100519 if (PHY_HALTED == phydev->state)
520 return IRQ_NONE; /* It can't be ours. */
521
Andy Fleminge1393452005-08-24 18:46:21 -0500522 /* The MDIO bus is not allowed to be written in interrupt
523 * context, so we need to disable the irq here. A work
524 * queue will write the PHY to disable and clear the
525 * interrupt, and then reenable the irq line. */
526 disable_irq_nosync(irq);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700527 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500528
529 schedule_work(&phydev->phy_queue);
530
531 return IRQ_HANDLED;
532}
533
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800534/**
535 * phy_enable_interrupts - Enable the interrupts from the PHY side
536 * @phydev: target phy_device struct
537 */
stephen hemminger89ff05e2010-10-21 08:37:41 +0000538static int phy_enable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400539{
540 int err;
541
Andy Fleminge1393452005-08-24 18:46:21 -0500542 err = phy_clear_interrupt(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400543
Andy Fleminge1393452005-08-24 18:46:21 -0500544 if (err < 0)
545 return err;
Andy Fleming00db8182005-07-30 19:31:23 -0400546
Andy Fleminge1393452005-08-24 18:46:21 -0500547 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleming00db8182005-07-30 19:31:23 -0400548
549 return err;
550}
Andy Fleming00db8182005-07-30 19:31:23 -0400551
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800552/**
553 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
554 * @phydev: target phy_device struct
555 */
stephen hemminger89ff05e2010-10-21 08:37:41 +0000556static int phy_disable_interrupts(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400557{
558 int err;
559
560 /* Disable PHY interrupts */
561 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
562
563 if (err)
564 goto phy_err;
565
566 /* Clear the interrupt */
567 err = phy_clear_interrupt(phydev);
568
569 if (err)
570 goto phy_err;
571
572 return 0;
573
574phy_err:
575 phy_error(phydev);
576
577 return err;
578}
Andy Fleminge1393452005-08-24 18:46:21 -0500579
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800580/**
581 * phy_start_interrupts - request and enable interrupts for a PHY device
582 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500583 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800584 * Description: Request the interrupt for the given PHY.
585 * If this fails, then we set irq to PHY_POLL.
Andy Fleminge1393452005-08-24 18:46:21 -0500586 * Otherwise, we enable the interrupts in the PHY.
Andy Fleminge1393452005-08-24 18:46:21 -0500587 * This should only be called with a valid IRQ number.
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800588 * Returns 0 on success or < 0 on error.
Andy Fleminge1393452005-08-24 18:46:21 -0500589 */
590int phy_start_interrupts(struct phy_device *phydev)
591{
592 int err = 0;
593
David Howellsc4028952006-11-22 14:57:56 +0000594 INIT_WORK(&phydev->phy_queue, phy_change);
Andy Fleminge1393452005-08-24 18:46:21 -0500595
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700596 atomic_set(&phydev->irq_disable, 0);
Andy Fleminge1393452005-08-24 18:46:21 -0500597 if (request_irq(phydev->irq, phy_interrupt,
Thomas Gleixner1fb9df52006-07-01 19:29:39 -0700598 IRQF_SHARED,
Andy Fleminge1393452005-08-24 18:46:21 -0500599 "phy_interrupt",
600 phydev) < 0) {
Joe Perches8d242482012-06-09 07:49:07 +0000601 pr_warn("%s: Can't get IRQ %d (PHY)\n",
602 phydev->bus->name, phydev->irq);
Andy Fleminge1393452005-08-24 18:46:21 -0500603 phydev->irq = PHY_POLL;
604 return 0;
605 }
606
607 err = phy_enable_interrupts(phydev);
608
609 return err;
610}
611EXPORT_SYMBOL(phy_start_interrupts);
612
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800613/**
614 * phy_stop_interrupts - disable interrupts from a PHY device
615 * @phydev: target phy_device struct
616 */
Andy Fleminge1393452005-08-24 18:46:21 -0500617int phy_stop_interrupts(struct phy_device *phydev)
618{
619 int err;
620
621 err = phy_disable_interrupts(phydev);
622
623 if (err)
624 phy_error(phydev);
625
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700626 free_irq(phydev->irq, phydev);
627
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100628 /*
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700629 * Cannot call flush_scheduled_work() here as desired because
630 * of rtnl_lock(), but we do not really care about what would
631 * be done, except from enable_irq(), so cancel any work
632 * possibly pending and take care of the matter below.
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100633 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700634 cancel_work_sync(&phydev->phy_queue);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700635 /*
636 * If work indeed has been cancelled, disable_irq() will have
637 * been left unbalanced from phy_interrupt() and enable_irq()
638 * has to be called so that other devices on the line work.
639 */
640 while (atomic_dec_return(&phydev->irq_disable) >= 0)
641 enable_irq(phydev->irq);
Andy Fleminge1393452005-08-24 18:46:21 -0500642
643 return err;
644}
645EXPORT_SYMBOL(phy_stop_interrupts);
646
647
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800648/**
649 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
650 * @work: work_struct that describes the work to be done
651 */
David Howellsc4028952006-11-22 14:57:56 +0000652static void phy_change(struct work_struct *work)
Andy Fleminge1393452005-08-24 18:46:21 -0500653{
654 int err;
David Howellsc4028952006-11-22 14:57:56 +0000655 struct phy_device *phydev =
656 container_of(work, struct phy_device, phy_queue);
Andy Fleminge1393452005-08-24 18:46:21 -0500657
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000658 if (phydev->drv->did_interrupt &&
659 !phydev->drv->did_interrupt(phydev))
660 goto ignore;
661
Andy Fleminge1393452005-08-24 18:46:21 -0500662 err = phy_disable_interrupts(phydev);
663
664 if (err)
665 goto phy_err;
666
Nate Case35b5f6b2008-01-29 10:05:09 -0600667 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500668 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
669 phydev->state = PHY_CHANGELINK;
Nate Case35b5f6b2008-01-29 10:05:09 -0600670 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500671
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700672 atomic_dec(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500673 enable_irq(phydev->irq);
674
675 /* Reenable interrupts */
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100676 if (PHY_HALTED != phydev->state)
677 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500678
679 if (err)
680 goto irq_enable_err;
681
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700682 /* reschedule state queue work to run as soon as possible */
683 cancel_delayed_work_sync(&phydev->state_queue);
684 schedule_delayed_work(&phydev->state_queue, 0);
Trent Piepho0acb2832008-10-08 15:46:57 -0700685
Andy Fleminge1393452005-08-24 18:46:21 -0500686 return;
687
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000688ignore:
689 atomic_dec(&phydev->irq_disable);
690 enable_irq(phydev->irq);
691 return;
692
Andy Fleminge1393452005-08-24 18:46:21 -0500693irq_enable_err:
694 disable_irq(phydev->irq);
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700695 atomic_inc(&phydev->irq_disable);
Andy Fleminge1393452005-08-24 18:46:21 -0500696phy_err:
697 phy_error(phydev);
698}
699
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800700/**
701 * phy_stop - Bring down the PHY link, and stop checking the status
702 * @phydev: target phy_device struct
703 */
Andy Fleminge1393452005-08-24 18:46:21 -0500704void phy_stop(struct phy_device *phydev)
705{
Nate Case35b5f6b2008-01-29 10:05:09 -0600706 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500707
708 if (PHY_HALTED == phydev->state)
709 goto out_unlock;
710
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100711 if (phydev->irq != PHY_POLL) {
Andy Fleminge1393452005-08-24 18:46:21 -0500712 /* Disable PHY Interrupts */
713 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
Andy Fleminge1393452005-08-24 18:46:21 -0500714
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100715 /* Clear any pending interrupts */
716 phy_clear_interrupt(phydev);
717 }
Andy Fleminge1393452005-08-24 18:46:21 -0500718
Maciej W. Rozycki6daf6532007-09-28 22:42:15 -0700719 phydev->state = PHY_HALTED;
720
Andy Fleminge1393452005-08-24 18:46:21 -0500721out_unlock:
Nate Case35b5f6b2008-01-29 10:05:09 -0600722 mutex_unlock(&phydev->lock);
Maciej W. Rozycki3c3070d2006-10-03 16:18:35 +0100723
724 /*
725 * Cannot call flush_scheduled_work() here as desired because
726 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
727 * will not reenable interrupts.
728 */
Andy Fleminge1393452005-08-24 18:46:21 -0500729}
730
731
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800732/**
733 * phy_start - start or restart a PHY device
734 * @phydev: target phy_device struct
Andy Fleminge1393452005-08-24 18:46:21 -0500735 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800736 * Description: Indicates the attached device's readiness to
Andy Fleminge1393452005-08-24 18:46:21 -0500737 * handle PHY-related work. Used during startup to start the
738 * PHY, and after a call to phy_stop() to resume operation.
739 * Also used to indicate the MDIO bus has cleared an error
740 * condition.
741 */
742void phy_start(struct phy_device *phydev)
743{
Nate Case35b5f6b2008-01-29 10:05:09 -0600744 mutex_lock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500745
746 switch (phydev->state) {
747 case PHY_STARTING:
748 phydev->state = PHY_PENDING;
749 break;
750 case PHY_READY:
751 phydev->state = PHY_UP;
752 break;
753 case PHY_HALTED:
754 phydev->state = PHY_RESUMING;
755 default:
756 break;
757 }
Nate Case35b5f6b2008-01-29 10:05:09 -0600758 mutex_unlock(&phydev->lock);
Andy Fleminge1393452005-08-24 18:46:21 -0500759}
760EXPORT_SYMBOL(phy_stop);
761EXPORT_SYMBOL(phy_start);
Jeff Garzik67c4f3f2005-08-11 02:07:25 -0400762
Nate Case35b5f6b2008-01-29 10:05:09 -0600763/**
764 * phy_state_machine - Handle the state machine
765 * @work: work_struct that describes the work to be done
Nate Case35b5f6b2008-01-29 10:05:09 -0600766 */
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000767void phy_state_machine(struct work_struct *work)
Andy Fleming00db8182005-07-30 19:31:23 -0400768{
Jean Delvarebf6aede2009-04-02 16:56:54 -0700769 struct delayed_work *dwork = to_delayed_work(work);
Nate Case35b5f6b2008-01-29 10:05:09 -0600770 struct phy_device *phydev =
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700771 container_of(dwork, struct phy_device, state_queue);
Andy Fleming00db8182005-07-30 19:31:23 -0400772 int needs_aneg = 0;
773 int err = 0;
774
Nate Case35b5f6b2008-01-29 10:05:09 -0600775 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400776
777 if (phydev->adjust_state)
778 phydev->adjust_state(phydev->attached_dev);
779
780 switch(phydev->state) {
781 case PHY_DOWN:
782 case PHY_STARTING:
783 case PHY_READY:
784 case PHY_PENDING:
785 break;
786 case PHY_UP:
787 needs_aneg = 1;
788
789 phydev->link_timeout = PHY_AN_TIMEOUT;
790
791 break;
792 case PHY_AN:
Andy Fleming6b655522006-10-16 16:19:17 -0500793 err = phy_read_status(phydev);
794
795 if (err < 0)
796 break;
797
798 /* If the link is down, give up on
799 * negotiation for now */
800 if (!phydev->link) {
801 phydev->state = PHY_NOLINK;
802 netif_carrier_off(phydev->attached_dev);
803 phydev->adjust_link(phydev->attached_dev);
804 break;
805 }
806
Andy Fleming00db8182005-07-30 19:31:23 -0400807 /* Check if negotiation is done. Break
808 * if there's an error */
809 err = phy_aneg_done(phydev);
810 if (err < 0)
811 break;
812
Andy Fleming6b655522006-10-16 16:19:17 -0500813 /* If AN is done, we're running */
Andy Fleming00db8182005-07-30 19:31:23 -0400814 if (err > 0) {
Andy Fleming6b655522006-10-16 16:19:17 -0500815 phydev->state = PHY_RUNNING;
816 netif_carrier_on(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400817 phydev->adjust_link(phydev->attached_dev);
818
819 } else if (0 == phydev->link_timeout--) {
Andy Fleming6b655522006-10-16 16:19:17 -0500820 int idx;
Andy Fleming00db8182005-07-30 19:31:23 -0400821
822 needs_aneg = 1;
Andy Fleming6b655522006-10-16 16:19:17 -0500823 /* If we have the magic_aneg bit,
824 * we try again */
825 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
826 break;
827
828 /* The timer expired, and we still
829 * don't have a setting, so we try
830 * forcing it until we find one that
831 * works, starting from the fastest speed,
832 * and working our way down */
833 idx = phy_find_valid(0, phydev->supported);
834
835 phydev->speed = settings[idx].speed;
836 phydev->duplex = settings[idx].duplex;
837
838 phydev->autoneg = AUTONEG_DISABLE;
839
Joe Perches8d242482012-06-09 07:49:07 +0000840 pr_info("Trying %d/%s\n",
841 phydev->speed,
842 DUPLEX_FULL == phydev->duplex ?
843 "FULL" : "HALF");
Andy Fleming00db8182005-07-30 19:31:23 -0400844 }
845 break;
846 case PHY_NOLINK:
847 err = phy_read_status(phydev);
848
849 if (err)
850 break;
851
852 if (phydev->link) {
853 phydev->state = PHY_RUNNING;
854 netif_carrier_on(phydev->attached_dev);
855 phydev->adjust_link(phydev->attached_dev);
856 }
857 break;
858 case PHY_FORCING:
Andy Fleming6b655522006-10-16 16:19:17 -0500859 err = genphy_update_link(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400860
861 if (err)
862 break;
863
864 if (phydev->link) {
865 phydev->state = PHY_RUNNING;
866 netif_carrier_on(phydev->attached_dev);
867 } else {
868 if (0 == phydev->link_timeout--) {
869 phy_force_reduction(phydev);
870 needs_aneg = 1;
871 }
872 }
873
874 phydev->adjust_link(phydev->attached_dev);
875 break;
876 case PHY_RUNNING:
877 /* Only register a CHANGE if we are
878 * polling */
879 if (PHY_POLL == phydev->irq)
880 phydev->state = PHY_CHANGELINK;
881 break;
882 case PHY_CHANGELINK:
883 err = phy_read_status(phydev);
884
885 if (err)
886 break;
887
888 if (phydev->link) {
889 phydev->state = PHY_RUNNING;
890 netif_carrier_on(phydev->attached_dev);
891 } else {
892 phydev->state = PHY_NOLINK;
893 netif_carrier_off(phydev->attached_dev);
894 }
895
896 phydev->adjust_link(phydev->attached_dev);
897
898 if (PHY_POLL != phydev->irq)
899 err = phy_config_interrupt(phydev,
900 PHY_INTERRUPT_ENABLED);
901 break;
902 case PHY_HALTED:
903 if (phydev->link) {
904 phydev->link = 0;
905 netif_carrier_off(phydev->attached_dev);
906 phydev->adjust_link(phydev->attached_dev);
907 }
908 break;
909 case PHY_RESUMING:
910
911 err = phy_clear_interrupt(phydev);
912
913 if (err)
914 break;
915
916 err = phy_config_interrupt(phydev,
917 PHY_INTERRUPT_ENABLED);
918
919 if (err)
920 break;
921
922 if (AUTONEG_ENABLE == phydev->autoneg) {
923 err = phy_aneg_done(phydev);
924 if (err < 0)
925 break;
926
927 /* err > 0 if AN is done.
928 * Otherwise, it's 0, and we're
929 * still waiting for AN */
930 if (err > 0) {
Wade Farnsworth42caa072009-07-01 13:00:34 +0000931 err = phy_read_status(phydev);
932 if (err)
933 break;
934
935 if (phydev->link) {
936 phydev->state = PHY_RUNNING;
937 netif_carrier_on(phydev->attached_dev);
938 } else
939 phydev->state = PHY_NOLINK;
940 phydev->adjust_link(phydev->attached_dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400941 } else {
942 phydev->state = PHY_AN;
943 phydev->link_timeout = PHY_AN_TIMEOUT;
944 }
Wade Farnsworth42caa072009-07-01 13:00:34 +0000945 } else {
946 err = phy_read_status(phydev);
947 if (err)
948 break;
949
950 if (phydev->link) {
951 phydev->state = PHY_RUNNING;
952 netif_carrier_on(phydev->attached_dev);
953 } else
954 phydev->state = PHY_NOLINK;
955 phydev->adjust_link(phydev->attached_dev);
956 }
Andy Fleming00db8182005-07-30 19:31:23 -0400957 break;
958 }
959
Nate Case35b5f6b2008-01-29 10:05:09 -0600960 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400961
962 if (needs_aneg)
963 err = phy_start_aneg(phydev);
964
965 if (err < 0)
966 phy_error(phydev);
967
Atsushi Nemoto36640902009-04-16 02:43:37 -0700968 schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);
Nate Case35b5f6b2008-01-29 10:05:09 -0600969}