1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for finding and configuring PHYs.
3 * Also contains generic PHY driver
4 *
5 * Author: Andy Fleming
6 *
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 */
9
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11
12 #include <linux/kernel.h>
13 #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>
23 #include <linux/mm.h>
24 #include <linux/module.h>
25 #include <linux/mii.h>
26 #include <linux/ethtool.h>
27 #include <linux/bitmap.h>
28 #include <linux/phy.h>
29 #include <linux/phy_led_triggers.h>
30 #include <linux/mdio.h>
31 #include <linux/io.h>
32 #include <linux/uaccess.h>
33
34 MODULE_DESCRIPTION("PHY library");
35 MODULE_AUTHOR("Andy Fleming");
36 MODULE_LICENSE("GPL");
37
38 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
39 EXPORT_SYMBOL_GPL(phy_basic_features);
40
41 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
42 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
43
44 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
45 EXPORT_SYMBOL_GPL(phy_gbit_features);
46
47 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
48 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
49
50 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
51 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
52
53 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
54 EXPORT_SYMBOL_GPL(phy_10gbit_features);
55
56 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
57 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
58
59 const int phy_basic_ports_array[3] = {
60 ETHTOOL_LINK_MODE_Autoneg_BIT,
61 ETHTOOL_LINK_MODE_TP_BIT,
62 ETHTOOL_LINK_MODE_MII_BIT,
63 };
64 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
65
66 const int phy_fibre_port_array[1] = {
67 ETHTOOL_LINK_MODE_FIBRE_BIT,
68 };
69 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
70
71 const int phy_all_ports_features_array[7] = {
72 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 };
80 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
81
82 const int phy_10_100_features_array[4] = {
83 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 };
88 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
89
90 const int phy_basic_t1_features_array[2] = {
91 ETHTOOL_LINK_MODE_TP_BIT,
92 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
93 };
94 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
95
96 const int phy_gbit_features_array[2] = {
97 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
98 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
99 };
100 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
101
102 const int phy_10gbit_features_array[1] = {
103 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
104 };
105 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
106
107 const int phy_10gbit_fec_features_array[1] = {
108 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
109 };
110 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features_array);
111
112 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
113 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
114
115 static 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
features_init(void)122 static 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);
194 /* 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);
198 }
199
phy_device_free(struct phy_device * phydev)200 void phy_device_free(struct phy_device *phydev)
201 {
202 put_device(&phydev->mdio.dev);
203 }
204 EXPORT_SYMBOL(phy_device_free);
205
phy_mdio_device_free(struct mdio_device * mdiodev)206 static 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
phy_device_release(struct device * dev)214 static void phy_device_release(struct device *dev)
215 {
216 kfree(to_phy_device(dev));
217 }
218
phy_mdio_device_remove(struct mdio_device * mdiodev)219 static 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
227 static struct phy_driver genphy_driver;
228 extern struct phy_driver genphy_c45_driver;
229
230 static LIST_HEAD(phy_fixup_list);
231 static DEFINE_MUTEX(phy_fixup_lock);
232
233 #ifdef CONFIG_PM
mdio_bus_phy_may_suspend(struct phy_device * phydev)234 static 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
251 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.
257 * 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
mdio_bus_phy_suspend(struct device * dev)272 static 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
mdio_bus_phy_resume(struct device * dev)290 static 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
302 no_resume:
303 if (phydev->attached_dev && phydev->adjust_link)
304 phy_start_machine(phydev);
305
306 return 0;
307 }
308
mdio_bus_phy_restore(struct device * dev)309 static 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
322 if (phydev->attached_dev && phydev->adjust_link)
323 phy_start_machine(phydev);
324
325 return 0;
326 }
327
328 static 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
344 /**
345 * phy_register_fixup - creates a new phy_fixup and adds it to the list
346 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
347 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
348 * It can also be PHY_ANY_UID
349 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
350 * comparison
351 * @run: The actual code to be run when a matching PHY is found
352 */
phy_register_fixup(const char * bus_id,u32 phy_uid,u32 phy_uid_mask,int (* run)(struct phy_device *))353 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
354 int (*run)(struct phy_device *))
355 {
356 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
357
358 if (!fixup)
359 return -ENOMEM;
360
361 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
362 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 }
372 EXPORT_SYMBOL(phy_register_fixup);
373
374 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
phy_register_fixup_for_uid(u32 phy_uid,u32 phy_uid_mask,int (* run)(struct phy_device *))375 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
376 int (*run)(struct phy_device *))
377 {
378 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
379 }
380 EXPORT_SYMBOL(phy_register_fixup_for_uid);
381
382 /* Registers a fixup to be run on the PHY with id string bus_id */
phy_register_fixup_for_id(const char * bus_id,int (* run)(struct phy_device *))383 int phy_register_fixup_for_id(const char *bus_id,
384 int (*run)(struct phy_device *))
385 {
386 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
387 }
388 EXPORT_SYMBOL(phy_register_fixup_for_id);
389
390 /**
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 */
phy_unregister_fixup(const char * bus_id,u32 phy_uid,u32 phy_uid_mask)396 int 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 }
421 EXPORT_SYMBOL(phy_unregister_fixup);
422
423 /* Unregisters a fixup of any PHY with the UID in phy_uid */
phy_unregister_fixup_for_uid(u32 phy_uid,u32 phy_uid_mask)424 int 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 }
428 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
429
430 /* Unregisters a fixup of the PHY with id string bus_id */
phy_unregister_fixup_for_id(const char * bus_id)431 int phy_unregister_fixup_for_id(const char *bus_id)
432 {
433 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
434 }
435 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
436
437 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
438 * Fixups can be set to match any in one or more fields.
439 */
phy_needs_fixup(struct phy_device * phydev,struct phy_fixup * fixup)440 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
441 {
442 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
443 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
444 return 0;
445
446 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
447 (phydev->phy_id & fixup->phy_uid_mask))
448 if (fixup->phy_uid != PHY_ANY_UID)
449 return 0;
450
451 return 1;
452 }
453
454 /* Runs any matching fixups for this phydev */
phy_scan_fixups(struct phy_device * phydev)455 static int phy_scan_fixups(struct phy_device *phydev)
456 {
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)) {
462 int err = fixup->run(phydev);
463
464 if (err < 0) {
465 mutex_unlock(&phy_fixup_lock);
466 return err;
467 }
468 phydev->has_fixups = true;
469 }
470 }
471 mutex_unlock(&phy_fixup_lock);
472
473 return 0;
474 }
475
phy_bus_match(struct device * dev,struct device_driver * drv)476 static 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
483 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
484 return 0;
485
486 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.device_ids[i] == 0xffffffff)
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
506 static ssize_t
phy_id_show(struct device * dev,struct device_attribute * attr,char * buf)507 phy_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 }
513 static DEVICE_ATTR_RO(phy_id);
514
515 static ssize_t
phy_interface_show(struct device * dev,struct device_attribute * attr,char * buf)516 phy_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 }
528 static DEVICE_ATTR_RO(phy_interface);
529
530 static ssize_t
phy_has_fixups_show(struct device * dev,struct device_attribute * attr,char * buf)531 phy_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 }
538 static DEVICE_ATTR_RO(phy_has_fixups);
539
540 static 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 };
546 ATTRIBUTE_GROUPS(phy_dev);
547
548 static 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
phy_request_driver_module(struct phy_device * dev,u32 phy_id)555 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
556 {
557 int ret;
558
559 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
560 MDIO_ID_ARGS(phy_id));
561 /* 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.
565 */
566 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
567 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
568 ret, (unsigned long)phy_id);
569 return ret;
570 }
571
572 return 0;
573 }
574
phy_device_create(struct mii_bus * bus,int addr,u32 phy_id,bool is_c45,struct phy_c45_device_ids * c45_ids)575 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
576 bool is_c45,
577 struct phy_c45_device_ids *c45_ids)
578 {
579 struct phy_device *dev;
580 struct mdio_device *mdiodev;
581 int ret = 0;
582
583 /* We allocate the device, and initialize the default values */
584 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
585 if (!dev)
586 return ERR_PTR(-ENOMEM);
587
588 mdiodev = &dev->mdio;
589 mdiodev->dev.parent = &bus->dev;
590 mdiodev->dev.bus = &mdio_bus_type;
591 mdiodev->dev.type = &mdio_bus_phy_type;
592 mdiodev->bus = bus;
593 mdiodev->bus_match = phy_bus_match;
594 mdiodev->addr = addr;
595 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
596 mdiodev->device_free = phy_mdio_device_free;
597 mdiodev->device_remove = phy_mdio_device_remove;
598
599 dev->speed = SPEED_UNKNOWN;
600 dev->duplex = DUPLEX_UNKNOWN;
601 dev->pause = 0;
602 dev->asym_pause = 0;
603 dev->link = 0;
604 dev->interface = PHY_INTERFACE_MODE_GMII;
605
606 dev->autoneg = AUTONEG_ENABLE;
607
608 dev->is_c45 = is_c45;
609 dev->phy_id = phy_id;
610 if (c45_ids)
611 dev->c45_ids = *c45_ids;
612 dev->irq = bus->irq[addr];
613 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
614
615 dev->state = PHY_DOWN;
616
617 mutex_init(&dev->lock);
618 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
619
620 /* Request the appropriate module unconditionally; don't
621 * 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 */
630 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->device_ids[i] == 0xffffffff)
636 continue;
637
638 ret = phy_request_driver_module(dev,
639 c45_ids->device_ids[i]);
640 if (ret)
641 break;
642 }
643 } else {
644 ret = phy_request_driver_module(dev, phy_id);
645 }
646
647 if (!ret) {
648 device_initialize(&mdiodev->dev);
649 } else {
650 kfree(dev);
651 dev = ERR_PTR(ret);
652 }
653
654 return dev;
655 }
656 EXPORT_SYMBOL(phy_device_create);
657
658 /* 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 */
get_phy_c45_devs_in_pkg(struct mii_bus * bus,int addr,int dev_addr,u32 * devices_in_package)669 static 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;
678 *devices_in_package = phy_reg << 16;
679
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;
684 *devices_in_package |= phy_reg;
685
686 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
687 *devices_in_package &= ~BIT(0);
688
689 return 0;
690 }
691
692 /**
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 */
get_phy_c45_ids(struct mii_bus * bus,int addr,u32 * phy_id,struct phy_c45_device_ids * c45_ids)705 static 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);
710 u32 *devs = &c45_ids->devices_in_package;
711
712 /* 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.
714 */
715 for (i = 1; i < num_ids && *devs == 0; i++) {
716 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
717 if (phy_reg < 0)
718 return -EIO;
719
720 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) {
731 *phy_id = 0xffffffff;
732 return 0;
733 } else {
734 break;
735 }
736 }
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;
748 c45_ids->device_ids[i] = phy_reg << 16;
749
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;
754 c45_ids->device_ids[i] |= phy_reg;
755 }
756 *phy_id = 0;
757 return 0;
758 }
759
760 /**
761 * 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.
765 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
766 * @c45_ids: where to store the c45 ID information.
767 *
768 * 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 *
775 */
get_phy_id(struct mii_bus * bus,int addr,u32 * phy_id,bool is_c45,struct phy_c45_device_ids * c45_ids)776 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
777 bool is_c45, struct phy_c45_device_ids *c45_ids)
778 {
779 int phy_reg;
780
781 if (is_c45)
782 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
783
784 /* Grab the bits from PHYIR1, and put them in the upper half */
785 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
786 if (phy_reg < 0) {
787 /* returning -ENODEV doesn't stop bus scanning */
788 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
789 }
790
791 *phy_id = phy_reg << 16;
792
793 /* Grab the bits from PHYIR2, and put them in the lower half */
794 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
795 if (phy_reg < 0)
796 return -EIO;
797
798 *phy_id |= phy_reg;
799
800 return 0;
801 }
802
803 /**
804 * get_phy_device - reads the specified PHY device and returns its @phy_device
805 * struct
806 * @bus: the target MII bus
807 * @addr: PHY address on the MII bus
808 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
809 *
810 * Description: Reads the ID registers of the PHY at @addr on the
811 * @bus, then allocates and returns the phy_device to represent it.
812 */
get_phy_device(struct mii_bus * bus,int addr,bool is_c45)813 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
814 {
815 struct phy_c45_device_ids c45_ids;
816 u32 phy_id = 0;
817 int r;
818
819 c45_ids.devices_in_package = 0;
820 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
821
822 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
823 if (r)
824 return ERR_PTR(r);
825
826 /* If the phy_id is mostly Fs, there is no device there */
827 if ((phy_id & 0x1fffffff) == 0x1fffffff)
828 return ERR_PTR(-ENODEV);
829
830 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
831 }
832 EXPORT_SYMBOL(get_phy_device);
833
834 /**
835 * phy_device_register - Register the phy device on the MDIO bus
836 * @phydev: phy_device structure to be added to the MDIO bus
837 */
phy_device_register(struct phy_device * phydev)838 int phy_device_register(struct phy_device *phydev)
839 {
840 int err;
841
842 err = mdiobus_register_device(&phydev->mdio);
843 if (err)
844 return err;
845
846 /* Deassert the reset signal */
847 phy_device_reset(phydev, 0);
848
849 /* Run all of the fixups for this PHY */
850 err = phy_scan_fixups(phydev);
851 if (err) {
852 phydev_err(phydev, "failed to initialize\n");
853 goto out;
854 }
855
856 err = device_add(&phydev->mdio.dev);
857 if (err) {
858 phydev_err(phydev, "failed to add\n");
859 goto out;
860 }
861
862 return 0;
863
864 out:
865 /* Assert the reset signal */
866 phy_device_reset(phydev, 1);
867
868 mdiobus_unregister_device(&phydev->mdio);
869 return err;
870 }
871 EXPORT_SYMBOL(phy_device_register);
872
873 /**
874 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
875 * @phydev: phy_device structure to remove
876 *
877 * This doesn't free the phy_device itself, it merely reverses the effects
878 * of phy_device_register(). Use phy_device_free() to free the device
879 * after calling this function.
880 */
phy_device_remove(struct phy_device * phydev)881 void phy_device_remove(struct phy_device *phydev)
882 {
883 device_del(&phydev->mdio.dev);
884
885 /* Assert the reset signal */
886 phy_device_reset(phydev, 1);
887
888 mdiobus_unregister_device(&phydev->mdio);
889 }
890 EXPORT_SYMBOL(phy_device_remove);
891
892 /**
893 * phy_find_first - finds the first PHY device on the bus
894 * @bus: the target MII bus
895 */
phy_find_first(struct mii_bus * bus)896 struct phy_device *phy_find_first(struct mii_bus *bus)
897 {
898 struct phy_device *phydev;
899 int addr;
900
901 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
902 phydev = mdiobus_get_phy(bus, addr);
903 if (phydev)
904 return phydev;
905 }
906 return NULL;
907 }
908 EXPORT_SYMBOL(phy_find_first);
909
phy_link_change(struct phy_device * phydev,bool up,bool do_carrier)910 static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
911 {
912 struct net_device *netdev = phydev->attached_dev;
913
914 if (do_carrier) {
915 if (up)
916 netif_carrier_on(netdev);
917 else
918 netif_carrier_off(netdev);
919 }
920 phydev->adjust_link(netdev);
921 }
922
923 /**
924 * phy_prepare_link - prepares the PHY layer to monitor link status
925 * @phydev: target phy_device struct
926 * @handler: callback function for link status change notifications
927 *
928 * Description: Tells the PHY infrastructure to handle the
929 * gory details on monitoring link status (whether through
930 * polling or an interrupt), and to call back to the
931 * connected device driver when the link status changes.
932 * If you want to monitor your own link state, don't call
933 * this function.
934 */
phy_prepare_link(struct phy_device * phydev,void (* handler)(struct net_device *))935 static void phy_prepare_link(struct phy_device *phydev,
936 void (*handler)(struct net_device *))
937 {
938 phydev->adjust_link = handler;
939 }
940
941 /**
942 * phy_connect_direct - connect an ethernet device to a specific phy_device
943 * @dev: the network device to connect
944 * @phydev: the pointer to the phy device
945 * @handler: callback function for state change notifications
946 * @interface: PHY device's interface
947 */
phy_connect_direct(struct net_device * dev,struct phy_device * phydev,void (* handler)(struct net_device *),phy_interface_t interface)948 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
949 void (*handler)(struct net_device *),
950 phy_interface_t interface)
951 {
952 int rc;
953
954 if (!dev)
955 return -EINVAL;
956
957 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
958 if (rc)
959 return rc;
960
961 phy_prepare_link(phydev, handler);
962 if (phy_interrupt_is_valid(phydev))
963 phy_request_interrupt(phydev);
964
965 return 0;
966 }
967 EXPORT_SYMBOL(phy_connect_direct);
968
969 /**
970 * phy_connect - connect an ethernet device to a PHY device
971 * @dev: the network device to connect
972 * @bus_id: the id string of the PHY device to connect
973 * @handler: callback function for state change notifications
974 * @interface: PHY device's interface
975 *
976 * Description: Convenience function for connecting ethernet
977 * devices to PHY devices. The default behavior is for
978 * the PHY infrastructure to handle everything, and only notify
979 * the connected driver when the link status changes. If you
980 * don't want, or can't use the provided functionality, you may
981 * choose to call only the subset of functions which provide
982 * the desired functionality.
983 */
phy_connect(struct net_device * dev,const char * bus_id,void (* handler)(struct net_device *),phy_interface_t interface)984 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
985 void (*handler)(struct net_device *),
986 phy_interface_t interface)
987 {
988 struct phy_device *phydev;
989 struct device *d;
990 int rc;
991
992 /* Search the list of PHY devices on the mdio bus for the
993 * PHY with the requested name
994 */
995 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
996 if (!d) {
997 pr_err("PHY %s not found\n", bus_id);
998 return ERR_PTR(-ENODEV);
999 }
1000 phydev = to_phy_device(d);
1001
1002 rc = phy_connect_direct(dev, phydev, handler, interface);
1003 put_device(d);
1004 if (rc)
1005 return ERR_PTR(rc);
1006
1007 return phydev;
1008 }
1009 EXPORT_SYMBOL(phy_connect);
1010
1011 /**
1012 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1013 * device
1014 * @phydev: target phy_device struct
1015 */
phy_disconnect(struct phy_device * phydev)1016 void phy_disconnect(struct phy_device *phydev)
1017 {
1018 if (phy_is_started(phydev))
1019 phy_stop(phydev);
1020
1021 if (phy_interrupt_is_valid(phydev))
1022 phy_free_interrupt(phydev);
1023
1024 phydev->adjust_link = NULL;
1025
1026 phy_detach(phydev);
1027 }
1028 EXPORT_SYMBOL(phy_disconnect);
1029
1030 /**
1031 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1032 * @phydev: The PHY device to poll
1033 *
1034 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1035 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1036 * register must be polled until the BMCR_RESET bit clears.
1037 *
1038 * Furthermore, any attempts to write to PHY registers may have no effect
1039 * or even generate MDIO bus errors until this is complete.
1040 *
1041 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1042 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1043 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1044 * effort to support such broken PHYs, this function is separate from the
1045 * standard phy_init_hw() which will zero all the other bits in the BMCR
1046 * and reapply all driver-specific and board-specific fixups.
1047 */
phy_poll_reset(struct phy_device * phydev)1048 static int phy_poll_reset(struct phy_device *phydev)
1049 {
1050 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1051 unsigned int retries = 12;
1052 int ret;
1053
1054 do {
1055 msleep(50);
1056 ret = phy_read(phydev, MII_BMCR);
1057 if (ret < 0)
1058 return ret;
1059 } while (ret & BMCR_RESET && --retries);
1060 if (ret & BMCR_RESET)
1061 return -ETIMEDOUT;
1062
1063 /* Some chips (smsc911x) may still need up to another 1ms after the
1064 * BMCR_RESET bit is cleared before they are usable.
1065 */
1066 msleep(1);
1067 return 0;
1068 }
1069
phy_init_hw(struct phy_device * phydev)1070 int phy_init_hw(struct phy_device *phydev)
1071 {
1072 int ret = 0;
1073
1074 /* Deassert the reset signal */
1075 phy_device_reset(phydev, 0);
1076
1077 if (!phydev->drv)
1078 return 0;
1079
1080 if (phydev->drv->soft_reset)
1081 ret = phydev->drv->soft_reset(phydev);
1082
1083 if (ret < 0)
1084 return ret;
1085
1086 ret = phy_scan_fixups(phydev);
1087 if (ret < 0)
1088 return ret;
1089
1090 if (phydev->drv->config_init)
1091 ret = phydev->drv->config_init(phydev);
1092
1093 return ret;
1094 }
1095 EXPORT_SYMBOL(phy_init_hw);
1096
phy_attached_info(struct phy_device * phydev)1097 void phy_attached_info(struct phy_device *phydev)
1098 {
1099 phy_attached_print(phydev, NULL);
1100 }
1101 EXPORT_SYMBOL(phy_attached_info);
1102
1103 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
phy_attached_print(struct phy_device * phydev,const char * fmt,...)1104 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1105 {
1106 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1107 char *irq_str;
1108 char irq_num[8];
1109
1110 switch(phydev->irq) {
1111 case PHY_POLL:
1112 irq_str = "POLL";
1113 break;
1114 case PHY_IGNORE_INTERRUPT:
1115 irq_str = "IGNORE";
1116 break;
1117 default:
1118 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1119 irq_str = irq_num;
1120 break;
1121 }
1122
1123
1124 if (!fmt) {
1125 phydev_info(phydev, ATTACHED_FMT "\n",
1126 drv_name, phydev_name(phydev),
1127 irq_str);
1128 } else {
1129 va_list ap;
1130
1131 phydev_info(phydev, ATTACHED_FMT,
1132 drv_name, phydev_name(phydev),
1133 irq_str);
1134
1135 va_start(ap, fmt);
1136 vprintk(fmt, ap);
1137 va_end(ap);
1138 }
1139 }
1140 EXPORT_SYMBOL(phy_attached_print);
1141
phy_sysfs_create_links(struct phy_device * phydev)1142 static void phy_sysfs_create_links(struct phy_device *phydev)
1143 {
1144 struct net_device *dev = phydev->attached_dev;
1145 int err;
1146
1147 if (!dev)
1148 return;
1149
1150 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1151 "attached_dev");
1152 if (err)
1153 return;
1154
1155 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1156 &phydev->mdio.dev.kobj,
1157 "phydev");
1158 if (err) {
1159 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1160 kobject_name(&phydev->mdio.dev.kobj),
1161 err);
1162 /* non-fatal - some net drivers can use one netdevice
1163 * with more then one phy
1164 */
1165 }
1166
1167 phydev->sysfs_links = true;
1168 }
1169
1170 static ssize_t
phy_standalone_show(struct device * dev,struct device_attribute * attr,char * buf)1171 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1172 char *buf)
1173 {
1174 struct phy_device *phydev = to_phy_device(dev);
1175
1176 return sprintf(buf, "%d\n", !phydev->attached_dev);
1177 }
1178 static DEVICE_ATTR_RO(phy_standalone);
1179
1180 /**
1181 * phy_attach_direct - attach a network device to a given PHY device pointer
1182 * @dev: network device to attach
1183 * @phydev: Pointer to phy_device to attach
1184 * @flags: PHY device's dev_flags
1185 * @interface: PHY device's interface
1186 *
1187 * Description: Called by drivers to attach to a particular PHY
1188 * device. The phy_device is found, and properly hooked up
1189 * to the phy_driver. If no driver is attached, then a
1190 * generic driver is used. The phy_device is given a ptr to
1191 * the attaching device, and given a callback for link status
1192 * change. The phy_device is returned to the attaching driver.
1193 * This function takes a reference on the phy device.
1194 */
phy_attach_direct(struct net_device * dev,struct phy_device * phydev,u32 flags,phy_interface_t interface)1195 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1196 u32 flags, phy_interface_t interface)
1197 {
1198 struct mii_bus *bus = phydev->mdio.bus;
1199 struct device *d = &phydev->mdio.dev;
1200 struct module *ndev_owner = NULL;
1201 bool using_genphy = false;
1202 int err;
1203
1204 /* For Ethernet device drivers that register their own MDIO bus, we
1205 * will have bus->owner match ndev_mod, so we do not want to increment
1206 * our own module->refcnt here, otherwise we would not be able to
1207 * unload later on.
1208 */
1209 if (dev)
1210 ndev_owner = dev->dev.parent->driver->owner;
1211 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1212 phydev_err(phydev, "failed to get the bus module\n");
1213 return -EIO;
1214 }
1215
1216 get_device(d);
1217
1218 /* Assume that if there is no driver, that it doesn't
1219 * exist, and we should use the genphy driver.
1220 */
1221 if (!d->driver) {
1222 if (phydev->is_c45)
1223 d->driver = &genphy_c45_driver.mdiodrv.driver;
1224 else
1225 d->driver = &genphy_driver.mdiodrv.driver;
1226
1227 using_genphy = true;
1228 }
1229
1230 if (!try_module_get(d->driver->owner)) {
1231 phydev_err(phydev, "failed to get the device driver module\n");
1232 err = -EIO;
1233 goto error_put_device;
1234 }
1235
1236 if (using_genphy) {
1237 err = d->driver->probe(d);
1238 if (err >= 0)
1239 err = device_bind_driver(d);
1240
1241 if (err)
1242 goto error_module_put;
1243 }
1244
1245 if (phydev->attached_dev) {
1246 dev_err(&dev->dev, "PHY already attached\n");
1247 err = -EBUSY;
1248 goto error;
1249 }
1250
1251 phydev->phy_link_change = phy_link_change;
1252 if (dev) {
1253 phydev->attached_dev = dev;
1254 dev->phydev = phydev;
1255 }
1256
1257 /* Some Ethernet drivers try to connect to a PHY device before
1258 * calling register_netdevice() -> netdev_register_kobject() and
1259 * does the dev->dev.kobj initialization. Here we only check for
1260 * success which indicates that the network device kobject is
1261 * ready. Once we do that we still need to keep track of whether
1262 * links were successfully set up or not for phy_detach() to
1263 * remove them accordingly.
1264 */
1265 phydev->sysfs_links = false;
1266
1267 phy_sysfs_create_links(phydev);
1268
1269 if (!phydev->attached_dev) {
1270 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1271 &dev_attr_phy_standalone.attr);
1272 if (err)
1273 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1274 }
1275
1276 phydev->dev_flags = flags;
1277
1278 phydev->interface = interface;
1279
1280 phydev->state = PHY_READY;
1281
1282 /* Initial carrier state is off as the phy is about to be
1283 * (re)initialized.
1284 */
1285 if (dev)
1286 netif_carrier_off(phydev->attached_dev);
1287
1288 /* Do initial configuration here, now that
1289 * we have certain key parameters
1290 * (dev_flags and interface)
1291 */
1292 err = phy_init_hw(phydev);
1293 if (err)
1294 goto error;
1295
1296 phy_resume(phydev);
1297 phy_led_triggers_register(phydev);
1298
1299 return err;
1300
1301 error:
1302 /* phy_detach() does all of the cleanup below */
1303 phy_detach(phydev);
1304 return err;
1305
1306 error_module_put:
1307 module_put(d->driver->owner);
1308 error_put_device:
1309 put_device(d);
1310 if (ndev_owner != bus->owner)
1311 module_put(bus->owner);
1312 return err;
1313 }
1314 EXPORT_SYMBOL(phy_attach_direct);
1315
1316 /**
1317 * phy_attach - attach a network device to a particular PHY device
1318 * @dev: network device to attach
1319 * @bus_id: Bus ID of PHY device to attach
1320 * @interface: PHY device's interface
1321 *
1322 * Description: Same as phy_attach_direct() except that a PHY bus_id
1323 * string is passed instead of a pointer to a struct phy_device.
1324 */
phy_attach(struct net_device * dev,const char * bus_id,phy_interface_t interface)1325 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1326 phy_interface_t interface)
1327 {
1328 struct bus_type *bus = &mdio_bus_type;
1329 struct phy_device *phydev;
1330 struct device *d;
1331 int rc;
1332
1333 if (!dev)
1334 return ERR_PTR(-EINVAL);
1335
1336 /* Search the list of PHY devices on the mdio bus for the
1337 * PHY with the requested name
1338 */
1339 d = bus_find_device_by_name(bus, NULL, bus_id);
1340 if (!d) {
1341 pr_err("PHY %s not found\n", bus_id);
1342 return ERR_PTR(-ENODEV);
1343 }
1344 phydev = to_phy_device(d);
1345
1346 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1347 put_device(d);
1348 if (rc)
1349 return ERR_PTR(rc);
1350
1351 return phydev;
1352 }
1353 EXPORT_SYMBOL(phy_attach);
1354
phy_driver_is_genphy_kind(struct phy_device * phydev,struct device_driver * driver)1355 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1356 struct device_driver *driver)
1357 {
1358 struct device *d = &phydev->mdio.dev;
1359 bool ret = false;
1360
1361 if (!phydev->drv)
1362 return ret;
1363
1364 get_device(d);
1365 ret = d->driver == driver;
1366 put_device(d);
1367
1368 return ret;
1369 }
1370
phy_driver_is_genphy(struct phy_device * phydev)1371 bool phy_driver_is_genphy(struct phy_device *phydev)
1372 {
1373 return phy_driver_is_genphy_kind(phydev,
1374 &genphy_driver.mdiodrv.driver);
1375 }
1376 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1377
phy_driver_is_genphy_10g(struct phy_device * phydev)1378 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1379 {
1380 return phy_driver_is_genphy_kind(phydev,
1381 &genphy_c45_driver.mdiodrv.driver);
1382 }
1383 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1384
1385 /**
1386 * phy_detach - detach a PHY device from its network device
1387 * @phydev: target phy_device struct
1388 *
1389 * This detaches the phy device from its network device and the phy
1390 * driver, and drops the reference count taken in phy_attach_direct().
1391 */
phy_detach(struct phy_device * phydev)1392 void phy_detach(struct phy_device *phydev)
1393 {
1394 struct net_device *dev = phydev->attached_dev;
1395 struct module *ndev_owner = NULL;
1396 struct mii_bus *bus;
1397
1398 if (phydev->sysfs_links) {
1399 if (dev)
1400 sysfs_remove_link(&dev->dev.kobj, "phydev");
1401 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1402 }
1403
1404 if (!phydev->attached_dev)
1405 sysfs_remove_file(&phydev->mdio.dev.kobj,
1406 &dev_attr_phy_standalone.attr);
1407
1408 phy_suspend(phydev);
1409 if (dev) {
1410 phydev->attached_dev->phydev = NULL;
1411 phydev->attached_dev = NULL;
1412 }
1413 phydev->phylink = NULL;
1414
1415 phy_led_triggers_unregister(phydev);
1416
1417 module_put(phydev->mdio.dev.driver->owner);
1418
1419 /* If the device had no specific driver before (i.e. - it
1420 * was using the generic driver), we unbind the device
1421 * from the generic driver so that there's a chance a
1422 * real driver could be loaded
1423 */
1424 if (phy_driver_is_genphy(phydev) ||
1425 phy_driver_is_genphy_10g(phydev))
1426 device_release_driver(&phydev->mdio.dev);
1427
1428 /*
1429 * The phydev might go away on the put_device() below, so avoid
1430 * a use-after-free bug by reading the underlying bus first.
1431 */
1432 bus = phydev->mdio.bus;
1433
1434 put_device(&phydev->mdio.dev);
1435 if (dev)
1436 ndev_owner = dev->dev.parent->driver->owner;
1437 if (ndev_owner != bus->owner)
1438 module_put(bus->owner);
1439
1440 /* Assert the reset signal */
1441 phy_device_reset(phydev, 1);
1442 }
1443 EXPORT_SYMBOL(phy_detach);
1444
phy_suspend(struct phy_device * phydev)1445 int phy_suspend(struct phy_device *phydev)
1446 {
1447 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1448 struct net_device *netdev = phydev->attached_dev;
1449 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1450 int ret = 0;
1451
1452 /* If the device has WOL enabled, we cannot suspend the PHY */
1453 phy_ethtool_get_wol(phydev, &wol);
1454 if (wol.wolopts || (netdev && netdev->wol_enabled))
1455 return -EBUSY;
1456
1457 if (phydev->drv && phydrv->suspend)
1458 ret = phydrv->suspend(phydev);
1459
1460 if (ret)
1461 return ret;
1462
1463 phydev->suspended = true;
1464
1465 return ret;
1466 }
1467 EXPORT_SYMBOL(phy_suspend);
1468
__phy_resume(struct phy_device * phydev)1469 int __phy_resume(struct phy_device *phydev)
1470 {
1471 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1472 int ret = 0;
1473
1474 WARN_ON(!mutex_is_locked(&phydev->lock));
1475
1476 if (phydev->drv && phydrv->resume)
1477 ret = phydrv->resume(phydev);
1478
1479 if (ret)
1480 return ret;
1481
1482 phydev->suspended = false;
1483
1484 return ret;
1485 }
1486 EXPORT_SYMBOL(__phy_resume);
1487
phy_resume(struct phy_device * phydev)1488 int phy_resume(struct phy_device *phydev)
1489 {
1490 int ret;
1491
1492 mutex_lock(&phydev->lock);
1493 ret = __phy_resume(phydev);
1494 mutex_unlock(&phydev->lock);
1495
1496 return ret;
1497 }
1498 EXPORT_SYMBOL(phy_resume);
1499
phy_loopback(struct phy_device * phydev,bool enable)1500 int phy_loopback(struct phy_device *phydev, bool enable)
1501 {
1502 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1503 int ret = 0;
1504
1505 mutex_lock(&phydev->lock);
1506
1507 if (enable && phydev->loopback_enabled) {
1508 ret = -EBUSY;
1509 goto out;
1510 }
1511
1512 if (!enable && !phydev->loopback_enabled) {
1513 ret = -EINVAL;
1514 goto out;
1515 }
1516
1517 if (phydev->drv && phydrv->set_loopback)
1518 ret = phydrv->set_loopback(phydev, enable);
1519 else
1520 ret = -EOPNOTSUPP;
1521
1522 if (ret)
1523 goto out;
1524
1525 phydev->loopback_enabled = enable;
1526
1527 out:
1528 mutex_unlock(&phydev->lock);
1529 return ret;
1530 }
1531 EXPORT_SYMBOL(phy_loopback);
1532
1533 /**
1534 * phy_reset_after_clk_enable - perform a PHY reset if needed
1535 * @phydev: target phy_device struct
1536 *
1537 * Description: Some PHYs are known to need a reset after their refclk was
1538 * enabled. This function evaluates the flags and perform the reset if it's
1539 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1540 * was reset.
1541 */
phy_reset_after_clk_enable(struct phy_device * phydev)1542 int phy_reset_after_clk_enable(struct phy_device *phydev)
1543 {
1544 if (!phydev || !phydev->drv)
1545 return -ENODEV;
1546
1547 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1548 phy_device_reset(phydev, 1);
1549 phy_device_reset(phydev, 0);
1550 return 1;
1551 }
1552
1553 return 0;
1554 }
1555 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1556
1557 /* Generic PHY support and helper functions */
1558
1559 /**
1560 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1561 * @phydev: target phy_device struct
1562 *
1563 * Description: Writes MII_ADVERTISE with the appropriate values,
1564 * after sanitizing the values to make sure we only advertise
1565 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1566 * hasn't changed, and > 0 if it has changed.
1567 */
genphy_config_advert(struct phy_device * phydev)1568 static int genphy_config_advert(struct phy_device *phydev)
1569 {
1570 int err, bmsr, changed = 0;
1571 u32 adv;
1572
1573 /* Only allow advertising what this PHY supports */
1574 linkmode_and(phydev->advertising, phydev->advertising,
1575 phydev->supported);
1576
1577 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1578
1579 /* Setup standard advertisement */
1580 err = phy_modify_changed(phydev, MII_ADVERTISE,
1581 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1582 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1583 adv);
1584 if (err < 0)
1585 return err;
1586 if (err > 0)
1587 changed = 1;
1588
1589 bmsr = phy_read(phydev, MII_BMSR);
1590 if (bmsr < 0)
1591 return bmsr;
1592
1593 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1594 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1595 * logical 1.
1596 */
1597 if (!(bmsr & BMSR_ESTATEN))
1598 return changed;
1599
1600 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1601
1602 err = phy_modify_changed(phydev, MII_CTRL1000,
1603 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1604 adv);
1605 if (err < 0)
1606 return err;
1607 if (err > 0)
1608 changed = 1;
1609
1610 return changed;
1611 }
1612
1613 /**
1614 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1615 * @phydev: target phy_device struct
1616 *
1617 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1618 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1619 * changed, and 1 if it has changed.
1620 */
genphy_config_eee_advert(struct phy_device * phydev)1621 int genphy_config_eee_advert(struct phy_device *phydev)
1622 {
1623 int err;
1624
1625 /* Nothing to disable */
1626 if (!phydev->eee_broken_modes)
1627 return 0;
1628
1629 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1630 phydev->eee_broken_modes, 0);
1631 /* If the call failed, we assume that EEE is not supported */
1632 return err < 0 ? 0 : err;
1633 }
1634 EXPORT_SYMBOL(genphy_config_eee_advert);
1635
1636 /**
1637 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1638 * @phydev: target phy_device struct
1639 *
1640 * Description: Configures MII_BMCR to force speed/duplex
1641 * to the values in phydev. Assumes that the values are valid.
1642 * Please see phy_sanitize_settings().
1643 */
genphy_setup_forced(struct phy_device * phydev)1644 int genphy_setup_forced(struct phy_device *phydev)
1645 {
1646 u16 ctl = 0;
1647
1648 phydev->pause = 0;
1649 phydev->asym_pause = 0;
1650
1651 if (SPEED_1000 == phydev->speed)
1652 ctl |= BMCR_SPEED1000;
1653 else if (SPEED_100 == phydev->speed)
1654 ctl |= BMCR_SPEED100;
1655
1656 if (DUPLEX_FULL == phydev->duplex)
1657 ctl |= BMCR_FULLDPLX;
1658
1659 return phy_modify(phydev, MII_BMCR,
1660 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1661 }
1662 EXPORT_SYMBOL(genphy_setup_forced);
1663
1664 /**
1665 * genphy_restart_aneg - Enable and Restart Autonegotiation
1666 * @phydev: target phy_device struct
1667 */
genphy_restart_aneg(struct phy_device * phydev)1668 int genphy_restart_aneg(struct phy_device *phydev)
1669 {
1670 /* Don't isolate the PHY if we're negotiating */
1671 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
1672 BMCR_ANENABLE | BMCR_ANRESTART);
1673 }
1674 EXPORT_SYMBOL(genphy_restart_aneg);
1675
1676 /**
1677 * __genphy_config_aneg - restart auto-negotiation or write BMCR
1678 * @phydev: target phy_device struct
1679 * @changed: whether autoneg is requested
1680 *
1681 * Description: If auto-negotiation is enabled, we configure the
1682 * advertising, and then restart auto-negotiation. If it is not
1683 * enabled, then we write the BMCR.
1684 */
__genphy_config_aneg(struct phy_device * phydev,bool changed)1685 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
1686 {
1687 int err;
1688
1689 if (genphy_config_eee_advert(phydev))
1690 changed = true;
1691
1692 if (AUTONEG_ENABLE != phydev->autoneg)
1693 return genphy_setup_forced(phydev);
1694
1695 err = genphy_config_advert(phydev);
1696 if (err < 0) /* error */
1697 return err;
1698 else if (err)
1699 changed = true;
1700
1701 if (!changed) {
1702 /* Advertisement hasn't changed, but maybe aneg was never on to
1703 * begin with? Or maybe phy was isolated?
1704 */
1705 int ctl = phy_read(phydev, MII_BMCR);
1706
1707 if (ctl < 0)
1708 return ctl;
1709
1710 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1711 changed = true; /* do restart aneg */
1712 }
1713
1714 /* Only restart aneg if we are advertising something different
1715 * than we were before.
1716 */
1717 return changed ? genphy_restart_aneg(phydev) : 0;
1718 }
1719 EXPORT_SYMBOL(__genphy_config_aneg);
1720
1721 /**
1722 * genphy_aneg_done - return auto-negotiation status
1723 * @phydev: target phy_device struct
1724 *
1725 * Description: Reads the status register and returns 0 either if
1726 * auto-negotiation is incomplete, or if there was an error.
1727 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1728 */
genphy_aneg_done(struct phy_device * phydev)1729 int genphy_aneg_done(struct phy_device *phydev)
1730 {
1731 int retval = phy_read(phydev, MII_BMSR);
1732
1733 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1734 }
1735 EXPORT_SYMBOL(genphy_aneg_done);
1736
1737 /**
1738 * genphy_update_link - update link status in @phydev
1739 * @phydev: target phy_device struct
1740 *
1741 * Description: Update the value in phydev->link to reflect the
1742 * current link value. In order to do this, we need to read
1743 * the status register twice, keeping the second value.
1744 */
genphy_update_link(struct phy_device * phydev)1745 int genphy_update_link(struct phy_device *phydev)
1746 {
1747 int status = 0, bmcr;
1748
1749 bmcr = phy_read(phydev, MII_BMCR);
1750 if (bmcr < 0)
1751 return bmcr;
1752
1753 /* Autoneg is being started, therefore disregard BMSR value and
1754 * report link as down.
1755 */
1756 if (bmcr & BMCR_ANRESTART)
1757 goto done;
1758
1759 /* The link state is latched low so that momentary link
1760 * drops can be detected. Do not double-read the status
1761 * in polling mode to detect such short link drops.
1762 */
1763 if (!phy_polling_mode(phydev)) {
1764 status = phy_read(phydev, MII_BMSR);
1765 if (status < 0)
1766 return status;
1767 else if (status & BMSR_LSTATUS)
1768 goto done;
1769 }
1770
1771 /* Read link and autonegotiation status */
1772 status = phy_read(phydev, MII_BMSR);
1773 if (status < 0)
1774 return status;
1775 done:
1776 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
1777 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
1778
1779 /* Consider the case that autoneg was started and "aneg complete"
1780 * bit has been reset, but "link up" bit not yet.
1781 */
1782 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
1783 phydev->link = 0;
1784
1785 return 0;
1786 }
1787 EXPORT_SYMBOL(genphy_update_link);
1788
genphy_read_lpa(struct phy_device * phydev)1789 int genphy_read_lpa(struct phy_device *phydev)
1790 {
1791 int lpa, lpagb;
1792
1793 if (phydev->autoneg == AUTONEG_ENABLE) {
1794 if (!phydev->autoneg_complete) {
1795 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1796 0);
1797 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
1798 return 0;
1799 }
1800
1801 if (phydev->is_gigabit_capable) {
1802 lpagb = phy_read(phydev, MII_STAT1000);
1803 if (lpagb < 0)
1804 return lpagb;
1805
1806 if (lpagb & LPA_1000MSFAIL) {
1807 int adv = phy_read(phydev, MII_CTRL1000);
1808
1809 if (adv < 0)
1810 return adv;
1811
1812 if (adv & CTL1000_ENABLE_MASTER)
1813 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
1814 else
1815 phydev_err(phydev, "Master/Slave resolution failed\n");
1816 return -ENOLINK;
1817 }
1818
1819 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1820 lpagb);
1821 }
1822
1823 lpa = phy_read(phydev, MII_LPA);
1824 if (lpa < 0)
1825 return lpa;
1826
1827 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
1828 } else {
1829 linkmode_zero(phydev->lp_advertising);
1830 }
1831
1832 return 0;
1833 }
1834 EXPORT_SYMBOL(genphy_read_lpa);
1835
1836 /**
1837 * genphy_read_status - check the link status and update current link state
1838 * @phydev: target phy_device struct
1839 *
1840 * Description: Check the link, then figure out the current state
1841 * by comparing what we advertise with what the link partner
1842 * advertises. Start by checking the gigabit possibilities,
1843 * then move on to 10/100.
1844 */
genphy_read_status(struct phy_device * phydev)1845 int genphy_read_status(struct phy_device *phydev)
1846 {
1847 int err, old_link = phydev->link;
1848
1849 /* Update the link, but return if there was an error */
1850 err = genphy_update_link(phydev);
1851 if (err)
1852 return err;
1853
1854 /* why bother the PHY if nothing can have changed */
1855 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
1856 return 0;
1857
1858 phydev->speed = SPEED_UNKNOWN;
1859 phydev->duplex = DUPLEX_UNKNOWN;
1860 phydev->pause = 0;
1861 phydev->asym_pause = 0;
1862
1863 err = genphy_read_lpa(phydev);
1864 if (err < 0)
1865 return err;
1866
1867 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
1868 phy_resolve_aneg_linkmode(phydev);
1869 } else if (phydev->autoneg == AUTONEG_DISABLE) {
1870 int bmcr = phy_read(phydev, MII_BMCR);
1871
1872 if (bmcr < 0)
1873 return bmcr;
1874
1875 if (bmcr & BMCR_FULLDPLX)
1876 phydev->duplex = DUPLEX_FULL;
1877 else
1878 phydev->duplex = DUPLEX_HALF;
1879
1880 if (bmcr & BMCR_SPEED1000)
1881 phydev->speed = SPEED_1000;
1882 else if (bmcr & BMCR_SPEED100)
1883 phydev->speed = SPEED_100;
1884 else
1885 phydev->speed = SPEED_10;
1886 }
1887
1888 return 0;
1889 }
1890 EXPORT_SYMBOL(genphy_read_status);
1891
1892 /**
1893 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1894 * @phydev: target phy_device struct
1895 *
1896 * Description: Perform a software PHY reset using the standard
1897 * BMCR_RESET bit and poll for the reset bit to be cleared.
1898 *
1899 * Returns: 0 on success, < 0 on failure
1900 */
genphy_soft_reset(struct phy_device * phydev)1901 int genphy_soft_reset(struct phy_device *phydev)
1902 {
1903 u16 res = BMCR_RESET;
1904 int ret;
1905
1906 if (phydev->autoneg == AUTONEG_ENABLE)
1907 res |= BMCR_ANRESTART;
1908
1909 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
1910 if (ret < 0)
1911 return ret;
1912
1913 ret = phy_poll_reset(phydev);
1914 if (ret)
1915 return ret;
1916
1917 /* BMCR may be reset to defaults */
1918 if (phydev->autoneg == AUTONEG_DISABLE)
1919 ret = genphy_setup_forced(phydev);
1920
1921 return ret;
1922 }
1923 EXPORT_SYMBOL(genphy_soft_reset);
1924
1925 /**
1926 * genphy_read_abilities - read PHY abilities from Clause 22 registers
1927 * @phydev: target phy_device struct
1928 *
1929 * Description: Reads the PHY's abilities and populates
1930 * phydev->supported accordingly.
1931 *
1932 * Returns: 0 on success, < 0 on failure
1933 */
genphy_read_abilities(struct phy_device * phydev)1934 int genphy_read_abilities(struct phy_device *phydev)
1935 {
1936 int val;
1937
1938 linkmode_set_bit_array(phy_basic_ports_array,
1939 ARRAY_SIZE(phy_basic_ports_array),
1940 phydev->supported);
1941
1942 val = phy_read(phydev, MII_BMSR);
1943 if (val < 0)
1944 return val;
1945
1946 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
1947 val & BMSR_ANEGCAPABLE);
1948
1949 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
1950 val & BMSR_100FULL);
1951 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
1952 val & BMSR_100HALF);
1953 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
1954 val & BMSR_10FULL);
1955 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
1956 val & BMSR_10HALF);
1957
1958 if (val & BMSR_ESTATEN) {
1959 val = phy_read(phydev, MII_ESTATUS);
1960 if (val < 0)
1961 return val;
1962
1963 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1964 phydev->supported, val & ESTATUS_1000_TFULL);
1965 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1966 phydev->supported, val & ESTATUS_1000_THALF);
1967 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1968 phydev->supported, val & ESTATUS_1000_XFULL);
1969 }
1970
1971 return 0;
1972 }
1973 EXPORT_SYMBOL(genphy_read_abilities);
1974
1975 /* This is used for the phy device which doesn't support the MMD extended
1976 * register access, but it does have side effect when we are trying to access
1977 * the MMD register via indirect method.
1978 */
genphy_read_mmd_unsupported(struct phy_device * phdev,int devad,u16 regnum)1979 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
1980 {
1981 return -EOPNOTSUPP;
1982 }
1983 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
1984
genphy_write_mmd_unsupported(struct phy_device * phdev,int devnum,u16 regnum,u16 val)1985 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1986 u16 regnum, u16 val)
1987 {
1988 return -EOPNOTSUPP;
1989 }
1990 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
1991
genphy_suspend(struct phy_device * phydev)1992 int genphy_suspend(struct phy_device *phydev)
1993 {
1994 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
1995 }
1996 EXPORT_SYMBOL(genphy_suspend);
1997
genphy_resume(struct phy_device * phydev)1998 int genphy_resume(struct phy_device *phydev)
1999 {
2000 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2001 }
2002 EXPORT_SYMBOL(genphy_resume);
2003
genphy_loopback(struct phy_device * phydev,bool enable)2004 int genphy_loopback(struct phy_device *phydev, bool enable)
2005 {
2006 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2007 enable ? BMCR_LOOPBACK : 0);
2008 }
2009 EXPORT_SYMBOL(genphy_loopback);
2010
2011 /**
2012 * phy_remove_link_mode - Remove a supported link mode
2013 * @phydev: phy_device structure to remove link mode from
2014 * @link_mode: Link mode to be removed
2015 *
2016 * Description: Some MACs don't support all link modes which the PHY
2017 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2018 * to remove a link mode.
2019 */
phy_remove_link_mode(struct phy_device * phydev,u32 link_mode)2020 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2021 {
2022 linkmode_clear_bit(link_mode, phydev->supported);
2023 phy_advertise_supported(phydev);
2024 }
2025 EXPORT_SYMBOL(phy_remove_link_mode);
2026
phy_copy_pause_bits(unsigned long * dst,unsigned long * src)2027 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2028 {
2029 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2030 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2031 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2032 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2033 }
2034
2035 /**
2036 * phy_advertise_supported - Advertise all supported modes
2037 * @phydev: target phy_device struct
2038 *
2039 * Description: Called to advertise all supported modes, doesn't touch
2040 * pause mode advertising.
2041 */
phy_advertise_supported(struct phy_device * phydev)2042 void phy_advertise_supported(struct phy_device *phydev)
2043 {
2044 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2045
2046 linkmode_copy(new, phydev->supported);
2047 phy_copy_pause_bits(new, phydev->advertising);
2048 linkmode_copy(phydev->advertising, new);
2049 }
2050 EXPORT_SYMBOL(phy_advertise_supported);
2051
2052 /**
2053 * phy_support_sym_pause - Enable support of symmetrical pause
2054 * @phydev: target phy_device struct
2055 *
2056 * Description: Called by the MAC to indicate is supports symmetrical
2057 * Pause, but not asym pause.
2058 */
phy_support_sym_pause(struct phy_device * phydev)2059 void phy_support_sym_pause(struct phy_device *phydev)
2060 {
2061 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2062 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2063 }
2064 EXPORT_SYMBOL(phy_support_sym_pause);
2065
2066 /**
2067 * phy_support_asym_pause - Enable support of asym pause
2068 * @phydev: target phy_device struct
2069 *
2070 * Description: Called by the MAC to indicate is supports Asym Pause.
2071 */
phy_support_asym_pause(struct phy_device * phydev)2072 void phy_support_asym_pause(struct phy_device *phydev)
2073 {
2074 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2075 }
2076 EXPORT_SYMBOL(phy_support_asym_pause);
2077
2078 /**
2079 * phy_set_sym_pause - Configure symmetric Pause
2080 * @phydev: target phy_device struct
2081 * @rx: Receiver Pause is supported
2082 * @tx: Transmit Pause is supported
2083 * @autoneg: Auto neg should be used
2084 *
2085 * Description: Configure advertised Pause support depending on if
2086 * receiver pause and pause auto neg is supported. Generally called
2087 * from the set_pauseparam .ndo.
2088 */
phy_set_sym_pause(struct phy_device * phydev,bool rx,bool tx,bool autoneg)2089 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2090 bool autoneg)
2091 {
2092 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2093
2094 if (rx && tx && autoneg)
2095 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2096 phydev->supported);
2097
2098 linkmode_copy(phydev->advertising, phydev->supported);
2099 }
2100 EXPORT_SYMBOL(phy_set_sym_pause);
2101
2102 /**
2103 * phy_set_asym_pause - Configure Pause and Asym Pause
2104 * @phydev: target phy_device struct
2105 * @rx: Receiver Pause is supported
2106 * @tx: Transmit Pause is supported
2107 *
2108 * Description: Configure advertised Pause support depending on if
2109 * transmit and receiver pause is supported. If there has been a
2110 * change in adverting, trigger a new autoneg. Generally called from
2111 * the set_pauseparam .ndo.
2112 */
phy_set_asym_pause(struct phy_device * phydev,bool rx,bool tx)2113 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2114 {
2115 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2116
2117 linkmode_copy(oldadv, phydev->advertising);
2118
2119 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2120 phydev->advertising);
2121 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2122 phydev->advertising);
2123
2124 if (rx) {
2125 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2126 phydev->advertising);
2127 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2128 phydev->advertising);
2129 }
2130
2131 if (tx)
2132 linkmode_change_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2133 phydev->advertising);
2134
2135 if (!linkmode_equal(oldadv, phydev->advertising) &&
2136 phydev->autoneg)
2137 phy_start_aneg(phydev);
2138 }
2139 EXPORT_SYMBOL(phy_set_asym_pause);
2140
2141 /**
2142 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2143 * @phydev: phy_device struct
2144 * @pp: requested pause configuration
2145 *
2146 * Description: Test if the PHY/MAC combination supports the Pause
2147 * configuration the user is requesting. Returns True if it is
2148 * supported, false otherwise.
2149 */
phy_validate_pause(struct phy_device * phydev,struct ethtool_pauseparam * pp)2150 bool phy_validate_pause(struct phy_device *phydev,
2151 struct ethtool_pauseparam *pp)
2152 {
2153 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2154 phydev->supported) && pp->rx_pause)
2155 return false;
2156
2157 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2158 phydev->supported) &&
2159 pp->rx_pause != pp->tx_pause)
2160 return false;
2161
2162 return true;
2163 }
2164 EXPORT_SYMBOL(phy_validate_pause);
2165
phy_drv_supports_irq(struct phy_driver * phydrv)2166 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2167 {
2168 return phydrv->config_intr && phydrv->ack_interrupt;
2169 }
2170
2171 /**
2172 * phy_probe - probe and init a PHY device
2173 * @dev: device to probe and init
2174 *
2175 * Description: Take care of setting up the phy_device structure,
2176 * set the state to READY (the driver's init function should
2177 * set it to STARTING if needed).
2178 */
phy_probe(struct device * dev)2179 static int phy_probe(struct device *dev)
2180 {
2181 struct phy_device *phydev = to_phy_device(dev);
2182 struct device_driver *drv = phydev->mdio.dev.driver;
2183 struct phy_driver *phydrv = to_phy_driver(drv);
2184 int err = 0;
2185
2186 phydev->drv = phydrv;
2187
2188 /* Disable the interrupt if the PHY doesn't support it
2189 * but the interrupt is still a valid one
2190 */
2191 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2192 phydev->irq = PHY_POLL;
2193
2194 if (phydrv->flags & PHY_IS_INTERNAL)
2195 phydev->is_internal = true;
2196
2197 mutex_lock(&phydev->lock);
2198
2199 if (phydev->drv->probe) {
2200 /* Deassert the reset signal */
2201 phy_device_reset(phydev, 0);
2202
2203 err = phydev->drv->probe(phydev);
2204 if (err) {
2205 /* Assert the reset signal */
2206 phy_device_reset(phydev, 1);
2207 goto out;
2208 }
2209 }
2210
2211 /* Start out supporting everything. Eventually,
2212 * a controller will attach, and may modify one
2213 * or both of these values
2214 */
2215 if (phydrv->features) {
2216 linkmode_copy(phydev->supported, phydrv->features);
2217 } else if (phydrv->get_features) {
2218 err = phydrv->get_features(phydev);
2219 } else if (phydev->is_c45) {
2220 err = genphy_c45_pma_read_abilities(phydev);
2221 } else {
2222 err = genphy_read_abilities(phydev);
2223 }
2224
2225 if (err)
2226 goto out;
2227
2228 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2229 phydev->supported))
2230 phydev->autoneg = 0;
2231
2232 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2233 phydev->supported))
2234 phydev->is_gigabit_capable = 1;
2235 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2236 phydev->supported))
2237 phydev->is_gigabit_capable = 1;
2238
2239 of_set_phy_supported(phydev);
2240 phy_advertise_supported(phydev);
2241
2242 /* Get the EEE modes we want to prohibit. We will ask
2243 * the PHY stop advertising these mode later on
2244 */
2245 of_set_phy_eee_broken(phydev);
2246
2247 /* The Pause Frame bits indicate that the PHY can support passing
2248 * pause frames. During autonegotiation, the PHYs will determine if
2249 * they should allow pause frames to pass. The MAC driver should then
2250 * use that result to determine whether to enable flow control via
2251 * pause frames.
2252 *
2253 * Normally, PHY drivers should not set the Pause bits, and instead
2254 * allow phylib to do that. However, there may be some situations
2255 * (e.g. hardware erratum) where the driver wants to set only one
2256 * of these bits.
2257 */
2258 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2259 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2260 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2261 phydev->supported);
2262 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2263 phydev->supported);
2264 }
2265
2266 /* Set the state to READY by default */
2267 phydev->state = PHY_READY;
2268
2269 out:
2270 mutex_unlock(&phydev->lock);
2271
2272 return err;
2273 }
2274
phy_remove(struct device * dev)2275 static int phy_remove(struct device *dev)
2276 {
2277 struct phy_device *phydev = to_phy_device(dev);
2278
2279 cancel_delayed_work_sync(&phydev->state_queue);
2280
2281 mutex_lock(&phydev->lock);
2282 phydev->state = PHY_DOWN;
2283 mutex_unlock(&phydev->lock);
2284
2285 if (phydev->drv && phydev->drv->remove) {
2286 phydev->drv->remove(phydev);
2287
2288 /* Assert the reset signal */
2289 phy_device_reset(phydev, 1);
2290 }
2291 phydev->drv = NULL;
2292
2293 return 0;
2294 }
2295
2296 /**
2297 * phy_driver_register - register a phy_driver with the PHY layer
2298 * @new_driver: new phy_driver to register
2299 * @owner: module owning this PHY
2300 */
phy_driver_register(struct phy_driver * new_driver,struct module * owner)2301 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2302 {
2303 int retval;
2304
2305 /* Either the features are hard coded, or dynamically
2306 * determined. It cannot be both.
2307 */
2308 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2309 pr_err("%s: features and get_features must not both be set\n",
2310 new_driver->name);
2311 return -EINVAL;
2312 }
2313
2314 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2315 new_driver->mdiodrv.driver.name = new_driver->name;
2316 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2317 new_driver->mdiodrv.driver.probe = phy_probe;
2318 new_driver->mdiodrv.driver.remove = phy_remove;
2319 new_driver->mdiodrv.driver.owner = owner;
2320
2321 retval = driver_register(&new_driver->mdiodrv.driver);
2322 if (retval) {
2323 pr_err("%s: Error %d in registering driver\n",
2324 new_driver->name, retval);
2325
2326 return retval;
2327 }
2328
2329 pr_debug("%s: Registered new driver\n", new_driver->name);
2330
2331 return 0;
2332 }
2333 EXPORT_SYMBOL(phy_driver_register);
2334
phy_drivers_register(struct phy_driver * new_driver,int n,struct module * owner)2335 int phy_drivers_register(struct phy_driver *new_driver, int n,
2336 struct module *owner)
2337 {
2338 int i, ret = 0;
2339
2340 for (i = 0; i < n; i++) {
2341 ret = phy_driver_register(new_driver + i, owner);
2342 if (ret) {
2343 while (i-- > 0)
2344 phy_driver_unregister(new_driver + i);
2345 break;
2346 }
2347 }
2348 return ret;
2349 }
2350 EXPORT_SYMBOL(phy_drivers_register);
2351
phy_driver_unregister(struct phy_driver * drv)2352 void phy_driver_unregister(struct phy_driver *drv)
2353 {
2354 driver_unregister(&drv->mdiodrv.driver);
2355 }
2356 EXPORT_SYMBOL(phy_driver_unregister);
2357
phy_drivers_unregister(struct phy_driver * drv,int n)2358 void phy_drivers_unregister(struct phy_driver *drv, int n)
2359 {
2360 int i;
2361
2362 for (i = 0; i < n; i++)
2363 phy_driver_unregister(drv + i);
2364 }
2365 EXPORT_SYMBOL(phy_drivers_unregister);
2366
2367 static struct phy_driver genphy_driver = {
2368 .phy_id = 0xffffffff,
2369 .phy_id_mask = 0xffffffff,
2370 .name = "Generic PHY",
2371 .soft_reset = genphy_no_soft_reset,
2372 .get_features = genphy_read_abilities,
2373 .aneg_done = genphy_aneg_done,
2374 .suspend = genphy_suspend,
2375 .resume = genphy_resume,
2376 .set_loopback = genphy_loopback,
2377 };
2378
phy_init(void)2379 static int __init phy_init(void)
2380 {
2381 int rc;
2382
2383 rc = mdio_bus_init();
2384 if (rc)
2385 return rc;
2386
2387 features_init();
2388
2389 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
2390 if (rc)
2391 goto err_c45;
2392
2393 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2394 if (rc) {
2395 phy_driver_unregister(&genphy_c45_driver);
2396 err_c45:
2397 mdio_bus_exit();
2398 }
2399
2400 return rc;
2401 }
2402
phy_exit(void)2403 static void __exit phy_exit(void)
2404 {
2405 phy_driver_unregister(&genphy_c45_driver);
2406 phy_driver_unregister(&genphy_driver);
2407 mdio_bus_exit();
2408 }
2409
2410 subsys_initcall(phy_init);
2411 module_exit(phy_exit);
2412