blob: adb66a2fae18b3e54e671e497635ffcc2db803ba [file] [log] [blame]
Andrew Lunna2443fd2019-01-21 19:05:50 +01001// SPDX-License-Identifier: GPL-2.0+
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03002/* Framework for finding and configuring PHYs.
Andy Fleming00db8182005-07-30 19:31:23 -04003 * Also contains generic PHY driver
4 *
5 * Author: Andy Fleming
6 *
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
Andy Fleming00db8182005-07-30 19:31:23 -04008 */
Joe Perches8d242482012-06-09 07:49:07 +00009
10#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11
Andy Fleming00db8182005-07-30 19:31:23 -040012#include <linux/kernel.h>
Andy Fleming00db8182005-07-30 19:31:23 -040013#include <linux/string.h>
14#include <linux/errno.h>
15#include <linux/unistd.h>
16#include <linux/slab.h>
17#include <linux/interrupt.h>
18#include <linux/init.h>
19#include <linux/delay.h>
20#include <linux/netdevice.h>
21#include <linux/etherdevice.h>
22#include <linux/skbuff.h>
Andy Fleming00db8182005-07-30 19:31:23 -040023#include <linux/mm.h>
24#include <linux/module.h>
Andy Fleming00db8182005-07-30 19:31:23 -040025#include <linux/mii.h>
26#include <linux/ethtool.h>
Andrew Lunn719655a2018-09-29 23:04:16 +020027#include <linux/bitmap.h>
Andy Fleming00db8182005-07-30 19:31:23 -040028#include <linux/phy.h>
Zach Brown2e0bc452016-10-17 10:49:55 -050029#include <linux/phy_led_triggers.h>
Andy Fleming124059f2014-01-10 14:27:37 +080030#include <linux/mdio.h>
Sergei Shtylyov2f53e902014-01-05 03:17:06 +030031#include <linux/io.h>
32#include <linux/uaccess.h>
Andy Fleming00db8182005-07-30 19:31:23 -040033
Olaf Heringafcceaa2005-12-14 00:33:49 +010034MODULE_DESCRIPTION("PHY library");
35MODULE_AUTHOR("Andy Fleming");
36MODULE_LICENSE("GPL");
37
Andrew Lunn719655a2018-09-29 23:04:16 +020038__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
39EXPORT_SYMBOL_GPL(phy_basic_features);
40
41__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
42EXPORT_SYMBOL_GPL(phy_basic_t1_features);
43
44__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
45EXPORT_SYMBOL_GPL(phy_gbit_features);
46
47__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
48EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
49
50__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
51EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
52
53__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
54EXPORT_SYMBOL_GPL(phy_10gbit_features);
55
Andrew Lunn9e857a42019-01-15 16:55:30 +010056__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
57EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
58
Denis Efremov54638c62019-07-10 21:03:24 +030059const int phy_basic_ports_array[3] = {
Andrew Lunn719655a2018-09-29 23:04:16 +020060 ETHTOOL_LINK_MODE_Autoneg_BIT,
61 ETHTOOL_LINK_MODE_TP_BIT,
62 ETHTOOL_LINK_MODE_MII_BIT,
63};
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010064EXPORT_SYMBOL_GPL(phy_basic_ports_array);
Andrew Lunn719655a2018-09-29 23:04:16 +020065
Denis Efremov54638c62019-07-10 21:03:24 +030066const int phy_fibre_port_array[1] = {
Andrew Lunn719655a2018-09-29 23:04:16 +020067 ETHTOOL_LINK_MODE_FIBRE_BIT,
68};
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010069EXPORT_SYMBOL_GPL(phy_fibre_port_array);
Andrew Lunn719655a2018-09-29 23:04:16 +020070
Denis Efremov54638c62019-07-10 21:03:24 +030071const int phy_all_ports_features_array[7] = {
Andrew Lunn719655a2018-09-29 23:04:16 +020072 ETHTOOL_LINK_MODE_Autoneg_BIT,
73 ETHTOOL_LINK_MODE_TP_BIT,
74 ETHTOOL_LINK_MODE_MII_BIT,
75 ETHTOOL_LINK_MODE_FIBRE_BIT,
76 ETHTOOL_LINK_MODE_AUI_BIT,
77 ETHTOOL_LINK_MODE_BNC_BIT,
78 ETHTOOL_LINK_MODE_Backplane_BIT,
79};
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010080EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
Andrew Lunn719655a2018-09-29 23:04:16 +020081
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010082const int phy_10_100_features_array[4] = {
Andrew Lunn719655a2018-09-29 23:04:16 +020083 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
84 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
85 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
86 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
87};
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010088EXPORT_SYMBOL_GPL(phy_10_100_features_array);
Andrew Lunn719655a2018-09-29 23:04:16 +020089
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010090const int phy_basic_t1_features_array[2] = {
Andrew Lunn719655a2018-09-29 23:04:16 +020091 ETHTOOL_LINK_MODE_TP_BIT,
Andrew Lunne5fb32c2019-05-22 20:47:04 +020092 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
Andrew Lunn719655a2018-09-29 23:04:16 +020093};
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010094EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
Andrew Lunn719655a2018-09-29 23:04:16 +020095
Andrew Lunn3c1bcc82018-11-10 23:43:33 +010096const int phy_gbit_features_array[2] = {
Andrew Lunn719655a2018-09-29 23:04:16 +020097 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
98 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
99};
Andrew Lunn3c1bcc82018-11-10 23:43:33 +0100100EXPORT_SYMBOL_GPL(phy_gbit_features_array);
Andrew Lunn719655a2018-09-29 23:04:16 +0200101
Andrew Lunn3c1bcc82018-11-10 23:43:33 +0100102const int phy_10gbit_features_array[1] = {
Andrew Lunn719655a2018-09-29 23:04:16 +0200103 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
104};
Andrew Lunn3c1bcc82018-11-10 23:43:33 +0100105EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
Andrew Lunn719655a2018-09-29 23:04:16 +0200106
Andrew Lunn9e857a42019-01-15 16:55:30 +0100107const int phy_10gbit_fec_features_array[1] = {
108 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
109};
110EXPORT_SYMBOL_GPL(phy_10gbit_fec_features_array);
111
Andrew Lunn719655a2018-09-29 23:04:16 +0200112__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
113EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
114
115static const int phy_10gbit_full_features_array[] = {
116 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
117 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
118 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
119 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
120};
121
122static void features_init(void)
123{
124 /* 10/100 half/full*/
125 linkmode_set_bit_array(phy_basic_ports_array,
126 ARRAY_SIZE(phy_basic_ports_array),
127 phy_basic_features);
128 linkmode_set_bit_array(phy_10_100_features_array,
129 ARRAY_SIZE(phy_10_100_features_array),
130 phy_basic_features);
131
132 /* 100 full, TP */
133 linkmode_set_bit_array(phy_basic_t1_features_array,
134 ARRAY_SIZE(phy_basic_t1_features_array),
135 phy_basic_t1_features);
136
137 /* 10/100 half/full + 1000 half/full */
138 linkmode_set_bit_array(phy_basic_ports_array,
139 ARRAY_SIZE(phy_basic_ports_array),
140 phy_gbit_features);
141 linkmode_set_bit_array(phy_10_100_features_array,
142 ARRAY_SIZE(phy_10_100_features_array),
143 phy_gbit_features);
144 linkmode_set_bit_array(phy_gbit_features_array,
145 ARRAY_SIZE(phy_gbit_features_array),
146 phy_gbit_features);
147
148 /* 10/100 half/full + 1000 half/full + fibre*/
149 linkmode_set_bit_array(phy_basic_ports_array,
150 ARRAY_SIZE(phy_basic_ports_array),
151 phy_gbit_fibre_features);
152 linkmode_set_bit_array(phy_10_100_features_array,
153 ARRAY_SIZE(phy_10_100_features_array),
154 phy_gbit_fibre_features);
155 linkmode_set_bit_array(phy_gbit_features_array,
156 ARRAY_SIZE(phy_gbit_features_array),
157 phy_gbit_fibre_features);
158 linkmode_set_bit_array(phy_fibre_port_array,
159 ARRAY_SIZE(phy_fibre_port_array),
160 phy_gbit_fibre_features);
161
162 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
163 linkmode_set_bit_array(phy_all_ports_features_array,
164 ARRAY_SIZE(phy_all_ports_features_array),
165 phy_gbit_all_ports_features);
166 linkmode_set_bit_array(phy_10_100_features_array,
167 ARRAY_SIZE(phy_10_100_features_array),
168 phy_gbit_all_ports_features);
169 linkmode_set_bit_array(phy_gbit_features_array,
170 ARRAY_SIZE(phy_gbit_features_array),
171 phy_gbit_all_ports_features);
172
173 /* 10/100 half/full + 1000 half/full + 10G full*/
174 linkmode_set_bit_array(phy_all_ports_features_array,
175 ARRAY_SIZE(phy_all_ports_features_array),
176 phy_10gbit_features);
177 linkmode_set_bit_array(phy_10_100_features_array,
178 ARRAY_SIZE(phy_10_100_features_array),
179 phy_10gbit_features);
180 linkmode_set_bit_array(phy_gbit_features_array,
181 ARRAY_SIZE(phy_gbit_features_array),
182 phy_10gbit_features);
183 linkmode_set_bit_array(phy_10gbit_features_array,
184 ARRAY_SIZE(phy_10gbit_features_array),
185 phy_10gbit_features);
186
187 /* 10/100/1000/10G full */
188 linkmode_set_bit_array(phy_all_ports_features_array,
189 ARRAY_SIZE(phy_all_ports_features_array),
190 phy_10gbit_full_features);
191 linkmode_set_bit_array(phy_10gbit_full_features_array,
192 ARRAY_SIZE(phy_10gbit_full_features_array),
193 phy_10gbit_full_features);
Andrew Lunn9e857a42019-01-15 16:55:30 +0100194 /* 10G FEC only */
195 linkmode_set_bit_array(phy_10gbit_fec_features_array,
196 ARRAY_SIZE(phy_10gbit_fec_features_array),
197 phy_10gbit_fec_features);
Andrew Lunn719655a2018-09-29 23:04:16 +0200198}
199
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300200void phy_device_free(struct phy_device *phydev)
201{
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100202 put_device(&phydev->mdio.dev);
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300203}
Grant Likely4dea5472009-04-25 12:52:46 +0000204EXPORT_SYMBOL(phy_device_free);
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300205
Andrew Lunn711fdba2016-01-06 20:11:27 +0100206static void phy_mdio_device_free(struct mdio_device *mdiodev)
207{
208 struct phy_device *phydev;
209
210 phydev = container_of(mdiodev, struct phy_device, mdio);
211 phy_device_free(phydev);
212}
213
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300214static void phy_device_release(struct device *dev)
215{
Petr Malatb2a43192013-02-28 01:01:52 +0000216 kfree(to_phy_device(dev));
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300217}
218
Andrew Lunn711fdba2016-01-06 20:11:27 +0100219static void phy_mdio_device_remove(struct mdio_device *mdiodev)
220{
221 struct phy_device *phydev;
222
223 phydev = container_of(mdiodev, struct phy_device, mdio);
224 phy_device_remove(phydev);
225}
226
Russell King921690f2017-06-05 12:23:05 +0100227static struct phy_driver genphy_driver;
Heiner Kallweit22b56e82019-04-07 13:55:01 +0200228extern struct phy_driver genphy_c45_driver;
Grant Likely4dea5472009-04-25 12:52:46 +0000229
Andy Flemingf62220d2008-04-18 17:29:54 -0500230static LIST_HEAD(phy_fixup_list);
231static DEFINE_MUTEX(phy_fixup_lock);
232
Andrew Lunnbc879222016-01-06 20:11:21 +0100233#ifdef CONFIG_PM
234static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
235{
236 struct device_driver *drv = phydev->mdio.dev.driver;
237 struct phy_driver *phydrv = to_phy_driver(drv);
238 struct net_device *netdev = phydev->attached_dev;
239
240 if (!drv || !phydrv->suspend)
241 return false;
242
243 /* PHY not attached? May suspend if the PHY has not already been
244 * suspended as part of a prior call to phy_disconnect() ->
245 * phy_detach() -> phy_suspend() because the parent netdev might be the
246 * MDIO bus driver and clock gated at this point.
247 */
248 if (!netdev)
249 return !phydev->suspended;
250
Heiner Kallweit93f41e62018-09-24 22:01:32 +0200251 if (netdev->wol_enabled)
252 return false;
253
254 /* As long as not all affected network drivers support the
255 * wol_enabled flag, let's check for hints that WoL is enabled.
256 * Don't suspend PHY if the attached netdev parent may wake up.
Andrew Lunnbc879222016-01-06 20:11:21 +0100257 * The parent may point to a PCI device, as in tg3 driver.
258 */
259 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
260 return false;
261
262 /* Also don't suspend PHY if the netdev itself may wakeup. This
263 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
264 * e.g. SoC devices.
265 */
266 if (device_may_wakeup(&netdev->dev))
267 return false;
268
269 return true;
270}
271
272static int mdio_bus_phy_suspend(struct device *dev)
273{
274 struct phy_device *phydev = to_phy_device(dev);
275
276 /* We must stop the state machine manually, otherwise it stops out of
277 * control, possibly with the phydev->lock held. Upon resume, netdev
278 * may call phy routines that try to grab the same lock, and that may
279 * lead to a deadlock.
280 */
281 if (phydev->attached_dev && phydev->adjust_link)
282 phy_stop_machine(phydev);
283
284 if (!mdio_bus_phy_may_suspend(phydev))
285 return 0;
286
287 return phy_suspend(phydev);
288}
289
290static int mdio_bus_phy_resume(struct device *dev)
291{
292 struct phy_device *phydev = to_phy_device(dev);
293 int ret;
294
295 if (!mdio_bus_phy_may_suspend(phydev))
296 goto no_resume;
297
298 ret = phy_resume(phydev);
299 if (ret < 0)
300 return ret;
301
302no_resume:
303 if (phydev->attached_dev && phydev->adjust_link)
304 phy_start_machine(phydev);
305
306 return 0;
307}
308
309static int mdio_bus_phy_restore(struct device *dev)
310{
311 struct phy_device *phydev = to_phy_device(dev);
312 struct net_device *netdev = phydev->attached_dev;
313 int ret;
314
315 if (!netdev)
316 return 0;
317
318 ret = phy_init_hw(phydev);
319 if (ret < 0)
320 return ret;
321
Kunihiko Hayashi8742beb2018-12-18 16:57:04 +0900322 if (phydev->attached_dev && phydev->adjust_link)
323 phy_start_machine(phydev);
Andrew Lunnbc879222016-01-06 20:11:21 +0100324
325 return 0;
326}
327
328static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
329 .suspend = mdio_bus_phy_suspend,
330 .resume = mdio_bus_phy_resume,
331 .freeze = mdio_bus_phy_suspend,
332 .thaw = mdio_bus_phy_resume,
333 .restore = mdio_bus_phy_restore,
334};
335
336#define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
337
338#else
339
340#define MDIO_BUS_PHY_PM_OPS NULL
341
342#endif /* CONFIG_PM */
343
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300344/**
345 * phy_register_fixup - creates a new phy_fixup and adds it to the list
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100346 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
Andy Flemingf62220d2008-04-18 17:29:54 -0500347 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300348 * It can also be PHY_ANY_UID
Andy Flemingf62220d2008-04-18 17:29:54 -0500349 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300350 * comparison
Andy Flemingf62220d2008-04-18 17:29:54 -0500351 * @run: The actual code to be run when a matching PHY is found
352 */
353int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300354 int (*run)(struct phy_device *))
Andy Flemingf62220d2008-04-18 17:29:54 -0500355{
Sergei Shtylyov553fe922014-01-05 03:23:19 +0300356 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
Andy Flemingf62220d2008-04-18 17:29:54 -0500357
Andy Flemingf62220d2008-04-18 17:29:54 -0500358 if (!fixup)
359 return -ENOMEM;
360
Kay Sieversfb28ad32008-11-10 13:55:14 -0800361 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
Andy Flemingf62220d2008-04-18 17:29:54 -0500362 fixup->phy_uid = phy_uid;
363 fixup->phy_uid_mask = phy_uid_mask;
364 fixup->run = run;
365
366 mutex_lock(&phy_fixup_lock);
367 list_add_tail(&fixup->list, &phy_fixup_list);
368 mutex_unlock(&phy_fixup_lock);
369
370 return 0;
371}
372EXPORT_SYMBOL(phy_register_fixup);
373
374/* Registers a fixup to be run on any PHY with the UID in phy_uid */
375int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300376 int (*run)(struct phy_device *))
Andy Flemingf62220d2008-04-18 17:29:54 -0500377{
378 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
379}
380EXPORT_SYMBOL(phy_register_fixup_for_uid);
381
382/* Registers a fixup to be run on the PHY with id string bus_id */
383int phy_register_fixup_for_id(const char *bus_id,
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300384 int (*run)(struct phy_device *))
Andy Flemingf62220d2008-04-18 17:29:54 -0500385{
386 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
387}
388EXPORT_SYMBOL(phy_register_fixup_for_id);
389
Woojung.Huh@microchip.comf38e7a32016-12-07 20:26:07 +0000390/**
391 * phy_unregister_fixup - remove a phy_fixup from the list
392 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
393 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
394 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
395 */
396int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
397{
398 struct list_head *pos, *n;
399 struct phy_fixup *fixup;
400 int ret;
401
402 ret = -ENODEV;
403
404 mutex_lock(&phy_fixup_lock);
405 list_for_each_safe(pos, n, &phy_fixup_list) {
406 fixup = list_entry(pos, struct phy_fixup, list);
407
408 if ((!strcmp(fixup->bus_id, bus_id)) &&
409 ((fixup->phy_uid & phy_uid_mask) ==
410 (phy_uid & phy_uid_mask))) {
411 list_del(&fixup->list);
412 kfree(fixup);
413 ret = 0;
414 break;
415 }
416 }
417 mutex_unlock(&phy_fixup_lock);
418
419 return ret;
420}
421EXPORT_SYMBOL(phy_unregister_fixup);
422
423/* Unregisters a fixup of any PHY with the UID in phy_uid */
424int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
425{
426 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
427}
428EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
429
430/* Unregisters a fixup of the PHY with id string bus_id */
431int phy_unregister_fixup_for_id(const char *bus_id)
432{
433 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
434}
435EXPORT_SYMBOL(phy_unregister_fixup_for_id);
436
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300437/* Returns 1 if fixup matches phydev in bus_id and phy_uid.
Andy Flemingf62220d2008-04-18 17:29:54 -0500438 * Fixups can be set to match any in one or more fields.
439 */
440static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
441{
Andrew Lunn84eff6d2016-01-06 20:11:10 +0100442 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
Andy Flemingf62220d2008-04-18 17:29:54 -0500443 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
444 return 0;
445
446 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300447 (phydev->phy_id & fixup->phy_uid_mask))
Andy Flemingf62220d2008-04-18 17:29:54 -0500448 if (fixup->phy_uid != PHY_ANY_UID)
449 return 0;
450
451 return 1;
452}
453
454/* Runs any matching fixups for this phydev */
Sergei Shtylyovfbfcec62014-01-05 03:28:27 +0300455static int phy_scan_fixups(struct phy_device *phydev)
Andy Flemingf62220d2008-04-18 17:29:54 -0500456{
457 struct phy_fixup *fixup;
458
459 mutex_lock(&phy_fixup_lock);
460 list_for_each_entry(fixup, &phy_fixup_list, list) {
461 if (phy_needs_fixup(phydev, fixup)) {
Sergei Shtylyov553fe922014-01-05 03:23:19 +0300462 int err = fixup->run(phydev);
Andy Flemingf62220d2008-04-18 17:29:54 -0500463
Jiri Slabybc23283c2009-07-13 11:23:39 +0000464 if (err < 0) {
465 mutex_unlock(&phy_fixup_lock);
Andy Flemingf62220d2008-04-18 17:29:54 -0500466 return err;
Jiri Slabybc23283c2009-07-13 11:23:39 +0000467 }
Florian Fainellib0ae0092014-02-11 17:27:41 -0800468 phydev->has_fixups = true;
Andy Flemingf62220d2008-04-18 17:29:54 -0500469 }
470 }
471 mutex_unlock(&phy_fixup_lock);
472
473 return 0;
474}
Andy Flemingf62220d2008-04-18 17:29:54 -0500475
Andrew Lunne76a4952016-01-06 20:11:23 +0100476static int phy_bus_match(struct device *dev, struct device_driver *drv)
477{
478 struct phy_device *phydev = to_phy_device(dev);
479 struct phy_driver *phydrv = to_phy_driver(drv);
480 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
481 int i;
482
Andrew Lunna9049e02016-01-06 20:11:26 +0100483 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
484 return 0;
485
Andrew Lunne76a4952016-01-06 20:11:23 +0100486 if (phydrv->match_phy_device)
487 return phydrv->match_phy_device(phydev);
488
489 if (phydev->is_c45) {
490 for (i = 1; i < num_ids; i++) {
491 if (!(phydev->c45_ids.devices_in_package & (1 << i)))
492 continue;
493
494 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
495 (phydev->c45_ids.device_ids[i] &
496 phydrv->phy_id_mask))
497 return 1;
498 }
499 return 0;
500 } else {
501 return (phydrv->phy_id & phydrv->phy_id_mask) ==
502 (phydev->phy_id & phydrv->phy_id_mask);
503 }
504}
505
Heiner Kallweit7f4828f2018-06-02 22:36:06 +0200506static ssize_t
507phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
508{
509 struct phy_device *phydev = to_phy_device(dev);
510
511 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
512}
513static DEVICE_ATTR_RO(phy_id);
514
515static ssize_t
516phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
517{
518 struct phy_device *phydev = to_phy_device(dev);
519 const char *mode = NULL;
520
521 if (phy_is_internal(phydev))
522 mode = "internal";
523 else
524 mode = phy_modes(phydev->interface);
525
526 return sprintf(buf, "%s\n", mode);
527}
528static DEVICE_ATTR_RO(phy_interface);
529
530static ssize_t
531phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
532 char *buf)
533{
534 struct phy_device *phydev = to_phy_device(dev);
535
536 return sprintf(buf, "%d\n", phydev->has_fixups);
537}
538static DEVICE_ATTR_RO(phy_has_fixups);
539
540static struct attribute *phy_dev_attrs[] = {
541 &dev_attr_phy_id.attr,
542 &dev_attr_phy_interface.attr,
543 &dev_attr_phy_has_fixups.attr,
544 NULL,
545};
546ATTRIBUTE_GROUPS(phy_dev);
547
548static const struct device_type mdio_bus_phy_type = {
549 .name = "PHY",
550 .groups = phy_dev_groups,
551 .release = phy_device_release,
552 .pm = MDIO_BUS_PHY_PM_OPS,
553};
554
Heiner Kallweit13d0ab62019-01-16 08:07:38 +0100555static int phy_request_driver_module(struct phy_device *dev, int phy_id)
556{
557 int ret;
558
559 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
560 MDIO_ID_ARGS(phy_id));
Heiner Kallweit21e19442019-01-19 10:30:21 +0100561 /* We only check for failures in executing the usermode binary,
562 * not whether a PHY driver module exists for the PHY ID.
563 * Accept -ENOENT because this may occur in case no initramfs exists,
564 * then modprobe isn't available.
Heiner Kallweit13d0ab62019-01-16 08:07:38 +0100565 */
Heiner Kallweit21e19442019-01-19 10:30:21 +0100566 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
Heiner Kallweit13d0ab62019-01-16 08:07:38 +0100567 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08x\n",
568 ret, phy_id);
569 return ret;
570 }
571
572 return 0;
573}
574
David Daneyac28b9f2012-06-27 07:33:35 +0000575struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300576 bool is_c45,
577 struct phy_c45_device_ids *c45_ids)
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700578{
579 struct phy_device *dev;
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100580 struct mdio_device *mdiodev;
Heiner Kallweit13d0ab62019-01-16 08:07:38 +0100581 int ret = 0;
David Woodhouse8626d3b2010-04-02 01:05:27 +0000582
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300583 /* We allocate the device, and initialize the default values */
Robert P. J. Daycd861282006-12-13 00:34:52 -0800584 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
Sergei Shtylyovef899c02015-08-28 21:35:14 +0300585 if (!dev)
Sergei Shtylyovd3765f02015-08-28 21:34:34 +0300586 return ERR_PTR(-ENOMEM);
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700587
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100588 mdiodev = &dev->mdio;
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100589 mdiodev->dev.parent = &bus->dev;
590 mdiodev->dev.bus = &mdio_bus_type;
Heiner Kallweit7f4828f2018-06-02 22:36:06 +0200591 mdiodev->dev.type = &mdio_bus_phy_type;
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100592 mdiodev->bus = bus;
Andrew Lunne76a4952016-01-06 20:11:23 +0100593 mdiodev->bus_match = phy_bus_match;
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100594 mdiodev->addr = addr;
Andrew Lunn7f854422016-01-06 20:11:18 +0100595 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
Andrew Lunn711fdba2016-01-06 20:11:27 +0100596 mdiodev->device_free = phy_mdio_device_free;
597 mdiodev->device_remove = phy_mdio_device_remove;
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300598
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700599 dev->speed = 0;
600 dev->duplex = -1;
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300601 dev->pause = 0;
602 dev->asym_pause = 0;
Heiner Kallweitc69851e2018-03-11 15:00:37 +0100603 dev->link = 0;
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600604 dev->interface = PHY_INTERFACE_MODE_GMII;
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700605
606 dev->autoneg = AUTONEG_ENABLE;
607
David Daneyac28b9f2012-06-27 07:33:35 +0000608 dev->is_c45 = is_c45;
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700609 dev->phy_id = phy_id;
David Daneyac28b9f2012-06-27 07:33:35 +0000610 if (c45_ids)
611 dev->c45_ids = *c45_ids;
Dan Carpenter47b356e2016-01-12 12:36:21 +0300612 dev->irq = bus->irq[addr];
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100613 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700614
615 dev->state = PHY_DOWN;
616
Nate Case35b5f6b2008-01-29 10:05:09 -0600617 mutex_init(&dev->lock);
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000618 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700619
David Woodhouse8626d3b2010-04-02 01:05:27 +0000620 /* Request the appropriate module unconditionally; don't
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300621 * bother trying to do so only if it isn't already loaded,
622 * because that gets complicated. A hotplug event would have
623 * done an unconditional modprobe anyway.
624 * We don't do normal hotplug because it won't work for MDIO
625 * -- because it relies on the device staying around for long
626 * enough for the driver to get loaded. With MDIO, the NIC
627 * driver will get bored and give up as soon as it finds that
628 * there's no driver _already_ loaded.
629 */
Jose Abreu30fcd6a2018-12-02 16:33:14 +0100630 if (is_c45 && c45_ids) {
631 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
632 int i;
633
634 for (i = 1; i < num_ids; i++) {
635 if (!(c45_ids->devices_in_package & (1 << i)))
636 continue;
637
Heiner Kallweit13d0ab62019-01-16 08:07:38 +0100638 ret = phy_request_driver_module(dev,
639 c45_ids->device_ids[i]);
640 if (ret)
641 break;
Jose Abreu30fcd6a2018-12-02 16:33:14 +0100642 }
643 } else {
Heiner Kallweit13d0ab62019-01-16 08:07:38 +0100644 ret = phy_request_driver_module(dev, phy_id);
Jose Abreu30fcd6a2018-12-02 16:33:14 +0100645 }
David Woodhouse8626d3b2010-04-02 01:05:27 +0000646
Heiner Kallweit13d0ab62019-01-16 08:07:38 +0100647 if (!ret) {
648 device_initialize(&mdiodev->dev);
649 } else {
650 kfree(dev);
651 dev = ERR_PTR(ret);
652 }
Petr Malatb2a43192013-02-28 01:01:52 +0000653
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700654 return dev;
655}
David Daneyac28b9f2012-06-27 07:33:35 +0000656EXPORT_SYMBOL(phy_device_create);
657
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800658/* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
659 * @bus: the target MII bus
660 * @addr: PHY address on the MII bus
661 * @dev_addr: MMD address in the PHY.
662 * @devices_in_package: where to store the devices in package information.
663 *
664 * Description: reads devices in package registers of a MMD at @dev_addr
665 * from PHY at @addr on @bus.
666 *
667 * Returns: 0 on success, -EIO on failure.
668 */
669static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
670 u32 *devices_in_package)
671{
672 int phy_reg, reg_addr;
673
674 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
675 phy_reg = mdiobus_read(bus, addr, reg_addr);
676 if (phy_reg < 0)
677 return -EIO;
Heiner Kallweit50684da2019-02-09 09:46:53 +0100678 *devices_in_package = phy_reg << 16;
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800679
680 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
681 phy_reg = mdiobus_read(bus, addr, reg_addr);
682 if (phy_reg < 0)
683 return -EIO;
Heiner Kallweit50684da2019-02-09 09:46:53 +0100684 *devices_in_package |= phy_reg;
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800685
Heiner Kallweit3b5e74e2019-02-08 19:25:22 +0100686 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
687 *devices_in_package &= ~BIT(0);
688
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800689 return 0;
690}
691
David Daneyac28b9f2012-06-27 07:33:35 +0000692/**
693 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
694 * @bus: the target MII bus
695 * @addr: PHY address on the MII bus
696 * @phy_id: where to store the ID retrieved.
697 * @c45_ids: where to store the c45 ID information.
698 *
699 * If the PHY devices-in-package appears to be valid, it and the
700 * corresponding identifiers are stored in @c45_ids, zero is stored
701 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
702 * zero on success.
703 *
704 */
705static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
706 struct phy_c45_device_ids *c45_ids) {
707 int phy_reg;
708 int i, reg_addr;
709 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800710 u32 *devs = &c45_ids->devices_in_package;
David Daneyac28b9f2012-06-27 07:33:35 +0000711
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800712 /* Find first non-zero Devices In package. Device zero is reserved
713 * for 802.3 c45 complied PHYs, so don't probe it at first.
David Daneyac28b9f2012-06-27 07:33:35 +0000714 */
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800715 for (i = 1; i < num_ids && *devs == 0; i++) {
716 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
David Daneyac28b9f2012-06-27 07:33:35 +0000717 if (phy_reg < 0)
718 return -EIO;
David Daneyac28b9f2012-06-27 07:33:35 +0000719
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800720 if ((*devs & 0x1fffffff) == 0x1fffffff) {
721 /* If mostly Fs, there is no device there,
722 * then let's continue to probe more, as some
723 * 10G PHYs have zero Devices In package,
724 * e.g. Cortina CS4315/CS4340 PHY.
725 */
726 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
727 if (phy_reg < 0)
728 return -EIO;
729 /* no device there, let's get out of here */
730 if ((*devs & 0x1fffffff) == 0x1fffffff) {
Shengzhou Liuda1da282015-06-26 17:58:52 +0800731 *phy_id = 0xffffffff;
732 return 0;
Shaohui Xie5f6c99e2015-11-03 12:27:33 +0800733 } else {
734 break;
Shengzhou Liuda1da282015-06-26 17:58:52 +0800735 }
David Daneyac28b9f2012-06-27 07:33:35 +0000736 }
737 }
738
739 /* Now probe Device Identifiers for each device present. */
740 for (i = 1; i < num_ids; i++) {
741 if (!(c45_ids->devices_in_package & (1 << i)))
742 continue;
743
744 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
745 phy_reg = mdiobus_read(bus, addr, reg_addr);
746 if (phy_reg < 0)
747 return -EIO;
Heiner Kallweit50684da2019-02-09 09:46:53 +0100748 c45_ids->device_ids[i] = phy_reg << 16;
David Daneyac28b9f2012-06-27 07:33:35 +0000749
750 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
751 phy_reg = mdiobus_read(bus, addr, reg_addr);
752 if (phy_reg < 0)
753 return -EIO;
Heiner Kallweit50684da2019-02-09 09:46:53 +0100754 c45_ids->device_ids[i] |= phy_reg;
David Daneyac28b9f2012-06-27 07:33:35 +0000755 }
756 *phy_id = 0;
757 return 0;
758}
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700759
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800760/**
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400761 * get_phy_id - reads the specified addr for its ID.
762 * @bus: the target MII bus
763 * @addr: PHY address on the MII bus
764 * @phy_id: where to store the ID retrieved.
David Daneyac28b9f2012-06-27 07:33:35 +0000765 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
766 * @c45_ids: where to store the c45 ID information.
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400767 *
David Daneyac28b9f2012-06-27 07:33:35 +0000768 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
769 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
770 * zero on success.
771 *
772 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
773 * its return value is in turn returned.
774 *
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400775 */
David Daneyac28b9f2012-06-27 07:33:35 +0000776static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
777 bool is_c45, struct phy_c45_device_ids *c45_ids)
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400778{
779 int phy_reg;
780
David Daneyac28b9f2012-06-27 07:33:35 +0000781 if (is_c45)
782 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
783
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300784 /* Grab the bits from PHYIR1, and put them in the upper half */
David Daney6fe32642011-09-30 11:51:22 +0000785 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
Alexandre Belloni02a6efc2018-04-24 18:09:04 +0200786 if (phy_reg < 0) {
Heiner Kallweitd8cce3a2019-01-16 19:52:51 +0100787 /* returning -ENODEV doesn't stop bus scanning */
788 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
Alexandre Belloni02a6efc2018-04-24 18:09:04 +0200789 }
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400790
Heiner Kallweit50684da2019-02-09 09:46:53 +0100791 *phy_id = phy_reg << 16;
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400792
793 /* Grab the bits from PHYIR2, and put them in the lower half */
David Daney6fe32642011-09-30 11:51:22 +0000794 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400795 if (phy_reg < 0)
796 return -EIO;
797
Heiner Kallweit50684da2019-02-09 09:46:53 +0100798 *phy_id |= phy_reg;
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400799
800 return 0;
801}
802
803/**
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300804 * get_phy_device - reads the specified PHY device and returns its @phy_device
805 * struct
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800806 * @bus: the target MII bus
807 * @addr: PHY address on the MII bus
David Daneyac28b9f2012-06-27 07:33:35 +0000808 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
Andy Fleming00db8182005-07-30 19:31:23 -0400809 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800810 * Description: Reads the ID registers of the PHY at @addr on the
811 * @bus, then allocates and returns the phy_device to represent it.
Andy Fleming00db8182005-07-30 19:31:23 -0400812 */
David Daneyac28b9f2012-06-27 07:33:35 +0000813struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
Andy Fleming00db8182005-07-30 19:31:23 -0400814{
David Daneyac28b9f2012-06-27 07:33:35 +0000815 struct phy_c45_device_ids c45_ids = {0};
David S. Miller160c85f2012-06-27 21:28:14 -0700816 u32 phy_id = 0;
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400817 int r;
Andy Fleming00db8182005-07-30 19:31:23 -0400818
David Daneyac28b9f2012-06-27 07:33:35 +0000819 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400820 if (r)
821 return ERR_PTR(r);
Andy Fleming00db8182005-07-30 19:31:23 -0400822
Giuseppe Cavallaro6436cbc2008-11-20 20:43:18 -0800823 /* If the phy_id is mostly Fs, there is no device there */
824 if ((phy_id & 0x1fffffff) == 0x1fffffff)
Sergei Shtylyovb74766a2016-04-24 20:25:23 +0300825 return ERR_PTR(-ENODEV);
Giuseppe Cavallaro6436cbc2008-11-20 20:43:18 -0800826
Sergei Shtylyove62a7682014-01-05 03:21:52 +0300827 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
Andy Fleming00db8182005-07-30 19:31:23 -0400828}
Grant Likely4dea5472009-04-25 12:52:46 +0000829EXPORT_SYMBOL(get_phy_device);
830
831/**
832 * phy_device_register - Register the phy device on the MDIO bus
Randy Dunlap1d4ac5d2009-06-16 16:56:33 +0000833 * @phydev: phy_device structure to be added to the MDIO bus
Grant Likely4dea5472009-04-25 12:52:46 +0000834 */
835int phy_device_register(struct phy_device *phydev)
836{
837 int err;
838
Andrew Lunn7f854422016-01-06 20:11:18 +0100839 err = mdiobus_register_device(&phydev->mdio);
840 if (err)
841 return err;
Grant Likely4dea5472009-04-25 12:52:46 +0000842
Sergei Shtylyovbafbdd52017-12-04 13:35:05 +0100843 /* Deassert the reset signal */
844 phy_device_reset(phydev, 0);
845
Grant Likely4dea5472009-04-25 12:52:46 +0000846 /* Run all of the fixups for this PHY */
Florian Fainellid92f5de2014-07-28 16:28:07 -0700847 err = phy_scan_fixups(phydev);
Florian Fainelli87aa9f92013-12-06 13:01:34 -0800848 if (err) {
Heiner Kallweitc3a6a172019-01-15 21:50:25 +0100849 phydev_err(phydev, "failed to initialize\n");
Florian Fainelli87aa9f92013-12-06 13:01:34 -0800850 goto out;
851 }
Grant Likely4dea5472009-04-25 12:52:46 +0000852
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100853 err = device_add(&phydev->mdio.dev);
Grant Likely4dea5472009-04-25 12:52:46 +0000854 if (err) {
Heiner Kallweitc3a6a172019-01-15 21:50:25 +0100855 phydev_err(phydev, "failed to add\n");
Grant Likely4dea5472009-04-25 12:52:46 +0000856 goto out;
857 }
858
859 return 0;
860
861 out:
Sergei Shtylyovbafbdd52017-12-04 13:35:05 +0100862 /* Assert the reset signal */
863 phy_device_reset(phydev, 1);
864
Andrew Lunn7f854422016-01-06 20:11:18 +0100865 mdiobus_unregister_device(&phydev->mdio);
Grant Likely4dea5472009-04-25 12:52:46 +0000866 return err;
867}
868EXPORT_SYMBOL(phy_device_register);
Andy Fleming00db8182005-07-30 19:31:23 -0400869
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800870/**
Russell King38737e42015-09-24 20:36:28 +0100871 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
872 * @phydev: phy_device structure to remove
873 *
874 * This doesn't free the phy_device itself, it merely reverses the effects
875 * of phy_device_register(). Use phy_device_free() to free the device
876 * after calling this function.
877 */
878void phy_device_remove(struct phy_device *phydev)
879{
Andrew Lunne5a03bf2016-01-06 20:11:16 +0100880 device_del(&phydev->mdio.dev);
Sergei Shtylyovbafbdd52017-12-04 13:35:05 +0100881
882 /* Assert the reset signal */
883 phy_device_reset(phydev, 1);
884
Andrew Lunn7f854422016-01-06 20:11:18 +0100885 mdiobus_unregister_device(&phydev->mdio);
Russell King38737e42015-09-24 20:36:28 +0100886}
887EXPORT_SYMBOL(phy_device_remove);
888
889/**
Jiri Pirkof8f76db2010-02-04 10:23:02 -0800890 * phy_find_first - finds the first PHY device on the bus
891 * @bus: the target MII bus
892 */
893struct phy_device *phy_find_first(struct mii_bus *bus)
894{
Andrew Lunn7f854422016-01-06 20:11:18 +0100895 struct phy_device *phydev;
Jiri Pirkof8f76db2010-02-04 10:23:02 -0800896 int addr;
897
898 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
Andrew Lunn7f854422016-01-06 20:11:18 +0100899 phydev = mdiobus_get_phy(bus, addr);
900 if (phydev)
901 return phydev;
Jiri Pirkof8f76db2010-02-04 10:23:02 -0800902 }
903 return NULL;
904}
905EXPORT_SYMBOL(phy_find_first);
906
Russell Kinga81497b2017-07-25 15:02:58 +0100907static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
908{
909 struct net_device *netdev = phydev->attached_dev;
910
911 if (do_carrier) {
912 if (up)
913 netif_carrier_on(netdev);
914 else
915 netif_carrier_off(netdev);
916 }
917 phydev->adjust_link(netdev);
918}
919
Jiri Pirkof8f76db2010-02-04 10:23:02 -0800920/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800921 * phy_prepare_link - prepares the PHY layer to monitor link status
922 * @phydev: target phy_device struct
923 * @handler: callback function for link status change notifications
Andy Fleming00db8182005-07-30 19:31:23 -0400924 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800925 * Description: Tells the PHY infrastructure to handle the
Andy Fleming00db8182005-07-30 19:31:23 -0400926 * gory details on monitoring link status (whether through
927 * polling or an interrupt), and to call back to the
928 * connected device driver when the link status changes.
929 * If you want to monitor your own link state, don't call
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800930 * this function.
931 */
stephen hemminger89ff05e2010-10-21 08:37:41 +0000932static void phy_prepare_link(struct phy_device *phydev,
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300933 void (*handler)(struct net_device *))
Andy Fleming00db8182005-07-30 19:31:23 -0400934{
935 phydev->adjust_link = handler;
936}
937
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800938/**
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000939 * phy_connect_direct - connect an ethernet device to a specific phy_device
940 * @dev: the network device to connect
941 * @phydev: the pointer to the phy device
942 * @handler: callback function for state change notifications
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000943 * @interface: PHY device's interface
944 */
945int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
Florian Fainellif9a8f832013-01-14 00:52:52 +0000946 void (*handler)(struct net_device *),
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000947 phy_interface_t interface)
948{
949 int rc;
950
Ioana Ciornei82c76ac2019-05-28 20:38:09 +0300951 if (!dev)
952 return -EINVAL;
953
Florian Fainellif9a8f832013-01-14 00:52:52 +0000954 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000955 if (rc)
956 return rc;
957
958 phy_prepare_link(phydev, handler);
Heiner Kallweit434a4312019-01-23 07:31:58 +0100959 if (phy_interrupt_is_valid(phydev))
960 phy_request_interrupt(phydev);
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000961
962 return 0;
963}
964EXPORT_SYMBOL(phy_connect_direct);
965
966/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800967 * phy_connect - connect an ethernet device to a PHY device
968 * @dev: the network device to connect
Randy Dunlap5d12b132008-04-28 10:58:22 -0700969 * @bus_id: the id string of the PHY device to connect
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800970 * @handler: callback function for state change notifications
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800971 * @interface: PHY device's interface
Andy Fleminge1393452005-08-24 18:46:21 -0500972 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800973 * Description: Convenience function for connecting ethernet
Andy Fleminge1393452005-08-24 18:46:21 -0500974 * devices to PHY devices. The default behavior is for
975 * the PHY infrastructure to handle everything, and only notify
976 * the connected driver when the link status changes. If you
977 * don't want, or can't use the provided functionality, you may
978 * choose to call only the subset of functions which provide
979 * the desired functionality.
980 */
Florian Fainellie1093742013-12-17 21:38:12 -0800981struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300982 void (*handler)(struct net_device *),
983 phy_interface_t interface)
Andy Fleminge1393452005-08-24 18:46:21 -0500984{
985 struct phy_device *phydev;
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000986 struct device *d;
987 int rc;
Andy Fleminge1393452005-08-24 18:46:21 -0500988
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000989 /* Search the list of PHY devices on the mdio bus for the
Sergei Shtylyov2f53e902014-01-05 03:17:06 +0300990 * PHY with the requested name
991 */
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000992 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
993 if (!d) {
994 pr_err("PHY %s not found\n", bus_id);
995 return ERR_PTR(-ENODEV);
996 }
997 phydev = to_phy_device(d);
Andy Fleminge1393452005-08-24 18:46:21 -0500998
Florian Fainellif9a8f832013-01-14 00:52:52 +0000999 rc = phy_connect_direct(dev, phydev, handler, interface);
Johan Hovold17ae1c62016-11-03 18:40:19 +01001000 put_device(d);
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001001 if (rc)
1002 return ERR_PTR(rc);
Andy Fleminge1393452005-08-24 18:46:21 -05001003
1004 return phydev;
1005}
1006EXPORT_SYMBOL(phy_connect);
1007
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001008/**
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001009 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1010 * device
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001011 * @phydev: target phy_device struct
1012 */
Andy Fleminge1393452005-08-24 18:46:21 -05001013void phy_disconnect(struct phy_device *phydev)
1014{
Heiner Kallweit472115d2019-01-17 20:07:54 +01001015 if (phy_is_started(phydev))
1016 phy_stop(phydev);
1017
Heiner Kallweitbb658ab2019-01-17 20:09:21 +01001018 if (phy_interrupt_is_valid(phydev))
Heiner Kallweit07b09282019-05-30 15:09:15 +02001019 phy_free_interrupt(phydev);
Andy Fleminge1393452005-08-24 18:46:21 -05001020
Andy Fleminge1393452005-08-24 18:46:21 -05001021 phydev->adjust_link = NULL;
1022
1023 phy_detach(phydev);
1024}
1025EXPORT_SYMBOL(phy_disconnect);
1026
Florian Fainelli87aa9f92013-12-06 13:01:34 -08001027/**
1028 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1029 * @phydev: The PHY device to poll
1030 *
1031 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1032 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1033 * register must be polled until the BMCR_RESET bit clears.
1034 *
1035 * Furthermore, any attempts to write to PHY registers may have no effect
1036 * or even generate MDIO bus errors until this is complete.
1037 *
1038 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1039 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1040 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1041 * effort to support such broken PHYs, this function is separate from the
1042 * standard phy_init_hw() which will zero all the other bits in the BMCR
1043 * and reapply all driver-specific and board-specific fixups.
1044 */
1045static int phy_poll_reset(struct phy_device *phydev)
1046{
1047 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1048 unsigned int retries = 12;
1049 int ret;
1050
1051 do {
1052 msleep(50);
1053 ret = phy_read(phydev, MII_BMCR);
1054 if (ret < 0)
1055 return ret;
1056 } while (ret & BMCR_RESET && --retries);
1057 if (ret & BMCR_RESET)
1058 return -ETIMEDOUT;
1059
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001060 /* Some chips (smsc911x) may still need up to another 1ms after the
Florian Fainelli87aa9f92013-12-06 13:01:34 -08001061 * BMCR_RESET bit is cleared before they are usable.
1062 */
1063 msleep(1);
1064 return 0;
1065}
1066
Anton Vorontsov2f5cb432009-12-30 08:23:30 +00001067int phy_init_hw(struct phy_device *phydev)
1068{
Florian Fainelli9df81dd2014-02-17 13:34:03 -08001069 int ret = 0;
Anton Vorontsov2f5cb432009-12-30 08:23:30 +00001070
Sergei Shtylyovbafbdd52017-12-04 13:35:05 +01001071 /* Deassert the reset signal */
1072 phy_device_reset(phydev, 0);
1073
Heiner Kallweita5996982019-01-19 10:43:07 +01001074 if (!phydev->drv)
Anton Vorontsov2f5cb432009-12-30 08:23:30 +00001075 return 0;
1076
Florian Fainelli9df81dd2014-02-17 13:34:03 -08001077 if (phydev->drv->soft_reset)
1078 ret = phydev->drv->soft_reset(phydev);
Florian Fainelli9df81dd2014-02-17 13:34:03 -08001079
Florian Fainelli87aa9f92013-12-06 13:01:34 -08001080 if (ret < 0)
1081 return ret;
1082
Anton Vorontsov2f5cb432009-12-30 08:23:30 +00001083 ret = phy_scan_fixups(phydev);
1084 if (ret < 0)
1085 return ret;
1086
Heiner Kallweita5996982019-01-19 10:43:07 +01001087 if (phydev->drv->config_init)
1088 ret = phydev->drv->config_init(phydev);
1089
1090 return ret;
Anton Vorontsov2f5cb432009-12-30 08:23:30 +00001091}
Florian Fainelli87aa9f92013-12-06 13:01:34 -08001092EXPORT_SYMBOL(phy_init_hw);
Anton Vorontsov2f5cb432009-12-30 08:23:30 +00001093
Andrew Lunn22209432016-01-06 20:11:13 +01001094void phy_attached_info(struct phy_device *phydev)
1095{
1096 phy_attached_print(phydev, NULL);
1097}
1098EXPORT_SYMBOL(phy_attached_info);
1099
Romain Perier5e369ae2017-09-04 10:41:36 +02001100#define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
Andrew Lunn22209432016-01-06 20:11:13 +01001101void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1102{
Florian Fainellifcd03e32017-08-22 14:26:47 -07001103 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
Romain Perier5e369ae2017-09-04 10:41:36 +02001104 char *irq_str;
Geert Uytterhoeven059fbe82017-09-21 13:27:02 +02001105 char irq_num[8];
Romain Perier5e369ae2017-09-04 10:41:36 +02001106
1107 switch(phydev->irq) {
1108 case PHY_POLL:
1109 irq_str = "POLL";
1110 break;
1111 case PHY_IGNORE_INTERRUPT:
1112 irq_str = "IGNORE";
1113 break;
1114 default:
1115 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1116 irq_str = irq_num;
1117 break;
1118 }
1119
Florian Fainellifcd03e32017-08-22 14:26:47 -07001120
Andrew Lunn22209432016-01-06 20:11:13 +01001121 if (!fmt) {
Andrew Lunnc4fabb82018-09-29 23:04:11 +02001122 phydev_info(phydev, ATTACHED_FMT "\n",
Florian Fainellifcd03e32017-08-22 14:26:47 -07001123 drv_name, phydev_name(phydev),
Romain Perier5e369ae2017-09-04 10:41:36 +02001124 irq_str);
Andrew Lunn22209432016-01-06 20:11:13 +01001125 } else {
1126 va_list ap;
1127
Andrew Lunnc4fabb82018-09-29 23:04:11 +02001128 phydev_info(phydev, ATTACHED_FMT,
Florian Fainellifcd03e32017-08-22 14:26:47 -07001129 drv_name, phydev_name(phydev),
Romain Perier5e369ae2017-09-04 10:41:36 +02001130 irq_str);
Andrew Lunn22209432016-01-06 20:11:13 +01001131
1132 va_start(ap, fmt);
1133 vprintk(fmt, ap);
1134 va_end(ap);
1135 }
1136}
1137EXPORT_SYMBOL(phy_attached_print);
1138
Vladimir Oltean53cfca22019-05-28 20:38:07 +03001139static void phy_sysfs_create_links(struct phy_device *phydev)
1140{
1141 struct net_device *dev = phydev->attached_dev;
1142 int err;
1143
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001144 if (!dev)
1145 return;
1146
Vladimir Oltean53cfca22019-05-28 20:38:07 +03001147 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1148 "attached_dev");
1149 if (err)
1150 return;
1151
1152 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1153 &phydev->mdio.dev.kobj,
1154 "phydev");
1155 if (err) {
1156 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1157 kobject_name(&phydev->mdio.dev.kobj),
1158 err);
1159 /* non-fatal - some net drivers can use one netdevice
1160 * with more then one phy
1161 */
1162 }
1163
1164 phydev->sysfs_links = true;
1165}
1166
Ioana Ciorneic920f742019-05-28 20:38:10 +03001167static ssize_t
1168phy_standalone_show(struct device *dev, struct device_attribute *attr,
1169 char *buf)
1170{
1171 struct phy_device *phydev = to_phy_device(dev);
1172
1173 return sprintf(buf, "%d\n", !phydev->attached_dev);
1174}
1175static DEVICE_ATTR_RO(phy_standalone);
1176
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001177/**
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001178 * phy_attach_direct - attach a network device to a given PHY device pointer
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001179 * @dev: network device to attach
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001180 * @phydev: Pointer to phy_device to attach
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001181 * @flags: PHY device's dev_flags
1182 * @interface: PHY device's interface
1183 *
1184 * Description: Called by drivers to attach to a particular PHY
1185 * device. The phy_device is found, and properly hooked up
Andy Fleming257184d2014-01-10 14:27:54 +08001186 * to the phy_driver. If no driver is attached, then a
1187 * generic driver is used. The phy_device is given a ptr to
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001188 * the attaching device, and given a callback for link status
1189 * change. The phy_device is returned to the attaching driver.
Russell King73229672015-09-24 20:36:08 +01001190 * This function takes a reference on the phy device.
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001191 */
Andy Fleming257184d2014-01-10 14:27:54 +08001192int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1193 u32 flags, phy_interface_t interface)
Andy Fleminge1393452005-08-24 18:46:21 -05001194{
Andrew Lunne5a03bf2016-01-06 20:11:16 +01001195 struct mii_bus *bus = phydev->mdio.bus;
1196 struct device *d = &phydev->mdio.dev;
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001197 struct module *ndev_owner = NULL;
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001198 bool using_genphy = false;
Marc Kleine-Budded005a092011-03-28 14:54:08 +00001199 int err;
Andy Fleminge1393452005-08-24 18:46:21 -05001200
Florian Fainelliec988ad2016-12-06 20:54:43 -08001201 /* For Ethernet device drivers that register their own MDIO bus, we
1202 * will have bus->owner match ndev_mod, so we do not want to increment
1203 * our own module->refcnt here, otherwise we would not be able to
1204 * unload later on.
1205 */
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001206 if (dev)
1207 ndev_owner = dev->dev.parent->driver->owner;
Florian Fainelliec988ad2016-12-06 20:54:43 -08001208 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001209 phydev_err(phydev, "failed to get the bus module\n");
Russell King3e3aaf62015-09-24 20:36:02 +01001210 return -EIO;
1211 }
1212
Russell King73229672015-09-24 20:36:08 +01001213 get_device(d);
1214
Andy Fleminge1393452005-08-24 18:46:21 -05001215 /* Assume that if there is no driver, that it doesn't
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001216 * exist, and we should use the genphy driver.
1217 */
Sergei Shtylyovef899c02015-08-28 21:35:14 +03001218 if (!d->driver) {
Andy Fleming257184d2014-01-10 14:27:54 +08001219 if (phydev->is_c45)
Heiner Kallweit22b56e82019-04-07 13:55:01 +02001220 d->driver = &genphy_c45_driver.mdiodrv.driver;
Andy Fleming257184d2014-01-10 14:27:54 +08001221 else
Russell King921690f2017-06-05 12:23:05 +01001222 d->driver = &genphy_driver.mdiodrv.driver;
Andy Fleminge1393452005-08-24 18:46:21 -05001223
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001224 using_genphy = true;
1225 }
1226
1227 if (!try_module_get(d->driver->owner)) {
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001228 phydev_err(phydev, "failed to get the device driver module\n");
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001229 err = -EIO;
1230 goto error_put_device;
1231 }
1232
1233 if (using_genphy) {
Andy Fleminge1393452005-08-24 18:46:21 -05001234 err = d->driver->probe(d);
Jeff Garzikb7a00ec2006-10-01 07:27:46 -04001235 if (err >= 0)
1236 err = device_bind_driver(d);
Andy Fleminge1393452005-08-24 18:46:21 -05001237
Jeff Garzikb7a00ec2006-10-01 07:27:46 -04001238 if (err)
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001239 goto error_module_put;
Andy Fleminge1393452005-08-24 18:46:21 -05001240 }
1241
1242 if (phydev->attached_dev) {
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001243 dev_err(&dev->dev, "PHY already attached\n");
Russell King3e3aaf62015-09-24 20:36:02 +01001244 err = -EBUSY;
1245 goto error;
Ezequiel Garciab3565f22014-07-23 16:47:32 -03001246 }
1247
Russell Kinga81497b2017-07-25 15:02:58 +01001248 phydev->phy_link_change = phy_link_change;
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001249 if (dev) {
1250 phydev->attached_dev = dev;
1251 dev->phydev = phydev;
1252 }
Florian Fainellia3995462017-05-27 10:42:25 -07001253
1254 /* Some Ethernet drivers try to connect to a PHY device before
1255 * calling register_netdevice() -> netdev_register_kobject() and
1256 * does the dev->dev.kobj initialization. Here we only check for
1257 * success which indicates that the network device kobject is
1258 * ready. Once we do that we still need to keep track of whether
1259 * links were successfully set up or not for phy_detach() to
1260 * remove them accordingly.
1261 */
1262 phydev->sysfs_links = false;
1263
Vladimir Oltean53cfca22019-05-28 20:38:07 +03001264 phy_sysfs_create_links(phydev);
Andy Fleminge1393452005-08-24 18:46:21 -05001265
Ioana Ciorneic920f742019-05-28 20:38:10 +03001266 if (!phydev->attached_dev) {
1267 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1268 &dev_attr_phy_standalone.attr);
1269 if (err)
1270 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1271 }
1272
Andy Fleminge1393452005-08-24 18:46:21 -05001273 phydev->dev_flags = flags;
1274
Andy Fleminge8a2b6a2006-12-01 12:01:06 -06001275 phydev->interface = interface;
1276
Anton Vorontsovef24b162010-08-24 14:46:12 -07001277 phydev->state = PHY_READY;
1278
Sjoerd Simons113c74d2016-01-14 21:57:18 +01001279 /* Initial carrier state is off as the phy is about to be
1280 * (re)initialized.
1281 */
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001282 if (dev)
1283 netif_carrier_off(phydev->attached_dev);
Sjoerd Simons113c74d2016-01-14 21:57:18 +01001284
Andy Fleminge8a2b6a2006-12-01 12:01:06 -06001285 /* Do initial configuration here, now that
1286 * we have certain key parameters
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001287 * (dev_flags and interface)
1288 */
Marc Kleine-Budded005a092011-03-28 14:54:08 +00001289 err = phy_init_hw(phydev);
1290 if (err)
Woojung Huha7dac9f2016-11-23 23:10:33 +00001291 goto error;
Sebastian Hesselbarth1211ce52013-12-13 10:20:28 +01001292
Woojung Huha7dac9f2016-11-23 23:10:33 +00001293 phy_resume(phydev);
Zach Brown2e0bc452016-10-17 10:49:55 -05001294 phy_led_triggers_register(phydev);
1295
Marc Kleine-Budded005a092011-03-28 14:54:08 +00001296 return err;
Russell King3e3aaf62015-09-24 20:36:02 +01001297
1298error:
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001299 /* phy_detach() does all of the cleanup below */
Woojung Huha7dac9f2016-11-23 23:10:33 +00001300 phy_detach(phydev);
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001301 return err;
1302
1303error_module_put:
Mao Wenancafe8df2017-01-31 18:46:43 -08001304 module_put(d->driver->owner);
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001305error_put_device:
1306 put_device(d);
Florian Fainelliec988ad2016-12-06 20:54:43 -08001307 if (ndev_owner != bus->owner)
1308 module_put(bus->owner);
Russell King3e3aaf62015-09-24 20:36:02 +01001309 return err;
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001310}
Andy Fleming257184d2014-01-10 14:27:54 +08001311EXPORT_SYMBOL(phy_attach_direct);
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001312
1313/**
1314 * phy_attach - attach a network device to a particular PHY device
1315 * @dev: network device to attach
1316 * @bus_id: Bus ID of PHY device to attach
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001317 * @interface: PHY device's interface
1318 *
1319 * Description: Same as phy_attach_direct() except that a PHY bus_id
1320 * string is passed instead of a pointer to a struct phy_device.
1321 */
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001322struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1323 phy_interface_t interface)
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001324{
1325 struct bus_type *bus = &mdio_bus_type;
1326 struct phy_device *phydev;
1327 struct device *d;
1328 int rc;
1329
Ioana Ciornei82c76ac2019-05-28 20:38:09 +03001330 if (!dev)
1331 return ERR_PTR(-EINVAL);
1332
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001333 /* Search the list of PHY devices on the mdio bus for the
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001334 * PHY with the requested name
1335 */
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001336 d = bus_find_device_by_name(bus, NULL, bus_id);
1337 if (!d) {
1338 pr_err("PHY %s not found\n", bus_id);
1339 return ERR_PTR(-ENODEV);
1340 }
1341 phydev = to_phy_device(d);
1342
Florian Fainellif9a8f832013-01-14 00:52:52 +00001343 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
Johan Hovold17ae1c62016-11-03 18:40:19 +01001344 put_device(d);
Grant Likelyfa94f6d2009-04-25 12:52:51 +00001345 if (rc)
1346 return ERR_PTR(rc);
1347
Andy Fleminge1393452005-08-24 18:46:21 -05001348 return phydev;
1349}
1350EXPORT_SYMBOL(phy_attach);
1351
Florian Fainelli5db5ea92019-01-15 15:09:35 -08001352static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1353 struct device_driver *driver)
1354{
1355 struct device *d = &phydev->mdio.dev;
1356 bool ret = false;
1357
1358 if (!phydev->drv)
1359 return ret;
1360
1361 get_device(d);
1362 ret = d->driver == driver;
1363 put_device(d);
1364
1365 return ret;
1366}
1367
1368bool phy_driver_is_genphy(struct phy_device *phydev)
1369{
1370 return phy_driver_is_genphy_kind(phydev,
1371 &genphy_driver.mdiodrv.driver);
1372}
1373EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1374
1375bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1376{
1377 return phy_driver_is_genphy_kind(phydev,
Heiner Kallweit22b56e82019-04-07 13:55:01 +02001378 &genphy_c45_driver.mdiodrv.driver);
Florian Fainelli5db5ea92019-01-15 15:09:35 -08001379}
1380EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1381
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001382/**
1383 * phy_detach - detach a PHY device from its network device
1384 * @phydev: target phy_device struct
Russell King73229672015-09-24 20:36:08 +01001385 *
1386 * This detaches the phy device from its network device and the phy
1387 * driver, and drops the reference count taken in phy_attach_direct().
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001388 */
Andy Fleminge1393452005-08-24 18:46:21 -05001389void phy_detach(struct phy_device *phydev)
1390{
Florian Fainelliec988ad2016-12-06 20:54:43 -08001391 struct net_device *dev = phydev->attached_dev;
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001392 struct module *ndev_owner = NULL;
Russell King3e3aaf62015-09-24 20:36:02 +01001393 struct mii_bus *bus;
Ezequiel Garciab3565f22014-07-23 16:47:32 -03001394
Florian Fainellia3995462017-05-27 10:42:25 -07001395 if (phydev->sysfs_links) {
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001396 if (dev)
1397 sysfs_remove_link(&dev->dev.kobj, "phydev");
Florian Fainellia3995462017-05-27 10:42:25 -07001398 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1399 }
Ioana Ciorneic920f742019-05-28 20:38:10 +03001400
1401 if (!phydev->attached_dev)
1402 sysfs_remove_file(&phydev->mdio.dev.kobj,
1403 &dev_attr_phy_standalone.attr);
1404
Heiner Kallweit93f41e62018-09-24 22:01:32 +02001405 phy_suspend(phydev);
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001406 if (dev) {
1407 phydev->attached_dev->phydev = NULL;
1408 phydev->attached_dev = NULL;
1409 }
Russell King9525ae82017-07-25 15:03:13 +01001410 phydev->phylink = NULL;
Andy Fleminge1393452005-08-24 18:46:21 -05001411
Geert Uytterhoeven0075bd62016-11-28 15:18:31 +01001412 phy_led_triggers_unregister(phydev);
1413
Florian Fainelli6d9f66a2017-02-08 19:05:26 -08001414 module_put(phydev->mdio.dev.driver->owner);
1415
Andy Fleminge1393452005-08-24 18:46:21 -05001416 /* If the device had no specific driver before (i.e. - it
1417 * was using the generic driver), we unbind the device
1418 * from the generic driver so that there's a chance a
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001419 * real driver could be loaded
1420 */
Florian Fainelli5db5ea92019-01-15 15:09:35 -08001421 if (phy_driver_is_genphy(phydev) ||
1422 phy_driver_is_genphy_10g(phydev))
Russell King921690f2017-06-05 12:23:05 +01001423 device_release_driver(&phydev->mdio.dev);
Russell King3e3aaf62015-09-24 20:36:02 +01001424
Russell King73229672015-09-24 20:36:08 +01001425 /*
1426 * The phydev might go away on the put_device() below, so avoid
1427 * a use-after-free bug by reading the underlying bus first.
1428 */
Andrew Lunne5a03bf2016-01-06 20:11:16 +01001429 bus = phydev->mdio.bus;
Russell King3e3aaf62015-09-24 20:36:02 +01001430
Andrew Lunne5a03bf2016-01-06 20:11:16 +01001431 put_device(&phydev->mdio.dev);
Ioana Ciornei2db2d9d12019-05-28 20:38:08 +03001432 if (dev)
1433 ndev_owner = dev->dev.parent->driver->owner;
Florian Fainelliec988ad2016-12-06 20:54:43 -08001434 if (ndev_owner != bus->owner)
1435 module_put(bus->owner);
Sergei Shtylyovbafbdd52017-12-04 13:35:05 +01001436
1437 /* Assert the reset signal */
1438 phy_device_reset(phydev, 1);
Andy Fleminge1393452005-08-24 18:46:21 -05001439}
1440EXPORT_SYMBOL(phy_detach);
1441
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001442int phy_suspend(struct phy_device *phydev)
1443{
Andrew Lunne5a03bf2016-01-06 20:11:16 +01001444 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
Heiner Kallweit93f41e62018-09-24 22:01:32 +02001445 struct net_device *netdev = phydev->attached_dev;
Sebastian Hesselbarth32fc3fd2014-03-14 10:07:44 +01001446 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
Florian Fainelli8a477a62015-01-26 22:05:39 -08001447 int ret = 0;
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001448
1449 /* If the device has WOL enabled, we cannot suspend the PHY */
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001450 phy_ethtool_get_wol(phydev, &wol);
Heiner Kallweit93f41e62018-09-24 22:01:32 +02001451 if (wol.wolopts || (netdev && netdev->wol_enabled))
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001452 return -EBUSY;
1453
Florian Fainelli25149ef2017-02-17 16:07:34 -08001454 if (phydev->drv && phydrv->suspend)
Florian Fainelli8a477a62015-01-26 22:05:39 -08001455 ret = phydrv->suspend(phydev);
1456
1457 if (ret)
1458 return ret;
1459
1460 phydev->suspended = true;
1461
1462 return ret;
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001463}
Florian Fainellica127692014-07-08 10:38:36 -07001464EXPORT_SYMBOL(phy_suspend);
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001465
Andrew Lunn9c2c2e62018-02-27 01:56:06 +01001466int __phy_resume(struct phy_device *phydev)
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001467{
Andrew Lunne5a03bf2016-01-06 20:11:16 +01001468 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
Florian Fainelli8a477a62015-01-26 22:05:39 -08001469 int ret = 0;
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001470
Russell Kingf5e64032017-12-12 10:45:36 +00001471 WARN_ON(!mutex_is_locked(&phydev->lock));
1472
Florian Fainelli25149ef2017-02-17 16:07:34 -08001473 if (phydev->drv && phydrv->resume)
Florian Fainelli8a477a62015-01-26 22:05:39 -08001474 ret = phydrv->resume(phydev);
1475
1476 if (ret)
1477 return ret;
1478
1479 phydev->suspended = false;
1480
1481 return ret;
Sebastian Hesselbarth481b5d92013-12-13 10:20:27 +01001482}
Andrew Lunn9c2c2e62018-02-27 01:56:06 +01001483EXPORT_SYMBOL(__phy_resume);
1484
1485int phy_resume(struct phy_device *phydev)
1486{
1487 int ret;
1488
1489 mutex_lock(&phydev->lock);
1490 ret = __phy_resume(phydev);
1491 mutex_unlock(&phydev->lock);
1492
1493 return ret;
1494}
Florian Fainellica127692014-07-08 10:38:36 -07001495EXPORT_SYMBOL(phy_resume);
Andy Fleminge1393452005-08-24 18:46:21 -05001496
Lin Yun Shengf0f9b4e2017-06-30 17:44:15 +08001497int phy_loopback(struct phy_device *phydev, bool enable)
1498{
1499 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1500 int ret = 0;
1501
1502 mutex_lock(&phydev->lock);
1503
1504 if (enable && phydev->loopback_enabled) {
1505 ret = -EBUSY;
1506 goto out;
1507 }
1508
1509 if (!enable && !phydev->loopback_enabled) {
1510 ret = -EINVAL;
1511 goto out;
1512 }
1513
1514 if (phydev->drv && phydrv->set_loopback)
1515 ret = phydrv->set_loopback(phydev, enable);
1516 else
1517 ret = -EOPNOTSUPP;
1518
1519 if (ret)
1520 goto out;
1521
1522 phydev->loopback_enabled = enable;
1523
1524out:
1525 mutex_unlock(&phydev->lock);
1526 return ret;
1527}
1528EXPORT_SYMBOL(phy_loopback);
1529
Richard Leitnera9668492017-12-11 13:16:58 +01001530/**
1531 * phy_reset_after_clk_enable - perform a PHY reset if needed
1532 * @phydev: target phy_device struct
1533 *
1534 * Description: Some PHYs are known to need a reset after their refclk was
1535 * enabled. This function evaluates the flags and perform the reset if it's
1536 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1537 * was reset.
1538 */
1539int phy_reset_after_clk_enable(struct phy_device *phydev)
1540{
1541 if (!phydev || !phydev->drv)
1542 return -ENODEV;
1543
1544 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1545 phy_device_reset(phydev, 1);
1546 phy_device_reset(phydev, 0);
1547 return 1;
1548 }
1549
1550 return 0;
1551}
1552EXPORT_SYMBOL(phy_reset_after_clk_enable);
1553
Andy Fleming00db8182005-07-30 19:31:23 -04001554/* Generic PHY support and helper functions */
1555
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001556/**
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001557 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001558 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -04001559 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001560 * Description: Writes MII_ADVERTISE with the appropriate values,
Andy Fleming00db8182005-07-30 19:31:23 -04001561 * after sanitizing the values to make sure we only advertise
Trent Piepho51e2a382008-09-24 10:55:46 +00001562 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1563 * hasn't changed, and > 0 if it has changed.
Andy Fleming00db8182005-07-30 19:31:23 -04001564 */
stephen hemminger89ff05e2010-10-21 08:37:41 +00001565static int genphy_config_advert(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -04001566{
Heiner Kallweit3eef8682019-08-09 20:43:04 +02001567 int err, bmsr, changed = 0;
1568 u32 adv;
Andy Fleming00db8182005-07-30 19:31:23 -04001569
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001570 /* Only allow advertising what this PHY supports */
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01001571 linkmode_and(phydev->advertising, phydev->advertising,
1572 phydev->supported);
Heiner Kallweit3eef8682019-08-09 20:43:04 +02001573
1574 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
Andy Fleming00db8182005-07-30 19:31:23 -04001575
1576 /* Setup standard advertisement */
Heiner Kallweit4f9744e2019-02-10 19:59:57 +01001577 err = phy_modify_changed(phydev, MII_ADVERTISE,
1578 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1579 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
Heiner Kallweit3eef8682019-08-09 20:43:04 +02001580 adv);
Heiner Kallweit4f9744e2019-02-10 19:59:57 +01001581 if (err < 0)
1582 return err;
1583 if (err > 0)
Trent Piepho51e2a382008-09-24 10:55:46 +00001584 changed = 1;
Andy Fleming00db8182005-07-30 19:31:23 -04001585
Florian Fainelli5273e3a2014-02-03 12:35:46 -08001586 bmsr = phy_read(phydev, MII_BMSR);
1587 if (bmsr < 0)
1588 return bmsr;
1589
1590 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1591 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1592 * logical 1.
1593 */
1594 if (!(bmsr & BMSR_ESTATEN))
1595 return changed;
1596
Heiner Kallweit3eef8682019-08-09 20:43:04 +02001597 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
Andy Fleming00db8182005-07-30 19:31:23 -04001598
Heiner Kallweit4f9744e2019-02-10 19:59:57 +01001599 err = phy_modify_changed(phydev, MII_CTRL1000,
1600 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1601 adv);
Florian Fainelli5273e3a2014-02-03 12:35:46 -08001602 if (err < 0)
1603 return err;
Heiner Kallweit4f9744e2019-02-10 19:59:57 +01001604 if (err > 0)
1605 changed = 1;
Florian Fainelli5273e3a2014-02-03 12:35:46 -08001606
Trent Piepho51e2a382008-09-24 10:55:46 +00001607 return changed;
Andy Fleming00db8182005-07-30 19:31:23 -04001608}
Andy Fleming00db8182005-07-30 19:31:23 -04001609
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001610/**
jbrunetd853d142016-11-28 10:46:46 +01001611 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1612 * @phydev: target phy_device struct
1613 *
1614 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1615 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1616 * changed, and 1 if it has changed.
1617 */
Heiner Kallweitcd344992019-02-18 21:26:58 +01001618int genphy_config_eee_advert(struct phy_device *phydev)
jbrunetd853d142016-11-28 10:46:46 +01001619{
Heiner Kallweit9f771f12019-02-11 22:16:13 +01001620 int err;
jbrunetd853d142016-11-28 10:46:46 +01001621
1622 /* Nothing to disable */
Heiner Kallweit9f771f12019-02-11 22:16:13 +01001623 if (!phydev->eee_broken_modes)
jbrunetd853d142016-11-28 10:46:46 +01001624 return 0;
1625
Heiner Kallweit9f771f12019-02-11 22:16:13 +01001626 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1627 phydev->eee_broken_modes, 0);
1628 /* If the call failed, we assume that EEE is not supported */
1629 return err < 0 ? 0 : err;
jbrunetd853d142016-11-28 10:46:46 +01001630}
Heiner Kallweitcd344992019-02-18 21:26:58 +01001631EXPORT_SYMBOL(genphy_config_eee_advert);
jbrunetd853d142016-11-28 10:46:46 +01001632
1633/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001634 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1635 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -04001636 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001637 * Description: Configures MII_BMCR to force speed/duplex
Andy Fleming00db8182005-07-30 19:31:23 -04001638 * to the values in phydev. Assumes that the values are valid.
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001639 * Please see phy_sanitize_settings().
1640 */
Madalin Bucur3fb69bc2013-11-20 16:38:19 -06001641int genphy_setup_forced(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -04001642{
Russell Kingfea23fb2018-01-02 10:58:58 +00001643 u16 ctl = 0;
Andy Fleming00db8182005-07-30 19:31:23 -04001644
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001645 phydev->pause = 0;
1646 phydev->asym_pause = 0;
Andy Fleming00db8182005-07-30 19:31:23 -04001647
1648 if (SPEED_1000 == phydev->speed)
1649 ctl |= BMCR_SPEED1000;
1650 else if (SPEED_100 == phydev->speed)
1651 ctl |= BMCR_SPEED100;
1652
1653 if (DUPLEX_FULL == phydev->duplex)
1654 ctl |= BMCR_FULLDPLX;
Florian Fainellie1093742013-12-17 21:38:12 -08001655
Russell Kingfea23fb2018-01-02 10:58:58 +00001656 return phy_modify(phydev, MII_BMCR,
Ingo van Lil18a5b052018-02-12 12:02:52 +01001657 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
Andy Fleming00db8182005-07-30 19:31:23 -04001658}
Madalin Bucur3fb69bc2013-11-20 16:38:19 -06001659EXPORT_SYMBOL(genphy_setup_forced);
Andy Fleming00db8182005-07-30 19:31:23 -04001660
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001661/**
1662 * genphy_restart_aneg - Enable and Restart Autonegotiation
1663 * @phydev: target phy_device struct
1664 */
Andy Fleming00db8182005-07-30 19:31:23 -04001665int genphy_restart_aneg(struct phy_device *phydev)
1666{
Andy Fleming00db8182005-07-30 19:31:23 -04001667 /* Don't isolate the PHY if we're negotiating */
Russell Kingf1028522018-01-05 16:07:10 +00001668 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
Russell Kingfea23fb2018-01-02 10:58:58 +00001669 BMCR_ANENABLE | BMCR_ANRESTART);
Andy Fleming00db8182005-07-30 19:31:23 -04001670}
Adrian Bunk892871d2008-10-13 18:48:09 -07001671EXPORT_SYMBOL(genphy_restart_aneg);
Andy Fleming00db8182005-07-30 19:31:23 -04001672
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001673/**
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001674 * __genphy_config_aneg - restart auto-negotiation or write BMCR
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001675 * @phydev: target phy_device struct
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001676 * @changed: whether autoneg is requested
Andy Fleming00db8182005-07-30 19:31:23 -04001677 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001678 * Description: If auto-negotiation is enabled, we configure the
Andy Fleming00db8182005-07-30 19:31:23 -04001679 * advertising, and then restart auto-negotiation. If it is not
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001680 * enabled, then we write the BMCR.
Andy Fleming00db8182005-07-30 19:31:23 -04001681 */
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001682int __genphy_config_aneg(struct phy_device *phydev, bool changed)
Andy Fleming00db8182005-07-30 19:31:23 -04001683{
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001684 int err;
jbrunetd853d142016-11-28 10:46:46 +01001685
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001686 if (genphy_config_eee_advert(phydev))
1687 changed = true;
Andy Fleming00db8182005-07-30 19:31:23 -04001688
Trent Piephode339c22008-11-19 15:52:41 -08001689 if (AUTONEG_ENABLE != phydev->autoneg)
1690 return genphy_setup_forced(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -04001691
jbrunetd853d142016-11-28 10:46:46 +01001692 err = genphy_config_advert(phydev);
1693 if (err < 0) /* error */
1694 return err;
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001695 else if (err)
1696 changed = true;
jbrunetd853d142016-11-28 10:46:46 +01001697
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001698 if (!changed) {
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001699 /* Advertisement hasn't changed, but maybe aneg was never on to
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001700 * begin with? Or maybe phy was isolated?
1701 */
Trent Piephode339c22008-11-19 15:52:41 -08001702 int ctl = phy_read(phydev, MII_BMCR);
1703
1704 if (ctl < 0)
1705 return ctl;
1706
1707 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001708 changed = true; /* do restart aneg */
Trent Piephode339c22008-11-19 15:52:41 -08001709 }
1710
1711 /* Only restart aneg if we are advertising something different
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001712 * than we were before.
1713 */
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001714 return changed ? genphy_restart_aneg(phydev) : 0;
Andy Fleming00db8182005-07-30 19:31:23 -04001715}
Heiner Kallweitf4069cd2019-08-09 20:43:50 +02001716EXPORT_SYMBOL(__genphy_config_aneg);
Andy Fleming00db8182005-07-30 19:31:23 -04001717
Florian Fainellia9fa6e62014-02-11 17:27:36 -08001718/**
1719 * genphy_aneg_done - return auto-negotiation status
1720 * @phydev: target phy_device struct
1721 *
1722 * Description: Reads the status register and returns 0 either if
1723 * auto-negotiation is incomplete, or if there was an error.
1724 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1725 */
1726int genphy_aneg_done(struct phy_device *phydev)
1727{
1728 int retval = phy_read(phydev, MII_BMSR);
1729
1730 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1731}
1732EXPORT_SYMBOL(genphy_aneg_done);
1733
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001734/**
1735 * genphy_update_link - update link status in @phydev
1736 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -04001737 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001738 * Description: Update the value in phydev->link to reflect the
Andy Fleming00db8182005-07-30 19:31:23 -04001739 * current link value. In order to do this, we need to read
Randy Dunlapb3df0da2007-03-06 02:41:48 -08001740 * the status register twice, keeping the second value.
Andy Fleming00db8182005-07-30 19:31:23 -04001741 */
1742int genphy_update_link(struct phy_device *phydev)
1743{
Heiner Kallweitc36757eb2019-08-12 21:20:02 +02001744 int status = 0, bmcr;
1745
1746 bmcr = phy_read(phydev, MII_BMCR);
1747 if (bmcr < 0)
1748 return bmcr;
1749
1750 /* Autoneg is being started, therefore disregard BMSR value and
1751 * report link as down.
1752 */
1753 if (bmcr & BMCR_ANRESTART)
1754 goto done;
Andy Fleming00db8182005-07-30 19:31:23 -04001755
Heiner Kallweit93c09702019-02-06 19:39:52 +01001756 /* The link state is latched low so that momentary link
1757 * drops can be detected. Do not double-read the status
1758 * in polling mode to detect such short link drops.
1759 */
1760 if (!phy_polling_mode(phydev)) {
1761 status = phy_read(phydev, MII_BMSR);
Heiner Kallweitb7f29f82019-04-08 19:28:28 +02001762 if (status < 0)
Heiner Kallweit93c09702019-02-06 19:39:52 +01001763 return status;
Heiner Kallweitb7f29f82019-04-08 19:28:28 +02001764 else if (status & BMSR_LSTATUS)
1765 goto done;
Heiner Kallweit93c09702019-02-06 19:39:52 +01001766 }
Andy Fleming00db8182005-07-30 19:31:23 -04001767
1768 /* Read link and autonegotiation status */
1769 status = phy_read(phydev, MII_BMSR);
Andy Fleming00db8182005-07-30 19:31:23 -04001770 if (status < 0)
1771 return status;
Heiner Kallweitb7f29f82019-04-08 19:28:28 +02001772done:
Heiner Kallweit4950c2b2019-04-02 20:43:30 +02001773 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
1774 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
Andy Fleming00db8182005-07-30 19:31:23 -04001775
Heiner Kallweitaa6b1952019-07-31 23:05:10 +02001776 /* Consider the case that autoneg was started and "aneg complete"
1777 * bit has been reset, but "link up" bit not yet.
1778 */
1779 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
1780 phydev->link = 0;
1781
Andy Fleming00db8182005-07-30 19:31:23 -04001782 return 0;
1783}
Andy Fleming6b655522006-10-16 16:19:17 -05001784EXPORT_SYMBOL(genphy_update_link);
Andy Fleming00db8182005-07-30 19:31:23 -04001785
Russell King8d3dc3ac2019-10-04 17:06:04 +01001786int genphy_read_lpa(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -04001787{
Russell King8d3dc3ac2019-10-04 17:06:04 +01001788 int lpa, lpagb;
Heiner Kallweitb6163f12019-03-30 10:22:45 +01001789
Yonglong Liu3de5ae52019-10-16 10:30:39 +08001790 if (phydev->autoneg == AUTONEG_ENABLE) {
1791 if (!phydev->autoneg_complete) {
1792 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1793 0);
1794 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
1795 return 0;
1796 }
1797
Heiner Kallweit3b8b11f2019-04-05 21:23:13 +02001798 if (phydev->is_gigabit_capable) {
Andy Fleming00db8182005-07-30 19:31:23 -04001799 lpagb = phy_read(phydev, MII_STAT1000);
Andy Fleming00db8182005-07-30 19:31:23 -04001800 if (lpagb < 0)
1801 return lpagb;
1802
Heiner Kallweitb8f8c8e2018-07-21 15:48:47 +02001803 if (lpagb & LPA_1000MSFAIL) {
Heiner Kallweit916e5712019-08-15 13:15:19 +02001804 int adv = phy_read(phydev, MII_CTRL1000);
1805
1806 if (adv < 0)
1807 return adv;
1808
Heiner Kallweitb8f8c8e2018-07-21 15:48:47 +02001809 if (adv & CTL1000_ENABLE_MASTER)
1810 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
1811 else
1812 phydev_err(phydev, "Master/Slave resolution failed\n");
1813 return -ENOLINK;
1814 }
1815
Andrew Lunn78a24df2018-12-05 21:49:41 +01001816 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1817 lpagb);
Andy Fleming00db8182005-07-30 19:31:23 -04001818 }
1819
1820 lpa = phy_read(phydev, MII_LPA);
Andy Fleming00db8182005-07-30 19:31:23 -04001821 if (lpa < 0)
1822 return lpa;
1823
Andrew Lunnd3351932018-12-05 21:49:43 +01001824 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
Yonglong Liu3de5ae52019-10-16 10:30:39 +08001825 } else {
1826 linkmode_zero(phydev->lp_advertising);
Russell King8d3dc3ac2019-10-04 17:06:04 +01001827 }
1828
1829 return 0;
1830}
1831EXPORT_SYMBOL(genphy_read_lpa);
1832
1833/**
1834 * genphy_read_status - check the link status and update current link state
1835 * @phydev: target phy_device struct
1836 *
1837 * Description: Check the link, then figure out the current state
1838 * by comparing what we advertise with what the link partner
1839 * advertises. Start by checking the gigabit possibilities,
1840 * then move on to 10/100.
1841 */
1842int genphy_read_status(struct phy_device *phydev)
1843{
1844 int err, old_link = phydev->link;
1845
1846 /* Update the link, but return if there was an error */
1847 err = genphy_update_link(phydev);
1848 if (err)
1849 return err;
1850
1851 /* why bother the PHY if nothing can have changed */
1852 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
1853 return 0;
1854
1855 phydev->speed = SPEED_UNKNOWN;
1856 phydev->duplex = DUPLEX_UNKNOWN;
1857 phydev->pause = 0;
1858 phydev->asym_pause = 0;
1859
1860 err = genphy_read_lpa(phydev);
1861 if (err < 0)
1862 return err;
1863
1864 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
Heiner Kallweit5502b212019-02-14 22:16:27 +01001865 phy_resolve_aneg_linkmode(phydev);
Heiner Kallweitb6163f12019-03-30 10:22:45 +01001866 } else if (phydev->autoneg == AUTONEG_DISABLE) {
Andy Fleming00db8182005-07-30 19:31:23 -04001867 int bmcr = phy_read(phydev, MII_BMCR);
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03001868
Andy Fleming00db8182005-07-30 19:31:23 -04001869 if (bmcr < 0)
1870 return bmcr;
1871
1872 if (bmcr & BMCR_FULLDPLX)
1873 phydev->duplex = DUPLEX_FULL;
1874 else
1875 phydev->duplex = DUPLEX_HALF;
1876
1877 if (bmcr & BMCR_SPEED1000)
1878 phydev->speed = SPEED_1000;
1879 else if (bmcr & BMCR_SPEED100)
1880 phydev->speed = SPEED_100;
1881 else
1882 phydev->speed = SPEED_10;
Andy Fleming00db8182005-07-30 19:31:23 -04001883 }
1884
1885 return 0;
1886}
1887EXPORT_SYMBOL(genphy_read_status);
1888
Florian Fainelli797ac072014-02-17 13:34:02 -08001889/**
1890 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1891 * @phydev: target phy_device struct
1892 *
1893 * Description: Perform a software PHY reset using the standard
1894 * BMCR_RESET bit and poll for the reset bit to be cleared.
1895 *
1896 * Returns: 0 on success, < 0 on failure
1897 */
1898int genphy_soft_reset(struct phy_device *phydev)
1899{
Heiner Kallweit8c90b792019-04-24 21:41:06 +02001900 u16 res = BMCR_RESET;
Florian Fainelli797ac072014-02-17 13:34:02 -08001901 int ret;
1902
Heiner Kallweit8c90b792019-04-24 21:41:06 +02001903 if (phydev->autoneg == AUTONEG_ENABLE)
1904 res |= BMCR_ANRESTART;
1905
1906 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
Florian Fainelli797ac072014-02-17 13:34:02 -08001907 if (ret < 0)
1908 return ret;
1909
Heiner Kallweit8c90b792019-04-24 21:41:06 +02001910 ret = phy_poll_reset(phydev);
1911 if (ret)
1912 return ret;
1913
1914 /* BMCR may be reset to defaults */
1915 if (phydev->autoneg == AUTONEG_DISABLE)
1916 ret = genphy_setup_forced(phydev);
1917
1918 return ret;
Florian Fainelli797ac072014-02-17 13:34:02 -08001919}
1920EXPORT_SYMBOL(genphy_soft_reset);
1921
Heiner Kallweit045925e2019-03-27 21:58:44 +01001922/**
1923 * genphy_read_abilities - read PHY abilities from Clause 22 registers
1924 * @phydev: target phy_device struct
1925 *
1926 * Description: Reads the PHY's abilities and populates
1927 * phydev->supported accordingly.
1928 *
1929 * Returns: 0 on success, < 0 on failure
1930 */
1931int genphy_read_abilities(struct phy_device *phydev)
1932{
1933 int val;
1934
1935 linkmode_set_bit_array(phy_basic_ports_array,
1936 ARRAY_SIZE(phy_basic_ports_array),
1937 phydev->supported);
1938
1939 val = phy_read(phydev, MII_BMSR);
1940 if (val < 0)
1941 return val;
1942
1943 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
1944 val & BMSR_ANEGCAPABLE);
1945
1946 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
1947 val & BMSR_100FULL);
1948 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
1949 val & BMSR_100HALF);
1950 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
1951 val & BMSR_10FULL);
1952 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
1953 val & BMSR_10HALF);
1954
1955 if (val & BMSR_ESTATEN) {
1956 val = phy_read(phydev, MII_ESTATUS);
1957 if (val < 0)
1958 return val;
1959
1960 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1961 phydev->supported, val & ESTATUS_1000_TFULL);
1962 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1963 phydev->supported, val & ESTATUS_1000_THALF);
Robert Hancockf30e33b2019-06-11 16:06:09 -06001964 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1965 phydev->supported, val & ESTATUS_1000_XFULL);
Heiner Kallweit045925e2019-03-27 21:58:44 +01001966 }
1967
1968 return 0;
1969}
1970EXPORT_SYMBOL(genphy_read_abilities);
1971
Kevin Hao5df7af82018-03-20 09:44:52 +08001972/* This is used for the phy device which doesn't support the MMD extended
1973 * register access, but it does have side effect when we are trying to access
1974 * the MMD register via indirect method.
1975 */
1976int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
1977{
1978 return -EOPNOTSUPP;
1979}
1980EXPORT_SYMBOL(genphy_read_mmd_unsupported);
1981
1982int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1983 u16 regnum, u16 val)
1984{
1985 return -EOPNOTSUPP;
1986}
1987EXPORT_SYMBOL(genphy_write_mmd_unsupported);
1988
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -08001989int genphy_suspend(struct phy_device *phydev)
1990{
Heiner Kallweit032f4702018-01-12 21:20:36 +01001991 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -08001992}
1993EXPORT_SYMBOL(genphy_suspend);
1994
1995int genphy_resume(struct phy_device *phydev)
1996{
Heiner Kallweit032f4702018-01-12 21:20:36 +01001997 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -08001998}
1999EXPORT_SYMBOL(genphy_resume);
Andy Fleming00db8182005-07-30 19:31:23 -04002000
Lin Yun Shengf0f9b4e2017-06-30 17:44:15 +08002001int genphy_loopback(struct phy_device *phydev, bool enable)
2002{
Russell Kingf1028522018-01-05 16:07:10 +00002003 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
Russell Kingfea23fb2018-01-02 10:58:58 +00002004 enable ? BMCR_LOOPBACK : 0);
Lin Yun Shengf0f9b4e2017-06-30 17:44:15 +08002005}
2006EXPORT_SYMBOL(genphy_loopback);
2007
Andrew Lunn41124fa2018-09-12 01:53:14 +02002008/**
2009 * phy_remove_link_mode - Remove a supported link mode
2010 * @phydev: phy_device structure to remove link mode from
2011 * @link_mode: Link mode to be removed
2012 *
2013 * Description: Some MACs don't support all link modes which the PHY
2014 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2015 * to remove a link mode.
2016 */
2017void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2018{
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002019 linkmode_clear_bit(link_mode, phydev->supported);
Heiner Kallweit22c0ef62019-05-01 21:34:43 +02002020 phy_advertise_supported(phydev);
Andrew Lunn41124fa2018-09-12 01:53:14 +02002021}
2022EXPORT_SYMBOL(phy_remove_link_mode);
2023
Heiner Kallweit22c0ef62019-05-01 21:34:43 +02002024static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2025{
2026 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2027 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2028 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2029 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2030}
2031
2032/**
2033 * phy_advertise_supported - Advertise all supported modes
2034 * @phydev: target phy_device struct
2035 *
2036 * Description: Called to advertise all supported modes, doesn't touch
2037 * pause mode advertising.
2038 */
2039void phy_advertise_supported(struct phy_device *phydev)
2040{
2041 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2042
2043 linkmode_copy(new, phydev->supported);
2044 phy_copy_pause_bits(new, phydev->advertising);
2045 linkmode_copy(phydev->advertising, new);
2046}
2047EXPORT_SYMBOL(phy_advertise_supported);
2048
Andrew Lunnaf8d9bb2018-09-12 01:53:15 +02002049/**
Andrew Lunnc306ad32018-09-12 01:53:16 +02002050 * phy_support_sym_pause - Enable support of symmetrical pause
2051 * @phydev: target phy_device struct
2052 *
2053 * Description: Called by the MAC to indicate is supports symmetrical
2054 * Pause, but not asym pause.
2055 */
2056void phy_support_sym_pause(struct phy_device *phydev)
2057{
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002058 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
Heiner Kallweit22c0ef62019-05-01 21:34:43 +02002059 phy_copy_pause_bits(phydev->advertising, phydev->supported);
Andrew Lunnc306ad32018-09-12 01:53:16 +02002060}
2061EXPORT_SYMBOL(phy_support_sym_pause);
2062
2063/**
Andrew Lunnaf8d9bb2018-09-12 01:53:15 +02002064 * phy_support_asym_pause - Enable support of asym pause
2065 * @phydev: target phy_device struct
2066 *
2067 * Description: Called by the MAC to indicate is supports Asym Pause.
2068 */
2069void phy_support_asym_pause(struct phy_device *phydev)
2070{
Heiner Kallweit22c0ef62019-05-01 21:34:43 +02002071 phy_copy_pause_bits(phydev->advertising, phydev->supported);
Andrew Lunnaf8d9bb2018-09-12 01:53:15 +02002072}
2073EXPORT_SYMBOL(phy_support_asym_pause);
2074
Andrew Lunn70814e82018-09-12 01:53:17 +02002075/**
Andrew Lunn0c122402018-09-12 01:53:18 +02002076 * phy_set_sym_pause - Configure symmetric Pause
2077 * @phydev: target phy_device struct
2078 * @rx: Receiver Pause is supported
2079 * @tx: Transmit Pause is supported
2080 * @autoneg: Auto neg should be used
2081 *
2082 * Description: Configure advertised Pause support depending on if
2083 * receiver pause and pause auto neg is supported. Generally called
2084 * from the set_pauseparam .ndo.
2085 */
2086void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2087 bool autoneg)
2088{
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002089 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
Andrew Lunn0c122402018-09-12 01:53:18 +02002090
2091 if (rx && tx && autoneg)
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002092 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2093 phydev->supported);
Andrew Lunn0c122402018-09-12 01:53:18 +02002094
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002095 linkmode_copy(phydev->advertising, phydev->supported);
Andrew Lunn0c122402018-09-12 01:53:18 +02002096}
2097EXPORT_SYMBOL(phy_set_sym_pause);
2098
2099/**
Andrew Lunn70814e82018-09-12 01:53:17 +02002100 * phy_set_asym_pause - Configure Pause and Asym Pause
2101 * @phydev: target phy_device struct
2102 * @rx: Receiver Pause is supported
2103 * @tx: Transmit Pause is supported
2104 *
2105 * Description: Configure advertised Pause support depending on if
2106 * transmit and receiver pause is supported. If there has been a
2107 * change in adverting, trigger a new autoneg. Generally called from
2108 * the set_pauseparam .ndo.
2109 */
2110void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2111{
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002112 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
Andrew Lunn70814e82018-09-12 01:53:17 +02002113
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002114 linkmode_copy(oldadv, phydev->advertising);
Andrew Lunn70814e82018-09-12 01:53:17 +02002115
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002116 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2117 phydev->advertising);
2118 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2119 phydev->advertising);
Andrew Lunn70814e82018-09-12 01:53:17 +02002120
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002121 if (rx) {
2122 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2123 phydev->advertising);
2124 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2125 phydev->advertising);
Andrew Lunn70814e82018-09-12 01:53:17 +02002126 }
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002127
2128 if (tx)
2129 linkmode_change_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2130 phydev->advertising);
2131
2132 if (!linkmode_equal(oldadv, phydev->advertising) &&
2133 phydev->autoneg)
2134 phy_start_aneg(phydev);
Andrew Lunn70814e82018-09-12 01:53:17 +02002135}
2136EXPORT_SYMBOL(phy_set_asym_pause);
2137
Andrew Lunn22b7d292018-09-12 01:53:19 +02002138/**
2139 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2140 * @phydev: phy_device struct
2141 * @pp: requested pause configuration
2142 *
2143 * Description: Test if the PHY/MAC combination supports the Pause
2144 * configuration the user is requesting. Returns True if it is
2145 * supported, false otherwise.
2146 */
2147bool phy_validate_pause(struct phy_device *phydev,
2148 struct ethtool_pauseparam *pp)
2149{
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002150 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
Heiner Kallweitb4010af2019-05-01 21:54:28 +02002151 phydev->supported) && pp->rx_pause)
Andrew Lunn22b7d292018-09-12 01:53:19 +02002152 return false;
Heiner Kallweitb4010af2019-05-01 21:54:28 +02002153
2154 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2155 phydev->supported) &&
2156 pp->rx_pause != pp->tx_pause)
2157 return false;
2158
Andrew Lunn22b7d292018-09-12 01:53:19 +02002159 return true;
2160}
2161EXPORT_SYMBOL(phy_validate_pause);
2162
Heiner Kallweit0d2e7782018-11-09 18:16:28 +01002163static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2164{
Heiner Kallweita21ff3c2018-11-12 21:16:06 +01002165 return phydrv->config_intr && phydrv->ack_interrupt;
Heiner Kallweit0d2e7782018-11-09 18:16:28 +01002166}
2167
Randy Dunlapb3df0da2007-03-06 02:41:48 -08002168/**
2169 * phy_probe - probe and init a PHY device
2170 * @dev: device to probe and init
Andy Fleming00db8182005-07-30 19:31:23 -04002171 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -08002172 * Description: Take care of setting up the phy_device structure,
Andy Fleming00db8182005-07-30 19:31:23 -04002173 * set the state to READY (the driver's init function should
2174 * set it to STARTING if needed).
2175 */
2176static int phy_probe(struct device *dev)
2177{
Sergei Shtylyov553fe922014-01-05 03:23:19 +03002178 struct phy_device *phydev = to_phy_device(dev);
Andrew Lunne5a03bf2016-01-06 20:11:16 +01002179 struct device_driver *drv = phydev->mdio.dev.driver;
Sergei Shtylyov553fe922014-01-05 03:23:19 +03002180 struct phy_driver *phydrv = to_phy_driver(drv);
Andy Fleming00db8182005-07-30 19:31:23 -04002181 int err = 0;
2182
Andy Fleming00db8182005-07-30 19:31:23 -04002183 phydev->drv = phydrv;
2184
Florian Fainelli2c7b4922013-05-19 22:53:42 +00002185 /* Disable the interrupt if the PHY doesn't support it
2186 * but the interrupt is still a valid one
2187 */
Heiner Kallweit0d2e7782018-11-09 18:16:28 +01002188 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
Andy Fleming00db8182005-07-30 19:31:23 -04002189 phydev->irq = PHY_POLL;
2190
Florian Fainelli4284b6a2013-05-23 01:11:12 +00002191 if (phydrv->flags & PHY_IS_INTERNAL)
2192 phydev->is_internal = true;
2193
Nate Case35b5f6b2008-01-29 10:05:09 -06002194 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -04002195
Andrew Lunn92ed2eb2019-02-09 14:46:30 +01002196 if (phydev->drv->probe) {
2197 /* Deassert the reset signal */
2198 phy_device_reset(phydev, 0);
2199
2200 err = phydev->drv->probe(phydev);
2201 if (err) {
2202 /* Assert the reset signal */
2203 phy_device_reset(phydev, 1);
2204 goto out;
2205 }
2206 }
2207
Andy Fleming00db8182005-07-30 19:31:23 -04002208 /* Start out supporting everything. Eventually,
2209 * a controller will attach, and may modify one
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03002210 * or both of these values
2211 */
Andrew Lunnefbdfdc2019-02-09 15:24:47 +01002212 if (phydrv->features) {
2213 linkmode_copy(phydev->supported, phydrv->features);
Heiner Kallweita1deab12019-04-03 23:14:33 +02002214 } else if (phydrv->get_features) {
Andrew Lunnefbdfdc2019-02-09 15:24:47 +01002215 err = phydrv->get_features(phydev);
Heiner Kallweita1deab12019-04-03 23:14:33 +02002216 } else if (phydev->is_c45) {
2217 err = genphy_c45_pma_read_abilities(phydev);
2218 } else {
2219 err = genphy_read_abilities(phydev);
Andrew Lunnefbdfdc2019-02-09 15:24:47 +01002220 }
2221
Heiner Kallweita1deab12019-04-03 23:14:33 +02002222 if (err)
2223 goto out;
2224
Heiner Kallweit5e425742019-04-16 23:54:00 +02002225 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2226 phydev->supported))
2227 phydev->autoneg = 0;
2228
Heiner Kallweit3b8b11f2019-04-05 21:23:13 +02002229 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2230 phydev->supported))
2231 phydev->is_gigabit_capable = 1;
2232 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2233 phydev->supported))
2234 phydev->is_gigabit_capable = 1;
2235
Sascha Hauerde906af2014-05-21 15:29:45 +02002236 of_set_phy_supported(phydev);
Heiner Kallweit22c0ef62019-05-01 21:34:43 +02002237 phy_advertise_supported(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -04002238
jbrunetd853d142016-11-28 10:46:46 +01002239 /* Get the EEE modes we want to prohibit. We will ask
2240 * the PHY stop advertising these mode later on
2241 */
2242 of_set_phy_eee_broken(phydev);
2243
Timur Tabi529ed122016-12-07 13:20:51 -06002244 /* The Pause Frame bits indicate that the PHY can support passing
2245 * pause frames. During autonegotiation, the PHYs will determine if
2246 * they should allow pause frames to pass. The MAC driver should then
2247 * use that result to determine whether to enable flow control via
2248 * pause frames.
2249 *
2250 * Normally, PHY drivers should not set the Pause bits, and instead
2251 * allow phylib to do that. However, there may be some situations
2252 * (e.g. hardware erratum) where the driver wants to set only one
2253 * of these bits.
2254 */
Andrew Lunnefbdfdc2019-02-09 15:24:47 +01002255 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2256 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
Andrew Lunn3c1bcc82018-11-10 23:43:33 +01002257 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2258 phydev->supported);
2259 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2260 phydev->supported);
Timur Tabi529ed122016-12-07 13:20:51 -06002261 }
2262
Andy Fleming00db8182005-07-30 19:31:23 -04002263 /* Set the state to READY by default */
2264 phydev->state = PHY_READY;
2265
Andrew Lunn92ed2eb2019-02-09 14:46:30 +01002266out:
Nate Case35b5f6b2008-01-29 10:05:09 -06002267 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -04002268
Andy Fleming00db8182005-07-30 19:31:23 -04002269 return err;
2270}
2271
2272static int phy_remove(struct device *dev)
2273{
Sergei Shtylyov553fe922014-01-05 03:23:19 +03002274 struct phy_device *phydev = to_phy_device(dev);
Andy Fleming00db8182005-07-30 19:31:23 -04002275
Florian Fainelli7b9a88a2017-02-17 16:07:33 -08002276 cancel_delayed_work_sync(&phydev->state_queue);
2277
Nate Case35b5f6b2008-01-29 10:05:09 -06002278 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -04002279 phydev->state = PHY_DOWN;
Nate Case35b5f6b2008-01-29 10:05:09 -06002280 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -04002281
Sergei Shtylyovbafbdd52017-12-04 13:35:05 +01002282 if (phydev->drv && phydev->drv->remove) {
Andy Fleming00db8182005-07-30 19:31:23 -04002283 phydev->drv->remove(phydev);
Sergei Shtylyovbafbdd52017-12-04 13:35:05 +01002284
2285 /* Assert the reset signal */
2286 phy_device_reset(phydev, 1);
2287 }
Andy Fleming00db8182005-07-30 19:31:23 -04002288 phydev->drv = NULL;
2289
2290 return 0;
2291}
2292
Randy Dunlapb3df0da2007-03-06 02:41:48 -08002293/**
2294 * phy_driver_register - register a phy_driver with the PHY layer
2295 * @new_driver: new phy_driver to register
Andrew Lunnbe01da72016-01-06 20:11:22 +01002296 * @owner: module owning this PHY
Randy Dunlapb3df0da2007-03-06 02:41:48 -08002297 */
Andrew Lunnbe01da72016-01-06 20:11:22 +01002298int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
Andy Fleming00db8182005-07-30 19:31:23 -04002299{
2300 int retval;
2301
Andrew Lunnefbdfdc2019-02-09 15:24:47 +01002302 /* Either the features are hard coded, or dynamically
Heiner Kallweita1deab12019-04-03 23:14:33 +02002303 * determined. It cannot be both.
Andrew Lunnefbdfdc2019-02-09 15:24:47 +01002304 */
Heiner Kallweita1deab12019-04-03 23:14:33 +02002305 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2306 pr_err("%s: features and get_features must not both be set\n",
2307 new_driver->name);
Camelia Groza3e64cf72019-01-17 14:22:36 +02002308 return -EINVAL;
2309 }
2310
Andrew Lunna9049e02016-01-06 20:11:26 +01002311 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2312 new_driver->mdiodrv.driver.name = new_driver->name;
2313 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2314 new_driver->mdiodrv.driver.probe = phy_probe;
2315 new_driver->mdiodrv.driver.remove = phy_remove;
2316 new_driver->mdiodrv.driver.owner = owner;
Andy Fleming00db8182005-07-30 19:31:23 -04002317
Andrew Lunna9049e02016-01-06 20:11:26 +01002318 retval = driver_register(&new_driver->mdiodrv.driver);
Andy Fleming00db8182005-07-30 19:31:23 -04002319 if (retval) {
Joe Perches8d242482012-06-09 07:49:07 +00002320 pr_err("%s: Error %d in registering driver\n",
2321 new_driver->name, retval);
Andy Fleming00db8182005-07-30 19:31:23 -04002322
2323 return retval;
2324 }
2325
Olof Johanssonf2511f12007-11-04 16:09:23 -06002326 pr_debug("%s: Registered new driver\n", new_driver->name);
Andy Fleming00db8182005-07-30 19:31:23 -04002327
2328 return 0;
2329}
2330EXPORT_SYMBOL(phy_driver_register);
2331
Andrew Lunnbe01da72016-01-06 20:11:22 +01002332int phy_drivers_register(struct phy_driver *new_driver, int n,
2333 struct module *owner)
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +00002334{
2335 int i, ret = 0;
2336
2337 for (i = 0; i < n; i++) {
Andrew Lunnbe01da72016-01-06 20:11:22 +01002338 ret = phy_driver_register(new_driver + i, owner);
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +00002339 if (ret) {
2340 while (i-- > 0)
2341 phy_driver_unregister(new_driver + i);
2342 break;
2343 }
2344 }
2345 return ret;
2346}
2347EXPORT_SYMBOL(phy_drivers_register);
2348
Andy Fleming00db8182005-07-30 19:31:23 -04002349void phy_driver_unregister(struct phy_driver *drv)
2350{
Andrew Lunna9049e02016-01-06 20:11:26 +01002351 driver_unregister(&drv->mdiodrv.driver);
Andy Fleming00db8182005-07-30 19:31:23 -04002352}
2353EXPORT_SYMBOL(phy_driver_unregister);
2354
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +00002355void phy_drivers_unregister(struct phy_driver *drv, int n)
2356{
2357 int i;
Sergei Shtylyov2f53e902014-01-05 03:17:06 +03002358
2359 for (i = 0; i < n; i++)
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +00002360 phy_driver_unregister(drv + i);
Christian Hohnstaedtd5bf9072012-07-04 05:44:34 +00002361}
2362EXPORT_SYMBOL(phy_drivers_unregister);
2363
Russell King921690f2017-06-05 12:23:05 +01002364static struct phy_driver genphy_driver = {
Andy Fleminge1393452005-08-24 18:46:21 -05002365 .phy_id = 0xffffffff,
2366 .phy_id_mask = 0xffffffff,
2367 .name = "Generic PHY",
Florian Fainelli0878fff2017-03-05 12:34:49 -08002368 .soft_reset = genphy_no_soft_reset,
Heiner Kallweit2a4d8672019-03-27 21:59:33 +01002369 .get_features = genphy_read_abilities,
Florian Fainelli76a423a2014-02-11 17:27:37 -08002370 .aneg_done = genphy_aneg_done,
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -08002371 .suspend = genphy_suspend,
2372 .resume = genphy_resume,
Lin Yun Shengf0f9b4e2017-06-30 17:44:15 +08002373 .set_loopback = genphy_loopback,
Russell King921690f2017-06-05 12:23:05 +01002374};
Andy Fleming00db8182005-07-30 19:31:23 -04002375
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002376static int __init phy_init(void)
Andy Fleming00db8182005-07-30 19:31:23 -04002377{
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002378 int rc;
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002379
2380 rc = mdio_bus_init();
2381 if (rc)
Andy Fleminge1393452005-08-24 18:46:21 -05002382 return rc;
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002383
Andrew Lunn719655a2018-09-29 23:04:16 +02002384 features_init();
2385
Heiner Kallweit22b56e82019-04-07 13:55:01 +02002386 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
Andy Fleminge1393452005-08-24 18:46:21 -05002387 if (rc)
Heiner Kallweit22b56e82019-04-07 13:55:01 +02002388 goto err_c45;
Russell King921690f2017-06-05 12:23:05 +01002389
2390 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2391 if (rc) {
Heiner Kallweit22b56e82019-04-07 13:55:01 +02002392 phy_driver_unregister(&genphy_c45_driver);
2393err_c45:
Andy Fleminge1393452005-08-24 18:46:21 -05002394 mdio_bus_exit();
Russell King921690f2017-06-05 12:23:05 +01002395 }
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002396
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002397 return rc;
Andy Fleming00db8182005-07-30 19:31:23 -04002398}
2399
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002400static void __exit phy_exit(void)
Andy Fleming00db8182005-07-30 19:31:23 -04002401{
Heiner Kallweit22b56e82019-04-07 13:55:01 +02002402 phy_driver_unregister(&genphy_c45_driver);
Russell King921690f2017-06-05 12:23:05 +01002403 phy_driver_unregister(&genphy_driver);
Andy Fleminge1393452005-08-24 18:46:21 -05002404 mdio_bus_exit();
Andy Fleming00db8182005-07-30 19:31:23 -04002405}
2406
Andy Fleminge1393452005-08-24 18:46:21 -05002407subsys_initcall(phy_init);
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04002408module_exit(phy_exit);