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