blob: 24126c4b27b58e443fe3569fa7143e256466ce84 [file] [log] [blame]
Andy Fleming00db8182005-07-30 19:31:23 -04001/*
Andy Fleming00db8182005-07-30 19:31:23 -04002 * Framework and drivers for configuring and reading different PHYs
3 * Based on code in sungem_phy.c and gianfar_phy.c
4 *
5 * Author: Andy Fleming
6 *
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 *
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
13 *
14 */
15
16#ifndef __PHY_H
17#define __PHY_H
18
19#include <linux/spinlock.h>
Maciej W. Rozycki13df29f2006-10-03 16:18:28 +010020#include <linux/ethtool.h>
21#include <linux/mii.h>
22#include <linux/timer.h>
23#include <linux/workqueue.h>
David Woodhouse8626d3b2010-04-02 01:05:27 +000024#include <linux/mod_devicetable.h>
Andy Fleming00db8182005-07-30 19:31:23 -040025
Arun Sharma600634972011-07-26 16:09:06 -070026#include <linux/atomic.h>
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -070027
Florian Fainellie9fbdf12013-12-05 14:52:13 -080028#define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
Andy Fleming00db8182005-07-30 19:31:23 -040029 SUPPORTED_TP | \
30 SUPPORTED_MII)
31
Florian Fainellie9fbdf12013-12-05 14:52:13 -080032#define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
33 SUPPORTED_10baseT_Full)
34
35#define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
36 SUPPORTED_100baseT_Full)
37
38#define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
Andy Fleming00db8182005-07-30 19:31:23 -040039 SUPPORTED_1000baseT_Full)
40
Florian Fainellie9fbdf12013-12-05 14:52:13 -080041#define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
42 PHY_100BT_FEATURES | \
43 PHY_DEFAULT_FEATURES)
44
45#define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
46 PHY_1000BT_FEATURES)
47
48
Andy Flemingc5e38a92008-04-09 19:38:27 -050049/*
50 * Set phydev->irq to PHY_POLL if interrupts are not supported,
Andy Fleming00db8182005-07-30 19:31:23 -040051 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
52 * the attached driver handles the interrupt
53 */
54#define PHY_POLL -1
55#define PHY_IGNORE_INTERRUPT -2
56
57#define PHY_HAS_INTERRUPT 0x00000001
58#define PHY_HAS_MAGICANEG 0x00000002
Florian Fainelli4284b6a2013-05-23 01:11:12 +000059#define PHY_IS_INTERNAL 0x00000004
Andy Fleming00db8182005-07-30 19:31:23 -040060
Andy Fleminge8a2b6a2006-12-01 12:01:06 -060061/* Interface Mode definitions */
62typedef enum {
Shawn Guo4157ef12011-07-05 16:42:09 +080063 PHY_INTERFACE_MODE_NA,
Andy Fleminge8a2b6a2006-12-01 12:01:06 -060064 PHY_INTERFACE_MODE_MII,
65 PHY_INTERFACE_MODE_GMII,
66 PHY_INTERFACE_MODE_SGMII,
67 PHY_INTERFACE_MODE_TBI,
Florian Fainelli2cc70ba2013-05-28 04:07:21 +000068 PHY_INTERFACE_MODE_REVMII,
Andy Fleminge8a2b6a2006-12-01 12:01:06 -060069 PHY_INTERFACE_MODE_RMII,
70 PHY_INTERFACE_MODE_RGMII,
Kim Phillipsa9995892007-04-13 01:25:57 -050071 PHY_INTERFACE_MODE_RGMII_ID,
Kim Phillips7d400a42007-11-26 16:17:48 -060072 PHY_INTERFACE_MODE_RGMII_RXID,
73 PHY_INTERFACE_MODE_RGMII_TXID,
Shawn Guo4157ef12011-07-05 16:42:09 +080074 PHY_INTERFACE_MODE_RTBI,
75 PHY_INTERFACE_MODE_SMII,
Andy Fleming898dd0b2014-01-10 14:26:46 +080076 PHY_INTERFACE_MODE_XGMII,
Florian Fainellifd70f722014-02-13 16:08:42 -080077 PHY_INTERFACE_MODE_MOCA,
Florian Fainelli8a2fe562014-02-11 17:27:39 -080078 PHY_INTERFACE_MODE_MAX,
Andy Fleminge8a2b6a2006-12-01 12:01:06 -060079} phy_interface_t;
80
Florian Fainelli8a2fe562014-02-11 17:27:39 -080081/**
82 * It maps 'enum phy_interface_t' found in include/linux/phy.h
83 * into the device tree binding of 'phy-mode', so that Ethernet
84 * device driver can get phy interface from device tree.
85 */
86static inline const char *phy_modes(phy_interface_t interface)
87{
88 switch (interface) {
89 case PHY_INTERFACE_MODE_NA:
90 return "";
91 case PHY_INTERFACE_MODE_MII:
92 return "mii";
93 case PHY_INTERFACE_MODE_GMII:
94 return "gmii";
95 case PHY_INTERFACE_MODE_SGMII:
96 return "sgmii";
97 case PHY_INTERFACE_MODE_TBI:
98 return "tbi";
99 case PHY_INTERFACE_MODE_REVMII:
100 return "rev-mii";
101 case PHY_INTERFACE_MODE_RMII:
102 return "rmii";
103 case PHY_INTERFACE_MODE_RGMII:
104 return "rgmii";
105 case PHY_INTERFACE_MODE_RGMII_ID:
106 return "rgmii-id";
107 case PHY_INTERFACE_MODE_RGMII_RXID:
108 return "rgmii-rxid";
109 case PHY_INTERFACE_MODE_RGMII_TXID:
110 return "rgmii-txid";
111 case PHY_INTERFACE_MODE_RTBI:
112 return "rtbi";
113 case PHY_INTERFACE_MODE_SMII:
114 return "smii";
115 case PHY_INTERFACE_MODE_XGMII:
116 return "xgmii";
Florian Fainellifd70f722014-02-13 16:08:42 -0800117 case PHY_INTERFACE_MODE_MOCA:
118 return "moca";
Florian Fainelli8a2fe562014-02-11 17:27:39 -0800119 default:
120 return "unknown";
121 }
122}
123
Andy Fleming00db8182005-07-30 19:31:23 -0400124
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600125#define PHY_INIT_TIMEOUT 100000
Andy Fleming00db8182005-07-30 19:31:23 -0400126#define PHY_STATE_TIME 1
127#define PHY_FORCE_TIMEOUT 10
128#define PHY_AN_TIMEOUT 10
129
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600130#define PHY_MAX_ADDR 32
Andy Fleming00db8182005-07-30 19:31:23 -0400131
Kumar Galaa4d00f12006-01-11 11:27:33 -0800132/* Used when trying to connect to a specific phy (mii bus id:phy device id) */
Andy Fleming9d9326d2008-04-09 19:38:13 -0500133#define PHY_ID_FMT "%s:%02x"
134
135/*
136 * Need to be a little smaller than phydev->dev.bus_id to leave room
137 * for the ":%02x"
138 */
David S. Miller8e401ec2009-05-26 21:16:25 -0700139#define MII_BUS_ID_SIZE (20 - 3)
Kumar Galaa4d00f12006-01-11 11:27:33 -0800140
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000141/* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
142 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
143#define MII_ADDR_C45 (1<<30)
144
Paul Gortmaker313162d2012-01-30 11:46:54 -0500145struct device;
146struct sk_buff;
147
Andy Flemingc5e38a92008-04-09 19:38:27 -0500148/*
149 * The Bus class for PHYs. Devices which provide access to
150 * PHYs should register using this structure
151 */
Andy Fleming00db8182005-07-30 19:31:23 -0400152struct mii_bus {
153 const char *name;
Andy Fleming9d9326d2008-04-09 19:38:13 -0500154 char id[MII_BUS_ID_SIZE];
Andy Fleming00db8182005-07-30 19:31:23 -0400155 void *priv;
156 int (*read)(struct mii_bus *bus, int phy_id, int regnum);
157 int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
158 int (*reset)(struct mii_bus *bus);
159
Andy Flemingc5e38a92008-04-09 19:38:27 -0500160 /*
161 * A lock to ensure that only one thing can read/write
162 * the MDIO bus at a time
163 */
Nate Case35b5f6b2008-01-29 10:05:09 -0600164 struct mutex mdio_lock;
Andy Fleming00db8182005-07-30 19:31:23 -0400165
Lennert Buytenhek18ee49d2008-10-01 15:41:33 +0000166 struct device *parent;
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700167 enum {
168 MDIOBUS_ALLOCATED = 1,
169 MDIOBUS_REGISTERED,
170 MDIOBUS_UNREGISTERED,
171 MDIOBUS_RELEASED,
172 } state;
173 struct device dev;
Andy Fleming00db8182005-07-30 19:31:23 -0400174
175 /* list of all PHYs on bus */
176 struct phy_device *phy_map[PHY_MAX_ADDR];
177
Peter Meerwaldc6883992010-09-02 04:06:24 +0000178 /* PHY addresses to be ignored when probing */
Matt Porterf896424c2005-11-02 16:13:06 -0700179 u32 phy_mask;
180
Andy Flemingc5e38a92008-04-09 19:38:27 -0500181 /*
182 * Pointer to an array of interrupts, each PHY's
183 * interrupt at the index matching its address
184 */
Andy Fleming00db8182005-07-30 19:31:23 -0400185 int *irq;
186};
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700187#define to_mii_bus(d) container_of(d, struct mii_bus, dev)
Andy Fleming00db8182005-07-30 19:31:23 -0400188
Timur Tabieb8a54a72012-01-12 15:23:04 -0800189struct mii_bus *mdiobus_alloc_size(size_t);
190static inline struct mii_bus *mdiobus_alloc(void)
191{
192 return mdiobus_alloc_size(0);
193}
194
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000195int mdiobus_register(struct mii_bus *bus);
196void mdiobus_unregister(struct mii_bus *bus);
197void mdiobus_free(struct mii_bus *bus);
198struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000199int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
200int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000201
202
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600203#define PHY_INTERRUPT_DISABLED 0x0
204#define PHY_INTERRUPT_ENABLED 0x80000000
Andy Fleming00db8182005-07-30 19:31:23 -0400205
206/* PHY state machine states:
207 *
208 * DOWN: PHY device and driver are not ready for anything. probe
209 * should be called if and only if the PHY is in this state,
210 * given that the PHY device exists.
211 * - PHY driver probe function will, depending on the PHY, set
212 * the state to STARTING or READY
213 *
214 * STARTING: PHY device is coming up, and the ethernet driver is
215 * not ready. PHY drivers may set this in the probe function.
216 * If they do, they are responsible for making sure the state is
217 * eventually set to indicate whether the PHY is UP or READY,
218 * depending on the state when the PHY is done starting up.
219 * - PHY driver will set the state to READY
220 * - start will set the state to PENDING
221 *
222 * READY: PHY is ready to send and receive packets, but the
223 * controller is not. By default, PHYs which do not implement
224 * probe will be set to this state by phy_probe(). If the PHY
225 * driver knows the PHY is ready, and the PHY state is STARTING,
226 * then it sets this STATE.
227 * - start will set the state to UP
228 *
229 * PENDING: PHY device is coming up, but the ethernet driver is
230 * ready. phy_start will set this state if the PHY state is
231 * STARTING.
232 * - PHY driver will set the state to UP when the PHY is ready
233 *
234 * UP: The PHY and attached device are ready to do work.
235 * Interrupts should be started here.
236 * - timer moves to AN
237 *
238 * AN: The PHY is currently negotiating the link state. Link is
239 * therefore down for now. phy_timer will set this state when it
240 * detects the state is UP. config_aneg will set this state
241 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
242 * - If autonegotiation finishes, but there's no link, it sets
243 * the state to NOLINK.
244 * - If aneg finishes with link, it sets the state to RUNNING,
245 * and calls adjust_link
246 * - If autonegotiation did not finish after an arbitrary amount
247 * of time, autonegotiation should be tried again if the PHY
248 * supports "magic" autonegotiation (back to AN)
249 * - If it didn't finish, and no magic_aneg, move to FORCING.
250 *
251 * NOLINK: PHY is up, but not currently plugged in.
252 * - If the timer notes that the link comes back, we move to RUNNING
253 * - config_aneg moves to AN
254 * - phy_stop moves to HALTED
255 *
256 * FORCING: PHY is being configured with forced settings
257 * - if link is up, move to RUNNING
258 * - If link is down, we drop to the next highest setting, and
259 * retry (FORCING) after a timeout
260 * - phy_stop moves to HALTED
261 *
262 * RUNNING: PHY is currently up, running, and possibly sending
263 * and/or receiving packets
264 * - timer will set CHANGELINK if we're polling (this ensures the
265 * link state is polled every other cycle of this state machine,
266 * which makes it every other second)
267 * - irq will set CHANGELINK
268 * - config_aneg will set AN
269 * - phy_stop moves to HALTED
270 *
271 * CHANGELINK: PHY experienced a change in link state
272 * - timer moves to RUNNING if link
273 * - timer moves to NOLINK if the link is down
274 * - phy_stop moves to HALTED
275 *
276 * HALTED: PHY is up, but no polling or interrupts are done. Or
277 * PHY is in an error state.
278 *
279 * - phy_start moves to RESUMING
280 *
281 * RESUMING: PHY was halted, but now wants to run again.
282 * - If we are forcing, or aneg is done, timer moves to RUNNING
283 * - If aneg is not done, timer moves to AN
284 * - phy_stop moves to HALTED
285 */
286enum phy_state {
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300287 PHY_DOWN = 0,
Andy Fleming00db8182005-07-30 19:31:23 -0400288 PHY_STARTING,
289 PHY_READY,
290 PHY_PENDING,
291 PHY_UP,
292 PHY_AN,
293 PHY_RUNNING,
294 PHY_NOLINK,
295 PHY_FORCING,
296 PHY_CHANGELINK,
297 PHY_HALTED,
298 PHY_RESUMING
299};
300
David Daneyac28b9f2012-06-27 07:33:35 +0000301/**
302 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
303 * @devices_in_package: Bit vector of devices present.
304 * @device_ids: The device identifer for each present device.
305 */
306struct phy_c45_device_ids {
307 u32 devices_in_package;
308 u32 device_ids[8];
309};
Richard Cochranc1f19b52010-07-17 08:49:36 +0000310
Andy Fleming00db8182005-07-30 19:31:23 -0400311/* phy_device: An instance of a PHY
312 *
313 * drv: Pointer to the driver for this PHY instance
314 * bus: Pointer to the bus this PHY is on
315 * dev: driver model device structure for this PHY
316 * phy_id: UID for this device found during discovery
David Daneyac28b9f2012-06-27 07:33:35 +0000317 * c45_ids: 802.3-c45 Device Identifers if is_c45.
318 * is_c45: Set to true if this phy uses clause 45 addressing.
Florian Fainelli4284b6a2013-05-23 01:11:12 +0000319 * is_internal: Set to true if this phy is internal to a MAC.
Andy Fleming00db8182005-07-30 19:31:23 -0400320 * state: state of the PHY for management purposes
321 * dev_flags: Device-specific flags used by the PHY driver.
322 * addr: Bus address of PHY
323 * link_timeout: The number of timer firings to wait before the
324 * giving up on the current attempt at acquiring a link
325 * irq: IRQ number of the PHY's interrupt (-1 if none)
326 * phy_timer: The timer for handling the state machine
327 * phy_queue: A work_queue for the interrupt
328 * attached_dev: The attached enet driver's device instance ptr
329 * adjust_link: Callback for the enet controller to respond to
330 * changes in the link state.
Andy Fleming00db8182005-07-30 19:31:23 -0400331 *
Florian Fainelli114002b2013-12-06 13:01:30 -0800332 * speed, duplex, pause, supported, advertising, lp_advertising,
333 * and autoneg are used like in mii_if_info
Andy Fleming00db8182005-07-30 19:31:23 -0400334 *
335 * interrupts currently only supports enabled or disabled,
336 * but could be changed in the future to support enabling
337 * and disabling specific interrupts
338 *
339 * Contains some infrastructure for polling and interrupt
340 * handling, as well as handling shifts in PHY hardware state
341 */
342struct phy_device {
343 /* Information about the PHY type */
344 /* And management functions */
345 struct phy_driver *drv;
346
347 struct mii_bus *bus;
348
349 struct device dev;
350
351 u32 phy_id;
352
David Daneyac28b9f2012-06-27 07:33:35 +0000353 struct phy_c45_device_ids c45_ids;
354 bool is_c45;
Florian Fainelli4284b6a2013-05-23 01:11:12 +0000355 bool is_internal;
Florian Fainellib0ae0092014-02-11 17:27:41 -0800356 bool has_fixups;
David Daneyac28b9f2012-06-27 07:33:35 +0000357
Andy Fleming00db8182005-07-30 19:31:23 -0400358 enum phy_state state;
359
360 u32 dev_flags;
361
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600362 phy_interface_t interface;
363
Peter Meerwaldc6883992010-09-02 04:06:24 +0000364 /* Bus address of the PHY (0-31) */
Andy Fleming00db8182005-07-30 19:31:23 -0400365 int addr;
366
Andy Flemingc5e38a92008-04-09 19:38:27 -0500367 /*
368 * forced speed & duplex (no autoneg)
Andy Fleming00db8182005-07-30 19:31:23 -0400369 * partner speed & duplex & pause (autoneg)
370 */
371 int speed;
372 int duplex;
373 int pause;
374 int asym_pause;
375
376 /* The most recently read link state */
377 int link;
378
379 /* Enabled Interrupts */
380 u32 interrupts;
381
382 /* Union of PHY and Attached devices' supported modes */
383 /* See mii.h for more info */
384 u32 supported;
385 u32 advertising;
Florian Fainelli114002b2013-12-06 13:01:30 -0800386 u32 lp_advertising;
Andy Fleming00db8182005-07-30 19:31:23 -0400387
388 int autoneg;
389
390 int link_timeout;
391
Andy Flemingc5e38a92008-04-09 19:38:27 -0500392 /*
393 * Interrupt number for this PHY
394 * -1 means no interrupt
395 */
Andy Fleming00db8182005-07-30 19:31:23 -0400396 int irq;
397
398 /* private data pointer */
399 /* For use by PHYs to maintain extra state */
400 void *priv;
401
402 /* Interrupt and Polling infrastructure */
403 struct work_struct phy_queue;
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700404 struct delayed_work state_queue;
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700405 atomic_t irq_disable;
Andy Fleming00db8182005-07-30 19:31:23 -0400406
Nate Case35b5f6b2008-01-29 10:05:09 -0600407 struct mutex lock;
Andy Fleming00db8182005-07-30 19:31:23 -0400408
409 struct net_device *attached_dev;
410
411 void (*adjust_link)(struct net_device *dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400412};
413#define to_phy_device(d) container_of(d, struct phy_device, dev)
414
415/* struct phy_driver: Driver structure for a particular PHY type
416 *
417 * phy_id: The result of reading the UID registers of this PHY
418 * type, and ANDing them with the phy_id_mask. This driver
419 * only works for PHYs with IDs which match this field
420 * name: The friendly name of this PHY type
421 * phy_id_mask: Defines the important bits of the phy_id
422 * features: A list of features (speed, duplex, etc) supported
423 * by this PHY
424 * flags: A bitfield defining certain other features this PHY
425 * supports (like interrupts)
426 *
427 * The drivers must implement config_aneg and read_status. All
428 * other functions are optional. Note that none of these
429 * functions should be called from interrupt time. The goal is
430 * for the bus read/write functions to be able to block when the
431 * bus transaction is happening, and be freed up by an interrupt
432 * (The MPC85xx has this ability, though it is not currently
433 * supported in the driver).
434 */
435struct phy_driver {
436 u32 phy_id;
437 char *name;
438 unsigned int phy_id_mask;
439 u32 features;
440 u32 flags;
441
Andy Flemingc5e38a92008-04-09 19:38:27 -0500442 /*
Florian Fainelli9df81dd2014-02-17 13:34:03 -0800443 * Called to issue a PHY software reset
444 */
445 int (*soft_reset)(struct phy_device *phydev);
446
447 /*
Andy Flemingc5e38a92008-04-09 19:38:27 -0500448 * Called to initialize the PHY,
449 * including after a reset
450 */
Andy Fleming00db8182005-07-30 19:31:23 -0400451 int (*config_init)(struct phy_device *phydev);
452
Andy Flemingc5e38a92008-04-09 19:38:27 -0500453 /*
454 * Called during discovery. Used to set
455 * up device-specific structures, if any
456 */
Andy Fleming00db8182005-07-30 19:31:23 -0400457 int (*probe)(struct phy_device *phydev);
458
459 /* PHY Power Management */
460 int (*suspend)(struct phy_device *phydev);
461 int (*resume)(struct phy_device *phydev);
462
Andy Flemingc5e38a92008-04-09 19:38:27 -0500463 /*
464 * Configures the advertisement and resets
Andy Fleming00db8182005-07-30 19:31:23 -0400465 * autonegotiation if phydev->autoneg is on,
466 * forces the speed to the current settings in phydev
Andy Flemingc5e38a92008-04-09 19:38:27 -0500467 * if phydev->autoneg is off
468 */
Andy Fleming00db8182005-07-30 19:31:23 -0400469 int (*config_aneg)(struct phy_device *phydev);
470
Florian Fainelli76a423a2014-02-11 17:27:37 -0800471 /* Determines the auto negotiation result */
472 int (*aneg_done)(struct phy_device *phydev);
473
Andy Fleming00db8182005-07-30 19:31:23 -0400474 /* Determines the negotiated speed and duplex */
475 int (*read_status)(struct phy_device *phydev);
476
477 /* Clears any pending interrupts */
478 int (*ack_interrupt)(struct phy_device *phydev);
479
480 /* Enables or disables interrupts */
481 int (*config_intr)(struct phy_device *phydev);
482
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000483 /*
484 * Checks if the PHY generated an interrupt.
485 * For multi-PHY devices with shared PHY interrupt pin
486 */
487 int (*did_interrupt)(struct phy_device *phydev);
488
Andy Fleming00db8182005-07-30 19:31:23 -0400489 /* Clears up any memory if needed */
490 void (*remove)(struct phy_device *phydev);
491
David Daneya30e2c12012-06-27 07:33:37 +0000492 /* Returns true if this is a suitable driver for the given
493 * phydev. If NULL, matching is based on phy_id and
494 * phy_id_mask.
495 */
496 int (*match_phy_device)(struct phy_device *phydev);
497
Richard Cochranc8f3a8c2012-04-03 22:59:17 +0000498 /* Handles ethtool queries for hardware time stamping. */
499 int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
500
Richard Cochranc1f19b52010-07-17 08:49:36 +0000501 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
502 int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
503
504 /*
505 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
506 * the phy driver promises to deliver it using netif_rx() as
507 * soon as a timestamp becomes available. One of the
508 * PTP_CLASS_ values is passed in 'type'. The function must
509 * return true if the skb is accepted for delivery.
510 */
511 bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
512
513 /*
514 * Requests a Tx timestamp for 'skb'. The phy driver promises
Richard Cochranda92b192011-10-21 00:49:15 +0000515 * to deliver it using skb_complete_tx_timestamp() as soon as a
Richard Cochranc1f19b52010-07-17 08:49:36 +0000516 * timestamp becomes available. One of the PTP_CLASS_ values
517 * is passed in 'type'.
518 */
519 void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
520
Michael Stapelberg42e836e2013-03-11 13:56:44 +0000521 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
522 * enable Wake on LAN, so set_wol is provided to be called in the
523 * ethernet driver's set_wol function. */
524 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
525
526 /* See set_wol, but for checking whether Wake on LAN is enabled. */
527 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
528
Andy Fleming00db8182005-07-30 19:31:23 -0400529 struct device_driver driver;
530};
531#define to_phy_driver(d) container_of(d, struct phy_driver, driver)
532
Andy Flemingf62220d2008-04-18 17:29:54 -0500533#define PHY_ANY_ID "MATCH ANY PHY"
534#define PHY_ANY_UID 0xffffffff
535
536/* A Structure for boards to register fixups with the PHY Lib */
537struct phy_fixup {
538 struct list_head list;
David S. Miller8e401ec2009-05-26 21:16:25 -0700539 char bus_id[20];
Andy Flemingf62220d2008-04-18 17:29:54 -0500540 u32 phy_uid;
541 u32 phy_uid_mask;
542 int (*run)(struct phy_device *phydev);
543};
544
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000545/**
Andy Flemingefabdfb2014-01-10 14:25:09 +0800546 * phy_read_mmd - Convenience function for reading a register
547 * from an MMD on a given PHY.
548 * @phydev: The phy_device struct
549 * @devad: The MMD to read from
550 * @regnum: The register on the MMD to read
551 *
552 * Same rules as for phy_read();
553 */
554static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum)
555{
556 if (!phydev->is_c45)
557 return -EOPNOTSUPP;
558
559 return mdiobus_read(phydev->bus, phydev->addr,
560 MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff));
561}
562
563/**
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000564 * phy_read - Convenience function for reading a given PHY register
565 * @phydev: the phy_device struct
566 * @regnum: register number to read
567 *
568 * NOTE: MUST NOT be called from interrupt context,
569 * because the bus read/write functions may wait for an interrupt
570 * to conclude the operation.
571 */
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000572static inline int phy_read(struct phy_device *phydev, u32 regnum)
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000573{
574 return mdiobus_read(phydev->bus, phydev->addr, regnum);
575}
576
577/**
578 * phy_write - Convenience function for writing a given PHY register
579 * @phydev: the phy_device struct
580 * @regnum: register number to write
581 * @val: value to write to @regnum
582 *
583 * NOTE: MUST NOT be called from interrupt context,
584 * because the bus read/write functions may wait for an interrupt
585 * to conclude the operation.
586 */
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000587static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000588{
589 return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
590}
591
Florian Fainelli2c7b4922013-05-19 22:53:42 +0000592/**
593 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
594 * @phydev: the phy_device struct
595 *
596 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
597 * PHY_IGNORE_INTERRUPT
598 */
599static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
600{
601 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
602}
603
Florian Fainelli4284b6a2013-05-23 01:11:12 +0000604/**
605 * phy_is_internal - Convenience function for testing if a PHY is internal
606 * @phydev: the phy_device struct
607 */
608static inline bool phy_is_internal(struct phy_device *phydev)
609{
610 return phydev->is_internal;
611}
612
Andy Flemingefabdfb2014-01-10 14:25:09 +0800613/**
614 * phy_write_mmd - Convenience function for writing a register
615 * on an MMD on a given PHY.
616 * @phydev: The phy_device struct
617 * @devad: The MMD to read from
618 * @regnum: The register on the MMD to read
619 * @val: value to write to @regnum
620 *
621 * Same rules as for phy_write();
622 */
623static inline int phy_write_mmd(struct phy_device *phydev, int devad,
624 u32 regnum, u16 val)
625{
626 if (!phydev->is_c45)
627 return -EOPNOTSUPP;
628
629 regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
630
631 return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
632}
633
David Daneyac28b9f2012-06-27 07:33:35 +0000634struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300635 bool is_c45,
636 struct phy_c45_device_ids *c45_ids);
David Daneyac28b9f2012-06-27 07:33:35 +0000637struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
Grant Likely4dea5472009-04-25 12:52:46 +0000638int phy_device_register(struct phy_device *phy);
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000639int phy_init_hw(struct phy_device *phydev);
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +0100640int phy_suspend(struct phy_device *phydev);
641int phy_resume(struct phy_device *phydev);
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300642struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
643 phy_interface_t interface);
Jiri Pirkof8f76db2010-02-04 10:23:02 -0800644struct phy_device *phy_find_first(struct mii_bus *bus);
Andy Fleming257184d2014-01-10 14:27:54 +0800645int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
646 u32 flags, phy_interface_t interface);
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000647int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300648 void (*handler)(struct net_device *),
649 phy_interface_t interface);
650struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
651 void (*handler)(struct net_device *),
652 phy_interface_t interface);
Andy Fleminge1393452005-08-24 18:46:21 -0500653void phy_disconnect(struct phy_device *phydev);
654void phy_detach(struct phy_device *phydev);
655void phy_start(struct phy_device *phydev);
656void phy_stop(struct phy_device *phydev);
657int phy_start_aneg(struct phy_device *phydev);
658
Andy Fleminge1393452005-08-24 18:46:21 -0500659int phy_stop_interrupts(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400660
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300661static inline int phy_read_status(struct phy_device *phydev)
662{
Andy Fleming00db8182005-07-30 19:31:23 -0400663 return phydev->drv->read_status(phydev);
664}
665
Madalin Bucur3fb69bc2013-11-20 16:38:19 -0600666int genphy_setup_forced(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400667int genphy_restart_aneg(struct phy_device *phydev);
668int genphy_config_aneg(struct phy_device *phydev);
Florian Fainellia9fa6e62014-02-11 17:27:36 -0800669int genphy_aneg_done(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400670int genphy_update_link(struct phy_device *phydev);
671int genphy_read_status(struct phy_device *phydev);
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -0800672int genphy_suspend(struct phy_device *phydev);
673int genphy_resume(struct phy_device *phydev);
Florian Fainelli797ac072014-02-17 13:34:02 -0800674int genphy_soft_reset(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400675void phy_driver_unregister(struct phy_driver *drv);
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +0000676void phy_drivers_unregister(struct phy_driver *drv, int n);
Andy Fleming00db8182005-07-30 19:31:23 -0400677int phy_driver_register(struct phy_driver *new_driver);
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +0000678int phy_drivers_register(struct phy_driver *new_driver, int n);
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000679void phy_state_machine(struct work_struct *work);
Florian Fainelli5ea94e72013-05-19 22:53:43 +0000680void phy_change(struct work_struct *work);
681void phy_mac_interrupt(struct phy_device *phydev, int new_link);
Sergei Shtylyov29935ae2014-01-05 03:27:17 +0300682void phy_start_machine(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400683void phy_stop_machine(struct phy_device *phydev);
684int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
685int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300686int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
Andy Fleminge1393452005-08-24 18:46:21 -0500687int phy_start_interrupts(struct phy_device *phydev);
688void phy_print_status(struct phy_device *phydev);
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300689void phy_device_free(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400690
Andy Flemingf62220d2008-04-18 17:29:54 -0500691int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300692 int (*run)(struct phy_device *));
Andy Flemingf62220d2008-04-18 17:29:54 -0500693int phy_register_fixup_for_id(const char *bus_id,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300694 int (*run)(struct phy_device *));
Andy Flemingf62220d2008-04-18 17:29:54 -0500695int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300696 int (*run)(struct phy_device *));
Andy Flemingf62220d2008-04-18 17:29:54 -0500697
Giuseppe CAVALLAROa59a4d12012-06-27 21:14:38 +0000698int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
699int phy_get_eee_err(struct phy_device *phydev);
700int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
701int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
Michael Stapelberg42e836e2013-03-11 13:56:44 +0000702int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300703void phy_ethtool_get_wol(struct phy_device *phydev,
704 struct ethtool_wolinfo *wol);
Giuseppe CAVALLAROa59a4d12012-06-27 21:14:38 +0000705
Andy Fleming9b9a8bf2008-05-02 13:00:51 -0500706int __init mdio_bus_init(void);
707void mdio_bus_exit(void);
708
Andy Fleming00db8182005-07-30 19:31:23 -0400709extern struct bus_type mdio_bus_type;
Andy Fleming00db8182005-07-30 19:31:23 -0400710#endif /* __PHY_H */