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/acpi.h> 13 #include <linux/bitmap.h> 14 #include <linux/delay.h> 15 #include <linux/errno.h> 16 #include <linux/etherdevice.h> 17 #include <linux/ethtool.h> 18 #include <linux/init.h> 19 #include <linux/interrupt.h> 20 #include <linux/io.h> 21 #include <linux/kernel.h> 22 #include <linux/mdio.h> 23 #include <linux/mii.h> 24 #include <linux/mm.h> 25 #include <linux/module.h> 26 #include <linux/netdevice.h> 27 #include <linux/phy.h> 28 #include <linux/phy_led_triggers.h> 29 #include <linux/pse-pd/pse.h> 30 #include <linux/property.h> 31 #include <linux/sfp.h> 32 #include <linux/skbuff.h> 33 #include <linux/slab.h> 34 #include <linux/string.h> 35 #include <linux/uaccess.h> 36 #include <linux/unistd.h> 37 38 MODULE_DESCRIPTION("PHY library"); 39 MODULE_AUTHOR("Andy Fleming"); 40 MODULE_LICENSE("GPL"); 41 42 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init; 43 EXPORT_SYMBOL_GPL(phy_basic_features); 44 45 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init; 46 EXPORT_SYMBOL_GPL(phy_basic_t1_features); 47 48 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init; 49 EXPORT_SYMBOL_GPL(phy_gbit_features); 50 51 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init; 52 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features); 53 54 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init; 55 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features); 56 57 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init; 58 EXPORT_SYMBOL_GPL(phy_10gbit_features); 59 60 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init; 61 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features); 62 63 const int phy_basic_ports_array[3] = { 64 ETHTOOL_LINK_MODE_Autoneg_BIT, 65 ETHTOOL_LINK_MODE_TP_BIT, 66 ETHTOOL_LINK_MODE_MII_BIT, 67 }; 68 EXPORT_SYMBOL_GPL(phy_basic_ports_array); 69 70 const int phy_fibre_port_array[1] = { 71 ETHTOOL_LINK_MODE_FIBRE_BIT, 72 }; 73 EXPORT_SYMBOL_GPL(phy_fibre_port_array); 74 75 const int phy_all_ports_features_array[7] = { 76 ETHTOOL_LINK_MODE_Autoneg_BIT, 77 ETHTOOL_LINK_MODE_TP_BIT, 78 ETHTOOL_LINK_MODE_MII_BIT, 79 ETHTOOL_LINK_MODE_FIBRE_BIT, 80 ETHTOOL_LINK_MODE_AUI_BIT, 81 ETHTOOL_LINK_MODE_BNC_BIT, 82 ETHTOOL_LINK_MODE_Backplane_BIT, 83 }; 84 EXPORT_SYMBOL_GPL(phy_all_ports_features_array); 85 86 const int phy_10_100_features_array[4] = { 87 ETHTOOL_LINK_MODE_10baseT_Half_BIT, 88 ETHTOOL_LINK_MODE_10baseT_Full_BIT, 89 ETHTOOL_LINK_MODE_100baseT_Half_BIT, 90 ETHTOOL_LINK_MODE_100baseT_Full_BIT, 91 }; 92 EXPORT_SYMBOL_GPL(phy_10_100_features_array); 93 94 const int phy_basic_t1_features_array[3] = { 95 ETHTOOL_LINK_MODE_TP_BIT, 96 ETHTOOL_LINK_MODE_10baseT1L_Full_BIT, 97 ETHTOOL_LINK_MODE_100baseT1_Full_BIT, 98 }; 99 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array); 100 101 const int phy_gbit_features_array[2] = { 102 ETHTOOL_LINK_MODE_1000baseT_Half_BIT, 103 ETHTOOL_LINK_MODE_1000baseT_Full_BIT, 104 }; 105 EXPORT_SYMBOL_GPL(phy_gbit_features_array); 106 107 const int phy_10gbit_features_array[1] = { 108 ETHTOOL_LINK_MODE_10000baseT_Full_BIT, 109 }; 110 EXPORT_SYMBOL_GPL(phy_10gbit_features_array); 111 112 static const int phy_10gbit_fec_features_array[1] = { 113 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT, 114 }; 115 116 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init; 117 EXPORT_SYMBOL_GPL(phy_10gbit_full_features); 118 119 static const int phy_10gbit_full_features_array[] = { 120 ETHTOOL_LINK_MODE_10baseT_Full_BIT, 121 ETHTOOL_LINK_MODE_100baseT_Full_BIT, 122 ETHTOOL_LINK_MODE_1000baseT_Full_BIT, 123 ETHTOOL_LINK_MODE_10000baseT_Full_BIT, 124 }; 125 126 static void features_init(void) 127 { 128 /* 10/100 half/full*/ 129 linkmode_set_bit_array(phy_basic_ports_array, 130 ARRAY_SIZE(phy_basic_ports_array), 131 phy_basic_features); 132 linkmode_set_bit_array(phy_10_100_features_array, 133 ARRAY_SIZE(phy_10_100_features_array), 134 phy_basic_features); 135 136 /* 100 full, TP */ 137 linkmode_set_bit_array(phy_basic_t1_features_array, 138 ARRAY_SIZE(phy_basic_t1_features_array), 139 phy_basic_t1_features); 140 141 /* 10/100 half/full + 1000 half/full */ 142 linkmode_set_bit_array(phy_basic_ports_array, 143 ARRAY_SIZE(phy_basic_ports_array), 144 phy_gbit_features); 145 linkmode_set_bit_array(phy_10_100_features_array, 146 ARRAY_SIZE(phy_10_100_features_array), 147 phy_gbit_features); 148 linkmode_set_bit_array(phy_gbit_features_array, 149 ARRAY_SIZE(phy_gbit_features_array), 150 phy_gbit_features); 151 152 /* 10/100 half/full + 1000 half/full + fibre*/ 153 linkmode_set_bit_array(phy_basic_ports_array, 154 ARRAY_SIZE(phy_basic_ports_array), 155 phy_gbit_fibre_features); 156 linkmode_set_bit_array(phy_10_100_features_array, 157 ARRAY_SIZE(phy_10_100_features_array), 158 phy_gbit_fibre_features); 159 linkmode_set_bit_array(phy_gbit_features_array, 160 ARRAY_SIZE(phy_gbit_features_array), 161 phy_gbit_fibre_features); 162 linkmode_set_bit_array(phy_fibre_port_array, 163 ARRAY_SIZE(phy_fibre_port_array), 164 phy_gbit_fibre_features); 165 166 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/ 167 linkmode_set_bit_array(phy_all_ports_features_array, 168 ARRAY_SIZE(phy_all_ports_features_array), 169 phy_gbit_all_ports_features); 170 linkmode_set_bit_array(phy_10_100_features_array, 171 ARRAY_SIZE(phy_10_100_features_array), 172 phy_gbit_all_ports_features); 173 linkmode_set_bit_array(phy_gbit_features_array, 174 ARRAY_SIZE(phy_gbit_features_array), 175 phy_gbit_all_ports_features); 176 177 /* 10/100 half/full + 1000 half/full + 10G full*/ 178 linkmode_set_bit_array(phy_all_ports_features_array, 179 ARRAY_SIZE(phy_all_ports_features_array), 180 phy_10gbit_features); 181 linkmode_set_bit_array(phy_10_100_features_array, 182 ARRAY_SIZE(phy_10_100_features_array), 183 phy_10gbit_features); 184 linkmode_set_bit_array(phy_gbit_features_array, 185 ARRAY_SIZE(phy_gbit_features_array), 186 phy_10gbit_features); 187 linkmode_set_bit_array(phy_10gbit_features_array, 188 ARRAY_SIZE(phy_10gbit_features_array), 189 phy_10gbit_features); 190 191 /* 10/100/1000/10G full */ 192 linkmode_set_bit_array(phy_all_ports_features_array, 193 ARRAY_SIZE(phy_all_ports_features_array), 194 phy_10gbit_full_features); 195 linkmode_set_bit_array(phy_10gbit_full_features_array, 196 ARRAY_SIZE(phy_10gbit_full_features_array), 197 phy_10gbit_full_features); 198 /* 10G FEC only */ 199 linkmode_set_bit_array(phy_10gbit_fec_features_array, 200 ARRAY_SIZE(phy_10gbit_fec_features_array), 201 phy_10gbit_fec_features); 202 } 203 204 void phy_device_free(struct phy_device *phydev) 205 { 206 put_device(&phydev->mdio.dev); 207 } 208 EXPORT_SYMBOL(phy_device_free); 209 210 static void phy_mdio_device_free(struct mdio_device *mdiodev) 211 { 212 struct phy_device *phydev; 213 214 phydev = container_of(mdiodev, struct phy_device, mdio); 215 phy_device_free(phydev); 216 } 217 218 static void phy_device_release(struct device *dev) 219 { 220 kfree(to_phy_device(dev)); 221 } 222 223 static void phy_mdio_device_remove(struct mdio_device *mdiodev) 224 { 225 struct phy_device *phydev; 226 227 phydev = container_of(mdiodev, struct phy_device, mdio); 228 phy_device_remove(phydev); 229 } 230 231 static struct phy_driver genphy_driver; 232 233 static LIST_HEAD(phy_fixup_list); 234 static DEFINE_MUTEX(phy_fixup_lock); 235 236 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev) 237 { 238 struct device_driver *drv = phydev->mdio.dev.driver; 239 struct phy_driver *phydrv = to_phy_driver(drv); 240 struct net_device *netdev = phydev->attached_dev; 241 242 if (!drv || !phydrv->suspend) 243 return false; 244 245 /* PHY not attached? May suspend if the PHY has not already been 246 * suspended as part of a prior call to phy_disconnect() -> 247 * phy_detach() -> phy_suspend() because the parent netdev might be the 248 * MDIO bus driver and clock gated at this point. 249 */ 250 if (!netdev) 251 goto out; 252 253 if (netdev->wol_enabled) 254 return false; 255 256 /* As long as not all affected network drivers support the 257 * wol_enabled flag, let's check for hints that WoL is enabled. 258 * Don't suspend PHY if the attached netdev parent may wake up. 259 * The parent may point to a PCI device, as in tg3 driver. 260 */ 261 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent)) 262 return false; 263 264 /* Also don't suspend PHY if the netdev itself may wakeup. This 265 * is the case for devices w/o underlaying pwr. mgmt. aware bus, 266 * e.g. SoC devices. 267 */ 268 if (device_may_wakeup(&netdev->dev)) 269 return false; 270 271 out: 272 return !phydev->suspended; 273 } 274 275 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev) 276 { 277 struct phy_device *phydev = to_phy_device(dev); 278 279 if (phydev->mac_managed_pm) 280 return 0; 281 282 /* Wakeup interrupts may occur during the system sleep transition when 283 * the PHY is inaccessible. Set flag to postpone handling until the PHY 284 * has resumed. Wait for concurrent interrupt handler to complete. 285 */ 286 if (phy_interrupt_is_valid(phydev)) { 287 phydev->irq_suspended = 1; 288 synchronize_irq(phydev->irq); 289 } 290 291 /* We must stop the state machine manually, otherwise it stops out of 292 * control, possibly with the phydev->lock held. Upon resume, netdev 293 * may call phy routines that try to grab the same lock, and that may 294 * lead to a deadlock. 295 */ 296 if (phydev->attached_dev && phydev->adjust_link) 297 phy_stop_machine(phydev); 298 299 if (!mdio_bus_phy_may_suspend(phydev)) 300 return 0; 301 302 phydev->suspended_by_mdio_bus = 1; 303 304 return phy_suspend(phydev); 305 } 306 307 static __maybe_unused int mdio_bus_phy_resume(struct device *dev) 308 { 309 struct phy_device *phydev = to_phy_device(dev); 310 int ret; 311 312 if (phydev->mac_managed_pm) 313 return 0; 314 315 if (!phydev->suspended_by_mdio_bus) 316 goto no_resume; 317 318 phydev->suspended_by_mdio_bus = 0; 319 320 /* If we managed to get here with the PHY state machine in a state 321 * neither PHY_HALTED, PHY_READY nor PHY_UP, this is an indication 322 * that something went wrong and we should most likely be using 323 * MAC managed PM, but we are not. 324 */ 325 WARN_ON(phydev->state != PHY_HALTED && phydev->state != PHY_READY && 326 phydev->state != PHY_UP); 327 328 ret = phy_init_hw(phydev); 329 if (ret < 0) 330 return ret; 331 332 ret = phy_resume(phydev); 333 if (ret < 0) 334 return ret; 335 no_resume: 336 if (phy_interrupt_is_valid(phydev)) { 337 phydev->irq_suspended = 0; 338 synchronize_irq(phydev->irq); 339 340 /* Rerun interrupts which were postponed by phy_interrupt() 341 * because they occurred during the system sleep transition. 342 */ 343 if (phydev->irq_rerun) { 344 phydev->irq_rerun = 0; 345 enable_irq(phydev->irq); 346 irq_wake_thread(phydev->irq, phydev); 347 } 348 } 349 350 if (phydev->attached_dev && phydev->adjust_link) 351 phy_start_machine(phydev); 352 353 return 0; 354 } 355 356 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend, 357 mdio_bus_phy_resume); 358 359 /** 360 * phy_register_fixup - creates a new phy_fixup and adds it to the list 361 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID) 362 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY) 363 * It can also be PHY_ANY_UID 364 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before 365 * comparison 366 * @run: The actual code to be run when a matching PHY is found 367 */ 368 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, 369 int (*run)(struct phy_device *)) 370 { 371 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL); 372 373 if (!fixup) 374 return -ENOMEM; 375 376 strscpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id)); 377 fixup->phy_uid = phy_uid; 378 fixup->phy_uid_mask = phy_uid_mask; 379 fixup->run = run; 380 381 mutex_lock(&phy_fixup_lock); 382 list_add_tail(&fixup->list, &phy_fixup_list); 383 mutex_unlock(&phy_fixup_lock); 384 385 return 0; 386 } 387 EXPORT_SYMBOL(phy_register_fixup); 388 389 /* Registers a fixup to be run on any PHY with the UID in phy_uid */ 390 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, 391 int (*run)(struct phy_device *)) 392 { 393 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run); 394 } 395 EXPORT_SYMBOL(phy_register_fixup_for_uid); 396 397 /* Registers a fixup to be run on the PHY with id string bus_id */ 398 int phy_register_fixup_for_id(const char *bus_id, 399 int (*run)(struct phy_device *)) 400 { 401 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run); 402 } 403 EXPORT_SYMBOL(phy_register_fixup_for_id); 404 405 /** 406 * phy_unregister_fixup - remove a phy_fixup from the list 407 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list 408 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list 409 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison 410 */ 411 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask) 412 { 413 struct list_head *pos, *n; 414 struct phy_fixup *fixup; 415 int ret; 416 417 ret = -ENODEV; 418 419 mutex_lock(&phy_fixup_lock); 420 list_for_each_safe(pos, n, &phy_fixup_list) { 421 fixup = list_entry(pos, struct phy_fixup, list); 422 423 if ((!strcmp(fixup->bus_id, bus_id)) && 424 ((fixup->phy_uid & phy_uid_mask) == 425 (phy_uid & phy_uid_mask))) { 426 list_del(&fixup->list); 427 kfree(fixup); 428 ret = 0; 429 break; 430 } 431 } 432 mutex_unlock(&phy_fixup_lock); 433 434 return ret; 435 } 436 EXPORT_SYMBOL(phy_unregister_fixup); 437 438 /* Unregisters a fixup of any PHY with the UID in phy_uid */ 439 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask) 440 { 441 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask); 442 } 443 EXPORT_SYMBOL(phy_unregister_fixup_for_uid); 444 445 /* Unregisters a fixup of the PHY with id string bus_id */ 446 int phy_unregister_fixup_for_id(const char *bus_id) 447 { 448 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff); 449 } 450 EXPORT_SYMBOL(phy_unregister_fixup_for_id); 451 452 /* Returns 1 if fixup matches phydev in bus_id and phy_uid. 453 * Fixups can be set to match any in one or more fields. 454 */ 455 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup) 456 { 457 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0) 458 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0) 459 return 0; 460 461 if ((fixup->phy_uid & fixup->phy_uid_mask) != 462 (phydev->phy_id & fixup->phy_uid_mask)) 463 if (fixup->phy_uid != PHY_ANY_UID) 464 return 0; 465 466 return 1; 467 } 468 469 /* Runs any matching fixups for this phydev */ 470 static int phy_scan_fixups(struct phy_device *phydev) 471 { 472 struct phy_fixup *fixup; 473 474 mutex_lock(&phy_fixup_lock); 475 list_for_each_entry(fixup, &phy_fixup_list, list) { 476 if (phy_needs_fixup(phydev, fixup)) { 477 int err = fixup->run(phydev); 478 479 if (err < 0) { 480 mutex_unlock(&phy_fixup_lock); 481 return err; 482 } 483 phydev->has_fixups = true; 484 } 485 } 486 mutex_unlock(&phy_fixup_lock); 487 488 return 0; 489 } 490 491 static int phy_bus_match(struct device *dev, struct device_driver *drv) 492 { 493 struct phy_device *phydev = to_phy_device(dev); 494 struct phy_driver *phydrv = to_phy_driver(drv); 495 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids); 496 int i; 497 498 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY)) 499 return 0; 500 501 if (phydrv->match_phy_device) 502 return phydrv->match_phy_device(phydev); 503 504 if (phydev->is_c45) { 505 for (i = 1; i < num_ids; i++) { 506 if (phydev->c45_ids.device_ids[i] == 0xffffffff) 507 continue; 508 509 if ((phydrv->phy_id & phydrv->phy_id_mask) == 510 (phydev->c45_ids.device_ids[i] & 511 phydrv->phy_id_mask)) 512 return 1; 513 } 514 return 0; 515 } else { 516 return (phydrv->phy_id & phydrv->phy_id_mask) == 517 (phydev->phy_id & phydrv->phy_id_mask); 518 } 519 } 520 521 static ssize_t 522 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf) 523 { 524 struct phy_device *phydev = to_phy_device(dev); 525 526 return sysfs_emit(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id); 527 } 528 static DEVICE_ATTR_RO(phy_id); 529 530 static ssize_t 531 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf) 532 { 533 struct phy_device *phydev = to_phy_device(dev); 534 const char *mode = NULL; 535 536 if (phy_is_internal(phydev)) 537 mode = "internal"; 538 else 539 mode = phy_modes(phydev->interface); 540 541 return sysfs_emit(buf, "%s\n", mode); 542 } 543 static DEVICE_ATTR_RO(phy_interface); 544 545 static ssize_t 546 phy_has_fixups_show(struct device *dev, struct device_attribute *attr, 547 char *buf) 548 { 549 struct phy_device *phydev = to_phy_device(dev); 550 551 return sysfs_emit(buf, "%d\n", phydev->has_fixups); 552 } 553 static DEVICE_ATTR_RO(phy_has_fixups); 554 555 static ssize_t phy_dev_flags_show(struct device *dev, 556 struct device_attribute *attr, 557 char *buf) 558 { 559 struct phy_device *phydev = to_phy_device(dev); 560 561 return sysfs_emit(buf, "0x%08x\n", phydev->dev_flags); 562 } 563 static DEVICE_ATTR_RO(phy_dev_flags); 564 565 static struct attribute *phy_dev_attrs[] = { 566 &dev_attr_phy_id.attr, 567 &dev_attr_phy_interface.attr, 568 &dev_attr_phy_has_fixups.attr, 569 &dev_attr_phy_dev_flags.attr, 570 NULL, 571 }; 572 ATTRIBUTE_GROUPS(phy_dev); 573 574 static const struct device_type mdio_bus_phy_type = { 575 .name = "PHY", 576 .groups = phy_dev_groups, 577 .release = phy_device_release, 578 .pm = pm_ptr(&mdio_bus_phy_pm_ops), 579 }; 580 581 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id) 582 { 583 int ret; 584 585 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, 586 MDIO_ID_ARGS(phy_id)); 587 /* We only check for failures in executing the usermode binary, 588 * not whether a PHY driver module exists for the PHY ID. 589 * Accept -ENOENT because this may occur in case no initramfs exists, 590 * then modprobe isn't available. 591 */ 592 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) { 593 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n", 594 ret, (unsigned long)phy_id); 595 return ret; 596 } 597 598 return 0; 599 } 600 601 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id, 602 bool is_c45, 603 struct phy_c45_device_ids *c45_ids) 604 { 605 struct phy_device *dev; 606 struct mdio_device *mdiodev; 607 int ret = 0; 608 609 /* We allocate the device, and initialize the default values */ 610 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 611 if (!dev) 612 return ERR_PTR(-ENOMEM); 613 614 mdiodev = &dev->mdio; 615 mdiodev->dev.parent = &bus->dev; 616 mdiodev->dev.bus = &mdio_bus_type; 617 mdiodev->dev.type = &mdio_bus_phy_type; 618 mdiodev->bus = bus; 619 mdiodev->bus_match = phy_bus_match; 620 mdiodev->addr = addr; 621 mdiodev->flags = MDIO_DEVICE_FLAG_PHY; 622 mdiodev->device_free = phy_mdio_device_free; 623 mdiodev->device_remove = phy_mdio_device_remove; 624 625 dev->speed = SPEED_UNKNOWN; 626 dev->duplex = DUPLEX_UNKNOWN; 627 dev->pause = 0; 628 dev->asym_pause = 0; 629 dev->link = 0; 630 dev->port = PORT_TP; 631 dev->interface = PHY_INTERFACE_MODE_GMII; 632 633 dev->autoneg = AUTONEG_ENABLE; 634 635 dev->pma_extable = -ENODATA; 636 dev->is_c45 = is_c45; 637 dev->phy_id = phy_id; 638 if (c45_ids) 639 dev->c45_ids = *c45_ids; 640 dev->irq = bus->irq[addr]; 641 642 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr); 643 device_initialize(&mdiodev->dev); 644 645 dev->state = PHY_DOWN; 646 647 mutex_init(&dev->lock); 648 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine); 649 650 /* Request the appropriate module unconditionally; don't 651 * bother trying to do so only if it isn't already loaded, 652 * because that gets complicated. A hotplug event would have 653 * done an unconditional modprobe anyway. 654 * We don't do normal hotplug because it won't work for MDIO 655 * -- because it relies on the device staying around for long 656 * enough for the driver to get loaded. With MDIO, the NIC 657 * driver will get bored and give up as soon as it finds that 658 * there's no driver _already_ loaded. 659 */ 660 if (is_c45 && c45_ids) { 661 const int num_ids = ARRAY_SIZE(c45_ids->device_ids); 662 int i; 663 664 for (i = 1; i < num_ids; i++) { 665 if (c45_ids->device_ids[i] == 0xffffffff) 666 continue; 667 668 ret = phy_request_driver_module(dev, 669 c45_ids->device_ids[i]); 670 if (ret) 671 break; 672 } 673 } else { 674 ret = phy_request_driver_module(dev, phy_id); 675 } 676 677 if (ret) { 678 put_device(&mdiodev->dev); 679 dev = ERR_PTR(ret); 680 } 681 682 return dev; 683 } 684 EXPORT_SYMBOL(phy_device_create); 685 686 /* phy_c45_probe_present - checks to see if a MMD is present in the package 687 * @bus: the target MII bus 688 * @prtad: PHY package address on the MII bus 689 * @devad: PHY device (MMD) address 690 * 691 * Read the MDIO_STAT2 register, and check whether a device is responding 692 * at this address. 693 * 694 * Returns: negative error number on bus access error, zero if no device 695 * is responding, or positive if a device is present. 696 */ 697 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad) 698 { 699 int stat2; 700 701 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2); 702 if (stat2 < 0) 703 return stat2; 704 705 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL; 706 } 707 708 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers. 709 * @bus: the target MII bus 710 * @addr: PHY address on the MII bus 711 * @dev_addr: MMD address in the PHY. 712 * @devices_in_package: where to store the devices in package information. 713 * 714 * Description: reads devices in package registers of a MMD at @dev_addr 715 * from PHY at @addr on @bus. 716 * 717 * Returns: 0 on success, -EIO on failure. 718 */ 719 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr, 720 u32 *devices_in_package) 721 { 722 int phy_reg; 723 724 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2); 725 if (phy_reg < 0) 726 return -EIO; 727 *devices_in_package = phy_reg << 16; 728 729 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1); 730 if (phy_reg < 0) 731 return -EIO; 732 *devices_in_package |= phy_reg; 733 734 return 0; 735 } 736 737 /** 738 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs. 739 * @bus: the target MII bus 740 * @addr: PHY address on the MII bus 741 * @c45_ids: where to store the c45 ID information. 742 * 743 * Read the PHY "devices in package". If this appears to be valid, read 744 * the PHY identifiers for each device. Return the "devices in package" 745 * and identifiers in @c45_ids. 746 * 747 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if 748 * the "devices in package" is invalid. 749 */ 750 static int get_phy_c45_ids(struct mii_bus *bus, int addr, 751 struct phy_c45_device_ids *c45_ids) 752 { 753 const int num_ids = ARRAY_SIZE(c45_ids->device_ids); 754 u32 devs_in_pkg = 0; 755 int i, ret, phy_reg; 756 757 /* Find first non-zero Devices In package. Device zero is reserved 758 * for 802.3 c45 complied PHYs, so don't probe it at first. 759 */ 760 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 || 761 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) { 762 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) { 763 /* Check that there is a device present at this 764 * address before reading the devices-in-package 765 * register to avoid reading garbage from the PHY. 766 * Some PHYs (88x3310) vendor space is not IEEE802.3 767 * compliant. 768 */ 769 ret = phy_c45_probe_present(bus, addr, i); 770 if (ret < 0) 771 return -EIO; 772 773 if (!ret) 774 continue; 775 } 776 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg); 777 if (phy_reg < 0) 778 return -EIO; 779 } 780 781 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) { 782 /* If mostly Fs, there is no device there, then let's probe 783 * MMD 0, as some 10G PHYs have zero Devices In package, 784 * e.g. Cortina CS4315/CS4340 PHY. 785 */ 786 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg); 787 if (phy_reg < 0) 788 return -EIO; 789 790 /* no device there, let's get out of here */ 791 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) 792 return -ENODEV; 793 } 794 795 /* Now probe Device Identifiers for each device present. */ 796 for (i = 1; i < num_ids; i++) { 797 if (!(devs_in_pkg & (1 << i))) 798 continue; 799 800 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) { 801 /* Probe the "Device Present" bits for the vendor MMDs 802 * to ignore these if they do not contain IEEE 802.3 803 * registers. 804 */ 805 ret = phy_c45_probe_present(bus, addr, i); 806 if (ret < 0) 807 return ret; 808 809 if (!ret) 810 continue; 811 } 812 813 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1); 814 if (phy_reg < 0) 815 return -EIO; 816 c45_ids->device_ids[i] = phy_reg << 16; 817 818 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2); 819 if (phy_reg < 0) 820 return -EIO; 821 c45_ids->device_ids[i] |= phy_reg; 822 } 823 824 c45_ids->devices_in_package = devs_in_pkg; 825 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */ 826 c45_ids->mmds_present = devs_in_pkg & ~BIT(0); 827 828 return 0; 829 } 830 831 /** 832 * get_phy_c22_id - reads the specified addr for its clause 22 ID. 833 * @bus: the target MII bus 834 * @addr: PHY address on the MII bus 835 * @phy_id: where to store the ID retrieved. 836 * 837 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus, 838 * placing it in @phy_id. Return zero on successful read and the ID is 839 * valid, %-EIO on bus access error, or %-ENODEV if no device responds 840 * or invalid ID. 841 */ 842 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id) 843 { 844 int phy_reg; 845 846 /* Grab the bits from PHYIR1, and put them in the upper half */ 847 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1); 848 if (phy_reg < 0) { 849 /* returning -ENODEV doesn't stop bus scanning */ 850 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO; 851 } 852 853 *phy_id = phy_reg << 16; 854 855 /* Grab the bits from PHYIR2, and put them in the lower half */ 856 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2); 857 if (phy_reg < 0) { 858 /* returning -ENODEV doesn't stop bus scanning */ 859 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO; 860 } 861 862 *phy_id |= phy_reg; 863 864 /* If the phy_id is mostly Fs, there is no device there */ 865 if ((*phy_id & 0x1fffffff) == 0x1fffffff) 866 return -ENODEV; 867 868 return 0; 869 } 870 871 /* Extract the phy ID from the compatible string of the form 872 * ethernet-phy-idAAAA.BBBB. 873 */ 874 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id) 875 { 876 unsigned int upper, lower; 877 const char *cp; 878 int ret; 879 880 ret = fwnode_property_read_string(fwnode, "compatible", &cp); 881 if (ret) 882 return ret; 883 884 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) != 2) 885 return -EINVAL; 886 887 *phy_id = ((upper & GENMASK(15, 0)) << 16) | (lower & GENMASK(15, 0)); 888 return 0; 889 } 890 EXPORT_SYMBOL(fwnode_get_phy_id); 891 892 /** 893 * get_phy_device - reads the specified PHY device and returns its @phy_device 894 * struct 895 * @bus: the target MII bus 896 * @addr: PHY address on the MII bus 897 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol 898 * 899 * Probe for a PHY at @addr on @bus. 900 * 901 * When probing for a clause 22 PHY, then read the ID registers. If we find 902 * a valid ID, allocate and return a &struct phy_device. 903 * 904 * When probing for a clause 45 PHY, read the "devices in package" registers. 905 * If the "devices in package" appears valid, read the ID registers for each 906 * MMD, allocate and return a &struct phy_device. 907 * 908 * Returns an allocated &struct phy_device on success, %-ENODEV if there is 909 * no PHY present, or %-EIO on bus access error. 910 */ 911 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45) 912 { 913 struct phy_c45_device_ids c45_ids; 914 u32 phy_id = 0; 915 int r; 916 917 c45_ids.devices_in_package = 0; 918 c45_ids.mmds_present = 0; 919 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids)); 920 921 if (is_c45) 922 r = get_phy_c45_ids(bus, addr, &c45_ids); 923 else 924 r = get_phy_c22_id(bus, addr, &phy_id); 925 926 if (r) 927 return ERR_PTR(r); 928 929 /* PHY device such as the Marvell Alaska 88E2110 will return a PHY ID 930 * of 0 when probed using get_phy_c22_id() with no error. Proceed to 931 * probe with C45 to see if we're able to get a valid PHY ID in the C45 932 * space, if successful, create the C45 PHY device. 933 */ 934 if (!is_c45 && phy_id == 0 && bus->probe_capabilities >= MDIOBUS_C45) { 935 r = get_phy_c45_ids(bus, addr, &c45_ids); 936 if (!r) 937 return phy_device_create(bus, addr, phy_id, 938 true, &c45_ids); 939 } 940 941 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids); 942 } 943 EXPORT_SYMBOL(get_phy_device); 944 945 /** 946 * phy_device_register - Register the phy device on the MDIO bus 947 * @phydev: phy_device structure to be added to the MDIO bus 948 */ 949 int phy_device_register(struct phy_device *phydev) 950 { 951 int err; 952 953 err = mdiobus_register_device(&phydev->mdio); 954 if (err) 955 return err; 956 957 /* Deassert the reset signal */ 958 phy_device_reset(phydev, 0); 959 960 /* Run all of the fixups for this PHY */ 961 err = phy_scan_fixups(phydev); 962 if (err) { 963 phydev_err(phydev, "failed to initialize\n"); 964 goto out; 965 } 966 967 err = device_add(&phydev->mdio.dev); 968 if (err) { 969 phydev_err(phydev, "failed to add\n"); 970 goto out; 971 } 972 973 return 0; 974 975 out: 976 /* Assert the reset signal */ 977 phy_device_reset(phydev, 1); 978 979 mdiobus_unregister_device(&phydev->mdio); 980 return err; 981 } 982 EXPORT_SYMBOL(phy_device_register); 983 984 /** 985 * phy_device_remove - Remove a previously registered phy device from the MDIO bus 986 * @phydev: phy_device structure to remove 987 * 988 * This doesn't free the phy_device itself, it merely reverses the effects 989 * of phy_device_register(). Use phy_device_free() to free the device 990 * after calling this function. 991 */ 992 void phy_device_remove(struct phy_device *phydev) 993 { 994 unregister_mii_timestamper(phydev->mii_ts); 995 pse_control_put(phydev->psec); 996 997 device_del(&phydev->mdio.dev); 998 999 /* Assert the reset signal */ 1000 phy_device_reset(phydev, 1); 1001 1002 mdiobus_unregister_device(&phydev->mdio); 1003 } 1004 EXPORT_SYMBOL(phy_device_remove); 1005 1006 /** 1007 * phy_get_c45_ids - Read 802.3-c45 IDs for phy device. 1008 * @phydev: phy_device structure to read 802.3-c45 IDs 1009 * 1010 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if 1011 * the "devices in package" is invalid. 1012 */ 1013 int phy_get_c45_ids(struct phy_device *phydev) 1014 { 1015 return get_phy_c45_ids(phydev->mdio.bus, phydev->mdio.addr, 1016 &phydev->c45_ids); 1017 } 1018 EXPORT_SYMBOL(phy_get_c45_ids); 1019 1020 /** 1021 * phy_find_first - finds the first PHY device on the bus 1022 * @bus: the target MII bus 1023 */ 1024 struct phy_device *phy_find_first(struct mii_bus *bus) 1025 { 1026 struct phy_device *phydev; 1027 int addr; 1028 1029 for (addr = 0; addr < PHY_MAX_ADDR; addr++) { 1030 phydev = mdiobus_get_phy(bus, addr); 1031 if (phydev) 1032 return phydev; 1033 } 1034 return NULL; 1035 } 1036 EXPORT_SYMBOL(phy_find_first); 1037 1038 static void phy_link_change(struct phy_device *phydev, bool up) 1039 { 1040 struct net_device *netdev = phydev->attached_dev; 1041 1042 if (up) 1043 netif_carrier_on(netdev); 1044 else 1045 netif_carrier_off(netdev); 1046 phydev->adjust_link(netdev); 1047 if (phydev->mii_ts && phydev->mii_ts->link_state) 1048 phydev->mii_ts->link_state(phydev->mii_ts, phydev); 1049 } 1050 1051 /** 1052 * phy_prepare_link - prepares the PHY layer to monitor link status 1053 * @phydev: target phy_device struct 1054 * @handler: callback function for link status change notifications 1055 * 1056 * Description: Tells the PHY infrastructure to handle the 1057 * gory details on monitoring link status (whether through 1058 * polling or an interrupt), and to call back to the 1059 * connected device driver when the link status changes. 1060 * If you want to monitor your own link state, don't call 1061 * this function. 1062 */ 1063 static void phy_prepare_link(struct phy_device *phydev, 1064 void (*handler)(struct net_device *)) 1065 { 1066 phydev->adjust_link = handler; 1067 } 1068 1069 /** 1070 * phy_connect_direct - connect an ethernet device to a specific phy_device 1071 * @dev: the network device to connect 1072 * @phydev: the pointer to the phy device 1073 * @handler: callback function for state change notifications 1074 * @interface: PHY device's interface 1075 */ 1076 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, 1077 void (*handler)(struct net_device *), 1078 phy_interface_t interface) 1079 { 1080 int rc; 1081 1082 if (!dev) 1083 return -EINVAL; 1084 1085 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface); 1086 if (rc) 1087 return rc; 1088 1089 phy_prepare_link(phydev, handler); 1090 if (phy_interrupt_is_valid(phydev)) 1091 phy_request_interrupt(phydev); 1092 1093 return 0; 1094 } 1095 EXPORT_SYMBOL(phy_connect_direct); 1096 1097 /** 1098 * phy_connect - connect an ethernet device to a PHY device 1099 * @dev: the network device to connect 1100 * @bus_id: the id string of the PHY device to connect 1101 * @handler: callback function for state change notifications 1102 * @interface: PHY device's interface 1103 * 1104 * Description: Convenience function for connecting ethernet 1105 * devices to PHY devices. The default behavior is for 1106 * the PHY infrastructure to handle everything, and only notify 1107 * the connected driver when the link status changes. If you 1108 * don't want, or can't use the provided functionality, you may 1109 * choose to call only the subset of functions which provide 1110 * the desired functionality. 1111 */ 1112 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, 1113 void (*handler)(struct net_device *), 1114 phy_interface_t interface) 1115 { 1116 struct phy_device *phydev; 1117 struct device *d; 1118 int rc; 1119 1120 /* Search the list of PHY devices on the mdio bus for the 1121 * PHY with the requested name 1122 */ 1123 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id); 1124 if (!d) { 1125 pr_err("PHY %s not found\n", bus_id); 1126 return ERR_PTR(-ENODEV); 1127 } 1128 phydev = to_phy_device(d); 1129 1130 rc = phy_connect_direct(dev, phydev, handler, interface); 1131 put_device(d); 1132 if (rc) 1133 return ERR_PTR(rc); 1134 1135 return phydev; 1136 } 1137 EXPORT_SYMBOL(phy_connect); 1138 1139 /** 1140 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY 1141 * device 1142 * @phydev: target phy_device struct 1143 */ 1144 void phy_disconnect(struct phy_device *phydev) 1145 { 1146 if (phy_is_started(phydev)) 1147 phy_stop(phydev); 1148 1149 if (phy_interrupt_is_valid(phydev)) 1150 phy_free_interrupt(phydev); 1151 1152 phydev->adjust_link = NULL; 1153 1154 phy_detach(phydev); 1155 } 1156 EXPORT_SYMBOL(phy_disconnect); 1157 1158 /** 1159 * phy_poll_reset - Safely wait until a PHY reset has properly completed 1160 * @phydev: The PHY device to poll 1161 * 1162 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as 1163 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR 1164 * register must be polled until the BMCR_RESET bit clears. 1165 * 1166 * Furthermore, any attempts to write to PHY registers may have no effect 1167 * or even generate MDIO bus errors until this is complete. 1168 * 1169 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the 1170 * standard and do not fully reset after the BMCR_RESET bit is set, and may 1171 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an 1172 * effort to support such broken PHYs, this function is separate from the 1173 * standard phy_init_hw() which will zero all the other bits in the BMCR 1174 * and reapply all driver-specific and board-specific fixups. 1175 */ 1176 static int phy_poll_reset(struct phy_device *phydev) 1177 { 1178 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */ 1179 int ret, val; 1180 1181 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET), 1182 50000, 600000, true); 1183 if (ret) 1184 return ret; 1185 /* Some chips (smsc911x) may still need up to another 1ms after the 1186 * BMCR_RESET bit is cleared before they are usable. 1187 */ 1188 msleep(1); 1189 return 0; 1190 } 1191 1192 int phy_init_hw(struct phy_device *phydev) 1193 { 1194 int ret = 0; 1195 1196 /* Deassert the reset signal */ 1197 phy_device_reset(phydev, 0); 1198 1199 if (!phydev->drv) 1200 return 0; 1201 1202 if (phydev->drv->soft_reset) { 1203 ret = phydev->drv->soft_reset(phydev); 1204 /* see comment in genphy_soft_reset for an explanation */ 1205 if (!ret) 1206 phydev->suspended = 0; 1207 } 1208 1209 if (ret < 0) 1210 return ret; 1211 1212 ret = phy_scan_fixups(phydev); 1213 if (ret < 0) 1214 return ret; 1215 1216 if (phydev->drv->config_init) { 1217 ret = phydev->drv->config_init(phydev); 1218 if (ret < 0) 1219 return ret; 1220 } 1221 1222 if (phydev->drv->config_intr) { 1223 ret = phydev->drv->config_intr(phydev); 1224 if (ret < 0) 1225 return ret; 1226 } 1227 1228 return 0; 1229 } 1230 EXPORT_SYMBOL(phy_init_hw); 1231 1232 void phy_attached_info(struct phy_device *phydev) 1233 { 1234 phy_attached_print(phydev, NULL); 1235 } 1236 EXPORT_SYMBOL(phy_attached_info); 1237 1238 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)" 1239 char *phy_attached_info_irq(struct phy_device *phydev) 1240 { 1241 char *irq_str; 1242 char irq_num[8]; 1243 1244 switch(phydev->irq) { 1245 case PHY_POLL: 1246 irq_str = "POLL"; 1247 break; 1248 case PHY_MAC_INTERRUPT: 1249 irq_str = "MAC"; 1250 break; 1251 default: 1252 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq); 1253 irq_str = irq_num; 1254 break; 1255 } 1256 1257 return kasprintf(GFP_KERNEL, "%s", irq_str); 1258 } 1259 EXPORT_SYMBOL(phy_attached_info_irq); 1260 1261 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...) 1262 { 1263 const char *unbound = phydev->drv ? "" : "[unbound] "; 1264 char *irq_str = phy_attached_info_irq(phydev); 1265 1266 if (!fmt) { 1267 phydev_info(phydev, ATTACHED_FMT "\n", unbound, 1268 phydev_name(phydev), irq_str); 1269 } else { 1270 va_list ap; 1271 1272 phydev_info(phydev, ATTACHED_FMT, unbound, 1273 phydev_name(phydev), irq_str); 1274 1275 va_start(ap, fmt); 1276 vprintk(fmt, ap); 1277 va_end(ap); 1278 } 1279 kfree(irq_str); 1280 } 1281 EXPORT_SYMBOL(phy_attached_print); 1282 1283 static void phy_sysfs_create_links(struct phy_device *phydev) 1284 { 1285 struct net_device *dev = phydev->attached_dev; 1286 int err; 1287 1288 if (!dev) 1289 return; 1290 1291 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj, 1292 "attached_dev"); 1293 if (err) 1294 return; 1295 1296 err = sysfs_create_link_nowarn(&dev->dev.kobj, 1297 &phydev->mdio.dev.kobj, 1298 "phydev"); 1299 if (err) { 1300 dev_err(&dev->dev, "could not add device link to %s err %d\n", 1301 kobject_name(&phydev->mdio.dev.kobj), 1302 err); 1303 /* non-fatal - some net drivers can use one netdevice 1304 * with more then one phy 1305 */ 1306 } 1307 1308 phydev->sysfs_links = true; 1309 } 1310 1311 static ssize_t 1312 phy_standalone_show(struct device *dev, struct device_attribute *attr, 1313 char *buf) 1314 { 1315 struct phy_device *phydev = to_phy_device(dev); 1316 1317 return sysfs_emit(buf, "%d\n", !phydev->attached_dev); 1318 } 1319 static DEVICE_ATTR_RO(phy_standalone); 1320 1321 /** 1322 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device 1323 * @upstream: pointer to the phy device 1324 * @bus: sfp bus representing cage being attached 1325 * 1326 * This is used to fill in the sfp_upstream_ops .attach member. 1327 */ 1328 void phy_sfp_attach(void *upstream, struct sfp_bus *bus) 1329 { 1330 struct phy_device *phydev = upstream; 1331 1332 if (phydev->attached_dev) 1333 phydev->attached_dev->sfp_bus = bus; 1334 phydev->sfp_bus_attached = true; 1335 } 1336 EXPORT_SYMBOL(phy_sfp_attach); 1337 1338 /** 1339 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device 1340 * @upstream: pointer to the phy device 1341 * @bus: sfp bus representing cage being attached 1342 * 1343 * This is used to fill in the sfp_upstream_ops .detach member. 1344 */ 1345 void phy_sfp_detach(void *upstream, struct sfp_bus *bus) 1346 { 1347 struct phy_device *phydev = upstream; 1348 1349 if (phydev->attached_dev) 1350 phydev->attached_dev->sfp_bus = NULL; 1351 phydev->sfp_bus_attached = false; 1352 } 1353 EXPORT_SYMBOL(phy_sfp_detach); 1354 1355 /** 1356 * phy_sfp_probe - probe for a SFP cage attached to this PHY device 1357 * @phydev: Pointer to phy_device 1358 * @ops: SFP's upstream operations 1359 */ 1360 int phy_sfp_probe(struct phy_device *phydev, 1361 const struct sfp_upstream_ops *ops) 1362 { 1363 struct sfp_bus *bus; 1364 int ret = 0; 1365 1366 if (phydev->mdio.dev.fwnode) { 1367 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode); 1368 if (IS_ERR(bus)) 1369 return PTR_ERR(bus); 1370 1371 phydev->sfp_bus = bus; 1372 1373 ret = sfp_bus_add_upstream(bus, phydev, ops); 1374 sfp_bus_put(bus); 1375 } 1376 return ret; 1377 } 1378 EXPORT_SYMBOL(phy_sfp_probe); 1379 1380 /** 1381 * phy_attach_direct - attach a network device to a given PHY device pointer 1382 * @dev: network device to attach 1383 * @phydev: Pointer to phy_device to attach 1384 * @flags: PHY device's dev_flags 1385 * @interface: PHY device's interface 1386 * 1387 * Description: Called by drivers to attach to a particular PHY 1388 * device. The phy_device is found, and properly hooked up 1389 * to the phy_driver. If no driver is attached, then a 1390 * generic driver is used. The phy_device is given a ptr to 1391 * the attaching device, and given a callback for link status 1392 * change. The phy_device is returned to the attaching driver. 1393 * This function takes a reference on the phy device. 1394 */ 1395 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, 1396 u32 flags, phy_interface_t interface) 1397 { 1398 struct mii_bus *bus = phydev->mdio.bus; 1399 struct device *d = &phydev->mdio.dev; 1400 struct module *ndev_owner = NULL; 1401 bool using_genphy = false; 1402 int err; 1403 1404 /* For Ethernet device drivers that register their own MDIO bus, we 1405 * will have bus->owner match ndev_mod, so we do not want to increment 1406 * our own module->refcnt here, otherwise we would not be able to 1407 * unload later on. 1408 */ 1409 if (dev) 1410 ndev_owner = dev->dev.parent->driver->owner; 1411 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) { 1412 phydev_err(phydev, "failed to get the bus module\n"); 1413 return -EIO; 1414 } 1415 1416 get_device(d); 1417 1418 /* Assume that if there is no driver, that it doesn't 1419 * exist, and we should use the genphy driver. 1420 */ 1421 if (!d->driver) { 1422 if (phydev->is_c45) 1423 d->driver = &genphy_c45_driver.mdiodrv.driver; 1424 else 1425 d->driver = &genphy_driver.mdiodrv.driver; 1426 1427 using_genphy = true; 1428 } 1429 1430 if (!try_module_get(d->driver->owner)) { 1431 phydev_err(phydev, "failed to get the device driver module\n"); 1432 err = -EIO; 1433 goto error_put_device; 1434 } 1435 1436 if (using_genphy) { 1437 err = d->driver->probe(d); 1438 if (err >= 0) 1439 err = device_bind_driver(d); 1440 1441 if (err) 1442 goto error_module_put; 1443 } 1444 1445 if (phydev->attached_dev) { 1446 dev_err(&dev->dev, "PHY already attached\n"); 1447 err = -EBUSY; 1448 goto error; 1449 } 1450 1451 phydev->phy_link_change = phy_link_change; 1452 if (dev) { 1453 phydev->attached_dev = dev; 1454 dev->phydev = phydev; 1455 1456 if (phydev->sfp_bus_attached) 1457 dev->sfp_bus = phydev->sfp_bus; 1458 else if (dev->sfp_bus) 1459 phydev->is_on_sfp_module = true; 1460 } 1461 1462 /* Some Ethernet drivers try to connect to a PHY device before 1463 * calling register_netdevice() -> netdev_register_kobject() and 1464 * does the dev->dev.kobj initialization. Here we only check for 1465 * success which indicates that the network device kobject is 1466 * ready. Once we do that we still need to keep track of whether 1467 * links were successfully set up or not for phy_detach() to 1468 * remove them accordingly. 1469 */ 1470 phydev->sysfs_links = false; 1471 1472 phy_sysfs_create_links(phydev); 1473 1474 if (!phydev->attached_dev) { 1475 err = sysfs_create_file(&phydev->mdio.dev.kobj, 1476 &dev_attr_phy_standalone.attr); 1477 if (err) 1478 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n"); 1479 } 1480 1481 phydev->dev_flags |= flags; 1482 1483 phydev->interface = interface; 1484 1485 phydev->state = PHY_READY; 1486 1487 phydev->interrupts = PHY_INTERRUPT_DISABLED; 1488 1489 /* Port is set to PORT_TP by default and the actual PHY driver will set 1490 * it to different value depending on the PHY configuration. If we have 1491 * the generic PHY driver we can't figure it out, thus set the old 1492 * legacy PORT_MII value. 1493 */ 1494 if (using_genphy) 1495 phydev->port = PORT_MII; 1496 1497 /* Initial carrier state is off as the phy is about to be 1498 * (re)initialized. 1499 */ 1500 if (dev) 1501 netif_carrier_off(phydev->attached_dev); 1502 1503 /* Do initial configuration here, now that 1504 * we have certain key parameters 1505 * (dev_flags and interface) 1506 */ 1507 err = phy_init_hw(phydev); 1508 if (err) 1509 goto error; 1510 1511 phy_resume(phydev); 1512 phy_led_triggers_register(phydev); 1513 1514 return err; 1515 1516 error: 1517 /* phy_detach() does all of the cleanup below */ 1518 phy_detach(phydev); 1519 return err; 1520 1521 error_module_put: 1522 module_put(d->driver->owner); 1523 error_put_device: 1524 put_device(d); 1525 if (ndev_owner != bus->owner) 1526 module_put(bus->owner); 1527 return err; 1528 } 1529 EXPORT_SYMBOL(phy_attach_direct); 1530 1531 /** 1532 * phy_attach - attach a network device to a particular PHY device 1533 * @dev: network device to attach 1534 * @bus_id: Bus ID of PHY device to attach 1535 * @interface: PHY device's interface 1536 * 1537 * Description: Same as phy_attach_direct() except that a PHY bus_id 1538 * string is passed instead of a pointer to a struct phy_device. 1539 */ 1540 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, 1541 phy_interface_t interface) 1542 { 1543 struct bus_type *bus = &mdio_bus_type; 1544 struct phy_device *phydev; 1545 struct device *d; 1546 int rc; 1547 1548 if (!dev) 1549 return ERR_PTR(-EINVAL); 1550 1551 /* Search the list of PHY devices on the mdio bus for the 1552 * PHY with the requested name 1553 */ 1554 d = bus_find_device_by_name(bus, NULL, bus_id); 1555 if (!d) { 1556 pr_err("PHY %s not found\n", bus_id); 1557 return ERR_PTR(-ENODEV); 1558 } 1559 phydev = to_phy_device(d); 1560 1561 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface); 1562 put_device(d); 1563 if (rc) 1564 return ERR_PTR(rc); 1565 1566 return phydev; 1567 } 1568 EXPORT_SYMBOL(phy_attach); 1569 1570 static bool phy_driver_is_genphy_kind(struct phy_device *phydev, 1571 struct device_driver *driver) 1572 { 1573 struct device *d = &phydev->mdio.dev; 1574 bool ret = false; 1575 1576 if (!phydev->drv) 1577 return ret; 1578 1579 get_device(d); 1580 ret = d->driver == driver; 1581 put_device(d); 1582 1583 return ret; 1584 } 1585 1586 bool phy_driver_is_genphy(struct phy_device *phydev) 1587 { 1588 return phy_driver_is_genphy_kind(phydev, 1589 &genphy_driver.mdiodrv.driver); 1590 } 1591 EXPORT_SYMBOL_GPL(phy_driver_is_genphy); 1592 1593 bool phy_driver_is_genphy_10g(struct phy_device *phydev) 1594 { 1595 return phy_driver_is_genphy_kind(phydev, 1596 &genphy_c45_driver.mdiodrv.driver); 1597 } 1598 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g); 1599 1600 /** 1601 * phy_package_join - join a common PHY group 1602 * @phydev: target phy_device struct 1603 * @addr: cookie and PHY address for global register access 1604 * @priv_size: if non-zero allocate this amount of bytes for private data 1605 * 1606 * This joins a PHY group and provides a shared storage for all phydevs in 1607 * this group. This is intended to be used for packages which contain 1608 * more than one PHY, for example a quad PHY transceiver. 1609 * 1610 * The addr parameter serves as a cookie which has to have the same value 1611 * for all members of one group and as a PHY address to access generic 1612 * registers of a PHY package. Usually, one of the PHY addresses of the 1613 * different PHYs in the package provides access to these global registers. 1614 * The address which is given here, will be used in the phy_package_read() 1615 * and phy_package_write() convenience functions. If your PHY doesn't have 1616 * global registers you can just pick any of the PHY addresses. 1617 * 1618 * This will set the shared pointer of the phydev to the shared storage. 1619 * If this is the first call for a this cookie the shared storage will be 1620 * allocated. If priv_size is non-zero, the given amount of bytes are 1621 * allocated for the priv member. 1622 * 1623 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join() 1624 * with the same cookie but a different priv_size is an error. 1625 */ 1626 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size) 1627 { 1628 struct mii_bus *bus = phydev->mdio.bus; 1629 struct phy_package_shared *shared; 1630 int ret; 1631 1632 if (addr < 0 || addr >= PHY_MAX_ADDR) 1633 return -EINVAL; 1634 1635 mutex_lock(&bus->shared_lock); 1636 shared = bus->shared[addr]; 1637 if (!shared) { 1638 ret = -ENOMEM; 1639 shared = kzalloc(sizeof(*shared), GFP_KERNEL); 1640 if (!shared) 1641 goto err_unlock; 1642 if (priv_size) { 1643 shared->priv = kzalloc(priv_size, GFP_KERNEL); 1644 if (!shared->priv) 1645 goto err_free; 1646 shared->priv_size = priv_size; 1647 } 1648 shared->addr = addr; 1649 refcount_set(&shared->refcnt, 1); 1650 bus->shared[addr] = shared; 1651 } else { 1652 ret = -EINVAL; 1653 if (priv_size && priv_size != shared->priv_size) 1654 goto err_unlock; 1655 refcount_inc(&shared->refcnt); 1656 } 1657 mutex_unlock(&bus->shared_lock); 1658 1659 phydev->shared = shared; 1660 1661 return 0; 1662 1663 err_free: 1664 kfree(shared); 1665 err_unlock: 1666 mutex_unlock(&bus->shared_lock); 1667 return ret; 1668 } 1669 EXPORT_SYMBOL_GPL(phy_package_join); 1670 1671 /** 1672 * phy_package_leave - leave a common PHY group 1673 * @phydev: target phy_device struct 1674 * 1675 * This leaves a PHY group created by phy_package_join(). If this phydev 1676 * was the last user of the shared data between the group, this data is 1677 * freed. Resets the phydev->shared pointer to NULL. 1678 */ 1679 void phy_package_leave(struct phy_device *phydev) 1680 { 1681 struct phy_package_shared *shared = phydev->shared; 1682 struct mii_bus *bus = phydev->mdio.bus; 1683 1684 if (!shared) 1685 return; 1686 1687 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) { 1688 bus->shared[shared->addr] = NULL; 1689 mutex_unlock(&bus->shared_lock); 1690 kfree(shared->priv); 1691 kfree(shared); 1692 } 1693 1694 phydev->shared = NULL; 1695 } 1696 EXPORT_SYMBOL_GPL(phy_package_leave); 1697 1698 static void devm_phy_package_leave(struct device *dev, void *res) 1699 { 1700 phy_package_leave(*(struct phy_device **)res); 1701 } 1702 1703 /** 1704 * devm_phy_package_join - resource managed phy_package_join() 1705 * @dev: device that is registering this PHY package 1706 * @phydev: target phy_device struct 1707 * @addr: cookie and PHY address for global register access 1708 * @priv_size: if non-zero allocate this amount of bytes for private data 1709 * 1710 * Managed phy_package_join(). Shared storage fetched by this function, 1711 * phy_package_leave() is automatically called on driver detach. See 1712 * phy_package_join() for more information. 1713 */ 1714 int devm_phy_package_join(struct device *dev, struct phy_device *phydev, 1715 int addr, size_t priv_size) 1716 { 1717 struct phy_device **ptr; 1718 int ret; 1719 1720 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr), 1721 GFP_KERNEL); 1722 if (!ptr) 1723 return -ENOMEM; 1724 1725 ret = phy_package_join(phydev, addr, priv_size); 1726 1727 if (!ret) { 1728 *ptr = phydev; 1729 devres_add(dev, ptr); 1730 } else { 1731 devres_free(ptr); 1732 } 1733 1734 return ret; 1735 } 1736 EXPORT_SYMBOL_GPL(devm_phy_package_join); 1737 1738 /** 1739 * phy_detach - detach a PHY device from its network device 1740 * @phydev: target phy_device struct 1741 * 1742 * This detaches the phy device from its network device and the phy 1743 * driver, and drops the reference count taken in phy_attach_direct(). 1744 */ 1745 void phy_detach(struct phy_device *phydev) 1746 { 1747 struct net_device *dev = phydev->attached_dev; 1748 struct module *ndev_owner = NULL; 1749 struct mii_bus *bus; 1750 1751 if (phydev->sysfs_links) { 1752 if (dev) 1753 sysfs_remove_link(&dev->dev.kobj, "phydev"); 1754 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev"); 1755 } 1756 1757 if (!phydev->attached_dev) 1758 sysfs_remove_file(&phydev->mdio.dev.kobj, 1759 &dev_attr_phy_standalone.attr); 1760 1761 phy_suspend(phydev); 1762 if (dev) { 1763 phydev->attached_dev->phydev = NULL; 1764 phydev->attached_dev = NULL; 1765 } 1766 phydev->phylink = NULL; 1767 1768 phy_led_triggers_unregister(phydev); 1769 1770 if (phydev->mdio.dev.driver) 1771 module_put(phydev->mdio.dev.driver->owner); 1772 1773 /* If the device had no specific driver before (i.e. - it 1774 * was using the generic driver), we unbind the device 1775 * from the generic driver so that there's a chance a 1776 * real driver could be loaded 1777 */ 1778 if (phy_driver_is_genphy(phydev) || 1779 phy_driver_is_genphy_10g(phydev)) 1780 device_release_driver(&phydev->mdio.dev); 1781 1782 /* Assert the reset signal */ 1783 phy_device_reset(phydev, 1); 1784 1785 /* 1786 * The phydev might go away on the put_device() below, so avoid 1787 * a use-after-free bug by reading the underlying bus first. 1788 */ 1789 bus = phydev->mdio.bus; 1790 1791 put_device(&phydev->mdio.dev); 1792 if (dev) 1793 ndev_owner = dev->dev.parent->driver->owner; 1794 if (ndev_owner != bus->owner) 1795 module_put(bus->owner); 1796 } 1797 EXPORT_SYMBOL(phy_detach); 1798 1799 int phy_suspend(struct phy_device *phydev) 1800 { 1801 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL }; 1802 struct net_device *netdev = phydev->attached_dev; 1803 struct phy_driver *phydrv = phydev->drv; 1804 int ret; 1805 1806 if (phydev->suspended) 1807 return 0; 1808 1809 /* If the device has WOL enabled, we cannot suspend the PHY */ 1810 phy_ethtool_get_wol(phydev, &wol); 1811 if (wol.wolopts || (netdev && netdev->wol_enabled)) 1812 return -EBUSY; 1813 1814 if (!phydrv || !phydrv->suspend) 1815 return 0; 1816 1817 ret = phydrv->suspend(phydev); 1818 if (!ret) 1819 phydev->suspended = true; 1820 1821 return ret; 1822 } 1823 EXPORT_SYMBOL(phy_suspend); 1824 1825 int __phy_resume(struct phy_device *phydev) 1826 { 1827 struct phy_driver *phydrv = phydev->drv; 1828 int ret; 1829 1830 lockdep_assert_held(&phydev->lock); 1831 1832 if (!phydrv || !phydrv->resume) 1833 return 0; 1834 1835 ret = phydrv->resume(phydev); 1836 if (!ret) 1837 phydev->suspended = false; 1838 1839 return ret; 1840 } 1841 EXPORT_SYMBOL(__phy_resume); 1842 1843 int phy_resume(struct phy_device *phydev) 1844 { 1845 int ret; 1846 1847 mutex_lock(&phydev->lock); 1848 ret = __phy_resume(phydev); 1849 mutex_unlock(&phydev->lock); 1850 1851 return ret; 1852 } 1853 EXPORT_SYMBOL(phy_resume); 1854 1855 int phy_loopback(struct phy_device *phydev, bool enable) 1856 { 1857 int ret = 0; 1858 1859 if (!phydev->drv) 1860 return -EIO; 1861 1862 mutex_lock(&phydev->lock); 1863 1864 if (enable && phydev->loopback_enabled) { 1865 ret = -EBUSY; 1866 goto out; 1867 } 1868 1869 if (!enable && !phydev->loopback_enabled) { 1870 ret = -EINVAL; 1871 goto out; 1872 } 1873 1874 if (phydev->drv->set_loopback) 1875 ret = phydev->drv->set_loopback(phydev, enable); 1876 else 1877 ret = genphy_loopback(phydev, enable); 1878 1879 if (ret) 1880 goto out; 1881 1882 phydev->loopback_enabled = enable; 1883 1884 out: 1885 mutex_unlock(&phydev->lock); 1886 return ret; 1887 } 1888 EXPORT_SYMBOL(phy_loopback); 1889 1890 /** 1891 * phy_reset_after_clk_enable - perform a PHY reset if needed 1892 * @phydev: target phy_device struct 1893 * 1894 * Description: Some PHYs are known to need a reset after their refclk was 1895 * enabled. This function evaluates the flags and perform the reset if it's 1896 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy 1897 * was reset. 1898 */ 1899 int phy_reset_after_clk_enable(struct phy_device *phydev) 1900 { 1901 if (!phydev || !phydev->drv) 1902 return -ENODEV; 1903 1904 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) { 1905 phy_device_reset(phydev, 1); 1906 phy_device_reset(phydev, 0); 1907 return 1; 1908 } 1909 1910 return 0; 1911 } 1912 EXPORT_SYMBOL(phy_reset_after_clk_enable); 1913 1914 /* Generic PHY support and helper functions */ 1915 1916 /** 1917 * genphy_config_advert - sanitize and advertise auto-negotiation parameters 1918 * @phydev: target phy_device struct 1919 * 1920 * Description: Writes MII_ADVERTISE with the appropriate values, 1921 * after sanitizing the values to make sure we only advertise 1922 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement 1923 * hasn't changed, and > 0 if it has changed. 1924 */ 1925 static int genphy_config_advert(struct phy_device *phydev) 1926 { 1927 int err, bmsr, changed = 0; 1928 u32 adv; 1929 1930 /* Only allow advertising what this PHY supports */ 1931 linkmode_and(phydev->advertising, phydev->advertising, 1932 phydev->supported); 1933 1934 adv = linkmode_adv_to_mii_adv_t(phydev->advertising); 1935 1936 /* Setup standard advertisement */ 1937 err = phy_modify_changed(phydev, MII_ADVERTISE, 1938 ADVERTISE_ALL | ADVERTISE_100BASE4 | 1939 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM, 1940 adv); 1941 if (err < 0) 1942 return err; 1943 if (err > 0) 1944 changed = 1; 1945 1946 bmsr = phy_read(phydev, MII_BMSR); 1947 if (bmsr < 0) 1948 return bmsr; 1949 1950 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all 1951 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a 1952 * logical 1. 1953 */ 1954 if (!(bmsr & BMSR_ESTATEN)) 1955 return changed; 1956 1957 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising); 1958 1959 err = phy_modify_changed(phydev, MII_CTRL1000, 1960 ADVERTISE_1000FULL | ADVERTISE_1000HALF, 1961 adv); 1962 if (err < 0) 1963 return err; 1964 if (err > 0) 1965 changed = 1; 1966 1967 return changed; 1968 } 1969 1970 /** 1971 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters 1972 * @phydev: target phy_device struct 1973 * 1974 * Description: Writes MII_ADVERTISE with the appropriate values, 1975 * after sanitizing the values to make sure we only advertise 1976 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement 1977 * hasn't changed, and > 0 if it has changed. This function is intended 1978 * for Clause 37 1000Base-X mode. 1979 */ 1980 static int genphy_c37_config_advert(struct phy_device *phydev) 1981 { 1982 u16 adv = 0; 1983 1984 /* Only allow advertising what this PHY supports */ 1985 linkmode_and(phydev->advertising, phydev->advertising, 1986 phydev->supported); 1987 1988 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT, 1989 phydev->advertising)) 1990 adv |= ADVERTISE_1000XFULL; 1991 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, 1992 phydev->advertising)) 1993 adv |= ADVERTISE_1000XPAUSE; 1994 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, 1995 phydev->advertising)) 1996 adv |= ADVERTISE_1000XPSE_ASYM; 1997 1998 return phy_modify_changed(phydev, MII_ADVERTISE, 1999 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE | 2000 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM, 2001 adv); 2002 } 2003 2004 /** 2005 * genphy_config_eee_advert - disable unwanted eee mode advertisement 2006 * @phydev: target phy_device struct 2007 * 2008 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy 2009 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't 2010 * changed, and 1 if it has changed. 2011 */ 2012 int genphy_config_eee_advert(struct phy_device *phydev) 2013 { 2014 int err; 2015 2016 /* Nothing to disable */ 2017 if (!phydev->eee_broken_modes) 2018 return 0; 2019 2020 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, 2021 phydev->eee_broken_modes, 0); 2022 /* If the call failed, we assume that EEE is not supported */ 2023 return err < 0 ? 0 : err; 2024 } 2025 EXPORT_SYMBOL(genphy_config_eee_advert); 2026 2027 /** 2028 * genphy_setup_forced - configures/forces speed/duplex from @phydev 2029 * @phydev: target phy_device struct 2030 * 2031 * Description: Configures MII_BMCR to force speed/duplex 2032 * to the values in phydev. Assumes that the values are valid. 2033 * Please see phy_sanitize_settings(). 2034 */ 2035 int genphy_setup_forced(struct phy_device *phydev) 2036 { 2037 u16 ctl; 2038 2039 phydev->pause = 0; 2040 phydev->asym_pause = 0; 2041 2042 ctl = mii_bmcr_encode_fixed(phydev->speed, phydev->duplex); 2043 2044 return phy_modify(phydev, MII_BMCR, 2045 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl); 2046 } 2047 EXPORT_SYMBOL(genphy_setup_forced); 2048 2049 static int genphy_setup_master_slave(struct phy_device *phydev) 2050 { 2051 u16 ctl = 0; 2052 2053 if (!phydev->is_gigabit_capable) 2054 return 0; 2055 2056 switch (phydev->master_slave_set) { 2057 case MASTER_SLAVE_CFG_MASTER_PREFERRED: 2058 ctl |= CTL1000_PREFER_MASTER; 2059 break; 2060 case MASTER_SLAVE_CFG_SLAVE_PREFERRED: 2061 break; 2062 case MASTER_SLAVE_CFG_MASTER_FORCE: 2063 ctl |= CTL1000_AS_MASTER; 2064 fallthrough; 2065 case MASTER_SLAVE_CFG_SLAVE_FORCE: 2066 ctl |= CTL1000_ENABLE_MASTER; 2067 break; 2068 case MASTER_SLAVE_CFG_UNKNOWN: 2069 case MASTER_SLAVE_CFG_UNSUPPORTED: 2070 return 0; 2071 default: 2072 phydev_warn(phydev, "Unsupported Master/Slave mode\n"); 2073 return -EOPNOTSUPP; 2074 } 2075 2076 return phy_modify_changed(phydev, MII_CTRL1000, 2077 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER | 2078 CTL1000_PREFER_MASTER), ctl); 2079 } 2080 2081 int genphy_read_master_slave(struct phy_device *phydev) 2082 { 2083 int cfg, state; 2084 int val; 2085 2086 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN; 2087 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN; 2088 2089 val = phy_read(phydev, MII_CTRL1000); 2090 if (val < 0) 2091 return val; 2092 2093 if (val & CTL1000_ENABLE_MASTER) { 2094 if (val & CTL1000_AS_MASTER) 2095 cfg = MASTER_SLAVE_CFG_MASTER_FORCE; 2096 else 2097 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE; 2098 } else { 2099 if (val & CTL1000_PREFER_MASTER) 2100 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED; 2101 else 2102 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED; 2103 } 2104 2105 val = phy_read(phydev, MII_STAT1000); 2106 if (val < 0) 2107 return val; 2108 2109 if (val & LPA_1000MSFAIL) { 2110 state = MASTER_SLAVE_STATE_ERR; 2111 } else if (phydev->link) { 2112 /* this bits are valid only for active link */ 2113 if (val & LPA_1000MSRES) 2114 state = MASTER_SLAVE_STATE_MASTER; 2115 else 2116 state = MASTER_SLAVE_STATE_SLAVE; 2117 } else { 2118 state = MASTER_SLAVE_STATE_UNKNOWN; 2119 } 2120 2121 phydev->master_slave_get = cfg; 2122 phydev->master_slave_state = state; 2123 2124 return 0; 2125 } 2126 EXPORT_SYMBOL(genphy_read_master_slave); 2127 2128 /** 2129 * genphy_restart_aneg - Enable and Restart Autonegotiation 2130 * @phydev: target phy_device struct 2131 */ 2132 int genphy_restart_aneg(struct phy_device *phydev) 2133 { 2134 /* Don't isolate the PHY if we're negotiating */ 2135 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, 2136 BMCR_ANENABLE | BMCR_ANRESTART); 2137 } 2138 EXPORT_SYMBOL(genphy_restart_aneg); 2139 2140 /** 2141 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation 2142 * @phydev: target phy_device struct 2143 * @restart: whether aneg restart is requested 2144 * 2145 * Check, and restart auto-negotiation if needed. 2146 */ 2147 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart) 2148 { 2149 int ret; 2150 2151 if (!restart) { 2152 /* Advertisement hasn't changed, but maybe aneg was never on to 2153 * begin with? Or maybe phy was isolated? 2154 */ 2155 ret = phy_read(phydev, MII_BMCR); 2156 if (ret < 0) 2157 return ret; 2158 2159 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE)) 2160 restart = true; 2161 } 2162 2163 if (restart) 2164 return genphy_restart_aneg(phydev); 2165 2166 return 0; 2167 } 2168 EXPORT_SYMBOL(genphy_check_and_restart_aneg); 2169 2170 /** 2171 * __genphy_config_aneg - restart auto-negotiation or write BMCR 2172 * @phydev: target phy_device struct 2173 * @changed: whether autoneg is requested 2174 * 2175 * Description: If auto-negotiation is enabled, we configure the 2176 * advertising, and then restart auto-negotiation. If it is not 2177 * enabled, then we write the BMCR. 2178 */ 2179 int __genphy_config_aneg(struct phy_device *phydev, bool changed) 2180 { 2181 int err; 2182 2183 if (genphy_config_eee_advert(phydev)) 2184 changed = true; 2185 2186 err = genphy_setup_master_slave(phydev); 2187 if (err < 0) 2188 return err; 2189 else if (err) 2190 changed = true; 2191 2192 if (AUTONEG_ENABLE != phydev->autoneg) 2193 return genphy_setup_forced(phydev); 2194 2195 err = genphy_config_advert(phydev); 2196 if (err < 0) /* error */ 2197 return err; 2198 else if (err) 2199 changed = true; 2200 2201 return genphy_check_and_restart_aneg(phydev, changed); 2202 } 2203 EXPORT_SYMBOL(__genphy_config_aneg); 2204 2205 /** 2206 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR 2207 * @phydev: target phy_device struct 2208 * 2209 * Description: If auto-negotiation is enabled, we configure the 2210 * advertising, and then restart auto-negotiation. If it is not 2211 * enabled, then we write the BMCR. This function is intended 2212 * for use with Clause 37 1000Base-X mode. 2213 */ 2214 int genphy_c37_config_aneg(struct phy_device *phydev) 2215 { 2216 int err, changed; 2217 2218 if (phydev->autoneg != AUTONEG_ENABLE) 2219 return genphy_setup_forced(phydev); 2220 2221 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100, 2222 BMCR_SPEED1000); 2223 if (err) 2224 return err; 2225 2226 changed = genphy_c37_config_advert(phydev); 2227 if (changed < 0) /* error */ 2228 return changed; 2229 2230 if (!changed) { 2231 /* Advertisement hasn't changed, but maybe aneg was never on to 2232 * begin with? Or maybe phy was isolated? 2233 */ 2234 int ctl = phy_read(phydev, MII_BMCR); 2235 2236 if (ctl < 0) 2237 return ctl; 2238 2239 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE)) 2240 changed = 1; /* do restart aneg */ 2241 } 2242 2243 /* Only restart aneg if we are advertising something different 2244 * than we were before. 2245 */ 2246 if (changed > 0) 2247 return genphy_restart_aneg(phydev); 2248 2249 return 0; 2250 } 2251 EXPORT_SYMBOL(genphy_c37_config_aneg); 2252 2253 /** 2254 * genphy_aneg_done - return auto-negotiation status 2255 * @phydev: target phy_device struct 2256 * 2257 * Description: Reads the status register and returns 0 either if 2258 * auto-negotiation is incomplete, or if there was an error. 2259 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done. 2260 */ 2261 int genphy_aneg_done(struct phy_device *phydev) 2262 { 2263 int retval = phy_read(phydev, MII_BMSR); 2264 2265 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE); 2266 } 2267 EXPORT_SYMBOL(genphy_aneg_done); 2268 2269 /** 2270 * genphy_update_link - update link status in @phydev 2271 * @phydev: target phy_device struct 2272 * 2273 * Description: Update the value in phydev->link to reflect the 2274 * current link value. In order to do this, we need to read 2275 * the status register twice, keeping the second value. 2276 */ 2277 int genphy_update_link(struct phy_device *phydev) 2278 { 2279 int status = 0, bmcr; 2280 2281 bmcr = phy_read(phydev, MII_BMCR); 2282 if (bmcr < 0) 2283 return bmcr; 2284 2285 /* Autoneg is being started, therefore disregard BMSR value and 2286 * report link as down. 2287 */ 2288 if (bmcr & BMCR_ANRESTART) 2289 goto done; 2290 2291 /* The link state is latched low so that momentary link 2292 * drops can be detected. Do not double-read the status 2293 * in polling mode to detect such short link drops except 2294 * the link was already down. 2295 */ 2296 if (!phy_polling_mode(phydev) || !phydev->link) { 2297 status = phy_read(phydev, MII_BMSR); 2298 if (status < 0) 2299 return status; 2300 else if (status & BMSR_LSTATUS) 2301 goto done; 2302 } 2303 2304 /* Read link and autonegotiation status */ 2305 status = phy_read(phydev, MII_BMSR); 2306 if (status < 0) 2307 return status; 2308 done: 2309 phydev->link = status & BMSR_LSTATUS ? 1 : 0; 2310 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0; 2311 2312 /* Consider the case that autoneg was started and "aneg complete" 2313 * bit has been reset, but "link up" bit not yet. 2314 */ 2315 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete) 2316 phydev->link = 0; 2317 2318 return 0; 2319 } 2320 EXPORT_SYMBOL(genphy_update_link); 2321 2322 int genphy_read_lpa(struct phy_device *phydev) 2323 { 2324 int lpa, lpagb; 2325 2326 if (phydev->autoneg == AUTONEG_ENABLE) { 2327 if (!phydev->autoneg_complete) { 2328 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising, 2329 0); 2330 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0); 2331 return 0; 2332 } 2333 2334 if (phydev->is_gigabit_capable) { 2335 lpagb = phy_read(phydev, MII_STAT1000); 2336 if (lpagb < 0) 2337 return lpagb; 2338 2339 if (lpagb & LPA_1000MSFAIL) { 2340 int adv = phy_read(phydev, MII_CTRL1000); 2341 2342 if (adv < 0) 2343 return adv; 2344 2345 if (adv & CTL1000_ENABLE_MASTER) 2346 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n"); 2347 else 2348 phydev_err(phydev, "Master/Slave resolution failed\n"); 2349 return -ENOLINK; 2350 } 2351 2352 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising, 2353 lpagb); 2354 } 2355 2356 lpa = phy_read(phydev, MII_LPA); 2357 if (lpa < 0) 2358 return lpa; 2359 2360 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa); 2361 } else { 2362 linkmode_zero(phydev->lp_advertising); 2363 } 2364 2365 return 0; 2366 } 2367 EXPORT_SYMBOL(genphy_read_lpa); 2368 2369 /** 2370 * genphy_read_status_fixed - read the link parameters for !aneg mode 2371 * @phydev: target phy_device struct 2372 * 2373 * Read the current duplex and speed state for a PHY operating with 2374 * autonegotiation disabled. 2375 */ 2376 int genphy_read_status_fixed(struct phy_device *phydev) 2377 { 2378 int bmcr = phy_read(phydev, MII_BMCR); 2379 2380 if (bmcr < 0) 2381 return bmcr; 2382 2383 if (bmcr & BMCR_FULLDPLX) 2384 phydev->duplex = DUPLEX_FULL; 2385 else 2386 phydev->duplex = DUPLEX_HALF; 2387 2388 if (bmcr & BMCR_SPEED1000) 2389 phydev->speed = SPEED_1000; 2390 else if (bmcr & BMCR_SPEED100) 2391 phydev->speed = SPEED_100; 2392 else 2393 phydev->speed = SPEED_10; 2394 2395 return 0; 2396 } 2397 EXPORT_SYMBOL(genphy_read_status_fixed); 2398 2399 /** 2400 * genphy_read_status - check the link status and update current link state 2401 * @phydev: target phy_device struct 2402 * 2403 * Description: Check the link, then figure out the current state 2404 * by comparing what we advertise with what the link partner 2405 * advertises. Start by checking the gigabit possibilities, 2406 * then move on to 10/100. 2407 */ 2408 int genphy_read_status(struct phy_device *phydev) 2409 { 2410 int err, old_link = phydev->link; 2411 2412 /* Update the link, but return if there was an error */ 2413 err = genphy_update_link(phydev); 2414 if (err) 2415 return err; 2416 2417 /* why bother the PHY if nothing can have changed */ 2418 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link) 2419 return 0; 2420 2421 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED; 2422 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED; 2423 phydev->speed = SPEED_UNKNOWN; 2424 phydev->duplex = DUPLEX_UNKNOWN; 2425 phydev->pause = 0; 2426 phydev->asym_pause = 0; 2427 2428 if (phydev->is_gigabit_capable) { 2429 err = genphy_read_master_slave(phydev); 2430 if (err < 0) 2431 return err; 2432 } 2433 2434 err = genphy_read_lpa(phydev); 2435 if (err < 0) 2436 return err; 2437 2438 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) { 2439 phy_resolve_aneg_linkmode(phydev); 2440 } else if (phydev->autoneg == AUTONEG_DISABLE) { 2441 err = genphy_read_status_fixed(phydev); 2442 if (err < 0) 2443 return err; 2444 } 2445 2446 return 0; 2447 } 2448 EXPORT_SYMBOL(genphy_read_status); 2449 2450 /** 2451 * genphy_c37_read_status - check the link status and update current link state 2452 * @phydev: target phy_device struct 2453 * 2454 * Description: Check the link, then figure out the current state 2455 * by comparing what we advertise with what the link partner 2456 * advertises. This function is for Clause 37 1000Base-X mode. 2457 */ 2458 int genphy_c37_read_status(struct phy_device *phydev) 2459 { 2460 int lpa, err, old_link = phydev->link; 2461 2462 /* Update the link, but return if there was an error */ 2463 err = genphy_update_link(phydev); 2464 if (err) 2465 return err; 2466 2467 /* why bother the PHY if nothing can have changed */ 2468 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link) 2469 return 0; 2470 2471 phydev->duplex = DUPLEX_UNKNOWN; 2472 phydev->pause = 0; 2473 phydev->asym_pause = 0; 2474 2475 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) { 2476 lpa = phy_read(phydev, MII_LPA); 2477 if (lpa < 0) 2478 return lpa; 2479 2480 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, 2481 phydev->lp_advertising, lpa & LPA_LPACK); 2482 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT, 2483 phydev->lp_advertising, lpa & LPA_1000XFULL); 2484 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, 2485 phydev->lp_advertising, lpa & LPA_1000XPAUSE); 2486 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, 2487 phydev->lp_advertising, 2488 lpa & LPA_1000XPAUSE_ASYM); 2489 2490 phy_resolve_aneg_linkmode(phydev); 2491 } else if (phydev->autoneg == AUTONEG_DISABLE) { 2492 int bmcr = phy_read(phydev, MII_BMCR); 2493 2494 if (bmcr < 0) 2495 return bmcr; 2496 2497 if (bmcr & BMCR_FULLDPLX) 2498 phydev->duplex = DUPLEX_FULL; 2499 else 2500 phydev->duplex = DUPLEX_HALF; 2501 } 2502 2503 return 0; 2504 } 2505 EXPORT_SYMBOL(genphy_c37_read_status); 2506 2507 /** 2508 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit 2509 * @phydev: target phy_device struct 2510 * 2511 * Description: Perform a software PHY reset using the standard 2512 * BMCR_RESET bit and poll for the reset bit to be cleared. 2513 * 2514 * Returns: 0 on success, < 0 on failure 2515 */ 2516 int genphy_soft_reset(struct phy_device *phydev) 2517 { 2518 u16 res = BMCR_RESET; 2519 int ret; 2520 2521 if (phydev->autoneg == AUTONEG_ENABLE) 2522 res |= BMCR_ANRESTART; 2523 2524 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res); 2525 if (ret < 0) 2526 return ret; 2527 2528 /* Clause 22 states that setting bit BMCR_RESET sets control registers 2529 * to their default value. Therefore the POWER DOWN bit is supposed to 2530 * be cleared after soft reset. 2531 */ 2532 phydev->suspended = 0; 2533 2534 ret = phy_poll_reset(phydev); 2535 if (ret) 2536 return ret; 2537 2538 /* BMCR may be reset to defaults */ 2539 if (phydev->autoneg == AUTONEG_DISABLE) 2540 ret = genphy_setup_forced(phydev); 2541 2542 return ret; 2543 } 2544 EXPORT_SYMBOL(genphy_soft_reset); 2545 2546 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev) 2547 { 2548 /* It seems there are cases where the interrupts are handled by another 2549 * entity (ie an IRQ controller embedded inside the PHY) and do not 2550 * need any other interraction from phylib. In this case, just trigger 2551 * the state machine directly. 2552 */ 2553 phy_trigger_machine(phydev); 2554 2555 return 0; 2556 } 2557 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack); 2558 2559 /** 2560 * genphy_read_abilities - read PHY abilities from Clause 22 registers 2561 * @phydev: target phy_device struct 2562 * 2563 * Description: Reads the PHY's abilities and populates 2564 * phydev->supported accordingly. 2565 * 2566 * Returns: 0 on success, < 0 on failure 2567 */ 2568 int genphy_read_abilities(struct phy_device *phydev) 2569 { 2570 int val; 2571 2572 linkmode_set_bit_array(phy_basic_ports_array, 2573 ARRAY_SIZE(phy_basic_ports_array), 2574 phydev->supported); 2575 2576 val = phy_read(phydev, MII_BMSR); 2577 if (val < 0) 2578 return val; 2579 2580 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported, 2581 val & BMSR_ANEGCAPABLE); 2582 2583 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported, 2584 val & BMSR_100FULL); 2585 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported, 2586 val & BMSR_100HALF); 2587 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported, 2588 val & BMSR_10FULL); 2589 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported, 2590 val & BMSR_10HALF); 2591 2592 if (val & BMSR_ESTATEN) { 2593 val = phy_read(phydev, MII_ESTATUS); 2594 if (val < 0) 2595 return val; 2596 2597 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, 2598 phydev->supported, val & ESTATUS_1000_TFULL); 2599 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, 2600 phydev->supported, val & ESTATUS_1000_THALF); 2601 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT, 2602 phydev->supported, val & ESTATUS_1000_XFULL); 2603 } 2604 2605 return 0; 2606 } 2607 EXPORT_SYMBOL(genphy_read_abilities); 2608 2609 /* This is used for the phy device which doesn't support the MMD extended 2610 * register access, but it does have side effect when we are trying to access 2611 * the MMD register via indirect method. 2612 */ 2613 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum) 2614 { 2615 return -EOPNOTSUPP; 2616 } 2617 EXPORT_SYMBOL(genphy_read_mmd_unsupported); 2618 2619 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum, 2620 u16 regnum, u16 val) 2621 { 2622 return -EOPNOTSUPP; 2623 } 2624 EXPORT_SYMBOL(genphy_write_mmd_unsupported); 2625 2626 int genphy_suspend(struct phy_device *phydev) 2627 { 2628 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN); 2629 } 2630 EXPORT_SYMBOL(genphy_suspend); 2631 2632 int genphy_resume(struct phy_device *phydev) 2633 { 2634 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN); 2635 } 2636 EXPORT_SYMBOL(genphy_resume); 2637 2638 int genphy_loopback(struct phy_device *phydev, bool enable) 2639 { 2640 if (enable) { 2641 u16 val, ctl = BMCR_LOOPBACK; 2642 int ret; 2643 2644 ctl |= mii_bmcr_encode_fixed(phydev->speed, phydev->duplex); 2645 2646 phy_modify(phydev, MII_BMCR, ~0, ctl); 2647 2648 ret = phy_read_poll_timeout(phydev, MII_BMSR, val, 2649 val & BMSR_LSTATUS, 2650 5000, 500000, true); 2651 if (ret) 2652 return ret; 2653 } else { 2654 phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0); 2655 2656 phy_config_aneg(phydev); 2657 } 2658 2659 return 0; 2660 } 2661 EXPORT_SYMBOL(genphy_loopback); 2662 2663 /** 2664 * phy_remove_link_mode - Remove a supported link mode 2665 * @phydev: phy_device structure to remove link mode from 2666 * @link_mode: Link mode to be removed 2667 * 2668 * Description: Some MACs don't support all link modes which the PHY 2669 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper 2670 * to remove a link mode. 2671 */ 2672 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode) 2673 { 2674 linkmode_clear_bit(link_mode, phydev->supported); 2675 phy_advertise_supported(phydev); 2676 } 2677 EXPORT_SYMBOL(phy_remove_link_mode); 2678 2679 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src) 2680 { 2681 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst, 2682 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src)); 2683 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst, 2684 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src)); 2685 } 2686 2687 /** 2688 * phy_advertise_supported - Advertise all supported modes 2689 * @phydev: target phy_device struct 2690 * 2691 * Description: Called to advertise all supported modes, doesn't touch 2692 * pause mode advertising. 2693 */ 2694 void phy_advertise_supported(struct phy_device *phydev) 2695 { 2696 __ETHTOOL_DECLARE_LINK_MODE_MASK(new); 2697 2698 linkmode_copy(new, phydev->supported); 2699 phy_copy_pause_bits(new, phydev->advertising); 2700 linkmode_copy(phydev->advertising, new); 2701 } 2702 EXPORT_SYMBOL(phy_advertise_supported); 2703 2704 /** 2705 * phy_support_sym_pause - Enable support of symmetrical pause 2706 * @phydev: target phy_device struct 2707 * 2708 * Description: Called by the MAC to indicate is supports symmetrical 2709 * Pause, but not asym pause. 2710 */ 2711 void phy_support_sym_pause(struct phy_device *phydev) 2712 { 2713 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported); 2714 phy_copy_pause_bits(phydev->advertising, phydev->supported); 2715 } 2716 EXPORT_SYMBOL(phy_support_sym_pause); 2717 2718 /** 2719 * phy_support_asym_pause - Enable support of asym pause 2720 * @phydev: target phy_device struct 2721 * 2722 * Description: Called by the MAC to indicate is supports Asym Pause. 2723 */ 2724 void phy_support_asym_pause(struct phy_device *phydev) 2725 { 2726 phy_copy_pause_bits(phydev->advertising, phydev->supported); 2727 } 2728 EXPORT_SYMBOL(phy_support_asym_pause); 2729 2730 /** 2731 * phy_set_sym_pause - Configure symmetric Pause 2732 * @phydev: target phy_device struct 2733 * @rx: Receiver Pause is supported 2734 * @tx: Transmit Pause is supported 2735 * @autoneg: Auto neg should be used 2736 * 2737 * Description: Configure advertised Pause support depending on if 2738 * receiver pause and pause auto neg is supported. Generally called 2739 * from the set_pauseparam .ndo. 2740 */ 2741 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx, 2742 bool autoneg) 2743 { 2744 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported); 2745 2746 if (rx && tx && autoneg) 2747 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, 2748 phydev->supported); 2749 2750 linkmode_copy(phydev->advertising, phydev->supported); 2751 } 2752 EXPORT_SYMBOL(phy_set_sym_pause); 2753 2754 /** 2755 * phy_set_asym_pause - Configure Pause and Asym Pause 2756 * @phydev: target phy_device struct 2757 * @rx: Receiver Pause is supported 2758 * @tx: Transmit Pause is supported 2759 * 2760 * Description: Configure advertised Pause support depending on if 2761 * transmit and receiver pause is supported. If there has been a 2762 * change in adverting, trigger a new autoneg. Generally called from 2763 * the set_pauseparam .ndo. 2764 */ 2765 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx) 2766 { 2767 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv); 2768 2769 linkmode_copy(oldadv, phydev->advertising); 2770 linkmode_set_pause(phydev->advertising, tx, rx); 2771 2772 if (!linkmode_equal(oldadv, phydev->advertising) && 2773 phydev->autoneg) 2774 phy_start_aneg(phydev); 2775 } 2776 EXPORT_SYMBOL(phy_set_asym_pause); 2777 2778 /** 2779 * phy_validate_pause - Test if the PHY/MAC support the pause configuration 2780 * @phydev: phy_device struct 2781 * @pp: requested pause configuration 2782 * 2783 * Description: Test if the PHY/MAC combination supports the Pause 2784 * configuration the user is requesting. Returns True if it is 2785 * supported, false otherwise. 2786 */ 2787 bool phy_validate_pause(struct phy_device *phydev, 2788 struct ethtool_pauseparam *pp) 2789 { 2790 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, 2791 phydev->supported) && pp->rx_pause) 2792 return false; 2793 2794 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, 2795 phydev->supported) && 2796 pp->rx_pause != pp->tx_pause) 2797 return false; 2798 2799 return true; 2800 } 2801 EXPORT_SYMBOL(phy_validate_pause); 2802 2803 /** 2804 * phy_get_pause - resolve negotiated pause modes 2805 * @phydev: phy_device struct 2806 * @tx_pause: pointer to bool to indicate whether transmit pause should be 2807 * enabled. 2808 * @rx_pause: pointer to bool to indicate whether receive pause should be 2809 * enabled. 2810 * 2811 * Resolve and return the flow control modes according to the negotiation 2812 * result. This includes checking that we are operating in full duplex mode. 2813 * See linkmode_resolve_pause() for further details. 2814 */ 2815 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause) 2816 { 2817 if (phydev->duplex != DUPLEX_FULL) { 2818 *tx_pause = false; 2819 *rx_pause = false; 2820 return; 2821 } 2822 2823 return linkmode_resolve_pause(phydev->advertising, 2824 phydev->lp_advertising, 2825 tx_pause, rx_pause); 2826 } 2827 EXPORT_SYMBOL(phy_get_pause); 2828 2829 #if IS_ENABLED(CONFIG_OF_MDIO) 2830 static int phy_get_int_delay_property(struct device *dev, const char *name) 2831 { 2832 s32 int_delay; 2833 int ret; 2834 2835 ret = device_property_read_u32(dev, name, &int_delay); 2836 if (ret) 2837 return ret; 2838 2839 return int_delay; 2840 } 2841 #else 2842 static int phy_get_int_delay_property(struct device *dev, const char *name) 2843 { 2844 return -EINVAL; 2845 } 2846 #endif 2847 2848 /** 2849 * phy_get_internal_delay - returns the index of the internal delay 2850 * @phydev: phy_device struct 2851 * @dev: pointer to the devices device struct 2852 * @delay_values: array of delays the PHY supports 2853 * @size: the size of the delay array 2854 * @is_rx: boolean to indicate to get the rx internal delay 2855 * 2856 * Returns the index within the array of internal delay passed in. 2857 * If the device property is not present then the interface type is checked 2858 * if the interface defines use of internal delay then a 1 is returned otherwise 2859 * a 0 is returned. 2860 * The array must be in ascending order. If PHY does not have an ascending order 2861 * array then size = 0 and the value of the delay property is returned. 2862 * Return -EINVAL if the delay is invalid or cannot be found. 2863 */ 2864 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev, 2865 const int *delay_values, int size, bool is_rx) 2866 { 2867 s32 delay; 2868 int i; 2869 2870 if (is_rx) { 2871 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps"); 2872 if (delay < 0 && size == 0) { 2873 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID || 2874 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID) 2875 return 1; 2876 else 2877 return 0; 2878 } 2879 2880 } else { 2881 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps"); 2882 if (delay < 0 && size == 0) { 2883 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID || 2884 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID) 2885 return 1; 2886 else 2887 return 0; 2888 } 2889 } 2890 2891 if (delay < 0) 2892 return delay; 2893 2894 if (delay && size == 0) 2895 return delay; 2896 2897 if (delay < delay_values[0] || delay > delay_values[size - 1]) { 2898 phydev_err(phydev, "Delay %d is out of range\n", delay); 2899 return -EINVAL; 2900 } 2901 2902 if (delay == delay_values[0]) 2903 return 0; 2904 2905 for (i = 1; i < size; i++) { 2906 if (delay == delay_values[i]) 2907 return i; 2908 2909 /* Find an approximate index by looking up the table */ 2910 if (delay > delay_values[i - 1] && 2911 delay < delay_values[i]) { 2912 if (delay - delay_values[i - 1] < 2913 delay_values[i] - delay) 2914 return i - 1; 2915 else 2916 return i; 2917 } 2918 } 2919 2920 phydev_err(phydev, "error finding internal delay index for %d\n", 2921 delay); 2922 2923 return -EINVAL; 2924 } 2925 EXPORT_SYMBOL(phy_get_internal_delay); 2926 2927 static bool phy_drv_supports_irq(struct phy_driver *phydrv) 2928 { 2929 return phydrv->config_intr && phydrv->handle_interrupt; 2930 } 2931 2932 /** 2933 * fwnode_mdio_find_device - Given a fwnode, find the mdio_device 2934 * @fwnode: pointer to the mdio_device's fwnode 2935 * 2936 * If successful, returns a pointer to the mdio_device with the embedded 2937 * struct device refcount incremented by one, or NULL on failure. 2938 * The caller should call put_device() on the mdio_device after its use. 2939 */ 2940 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode) 2941 { 2942 struct device *d; 2943 2944 if (!fwnode) 2945 return NULL; 2946 2947 d = bus_find_device_by_fwnode(&mdio_bus_type, fwnode); 2948 if (!d) 2949 return NULL; 2950 2951 return to_mdio_device(d); 2952 } 2953 EXPORT_SYMBOL(fwnode_mdio_find_device); 2954 2955 /** 2956 * fwnode_phy_find_device - For provided phy_fwnode, find phy_device. 2957 * 2958 * @phy_fwnode: Pointer to the phy's fwnode. 2959 * 2960 * If successful, returns a pointer to the phy_device with the embedded 2961 * struct device refcount incremented by one, or NULL on failure. 2962 */ 2963 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode) 2964 { 2965 struct mdio_device *mdiodev; 2966 2967 mdiodev = fwnode_mdio_find_device(phy_fwnode); 2968 if (!mdiodev) 2969 return NULL; 2970 2971 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY) 2972 return to_phy_device(&mdiodev->dev); 2973 2974 put_device(&mdiodev->dev); 2975 2976 return NULL; 2977 } 2978 EXPORT_SYMBOL(fwnode_phy_find_device); 2979 2980 /** 2981 * device_phy_find_device - For the given device, get the phy_device 2982 * @dev: Pointer to the given device 2983 * 2984 * Refer return conditions of fwnode_phy_find_device(). 2985 */ 2986 struct phy_device *device_phy_find_device(struct device *dev) 2987 { 2988 return fwnode_phy_find_device(dev_fwnode(dev)); 2989 } 2990 EXPORT_SYMBOL_GPL(device_phy_find_device); 2991 2992 /** 2993 * fwnode_get_phy_node - Get the phy_node using the named reference. 2994 * @fwnode: Pointer to fwnode from which phy_node has to be obtained. 2995 * 2996 * Refer return conditions of fwnode_find_reference(). 2997 * For ACPI, only "phy-handle" is supported. Legacy DT properties "phy" 2998 * and "phy-device" are not supported in ACPI. DT supports all the three 2999 * named references to the phy node. 3000 */ 3001 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode) 3002 { 3003 struct fwnode_handle *phy_node; 3004 3005 /* Only phy-handle is used for ACPI */ 3006 phy_node = fwnode_find_reference(fwnode, "phy-handle", 0); 3007 if (is_acpi_node(fwnode) || !IS_ERR(phy_node)) 3008 return phy_node; 3009 phy_node = fwnode_find_reference(fwnode, "phy", 0); 3010 if (IS_ERR(phy_node)) 3011 phy_node = fwnode_find_reference(fwnode, "phy-device", 0); 3012 return phy_node; 3013 } 3014 EXPORT_SYMBOL_GPL(fwnode_get_phy_node); 3015 3016 /** 3017 * phy_probe - probe and init a PHY device 3018 * @dev: device to probe and init 3019 * 3020 * Description: Take care of setting up the phy_device structure, 3021 * set the state to READY (the driver's init function should 3022 * set it to STARTING if needed). 3023 */ 3024 static int phy_probe(struct device *dev) 3025 { 3026 struct phy_device *phydev = to_phy_device(dev); 3027 struct device_driver *drv = phydev->mdio.dev.driver; 3028 struct phy_driver *phydrv = to_phy_driver(drv); 3029 int err = 0; 3030 3031 phydev->drv = phydrv; 3032 3033 /* Disable the interrupt if the PHY doesn't support it 3034 * but the interrupt is still a valid one 3035 */ 3036 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev)) 3037 phydev->irq = PHY_POLL; 3038 3039 if (phydrv->flags & PHY_IS_INTERNAL) 3040 phydev->is_internal = true; 3041 3042 mutex_lock(&phydev->lock); 3043 3044 /* Deassert the reset signal */ 3045 phy_device_reset(phydev, 0); 3046 3047 if (phydev->drv->probe) { 3048 err = phydev->drv->probe(phydev); 3049 if (err) 3050 goto out; 3051 } 3052 3053 /* Start out supporting everything. Eventually, 3054 * a controller will attach, and may modify one 3055 * or both of these values 3056 */ 3057 if (phydrv->features) 3058 linkmode_copy(phydev->supported, phydrv->features); 3059 else if (phydrv->get_features) 3060 err = phydrv->get_features(phydev); 3061 else if (phydev->is_c45) 3062 err = genphy_c45_pma_read_abilities(phydev); 3063 else 3064 err = genphy_read_abilities(phydev); 3065 3066 if (err) 3067 goto out; 3068 3069 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, 3070 phydev->supported)) 3071 phydev->autoneg = 0; 3072 3073 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, 3074 phydev->supported)) 3075 phydev->is_gigabit_capable = 1; 3076 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, 3077 phydev->supported)) 3078 phydev->is_gigabit_capable = 1; 3079 3080 of_set_phy_supported(phydev); 3081 phy_advertise_supported(phydev); 3082 3083 /* Get the EEE modes we want to prohibit. We will ask 3084 * the PHY stop advertising these mode later on 3085 */ 3086 of_set_phy_eee_broken(phydev); 3087 3088 /* The Pause Frame bits indicate that the PHY can support passing 3089 * pause frames. During autonegotiation, the PHYs will determine if 3090 * they should allow pause frames to pass. The MAC driver should then 3091 * use that result to determine whether to enable flow control via 3092 * pause frames. 3093 * 3094 * Normally, PHY drivers should not set the Pause bits, and instead 3095 * allow phylib to do that. However, there may be some situations 3096 * (e.g. hardware erratum) where the driver wants to set only one 3097 * of these bits. 3098 */ 3099 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) && 3100 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) { 3101 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, 3102 phydev->supported); 3103 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, 3104 phydev->supported); 3105 } 3106 3107 /* Set the state to READY by default */ 3108 phydev->state = PHY_READY; 3109 3110 out: 3111 /* Assert the reset signal */ 3112 if (err) 3113 phy_device_reset(phydev, 1); 3114 3115 mutex_unlock(&phydev->lock); 3116 3117 return err; 3118 } 3119 3120 static int phy_remove(struct device *dev) 3121 { 3122 struct phy_device *phydev = to_phy_device(dev); 3123 3124 cancel_delayed_work_sync(&phydev->state_queue); 3125 3126 mutex_lock(&phydev->lock); 3127 phydev->state = PHY_DOWN; 3128 mutex_unlock(&phydev->lock); 3129 3130 sfp_bus_del_upstream(phydev->sfp_bus); 3131 phydev->sfp_bus = NULL; 3132 3133 if (phydev->drv && phydev->drv->remove) 3134 phydev->drv->remove(phydev); 3135 3136 /* Assert the reset signal */ 3137 phy_device_reset(phydev, 1); 3138 3139 phydev->drv = NULL; 3140 3141 return 0; 3142 } 3143 3144 static void phy_shutdown(struct device *dev) 3145 { 3146 struct phy_device *phydev = to_phy_device(dev); 3147 3148 if (phydev->state == PHY_READY || !phydev->attached_dev) 3149 return; 3150 3151 phy_disable_interrupts(phydev); 3152 } 3153 3154 /** 3155 * phy_driver_register - register a phy_driver with the PHY layer 3156 * @new_driver: new phy_driver to register 3157 * @owner: module owning this PHY 3158 */ 3159 int phy_driver_register(struct phy_driver *new_driver, struct module *owner) 3160 { 3161 int retval; 3162 3163 /* Either the features are hard coded, or dynamically 3164 * determined. It cannot be both. 3165 */ 3166 if (WARN_ON(new_driver->features && new_driver->get_features)) { 3167 pr_err("%s: features and get_features must not both be set\n", 3168 new_driver->name); 3169 return -EINVAL; 3170 } 3171 3172 /* PHYLIB device drivers must not match using a DT compatible table 3173 * as this bypasses our checks that the mdiodev that is being matched 3174 * is backed by a struct phy_device. If such a case happens, we will 3175 * make out-of-bounds accesses and lockup in phydev->lock. 3176 */ 3177 if (WARN(new_driver->mdiodrv.driver.of_match_table, 3178 "%s: driver must not provide a DT match table\n", 3179 new_driver->name)) 3180 return -EINVAL; 3181 3182 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY; 3183 new_driver->mdiodrv.driver.name = new_driver->name; 3184 new_driver->mdiodrv.driver.bus = &mdio_bus_type; 3185 new_driver->mdiodrv.driver.probe = phy_probe; 3186 new_driver->mdiodrv.driver.remove = phy_remove; 3187 new_driver->mdiodrv.driver.shutdown = phy_shutdown; 3188 new_driver->mdiodrv.driver.owner = owner; 3189 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS; 3190 3191 retval = driver_register(&new_driver->mdiodrv.driver); 3192 if (retval) { 3193 pr_err("%s: Error %d in registering driver\n", 3194 new_driver->name, retval); 3195 3196 return retval; 3197 } 3198 3199 pr_debug("%s: Registered new driver\n", new_driver->name); 3200 3201 return 0; 3202 } 3203 EXPORT_SYMBOL(phy_driver_register); 3204 3205 int phy_drivers_register(struct phy_driver *new_driver, int n, 3206 struct module *owner) 3207 { 3208 int i, ret = 0; 3209 3210 for (i = 0; i < n; i++) { 3211 ret = phy_driver_register(new_driver + i, owner); 3212 if (ret) { 3213 while (i-- > 0) 3214 phy_driver_unregister(new_driver + i); 3215 break; 3216 } 3217 } 3218 return ret; 3219 } 3220 EXPORT_SYMBOL(phy_drivers_register); 3221 3222 void phy_driver_unregister(struct phy_driver *drv) 3223 { 3224 driver_unregister(&drv->mdiodrv.driver); 3225 } 3226 EXPORT_SYMBOL(phy_driver_unregister); 3227 3228 void phy_drivers_unregister(struct phy_driver *drv, int n) 3229 { 3230 int i; 3231 3232 for (i = 0; i < n; i++) 3233 phy_driver_unregister(drv + i); 3234 } 3235 EXPORT_SYMBOL(phy_drivers_unregister); 3236 3237 static struct phy_driver genphy_driver = { 3238 .phy_id = 0xffffffff, 3239 .phy_id_mask = 0xffffffff, 3240 .name = "Generic PHY", 3241 .get_features = genphy_read_abilities, 3242 .suspend = genphy_suspend, 3243 .resume = genphy_resume, 3244 .set_loopback = genphy_loopback, 3245 }; 3246 3247 static const struct ethtool_phy_ops phy_ethtool_phy_ops = { 3248 .get_sset_count = phy_ethtool_get_sset_count, 3249 .get_strings = phy_ethtool_get_strings, 3250 .get_stats = phy_ethtool_get_stats, 3251 .start_cable_test = phy_start_cable_test, 3252 .start_cable_test_tdr = phy_start_cable_test_tdr, 3253 }; 3254 3255 static int __init phy_init(void) 3256 { 3257 int rc; 3258 3259 rc = mdio_bus_init(); 3260 if (rc) 3261 return rc; 3262 3263 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops); 3264 features_init(); 3265 3266 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE); 3267 if (rc) 3268 goto err_c45; 3269 3270 rc = phy_driver_register(&genphy_driver, THIS_MODULE); 3271 if (rc) { 3272 phy_driver_unregister(&genphy_c45_driver); 3273 err_c45: 3274 mdio_bus_exit(); 3275 } 3276 3277 return rc; 3278 } 3279 3280 static void __exit phy_exit(void) 3281 { 3282 phy_driver_unregister(&genphy_c45_driver); 3283 phy_driver_unregister(&genphy_driver); 3284 mdio_bus_exit(); 3285 ethtool_set_ethtool_phy_ops(NULL); 3286 } 3287 3288 subsys_initcall(phy_init); 3289 module_exit(phy_exit); 3290