1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Core PHY library, taken from phy.c 4 */ 5 #include <linux/export.h> 6 #include <linux/phy.h> 7 #include <linux/of.h> 8 9 const char *phy_speed_to_str(int speed) 10 { 11 BUILD_BUG_ON_MSG(__ETHTOOL_LINK_MODE_MASK_NBITS != 69, 12 "Enum ethtool_link_mode_bit_indices and phylib are out of sync. " 13 "If a speed or mode has been added please update phy_speed_to_str " 14 "and the PHY settings array.\n"); 15 16 switch (speed) { 17 case SPEED_10: 18 return "10Mbps"; 19 case SPEED_100: 20 return "100Mbps"; 21 case SPEED_1000: 22 return "1Gbps"; 23 case SPEED_2500: 24 return "2.5Gbps"; 25 case SPEED_5000: 26 return "5Gbps"; 27 case SPEED_10000: 28 return "10Gbps"; 29 case SPEED_14000: 30 return "14Gbps"; 31 case SPEED_20000: 32 return "20Gbps"; 33 case SPEED_25000: 34 return "25Gbps"; 35 case SPEED_40000: 36 return "40Gbps"; 37 case SPEED_50000: 38 return "50Gbps"; 39 case SPEED_56000: 40 return "56Gbps"; 41 case SPEED_100000: 42 return "100Gbps"; 43 case SPEED_200000: 44 return "200Gbps"; 45 case SPEED_UNKNOWN: 46 return "Unknown"; 47 default: 48 return "Unsupported (update phy-core.c)"; 49 } 50 } 51 EXPORT_SYMBOL_GPL(phy_speed_to_str); 52 53 const char *phy_duplex_to_str(unsigned int duplex) 54 { 55 if (duplex == DUPLEX_HALF) 56 return "Half"; 57 if (duplex == DUPLEX_FULL) 58 return "Full"; 59 if (duplex == DUPLEX_UNKNOWN) 60 return "Unknown"; 61 return "Unsupported (update phy-core.c)"; 62 } 63 EXPORT_SYMBOL_GPL(phy_duplex_to_str); 64 65 /* A mapping of all SUPPORTED settings to speed/duplex. This table 66 * must be grouped by speed and sorted in descending match priority 67 * - iow, descending speed. */ 68 69 #define PHY_SETTING(s, d, b) { .speed = SPEED_ ## s, .duplex = DUPLEX_ ## d, \ 70 .bit = ETHTOOL_LINK_MODE_ ## b ## _BIT} 71 72 static const struct phy_setting settings[] = { 73 /* 200G */ 74 PHY_SETTING( 200000, FULL, 200000baseCR4_Full ), 75 PHY_SETTING( 200000, FULL, 200000baseKR4_Full ), 76 PHY_SETTING( 200000, FULL, 200000baseLR4_ER4_FR4_Full ), 77 PHY_SETTING( 200000, FULL, 200000baseDR4_Full ), 78 PHY_SETTING( 200000, FULL, 200000baseSR4_Full ), 79 /* 100G */ 80 PHY_SETTING( 100000, FULL, 100000baseCR4_Full ), 81 PHY_SETTING( 100000, FULL, 100000baseKR4_Full ), 82 PHY_SETTING( 100000, FULL, 100000baseLR4_ER4_Full ), 83 PHY_SETTING( 100000, FULL, 100000baseSR4_Full ), 84 PHY_SETTING( 100000, FULL, 100000baseCR2_Full ), 85 PHY_SETTING( 100000, FULL, 100000baseKR2_Full ), 86 PHY_SETTING( 100000, FULL, 100000baseLR2_ER2_FR2_Full ), 87 PHY_SETTING( 100000, FULL, 100000baseDR2_Full ), 88 PHY_SETTING( 100000, FULL, 100000baseSR2_Full ), 89 /* 56G */ 90 PHY_SETTING( 56000, FULL, 56000baseCR4_Full ), 91 PHY_SETTING( 56000, FULL, 56000baseKR4_Full ), 92 PHY_SETTING( 56000, FULL, 56000baseLR4_Full ), 93 PHY_SETTING( 56000, FULL, 56000baseSR4_Full ), 94 /* 50G */ 95 PHY_SETTING( 50000, FULL, 50000baseCR2_Full ), 96 PHY_SETTING( 50000, FULL, 50000baseKR2_Full ), 97 PHY_SETTING( 50000, FULL, 50000baseSR2_Full ), 98 PHY_SETTING( 50000, FULL, 50000baseCR_Full ), 99 PHY_SETTING( 50000, FULL, 50000baseKR_Full ), 100 PHY_SETTING( 50000, FULL, 50000baseLR_ER_FR_Full ), 101 PHY_SETTING( 50000, FULL, 50000baseDR_Full ), 102 PHY_SETTING( 50000, FULL, 50000baseSR_Full ), 103 /* 40G */ 104 PHY_SETTING( 40000, FULL, 40000baseCR4_Full ), 105 PHY_SETTING( 40000, FULL, 40000baseKR4_Full ), 106 PHY_SETTING( 40000, FULL, 40000baseLR4_Full ), 107 PHY_SETTING( 40000, FULL, 40000baseSR4_Full ), 108 /* 25G */ 109 PHY_SETTING( 25000, FULL, 25000baseCR_Full ), 110 PHY_SETTING( 25000, FULL, 25000baseKR_Full ), 111 PHY_SETTING( 25000, FULL, 25000baseSR_Full ), 112 /* 20G */ 113 PHY_SETTING( 20000, FULL, 20000baseKR2_Full ), 114 PHY_SETTING( 20000, FULL, 20000baseMLD2_Full ), 115 /* 10G */ 116 PHY_SETTING( 10000, FULL, 10000baseCR_Full ), 117 PHY_SETTING( 10000, FULL, 10000baseER_Full ), 118 PHY_SETTING( 10000, FULL, 10000baseKR_Full ), 119 PHY_SETTING( 10000, FULL, 10000baseKX4_Full ), 120 PHY_SETTING( 10000, FULL, 10000baseLR_Full ), 121 PHY_SETTING( 10000, FULL, 10000baseLRM_Full ), 122 PHY_SETTING( 10000, FULL, 10000baseR_FEC ), 123 PHY_SETTING( 10000, FULL, 10000baseSR_Full ), 124 PHY_SETTING( 10000, FULL, 10000baseT_Full ), 125 /* 5G */ 126 PHY_SETTING( 5000, FULL, 5000baseT_Full ), 127 /* 2.5G */ 128 PHY_SETTING( 2500, FULL, 2500baseT_Full ), 129 PHY_SETTING( 2500, FULL, 2500baseX_Full ), 130 /* 1G */ 131 PHY_SETTING( 1000, FULL, 1000baseKX_Full ), 132 PHY_SETTING( 1000, FULL, 1000baseT_Full ), 133 PHY_SETTING( 1000, HALF, 1000baseT_Half ), 134 PHY_SETTING( 1000, FULL, 1000baseT1_Full ), 135 PHY_SETTING( 1000, FULL, 1000baseX_Full ), 136 /* 100M */ 137 PHY_SETTING( 100, FULL, 100baseT_Full ), 138 PHY_SETTING( 100, FULL, 100baseT1_Full ), 139 PHY_SETTING( 100, HALF, 100baseT_Half ), 140 /* 10M */ 141 PHY_SETTING( 10, FULL, 10baseT_Full ), 142 PHY_SETTING( 10, HALF, 10baseT_Half ), 143 }; 144 #undef PHY_SETTING 145 146 /** 147 * phy_lookup_setting - lookup a PHY setting 148 * @speed: speed to match 149 * @duplex: duplex to match 150 * @mask: allowed link modes 151 * @exact: an exact match is required 152 * 153 * Search the settings array for a setting that matches the speed and 154 * duplex, and which is supported. 155 * 156 * If @exact is unset, either an exact match or %NULL for no match will 157 * be returned. 158 * 159 * If @exact is set, an exact match, the fastest supported setting at 160 * or below the specified speed, the slowest supported setting, or if 161 * they all fail, %NULL will be returned. 162 */ 163 const struct phy_setting * 164 phy_lookup_setting(int speed, int duplex, const unsigned long *mask, bool exact) 165 { 166 const struct phy_setting *p, *match = NULL, *last = NULL; 167 int i; 168 169 for (i = 0, p = settings; i < ARRAY_SIZE(settings); i++, p++) { 170 if (p->bit < __ETHTOOL_LINK_MODE_MASK_NBITS && 171 test_bit(p->bit, mask)) { 172 last = p; 173 if (p->speed == speed && p->duplex == duplex) { 174 /* Exact match for speed and duplex */ 175 match = p; 176 break; 177 } else if (!exact) { 178 if (!match && p->speed <= speed) 179 /* Candidate */ 180 match = p; 181 182 if (p->speed < speed) 183 break; 184 } 185 } 186 } 187 188 if (!match && !exact) 189 match = last; 190 191 return match; 192 } 193 EXPORT_SYMBOL_GPL(phy_lookup_setting); 194 195 size_t phy_speeds(unsigned int *speeds, size_t size, 196 unsigned long *mask) 197 { 198 size_t count; 199 int i; 200 201 for (i = 0, count = 0; i < ARRAY_SIZE(settings) && count < size; i++) 202 if (settings[i].bit < __ETHTOOL_LINK_MODE_MASK_NBITS && 203 test_bit(settings[i].bit, mask) && 204 (count == 0 || speeds[count - 1] != settings[i].speed)) 205 speeds[count++] = settings[i].speed; 206 207 return count; 208 } 209 210 static int __set_linkmode_max_speed(u32 max_speed, unsigned long *addr) 211 { 212 const struct phy_setting *p; 213 int i; 214 215 for (i = 0, p = settings; i < ARRAY_SIZE(settings); i++, p++) { 216 if (p->speed > max_speed) 217 linkmode_clear_bit(p->bit, addr); 218 else 219 break; 220 } 221 222 return 0; 223 } 224 225 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed) 226 { 227 return __set_linkmode_max_speed(max_speed, phydev->supported); 228 } 229 230 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed) 231 { 232 int err; 233 234 err = __set_phy_supported(phydev, max_speed); 235 if (err) 236 return err; 237 238 phy_advertise_supported(phydev); 239 240 return 0; 241 } 242 EXPORT_SYMBOL(phy_set_max_speed); 243 244 void of_set_phy_supported(struct phy_device *phydev) 245 { 246 struct device_node *node = phydev->mdio.dev.of_node; 247 u32 max_speed; 248 249 if (!IS_ENABLED(CONFIG_OF_MDIO)) 250 return; 251 252 if (!node) 253 return; 254 255 if (!of_property_read_u32(node, "max-speed", &max_speed)) 256 __set_phy_supported(phydev, max_speed); 257 } 258 259 void of_set_phy_eee_broken(struct phy_device *phydev) 260 { 261 struct device_node *node = phydev->mdio.dev.of_node; 262 u32 broken = 0; 263 264 if (!IS_ENABLED(CONFIG_OF_MDIO)) 265 return; 266 267 if (!node) 268 return; 269 270 if (of_property_read_bool(node, "eee-broken-100tx")) 271 broken |= MDIO_EEE_100TX; 272 if (of_property_read_bool(node, "eee-broken-1000t")) 273 broken |= MDIO_EEE_1000T; 274 if (of_property_read_bool(node, "eee-broken-10gt")) 275 broken |= MDIO_EEE_10GT; 276 if (of_property_read_bool(node, "eee-broken-1000kx")) 277 broken |= MDIO_EEE_1000KX; 278 if (of_property_read_bool(node, "eee-broken-10gkx4")) 279 broken |= MDIO_EEE_10GKX4; 280 if (of_property_read_bool(node, "eee-broken-10gkr")) 281 broken |= MDIO_EEE_10GKR; 282 283 phydev->eee_broken_modes = broken; 284 } 285 286 /** 287 * phy_resolve_aneg_linkmode - resolve the advertisements into phy settings 288 * @phydev: The phy_device struct 289 * 290 * Resolve our and the link partner advertisements into their corresponding 291 * speed and duplex. If full duplex was negotiated, extract the pause mode 292 * from the link partner mask. 293 */ 294 void phy_resolve_aneg_linkmode(struct phy_device *phydev) 295 { 296 __ETHTOOL_DECLARE_LINK_MODE_MASK(common); 297 int i; 298 299 linkmode_and(common, phydev->lp_advertising, phydev->advertising); 300 301 for (i = 0; i < ARRAY_SIZE(settings); i++) 302 if (test_bit(settings[i].bit, common)) { 303 phydev->speed = settings[i].speed; 304 phydev->duplex = settings[i].duplex; 305 break; 306 } 307 308 if (phydev->duplex == DUPLEX_FULL) { 309 phydev->pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, 310 phydev->lp_advertising); 311 phydev->asym_pause = linkmode_test_bit( 312 ETHTOOL_LINK_MODE_Asym_Pause_BIT, 313 phydev->lp_advertising); 314 } 315 } 316 EXPORT_SYMBOL_GPL(phy_resolve_aneg_linkmode); 317 318 static void mmd_phy_indirect(struct mii_bus *bus, int phy_addr, int devad, 319 u16 regnum) 320 { 321 /* Write the desired MMD Devad */ 322 __mdiobus_write(bus, phy_addr, MII_MMD_CTRL, devad); 323 324 /* Write the desired MMD register address */ 325 __mdiobus_write(bus, phy_addr, MII_MMD_DATA, regnum); 326 327 /* Select the Function : DATA with no post increment */ 328 __mdiobus_write(bus, phy_addr, MII_MMD_CTRL, 329 devad | MII_MMD_CTRL_NOINCR); 330 } 331 332 /** 333 * __phy_read_mmd - Convenience function for reading a register 334 * from an MMD on a given PHY. 335 * @phydev: The phy_device struct 336 * @devad: The MMD to read from (0..31) 337 * @regnum: The register on the MMD to read (0..65535) 338 * 339 * Same rules as for __phy_read(); 340 */ 341 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum) 342 { 343 int val; 344 345 if (regnum > (u16)~0 || devad > 32) 346 return -EINVAL; 347 348 if (phydev->drv->read_mmd) { 349 val = phydev->drv->read_mmd(phydev, devad, regnum); 350 } else if (phydev->is_c45) { 351 u32 addr = MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff); 352 353 val = __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, addr); 354 } else { 355 struct mii_bus *bus = phydev->mdio.bus; 356 int phy_addr = phydev->mdio.addr; 357 358 mmd_phy_indirect(bus, phy_addr, devad, regnum); 359 360 /* Read the content of the MMD's selected register */ 361 val = __mdiobus_read(bus, phy_addr, MII_MMD_DATA); 362 } 363 return val; 364 } 365 EXPORT_SYMBOL(__phy_read_mmd); 366 367 /** 368 * phy_read_mmd - Convenience function for reading a register 369 * from an MMD on a given PHY. 370 * @phydev: The phy_device struct 371 * @devad: The MMD to read from 372 * @regnum: The register on the MMD to read 373 * 374 * Same rules as for phy_read(); 375 */ 376 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum) 377 { 378 int ret; 379 380 mutex_lock(&phydev->mdio.bus->mdio_lock); 381 ret = __phy_read_mmd(phydev, devad, regnum); 382 mutex_unlock(&phydev->mdio.bus->mdio_lock); 383 384 return ret; 385 } 386 EXPORT_SYMBOL(phy_read_mmd); 387 388 /** 389 * __phy_write_mmd - Convenience function for writing a register 390 * on an MMD on a given PHY. 391 * @phydev: The phy_device struct 392 * @devad: The MMD to read from 393 * @regnum: The register on the MMD to read 394 * @val: value to write to @regnum 395 * 396 * Same rules as for __phy_write(); 397 */ 398 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val) 399 { 400 int ret; 401 402 if (regnum > (u16)~0 || devad > 32) 403 return -EINVAL; 404 405 if (phydev->drv->write_mmd) { 406 ret = phydev->drv->write_mmd(phydev, devad, regnum, val); 407 } else if (phydev->is_c45) { 408 u32 addr = MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff); 409 410 ret = __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, 411 addr, val); 412 } else { 413 struct mii_bus *bus = phydev->mdio.bus; 414 int phy_addr = phydev->mdio.addr; 415 416 mmd_phy_indirect(bus, phy_addr, devad, regnum); 417 418 /* Write the data into MMD's selected register */ 419 __mdiobus_write(bus, phy_addr, MII_MMD_DATA, val); 420 421 ret = 0; 422 } 423 return ret; 424 } 425 EXPORT_SYMBOL(__phy_write_mmd); 426 427 /** 428 * phy_write_mmd - Convenience function for writing a register 429 * on an MMD on a given PHY. 430 * @phydev: The phy_device struct 431 * @devad: The MMD to read from 432 * @regnum: The register on the MMD to read 433 * @val: value to write to @regnum 434 * 435 * Same rules as for phy_write(); 436 */ 437 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val) 438 { 439 int ret; 440 441 mutex_lock(&phydev->mdio.bus->mdio_lock); 442 ret = __phy_write_mmd(phydev, devad, regnum, val); 443 mutex_unlock(&phydev->mdio.bus->mdio_lock); 444 445 return ret; 446 } 447 EXPORT_SYMBOL(phy_write_mmd); 448 449 /** 450 * __phy_modify_changed() - Convenience function for modifying a PHY register 451 * @phydev: a pointer to a &struct phy_device 452 * @regnum: register number 453 * @mask: bit mask of bits to clear 454 * @set: bit mask of bits to set 455 * 456 * Unlocked helper function which allows a PHY register to be modified as 457 * new register value = (old register value & ~mask) | set 458 * 459 * Returns negative errno, 0 if there was no change, and 1 in case of change 460 */ 461 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask, 462 u16 set) 463 { 464 int new, ret; 465 466 ret = __phy_read(phydev, regnum); 467 if (ret < 0) 468 return ret; 469 470 new = (ret & ~mask) | set; 471 if (new == ret) 472 return 0; 473 474 ret = __phy_write(phydev, regnum, new); 475 476 return ret < 0 ? ret : 1; 477 } 478 EXPORT_SYMBOL_GPL(__phy_modify_changed); 479 480 /** 481 * phy_modify_changed - Function for modifying a PHY register 482 * @phydev: the phy_device struct 483 * @regnum: register number to modify 484 * @mask: bit mask of bits to clear 485 * @set: new value of bits set in mask to write to @regnum 486 * 487 * NOTE: MUST NOT be called from interrupt context, 488 * because the bus read/write functions may wait for an interrupt 489 * to conclude the operation. 490 * 491 * Returns negative errno, 0 if there was no change, and 1 in case of change 492 */ 493 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask, u16 set) 494 { 495 int ret; 496 497 mutex_lock(&phydev->mdio.bus->mdio_lock); 498 ret = __phy_modify_changed(phydev, regnum, mask, set); 499 mutex_unlock(&phydev->mdio.bus->mdio_lock); 500 501 return ret; 502 } 503 EXPORT_SYMBOL_GPL(phy_modify_changed); 504 505 /** 506 * __phy_modify - Convenience function for modifying a PHY register 507 * @phydev: the phy_device struct 508 * @regnum: register number to modify 509 * @mask: bit mask of bits to clear 510 * @set: new value of bits set in mask to write to @regnum 511 * 512 * NOTE: MUST NOT be called from interrupt context, 513 * because the bus read/write functions may wait for an interrupt 514 * to conclude the operation. 515 */ 516 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set) 517 { 518 int ret; 519 520 ret = __phy_modify_changed(phydev, regnum, mask, set); 521 522 return ret < 0 ? ret : 0; 523 } 524 EXPORT_SYMBOL_GPL(__phy_modify); 525 526 /** 527 * phy_modify - Convenience function for modifying a given PHY register 528 * @phydev: the phy_device struct 529 * @regnum: register number to write 530 * @mask: bit mask of bits to clear 531 * @set: new value of bits set in mask to write to @regnum 532 * 533 * NOTE: MUST NOT be called from interrupt context, 534 * because the bus read/write functions may wait for an interrupt 535 * to conclude the operation. 536 */ 537 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set) 538 { 539 int ret; 540 541 mutex_lock(&phydev->mdio.bus->mdio_lock); 542 ret = __phy_modify(phydev, regnum, mask, set); 543 mutex_unlock(&phydev->mdio.bus->mdio_lock); 544 545 return ret; 546 } 547 EXPORT_SYMBOL_GPL(phy_modify); 548 549 /** 550 * __phy_modify_mmd_changed - Function for modifying a register on MMD 551 * @phydev: the phy_device struct 552 * @devad: the MMD containing register to modify 553 * @regnum: register number to modify 554 * @mask: bit mask of bits to clear 555 * @set: new value of bits set in mask to write to @regnum 556 * 557 * Unlocked helper function which allows a MMD register to be modified as 558 * new register value = (old register value & ~mask) | set 559 * 560 * Returns negative errno, 0 if there was no change, and 1 in case of change 561 */ 562 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum, 563 u16 mask, u16 set) 564 { 565 int new, ret; 566 567 ret = __phy_read_mmd(phydev, devad, regnum); 568 if (ret < 0) 569 return ret; 570 571 new = (ret & ~mask) | set; 572 if (new == ret) 573 return 0; 574 575 ret = __phy_write_mmd(phydev, devad, regnum, new); 576 577 return ret < 0 ? ret : 1; 578 } 579 EXPORT_SYMBOL_GPL(__phy_modify_mmd_changed); 580 581 /** 582 * phy_modify_mmd_changed - Function for modifying a register on MMD 583 * @phydev: the phy_device struct 584 * @devad: the MMD containing register to modify 585 * @regnum: register number to modify 586 * @mask: bit mask of bits to clear 587 * @set: new value of bits set in mask to write to @regnum 588 * 589 * NOTE: MUST NOT be called from interrupt context, 590 * because the bus read/write functions may wait for an interrupt 591 * to conclude the operation. 592 * 593 * Returns negative errno, 0 if there was no change, and 1 in case of change 594 */ 595 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum, 596 u16 mask, u16 set) 597 { 598 int ret; 599 600 mutex_lock(&phydev->mdio.bus->mdio_lock); 601 ret = __phy_modify_mmd_changed(phydev, devad, regnum, mask, set); 602 mutex_unlock(&phydev->mdio.bus->mdio_lock); 603 604 return ret; 605 } 606 EXPORT_SYMBOL_GPL(phy_modify_mmd_changed); 607 608 /** 609 * __phy_modify_mmd - Convenience function for modifying a register on MMD 610 * @phydev: the phy_device struct 611 * @devad: the MMD containing register to modify 612 * @regnum: register number to modify 613 * @mask: bit mask of bits to clear 614 * @set: new value of bits set in mask to write to @regnum 615 * 616 * NOTE: MUST NOT be called from interrupt context, 617 * because the bus read/write functions may wait for an interrupt 618 * to conclude the operation. 619 */ 620 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum, 621 u16 mask, u16 set) 622 { 623 int ret; 624 625 ret = __phy_modify_mmd_changed(phydev, devad, regnum, mask, set); 626 627 return ret < 0 ? ret : 0; 628 } 629 EXPORT_SYMBOL_GPL(__phy_modify_mmd); 630 631 /** 632 * phy_modify_mmd - Convenience function for modifying a register on MMD 633 * @phydev: the phy_device struct 634 * @devad: the MMD containing register to modify 635 * @regnum: register number to modify 636 * @mask: bit mask of bits to clear 637 * @set: new value of bits set in mask to write to @regnum 638 * 639 * NOTE: MUST NOT be called from interrupt context, 640 * because the bus read/write functions may wait for an interrupt 641 * to conclude the operation. 642 */ 643 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum, 644 u16 mask, u16 set) 645 { 646 int ret; 647 648 mutex_lock(&phydev->mdio.bus->mdio_lock); 649 ret = __phy_modify_mmd(phydev, devad, regnum, mask, set); 650 mutex_unlock(&phydev->mdio.bus->mdio_lock); 651 652 return ret; 653 } 654 EXPORT_SYMBOL_GPL(phy_modify_mmd); 655 656 static int __phy_read_page(struct phy_device *phydev) 657 { 658 return phydev->drv->read_page(phydev); 659 } 660 661 static int __phy_write_page(struct phy_device *phydev, int page) 662 { 663 return phydev->drv->write_page(phydev, page); 664 } 665 666 /** 667 * phy_save_page() - take the bus lock and save the current page 668 * @phydev: a pointer to a &struct phy_device 669 * 670 * Take the MDIO bus lock, and return the current page number. On error, 671 * returns a negative errno. phy_restore_page() must always be called 672 * after this, irrespective of success or failure of this call. 673 */ 674 int phy_save_page(struct phy_device *phydev) 675 { 676 mutex_lock(&phydev->mdio.bus->mdio_lock); 677 return __phy_read_page(phydev); 678 } 679 EXPORT_SYMBOL_GPL(phy_save_page); 680 681 /** 682 * phy_select_page() - take the bus lock, save the current page, and set a page 683 * @phydev: a pointer to a &struct phy_device 684 * @page: desired page 685 * 686 * Take the MDIO bus lock to protect against concurrent access, save the 687 * current PHY page, and set the current page. On error, returns a 688 * negative errno, otherwise returns the previous page number. 689 * phy_restore_page() must always be called after this, irrespective 690 * of success or failure of this call. 691 */ 692 int phy_select_page(struct phy_device *phydev, int page) 693 { 694 int ret, oldpage; 695 696 oldpage = ret = phy_save_page(phydev); 697 if (ret < 0) 698 return ret; 699 700 if (oldpage != page) { 701 ret = __phy_write_page(phydev, page); 702 if (ret < 0) 703 return ret; 704 } 705 706 return oldpage; 707 } 708 EXPORT_SYMBOL_GPL(phy_select_page); 709 710 /** 711 * phy_restore_page() - restore the page register and release the bus lock 712 * @phydev: a pointer to a &struct phy_device 713 * @oldpage: the old page, return value from phy_save_page() or phy_select_page() 714 * @ret: operation's return code 715 * 716 * Release the MDIO bus lock, restoring @oldpage if it is a valid page. 717 * This function propagates the earliest error code from the group of 718 * operations. 719 * 720 * Returns: 721 * @oldpage if it was a negative value, otherwise 722 * @ret if it was a negative errno value, otherwise 723 * phy_write_page()'s negative value if it were in error, otherwise 724 * @ret. 725 */ 726 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret) 727 { 728 int r; 729 730 if (oldpage >= 0) { 731 r = __phy_write_page(phydev, oldpage); 732 733 /* Propagate the operation return code if the page write 734 * was successful. 735 */ 736 if (ret >= 0 && r < 0) 737 ret = r; 738 } else { 739 /* Propagate the phy page selection error code */ 740 ret = oldpage; 741 } 742 743 mutex_unlock(&phydev->mdio.bus->mdio_lock); 744 745 return ret; 746 } 747 EXPORT_SYMBOL_GPL(phy_restore_page); 748 749 /** 750 * phy_read_paged() - Convenience function for reading a paged register 751 * @phydev: a pointer to a &struct phy_device 752 * @page: the page for the phy 753 * @regnum: register number 754 * 755 * Same rules as for phy_read(). 756 */ 757 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum) 758 { 759 int ret = 0, oldpage; 760 761 oldpage = phy_select_page(phydev, page); 762 if (oldpage >= 0) 763 ret = __phy_read(phydev, regnum); 764 765 return phy_restore_page(phydev, oldpage, ret); 766 } 767 EXPORT_SYMBOL(phy_read_paged); 768 769 /** 770 * phy_write_paged() - Convenience function for writing a paged register 771 * @phydev: a pointer to a &struct phy_device 772 * @page: the page for the phy 773 * @regnum: register number 774 * @val: value to write 775 * 776 * Same rules as for phy_write(). 777 */ 778 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val) 779 { 780 int ret = 0, oldpage; 781 782 oldpage = phy_select_page(phydev, page); 783 if (oldpage >= 0) 784 ret = __phy_write(phydev, regnum, val); 785 786 return phy_restore_page(phydev, oldpage, ret); 787 } 788 EXPORT_SYMBOL(phy_write_paged); 789 790 /** 791 * phy_modify_paged_changed() - Function for modifying a paged register 792 * @phydev: a pointer to a &struct phy_device 793 * @page: the page for the phy 794 * @regnum: register number 795 * @mask: bit mask of bits to clear 796 * @set: bit mask of bits to set 797 * 798 * Returns negative errno, 0 if there was no change, and 1 in case of change 799 */ 800 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum, 801 u16 mask, u16 set) 802 { 803 int ret = 0, oldpage; 804 805 oldpage = phy_select_page(phydev, page); 806 if (oldpage >= 0) 807 ret = __phy_modify_changed(phydev, regnum, mask, set); 808 809 return phy_restore_page(phydev, oldpage, ret); 810 } 811 EXPORT_SYMBOL(phy_modify_paged_changed); 812 813 /** 814 * phy_modify_paged() - Convenience function for modifying a paged register 815 * @phydev: a pointer to a &struct phy_device 816 * @page: the page for the phy 817 * @regnum: register number 818 * @mask: bit mask of bits to clear 819 * @set: bit mask of bits to set 820 * 821 * Same rules as for phy_read() and phy_write(). 822 */ 823 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum, 824 u16 mask, u16 set) 825 { 826 int ret = phy_modify_paged_changed(phydev, page, regnum, mask, set); 827 828 return ret < 0 ? ret : 0; 829 } 830 EXPORT_SYMBOL(phy_modify_paged); 831