blob: 51d15f684e7e0b0259b2183c83097ec77baf541e [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,
Thomas Petazzonib9d12082014-04-15 15:50:19 +020078 PHY_INTERFACE_MODE_QSGMII,
Florian Fainelli8a2fe562014-02-11 17:27:39 -080079 PHY_INTERFACE_MODE_MAX,
Andy Fleminge8a2b6a2006-12-01 12:01:06 -060080} phy_interface_t;
81
Florian Fainelli8a2fe562014-02-11 17:27:39 -080082/**
83 * It maps 'enum phy_interface_t' found in include/linux/phy.h
84 * into the device tree binding of 'phy-mode', so that Ethernet
85 * device driver can get phy interface from device tree.
86 */
87static inline const char *phy_modes(phy_interface_t interface)
88{
89 switch (interface) {
90 case PHY_INTERFACE_MODE_NA:
91 return "";
92 case PHY_INTERFACE_MODE_MII:
93 return "mii";
94 case PHY_INTERFACE_MODE_GMII:
95 return "gmii";
96 case PHY_INTERFACE_MODE_SGMII:
97 return "sgmii";
98 case PHY_INTERFACE_MODE_TBI:
99 return "tbi";
100 case PHY_INTERFACE_MODE_REVMII:
101 return "rev-mii";
102 case PHY_INTERFACE_MODE_RMII:
103 return "rmii";
104 case PHY_INTERFACE_MODE_RGMII:
105 return "rgmii";
106 case PHY_INTERFACE_MODE_RGMII_ID:
107 return "rgmii-id";
108 case PHY_INTERFACE_MODE_RGMII_RXID:
109 return "rgmii-rxid";
110 case PHY_INTERFACE_MODE_RGMII_TXID:
111 return "rgmii-txid";
112 case PHY_INTERFACE_MODE_RTBI:
113 return "rtbi";
114 case PHY_INTERFACE_MODE_SMII:
115 return "smii";
116 case PHY_INTERFACE_MODE_XGMII:
117 return "xgmii";
Florian Fainellifd70f722014-02-13 16:08:42 -0800118 case PHY_INTERFACE_MODE_MOCA:
119 return "moca";
Thomas Petazzonib9d12082014-04-15 15:50:19 +0200120 case PHY_INTERFACE_MODE_QSGMII:
121 return "qsgmii";
Florian Fainelli8a2fe562014-02-11 17:27:39 -0800122 default:
123 return "unknown";
124 }
125}
126
Andy Fleming00db8182005-07-30 19:31:23 -0400127
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600128#define PHY_INIT_TIMEOUT 100000
Andy Fleming00db8182005-07-30 19:31:23 -0400129#define PHY_STATE_TIME 1
130#define PHY_FORCE_TIMEOUT 10
131#define PHY_AN_TIMEOUT 10
132
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600133#define PHY_MAX_ADDR 32
Andy Fleming00db8182005-07-30 19:31:23 -0400134
Kumar Galaa4d00f12006-01-11 11:27:33 -0800135/* Used when trying to connect to a specific phy (mii bus id:phy device id) */
Andy Fleming9d9326d2008-04-09 19:38:13 -0500136#define PHY_ID_FMT "%s:%02x"
137
138/*
139 * Need to be a little smaller than phydev->dev.bus_id to leave room
140 * for the ":%02x"
141 */
David S. Miller8e401ec2009-05-26 21:16:25 -0700142#define MII_BUS_ID_SIZE (20 - 3)
Kumar Galaa4d00f12006-01-11 11:27:33 -0800143
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000144/* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
145 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
146#define MII_ADDR_C45 (1<<30)
147
Paul Gortmaker313162d2012-01-30 11:46:54 -0500148struct device;
149struct sk_buff;
150
Andy Flemingc5e38a92008-04-09 19:38:27 -0500151/*
152 * The Bus class for PHYs. Devices which provide access to
153 * PHYs should register using this structure
154 */
Andy Fleming00db8182005-07-30 19:31:23 -0400155struct mii_bus {
156 const char *name;
Andy Fleming9d9326d2008-04-09 19:38:13 -0500157 char id[MII_BUS_ID_SIZE];
Andy Fleming00db8182005-07-30 19:31:23 -0400158 void *priv;
159 int (*read)(struct mii_bus *bus, int phy_id, int regnum);
160 int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
161 int (*reset)(struct mii_bus *bus);
162
Andy Flemingc5e38a92008-04-09 19:38:27 -0500163 /*
164 * A lock to ensure that only one thing can read/write
165 * the MDIO bus at a time
166 */
Nate Case35b5f6b2008-01-29 10:05:09 -0600167 struct mutex mdio_lock;
Andy Fleming00db8182005-07-30 19:31:23 -0400168
Lennert Buytenhek18ee49d2008-10-01 15:41:33 +0000169 struct device *parent;
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700170 enum {
171 MDIOBUS_ALLOCATED = 1,
172 MDIOBUS_REGISTERED,
173 MDIOBUS_UNREGISTERED,
174 MDIOBUS_RELEASED,
175 } state;
176 struct device dev;
Andy Fleming00db8182005-07-30 19:31:23 -0400177
178 /* list of all PHYs on bus */
179 struct phy_device *phy_map[PHY_MAX_ADDR];
180
Peter Meerwaldc6883992010-09-02 04:06:24 +0000181 /* PHY addresses to be ignored when probing */
Matt Porterf896424c2005-11-02 16:13:06 -0700182 u32 phy_mask;
183
Andy Flemingc5e38a92008-04-09 19:38:27 -0500184 /*
185 * Pointer to an array of interrupts, each PHY's
186 * interrupt at the index matching its address
187 */
Andy Fleming00db8182005-07-30 19:31:23 -0400188 int *irq;
189};
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700190#define to_mii_bus(d) container_of(d, struct mii_bus, dev)
Andy Fleming00db8182005-07-30 19:31:23 -0400191
Timur Tabieb8a54a72012-01-12 15:23:04 -0800192struct mii_bus *mdiobus_alloc_size(size_t);
193static inline struct mii_bus *mdiobus_alloc(void)
194{
195 return mdiobus_alloc_size(0);
196}
197
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000198int mdiobus_register(struct mii_bus *bus);
199void mdiobus_unregister(struct mii_bus *bus);
200void mdiobus_free(struct mii_bus *bus);
201struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000202int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
203int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000204
205
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600206#define PHY_INTERRUPT_DISABLED 0x0
207#define PHY_INTERRUPT_ENABLED 0x80000000
Andy Fleming00db8182005-07-30 19:31:23 -0400208
209/* PHY state machine states:
210 *
211 * DOWN: PHY device and driver are not ready for anything. probe
212 * should be called if and only if the PHY is in this state,
213 * given that the PHY device exists.
214 * - PHY driver probe function will, depending on the PHY, set
215 * the state to STARTING or READY
216 *
217 * STARTING: PHY device is coming up, and the ethernet driver is
218 * not ready. PHY drivers may set this in the probe function.
219 * If they do, they are responsible for making sure the state is
220 * eventually set to indicate whether the PHY is UP or READY,
221 * depending on the state when the PHY is done starting up.
222 * - PHY driver will set the state to READY
223 * - start will set the state to PENDING
224 *
225 * READY: PHY is ready to send and receive packets, but the
226 * controller is not. By default, PHYs which do not implement
227 * probe will be set to this state by phy_probe(). If the PHY
228 * driver knows the PHY is ready, and the PHY state is STARTING,
229 * then it sets this STATE.
230 * - start will set the state to UP
231 *
232 * PENDING: PHY device is coming up, but the ethernet driver is
233 * ready. phy_start will set this state if the PHY state is
234 * STARTING.
235 * - PHY driver will set the state to UP when the PHY is ready
236 *
237 * UP: The PHY and attached device are ready to do work.
238 * Interrupts should be started here.
239 * - timer moves to AN
240 *
241 * AN: The PHY is currently negotiating the link state. Link is
242 * therefore down for now. phy_timer will set this state when it
243 * detects the state is UP. config_aneg will set this state
244 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
245 * - If autonegotiation finishes, but there's no link, it sets
246 * the state to NOLINK.
247 * - If aneg finishes with link, it sets the state to RUNNING,
248 * and calls adjust_link
249 * - If autonegotiation did not finish after an arbitrary amount
250 * of time, autonegotiation should be tried again if the PHY
251 * supports "magic" autonegotiation (back to AN)
252 * - If it didn't finish, and no magic_aneg, move to FORCING.
253 *
254 * NOLINK: PHY is up, but not currently plugged in.
255 * - If the timer notes that the link comes back, we move to RUNNING
256 * - config_aneg moves to AN
257 * - phy_stop moves to HALTED
258 *
259 * FORCING: PHY is being configured with forced settings
260 * - if link is up, move to RUNNING
261 * - If link is down, we drop to the next highest setting, and
262 * retry (FORCING) after a timeout
263 * - phy_stop moves to HALTED
264 *
265 * RUNNING: PHY is currently up, running, and possibly sending
266 * and/or receiving packets
267 * - timer will set CHANGELINK if we're polling (this ensures the
268 * link state is polled every other cycle of this state machine,
269 * which makes it every other second)
270 * - irq will set CHANGELINK
271 * - config_aneg will set AN
272 * - phy_stop moves to HALTED
273 *
274 * CHANGELINK: PHY experienced a change in link state
275 * - timer moves to RUNNING if link
276 * - timer moves to NOLINK if the link is down
277 * - phy_stop moves to HALTED
278 *
279 * HALTED: PHY is up, but no polling or interrupts are done. Or
280 * PHY is in an error state.
281 *
282 * - phy_start moves to RESUMING
283 *
284 * RESUMING: PHY was halted, but now wants to run again.
285 * - If we are forcing, or aneg is done, timer moves to RUNNING
286 * - If aneg is not done, timer moves to AN
287 * - phy_stop moves to HALTED
288 */
289enum phy_state {
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300290 PHY_DOWN = 0,
Andy Fleming00db8182005-07-30 19:31:23 -0400291 PHY_STARTING,
292 PHY_READY,
293 PHY_PENDING,
294 PHY_UP,
295 PHY_AN,
296 PHY_RUNNING,
297 PHY_NOLINK,
298 PHY_FORCING,
299 PHY_CHANGELINK,
300 PHY_HALTED,
301 PHY_RESUMING
302};
303
David Daneyac28b9f2012-06-27 07:33:35 +0000304/**
305 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
306 * @devices_in_package: Bit vector of devices present.
307 * @device_ids: The device identifer for each present device.
308 */
309struct phy_c45_device_ids {
310 u32 devices_in_package;
311 u32 device_ids[8];
312};
Richard Cochranc1f19b52010-07-17 08:49:36 +0000313
Andy Fleming00db8182005-07-30 19:31:23 -0400314/* phy_device: An instance of a PHY
315 *
316 * drv: Pointer to the driver for this PHY instance
317 * bus: Pointer to the bus this PHY is on
318 * dev: driver model device structure for this PHY
319 * phy_id: UID for this device found during discovery
David Daneyac28b9f2012-06-27 07:33:35 +0000320 * c45_ids: 802.3-c45 Device Identifers if is_c45.
321 * is_c45: Set to true if this phy uses clause 45 addressing.
Florian Fainelli4284b6a2013-05-23 01:11:12 +0000322 * is_internal: Set to true if this phy is internal to a MAC.
Andy Fleming00db8182005-07-30 19:31:23 -0400323 * state: state of the PHY for management purposes
324 * dev_flags: Device-specific flags used by the PHY driver.
325 * addr: Bus address of PHY
326 * link_timeout: The number of timer firings to wait before the
327 * giving up on the current attempt at acquiring a link
328 * irq: IRQ number of the PHY's interrupt (-1 if none)
329 * phy_timer: The timer for handling the state machine
330 * phy_queue: A work_queue for the interrupt
331 * attached_dev: The attached enet driver's device instance ptr
332 * adjust_link: Callback for the enet controller to respond to
333 * changes in the link state.
Andy Fleming00db8182005-07-30 19:31:23 -0400334 *
Florian Fainelli114002b2013-12-06 13:01:30 -0800335 * speed, duplex, pause, supported, advertising, lp_advertising,
336 * and autoneg are used like in mii_if_info
Andy Fleming00db8182005-07-30 19:31:23 -0400337 *
338 * interrupts currently only supports enabled or disabled,
339 * but could be changed in the future to support enabling
340 * and disabling specific interrupts
341 *
342 * Contains some infrastructure for polling and interrupt
343 * handling, as well as handling shifts in PHY hardware state
344 */
345struct phy_device {
346 /* Information about the PHY type */
347 /* And management functions */
348 struct phy_driver *drv;
349
350 struct mii_bus *bus;
351
352 struct device dev;
353
354 u32 phy_id;
355
David Daneyac28b9f2012-06-27 07:33:35 +0000356 struct phy_c45_device_ids c45_ids;
357 bool is_c45;
Florian Fainelli4284b6a2013-05-23 01:11:12 +0000358 bool is_internal;
Florian Fainellib0ae0092014-02-11 17:27:41 -0800359 bool has_fixups;
David Daneyac28b9f2012-06-27 07:33:35 +0000360
Andy Fleming00db8182005-07-30 19:31:23 -0400361 enum phy_state state;
362
363 u32 dev_flags;
364
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600365 phy_interface_t interface;
366
Peter Meerwaldc6883992010-09-02 04:06:24 +0000367 /* Bus address of the PHY (0-31) */
Andy Fleming00db8182005-07-30 19:31:23 -0400368 int addr;
369
Andy Flemingc5e38a92008-04-09 19:38:27 -0500370 /*
371 * forced speed & duplex (no autoneg)
Andy Fleming00db8182005-07-30 19:31:23 -0400372 * partner speed & duplex & pause (autoneg)
373 */
374 int speed;
375 int duplex;
376 int pause;
377 int asym_pause;
378
379 /* The most recently read link state */
380 int link;
381
382 /* Enabled Interrupts */
383 u32 interrupts;
384
385 /* Union of PHY and Attached devices' supported modes */
386 /* See mii.h for more info */
387 u32 supported;
388 u32 advertising;
Florian Fainelli114002b2013-12-06 13:01:30 -0800389 u32 lp_advertising;
Andy Fleming00db8182005-07-30 19:31:23 -0400390
391 int autoneg;
392
393 int link_timeout;
394
Andy Flemingc5e38a92008-04-09 19:38:27 -0500395 /*
396 * Interrupt number for this PHY
397 * -1 means no interrupt
398 */
Andy Fleming00db8182005-07-30 19:31:23 -0400399 int irq;
400
401 /* private data pointer */
402 /* For use by PHYs to maintain extra state */
403 void *priv;
404
405 /* Interrupt and Polling infrastructure */
406 struct work_struct phy_queue;
Marcin Slusarza390d1f2009-03-13 15:41:19 -0700407 struct delayed_work state_queue;
Maciej W. Rozycki0ac49522007-09-28 22:42:14 -0700408 atomic_t irq_disable;
Andy Fleming00db8182005-07-30 19:31:23 -0400409
Nate Case35b5f6b2008-01-29 10:05:09 -0600410 struct mutex lock;
Andy Fleming00db8182005-07-30 19:31:23 -0400411
412 struct net_device *attached_dev;
413
414 void (*adjust_link)(struct net_device *dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400415};
416#define to_phy_device(d) container_of(d, struct phy_device, dev)
417
418/* struct phy_driver: Driver structure for a particular PHY type
419 *
420 * phy_id: The result of reading the UID registers of this PHY
421 * type, and ANDing them with the phy_id_mask. This driver
422 * only works for PHYs with IDs which match this field
423 * name: The friendly name of this PHY type
424 * phy_id_mask: Defines the important bits of the phy_id
425 * features: A list of features (speed, duplex, etc) supported
426 * by this PHY
427 * flags: A bitfield defining certain other features this PHY
428 * supports (like interrupts)
429 *
430 * The drivers must implement config_aneg and read_status. All
431 * other functions are optional. Note that none of these
432 * functions should be called from interrupt time. The goal is
433 * for the bus read/write functions to be able to block when the
434 * bus transaction is happening, and be freed up by an interrupt
435 * (The MPC85xx has this ability, though it is not currently
436 * supported in the driver).
437 */
438struct phy_driver {
439 u32 phy_id;
440 char *name;
441 unsigned int phy_id_mask;
442 u32 features;
443 u32 flags;
444
Andy Flemingc5e38a92008-04-09 19:38:27 -0500445 /*
Florian Fainelli9df81dd2014-02-17 13:34:03 -0800446 * Called to issue a PHY software reset
447 */
448 int (*soft_reset)(struct phy_device *phydev);
449
450 /*
Andy Flemingc5e38a92008-04-09 19:38:27 -0500451 * Called to initialize the PHY,
452 * including after a reset
453 */
Andy Fleming00db8182005-07-30 19:31:23 -0400454 int (*config_init)(struct phy_device *phydev);
455
Andy Flemingc5e38a92008-04-09 19:38:27 -0500456 /*
457 * Called during discovery. Used to set
458 * up device-specific structures, if any
459 */
Andy Fleming00db8182005-07-30 19:31:23 -0400460 int (*probe)(struct phy_device *phydev);
461
462 /* PHY Power Management */
463 int (*suspend)(struct phy_device *phydev);
464 int (*resume)(struct phy_device *phydev);
465
Andy Flemingc5e38a92008-04-09 19:38:27 -0500466 /*
467 * Configures the advertisement and resets
Andy Fleming00db8182005-07-30 19:31:23 -0400468 * autonegotiation if phydev->autoneg is on,
469 * forces the speed to the current settings in phydev
Andy Flemingc5e38a92008-04-09 19:38:27 -0500470 * if phydev->autoneg is off
471 */
Andy Fleming00db8182005-07-30 19:31:23 -0400472 int (*config_aneg)(struct phy_device *phydev);
473
Florian Fainelli76a423a2014-02-11 17:27:37 -0800474 /* Determines the auto negotiation result */
475 int (*aneg_done)(struct phy_device *phydev);
476
Andy Fleming00db8182005-07-30 19:31:23 -0400477 /* Determines the negotiated speed and duplex */
478 int (*read_status)(struct phy_device *phydev);
479
480 /* Clears any pending interrupts */
481 int (*ack_interrupt)(struct phy_device *phydev);
482
483 /* Enables or disables interrupts */
484 int (*config_intr)(struct phy_device *phydev);
485
Anatolij Gustschina8729eb2009-04-07 02:01:42 +0000486 /*
487 * Checks if the PHY generated an interrupt.
488 * For multi-PHY devices with shared PHY interrupt pin
489 */
490 int (*did_interrupt)(struct phy_device *phydev);
491
Andy Fleming00db8182005-07-30 19:31:23 -0400492 /* Clears up any memory if needed */
493 void (*remove)(struct phy_device *phydev);
494
David Daneya30e2c12012-06-27 07:33:37 +0000495 /* Returns true if this is a suitable driver for the given
496 * phydev. If NULL, matching is based on phy_id and
497 * phy_id_mask.
498 */
499 int (*match_phy_device)(struct phy_device *phydev);
500
Richard Cochranc8f3a8c2012-04-03 22:59:17 +0000501 /* Handles ethtool queries for hardware time stamping. */
502 int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
503
Richard Cochranc1f19b52010-07-17 08:49:36 +0000504 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
505 int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
506
507 /*
508 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
509 * the phy driver promises to deliver it using netif_rx() as
510 * soon as a timestamp becomes available. One of the
511 * PTP_CLASS_ values is passed in 'type'. The function must
512 * return true if the skb is accepted for delivery.
513 */
514 bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
515
516 /*
517 * Requests a Tx timestamp for 'skb'. The phy driver promises
Richard Cochranda92b192011-10-21 00:49:15 +0000518 * to deliver it using skb_complete_tx_timestamp() as soon as a
Richard Cochranc1f19b52010-07-17 08:49:36 +0000519 * timestamp becomes available. One of the PTP_CLASS_ values
520 * is passed in 'type'.
521 */
522 void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
523
Michael Stapelberg42e836e2013-03-11 13:56:44 +0000524 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
525 * enable Wake on LAN, so set_wol is provided to be called in the
526 * ethernet driver's set_wol function. */
527 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
528
529 /* See set_wol, but for checking whether Wake on LAN is enabled. */
530 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
531
Andy Fleming00db8182005-07-30 19:31:23 -0400532 struct device_driver driver;
533};
534#define to_phy_driver(d) container_of(d, struct phy_driver, driver)
535
Andy Flemingf62220d2008-04-18 17:29:54 -0500536#define PHY_ANY_ID "MATCH ANY PHY"
537#define PHY_ANY_UID 0xffffffff
538
539/* A Structure for boards to register fixups with the PHY Lib */
540struct phy_fixup {
541 struct list_head list;
David S. Miller8e401ec2009-05-26 21:16:25 -0700542 char bus_id[20];
Andy Flemingf62220d2008-04-18 17:29:54 -0500543 u32 phy_uid;
544 u32 phy_uid_mask;
545 int (*run)(struct phy_device *phydev);
546};
547
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000548/**
Andy Flemingefabdfb2014-01-10 14:25:09 +0800549 * phy_read_mmd - Convenience function for reading a register
550 * from an MMD on a given PHY.
551 * @phydev: The phy_device struct
552 * @devad: The MMD to read from
553 * @regnum: The register on the MMD to read
554 *
555 * Same rules as for phy_read();
556 */
557static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum)
558{
559 if (!phydev->is_c45)
560 return -EOPNOTSUPP;
561
562 return mdiobus_read(phydev->bus, phydev->addr,
563 MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff));
564}
565
566/**
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000567 * phy_read - Convenience function for reading a given PHY register
568 * @phydev: the phy_device struct
569 * @regnum: register number to read
570 *
571 * NOTE: MUST NOT be called from interrupt context,
572 * because the bus read/write functions may wait for an interrupt
573 * to conclude the operation.
574 */
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000575static inline int phy_read(struct phy_device *phydev, u32 regnum)
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000576{
577 return mdiobus_read(phydev->bus, phydev->addr, regnum);
578}
579
580/**
581 * phy_write - Convenience function for writing a given PHY register
582 * @phydev: the phy_device struct
583 * @regnum: register number to write
584 * @val: value to write to @regnum
585 *
586 * NOTE: MUST NOT be called from interrupt context,
587 * because the bus read/write functions may wait for an interrupt
588 * to conclude the operation.
589 */
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000590static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000591{
592 return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
593}
594
Florian Fainelli2c7b4922013-05-19 22:53:42 +0000595/**
596 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
597 * @phydev: the phy_device struct
598 *
599 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
600 * PHY_IGNORE_INTERRUPT
601 */
602static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
603{
604 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
605}
606
Florian Fainelli4284b6a2013-05-23 01:11:12 +0000607/**
608 * phy_is_internal - Convenience function for testing if a PHY is internal
609 * @phydev: the phy_device struct
610 */
611static inline bool phy_is_internal(struct phy_device *phydev)
612{
613 return phydev->is_internal;
614}
615
Andy Flemingefabdfb2014-01-10 14:25:09 +0800616/**
617 * phy_write_mmd - Convenience function for writing a register
618 * on an MMD on a given PHY.
619 * @phydev: The phy_device struct
620 * @devad: The MMD to read from
621 * @regnum: The register on the MMD to read
622 * @val: value to write to @regnum
623 *
624 * Same rules as for phy_write();
625 */
626static inline int phy_write_mmd(struct phy_device *phydev, int devad,
627 u32 regnum, u16 val)
628{
629 if (!phydev->is_c45)
630 return -EOPNOTSUPP;
631
632 regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
633
634 return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
635}
636
David Daneyac28b9f2012-06-27 07:33:35 +0000637struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300638 bool is_c45,
639 struct phy_c45_device_ids *c45_ids);
David Daneyac28b9f2012-06-27 07:33:35 +0000640struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
Grant Likely4dea5472009-04-25 12:52:46 +0000641int phy_device_register(struct phy_device *phy);
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000642int phy_init_hw(struct phy_device *phydev);
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +0100643int phy_suspend(struct phy_device *phydev);
644int phy_resume(struct phy_device *phydev);
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300645struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
646 phy_interface_t interface);
Jiri Pirkof8f76db2010-02-04 10:23:02 -0800647struct phy_device *phy_find_first(struct mii_bus *bus);
Andy Fleming257184d2014-01-10 14:27:54 +0800648int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
649 u32 flags, phy_interface_t interface);
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000650int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300651 void (*handler)(struct net_device *),
652 phy_interface_t interface);
653struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
654 void (*handler)(struct net_device *),
655 phy_interface_t interface);
Andy Fleminge1393452005-08-24 18:46:21 -0500656void phy_disconnect(struct phy_device *phydev);
657void phy_detach(struct phy_device *phydev);
658void phy_start(struct phy_device *phydev);
659void phy_stop(struct phy_device *phydev);
660int phy_start_aneg(struct phy_device *phydev);
661
Andy Fleminge1393452005-08-24 18:46:21 -0500662int phy_stop_interrupts(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400663
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300664static inline int phy_read_status(struct phy_device *phydev)
665{
Andy Fleming00db8182005-07-30 19:31:23 -0400666 return phydev->drv->read_status(phydev);
667}
668
Daniel Mackaf6b6962014-04-16 17:19:12 +0200669int genphy_config_init(struct phy_device *phydev);
Madalin Bucur3fb69bc2013-11-20 16:38:19 -0600670int genphy_setup_forced(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400671int genphy_restart_aneg(struct phy_device *phydev);
672int genphy_config_aneg(struct phy_device *phydev);
Florian Fainellia9fa6e62014-02-11 17:27:36 -0800673int genphy_aneg_done(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400674int genphy_update_link(struct phy_device *phydev);
675int genphy_read_status(struct phy_device *phydev);
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -0800676int genphy_suspend(struct phy_device *phydev);
677int genphy_resume(struct phy_device *phydev);
Florian Fainelli797ac072014-02-17 13:34:02 -0800678int genphy_soft_reset(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400679void phy_driver_unregister(struct phy_driver *drv);
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +0000680void phy_drivers_unregister(struct phy_driver *drv, int n);
Andy Fleming00db8182005-07-30 19:31:23 -0400681int phy_driver_register(struct phy_driver *new_driver);
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +0000682int phy_drivers_register(struct phy_driver *new_driver, int n);
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000683void phy_state_machine(struct work_struct *work);
Florian Fainelli5ea94e72013-05-19 22:53:43 +0000684void phy_change(struct work_struct *work);
685void phy_mac_interrupt(struct phy_device *phydev, int new_link);
Sergei Shtylyov29935ae2014-01-05 03:27:17 +0300686void phy_start_machine(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400687void phy_stop_machine(struct phy_device *phydev);
688int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
689int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300690int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
Andy Fleminge1393452005-08-24 18:46:21 -0500691int phy_start_interrupts(struct phy_device *phydev);
692void phy_print_status(struct phy_device *phydev);
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300693void phy_device_free(struct phy_device *phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400694
Andy Flemingf62220d2008-04-18 17:29:54 -0500695int phy_register_fixup(const char *bus_id, 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 -0500697int phy_register_fixup_for_id(const char *bus_id,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300698 int (*run)(struct phy_device *));
Andy Flemingf62220d2008-04-18 17:29:54 -0500699int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300700 int (*run)(struct phy_device *));
Andy Flemingf62220d2008-04-18 17:29:54 -0500701
Giuseppe CAVALLAROa59a4d12012-06-27 21:14:38 +0000702int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
703int phy_get_eee_err(struct phy_device *phydev);
704int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
705int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
Michael Stapelberg42e836e2013-03-11 13:56:44 +0000706int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
Sergei Shtylyov4017b4d2014-01-05 03:20:17 +0300707void phy_ethtool_get_wol(struct phy_device *phydev,
708 struct ethtool_wolinfo *wol);
Giuseppe CAVALLAROa59a4d12012-06-27 21:14:38 +0000709
Andy Fleming9b9a8bf2008-05-02 13:00:51 -0500710int __init mdio_bus_init(void);
711void mdio_bus_exit(void);
712
Andy Fleming00db8182005-07-30 19:31:23 -0400713extern struct bus_type mdio_bus_type;
Andy Fleming00db8182005-07-30 19:31:23 -0400714#endif /* __PHY_H */