Commit | Line | Data |
---|---|---|
00db8189 | 1 | /* |
00db8189 AF |
2 | * 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> | |
13df29f6 MR |
20 | #include <linux/ethtool.h> |
21 | #include <linux/mii.h> | |
22 | #include <linux/timer.h> | |
23 | #include <linux/workqueue.h> | |
8626d3b4 | 24 | #include <linux/mod_devicetable.h> |
00db8189 | 25 | |
60063497 | 26 | #include <linux/atomic.h> |
0ac49527 | 27 | |
e9fbdf17 | 28 | #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \ |
00db8189 AF |
29 | SUPPORTED_TP | \ |
30 | SUPPORTED_MII) | |
31 | ||
e9fbdf17 FF |
32 | #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 | \ | |
00db8189 AF |
39 | SUPPORTED_1000baseT_Full) |
40 | ||
e9fbdf17 FF |
41 | #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 | ||
c5e38a94 AF |
49 | /* |
50 | * Set phydev->irq to PHY_POLL if interrupts are not supported, | |
00db8189 AF |
51 | * 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 | |
4284b6a5 | 59 | #define PHY_IS_INTERNAL 0x00000004 |
00db8189 | 60 | |
e8a2b6a4 AF |
61 | /* Interface Mode definitions */ |
62 | typedef enum { | |
4157ef1b | 63 | PHY_INTERFACE_MODE_NA, |
e8a2b6a4 AF |
64 | PHY_INTERFACE_MODE_MII, |
65 | PHY_INTERFACE_MODE_GMII, | |
66 | PHY_INTERFACE_MODE_SGMII, | |
67 | PHY_INTERFACE_MODE_TBI, | |
2cc70ba4 | 68 | PHY_INTERFACE_MODE_REVMII, |
e8a2b6a4 AF |
69 | PHY_INTERFACE_MODE_RMII, |
70 | PHY_INTERFACE_MODE_RGMII, | |
a999589c | 71 | PHY_INTERFACE_MODE_RGMII_ID, |
7d400a4c KP |
72 | PHY_INTERFACE_MODE_RGMII_RXID, |
73 | PHY_INTERFACE_MODE_RGMII_TXID, | |
4157ef1b SG |
74 | PHY_INTERFACE_MODE_RTBI, |
75 | PHY_INTERFACE_MODE_SMII, | |
898dd0bd | 76 | PHY_INTERFACE_MODE_XGMII, |
fd70f72c | 77 | PHY_INTERFACE_MODE_MOCA, |
b9d12085 | 78 | PHY_INTERFACE_MODE_QSGMII, |
8a2fe56e | 79 | PHY_INTERFACE_MODE_MAX, |
e8a2b6a4 AF |
80 | } phy_interface_t; |
81 | ||
8a2fe56e FF |
82 | /** |
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 | */ | |
87 | static 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"; | |
fd70f72c FF |
118 | case PHY_INTERFACE_MODE_MOCA: |
119 | return "moca"; | |
b9d12085 TP |
120 | case PHY_INTERFACE_MODE_QSGMII: |
121 | return "qsgmii"; | |
8a2fe56e FF |
122 | default: |
123 | return "unknown"; | |
124 | } | |
125 | } | |
126 | ||
00db8189 | 127 | |
e8a2b6a4 | 128 | #define PHY_INIT_TIMEOUT 100000 |
00db8189 AF |
129 | #define PHY_STATE_TIME 1 |
130 | #define PHY_FORCE_TIMEOUT 10 | |
131 | #define PHY_AN_TIMEOUT 10 | |
132 | ||
e8a2b6a4 | 133 | #define PHY_MAX_ADDR 32 |
00db8189 | 134 | |
a4d00f17 | 135 | /* Used when trying to connect to a specific phy (mii bus id:phy device id) */ |
9d9326d3 AF |
136 | #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 | */ | |
8e401ecc | 142 | #define MII_BUS_ID_SIZE (20 - 3) |
a4d00f17 | 143 | |
abf35df2 JG |
144 | /* 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 | ||
313162d0 PG |
148 | struct device; |
149 | struct sk_buff; | |
150 | ||
c5e38a94 AF |
151 | /* |
152 | * The Bus class for PHYs. Devices which provide access to | |
153 | * PHYs should register using this structure | |
154 | */ | |
00db8189 AF |
155 | struct mii_bus { |
156 | const char *name; | |
9d9326d3 | 157 | char id[MII_BUS_ID_SIZE]; |
00db8189 AF |
158 | 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 | ||
c5e38a94 AF |
163 | /* |
164 | * A lock to ensure that only one thing can read/write | |
165 | * the MDIO bus at a time | |
166 | */ | |
35b5f6b1 | 167 | struct mutex mdio_lock; |
00db8189 | 168 | |
18ee49dd | 169 | struct device *parent; |
46abc021 LB |
170 | enum { |
171 | MDIOBUS_ALLOCATED = 1, | |
172 | MDIOBUS_REGISTERED, | |
173 | MDIOBUS_UNREGISTERED, | |
174 | MDIOBUS_RELEASED, | |
175 | } state; | |
176 | struct device dev; | |
00db8189 AF |
177 | |
178 | /* list of all PHYs on bus */ | |
179 | struct phy_device *phy_map[PHY_MAX_ADDR]; | |
180 | ||
c6883996 | 181 | /* PHY addresses to be ignored when probing */ |
f896424c MP |
182 | u32 phy_mask; |
183 | ||
922f2dd1 FF |
184 | /* PHY addresses to ignore the TA/read failure */ |
185 | u32 phy_ignore_ta_mask; | |
186 | ||
c5e38a94 AF |
187 | /* |
188 | * Pointer to an array of interrupts, each PHY's | |
189 | * interrupt at the index matching its address | |
190 | */ | |
00db8189 AF |
191 | int *irq; |
192 | }; | |
46abc021 | 193 | #define to_mii_bus(d) container_of(d, struct mii_bus, dev) |
00db8189 | 194 | |
eb8a54a7 TT |
195 | struct mii_bus *mdiobus_alloc_size(size_t); |
196 | static inline struct mii_bus *mdiobus_alloc(void) | |
197 | { | |
198 | return mdiobus_alloc_size(0); | |
199 | } | |
200 | ||
2e888103 LB |
201 | int mdiobus_register(struct mii_bus *bus); |
202 | void mdiobus_unregister(struct mii_bus *bus); | |
203 | void mdiobus_free(struct mii_bus *bus); | |
6d48f44b GS |
204 | struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv); |
205 | static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev) | |
206 | { | |
207 | return devm_mdiobus_alloc_size(dev, 0); | |
208 | } | |
209 | ||
210 | void devm_mdiobus_free(struct device *dev, struct mii_bus *bus); | |
2e888103 | 211 | struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr); |
abf35df2 JG |
212 | int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum); |
213 | int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val); | |
2e888103 LB |
214 | |
215 | ||
e8a2b6a4 AF |
216 | #define PHY_INTERRUPT_DISABLED 0x0 |
217 | #define PHY_INTERRUPT_ENABLED 0x80000000 | |
00db8189 AF |
218 | |
219 | /* PHY state machine states: | |
220 | * | |
221 | * DOWN: PHY device and driver are not ready for anything. probe | |
222 | * should be called if and only if the PHY is in this state, | |
223 | * given that the PHY device exists. | |
224 | * - PHY driver probe function will, depending on the PHY, set | |
225 | * the state to STARTING or READY | |
226 | * | |
227 | * STARTING: PHY device is coming up, and the ethernet driver is | |
228 | * not ready. PHY drivers may set this in the probe function. | |
229 | * If they do, they are responsible for making sure the state is | |
230 | * eventually set to indicate whether the PHY is UP or READY, | |
231 | * depending on the state when the PHY is done starting up. | |
232 | * - PHY driver will set the state to READY | |
233 | * - start will set the state to PENDING | |
234 | * | |
235 | * READY: PHY is ready to send and receive packets, but the | |
236 | * controller is not. By default, PHYs which do not implement | |
237 | * probe will be set to this state by phy_probe(). If the PHY | |
238 | * driver knows the PHY is ready, and the PHY state is STARTING, | |
239 | * then it sets this STATE. | |
240 | * - start will set the state to UP | |
241 | * | |
242 | * PENDING: PHY device is coming up, but the ethernet driver is | |
243 | * ready. phy_start will set this state if the PHY state is | |
244 | * STARTING. | |
245 | * - PHY driver will set the state to UP when the PHY is ready | |
246 | * | |
247 | * UP: The PHY and attached device are ready to do work. | |
248 | * Interrupts should be started here. | |
249 | * - timer moves to AN | |
250 | * | |
251 | * AN: The PHY is currently negotiating the link state. Link is | |
252 | * therefore down for now. phy_timer will set this state when it | |
253 | * detects the state is UP. config_aneg will set this state | |
254 | * whenever called with phydev->autoneg set to AUTONEG_ENABLE. | |
255 | * - If autonegotiation finishes, but there's no link, it sets | |
256 | * the state to NOLINK. | |
257 | * - If aneg finishes with link, it sets the state to RUNNING, | |
258 | * and calls adjust_link | |
259 | * - If autonegotiation did not finish after an arbitrary amount | |
260 | * of time, autonegotiation should be tried again if the PHY | |
261 | * supports "magic" autonegotiation (back to AN) | |
262 | * - If it didn't finish, and no magic_aneg, move to FORCING. | |
263 | * | |
264 | * NOLINK: PHY is up, but not currently plugged in. | |
265 | * - If the timer notes that the link comes back, we move to RUNNING | |
266 | * - config_aneg moves to AN | |
267 | * - phy_stop moves to HALTED | |
268 | * | |
269 | * FORCING: PHY is being configured with forced settings | |
270 | * - if link is up, move to RUNNING | |
271 | * - If link is down, we drop to the next highest setting, and | |
272 | * retry (FORCING) after a timeout | |
273 | * - phy_stop moves to HALTED | |
274 | * | |
275 | * RUNNING: PHY is currently up, running, and possibly sending | |
276 | * and/or receiving packets | |
277 | * - timer will set CHANGELINK if we're polling (this ensures the | |
278 | * link state is polled every other cycle of this state machine, | |
279 | * which makes it every other second) | |
280 | * - irq will set CHANGELINK | |
281 | * - config_aneg will set AN | |
282 | * - phy_stop moves to HALTED | |
283 | * | |
284 | * CHANGELINK: PHY experienced a change in link state | |
285 | * - timer moves to RUNNING if link | |
286 | * - timer moves to NOLINK if the link is down | |
287 | * - phy_stop moves to HALTED | |
288 | * | |
289 | * HALTED: PHY is up, but no polling or interrupts are done. Or | |
290 | * PHY is in an error state. | |
291 | * | |
292 | * - phy_start moves to RESUMING | |
293 | * | |
294 | * RESUMING: PHY was halted, but now wants to run again. | |
295 | * - If we are forcing, or aneg is done, timer moves to RUNNING | |
296 | * - If aneg is not done, timer moves to AN | |
297 | * - phy_stop moves to HALTED | |
298 | */ | |
299 | enum phy_state { | |
4017b4d3 | 300 | PHY_DOWN = 0, |
00db8189 AF |
301 | PHY_STARTING, |
302 | PHY_READY, | |
303 | PHY_PENDING, | |
304 | PHY_UP, | |
305 | PHY_AN, | |
306 | PHY_RUNNING, | |
307 | PHY_NOLINK, | |
308 | PHY_FORCING, | |
309 | PHY_CHANGELINK, | |
310 | PHY_HALTED, | |
311 | PHY_RESUMING | |
312 | }; | |
313 | ||
ac28b9f8 DD |
314 | /** |
315 | * struct phy_c45_device_ids - 802.3-c45 Device Identifiers | |
316 | * @devices_in_package: Bit vector of devices present. | |
317 | * @device_ids: The device identifer for each present device. | |
318 | */ | |
319 | struct phy_c45_device_ids { | |
320 | u32 devices_in_package; | |
321 | u32 device_ids[8]; | |
322 | }; | |
c1f19b51 | 323 | |
00db8189 AF |
324 | /* phy_device: An instance of a PHY |
325 | * | |
326 | * drv: Pointer to the driver for this PHY instance | |
327 | * bus: Pointer to the bus this PHY is on | |
328 | * dev: driver model device structure for this PHY | |
329 | * phy_id: UID for this device found during discovery | |
ac28b9f8 DD |
330 | * c45_ids: 802.3-c45 Device Identifers if is_c45. |
331 | * is_c45: Set to true if this phy uses clause 45 addressing. | |
4284b6a5 | 332 | * is_internal: Set to true if this phy is internal to a MAC. |
aae88261 | 333 | * has_fixups: Set to true if this phy has fixups/quirks. |
8a477a6f | 334 | * suspended: Set to true if this phy has been suspended successfully. |
00db8189 AF |
335 | * state: state of the PHY for management purposes |
336 | * dev_flags: Device-specific flags used by the PHY driver. | |
337 | * addr: Bus address of PHY | |
338 | * link_timeout: The number of timer firings to wait before the | |
339 | * giving up on the current attempt at acquiring a link | |
340 | * irq: IRQ number of the PHY's interrupt (-1 if none) | |
341 | * phy_timer: The timer for handling the state machine | |
342 | * phy_queue: A work_queue for the interrupt | |
343 | * attached_dev: The attached enet driver's device instance ptr | |
344 | * adjust_link: Callback for the enet controller to respond to | |
345 | * changes in the link state. | |
00db8189 | 346 | * |
114002bc FF |
347 | * speed, duplex, pause, supported, advertising, lp_advertising, |
348 | * and autoneg are used like in mii_if_info | |
00db8189 AF |
349 | * |
350 | * interrupts currently only supports enabled or disabled, | |
351 | * but could be changed in the future to support enabling | |
352 | * and disabling specific interrupts | |
353 | * | |
354 | * Contains some infrastructure for polling and interrupt | |
355 | * handling, as well as handling shifts in PHY hardware state | |
356 | */ | |
357 | struct phy_device { | |
358 | /* Information about the PHY type */ | |
359 | /* And management functions */ | |
360 | struct phy_driver *drv; | |
361 | ||
362 | struct mii_bus *bus; | |
363 | ||
364 | struct device dev; | |
365 | ||
366 | u32 phy_id; | |
367 | ||
ac28b9f8 DD |
368 | struct phy_c45_device_ids c45_ids; |
369 | bool is_c45; | |
4284b6a5 | 370 | bool is_internal; |
b0ae009f | 371 | bool has_fixups; |
8a477a6f | 372 | bool suspended; |
ac28b9f8 | 373 | |
00db8189 AF |
374 | enum phy_state state; |
375 | ||
376 | u32 dev_flags; | |
377 | ||
e8a2b6a4 AF |
378 | phy_interface_t interface; |
379 | ||
c6883996 | 380 | /* Bus address of the PHY (0-31) */ |
00db8189 AF |
381 | int addr; |
382 | ||
c5e38a94 AF |
383 | /* |
384 | * forced speed & duplex (no autoneg) | |
00db8189 AF |
385 | * partner speed & duplex & pause (autoneg) |
386 | */ | |
387 | int speed; | |
388 | int duplex; | |
389 | int pause; | |
390 | int asym_pause; | |
391 | ||
392 | /* The most recently read link state */ | |
393 | int link; | |
394 | ||
395 | /* Enabled Interrupts */ | |
396 | u32 interrupts; | |
397 | ||
398 | /* Union of PHY and Attached devices' supported modes */ | |
399 | /* See mii.h for more info */ | |
400 | u32 supported; | |
401 | u32 advertising; | |
114002bc | 402 | u32 lp_advertising; |
00db8189 AF |
403 | |
404 | int autoneg; | |
405 | ||
406 | int link_timeout; | |
407 | ||
c5e38a94 AF |
408 | /* |
409 | * Interrupt number for this PHY | |
410 | * -1 means no interrupt | |
411 | */ | |
00db8189 AF |
412 | int irq; |
413 | ||
414 | /* private data pointer */ | |
415 | /* For use by PHYs to maintain extra state */ | |
416 | void *priv; | |
417 | ||
418 | /* Interrupt and Polling infrastructure */ | |
419 | struct work_struct phy_queue; | |
a390d1f3 | 420 | struct delayed_work state_queue; |
0ac49527 | 421 | atomic_t irq_disable; |
00db8189 | 422 | |
35b5f6b1 | 423 | struct mutex lock; |
00db8189 AF |
424 | |
425 | struct net_device *attached_dev; | |
426 | ||
427 | void (*adjust_link)(struct net_device *dev); | |
00db8189 AF |
428 | }; |
429 | #define to_phy_device(d) container_of(d, struct phy_device, dev) | |
430 | ||
431 | /* struct phy_driver: Driver structure for a particular PHY type | |
432 | * | |
433 | * phy_id: The result of reading the UID registers of this PHY | |
434 | * type, and ANDing them with the phy_id_mask. This driver | |
435 | * only works for PHYs with IDs which match this field | |
436 | * name: The friendly name of this PHY type | |
437 | * phy_id_mask: Defines the important bits of the phy_id | |
438 | * features: A list of features (speed, duplex, etc) supported | |
439 | * by this PHY | |
440 | * flags: A bitfield defining certain other features this PHY | |
441 | * supports (like interrupts) | |
860f6e9e | 442 | * driver_data: static driver data |
00db8189 AF |
443 | * |
444 | * The drivers must implement config_aneg and read_status. All | |
445 | * other functions are optional. Note that none of these | |
446 | * functions should be called from interrupt time. The goal is | |
447 | * for the bus read/write functions to be able to block when the | |
448 | * bus transaction is happening, and be freed up by an interrupt | |
449 | * (The MPC85xx has this ability, though it is not currently | |
450 | * supported in the driver). | |
451 | */ | |
452 | struct phy_driver { | |
453 | u32 phy_id; | |
454 | char *name; | |
455 | unsigned int phy_id_mask; | |
456 | u32 features; | |
457 | u32 flags; | |
860f6e9e | 458 | const void *driver_data; |
00db8189 | 459 | |
c5e38a94 | 460 | /* |
9df81dd7 FF |
461 | * Called to issue a PHY software reset |
462 | */ | |
463 | int (*soft_reset)(struct phy_device *phydev); | |
464 | ||
465 | /* | |
c5e38a94 AF |
466 | * Called to initialize the PHY, |
467 | * including after a reset | |
468 | */ | |
00db8189 AF |
469 | int (*config_init)(struct phy_device *phydev); |
470 | ||
c5e38a94 AF |
471 | /* |
472 | * Called during discovery. Used to set | |
473 | * up device-specific structures, if any | |
474 | */ | |
00db8189 AF |
475 | int (*probe)(struct phy_device *phydev); |
476 | ||
477 | /* PHY Power Management */ | |
478 | int (*suspend)(struct phy_device *phydev); | |
479 | int (*resume)(struct phy_device *phydev); | |
480 | ||
c5e38a94 AF |
481 | /* |
482 | * Configures the advertisement and resets | |
00db8189 AF |
483 | * autonegotiation if phydev->autoneg is on, |
484 | * forces the speed to the current settings in phydev | |
c5e38a94 AF |
485 | * if phydev->autoneg is off |
486 | */ | |
00db8189 AF |
487 | int (*config_aneg)(struct phy_device *phydev); |
488 | ||
76a423a3 FF |
489 | /* Determines the auto negotiation result */ |
490 | int (*aneg_done)(struct phy_device *phydev); | |
491 | ||
00db8189 AF |
492 | /* Determines the negotiated speed and duplex */ |
493 | int (*read_status)(struct phy_device *phydev); | |
494 | ||
495 | /* Clears any pending interrupts */ | |
496 | int (*ack_interrupt)(struct phy_device *phydev); | |
497 | ||
498 | /* Enables or disables interrupts */ | |
499 | int (*config_intr)(struct phy_device *phydev); | |
500 | ||
a8729eb3 AG |
501 | /* |
502 | * Checks if the PHY generated an interrupt. | |
503 | * For multi-PHY devices with shared PHY interrupt pin | |
504 | */ | |
505 | int (*did_interrupt)(struct phy_device *phydev); | |
506 | ||
00db8189 AF |
507 | /* Clears up any memory if needed */ |
508 | void (*remove)(struct phy_device *phydev); | |
509 | ||
a30e2c18 DD |
510 | /* Returns true if this is a suitable driver for the given |
511 | * phydev. If NULL, matching is based on phy_id and | |
512 | * phy_id_mask. | |
513 | */ | |
514 | int (*match_phy_device)(struct phy_device *phydev); | |
515 | ||
c8f3a8c3 RC |
516 | /* Handles ethtool queries for hardware time stamping. */ |
517 | int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti); | |
518 | ||
c1f19b51 RC |
519 | /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */ |
520 | int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr); | |
521 | ||
522 | /* | |
523 | * Requests a Rx timestamp for 'skb'. If the skb is accepted, | |
524 | * the phy driver promises to deliver it using netif_rx() as | |
525 | * soon as a timestamp becomes available. One of the | |
526 | * PTP_CLASS_ values is passed in 'type'. The function must | |
527 | * return true if the skb is accepted for delivery. | |
528 | */ | |
529 | bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); | |
530 | ||
531 | /* | |
532 | * Requests a Tx timestamp for 'skb'. The phy driver promises | |
da92b194 | 533 | * to deliver it using skb_complete_tx_timestamp() as soon as a |
c1f19b51 RC |
534 | * timestamp becomes available. One of the PTP_CLASS_ values |
535 | * is passed in 'type'. | |
536 | */ | |
537 | void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); | |
538 | ||
42e836eb MS |
539 | /* Some devices (e.g. qnap TS-119P II) require PHY register changes to |
540 | * enable Wake on LAN, so set_wol is provided to be called in the | |
541 | * ethernet driver's set_wol function. */ | |
542 | int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); | |
543 | ||
544 | /* See set_wol, but for checking whether Wake on LAN is enabled. */ | |
545 | void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); | |
546 | ||
2b8f2a28 DM |
547 | /* |
548 | * Called to inform a PHY device driver when the core is about to | |
549 | * change the link state. This callback is supposed to be used as | |
550 | * fixup hook for drivers that need to take action when the link | |
551 | * state changes. Drivers are by no means allowed to mess with the | |
552 | * PHY device structure in their implementations. | |
553 | */ | |
554 | void (*link_change_notify)(struct phy_device *dev); | |
555 | ||
0c1d77df VB |
556 | /* A function provided by a phy specific driver to override the |
557 | * the PHY driver framework support for reading a MMD register | |
558 | * from the PHY. If not supported, return -1. This function is | |
559 | * optional for PHY specific drivers, if not provided then the | |
560 | * default MMD read function is used by the PHY framework. | |
561 | */ | |
562 | int (*read_mmd_indirect)(struct phy_device *dev, int ptrad, | |
563 | int devnum, int regnum); | |
564 | ||
565 | /* A function provided by a phy specific driver to override the | |
566 | * the PHY driver framework support for writing a MMD register | |
567 | * from the PHY. This function is optional for PHY specific drivers, | |
568 | * if not provided then the default MMD read function is used by | |
569 | * the PHY framework. | |
570 | */ | |
571 | void (*write_mmd_indirect)(struct phy_device *dev, int ptrad, | |
572 | int devnum, int regnum, u32 val); | |
573 | ||
2f438366 ES |
574 | /* Get the size and type of the eeprom contained within a plug-in |
575 | * module */ | |
576 | int (*module_info)(struct phy_device *dev, | |
577 | struct ethtool_modinfo *modinfo); | |
578 | ||
579 | /* Get the eeprom information from the plug-in module */ | |
580 | int (*module_eeprom)(struct phy_device *dev, | |
581 | struct ethtool_eeprom *ee, u8 *data); | |
582 | ||
00db8189 AF |
583 | struct device_driver driver; |
584 | }; | |
585 | #define to_phy_driver(d) container_of(d, struct phy_driver, driver) | |
586 | ||
f62220d3 AF |
587 | #define PHY_ANY_ID "MATCH ANY PHY" |
588 | #define PHY_ANY_UID 0xffffffff | |
589 | ||
590 | /* A Structure for boards to register fixups with the PHY Lib */ | |
591 | struct phy_fixup { | |
592 | struct list_head list; | |
8e401ecc | 593 | char bus_id[20]; |
f62220d3 AF |
594 | u32 phy_uid; |
595 | u32 phy_uid_mask; | |
596 | int (*run)(struct phy_device *phydev); | |
597 | }; | |
598 | ||
efabdfb9 AF |
599 | /** |
600 | * phy_read_mmd - Convenience function for reading a register | |
601 | * from an MMD on a given PHY. | |
602 | * @phydev: The phy_device struct | |
603 | * @devad: The MMD to read from | |
604 | * @regnum: The register on the MMD to read | |
605 | * | |
606 | * Same rules as for phy_read(); | |
607 | */ | |
608 | static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum) | |
609 | { | |
610 | if (!phydev->is_c45) | |
611 | return -EOPNOTSUPP; | |
612 | ||
613 | return mdiobus_read(phydev->bus, phydev->addr, | |
614 | MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff)); | |
615 | } | |
616 | ||
66ce7fb9 FF |
617 | /** |
618 | * phy_read_mmd_indirect - reads data from the MMD registers | |
619 | * @phydev: The PHY device bus | |
620 | * @prtad: MMD Address | |
621 | * @devad: MMD DEVAD | |
622 | * @addr: PHY address on the MII bus | |
623 | * | |
624 | * Description: it reads data from the MMD registers (clause 22 to access to | |
625 | * clause 45) of the specified phy address. | |
626 | */ | |
627 | int phy_read_mmd_indirect(struct phy_device *phydev, int prtad, | |
628 | int devad, int addr); | |
629 | ||
2e888103 LB |
630 | /** |
631 | * phy_read - Convenience function for reading a given PHY register | |
632 | * @phydev: the phy_device struct | |
633 | * @regnum: register number to read | |
634 | * | |
635 | * NOTE: MUST NOT be called from interrupt context, | |
636 | * because the bus read/write functions may wait for an interrupt | |
637 | * to conclude the operation. | |
638 | */ | |
abf35df2 | 639 | static inline int phy_read(struct phy_device *phydev, u32 regnum) |
2e888103 LB |
640 | { |
641 | return mdiobus_read(phydev->bus, phydev->addr, regnum); | |
642 | } | |
643 | ||
644 | /** | |
645 | * phy_write - Convenience function for writing a given PHY register | |
646 | * @phydev: the phy_device struct | |
647 | * @regnum: register number to write | |
648 | * @val: value to write to @regnum | |
649 | * | |
650 | * NOTE: MUST NOT be called from interrupt context, | |
651 | * because the bus read/write functions may wait for an interrupt | |
652 | * to conclude the operation. | |
653 | */ | |
abf35df2 | 654 | static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) |
2e888103 LB |
655 | { |
656 | return mdiobus_write(phydev->bus, phydev->addr, regnum, val); | |
657 | } | |
658 | ||
2c7b4921 FF |
659 | /** |
660 | * phy_interrupt_is_valid - Convenience function for testing a given PHY irq | |
661 | * @phydev: the phy_device struct | |
662 | * | |
663 | * NOTE: must be kept in sync with addition/removal of PHY_POLL and | |
664 | * PHY_IGNORE_INTERRUPT | |
665 | */ | |
666 | static inline bool phy_interrupt_is_valid(struct phy_device *phydev) | |
667 | { | |
668 | return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT; | |
669 | } | |
670 | ||
4284b6a5 FF |
671 | /** |
672 | * phy_is_internal - Convenience function for testing if a PHY is internal | |
673 | * @phydev: the phy_device struct | |
674 | */ | |
675 | static inline bool phy_is_internal(struct phy_device *phydev) | |
676 | { | |
677 | return phydev->is_internal; | |
678 | } | |
679 | ||
e463d88c FF |
680 | /** |
681 | * phy_interface_is_rgmii - Convenience function for testing if a PHY interface | |
682 | * is RGMII (all variants) | |
683 | * @phydev: the phy_device struct | |
684 | */ | |
685 | static inline bool phy_interface_is_rgmii(struct phy_device *phydev) | |
686 | { | |
687 | return phydev->interface >= PHY_INTERFACE_MODE_RGMII && | |
688 | phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID; | |
689 | } | |
690 | ||
efabdfb9 AF |
691 | /** |
692 | * phy_write_mmd - Convenience function for writing a register | |
693 | * on an MMD on a given PHY. | |
694 | * @phydev: The phy_device struct | |
695 | * @devad: The MMD to read from | |
696 | * @regnum: The register on the MMD to read | |
697 | * @val: value to write to @regnum | |
698 | * | |
699 | * Same rules as for phy_write(); | |
700 | */ | |
701 | static inline int phy_write_mmd(struct phy_device *phydev, int devad, | |
702 | u32 regnum, u16 val) | |
703 | { | |
704 | if (!phydev->is_c45) | |
705 | return -EOPNOTSUPP; | |
706 | ||
707 | regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff); | |
708 | ||
709 | return mdiobus_write(phydev->bus, phydev->addr, regnum, val); | |
710 | } | |
711 | ||
66ce7fb9 FF |
712 | /** |
713 | * phy_write_mmd_indirect - writes data to the MMD registers | |
714 | * @phydev: The PHY device | |
715 | * @prtad: MMD Address | |
716 | * @devad: MMD DEVAD | |
717 | * @addr: PHY address on the MII bus | |
718 | * @data: data to write in the MMD register | |
719 | * | |
720 | * Description: Write data from the MMD registers of the specified | |
721 | * phy address. | |
722 | */ | |
723 | void phy_write_mmd_indirect(struct phy_device *phydev, int prtad, | |
724 | int devad, int addr, u32 data); | |
725 | ||
ac28b9f8 | 726 | struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id, |
4017b4d3 SS |
727 | bool is_c45, |
728 | struct phy_c45_device_ids *c45_ids); | |
ac28b9f8 | 729 | struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); |
4dea547f | 730 | int phy_device_register(struct phy_device *phy); |
2f5cb434 | 731 | int phy_init_hw(struct phy_device *phydev); |
481b5d93 SH |
732 | int phy_suspend(struct phy_device *phydev); |
733 | int phy_resume(struct phy_device *phydev); | |
4017b4d3 SS |
734 | struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, |
735 | phy_interface_t interface); | |
f8f76db1 | 736 | struct phy_device *phy_find_first(struct mii_bus *bus); |
257184d7 AF |
737 | int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, |
738 | u32 flags, phy_interface_t interface); | |
fa94f6d9 | 739 | int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, |
4017b4d3 SS |
740 | void (*handler)(struct net_device *), |
741 | phy_interface_t interface); | |
742 | struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, | |
743 | void (*handler)(struct net_device *), | |
744 | phy_interface_t interface); | |
e1393456 AF |
745 | void phy_disconnect(struct phy_device *phydev); |
746 | void phy_detach(struct phy_device *phydev); | |
747 | void phy_start(struct phy_device *phydev); | |
748 | void phy_stop(struct phy_device *phydev); | |
749 | int phy_start_aneg(struct phy_device *phydev); | |
750 | ||
e1393456 | 751 | int phy_stop_interrupts(struct phy_device *phydev); |
00db8189 | 752 | |
4017b4d3 SS |
753 | static inline int phy_read_status(struct phy_device *phydev) |
754 | { | |
00db8189 AF |
755 | return phydev->drv->read_status(phydev); |
756 | } | |
757 | ||
af6b6967 | 758 | int genphy_config_init(struct phy_device *phydev); |
3fb69bca | 759 | int genphy_setup_forced(struct phy_device *phydev); |
00db8189 AF |
760 | int genphy_restart_aneg(struct phy_device *phydev); |
761 | int genphy_config_aneg(struct phy_device *phydev); | |
a9fa6e6a | 762 | int genphy_aneg_done(struct phy_device *phydev); |
00db8189 AF |
763 | int genphy_update_link(struct phy_device *phydev); |
764 | int genphy_read_status(struct phy_device *phydev); | |
0f0ca340 GC |
765 | int genphy_suspend(struct phy_device *phydev); |
766 | int genphy_resume(struct phy_device *phydev); | |
797ac071 | 767 | int genphy_soft_reset(struct phy_device *phydev); |
00db8189 | 768 | void phy_driver_unregister(struct phy_driver *drv); |
d5bf9071 | 769 | void phy_drivers_unregister(struct phy_driver *drv, int n); |
00db8189 | 770 | int phy_driver_register(struct phy_driver *new_driver); |
d5bf9071 | 771 | int phy_drivers_register(struct phy_driver *new_driver, int n); |
4f9c85a1 | 772 | void phy_state_machine(struct work_struct *work); |
5ea94e76 FF |
773 | void phy_change(struct work_struct *work); |
774 | void phy_mac_interrupt(struct phy_device *phydev, int new_link); | |
29935aeb | 775 | void phy_start_machine(struct phy_device *phydev); |
00db8189 AF |
776 | void phy_stop_machine(struct phy_device *phydev); |
777 | int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd); | |
778 | int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd); | |
4017b4d3 | 779 | int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); |
e1393456 AF |
780 | int phy_start_interrupts(struct phy_device *phydev); |
781 | void phy_print_status(struct phy_device *phydev); | |
6f4a7f41 | 782 | void phy_device_free(struct phy_device *phydev); |
00db8189 | 783 | |
f62220d3 | 784 | int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, |
4017b4d3 | 785 | int (*run)(struct phy_device *)); |
f62220d3 | 786 | int phy_register_fixup_for_id(const char *bus_id, |
4017b4d3 | 787 | int (*run)(struct phy_device *)); |
f62220d3 | 788 | int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, |
4017b4d3 | 789 | int (*run)(struct phy_device *)); |
f62220d3 | 790 | |
a59a4d19 GC |
791 | int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); |
792 | int phy_get_eee_err(struct phy_device *phydev); | |
793 | int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); | |
794 | int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); | |
42e836eb | 795 | int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); |
4017b4d3 SS |
796 | void phy_ethtool_get_wol(struct phy_device *phydev, |
797 | struct ethtool_wolinfo *wol); | |
a59a4d19 | 798 | |
9b9a8bfc AF |
799 | int __init mdio_bus_init(void); |
800 | void mdio_bus_exit(void); | |
801 | ||
00db8189 | 802 | extern struct bus_type mdio_bus_type; |
c31accd1 JH |
803 | |
804 | /** | |
805 | * module_phy_driver() - Helper macro for registering PHY drivers | |
806 | * @__phy_drivers: array of PHY drivers to register | |
807 | * | |
808 | * Helper macro for PHY drivers which do not do anything special in module | |
809 | * init/exit. Each module may only use this macro once, and calling it | |
810 | * replaces module_init() and module_exit(). | |
811 | */ | |
812 | #define phy_module_driver(__phy_drivers, __count) \ | |
813 | static int __init phy_module_init(void) \ | |
814 | { \ | |
815 | return phy_drivers_register(__phy_drivers, __count); \ | |
816 | } \ | |
817 | module_init(phy_module_init); \ | |
818 | static void __exit phy_module_exit(void) \ | |
819 | { \ | |
820 | phy_drivers_unregister(__phy_drivers, __count); \ | |
821 | } \ | |
822 | module_exit(phy_module_exit) | |
823 | ||
824 | #define module_phy_driver(__phy_drivers) \ | |
825 | phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) | |
826 | ||
00db8189 | 827 | #endif /* __PHY_H */ |