Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
fork
Configure Feed
Select the types of activity you want to include in your feed.
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/sfp.h>
31#include <linux/mdio.h>
32#include <linux/io.h>
33#include <linux/uaccess.h>
34
35MODULE_DESCRIPTION("PHY library");
36MODULE_AUTHOR("Andy Fleming");
37MODULE_LICENSE("GPL");
38
39__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
40EXPORT_SYMBOL_GPL(phy_basic_features);
41
42__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
43EXPORT_SYMBOL_GPL(phy_basic_t1_features);
44
45__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
46EXPORT_SYMBOL_GPL(phy_gbit_features);
47
48__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
49EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
50
51__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
52EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
53
54__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
55EXPORT_SYMBOL_GPL(phy_10gbit_features);
56
57__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
58EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
59
60const int phy_basic_ports_array[3] = {
61 ETHTOOL_LINK_MODE_Autoneg_BIT,
62 ETHTOOL_LINK_MODE_TP_BIT,
63 ETHTOOL_LINK_MODE_MII_BIT,
64};
65EXPORT_SYMBOL_GPL(phy_basic_ports_array);
66
67const int phy_fibre_port_array[1] = {
68 ETHTOOL_LINK_MODE_FIBRE_BIT,
69};
70EXPORT_SYMBOL_GPL(phy_fibre_port_array);
71
72const int phy_all_ports_features_array[7] = {
73 ETHTOOL_LINK_MODE_Autoneg_BIT,
74 ETHTOOL_LINK_MODE_TP_BIT,
75 ETHTOOL_LINK_MODE_MII_BIT,
76 ETHTOOL_LINK_MODE_FIBRE_BIT,
77 ETHTOOL_LINK_MODE_AUI_BIT,
78 ETHTOOL_LINK_MODE_BNC_BIT,
79 ETHTOOL_LINK_MODE_Backplane_BIT,
80};
81EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
82
83const int phy_10_100_features_array[4] = {
84 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
85 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
86 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
87 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
88};
89EXPORT_SYMBOL_GPL(phy_10_100_features_array);
90
91const int phy_basic_t1_features_array[2] = {
92 ETHTOOL_LINK_MODE_TP_BIT,
93 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
94};
95EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
96
97const int phy_gbit_features_array[2] = {
98 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
99 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
100};
101EXPORT_SYMBOL_GPL(phy_gbit_features_array);
102
103const int phy_10gbit_features_array[1] = {
104 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
105};
106EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
107
108const int phy_10gbit_fec_features_array[1] = {
109 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
110};
111EXPORT_SYMBOL_GPL(phy_10gbit_fec_features_array);
112
113__ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
114EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
115
116static const int phy_10gbit_full_features_array[] = {
117 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
118 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
119 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
120 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
121};
122
123static void features_init(void)
124{
125 /* 10/100 half/full*/
126 linkmode_set_bit_array(phy_basic_ports_array,
127 ARRAY_SIZE(phy_basic_ports_array),
128 phy_basic_features);
129 linkmode_set_bit_array(phy_10_100_features_array,
130 ARRAY_SIZE(phy_10_100_features_array),
131 phy_basic_features);
132
133 /* 100 full, TP */
134 linkmode_set_bit_array(phy_basic_t1_features_array,
135 ARRAY_SIZE(phy_basic_t1_features_array),
136 phy_basic_t1_features);
137
138 /* 10/100 half/full + 1000 half/full */
139 linkmode_set_bit_array(phy_basic_ports_array,
140 ARRAY_SIZE(phy_basic_ports_array),
141 phy_gbit_features);
142 linkmode_set_bit_array(phy_10_100_features_array,
143 ARRAY_SIZE(phy_10_100_features_array),
144 phy_gbit_features);
145 linkmode_set_bit_array(phy_gbit_features_array,
146 ARRAY_SIZE(phy_gbit_features_array),
147 phy_gbit_features);
148
149 /* 10/100 half/full + 1000 half/full + fibre*/
150 linkmode_set_bit_array(phy_basic_ports_array,
151 ARRAY_SIZE(phy_basic_ports_array),
152 phy_gbit_fibre_features);
153 linkmode_set_bit_array(phy_10_100_features_array,
154 ARRAY_SIZE(phy_10_100_features_array),
155 phy_gbit_fibre_features);
156 linkmode_set_bit_array(phy_gbit_features_array,
157 ARRAY_SIZE(phy_gbit_features_array),
158 phy_gbit_fibre_features);
159 linkmode_set_bit_array(phy_fibre_port_array,
160 ARRAY_SIZE(phy_fibre_port_array),
161 phy_gbit_fibre_features);
162
163 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
164 linkmode_set_bit_array(phy_all_ports_features_array,
165 ARRAY_SIZE(phy_all_ports_features_array),
166 phy_gbit_all_ports_features);
167 linkmode_set_bit_array(phy_10_100_features_array,
168 ARRAY_SIZE(phy_10_100_features_array),
169 phy_gbit_all_ports_features);
170 linkmode_set_bit_array(phy_gbit_features_array,
171 ARRAY_SIZE(phy_gbit_features_array),
172 phy_gbit_all_ports_features);
173
174 /* 10/100 half/full + 1000 half/full + 10G full*/
175 linkmode_set_bit_array(phy_all_ports_features_array,
176 ARRAY_SIZE(phy_all_ports_features_array),
177 phy_10gbit_features);
178 linkmode_set_bit_array(phy_10_100_features_array,
179 ARRAY_SIZE(phy_10_100_features_array),
180 phy_10gbit_features);
181 linkmode_set_bit_array(phy_gbit_features_array,
182 ARRAY_SIZE(phy_gbit_features_array),
183 phy_10gbit_features);
184 linkmode_set_bit_array(phy_10gbit_features_array,
185 ARRAY_SIZE(phy_10gbit_features_array),
186 phy_10gbit_features);
187
188 /* 10/100/1000/10G full */
189 linkmode_set_bit_array(phy_all_ports_features_array,
190 ARRAY_SIZE(phy_all_ports_features_array),
191 phy_10gbit_full_features);
192 linkmode_set_bit_array(phy_10gbit_full_features_array,
193 ARRAY_SIZE(phy_10gbit_full_features_array),
194 phy_10gbit_full_features);
195 /* 10G FEC only */
196 linkmode_set_bit_array(phy_10gbit_fec_features_array,
197 ARRAY_SIZE(phy_10gbit_fec_features_array),
198 phy_10gbit_fec_features);
199}
200
201void phy_device_free(struct phy_device *phydev)
202{
203 put_device(&phydev->mdio.dev);
204}
205EXPORT_SYMBOL(phy_device_free);
206
207static void phy_mdio_device_free(struct mdio_device *mdiodev)
208{
209 struct phy_device *phydev;
210
211 phydev = container_of(mdiodev, struct phy_device, mdio);
212 phy_device_free(phydev);
213}
214
215static void phy_device_release(struct device *dev)
216{
217 kfree(to_phy_device(dev));
218}
219
220static void phy_mdio_device_remove(struct mdio_device *mdiodev)
221{
222 struct phy_device *phydev;
223
224 phydev = container_of(mdiodev, struct phy_device, mdio);
225 phy_device_remove(phydev);
226}
227
228static struct phy_driver genphy_driver;
229extern struct phy_driver genphy_c45_driver;
230
231static LIST_HEAD(phy_fixup_list);
232static DEFINE_MUTEX(phy_fixup_lock);
233
234#ifdef CONFIG_PM
235static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
236{
237 struct device_driver *drv = phydev->mdio.dev.driver;
238 struct phy_driver *phydrv = to_phy_driver(drv);
239 struct net_device *netdev = phydev->attached_dev;
240
241 if (!drv || !phydrv->suspend)
242 return false;
243
244 /* PHY not attached? May suspend if the PHY has not already been
245 * suspended as part of a prior call to phy_disconnect() ->
246 * phy_detach() -> phy_suspend() because the parent netdev might be the
247 * MDIO bus driver and clock gated at this point.
248 */
249 if (!netdev)
250 return !phydev->suspended;
251
252 if (netdev->wol_enabled)
253 return false;
254
255 /* As long as not all affected network drivers support the
256 * wol_enabled flag, let's check for hints that WoL is enabled.
257 * Don't suspend PHY if the attached netdev parent may wake up.
258 * The parent may point to a PCI device, as in tg3 driver.
259 */
260 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
261 return false;
262
263 /* Also don't suspend PHY if the netdev itself may wakeup. This
264 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
265 * e.g. SoC devices.
266 */
267 if (device_may_wakeup(&netdev->dev))
268 return false;
269
270 return true;
271}
272
273static int mdio_bus_phy_suspend(struct device *dev)
274{
275 struct phy_device *phydev = to_phy_device(dev);
276
277 /* We must stop the state machine manually, otherwise it stops out of
278 * control, possibly with the phydev->lock held. Upon resume, netdev
279 * may call phy routines that try to grab the same lock, and that may
280 * lead to a deadlock.
281 */
282 if (phydev->attached_dev && phydev->adjust_link)
283 phy_stop_machine(phydev);
284
285 if (!mdio_bus_phy_may_suspend(phydev))
286 return 0;
287
288 return phy_suspend(phydev);
289}
290
291static int mdio_bus_phy_resume(struct device *dev)
292{
293 struct phy_device *phydev = to_phy_device(dev);
294 int ret;
295
296 if (!mdio_bus_phy_may_suspend(phydev))
297 goto no_resume;
298
299 ret = phy_resume(phydev);
300 if (ret < 0)
301 return ret;
302
303no_resume:
304 if (phydev->attached_dev && phydev->adjust_link)
305 phy_start_machine(phydev);
306
307 return 0;
308}
309
310static int mdio_bus_phy_restore(struct device *dev)
311{
312 struct phy_device *phydev = to_phy_device(dev);
313 struct net_device *netdev = phydev->attached_dev;
314 int ret;
315
316 if (!netdev)
317 return 0;
318
319 ret = phy_init_hw(phydev);
320 if (ret < 0)
321 return ret;
322
323 if (phydev->attached_dev && phydev->adjust_link)
324 phy_start_machine(phydev);
325
326 return 0;
327}
328
329static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
330 .suspend = mdio_bus_phy_suspend,
331 .resume = mdio_bus_phy_resume,
332 .freeze = mdio_bus_phy_suspend,
333 .thaw = mdio_bus_phy_resume,
334 .restore = mdio_bus_phy_restore,
335};
336
337#define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
338
339#else
340
341#define MDIO_BUS_PHY_PM_OPS NULL
342
343#endif /* CONFIG_PM */
344
345/**
346 * phy_register_fixup - creates a new phy_fixup and adds it to the list
347 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
348 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
349 * It can also be PHY_ANY_UID
350 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
351 * comparison
352 * @run: The actual code to be run when a matching PHY is found
353 */
354int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
355 int (*run)(struct phy_device *))
356{
357 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
358
359 if (!fixup)
360 return -ENOMEM;
361
362 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
363 fixup->phy_uid = phy_uid;
364 fixup->phy_uid_mask = phy_uid_mask;
365 fixup->run = run;
366
367 mutex_lock(&phy_fixup_lock);
368 list_add_tail(&fixup->list, &phy_fixup_list);
369 mutex_unlock(&phy_fixup_lock);
370
371 return 0;
372}
373EXPORT_SYMBOL(phy_register_fixup);
374
375/* Registers a fixup to be run on any PHY with the UID in phy_uid */
376int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
377 int (*run)(struct phy_device *))
378{
379 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
380}
381EXPORT_SYMBOL(phy_register_fixup_for_uid);
382
383/* Registers a fixup to be run on the PHY with id string bus_id */
384int phy_register_fixup_for_id(const char *bus_id,
385 int (*run)(struct phy_device *))
386{
387 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
388}
389EXPORT_SYMBOL(phy_register_fixup_for_id);
390
391/**
392 * phy_unregister_fixup - remove a phy_fixup from the list
393 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
394 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
395 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
396 */
397int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
398{
399 struct list_head *pos, *n;
400 struct phy_fixup *fixup;
401 int ret;
402
403 ret = -ENODEV;
404
405 mutex_lock(&phy_fixup_lock);
406 list_for_each_safe(pos, n, &phy_fixup_list) {
407 fixup = list_entry(pos, struct phy_fixup, list);
408
409 if ((!strcmp(fixup->bus_id, bus_id)) &&
410 ((fixup->phy_uid & phy_uid_mask) ==
411 (phy_uid & phy_uid_mask))) {
412 list_del(&fixup->list);
413 kfree(fixup);
414 ret = 0;
415 break;
416 }
417 }
418 mutex_unlock(&phy_fixup_lock);
419
420 return ret;
421}
422EXPORT_SYMBOL(phy_unregister_fixup);
423
424/* Unregisters a fixup of any PHY with the UID in phy_uid */
425int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
426{
427 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
428}
429EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
430
431/* Unregisters a fixup of the PHY with id string bus_id */
432int phy_unregister_fixup_for_id(const char *bus_id)
433{
434 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
435}
436EXPORT_SYMBOL(phy_unregister_fixup_for_id);
437
438/* Returns 1 if fixup matches phydev in bus_id and phy_uid.
439 * Fixups can be set to match any in one or more fields.
440 */
441static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
442{
443 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
444 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
445 return 0;
446
447 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
448 (phydev->phy_id & fixup->phy_uid_mask))
449 if (fixup->phy_uid != PHY_ANY_UID)
450 return 0;
451
452 return 1;
453}
454
455/* Runs any matching fixups for this phydev */
456static int phy_scan_fixups(struct phy_device *phydev)
457{
458 struct phy_fixup *fixup;
459
460 mutex_lock(&phy_fixup_lock);
461 list_for_each_entry(fixup, &phy_fixup_list, list) {
462 if (phy_needs_fixup(phydev, fixup)) {
463 int err = fixup->run(phydev);
464
465 if (err < 0) {
466 mutex_unlock(&phy_fixup_lock);
467 return err;
468 }
469 phydev->has_fixups = true;
470 }
471 }
472 mutex_unlock(&phy_fixup_lock);
473
474 return 0;
475}
476
477static int phy_bus_match(struct device *dev, struct device_driver *drv)
478{
479 struct phy_device *phydev = to_phy_device(dev);
480 struct phy_driver *phydrv = to_phy_driver(drv);
481 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
482 int i;
483
484 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
485 return 0;
486
487 if (phydrv->match_phy_device)
488 return phydrv->match_phy_device(phydev);
489
490 if (phydev->is_c45) {
491 for (i = 1; i < num_ids; i++) {
492 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
493 continue;
494
495 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
496 (phydev->c45_ids.device_ids[i] &
497 phydrv->phy_id_mask))
498 return 1;
499 }
500 return 0;
501 } else {
502 return (phydrv->phy_id & phydrv->phy_id_mask) ==
503 (phydev->phy_id & phydrv->phy_id_mask);
504 }
505}
506
507static ssize_t
508phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
509{
510 struct phy_device *phydev = to_phy_device(dev);
511
512 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
513}
514static DEVICE_ATTR_RO(phy_id);
515
516static ssize_t
517phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
518{
519 struct phy_device *phydev = to_phy_device(dev);
520 const char *mode = NULL;
521
522 if (phy_is_internal(phydev))
523 mode = "internal";
524 else
525 mode = phy_modes(phydev->interface);
526
527 return sprintf(buf, "%s\n", mode);
528}
529static DEVICE_ATTR_RO(phy_interface);
530
531static ssize_t
532phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
533 char *buf)
534{
535 struct phy_device *phydev = to_phy_device(dev);
536
537 return sprintf(buf, "%d\n", phydev->has_fixups);
538}
539static DEVICE_ATTR_RO(phy_has_fixups);
540
541static struct attribute *phy_dev_attrs[] = {
542 &dev_attr_phy_id.attr,
543 &dev_attr_phy_interface.attr,
544 &dev_attr_phy_has_fixups.attr,
545 NULL,
546};
547ATTRIBUTE_GROUPS(phy_dev);
548
549static const struct device_type mdio_bus_phy_type = {
550 .name = "PHY",
551 .groups = phy_dev_groups,
552 .release = phy_device_release,
553 .pm = MDIO_BUS_PHY_PM_OPS,
554};
555
556static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
557{
558 int ret;
559
560 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
561 MDIO_ID_ARGS(phy_id));
562 /* We only check for failures in executing the usermode binary,
563 * not whether a PHY driver module exists for the PHY ID.
564 * Accept -ENOENT because this may occur in case no initramfs exists,
565 * then modprobe isn't available.
566 */
567 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
568 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
569 ret, (unsigned long)phy_id);
570 return ret;
571 }
572
573 return 0;
574}
575
576struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
577 bool is_c45,
578 struct phy_c45_device_ids *c45_ids)
579{
580 struct phy_device *dev;
581 struct mdio_device *mdiodev;
582 int ret = 0;
583
584 /* We allocate the device, and initialize the default values */
585 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
586 if (!dev)
587 return ERR_PTR(-ENOMEM);
588
589 mdiodev = &dev->mdio;
590 mdiodev->dev.parent = &bus->dev;
591 mdiodev->dev.bus = &mdio_bus_type;
592 mdiodev->dev.type = &mdio_bus_phy_type;
593 mdiodev->bus = bus;
594 mdiodev->bus_match = phy_bus_match;
595 mdiodev->addr = addr;
596 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
597 mdiodev->device_free = phy_mdio_device_free;
598 mdiodev->device_remove = phy_mdio_device_remove;
599
600 dev->speed = SPEED_UNKNOWN;
601 dev->duplex = DUPLEX_UNKNOWN;
602 dev->pause = 0;
603 dev->asym_pause = 0;
604 dev->link = 0;
605 dev->interface = PHY_INTERFACE_MODE_GMII;
606
607 dev->autoneg = AUTONEG_ENABLE;
608
609 dev->is_c45 = is_c45;
610 dev->phy_id = phy_id;
611 if (c45_ids)
612 dev->c45_ids = *c45_ids;
613 dev->irq = bus->irq[addr];
614 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
615
616 dev->state = PHY_DOWN;
617
618 mutex_init(&dev->lock);
619 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
620
621 /* Request the appropriate module unconditionally; don't
622 * bother trying to do so only if it isn't already loaded,
623 * because that gets complicated. A hotplug event would have
624 * done an unconditional modprobe anyway.
625 * We don't do normal hotplug because it won't work for MDIO
626 * -- because it relies on the device staying around for long
627 * enough for the driver to get loaded. With MDIO, the NIC
628 * driver will get bored and give up as soon as it finds that
629 * there's no driver _already_ loaded.
630 */
631 if (is_c45 && c45_ids) {
632 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
633 int i;
634
635 for (i = 1; i < num_ids; i++) {
636 if (c45_ids->device_ids[i] == 0xffffffff)
637 continue;
638
639 ret = phy_request_driver_module(dev,
640 c45_ids->device_ids[i]);
641 if (ret)
642 break;
643 }
644 } else {
645 ret = phy_request_driver_module(dev, phy_id);
646 }
647
648 if (!ret) {
649 device_initialize(&mdiodev->dev);
650 } else {
651 kfree(dev);
652 dev = ERR_PTR(ret);
653 }
654
655 return dev;
656}
657EXPORT_SYMBOL(phy_device_create);
658
659/* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
660 * @bus: the target MII bus
661 * @addr: PHY address on the MII bus
662 * @dev_addr: MMD address in the PHY.
663 * @devices_in_package: where to store the devices in package information.
664 *
665 * Description: reads devices in package registers of a MMD at @dev_addr
666 * from PHY at @addr on @bus.
667 *
668 * Returns: 0 on success, -EIO on failure.
669 */
670static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
671 u32 *devices_in_package)
672{
673 int phy_reg, reg_addr;
674
675 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
676 phy_reg = mdiobus_read(bus, addr, reg_addr);
677 if (phy_reg < 0)
678 return -EIO;
679 *devices_in_package = phy_reg << 16;
680
681 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
682 phy_reg = mdiobus_read(bus, addr, reg_addr);
683 if (phy_reg < 0)
684 return -EIO;
685 *devices_in_package |= phy_reg;
686
687 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
688 *devices_in_package &= ~BIT(0);
689
690 return 0;
691}
692
693/**
694 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
695 * @bus: the target MII bus
696 * @addr: PHY address on the MII bus
697 * @phy_id: where to store the ID retrieved.
698 * @c45_ids: where to store the c45 ID information.
699 *
700 * If the PHY devices-in-package appears to be valid, it and the
701 * corresponding identifiers are stored in @c45_ids, zero is stored
702 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
703 * zero on success.
704 *
705 */
706static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
707 struct phy_c45_device_ids *c45_ids) {
708 int phy_reg;
709 int i, reg_addr;
710 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
711 u32 *devs = &c45_ids->devices_in_package;
712
713 /* Find first non-zero Devices In package. Device zero is reserved
714 * for 802.3 c45 complied PHYs, so don't probe it at first.
715 */
716 for (i = 1; i < num_ids && *devs == 0; i++) {
717 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
718 if (phy_reg < 0)
719 return -EIO;
720
721 if ((*devs & 0x1fffffff) == 0x1fffffff) {
722 /* If mostly Fs, there is no device there,
723 * then let's continue to probe more, as some
724 * 10G PHYs have zero Devices In package,
725 * e.g. Cortina CS4315/CS4340 PHY.
726 */
727 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
728 if (phy_reg < 0)
729 return -EIO;
730 /* no device there, let's get out of here */
731 if ((*devs & 0x1fffffff) == 0x1fffffff) {
732 *phy_id = 0xffffffff;
733 return 0;
734 } else {
735 break;
736 }
737 }
738 }
739
740 /* Now probe Device Identifiers for each device present. */
741 for (i = 1; i < num_ids; i++) {
742 if (!(c45_ids->devices_in_package & (1 << i)))
743 continue;
744
745 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
746 phy_reg = mdiobus_read(bus, addr, reg_addr);
747 if (phy_reg < 0)
748 return -EIO;
749 c45_ids->device_ids[i] = phy_reg << 16;
750
751 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
752 phy_reg = mdiobus_read(bus, addr, reg_addr);
753 if (phy_reg < 0)
754 return -EIO;
755 c45_ids->device_ids[i] |= phy_reg;
756 }
757 *phy_id = 0;
758 return 0;
759}
760
761/**
762 * get_phy_id - reads the specified addr for its ID.
763 * @bus: the target MII bus
764 * @addr: PHY address on the MII bus
765 * @phy_id: where to store the ID retrieved.
766 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
767 * @c45_ids: where to store the c45 ID information.
768 *
769 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
770 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
771 * zero on success.
772 *
773 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
774 * its return value is in turn returned.
775 *
776 */
777static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
778 bool is_c45, struct phy_c45_device_ids *c45_ids)
779{
780 int phy_reg;
781
782 if (is_c45)
783 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
784
785 /* Grab the bits from PHYIR1, and put them in the upper half */
786 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
787 if (phy_reg < 0) {
788 /* returning -ENODEV doesn't stop bus scanning */
789 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
790 }
791
792 *phy_id = phy_reg << 16;
793
794 /* Grab the bits from PHYIR2, and put them in the lower half */
795 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
796 if (phy_reg < 0)
797 return -EIO;
798
799 *phy_id |= phy_reg;
800
801 return 0;
802}
803
804/**
805 * get_phy_device - reads the specified PHY device and returns its @phy_device
806 * struct
807 * @bus: the target MII bus
808 * @addr: PHY address on the MII bus
809 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
810 *
811 * Description: Reads the ID registers of the PHY at @addr on the
812 * @bus, then allocates and returns the phy_device to represent it.
813 */
814struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
815{
816 struct phy_c45_device_ids c45_ids;
817 u32 phy_id = 0;
818 int r;
819
820 c45_ids.devices_in_package = 0;
821 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
822
823 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
824 if (r)
825 return ERR_PTR(r);
826
827 /* If the phy_id is mostly Fs, there is no device there */
828 if ((phy_id & 0x1fffffff) == 0x1fffffff)
829 return ERR_PTR(-ENODEV);
830
831 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
832}
833EXPORT_SYMBOL(get_phy_device);
834
835/**
836 * phy_device_register - Register the phy device on the MDIO bus
837 * @phydev: phy_device structure to be added to the MDIO bus
838 */
839int phy_device_register(struct phy_device *phydev)
840{
841 int err;
842
843 err = mdiobus_register_device(&phydev->mdio);
844 if (err)
845 return err;
846
847 /* Deassert the reset signal */
848 phy_device_reset(phydev, 0);
849
850 /* Run all of the fixups for this PHY */
851 err = phy_scan_fixups(phydev);
852 if (err) {
853 phydev_err(phydev, "failed to initialize\n");
854 goto out;
855 }
856
857 err = device_add(&phydev->mdio.dev);
858 if (err) {
859 phydev_err(phydev, "failed to add\n");
860 goto out;
861 }
862
863 return 0;
864
865 out:
866 /* Assert the reset signal */
867 phy_device_reset(phydev, 1);
868
869 mdiobus_unregister_device(&phydev->mdio);
870 return err;
871}
872EXPORT_SYMBOL(phy_device_register);
873
874/**
875 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
876 * @phydev: phy_device structure to remove
877 *
878 * This doesn't free the phy_device itself, it merely reverses the effects
879 * of phy_device_register(). Use phy_device_free() to free the device
880 * after calling this function.
881 */
882void phy_device_remove(struct phy_device *phydev)
883{
884 device_del(&phydev->mdio.dev);
885
886 /* Assert the reset signal */
887 phy_device_reset(phydev, 1);
888
889 mdiobus_unregister_device(&phydev->mdio);
890}
891EXPORT_SYMBOL(phy_device_remove);
892
893/**
894 * phy_find_first - finds the first PHY device on the bus
895 * @bus: the target MII bus
896 */
897struct phy_device *phy_find_first(struct mii_bus *bus)
898{
899 struct phy_device *phydev;
900 int addr;
901
902 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
903 phydev = mdiobus_get_phy(bus, addr);
904 if (phydev)
905 return phydev;
906 }
907 return NULL;
908}
909EXPORT_SYMBOL(phy_find_first);
910
911static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
912{
913 struct net_device *netdev = phydev->attached_dev;
914
915 if (do_carrier) {
916 if (up)
917 netif_carrier_on(netdev);
918 else
919 netif_carrier_off(netdev);
920 }
921 phydev->adjust_link(netdev);
922}
923
924/**
925 * phy_prepare_link - prepares the PHY layer to monitor link status
926 * @phydev: target phy_device struct
927 * @handler: callback function for link status change notifications
928 *
929 * Description: Tells the PHY infrastructure to handle the
930 * gory details on monitoring link status (whether through
931 * polling or an interrupt), and to call back to the
932 * connected device driver when the link status changes.
933 * If you want to monitor your own link state, don't call
934 * this function.
935 */
936static void phy_prepare_link(struct phy_device *phydev,
937 void (*handler)(struct net_device *))
938{
939 phydev->adjust_link = handler;
940}
941
942/**
943 * phy_connect_direct - connect an ethernet device to a specific phy_device
944 * @dev: the network device to connect
945 * @phydev: the pointer to the phy device
946 * @handler: callback function for state change notifications
947 * @interface: PHY device's interface
948 */
949int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
950 void (*handler)(struct net_device *),
951 phy_interface_t interface)
952{
953 int rc;
954
955 if (!dev)
956 return -EINVAL;
957
958 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
959 if (rc)
960 return rc;
961
962 phy_prepare_link(phydev, handler);
963 if (phy_interrupt_is_valid(phydev))
964 phy_request_interrupt(phydev);
965
966 return 0;
967}
968EXPORT_SYMBOL(phy_connect_direct);
969
970/**
971 * phy_connect - connect an ethernet device to a PHY device
972 * @dev: the network device to connect
973 * @bus_id: the id string of the PHY device to connect
974 * @handler: callback function for state change notifications
975 * @interface: PHY device's interface
976 *
977 * Description: Convenience function for connecting ethernet
978 * devices to PHY devices. The default behavior is for
979 * the PHY infrastructure to handle everything, and only notify
980 * the connected driver when the link status changes. If you
981 * don't want, or can't use the provided functionality, you may
982 * choose to call only the subset of functions which provide
983 * the desired functionality.
984 */
985struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
986 void (*handler)(struct net_device *),
987 phy_interface_t interface)
988{
989 struct phy_device *phydev;
990 struct device *d;
991 int rc;
992
993 /* Search the list of PHY devices on the mdio bus for the
994 * PHY with the requested name
995 */
996 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
997 if (!d) {
998 pr_err("PHY %s not found\n", bus_id);
999 return ERR_PTR(-ENODEV);
1000 }
1001 phydev = to_phy_device(d);
1002
1003 rc = phy_connect_direct(dev, phydev, handler, interface);
1004 put_device(d);
1005 if (rc)
1006 return ERR_PTR(rc);
1007
1008 return phydev;
1009}
1010EXPORT_SYMBOL(phy_connect);
1011
1012/**
1013 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1014 * device
1015 * @phydev: target phy_device struct
1016 */
1017void phy_disconnect(struct phy_device *phydev)
1018{
1019 if (phy_is_started(phydev))
1020 phy_stop(phydev);
1021
1022 if (phy_interrupt_is_valid(phydev))
1023 phy_free_interrupt(phydev);
1024
1025 phydev->adjust_link = NULL;
1026
1027 phy_detach(phydev);
1028}
1029EXPORT_SYMBOL(phy_disconnect);
1030
1031/**
1032 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1033 * @phydev: The PHY device to poll
1034 *
1035 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1036 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1037 * register must be polled until the BMCR_RESET bit clears.
1038 *
1039 * Furthermore, any attempts to write to PHY registers may have no effect
1040 * or even generate MDIO bus errors until this is complete.
1041 *
1042 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1043 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1044 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1045 * effort to support such broken PHYs, this function is separate from the
1046 * standard phy_init_hw() which will zero all the other bits in the BMCR
1047 * and reapply all driver-specific and board-specific fixups.
1048 */
1049static int phy_poll_reset(struct phy_device *phydev)
1050{
1051 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1052 unsigned int retries = 12;
1053 int ret;
1054
1055 do {
1056 msleep(50);
1057 ret = phy_read(phydev, MII_BMCR);
1058 if (ret < 0)
1059 return ret;
1060 } while (ret & BMCR_RESET && --retries);
1061 if (ret & BMCR_RESET)
1062 return -ETIMEDOUT;
1063
1064 /* Some chips (smsc911x) may still need up to another 1ms after the
1065 * BMCR_RESET bit is cleared before they are usable.
1066 */
1067 msleep(1);
1068 return 0;
1069}
1070
1071int phy_init_hw(struct phy_device *phydev)
1072{
1073 int ret = 0;
1074
1075 /* Deassert the reset signal */
1076 phy_device_reset(phydev, 0);
1077
1078 if (!phydev->drv)
1079 return 0;
1080
1081 if (phydev->drv->soft_reset)
1082 ret = phydev->drv->soft_reset(phydev);
1083
1084 if (ret < 0)
1085 return ret;
1086
1087 ret = phy_scan_fixups(phydev);
1088 if (ret < 0)
1089 return ret;
1090
1091 if (phydev->drv->config_init)
1092 ret = phydev->drv->config_init(phydev);
1093
1094 return ret;
1095}
1096EXPORT_SYMBOL(phy_init_hw);
1097
1098void phy_attached_info(struct phy_device *phydev)
1099{
1100 phy_attached_print(phydev, NULL);
1101}
1102EXPORT_SYMBOL(phy_attached_info);
1103
1104#define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1105void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1106{
1107 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1108 char *irq_str;
1109 char irq_num[8];
1110
1111 switch(phydev->irq) {
1112 case PHY_POLL:
1113 irq_str = "POLL";
1114 break;
1115 case PHY_IGNORE_INTERRUPT:
1116 irq_str = "IGNORE";
1117 break;
1118 default:
1119 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1120 irq_str = irq_num;
1121 break;
1122 }
1123
1124
1125 if (!fmt) {
1126 phydev_info(phydev, ATTACHED_FMT "\n",
1127 drv_name, phydev_name(phydev),
1128 irq_str);
1129 } else {
1130 va_list ap;
1131
1132 phydev_info(phydev, ATTACHED_FMT,
1133 drv_name, phydev_name(phydev),
1134 irq_str);
1135
1136 va_start(ap, fmt);
1137 vprintk(fmt, ap);
1138 va_end(ap);
1139 }
1140}
1141EXPORT_SYMBOL(phy_attached_print);
1142
1143static void phy_sysfs_create_links(struct phy_device *phydev)
1144{
1145 struct net_device *dev = phydev->attached_dev;
1146 int err;
1147
1148 if (!dev)
1149 return;
1150
1151 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1152 "attached_dev");
1153 if (err)
1154 return;
1155
1156 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1157 &phydev->mdio.dev.kobj,
1158 "phydev");
1159 if (err) {
1160 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1161 kobject_name(&phydev->mdio.dev.kobj),
1162 err);
1163 /* non-fatal - some net drivers can use one netdevice
1164 * with more then one phy
1165 */
1166 }
1167
1168 phydev->sysfs_links = true;
1169}
1170
1171static ssize_t
1172phy_standalone_show(struct device *dev, struct device_attribute *attr,
1173 char *buf)
1174{
1175 struct phy_device *phydev = to_phy_device(dev);
1176
1177 return sprintf(buf, "%d\n", !phydev->attached_dev);
1178}
1179static DEVICE_ATTR_RO(phy_standalone);
1180
1181/**
1182 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1183 * @upstream: pointer to the phy device
1184 * @bus: sfp bus representing cage being attached
1185 *
1186 * This is used to fill in the sfp_upstream_ops .attach member.
1187 */
1188void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1189{
1190 struct phy_device *phydev = upstream;
1191
1192 if (phydev->attached_dev)
1193 phydev->attached_dev->sfp_bus = bus;
1194 phydev->sfp_bus_attached = true;
1195}
1196EXPORT_SYMBOL(phy_sfp_attach);
1197
1198/**
1199 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1200 * @upstream: pointer to the phy device
1201 * @bus: sfp bus representing cage being attached
1202 *
1203 * This is used to fill in the sfp_upstream_ops .detach member.
1204 */
1205void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1206{
1207 struct phy_device *phydev = upstream;
1208
1209 if (phydev->attached_dev)
1210 phydev->attached_dev->sfp_bus = NULL;
1211 phydev->sfp_bus_attached = false;
1212}
1213EXPORT_SYMBOL(phy_sfp_detach);
1214
1215/**
1216 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1217 * @phydev: Pointer to phy_device
1218 * @ops: SFP's upstream operations
1219 */
1220int phy_sfp_probe(struct phy_device *phydev,
1221 const struct sfp_upstream_ops *ops)
1222{
1223 struct sfp_bus *bus;
1224 int ret;
1225
1226 if (phydev->mdio.dev.fwnode) {
1227 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1228 if (IS_ERR(bus))
1229 return PTR_ERR(bus);
1230
1231 phydev->sfp_bus = bus;
1232
1233 ret = sfp_bus_add_upstream(bus, phydev, ops);
1234 sfp_bus_put(bus);
1235 }
1236 return 0;
1237}
1238EXPORT_SYMBOL(phy_sfp_probe);
1239
1240/**
1241 * phy_attach_direct - attach a network device to a given PHY device pointer
1242 * @dev: network device to attach
1243 * @phydev: Pointer to phy_device to attach
1244 * @flags: PHY device's dev_flags
1245 * @interface: PHY device's interface
1246 *
1247 * Description: Called by drivers to attach to a particular PHY
1248 * device. The phy_device is found, and properly hooked up
1249 * to the phy_driver. If no driver is attached, then a
1250 * generic driver is used. The phy_device is given a ptr to
1251 * the attaching device, and given a callback for link status
1252 * change. The phy_device is returned to the attaching driver.
1253 * This function takes a reference on the phy device.
1254 */
1255int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1256 u32 flags, phy_interface_t interface)
1257{
1258 struct mii_bus *bus = phydev->mdio.bus;
1259 struct device *d = &phydev->mdio.dev;
1260 struct module *ndev_owner = NULL;
1261 bool using_genphy = false;
1262 int err;
1263
1264 /* For Ethernet device drivers that register their own MDIO bus, we
1265 * will have bus->owner match ndev_mod, so we do not want to increment
1266 * our own module->refcnt here, otherwise we would not be able to
1267 * unload later on.
1268 */
1269 if (dev)
1270 ndev_owner = dev->dev.parent->driver->owner;
1271 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1272 phydev_err(phydev, "failed to get the bus module\n");
1273 return -EIO;
1274 }
1275
1276 get_device(d);
1277
1278 /* Assume that if there is no driver, that it doesn't
1279 * exist, and we should use the genphy driver.
1280 */
1281 if (!d->driver) {
1282 if (phydev->is_c45)
1283 d->driver = &genphy_c45_driver.mdiodrv.driver;
1284 else
1285 d->driver = &genphy_driver.mdiodrv.driver;
1286
1287 using_genphy = true;
1288 }
1289
1290 if (!try_module_get(d->driver->owner)) {
1291 phydev_err(phydev, "failed to get the device driver module\n");
1292 err = -EIO;
1293 goto error_put_device;
1294 }
1295
1296 if (using_genphy) {
1297 err = d->driver->probe(d);
1298 if (err >= 0)
1299 err = device_bind_driver(d);
1300
1301 if (err)
1302 goto error_module_put;
1303 }
1304
1305 if (phydev->attached_dev) {
1306 dev_err(&dev->dev, "PHY already attached\n");
1307 err = -EBUSY;
1308 goto error;
1309 }
1310
1311 phydev->phy_link_change = phy_link_change;
1312 if (dev) {
1313 phydev->attached_dev = dev;
1314 dev->phydev = phydev;
1315
1316 if (phydev->sfp_bus_attached)
1317 dev->sfp_bus = phydev->sfp_bus;
1318 }
1319
1320 /* Some Ethernet drivers try to connect to a PHY device before
1321 * calling register_netdevice() -> netdev_register_kobject() and
1322 * does the dev->dev.kobj initialization. Here we only check for
1323 * success which indicates that the network device kobject is
1324 * ready. Once we do that we still need to keep track of whether
1325 * links were successfully set up or not for phy_detach() to
1326 * remove them accordingly.
1327 */
1328 phydev->sysfs_links = false;
1329
1330 phy_sysfs_create_links(phydev);
1331
1332 if (!phydev->attached_dev) {
1333 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1334 &dev_attr_phy_standalone.attr);
1335 if (err)
1336 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1337 }
1338
1339 phydev->dev_flags |= flags;
1340
1341 phydev->interface = interface;
1342
1343 phydev->state = PHY_READY;
1344
1345 /* Initial carrier state is off as the phy is about to be
1346 * (re)initialized.
1347 */
1348 if (dev)
1349 netif_carrier_off(phydev->attached_dev);
1350
1351 /* Do initial configuration here, now that
1352 * we have certain key parameters
1353 * (dev_flags and interface)
1354 */
1355 err = phy_init_hw(phydev);
1356 if (err)
1357 goto error;
1358
1359 phy_resume(phydev);
1360 phy_led_triggers_register(phydev);
1361
1362 return err;
1363
1364error:
1365 /* phy_detach() does all of the cleanup below */
1366 phy_detach(phydev);
1367 return err;
1368
1369error_module_put:
1370 module_put(d->driver->owner);
1371error_put_device:
1372 put_device(d);
1373 if (ndev_owner != bus->owner)
1374 module_put(bus->owner);
1375 return err;
1376}
1377EXPORT_SYMBOL(phy_attach_direct);
1378
1379/**
1380 * phy_attach - attach a network device to a particular PHY device
1381 * @dev: network device to attach
1382 * @bus_id: Bus ID of PHY device to attach
1383 * @interface: PHY device's interface
1384 *
1385 * Description: Same as phy_attach_direct() except that a PHY bus_id
1386 * string is passed instead of a pointer to a struct phy_device.
1387 */
1388struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1389 phy_interface_t interface)
1390{
1391 struct bus_type *bus = &mdio_bus_type;
1392 struct phy_device *phydev;
1393 struct device *d;
1394 int rc;
1395
1396 if (!dev)
1397 return ERR_PTR(-EINVAL);
1398
1399 /* Search the list of PHY devices on the mdio bus for the
1400 * PHY with the requested name
1401 */
1402 d = bus_find_device_by_name(bus, NULL, bus_id);
1403 if (!d) {
1404 pr_err("PHY %s not found\n", bus_id);
1405 return ERR_PTR(-ENODEV);
1406 }
1407 phydev = to_phy_device(d);
1408
1409 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1410 put_device(d);
1411 if (rc)
1412 return ERR_PTR(rc);
1413
1414 return phydev;
1415}
1416EXPORT_SYMBOL(phy_attach);
1417
1418static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1419 struct device_driver *driver)
1420{
1421 struct device *d = &phydev->mdio.dev;
1422 bool ret = false;
1423
1424 if (!phydev->drv)
1425 return ret;
1426
1427 get_device(d);
1428 ret = d->driver == driver;
1429 put_device(d);
1430
1431 return ret;
1432}
1433
1434bool phy_driver_is_genphy(struct phy_device *phydev)
1435{
1436 return phy_driver_is_genphy_kind(phydev,
1437 &genphy_driver.mdiodrv.driver);
1438}
1439EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1440
1441bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1442{
1443 return phy_driver_is_genphy_kind(phydev,
1444 &genphy_c45_driver.mdiodrv.driver);
1445}
1446EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1447
1448/**
1449 * phy_detach - detach a PHY device from its network device
1450 * @phydev: target phy_device struct
1451 *
1452 * This detaches the phy device from its network device and the phy
1453 * driver, and drops the reference count taken in phy_attach_direct().
1454 */
1455void phy_detach(struct phy_device *phydev)
1456{
1457 struct net_device *dev = phydev->attached_dev;
1458 struct module *ndev_owner = NULL;
1459 struct mii_bus *bus;
1460
1461 if (phydev->sysfs_links) {
1462 if (dev)
1463 sysfs_remove_link(&dev->dev.kobj, "phydev");
1464 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1465 }
1466
1467 if (!phydev->attached_dev)
1468 sysfs_remove_file(&phydev->mdio.dev.kobj,
1469 &dev_attr_phy_standalone.attr);
1470
1471 phy_suspend(phydev);
1472 if (dev) {
1473 phydev->attached_dev->phydev = NULL;
1474 phydev->attached_dev = NULL;
1475 }
1476 phydev->phylink = NULL;
1477
1478 phy_led_triggers_unregister(phydev);
1479
1480 module_put(phydev->mdio.dev.driver->owner);
1481
1482 /* If the device had no specific driver before (i.e. - it
1483 * was using the generic driver), we unbind the device
1484 * from the generic driver so that there's a chance a
1485 * real driver could be loaded
1486 */
1487 if (phy_driver_is_genphy(phydev) ||
1488 phy_driver_is_genphy_10g(phydev))
1489 device_release_driver(&phydev->mdio.dev);
1490
1491 /*
1492 * The phydev might go away on the put_device() below, so avoid
1493 * a use-after-free bug by reading the underlying bus first.
1494 */
1495 bus = phydev->mdio.bus;
1496
1497 put_device(&phydev->mdio.dev);
1498 if (dev)
1499 ndev_owner = dev->dev.parent->driver->owner;
1500 if (ndev_owner != bus->owner)
1501 module_put(bus->owner);
1502
1503 /* Assert the reset signal */
1504 phy_device_reset(phydev, 1);
1505}
1506EXPORT_SYMBOL(phy_detach);
1507
1508int phy_suspend(struct phy_device *phydev)
1509{
1510 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1511 struct net_device *netdev = phydev->attached_dev;
1512 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1513 int ret = 0;
1514
1515 /* If the device has WOL enabled, we cannot suspend the PHY */
1516 phy_ethtool_get_wol(phydev, &wol);
1517 if (wol.wolopts || (netdev && netdev->wol_enabled))
1518 return -EBUSY;
1519
1520 if (phydev->drv && phydrv->suspend)
1521 ret = phydrv->suspend(phydev);
1522
1523 if (ret)
1524 return ret;
1525
1526 phydev->suspended = true;
1527
1528 return ret;
1529}
1530EXPORT_SYMBOL(phy_suspend);
1531
1532int __phy_resume(struct phy_device *phydev)
1533{
1534 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1535 int ret = 0;
1536
1537 WARN_ON(!mutex_is_locked(&phydev->lock));
1538
1539 if (phydev->drv && phydrv->resume)
1540 ret = phydrv->resume(phydev);
1541
1542 if (ret)
1543 return ret;
1544
1545 phydev->suspended = false;
1546
1547 return ret;
1548}
1549EXPORT_SYMBOL(__phy_resume);
1550
1551int phy_resume(struct phy_device *phydev)
1552{
1553 int ret;
1554
1555 mutex_lock(&phydev->lock);
1556 ret = __phy_resume(phydev);
1557 mutex_unlock(&phydev->lock);
1558
1559 return ret;
1560}
1561EXPORT_SYMBOL(phy_resume);
1562
1563int phy_loopback(struct phy_device *phydev, bool enable)
1564{
1565 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1566 int ret = 0;
1567
1568 mutex_lock(&phydev->lock);
1569
1570 if (enable && phydev->loopback_enabled) {
1571 ret = -EBUSY;
1572 goto out;
1573 }
1574
1575 if (!enable && !phydev->loopback_enabled) {
1576 ret = -EINVAL;
1577 goto out;
1578 }
1579
1580 if (phydev->drv && phydrv->set_loopback)
1581 ret = phydrv->set_loopback(phydev, enable);
1582 else
1583 ret = -EOPNOTSUPP;
1584
1585 if (ret)
1586 goto out;
1587
1588 phydev->loopback_enabled = enable;
1589
1590out:
1591 mutex_unlock(&phydev->lock);
1592 return ret;
1593}
1594EXPORT_SYMBOL(phy_loopback);
1595
1596/**
1597 * phy_reset_after_clk_enable - perform a PHY reset if needed
1598 * @phydev: target phy_device struct
1599 *
1600 * Description: Some PHYs are known to need a reset after their refclk was
1601 * enabled. This function evaluates the flags and perform the reset if it's
1602 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1603 * was reset.
1604 */
1605int phy_reset_after_clk_enable(struct phy_device *phydev)
1606{
1607 if (!phydev || !phydev->drv)
1608 return -ENODEV;
1609
1610 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1611 phy_device_reset(phydev, 1);
1612 phy_device_reset(phydev, 0);
1613 return 1;
1614 }
1615
1616 return 0;
1617}
1618EXPORT_SYMBOL(phy_reset_after_clk_enable);
1619
1620/* Generic PHY support and helper functions */
1621
1622/**
1623 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1624 * @phydev: target phy_device struct
1625 *
1626 * Description: Writes MII_ADVERTISE with the appropriate values,
1627 * after sanitizing the values to make sure we only advertise
1628 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1629 * hasn't changed, and > 0 if it has changed.
1630 */
1631static int genphy_config_advert(struct phy_device *phydev)
1632{
1633 int err, bmsr, changed = 0;
1634 u32 adv;
1635
1636 /* Only allow advertising what this PHY supports */
1637 linkmode_and(phydev->advertising, phydev->advertising,
1638 phydev->supported);
1639
1640 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1641
1642 /* Setup standard advertisement */
1643 err = phy_modify_changed(phydev, MII_ADVERTISE,
1644 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1645 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1646 adv);
1647 if (err < 0)
1648 return err;
1649 if (err > 0)
1650 changed = 1;
1651
1652 bmsr = phy_read(phydev, MII_BMSR);
1653 if (bmsr < 0)
1654 return bmsr;
1655
1656 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1657 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1658 * logical 1.
1659 */
1660 if (!(bmsr & BMSR_ESTATEN))
1661 return changed;
1662
1663 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1664
1665 err = phy_modify_changed(phydev, MII_CTRL1000,
1666 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1667 adv);
1668 if (err < 0)
1669 return err;
1670 if (err > 0)
1671 changed = 1;
1672
1673 return changed;
1674}
1675
1676/**
1677 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1678 * @phydev: target phy_device struct
1679 *
1680 * Description: Writes MII_ADVERTISE with the appropriate values,
1681 * after sanitizing the values to make sure we only advertise
1682 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1683 * hasn't changed, and > 0 if it has changed. This function is intended
1684 * for Clause 37 1000Base-X mode.
1685 */
1686static int genphy_c37_config_advert(struct phy_device *phydev)
1687{
1688 u16 adv = 0;
1689
1690 /* Only allow advertising what this PHY supports */
1691 linkmode_and(phydev->advertising, phydev->advertising,
1692 phydev->supported);
1693
1694 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1695 phydev->advertising))
1696 adv |= ADVERTISE_1000XFULL;
1697 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1698 phydev->advertising))
1699 adv |= ADVERTISE_1000XPAUSE;
1700 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1701 phydev->advertising))
1702 adv |= ADVERTISE_1000XPSE_ASYM;
1703
1704 return phy_modify_changed(phydev, MII_ADVERTISE,
1705 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1706 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1707 adv);
1708}
1709
1710/**
1711 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1712 * @phydev: target phy_device struct
1713 *
1714 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1715 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1716 * changed, and 1 if it has changed.
1717 */
1718int genphy_config_eee_advert(struct phy_device *phydev)
1719{
1720 int err;
1721
1722 /* Nothing to disable */
1723 if (!phydev->eee_broken_modes)
1724 return 0;
1725
1726 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1727 phydev->eee_broken_modes, 0);
1728 /* If the call failed, we assume that EEE is not supported */
1729 return err < 0 ? 0 : err;
1730}
1731EXPORT_SYMBOL(genphy_config_eee_advert);
1732
1733/**
1734 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1735 * @phydev: target phy_device struct
1736 *
1737 * Description: Configures MII_BMCR to force speed/duplex
1738 * to the values in phydev. Assumes that the values are valid.
1739 * Please see phy_sanitize_settings().
1740 */
1741int genphy_setup_forced(struct phy_device *phydev)
1742{
1743 u16 ctl = 0;
1744
1745 phydev->pause = 0;
1746 phydev->asym_pause = 0;
1747
1748 if (SPEED_1000 == phydev->speed)
1749 ctl |= BMCR_SPEED1000;
1750 else if (SPEED_100 == phydev->speed)
1751 ctl |= BMCR_SPEED100;
1752
1753 if (DUPLEX_FULL == phydev->duplex)
1754 ctl |= BMCR_FULLDPLX;
1755
1756 return phy_modify(phydev, MII_BMCR,
1757 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1758}
1759EXPORT_SYMBOL(genphy_setup_forced);
1760
1761/**
1762 * genphy_restart_aneg - Enable and Restart Autonegotiation
1763 * @phydev: target phy_device struct
1764 */
1765int genphy_restart_aneg(struct phy_device *phydev)
1766{
1767 /* Don't isolate the PHY if we're negotiating */
1768 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
1769 BMCR_ANENABLE | BMCR_ANRESTART);
1770}
1771EXPORT_SYMBOL(genphy_restart_aneg);
1772
1773/**
1774 * __genphy_config_aneg - restart auto-negotiation or write BMCR
1775 * @phydev: target phy_device struct
1776 * @changed: whether autoneg is requested
1777 *
1778 * Description: If auto-negotiation is enabled, we configure the
1779 * advertising, and then restart auto-negotiation. If it is not
1780 * enabled, then we write the BMCR.
1781 */
1782int __genphy_config_aneg(struct phy_device *phydev, bool changed)
1783{
1784 int err;
1785
1786 if (genphy_config_eee_advert(phydev))
1787 changed = true;
1788
1789 if (AUTONEG_ENABLE != phydev->autoneg)
1790 return genphy_setup_forced(phydev);
1791
1792 err = genphy_config_advert(phydev);
1793 if (err < 0) /* error */
1794 return err;
1795 else if (err)
1796 changed = true;
1797
1798 if (!changed) {
1799 /* Advertisement hasn't changed, but maybe aneg was never on to
1800 * begin with? Or maybe phy was isolated?
1801 */
1802 int ctl = phy_read(phydev, MII_BMCR);
1803
1804 if (ctl < 0)
1805 return ctl;
1806
1807 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1808 changed = true; /* do restart aneg */
1809 }
1810
1811 /* Only restart aneg if we are advertising something different
1812 * than we were before.
1813 */
1814 return changed ? genphy_restart_aneg(phydev) : 0;
1815}
1816EXPORT_SYMBOL(__genphy_config_aneg);
1817
1818/**
1819 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
1820 * @phydev: target phy_device struct
1821 *
1822 * Description: If auto-negotiation is enabled, we configure the
1823 * advertising, and then restart auto-negotiation. If it is not
1824 * enabled, then we write the BMCR. This function is intended
1825 * for use with Clause 37 1000Base-X mode.
1826 */
1827int genphy_c37_config_aneg(struct phy_device *phydev)
1828{
1829 int err, changed;
1830
1831 if (phydev->autoneg != AUTONEG_ENABLE)
1832 return genphy_setup_forced(phydev);
1833
1834 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
1835 BMCR_SPEED1000);
1836 if (err)
1837 return err;
1838
1839 changed = genphy_c37_config_advert(phydev);
1840 if (changed < 0) /* error */
1841 return changed;
1842
1843 if (!changed) {
1844 /* Advertisement hasn't changed, but maybe aneg was never on to
1845 * begin with? Or maybe phy was isolated?
1846 */
1847 int ctl = phy_read(phydev, MII_BMCR);
1848
1849 if (ctl < 0)
1850 return ctl;
1851
1852 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1853 changed = 1; /* do restart aneg */
1854 }
1855
1856 /* Only restart aneg if we are advertising something different
1857 * than we were before.
1858 */
1859 if (changed > 0)
1860 return genphy_restart_aneg(phydev);
1861
1862 return 0;
1863}
1864EXPORT_SYMBOL(genphy_c37_config_aneg);
1865
1866/**
1867 * genphy_aneg_done - return auto-negotiation status
1868 * @phydev: target phy_device struct
1869 *
1870 * Description: Reads the status register and returns 0 either if
1871 * auto-negotiation is incomplete, or if there was an error.
1872 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1873 */
1874int genphy_aneg_done(struct phy_device *phydev)
1875{
1876 int retval = phy_read(phydev, MII_BMSR);
1877
1878 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1879}
1880EXPORT_SYMBOL(genphy_aneg_done);
1881
1882/**
1883 * genphy_update_link - update link status in @phydev
1884 * @phydev: target phy_device struct
1885 *
1886 * Description: Update the value in phydev->link to reflect the
1887 * current link value. In order to do this, we need to read
1888 * the status register twice, keeping the second value.
1889 */
1890int genphy_update_link(struct phy_device *phydev)
1891{
1892 int status = 0, bmcr;
1893
1894 bmcr = phy_read(phydev, MII_BMCR);
1895 if (bmcr < 0)
1896 return bmcr;
1897
1898 /* Autoneg is being started, therefore disregard BMSR value and
1899 * report link as down.
1900 */
1901 if (bmcr & BMCR_ANRESTART)
1902 goto done;
1903
1904 /* The link state is latched low so that momentary link
1905 * drops can be detected. Do not double-read the status
1906 * in polling mode to detect such short link drops.
1907 */
1908 if (!phy_polling_mode(phydev)) {
1909 status = phy_read(phydev, MII_BMSR);
1910 if (status < 0)
1911 return status;
1912 else if (status & BMSR_LSTATUS)
1913 goto done;
1914 }
1915
1916 /* Read link and autonegotiation status */
1917 status = phy_read(phydev, MII_BMSR);
1918 if (status < 0)
1919 return status;
1920done:
1921 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
1922 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
1923
1924 /* Consider the case that autoneg was started and "aneg complete"
1925 * bit has been reset, but "link up" bit not yet.
1926 */
1927 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
1928 phydev->link = 0;
1929
1930 return 0;
1931}
1932EXPORT_SYMBOL(genphy_update_link);
1933
1934int genphy_read_lpa(struct phy_device *phydev)
1935{
1936 int lpa, lpagb;
1937
1938 if (phydev->autoneg == AUTONEG_ENABLE) {
1939 if (!phydev->autoneg_complete) {
1940 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1941 0);
1942 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
1943 return 0;
1944 }
1945
1946 if (phydev->is_gigabit_capable) {
1947 lpagb = phy_read(phydev, MII_STAT1000);
1948 if (lpagb < 0)
1949 return lpagb;
1950
1951 if (lpagb & LPA_1000MSFAIL) {
1952 int adv = phy_read(phydev, MII_CTRL1000);
1953
1954 if (adv < 0)
1955 return adv;
1956
1957 if (adv & CTL1000_ENABLE_MASTER)
1958 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
1959 else
1960 phydev_err(phydev, "Master/Slave resolution failed\n");
1961 return -ENOLINK;
1962 }
1963
1964 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1965 lpagb);
1966 }
1967
1968 lpa = phy_read(phydev, MII_LPA);
1969 if (lpa < 0)
1970 return lpa;
1971
1972 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
1973 } else {
1974 linkmode_zero(phydev->lp_advertising);
1975 }
1976
1977 return 0;
1978}
1979EXPORT_SYMBOL(genphy_read_lpa);
1980
1981/**
1982 * genphy_read_status - check the link status and update current link state
1983 * @phydev: target phy_device struct
1984 *
1985 * Description: Check the link, then figure out the current state
1986 * by comparing what we advertise with what the link partner
1987 * advertises. Start by checking the gigabit possibilities,
1988 * then move on to 10/100.
1989 */
1990int genphy_read_status(struct phy_device *phydev)
1991{
1992 int err, old_link = phydev->link;
1993
1994 /* Update the link, but return if there was an error */
1995 err = genphy_update_link(phydev);
1996 if (err)
1997 return err;
1998
1999 /* why bother the PHY if nothing can have changed */
2000 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2001 return 0;
2002
2003 phydev->speed = SPEED_UNKNOWN;
2004 phydev->duplex = DUPLEX_UNKNOWN;
2005 phydev->pause = 0;
2006 phydev->asym_pause = 0;
2007
2008 err = genphy_read_lpa(phydev);
2009 if (err < 0)
2010 return err;
2011
2012 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2013 phy_resolve_aneg_linkmode(phydev);
2014 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2015 int bmcr = phy_read(phydev, MII_BMCR);
2016
2017 if (bmcr < 0)
2018 return bmcr;
2019
2020 if (bmcr & BMCR_FULLDPLX)
2021 phydev->duplex = DUPLEX_FULL;
2022 else
2023 phydev->duplex = DUPLEX_HALF;
2024
2025 if (bmcr & BMCR_SPEED1000)
2026 phydev->speed = SPEED_1000;
2027 else if (bmcr & BMCR_SPEED100)
2028 phydev->speed = SPEED_100;
2029 else
2030 phydev->speed = SPEED_10;
2031 }
2032
2033 return 0;
2034}
2035EXPORT_SYMBOL(genphy_read_status);
2036
2037/**
2038 * genphy_c37_read_status - check the link status and update current link state
2039 * @phydev: target phy_device struct
2040 *
2041 * Description: Check the link, then figure out the current state
2042 * by comparing what we advertise with what the link partner
2043 * advertises. This function is for Clause 37 1000Base-X mode.
2044 */
2045int genphy_c37_read_status(struct phy_device *phydev)
2046{
2047 int lpa, err, old_link = phydev->link;
2048
2049 /* Update the link, but return if there was an error */
2050 err = genphy_update_link(phydev);
2051 if (err)
2052 return err;
2053
2054 /* why bother the PHY if nothing can have changed */
2055 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2056 return 0;
2057
2058 phydev->duplex = DUPLEX_UNKNOWN;
2059 phydev->pause = 0;
2060 phydev->asym_pause = 0;
2061
2062 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2063 lpa = phy_read(phydev, MII_LPA);
2064 if (lpa < 0)
2065 return lpa;
2066
2067 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2068 phydev->lp_advertising, lpa & LPA_LPACK);
2069 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2070 phydev->lp_advertising, lpa & LPA_1000XFULL);
2071 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2072 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2073 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2074 phydev->lp_advertising,
2075 lpa & LPA_1000XPAUSE_ASYM);
2076
2077 phy_resolve_aneg_linkmode(phydev);
2078 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2079 int bmcr = phy_read(phydev, MII_BMCR);
2080
2081 if (bmcr < 0)
2082 return bmcr;
2083
2084 if (bmcr & BMCR_FULLDPLX)
2085 phydev->duplex = DUPLEX_FULL;
2086 else
2087 phydev->duplex = DUPLEX_HALF;
2088 }
2089
2090 return 0;
2091}
2092EXPORT_SYMBOL(genphy_c37_read_status);
2093
2094/**
2095 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2096 * @phydev: target phy_device struct
2097 *
2098 * Description: Perform a software PHY reset using the standard
2099 * BMCR_RESET bit and poll for the reset bit to be cleared.
2100 *
2101 * Returns: 0 on success, < 0 on failure
2102 */
2103int genphy_soft_reset(struct phy_device *phydev)
2104{
2105 u16 res = BMCR_RESET;
2106 int ret;
2107
2108 if (phydev->autoneg == AUTONEG_ENABLE)
2109 res |= BMCR_ANRESTART;
2110
2111 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2112 if (ret < 0)
2113 return ret;
2114
2115 ret = phy_poll_reset(phydev);
2116 if (ret)
2117 return ret;
2118
2119 /* BMCR may be reset to defaults */
2120 if (phydev->autoneg == AUTONEG_DISABLE)
2121 ret = genphy_setup_forced(phydev);
2122
2123 return ret;
2124}
2125EXPORT_SYMBOL(genphy_soft_reset);
2126
2127/**
2128 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2129 * @phydev: target phy_device struct
2130 *
2131 * Description: Reads the PHY's abilities and populates
2132 * phydev->supported accordingly.
2133 *
2134 * Returns: 0 on success, < 0 on failure
2135 */
2136int genphy_read_abilities(struct phy_device *phydev)
2137{
2138 int val;
2139
2140 linkmode_set_bit_array(phy_basic_ports_array,
2141 ARRAY_SIZE(phy_basic_ports_array),
2142 phydev->supported);
2143
2144 val = phy_read(phydev, MII_BMSR);
2145 if (val < 0)
2146 return val;
2147
2148 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2149 val & BMSR_ANEGCAPABLE);
2150
2151 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2152 val & BMSR_100FULL);
2153 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2154 val & BMSR_100HALF);
2155 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2156 val & BMSR_10FULL);
2157 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2158 val & BMSR_10HALF);
2159
2160 if (val & BMSR_ESTATEN) {
2161 val = phy_read(phydev, MII_ESTATUS);
2162 if (val < 0)
2163 return val;
2164
2165 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2166 phydev->supported, val & ESTATUS_1000_TFULL);
2167 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2168 phydev->supported, val & ESTATUS_1000_THALF);
2169 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2170 phydev->supported, val & ESTATUS_1000_XFULL);
2171 }
2172
2173 return 0;
2174}
2175EXPORT_SYMBOL(genphy_read_abilities);
2176
2177/* This is used for the phy device which doesn't support the MMD extended
2178 * register access, but it does have side effect when we are trying to access
2179 * the MMD register via indirect method.
2180 */
2181int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2182{
2183 return -EOPNOTSUPP;
2184}
2185EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2186
2187int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2188 u16 regnum, u16 val)
2189{
2190 return -EOPNOTSUPP;
2191}
2192EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2193
2194int genphy_suspend(struct phy_device *phydev)
2195{
2196 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2197}
2198EXPORT_SYMBOL(genphy_suspend);
2199
2200int genphy_resume(struct phy_device *phydev)
2201{
2202 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2203}
2204EXPORT_SYMBOL(genphy_resume);
2205
2206int genphy_loopback(struct phy_device *phydev, bool enable)
2207{
2208 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2209 enable ? BMCR_LOOPBACK : 0);
2210}
2211EXPORT_SYMBOL(genphy_loopback);
2212
2213/**
2214 * phy_remove_link_mode - Remove a supported link mode
2215 * @phydev: phy_device structure to remove link mode from
2216 * @link_mode: Link mode to be removed
2217 *
2218 * Description: Some MACs don't support all link modes which the PHY
2219 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2220 * to remove a link mode.
2221 */
2222void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2223{
2224 linkmode_clear_bit(link_mode, phydev->supported);
2225 phy_advertise_supported(phydev);
2226}
2227EXPORT_SYMBOL(phy_remove_link_mode);
2228
2229static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2230{
2231 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2232 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2233 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2234 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2235}
2236
2237/**
2238 * phy_advertise_supported - Advertise all supported modes
2239 * @phydev: target phy_device struct
2240 *
2241 * Description: Called to advertise all supported modes, doesn't touch
2242 * pause mode advertising.
2243 */
2244void phy_advertise_supported(struct phy_device *phydev)
2245{
2246 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2247
2248 linkmode_copy(new, phydev->supported);
2249 phy_copy_pause_bits(new, phydev->advertising);
2250 linkmode_copy(phydev->advertising, new);
2251}
2252EXPORT_SYMBOL(phy_advertise_supported);
2253
2254/**
2255 * phy_support_sym_pause - Enable support of symmetrical pause
2256 * @phydev: target phy_device struct
2257 *
2258 * Description: Called by the MAC to indicate is supports symmetrical
2259 * Pause, but not asym pause.
2260 */
2261void phy_support_sym_pause(struct phy_device *phydev)
2262{
2263 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2264 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2265}
2266EXPORT_SYMBOL(phy_support_sym_pause);
2267
2268/**
2269 * phy_support_asym_pause - Enable support of asym pause
2270 * @phydev: target phy_device struct
2271 *
2272 * Description: Called by the MAC to indicate is supports Asym Pause.
2273 */
2274void phy_support_asym_pause(struct phy_device *phydev)
2275{
2276 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2277}
2278EXPORT_SYMBOL(phy_support_asym_pause);
2279
2280/**
2281 * phy_set_sym_pause - Configure symmetric Pause
2282 * @phydev: target phy_device struct
2283 * @rx: Receiver Pause is supported
2284 * @tx: Transmit Pause is supported
2285 * @autoneg: Auto neg should be used
2286 *
2287 * Description: Configure advertised Pause support depending on if
2288 * receiver pause and pause auto neg is supported. Generally called
2289 * from the set_pauseparam .ndo.
2290 */
2291void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2292 bool autoneg)
2293{
2294 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2295
2296 if (rx && tx && autoneg)
2297 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2298 phydev->supported);
2299
2300 linkmode_copy(phydev->advertising, phydev->supported);
2301}
2302EXPORT_SYMBOL(phy_set_sym_pause);
2303
2304/**
2305 * phy_set_asym_pause - Configure Pause and Asym Pause
2306 * @phydev: target phy_device struct
2307 * @rx: Receiver Pause is supported
2308 * @tx: Transmit Pause is supported
2309 *
2310 * Description: Configure advertised Pause support depending on if
2311 * transmit and receiver pause is supported. If there has been a
2312 * change in adverting, trigger a new autoneg. Generally called from
2313 * the set_pauseparam .ndo.
2314 */
2315void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2316{
2317 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2318
2319 linkmode_copy(oldadv, phydev->advertising);
2320
2321 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2322 phydev->advertising);
2323 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2324 phydev->advertising);
2325
2326 if (rx) {
2327 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2328 phydev->advertising);
2329 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2330 phydev->advertising);
2331 }
2332
2333 if (tx)
2334 linkmode_change_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2335 phydev->advertising);
2336
2337 if (!linkmode_equal(oldadv, phydev->advertising) &&
2338 phydev->autoneg)
2339 phy_start_aneg(phydev);
2340}
2341EXPORT_SYMBOL(phy_set_asym_pause);
2342
2343/**
2344 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2345 * @phydev: phy_device struct
2346 * @pp: requested pause configuration
2347 *
2348 * Description: Test if the PHY/MAC combination supports the Pause
2349 * configuration the user is requesting. Returns True if it is
2350 * supported, false otherwise.
2351 */
2352bool phy_validate_pause(struct phy_device *phydev,
2353 struct ethtool_pauseparam *pp)
2354{
2355 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2356 phydev->supported) && pp->rx_pause)
2357 return false;
2358
2359 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2360 phydev->supported) &&
2361 pp->rx_pause != pp->tx_pause)
2362 return false;
2363
2364 return true;
2365}
2366EXPORT_SYMBOL(phy_validate_pause);
2367
2368static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2369{
2370 return phydrv->config_intr && phydrv->ack_interrupt;
2371}
2372
2373/**
2374 * phy_probe - probe and init a PHY device
2375 * @dev: device to probe and init
2376 *
2377 * Description: Take care of setting up the phy_device structure,
2378 * set the state to READY (the driver's init function should
2379 * set it to STARTING if needed).
2380 */
2381static int phy_probe(struct device *dev)
2382{
2383 struct phy_device *phydev = to_phy_device(dev);
2384 struct device_driver *drv = phydev->mdio.dev.driver;
2385 struct phy_driver *phydrv = to_phy_driver(drv);
2386 int err = 0;
2387
2388 phydev->drv = phydrv;
2389
2390 /* Disable the interrupt if the PHY doesn't support it
2391 * but the interrupt is still a valid one
2392 */
2393 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2394 phydev->irq = PHY_POLL;
2395
2396 if (phydrv->flags & PHY_IS_INTERNAL)
2397 phydev->is_internal = true;
2398
2399 mutex_lock(&phydev->lock);
2400
2401 if (phydev->drv->probe) {
2402 /* Deassert the reset signal */
2403 phy_device_reset(phydev, 0);
2404
2405 err = phydev->drv->probe(phydev);
2406 if (err) {
2407 /* Assert the reset signal */
2408 phy_device_reset(phydev, 1);
2409 goto out;
2410 }
2411 }
2412
2413 /* Start out supporting everything. Eventually,
2414 * a controller will attach, and may modify one
2415 * or both of these values
2416 */
2417 if (phydrv->features) {
2418 linkmode_copy(phydev->supported, phydrv->features);
2419 } else if (phydrv->get_features) {
2420 err = phydrv->get_features(phydev);
2421 } else if (phydev->is_c45) {
2422 err = genphy_c45_pma_read_abilities(phydev);
2423 } else {
2424 err = genphy_read_abilities(phydev);
2425 }
2426
2427 if (err)
2428 goto out;
2429
2430 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2431 phydev->supported))
2432 phydev->autoneg = 0;
2433
2434 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2435 phydev->supported))
2436 phydev->is_gigabit_capable = 1;
2437 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2438 phydev->supported))
2439 phydev->is_gigabit_capable = 1;
2440
2441 of_set_phy_supported(phydev);
2442 phy_advertise_supported(phydev);
2443
2444 /* Get the EEE modes we want to prohibit. We will ask
2445 * the PHY stop advertising these mode later on
2446 */
2447 of_set_phy_eee_broken(phydev);
2448
2449 /* The Pause Frame bits indicate that the PHY can support passing
2450 * pause frames. During autonegotiation, the PHYs will determine if
2451 * they should allow pause frames to pass. The MAC driver should then
2452 * use that result to determine whether to enable flow control via
2453 * pause frames.
2454 *
2455 * Normally, PHY drivers should not set the Pause bits, and instead
2456 * allow phylib to do that. However, there may be some situations
2457 * (e.g. hardware erratum) where the driver wants to set only one
2458 * of these bits.
2459 */
2460 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2461 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2462 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2463 phydev->supported);
2464 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2465 phydev->supported);
2466 }
2467
2468 /* Set the state to READY by default */
2469 phydev->state = PHY_READY;
2470
2471out:
2472 mutex_unlock(&phydev->lock);
2473
2474 return err;
2475}
2476
2477static int phy_remove(struct device *dev)
2478{
2479 struct phy_device *phydev = to_phy_device(dev);
2480
2481 cancel_delayed_work_sync(&phydev->state_queue);
2482
2483 mutex_lock(&phydev->lock);
2484 phydev->state = PHY_DOWN;
2485 mutex_unlock(&phydev->lock);
2486
2487 sfp_bus_del_upstream(phydev->sfp_bus);
2488 phydev->sfp_bus = NULL;
2489
2490 if (phydev->drv && phydev->drv->remove) {
2491 phydev->drv->remove(phydev);
2492
2493 /* Assert the reset signal */
2494 phy_device_reset(phydev, 1);
2495 }
2496 phydev->drv = NULL;
2497
2498 return 0;
2499}
2500
2501/**
2502 * phy_driver_register - register a phy_driver with the PHY layer
2503 * @new_driver: new phy_driver to register
2504 * @owner: module owning this PHY
2505 */
2506int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2507{
2508 int retval;
2509
2510 /* Either the features are hard coded, or dynamically
2511 * determined. It cannot be both.
2512 */
2513 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2514 pr_err("%s: features and get_features must not both be set\n",
2515 new_driver->name);
2516 return -EINVAL;
2517 }
2518
2519 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2520 new_driver->mdiodrv.driver.name = new_driver->name;
2521 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2522 new_driver->mdiodrv.driver.probe = phy_probe;
2523 new_driver->mdiodrv.driver.remove = phy_remove;
2524 new_driver->mdiodrv.driver.owner = owner;
2525
2526 retval = driver_register(&new_driver->mdiodrv.driver);
2527 if (retval) {
2528 pr_err("%s: Error %d in registering driver\n",
2529 new_driver->name, retval);
2530
2531 return retval;
2532 }
2533
2534 pr_debug("%s: Registered new driver\n", new_driver->name);
2535
2536 return 0;
2537}
2538EXPORT_SYMBOL(phy_driver_register);
2539
2540int phy_drivers_register(struct phy_driver *new_driver, int n,
2541 struct module *owner)
2542{
2543 int i, ret = 0;
2544
2545 for (i = 0; i < n; i++) {
2546 ret = phy_driver_register(new_driver + i, owner);
2547 if (ret) {
2548 while (i-- > 0)
2549 phy_driver_unregister(new_driver + i);
2550 break;
2551 }
2552 }
2553 return ret;
2554}
2555EXPORT_SYMBOL(phy_drivers_register);
2556
2557void phy_driver_unregister(struct phy_driver *drv)
2558{
2559 driver_unregister(&drv->mdiodrv.driver);
2560}
2561EXPORT_SYMBOL(phy_driver_unregister);
2562
2563void phy_drivers_unregister(struct phy_driver *drv, int n)
2564{
2565 int i;
2566
2567 for (i = 0; i < n; i++)
2568 phy_driver_unregister(drv + i);
2569}
2570EXPORT_SYMBOL(phy_drivers_unregister);
2571
2572static struct phy_driver genphy_driver = {
2573 .phy_id = 0xffffffff,
2574 .phy_id_mask = 0xffffffff,
2575 .name = "Generic PHY",
2576 .soft_reset = genphy_no_soft_reset,
2577 .get_features = genphy_read_abilities,
2578 .aneg_done = genphy_aneg_done,
2579 .suspend = genphy_suspend,
2580 .resume = genphy_resume,
2581 .set_loopback = genphy_loopback,
2582};
2583
2584static int __init phy_init(void)
2585{
2586 int rc;
2587
2588 rc = mdio_bus_init();
2589 if (rc)
2590 return rc;
2591
2592 features_init();
2593
2594 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
2595 if (rc)
2596 goto err_c45;
2597
2598 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2599 if (rc) {
2600 phy_driver_unregister(&genphy_c45_driver);
2601err_c45:
2602 mdio_bus_exit();
2603 }
2604
2605 return rc;
2606}
2607
2608static void __exit phy_exit(void)
2609{
2610 phy_driver_unregister(&genphy_c45_driver);
2611 phy_driver_unregister(&genphy_driver);
2612 mdio_bus_exit();
2613}
2614
2615subsys_initcall(phy_init);
2616module_exit(phy_exit);