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