]>
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 | ||
2220943a | 19 | #include <linux/compiler.h> |
00db8189 | 20 | #include <linux/spinlock.h> |
13df29f6 | 21 | #include <linux/ethtool.h> |
bac83c65 | 22 | #include <linux/mdio.h> |
13df29f6 | 23 | #include <linux/mii.h> |
3e3aaf64 | 24 | #include <linux/module.h> |
13df29f6 MR |
25 | #include <linux/timer.h> |
26 | #include <linux/workqueue.h> | |
8626d3b4 | 27 | #include <linux/mod_devicetable.h> |
00db8189 | 28 | |
60063497 | 29 | #include <linux/atomic.h> |
0ac49527 | 30 | |
e9fbdf17 | 31 | #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \ |
00db8189 AF |
32 | SUPPORTED_TP | \ |
33 | SUPPORTED_MII) | |
34 | ||
e9fbdf17 FF |
35 | #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \ |
36 | SUPPORTED_10baseT_Full) | |
37 | ||
38 | #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \ | |
39 | SUPPORTED_100baseT_Full) | |
40 | ||
41 | #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \ | |
00db8189 AF |
42 | SUPPORTED_1000baseT_Full) |
43 | ||
e9fbdf17 FF |
44 | #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \ |
45 | PHY_100BT_FEATURES | \ | |
46 | PHY_DEFAULT_FEATURES) | |
47 | ||
48 | #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \ | |
49 | PHY_1000BT_FEATURES) | |
50 | ||
51 | ||
c5e38a94 AF |
52 | /* |
53 | * Set phydev->irq to PHY_POLL if interrupts are not supported, | |
00db8189 AF |
54 | * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if |
55 | * the attached driver handles the interrupt | |
56 | */ | |
57 | #define PHY_POLL -1 | |
58 | #define PHY_IGNORE_INTERRUPT -2 | |
59 | ||
60 | #define PHY_HAS_INTERRUPT 0x00000001 | |
1b86f702 | 61 | #define PHY_IS_INTERNAL 0x00000002 |
a9668491 | 62 | #define PHY_RST_AFTER_CLK_EN 0x00000004 |
a9049e0c | 63 | #define MDIO_DEVICE_IS_PHY 0x80000000 |
00db8189 | 64 | |
e8a2b6a4 AF |
65 | /* Interface Mode definitions */ |
66 | typedef enum { | |
4157ef1b | 67 | PHY_INTERFACE_MODE_NA, |
735d8a18 | 68 | PHY_INTERFACE_MODE_INTERNAL, |
e8a2b6a4 AF |
69 | PHY_INTERFACE_MODE_MII, |
70 | PHY_INTERFACE_MODE_GMII, | |
71 | PHY_INTERFACE_MODE_SGMII, | |
72 | PHY_INTERFACE_MODE_TBI, | |
2cc70ba4 | 73 | PHY_INTERFACE_MODE_REVMII, |
e8a2b6a4 AF |
74 | PHY_INTERFACE_MODE_RMII, |
75 | PHY_INTERFACE_MODE_RGMII, | |
a999589c | 76 | PHY_INTERFACE_MODE_RGMII_ID, |
7d400a4c KP |
77 | PHY_INTERFACE_MODE_RGMII_RXID, |
78 | PHY_INTERFACE_MODE_RGMII_TXID, | |
4157ef1b SG |
79 | PHY_INTERFACE_MODE_RTBI, |
80 | PHY_INTERFACE_MODE_SMII, | |
898dd0bd | 81 | PHY_INTERFACE_MODE_XGMII, |
fd70f72c | 82 | PHY_INTERFACE_MODE_MOCA, |
b9d12085 | 83 | PHY_INTERFACE_MODE_QSGMII, |
572de608 | 84 | PHY_INTERFACE_MODE_TRGMII, |
55601a88 AL |
85 | PHY_INTERFACE_MODE_1000BASEX, |
86 | PHY_INTERFACE_MODE_2500BASEX, | |
87 | PHY_INTERFACE_MODE_RXAUI, | |
c125ca09 RK |
88 | PHY_INTERFACE_MODE_XAUI, |
89 | /* 10GBASE-KR, XFI, SFI - single lane 10G Serdes */ | |
90 | PHY_INTERFACE_MODE_10GKR, | |
8a2fe56e | 91 | PHY_INTERFACE_MODE_MAX, |
e8a2b6a4 AF |
92 | } phy_interface_t; |
93 | ||
1f9127ca ZB |
94 | /** |
95 | * phy_supported_speeds - return all speeds currently supported by a phy device | |
96 | * @phy: The phy device to return supported speeds of. | |
97 | * @speeds: buffer to store supported speeds in. | |
98 | * @size: size of speeds buffer. | |
99 | * | |
100 | * Description: Returns the number of supported speeds, and | |
101 | * fills the speeds * buffer with the supported speeds. If speeds buffer is | |
102 | * too small to contain * all currently supported speeds, will return as | |
103 | * many speeds as can fit. | |
104 | */ | |
105 | unsigned int phy_supported_speeds(struct phy_device *phy, | |
106 | unsigned int *speeds, | |
107 | unsigned int size); | |
108 | ||
8a2fe56e FF |
109 | /** |
110 | * It maps 'enum phy_interface_t' found in include/linux/phy.h | |
111 | * into the device tree binding of 'phy-mode', so that Ethernet | |
112 | * device driver can get phy interface from device tree. | |
113 | */ | |
114 | static inline const char *phy_modes(phy_interface_t interface) | |
115 | { | |
116 | switch (interface) { | |
117 | case PHY_INTERFACE_MODE_NA: | |
118 | return ""; | |
735d8a18 FF |
119 | case PHY_INTERFACE_MODE_INTERNAL: |
120 | return "internal"; | |
8a2fe56e FF |
121 | case PHY_INTERFACE_MODE_MII: |
122 | return "mii"; | |
123 | case PHY_INTERFACE_MODE_GMII: | |
124 | return "gmii"; | |
125 | case PHY_INTERFACE_MODE_SGMII: | |
126 | return "sgmii"; | |
127 | case PHY_INTERFACE_MODE_TBI: | |
128 | return "tbi"; | |
129 | case PHY_INTERFACE_MODE_REVMII: | |
130 | return "rev-mii"; | |
131 | case PHY_INTERFACE_MODE_RMII: | |
132 | return "rmii"; | |
133 | case PHY_INTERFACE_MODE_RGMII: | |
134 | return "rgmii"; | |
135 | case PHY_INTERFACE_MODE_RGMII_ID: | |
136 | return "rgmii-id"; | |
137 | case PHY_INTERFACE_MODE_RGMII_RXID: | |
138 | return "rgmii-rxid"; | |
139 | case PHY_INTERFACE_MODE_RGMII_TXID: | |
140 | return "rgmii-txid"; | |
141 | case PHY_INTERFACE_MODE_RTBI: | |
142 | return "rtbi"; | |
143 | case PHY_INTERFACE_MODE_SMII: | |
144 | return "smii"; | |
145 | case PHY_INTERFACE_MODE_XGMII: | |
146 | return "xgmii"; | |
fd70f72c FF |
147 | case PHY_INTERFACE_MODE_MOCA: |
148 | return "moca"; | |
b9d12085 TP |
149 | case PHY_INTERFACE_MODE_QSGMII: |
150 | return "qsgmii"; | |
572de608 SW |
151 | case PHY_INTERFACE_MODE_TRGMII: |
152 | return "trgmii"; | |
55601a88 AL |
153 | case PHY_INTERFACE_MODE_1000BASEX: |
154 | return "1000base-x"; | |
155 | case PHY_INTERFACE_MODE_2500BASEX: | |
156 | return "2500base-x"; | |
157 | case PHY_INTERFACE_MODE_RXAUI: | |
158 | return "rxaui"; | |
c125ca09 RK |
159 | case PHY_INTERFACE_MODE_XAUI: |
160 | return "xaui"; | |
161 | case PHY_INTERFACE_MODE_10GKR: | |
162 | return "10gbase-kr"; | |
8a2fe56e FF |
163 | default: |
164 | return "unknown"; | |
165 | } | |
166 | } | |
167 | ||
00db8189 | 168 | |
e8a2b6a4 | 169 | #define PHY_INIT_TIMEOUT 100000 |
00db8189 AF |
170 | #define PHY_STATE_TIME 1 |
171 | #define PHY_FORCE_TIMEOUT 10 | |
172 | #define PHY_AN_TIMEOUT 10 | |
173 | ||
e8a2b6a4 | 174 | #define PHY_MAX_ADDR 32 |
00db8189 | 175 | |
a4d00f17 | 176 | /* Used when trying to connect to a specific phy (mii bus id:phy device id) */ |
9d9326d3 AF |
177 | #define PHY_ID_FMT "%s:%02x" |
178 | ||
4567d686 | 179 | #define MII_BUS_ID_SIZE 61 |
a4d00f17 | 180 | |
abf35df2 JG |
181 | /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit |
182 | IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */ | |
183 | #define MII_ADDR_C45 (1<<30) | |
184 | ||
313162d0 | 185 | struct device; |
9525ae83 | 186 | struct phylink; |
313162d0 PG |
187 | struct sk_buff; |
188 | ||
c5e38a94 AF |
189 | /* |
190 | * The Bus class for PHYs. Devices which provide access to | |
191 | * PHYs should register using this structure | |
192 | */ | |
00db8189 | 193 | struct mii_bus { |
3e3aaf64 | 194 | struct module *owner; |
00db8189 | 195 | const char *name; |
9d9326d3 | 196 | char id[MII_BUS_ID_SIZE]; |
00db8189 | 197 | void *priv; |
ccaa953e AL |
198 | int (*read)(struct mii_bus *bus, int addr, int regnum); |
199 | int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val); | |
00db8189 AF |
200 | int (*reset)(struct mii_bus *bus); |
201 | ||
c5e38a94 AF |
202 | /* |
203 | * A lock to ensure that only one thing can read/write | |
204 | * the MDIO bus at a time | |
205 | */ | |
35b5f6b1 | 206 | struct mutex mdio_lock; |
00db8189 | 207 | |
18ee49dd | 208 | struct device *parent; |
46abc021 LB |
209 | enum { |
210 | MDIOBUS_ALLOCATED = 1, | |
211 | MDIOBUS_REGISTERED, | |
212 | MDIOBUS_UNREGISTERED, | |
213 | MDIOBUS_RELEASED, | |
214 | } state; | |
215 | struct device dev; | |
00db8189 AF |
216 | |
217 | /* list of all PHYs on bus */ | |
7f854420 | 218 | struct mdio_device *mdio_map[PHY_MAX_ADDR]; |
00db8189 | 219 | |
c6883996 | 220 | /* PHY addresses to be ignored when probing */ |
f896424c MP |
221 | u32 phy_mask; |
222 | ||
922f2dd1 FF |
223 | /* PHY addresses to ignore the TA/read failure */ |
224 | u32 phy_ignore_ta_mask; | |
225 | ||
c5e38a94 | 226 | /* |
e7f4dc35 AL |
227 | * An array of interrupts, each PHY's interrupt at the index |
228 | * matching its address | |
c5e38a94 | 229 | */ |
e7f4dc35 | 230 | int irq[PHY_MAX_ADDR]; |
69226896 RQ |
231 | |
232 | /* GPIO reset pulse width in microseconds */ | |
233 | int reset_delay_us; | |
d396e84c SS |
234 | /* RESET GPIO descriptor pointer */ |
235 | struct gpio_desc *reset_gpiod; | |
00db8189 | 236 | }; |
46abc021 | 237 | #define to_mii_bus(d) container_of(d, struct mii_bus, dev) |
00db8189 | 238 | |
eb8a54a7 TT |
239 | struct mii_bus *mdiobus_alloc_size(size_t); |
240 | static inline struct mii_bus *mdiobus_alloc(void) | |
241 | { | |
242 | return mdiobus_alloc_size(0); | |
243 | } | |
244 | ||
3e3aaf64 RK |
245 | int __mdiobus_register(struct mii_bus *bus, struct module *owner); |
246 | #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE) | |
2e888103 LB |
247 | void mdiobus_unregister(struct mii_bus *bus); |
248 | void mdiobus_free(struct mii_bus *bus); | |
6d48f44b GS |
249 | struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv); |
250 | static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev) | |
251 | { | |
252 | return devm_mdiobus_alloc_size(dev, 0); | |
253 | } | |
254 | ||
255 | void devm_mdiobus_free(struct device *dev, struct mii_bus *bus); | |
2e888103 | 256 | struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr); |
2e888103 | 257 | |
e8a2b6a4 AF |
258 | #define PHY_INTERRUPT_DISABLED 0x0 |
259 | #define PHY_INTERRUPT_ENABLED 0x80000000 | |
00db8189 AF |
260 | |
261 | /* PHY state machine states: | |
262 | * | |
263 | * DOWN: PHY device and driver are not ready for anything. probe | |
264 | * should be called if and only if the PHY is in this state, | |
265 | * given that the PHY device exists. | |
266 | * - PHY driver probe function will, depending on the PHY, set | |
267 | * the state to STARTING or READY | |
268 | * | |
269 | * STARTING: PHY device is coming up, and the ethernet driver is | |
270 | * not ready. PHY drivers may set this in the probe function. | |
271 | * If they do, they are responsible for making sure the state is | |
272 | * eventually set to indicate whether the PHY is UP or READY, | |
273 | * depending on the state when the PHY is done starting up. | |
274 | * - PHY driver will set the state to READY | |
275 | * - start will set the state to PENDING | |
276 | * | |
277 | * READY: PHY is ready to send and receive packets, but the | |
278 | * controller is not. By default, PHYs which do not implement | |
279 | * probe will be set to this state by phy_probe(). If the PHY | |
280 | * driver knows the PHY is ready, and the PHY state is STARTING, | |
281 | * then it sets this STATE. | |
282 | * - start will set the state to UP | |
283 | * | |
284 | * PENDING: PHY device is coming up, but the ethernet driver is | |
285 | * ready. phy_start will set this state if the PHY state is | |
286 | * STARTING. | |
287 | * - PHY driver will set the state to UP when the PHY is ready | |
288 | * | |
289 | * UP: The PHY and attached device are ready to do work. | |
290 | * Interrupts should be started here. | |
291 | * - timer moves to AN | |
292 | * | |
293 | * AN: The PHY is currently negotiating the link state. Link is | |
294 | * therefore down for now. phy_timer will set this state when it | |
295 | * detects the state is UP. config_aneg will set this state | |
296 | * whenever called with phydev->autoneg set to AUTONEG_ENABLE. | |
297 | * - If autonegotiation finishes, but there's no link, it sets | |
298 | * the state to NOLINK. | |
299 | * - If aneg finishes with link, it sets the state to RUNNING, | |
300 | * and calls adjust_link | |
301 | * - If autonegotiation did not finish after an arbitrary amount | |
302 | * of time, autonegotiation should be tried again if the PHY | |
303 | * supports "magic" autonegotiation (back to AN) | |
304 | * - If it didn't finish, and no magic_aneg, move to FORCING. | |
305 | * | |
306 | * NOLINK: PHY is up, but not currently plugged in. | |
307 | * - If the timer notes that the link comes back, we move to RUNNING | |
308 | * - config_aneg moves to AN | |
309 | * - phy_stop moves to HALTED | |
310 | * | |
311 | * FORCING: PHY is being configured with forced settings | |
312 | * - if link is up, move to RUNNING | |
313 | * - If link is down, we drop to the next highest setting, and | |
314 | * retry (FORCING) after a timeout | |
315 | * - phy_stop moves to HALTED | |
316 | * | |
317 | * RUNNING: PHY is currently up, running, and possibly sending | |
318 | * and/or receiving packets | |
319 | * - timer will set CHANGELINK if we're polling (this ensures the | |
320 | * link state is polled every other cycle of this state machine, | |
321 | * which makes it every other second) | |
322 | * - irq will set CHANGELINK | |
323 | * - config_aneg will set AN | |
324 | * - phy_stop moves to HALTED | |
325 | * | |
326 | * CHANGELINK: PHY experienced a change in link state | |
327 | * - timer moves to RUNNING if link | |
328 | * - timer moves to NOLINK if the link is down | |
329 | * - phy_stop moves to HALTED | |
330 | * | |
331 | * HALTED: PHY is up, but no polling or interrupts are done. Or | |
332 | * PHY is in an error state. | |
333 | * | |
334 | * - phy_start moves to RESUMING | |
335 | * | |
336 | * RESUMING: PHY was halted, but now wants to run again. | |
337 | * - If we are forcing, or aneg is done, timer moves to RUNNING | |
338 | * - If aneg is not done, timer moves to AN | |
339 | * - phy_stop moves to HALTED | |
340 | */ | |
341 | enum phy_state { | |
4017b4d3 | 342 | PHY_DOWN = 0, |
00db8189 AF |
343 | PHY_STARTING, |
344 | PHY_READY, | |
345 | PHY_PENDING, | |
346 | PHY_UP, | |
347 | PHY_AN, | |
348 | PHY_RUNNING, | |
349 | PHY_NOLINK, | |
350 | PHY_FORCING, | |
351 | PHY_CHANGELINK, | |
352 | PHY_HALTED, | |
353 | PHY_RESUMING | |
354 | }; | |
355 | ||
ac28b9f8 DD |
356 | /** |
357 | * struct phy_c45_device_ids - 802.3-c45 Device Identifiers | |
358 | * @devices_in_package: Bit vector of devices present. | |
359 | * @device_ids: The device identifer for each present device. | |
360 | */ | |
361 | struct phy_c45_device_ids { | |
362 | u32 devices_in_package; | |
363 | u32 device_ids[8]; | |
364 | }; | |
c1f19b51 | 365 | |
00db8189 AF |
366 | /* phy_device: An instance of a PHY |
367 | * | |
368 | * drv: Pointer to the driver for this PHY instance | |
00db8189 | 369 | * phy_id: UID for this device found during discovery |
ac28b9f8 DD |
370 | * c45_ids: 802.3-c45 Device Identifers if is_c45. |
371 | * is_c45: Set to true if this phy uses clause 45 addressing. | |
4284b6a5 | 372 | * is_internal: Set to true if this phy is internal to a MAC. |
5a11dd7d | 373 | * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc. |
aae88261 | 374 | * has_fixups: Set to true if this phy has fixups/quirks. |
8a477a6f | 375 | * suspended: Set to true if this phy has been suspended successfully. |
a3995460 | 376 | * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal. |
f0f9b4ed | 377 | * loopback_enabled: Set true if this phy has been loopbacked successfully. |
00db8189 AF |
378 | * state: state of the PHY for management purposes |
379 | * dev_flags: Device-specific flags used by the PHY driver. | |
00db8189 AF |
380 | * link_timeout: The number of timer firings to wait before the |
381 | * giving up on the current attempt at acquiring a link | |
382 | * irq: IRQ number of the PHY's interrupt (-1 if none) | |
383 | * phy_timer: The timer for handling the state machine | |
664fcf12 | 384 | * phy_queue: A work_queue for the phy_mac_interrupt |
00db8189 AF |
385 | * attached_dev: The attached enet driver's device instance ptr |
386 | * adjust_link: Callback for the enet controller to respond to | |
387 | * changes in the link state. | |
00db8189 | 388 | * |
114002bc FF |
389 | * speed, duplex, pause, supported, advertising, lp_advertising, |
390 | * and autoneg are used like in mii_if_info | |
00db8189 AF |
391 | * |
392 | * interrupts currently only supports enabled or disabled, | |
393 | * but could be changed in the future to support enabling | |
394 | * and disabling specific interrupts | |
395 | * | |
396 | * Contains some infrastructure for polling and interrupt | |
397 | * handling, as well as handling shifts in PHY hardware state | |
398 | */ | |
399 | struct phy_device { | |
e5a03bfd AL |
400 | struct mdio_device mdio; |
401 | ||
00db8189 AF |
402 | /* Information about the PHY type */ |
403 | /* And management functions */ | |
404 | struct phy_driver *drv; | |
405 | ||
00db8189 AF |
406 | u32 phy_id; |
407 | ||
ac28b9f8 | 408 | struct phy_c45_device_ids c45_ids; |
87e5808d HK |
409 | unsigned is_c45:1; |
410 | unsigned is_internal:1; | |
411 | unsigned is_pseudo_fixed_link:1; | |
412 | unsigned has_fixups:1; | |
413 | unsigned suspended:1; | |
414 | unsigned sysfs_links:1; | |
415 | unsigned loopback_enabled:1; | |
416 | ||
417 | unsigned autoneg:1; | |
418 | /* The most recently read link state */ | |
419 | unsigned link:1; | |
ac28b9f8 | 420 | |
00db8189 AF |
421 | enum phy_state state; |
422 | ||
423 | u32 dev_flags; | |
424 | ||
e8a2b6a4 AF |
425 | phy_interface_t interface; |
426 | ||
c5e38a94 AF |
427 | /* |
428 | * forced speed & duplex (no autoneg) | |
00db8189 AF |
429 | * partner speed & duplex & pause (autoneg) |
430 | */ | |
431 | int speed; | |
432 | int duplex; | |
433 | int pause; | |
434 | int asym_pause; | |
435 | ||
00db8189 AF |
436 | /* Enabled Interrupts */ |
437 | u32 interrupts; | |
438 | ||
439 | /* Union of PHY and Attached devices' supported modes */ | |
440 | /* See mii.h for more info */ | |
441 | u32 supported; | |
442 | u32 advertising; | |
114002bc | 443 | u32 lp_advertising; |
00db8189 | 444 | |
d853d145 | 445 | /* Energy efficient ethernet modes which should be prohibited */ |
446 | u32 eee_broken_modes; | |
447 | ||
00db8189 AF |
448 | int link_timeout; |
449 | ||
2e0bc452 ZB |
450 | #ifdef CONFIG_LED_TRIGGER_PHY |
451 | struct phy_led_trigger *phy_led_triggers; | |
452 | unsigned int phy_num_led_triggers; | |
453 | struct phy_led_trigger *last_triggered; | |
3928ee64 MS |
454 | |
455 | struct phy_led_trigger *led_link_trigger; | |
2e0bc452 ZB |
456 | #endif |
457 | ||
c5e38a94 AF |
458 | /* |
459 | * Interrupt number for this PHY | |
460 | * -1 means no interrupt | |
461 | */ | |
00db8189 AF |
462 | int irq; |
463 | ||
464 | /* private data pointer */ | |
465 | /* For use by PHYs to maintain extra state */ | |
466 | void *priv; | |
467 | ||
468 | /* Interrupt and Polling infrastructure */ | |
469 | struct work_struct phy_queue; | |
a390d1f3 | 470 | struct delayed_work state_queue; |
00db8189 | 471 | |
35b5f6b1 | 472 | struct mutex lock; |
00db8189 | 473 | |
9525ae83 | 474 | struct phylink *phylink; |
00db8189 AF |
475 | struct net_device *attached_dev; |
476 | ||
634ec36c | 477 | u8 mdix; |
f4ed2fe3 | 478 | u8 mdix_ctrl; |
634ec36c | 479 | |
a81497be | 480 | void (*phy_link_change)(struct phy_device *, bool up, bool do_carrier); |
00db8189 | 481 | void (*adjust_link)(struct net_device *dev); |
00db8189 | 482 | }; |
e5a03bfd AL |
483 | #define to_phy_device(d) container_of(to_mdio_device(d), \ |
484 | struct phy_device, mdio) | |
00db8189 AF |
485 | |
486 | /* struct phy_driver: Driver structure for a particular PHY type | |
487 | * | |
a9049e0c | 488 | * driver_data: static driver data |
00db8189 AF |
489 | * phy_id: The result of reading the UID registers of this PHY |
490 | * type, and ANDing them with the phy_id_mask. This driver | |
491 | * only works for PHYs with IDs which match this field | |
492 | * name: The friendly name of this PHY type | |
493 | * phy_id_mask: Defines the important bits of the phy_id | |
494 | * features: A list of features (speed, duplex, etc) supported | |
495 | * by this PHY | |
496 | * flags: A bitfield defining certain other features this PHY | |
497 | * supports (like interrupts) | |
498 | * | |
00fde795 HK |
499 | * All functions are optional. If config_aneg or read_status |
500 | * are not implemented, the phy core uses the genphy versions. | |
501 | * Note that none of these functions should be called from | |
502 | * interrupt time. The goal is for the bus read/write functions | |
503 | * to be able to block when the bus transaction is happening, | |
504 | * and be freed up by an interrupt (The MPC85xx has this ability, | |
505 | * though it is not currently supported in the driver). | |
00db8189 AF |
506 | */ |
507 | struct phy_driver { | |
a9049e0c | 508 | struct mdio_driver_common mdiodrv; |
00db8189 AF |
509 | u32 phy_id; |
510 | char *name; | |
511e3036 | 511 | u32 phy_id_mask; |
00db8189 AF |
512 | u32 features; |
513 | u32 flags; | |
860f6e9e | 514 | const void *driver_data; |
00db8189 | 515 | |
c5e38a94 | 516 | /* |
9df81dd7 FF |
517 | * Called to issue a PHY software reset |
518 | */ | |
519 | int (*soft_reset)(struct phy_device *phydev); | |
520 | ||
521 | /* | |
c5e38a94 AF |
522 | * Called to initialize the PHY, |
523 | * including after a reset | |
524 | */ | |
00db8189 AF |
525 | int (*config_init)(struct phy_device *phydev); |
526 | ||
c5e38a94 AF |
527 | /* |
528 | * Called during discovery. Used to set | |
529 | * up device-specific structures, if any | |
530 | */ | |
00db8189 AF |
531 | int (*probe)(struct phy_device *phydev); |
532 | ||
533 | /* PHY Power Management */ | |
534 | int (*suspend)(struct phy_device *phydev); | |
535 | int (*resume)(struct phy_device *phydev); | |
536 | ||
c5e38a94 AF |
537 | /* |
538 | * Configures the advertisement and resets | |
00db8189 AF |
539 | * autonegotiation if phydev->autoneg is on, |
540 | * forces the speed to the current settings in phydev | |
c5e38a94 AF |
541 | * if phydev->autoneg is off |
542 | */ | |
00db8189 AF |
543 | int (*config_aneg)(struct phy_device *phydev); |
544 | ||
76a423a3 FF |
545 | /* Determines the auto negotiation result */ |
546 | int (*aneg_done)(struct phy_device *phydev); | |
547 | ||
00db8189 AF |
548 | /* Determines the negotiated speed and duplex */ |
549 | int (*read_status)(struct phy_device *phydev); | |
550 | ||
551 | /* Clears any pending interrupts */ | |
552 | int (*ack_interrupt)(struct phy_device *phydev); | |
553 | ||
554 | /* Enables or disables interrupts */ | |
555 | int (*config_intr)(struct phy_device *phydev); | |
556 | ||
a8729eb3 AG |
557 | /* |
558 | * Checks if the PHY generated an interrupt. | |
559 | * For multi-PHY devices with shared PHY interrupt pin | |
560 | */ | |
561 | int (*did_interrupt)(struct phy_device *phydev); | |
562 | ||
00db8189 AF |
563 | /* Clears up any memory if needed */ |
564 | void (*remove)(struct phy_device *phydev); | |
565 | ||
a30e2c18 DD |
566 | /* Returns true if this is a suitable driver for the given |
567 | * phydev. If NULL, matching is based on phy_id and | |
568 | * phy_id_mask. | |
569 | */ | |
570 | int (*match_phy_device)(struct phy_device *phydev); | |
571 | ||
c8f3a8c3 RC |
572 | /* Handles ethtool queries for hardware time stamping. */ |
573 | int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti); | |
574 | ||
c1f19b51 RC |
575 | /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */ |
576 | int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr); | |
577 | ||
578 | /* | |
579 | * Requests a Rx timestamp for 'skb'. If the skb is accepted, | |
580 | * the phy driver promises to deliver it using netif_rx() as | |
581 | * soon as a timestamp becomes available. One of the | |
582 | * PTP_CLASS_ values is passed in 'type'. The function must | |
583 | * return true if the skb is accepted for delivery. | |
584 | */ | |
585 | bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); | |
586 | ||
587 | /* | |
588 | * Requests a Tx timestamp for 'skb'. The phy driver promises | |
da92b194 | 589 | * to deliver it using skb_complete_tx_timestamp() as soon as a |
c1f19b51 RC |
590 | * timestamp becomes available. One of the PTP_CLASS_ values |
591 | * is passed in 'type'. | |
592 | */ | |
593 | void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); | |
594 | ||
42e836eb MS |
595 | /* Some devices (e.g. qnap TS-119P II) require PHY register changes to |
596 | * enable Wake on LAN, so set_wol is provided to be called in the | |
597 | * ethernet driver's set_wol function. */ | |
598 | int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); | |
599 | ||
600 | /* See set_wol, but for checking whether Wake on LAN is enabled. */ | |
601 | void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); | |
602 | ||
2b8f2a28 DM |
603 | /* |
604 | * Called to inform a PHY device driver when the core is about to | |
605 | * change the link state. This callback is supposed to be used as | |
606 | * fixup hook for drivers that need to take action when the link | |
607 | * state changes. Drivers are by no means allowed to mess with the | |
608 | * PHY device structure in their implementations. | |
609 | */ | |
610 | void (*link_change_notify)(struct phy_device *dev); | |
611 | ||
1ee6b9bc RK |
612 | /* |
613 | * Phy specific driver override for reading a MMD register. | |
614 | * This function is optional for PHY specific drivers. When | |
615 | * not provided, the default MMD read function will be used | |
616 | * by phy_read_mmd(), which will use either a direct read for | |
617 | * Clause 45 PHYs or an indirect read for Clause 22 PHYs. | |
618 | * devnum is the MMD device number within the PHY device, | |
619 | * regnum is the register within the selected MMD device. | |
620 | */ | |
621 | int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum); | |
622 | ||
623 | /* | |
624 | * Phy specific driver override for writing a MMD register. | |
625 | * This function is optional for PHY specific drivers. When | |
626 | * not provided, the default MMD write function will be used | |
627 | * by phy_write_mmd(), which will use either a direct write for | |
628 | * Clause 45 PHYs, or an indirect write for Clause 22 PHYs. | |
629 | * devnum is the MMD device number within the PHY device, | |
630 | * regnum is the register within the selected MMD device. | |
631 | * val is the value to be written. | |
632 | */ | |
633 | int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum, | |
634 | u16 val); | |
635 | ||
78ffc4ac RK |
636 | int (*read_page)(struct phy_device *dev); |
637 | int (*write_page)(struct phy_device *dev, int page); | |
638 | ||
2f438366 ES |
639 | /* Get the size and type of the eeprom contained within a plug-in |
640 | * module */ | |
641 | int (*module_info)(struct phy_device *dev, | |
642 | struct ethtool_modinfo *modinfo); | |
643 | ||
644 | /* Get the eeprom information from the plug-in module */ | |
645 | int (*module_eeprom)(struct phy_device *dev, | |
646 | struct ethtool_eeprom *ee, u8 *data); | |
647 | ||
f3a40945 AL |
648 | /* Get statistics from the phy using ethtool */ |
649 | int (*get_sset_count)(struct phy_device *dev); | |
650 | void (*get_strings)(struct phy_device *dev, u8 *data); | |
651 | void (*get_stats)(struct phy_device *dev, | |
652 | struct ethtool_stats *stats, u64 *data); | |
968ad9da RL |
653 | |
654 | /* Get and Set PHY tunables */ | |
655 | int (*get_tunable)(struct phy_device *dev, | |
656 | struct ethtool_tunable *tuna, void *data); | |
657 | int (*set_tunable)(struct phy_device *dev, | |
658 | struct ethtool_tunable *tuna, | |
659 | const void *data); | |
f0f9b4ed | 660 | int (*set_loopback)(struct phy_device *dev, bool enable); |
00db8189 | 661 | }; |
a9049e0c AL |
662 | #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \ |
663 | struct phy_driver, mdiodrv) | |
00db8189 | 664 | |
f62220d3 AF |
665 | #define PHY_ANY_ID "MATCH ANY PHY" |
666 | #define PHY_ANY_UID 0xffffffff | |
667 | ||
668 | /* A Structure for boards to register fixups with the PHY Lib */ | |
669 | struct phy_fixup { | |
670 | struct list_head list; | |
4567d686 | 671 | char bus_id[MII_BUS_ID_SIZE + 3]; |
f62220d3 AF |
672 | u32 phy_uid; |
673 | u32 phy_uid_mask; | |
674 | int (*run)(struct phy_device *phydev); | |
675 | }; | |
676 | ||
da4625ac RK |
677 | const char *phy_speed_to_str(int speed); |
678 | const char *phy_duplex_to_str(unsigned int duplex); | |
679 | ||
0ccb4fc6 RK |
680 | /* A structure for mapping a particular speed and duplex |
681 | * combination to a particular SUPPORTED and ADVERTISED value | |
682 | */ | |
683 | struct phy_setting { | |
684 | u32 speed; | |
685 | u8 duplex; | |
686 | u8 bit; | |
687 | }; | |
688 | ||
689 | const struct phy_setting * | |
690 | phy_lookup_setting(int speed, int duplex, const unsigned long *mask, | |
691 | size_t maxbit, bool exact); | |
692 | size_t phy_speeds(unsigned int *speeds, size_t size, | |
693 | unsigned long *mask, size_t maxbit); | |
694 | ||
8c5e850c RK |
695 | void phy_resolve_aneg_linkmode(struct phy_device *phydev); |
696 | ||
efabdfb9 AF |
697 | /** |
698 | * phy_read_mmd - Convenience function for reading a register | |
699 | * from an MMD on a given PHY. | |
700 | * @phydev: The phy_device struct | |
701 | * @devad: The MMD to read from | |
702 | * @regnum: The register on the MMD to read | |
703 | * | |
704 | * Same rules as for phy_read(); | |
705 | */ | |
9860118b | 706 | int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); |
efabdfb9 | 707 | |
2e888103 LB |
708 | /** |
709 | * phy_read - Convenience function for reading a given PHY register | |
710 | * @phydev: the phy_device struct | |
711 | * @regnum: register number to read | |
712 | * | |
713 | * NOTE: MUST NOT be called from interrupt context, | |
714 | * because the bus read/write functions may wait for an interrupt | |
715 | * to conclude the operation. | |
716 | */ | |
abf35df2 | 717 | static inline int phy_read(struct phy_device *phydev, u32 regnum) |
2e888103 | 718 | { |
e5a03bfd | 719 | return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); |
2e888103 LB |
720 | } |
721 | ||
788f9933 RK |
722 | /** |
723 | * __phy_read - convenience function for reading a given PHY register | |
724 | * @phydev: the phy_device struct | |
725 | * @regnum: register number to read | |
726 | * | |
727 | * The caller must have taken the MDIO bus lock. | |
728 | */ | |
729 | static inline int __phy_read(struct phy_device *phydev, u32 regnum) | |
730 | { | |
731 | return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum); | |
732 | } | |
733 | ||
2e888103 LB |
734 | /** |
735 | * phy_write - Convenience function for writing a given PHY register | |
736 | * @phydev: the phy_device struct | |
737 | * @regnum: register number to write | |
738 | * @val: value to write to @regnum | |
739 | * | |
740 | * NOTE: MUST NOT be called from interrupt context, | |
741 | * because the bus read/write functions may wait for an interrupt | |
742 | * to conclude the operation. | |
743 | */ | |
abf35df2 | 744 | static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) |
2e888103 | 745 | { |
e5a03bfd | 746 | return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val); |
2e888103 LB |
747 | } |
748 | ||
788f9933 RK |
749 | /** |
750 | * __phy_write - Convenience function for writing a given PHY register | |
751 | * @phydev: the phy_device struct | |
752 | * @regnum: register number to write | |
753 | * @val: value to write to @regnum | |
754 | * | |
755 | * The caller must have taken the MDIO bus lock. | |
756 | */ | |
757 | static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val) | |
758 | { | |
759 | return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, | |
760 | val); | |
761 | } | |
762 | ||
763 | int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); | |
2b74e5be | 764 | int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set); |
788f9933 | 765 | |
ac8322d8 HK |
766 | /** |
767 | * __phy_set_bits - Convenience function for setting bits in a PHY register | |
768 | * @phydev: the phy_device struct | |
769 | * @regnum: register number to write | |
770 | * @val: bits to set | |
771 | * | |
772 | * The caller must have taken the MDIO bus lock. | |
773 | */ | |
774 | static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) | |
775 | { | |
776 | return __phy_modify(phydev, regnum, 0, val); | |
777 | } | |
778 | ||
779 | /** | |
780 | * __phy_clear_bits - Convenience function for clearing bits in a PHY register | |
781 | * @phydev: the phy_device struct | |
782 | * @regnum: register number to write | |
783 | * @val: bits to clear | |
784 | * | |
785 | * The caller must have taken the MDIO bus lock. | |
786 | */ | |
787 | static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum, | |
788 | u16 val) | |
789 | { | |
790 | return __phy_modify(phydev, regnum, val, 0); | |
791 | } | |
792 | ||
793 | /** | |
794 | * phy_set_bits - Convenience function for setting bits in a PHY register | |
795 | * @phydev: the phy_device struct | |
796 | * @regnum: register number to write | |
797 | * @val: bits to set | |
798 | */ | |
799 | static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val) | |
800 | { | |
801 | return phy_modify(phydev, regnum, 0, val); | |
802 | } | |
803 | ||
804 | /** | |
805 | * phy_clear_bits - Convenience function for clearing bits in a PHY register | |
806 | * @phydev: the phy_device struct | |
807 | * @regnum: register number to write | |
808 | * @val: bits to clear | |
809 | */ | |
810 | static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val) | |
811 | { | |
812 | return phy_modify(phydev, regnum, val, 0); | |
813 | } | |
814 | ||
2c7b4921 FF |
815 | /** |
816 | * phy_interrupt_is_valid - Convenience function for testing a given PHY irq | |
817 | * @phydev: the phy_device struct | |
818 | * | |
819 | * NOTE: must be kept in sync with addition/removal of PHY_POLL and | |
820 | * PHY_IGNORE_INTERRUPT | |
821 | */ | |
822 | static inline bool phy_interrupt_is_valid(struct phy_device *phydev) | |
823 | { | |
824 | return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT; | |
825 | } | |
826 | ||
3c507b8a HK |
827 | /** |
828 | * phy_polling_mode - Convenience function for testing whether polling is | |
829 | * used to detect PHY status changes | |
830 | * @phydev: the phy_device struct | |
831 | */ | |
832 | static inline bool phy_polling_mode(struct phy_device *phydev) | |
833 | { | |
834 | return phydev->irq == PHY_POLL; | |
835 | } | |
836 | ||
4284b6a5 FF |
837 | /** |
838 | * phy_is_internal - Convenience function for testing if a PHY is internal | |
839 | * @phydev: the phy_device struct | |
840 | */ | |
841 | static inline bool phy_is_internal(struct phy_device *phydev) | |
842 | { | |
843 | return phydev->is_internal; | |
844 | } | |
845 | ||
32d0f783 IS |
846 | /** |
847 | * phy_interface_mode_is_rgmii - Convenience function for testing if a | |
848 | * PHY interface mode is RGMII (all variants) | |
849 | * @mode: the phy_interface_t enum | |
850 | */ | |
851 | static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode) | |
852 | { | |
853 | return mode >= PHY_INTERFACE_MODE_RGMII && | |
854 | mode <= PHY_INTERFACE_MODE_RGMII_TXID; | |
855 | }; | |
856 | ||
365c1e64 RK |
857 | /** |
858 | * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z | |
859 | * negotiation | |
860 | * @mode: one of &enum phy_interface_t | |
861 | * | |
862 | * Returns true if the phy interface mode uses the 16-bit negotiation | |
863 | * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding) | |
864 | */ | |
865 | static inline bool phy_interface_mode_is_8023z(phy_interface_t mode) | |
866 | { | |
867 | return mode == PHY_INTERFACE_MODE_1000BASEX || | |
868 | mode == PHY_INTERFACE_MODE_2500BASEX; | |
869 | } | |
870 | ||
e463d88c FF |
871 | /** |
872 | * phy_interface_is_rgmii - Convenience function for testing if a PHY interface | |
873 | * is RGMII (all variants) | |
874 | * @phydev: the phy_device struct | |
875 | */ | |
876 | static inline bool phy_interface_is_rgmii(struct phy_device *phydev) | |
877 | { | |
32d0f783 | 878 | return phy_interface_mode_is_rgmii(phydev->interface); |
5a11dd7d FF |
879 | }; |
880 | ||
881 | /* | |
882 | * phy_is_pseudo_fixed_link - Convenience function for testing if this | |
883 | * PHY is the CPU port facing side of an Ethernet switch, or similar. | |
884 | * @phydev: the phy_device struct | |
885 | */ | |
886 | static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev) | |
887 | { | |
888 | return phydev->is_pseudo_fixed_link; | |
e463d88c FF |
889 | } |
890 | ||
efabdfb9 AF |
891 | /** |
892 | * phy_write_mmd - Convenience function for writing a register | |
893 | * on an MMD on a given PHY. | |
894 | * @phydev: The phy_device struct | |
895 | * @devad: The MMD to read from | |
896 | * @regnum: The register on the MMD to read | |
897 | * @val: value to write to @regnum | |
898 | * | |
899 | * Same rules as for phy_write(); | |
900 | */ | |
9860118b | 901 | int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val); |
efabdfb9 | 902 | |
78ffc4ac RK |
903 | int phy_save_page(struct phy_device *phydev); |
904 | int phy_select_page(struct phy_device *phydev, int page); | |
905 | int phy_restore_page(struct phy_device *phydev, int oldpage, int ret); | |
906 | int phy_read_paged(struct phy_device *phydev, int page, u32 regnum); | |
907 | int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val); | |
908 | int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum, | |
909 | u16 mask, u16 set); | |
910 | ||
ac28b9f8 | 911 | struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id, |
4017b4d3 SS |
912 | bool is_c45, |
913 | struct phy_c45_device_ids *c45_ids); | |
90eff909 | 914 | #if IS_ENABLED(CONFIG_PHYLIB) |
ac28b9f8 | 915 | struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); |
4dea547f | 916 | int phy_device_register(struct phy_device *phy); |
90eff909 FF |
917 | void phy_device_free(struct phy_device *phydev); |
918 | #else | |
919 | static inline | |
920 | struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45) | |
921 | { | |
922 | return NULL; | |
923 | } | |
924 | ||
925 | static inline int phy_device_register(struct phy_device *phy) | |
926 | { | |
927 | return 0; | |
928 | } | |
929 | ||
930 | static inline void phy_device_free(struct phy_device *phydev) { } | |
931 | #endif /* CONFIG_PHYLIB */ | |
38737e49 | 932 | void phy_device_remove(struct phy_device *phydev); |
2f5cb434 | 933 | int phy_init_hw(struct phy_device *phydev); |
481b5d93 SH |
934 | int phy_suspend(struct phy_device *phydev); |
935 | int phy_resume(struct phy_device *phydev); | |
9c2c2e62 | 936 | int __phy_resume(struct phy_device *phydev); |
f0f9b4ed | 937 | int phy_loopback(struct phy_device *phydev, bool enable); |
4017b4d3 SS |
938 | struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, |
939 | phy_interface_t interface); | |
f8f76db1 | 940 | struct phy_device *phy_find_first(struct mii_bus *bus); |
257184d7 AF |
941 | int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, |
942 | u32 flags, phy_interface_t interface); | |
fa94f6d9 | 943 | int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, |
4017b4d3 SS |
944 | void (*handler)(struct net_device *), |
945 | phy_interface_t interface); | |
946 | struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, | |
947 | void (*handler)(struct net_device *), | |
948 | phy_interface_t interface); | |
e1393456 AF |
949 | void phy_disconnect(struct phy_device *phydev); |
950 | void phy_detach(struct phy_device *phydev); | |
951 | void phy_start(struct phy_device *phydev); | |
952 | void phy_stop(struct phy_device *phydev); | |
953 | int phy_start_aneg(struct phy_device *phydev); | |
372788f9 | 954 | int phy_aneg_done(struct phy_device *phydev); |
2b9672dd HK |
955 | int phy_speed_down(struct phy_device *phydev, bool sync); |
956 | int phy_speed_up(struct phy_device *phydev); | |
e1393456 | 957 | |
e1393456 | 958 | int phy_stop_interrupts(struct phy_device *phydev); |
002ba705 | 959 | int phy_restart_aneg(struct phy_device *phydev); |
a9668491 | 960 | int phy_reset_after_clk_enable(struct phy_device *phydev); |
00db8189 | 961 | |
bafbdd52 SS |
962 | static inline void phy_device_reset(struct phy_device *phydev, int value) |
963 | { | |
964 | mdio_device_reset(&phydev->mdio, value); | |
965 | } | |
966 | ||
72ba48be | 967 | #define phydev_err(_phydev, format, args...) \ |
e5a03bfd | 968 | dev_err(&_phydev->mdio.dev, format, ##args) |
72ba48be AL |
969 | |
970 | #define phydev_dbg(_phydev, format, args...) \ | |
2eaa38d9 | 971 | dev_dbg(&_phydev->mdio.dev, format, ##args) |
72ba48be | 972 | |
84eff6d1 AL |
973 | static inline const char *phydev_name(const struct phy_device *phydev) |
974 | { | |
e5a03bfd | 975 | return dev_name(&phydev->mdio.dev); |
84eff6d1 AL |
976 | } |
977 | ||
2220943a AL |
978 | void phy_attached_print(struct phy_device *phydev, const char *fmt, ...) |
979 | __printf(2, 3); | |
980 | void phy_attached_info(struct phy_device *phydev); | |
5acde34a RK |
981 | |
982 | /* Clause 22 PHY */ | |
af6b6967 | 983 | int genphy_config_init(struct phy_device *phydev); |
3fb69bca | 984 | int genphy_setup_forced(struct phy_device *phydev); |
00db8189 AF |
985 | int genphy_restart_aneg(struct phy_device *phydev); |
986 | int genphy_config_aneg(struct phy_device *phydev); | |
a9fa6e6a | 987 | int genphy_aneg_done(struct phy_device *phydev); |
00db8189 AF |
988 | int genphy_update_link(struct phy_device *phydev); |
989 | int genphy_read_status(struct phy_device *phydev); | |
0f0ca340 GC |
990 | int genphy_suspend(struct phy_device *phydev); |
991 | int genphy_resume(struct phy_device *phydev); | |
f0f9b4ed | 992 | int genphy_loopback(struct phy_device *phydev, bool enable); |
797ac071 | 993 | int genphy_soft_reset(struct phy_device *phydev); |
0878fff1 FF |
994 | static inline int genphy_no_soft_reset(struct phy_device *phydev) |
995 | { | |
996 | return 0; | |
997 | } | |
5df7af85 KH |
998 | int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, |
999 | u16 regnum); | |
1000 | int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum, | |
1001 | u16 regnum, u16 val); | |
5acde34a RK |
1002 | |
1003 | /* Clause 45 PHY */ | |
1004 | int genphy_c45_restart_aneg(struct phy_device *phydev); | |
1005 | int genphy_c45_aneg_done(struct phy_device *phydev); | |
1006 | int genphy_c45_read_link(struct phy_device *phydev, u32 mmd_mask); | |
1007 | int genphy_c45_read_lpa(struct phy_device *phydev); | |
1008 | int genphy_c45_read_pma(struct phy_device *phydev); | |
1009 | int genphy_c45_pma_setup_forced(struct phy_device *phydev); | |
1010 | int genphy_c45_an_disable_aneg(struct phy_device *phydev); | |
ea4efe25 | 1011 | int genphy_c45_read_mdix(struct phy_device *phydev); |
5acde34a | 1012 | |
e8a714e0 FF |
1013 | /* The gen10g_* functions are the old Clause 45 stub */ |
1014 | int gen10g_config_aneg(struct phy_device *phydev); | |
1015 | int gen10g_read_status(struct phy_device *phydev); | |
1016 | int gen10g_no_soft_reset(struct phy_device *phydev); | |
1017 | int gen10g_config_init(struct phy_device *phydev); | |
1018 | int gen10g_suspend(struct phy_device *phydev); | |
1019 | int gen10g_resume(struct phy_device *phydev); | |
1020 | ||
00fde795 HK |
1021 | static inline int phy_read_status(struct phy_device *phydev) |
1022 | { | |
1023 | if (!phydev->drv) | |
1024 | return -EIO; | |
1025 | ||
1026 | if (phydev->drv->read_status) | |
1027 | return phydev->drv->read_status(phydev); | |
1028 | else | |
1029 | return genphy_read_status(phydev); | |
1030 | } | |
1031 | ||
00db8189 | 1032 | void phy_driver_unregister(struct phy_driver *drv); |
d5bf9071 | 1033 | void phy_drivers_unregister(struct phy_driver *drv, int n); |
be01da72 AL |
1034 | int phy_driver_register(struct phy_driver *new_driver, struct module *owner); |
1035 | int phy_drivers_register(struct phy_driver *new_driver, int n, | |
1036 | struct module *owner); | |
4f9c85a1 | 1037 | void phy_state_machine(struct work_struct *work); |
664fcf12 | 1038 | void phy_change_work(struct work_struct *work); |
28b2e0d2 | 1039 | void phy_mac_interrupt(struct phy_device *phydev); |
29935aeb | 1040 | void phy_start_machine(struct phy_device *phydev); |
00db8189 | 1041 | void phy_stop_machine(struct phy_device *phydev); |
f555f34f | 1042 | void phy_trigger_machine(struct phy_device *phydev, bool sync); |
00db8189 | 1043 | int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd); |
5514174f | 1044 | void phy_ethtool_ksettings_get(struct phy_device *phydev, |
1045 | struct ethtool_link_ksettings *cmd); | |
2d55173e PR |
1046 | int phy_ethtool_ksettings_set(struct phy_device *phydev, |
1047 | const struct ethtool_link_ksettings *cmd); | |
4017b4d3 | 1048 | int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); |
e1393456 AF |
1049 | int phy_start_interrupts(struct phy_device *phydev); |
1050 | void phy_print_status(struct phy_device *phydev); | |
f3a6bd39 | 1051 | int phy_set_max_speed(struct phy_device *phydev, u32 max_speed); |
00db8189 | 1052 | |
f62220d3 | 1053 | int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, |
4017b4d3 | 1054 | int (*run)(struct phy_device *)); |
f62220d3 | 1055 | int phy_register_fixup_for_id(const char *bus_id, |
4017b4d3 | 1056 | int (*run)(struct phy_device *)); |
f62220d3 | 1057 | int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, |
4017b4d3 | 1058 | int (*run)(struct phy_device *)); |
f62220d3 | 1059 | |
f38e7a32 WH |
1060 | int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask); |
1061 | int phy_unregister_fixup_for_id(const char *bus_id); | |
1062 | int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask); | |
1063 | ||
a59a4d19 GC |
1064 | int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); |
1065 | int phy_get_eee_err(struct phy_device *phydev); | |
1066 | int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); | |
1067 | int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); | |
42e836eb | 1068 | int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); |
4017b4d3 SS |
1069 | void phy_ethtool_get_wol(struct phy_device *phydev, |
1070 | struct ethtool_wolinfo *wol); | |
9d9a77ce PR |
1071 | int phy_ethtool_get_link_ksettings(struct net_device *ndev, |
1072 | struct ethtool_link_ksettings *cmd); | |
1073 | int phy_ethtool_set_link_ksettings(struct net_device *ndev, | |
1074 | const struct ethtool_link_ksettings *cmd); | |
e86a8987 | 1075 | int phy_ethtool_nway_reset(struct net_device *ndev); |
a59a4d19 | 1076 | |
90eff909 | 1077 | #if IS_ENABLED(CONFIG_PHYLIB) |
9b9a8bfc AF |
1078 | int __init mdio_bus_init(void); |
1079 | void mdio_bus_exit(void); | |
9e8d438e FF |
1080 | #endif |
1081 | ||
1082 | /* Inline function for use within net/core/ethtool.c (built-in) */ | |
1083 | static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data) | |
c59530d0 | 1084 | { |
9e8d438e FF |
1085 | if (!phydev->drv) |
1086 | return -EIO; | |
1087 | ||
1088 | mutex_lock(&phydev->lock); | |
1089 | phydev->drv->get_strings(phydev, data); | |
1090 | mutex_unlock(&phydev->lock); | |
1091 | ||
1092 | return 0; | |
c59530d0 FF |
1093 | } |
1094 | ||
9e8d438e | 1095 | static inline int phy_ethtool_get_sset_count(struct phy_device *phydev) |
c59530d0 | 1096 | { |
9e8d438e FF |
1097 | int ret; |
1098 | ||
1099 | if (!phydev->drv) | |
1100 | return -EIO; | |
1101 | ||
1102 | if (phydev->drv->get_sset_count && | |
1103 | phydev->drv->get_strings && | |
1104 | phydev->drv->get_stats) { | |
1105 | mutex_lock(&phydev->lock); | |
1106 | ret = phydev->drv->get_sset_count(phydev); | |
1107 | mutex_unlock(&phydev->lock); | |
1108 | ||
1109 | return ret; | |
1110 | } | |
1111 | ||
c59530d0 FF |
1112 | return -EOPNOTSUPP; |
1113 | } | |
1114 | ||
9e8d438e FF |
1115 | static inline int phy_ethtool_get_stats(struct phy_device *phydev, |
1116 | struct ethtool_stats *stats, u64 *data) | |
c59530d0 | 1117 | { |
9e8d438e FF |
1118 | if (!phydev->drv) |
1119 | return -EIO; | |
1120 | ||
1121 | mutex_lock(&phydev->lock); | |
1122 | phydev->drv->get_stats(phydev, stats, data); | |
1123 | mutex_unlock(&phydev->lock); | |
1124 | ||
1125 | return 0; | |
c59530d0 | 1126 | } |
9b9a8bfc | 1127 | |
00db8189 | 1128 | extern struct bus_type mdio_bus_type; |
c31accd1 | 1129 | |
648ea013 FF |
1130 | struct mdio_board_info { |
1131 | const char *bus_id; | |
1132 | char modalias[MDIO_NAME_SIZE]; | |
1133 | int mdio_addr; | |
1134 | const void *platform_data; | |
1135 | }; | |
1136 | ||
90eff909 | 1137 | #if IS_ENABLED(CONFIG_MDIO_DEVICE) |
648ea013 FF |
1138 | int mdiobus_register_board_info(const struct mdio_board_info *info, |
1139 | unsigned int n); | |
1140 | #else | |
1141 | static inline int mdiobus_register_board_info(const struct mdio_board_info *i, | |
1142 | unsigned int n) | |
1143 | { | |
1144 | return 0; | |
1145 | } | |
1146 | #endif | |
1147 | ||
1148 | ||
c31accd1 JH |
1149 | /** |
1150 | * module_phy_driver() - Helper macro for registering PHY drivers | |
1151 | * @__phy_drivers: array of PHY drivers to register | |
1152 | * | |
1153 | * Helper macro for PHY drivers which do not do anything special in module | |
1154 | * init/exit. Each module may only use this macro once, and calling it | |
1155 | * replaces module_init() and module_exit(). | |
1156 | */ | |
1157 | #define phy_module_driver(__phy_drivers, __count) \ | |
1158 | static int __init phy_module_init(void) \ | |
1159 | { \ | |
be01da72 | 1160 | return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \ |
c31accd1 JH |
1161 | } \ |
1162 | module_init(phy_module_init); \ | |
1163 | static void __exit phy_module_exit(void) \ | |
1164 | { \ | |
1165 | phy_drivers_unregister(__phy_drivers, __count); \ | |
1166 | } \ | |
1167 | module_exit(phy_module_exit) | |
1168 | ||
1169 | #define module_phy_driver(__phy_drivers) \ | |
1170 | phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) | |
1171 | ||
00db8189 | 1172 | #endif /* __PHY_H */ |