makphy.c revision 1.71
1 /* $NetBSD: makphy.c,v 1.71 2021/12/28 06:36:29 msaitoh Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 9 * NASA Ames Research Center. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * Copyright (c) 1997 Manuel Bouyer. All rights reserved. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 1. Redistributions of source code must retain the above copyright 40 * notice, this list of conditions and the following disclaimer. 41 * 2. Redistributions in binary form must reproduce the above copyright 42 * notice, this list of conditions and the following disclaimer in the 43 * documentation and/or other materials provided with the distribution. 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 55 */ 56 57 /* 58 * Driver for the Marvell 88E1000 ``Alaska'' 10/100/1000 PHY. 59 */ 60 61 #include <sys/cdefs.h> 62 __KERNEL_RCSID(0, "$NetBSD: makphy.c,v 1.71 2021/12/28 06:36:29 msaitoh Exp $"); 63 64 #include <sys/param.h> 65 #include <sys/systm.h> 66 #include <sys/kernel.h> 67 #include <sys/device.h> 68 #include <sys/socket.h> 69 #include <sys/errno.h> 70 71 #include <net/if.h> 72 #include <net/if_media.h> 73 74 #include <dev/mii/mii.h> 75 #include <dev/mii/miivar.h> 76 #include <dev/mii/miidevs.h> 77 78 #include <dev/mii/makphyreg.h> 79 #include <dev/mii/makphyvar.h> 80 81 static int makphymatch(device_t, cfdata_t, void *); 82 static void makphyattach(device_t, device_t, void *); 83 84 CFATTACH_DECL_NEW(makphy, sizeof(struct makphy_softc), 85 makphymatch, makphyattach, mii_phy_detach, mii_phy_activate); 86 87 static int makphy_service(struct mii_softc *, struct mii_data *, int); 88 static void makphy_status(struct mii_softc *); 89 static void makphy_reset(struct mii_softc *); 90 91 static const struct mii_phy_funcs makphy_funcs = { 92 makphy_service, makphy_status, makphy_reset, 93 }; 94 95 static const struct mii_phydesc makphys[] = { 96 MII_PHY_DESC(MARVELL, E1000_0), 97 MII_PHY_DESC(MARVELL, E1000_3), 98 MII_PHY_DESC(MARVELL, E1000_5), 99 MII_PHY_DESC(MARVELL, E1000_6), 100 MII_PHY_DESC(xxMARVELL, E1000_3), 101 MII_PHY_DESC(xxMARVELL, E1000_5), 102 MII_PHY_DESC(xxMARVELL, E1000S), 103 MII_PHY_DESC(xxMARVELL, E1011), 104 MII_PHY_DESC(xxMARVELL, E1101), 105 MII_PHY_DESC(xxMARVELL, E1111), 106 MII_PHY_DESC(xxMARVELL, E1112), 107 MII_PHY_DESC(xxMARVELL, E1116), 108 MII_PHY_DESC(xxMARVELL, E1116R), 109 MII_PHY_DESC(xxMARVELL, E1118), 110 MII_PHY_DESC(xxMARVELL, E1145), 111 MII_PHY_DESC(xxMARVELL, E1149), 112 MII_PHY_DESC(xxMARVELL, E1149R), 113 MII_PHY_DESC(xxMARVELL, E1240), 114 MII_PHY_DESC(xxMARVELL, E1318S), 115 MII_PHY_DESC(xxMARVELL, E1512), 116 MII_PHY_DESC(xxMARVELL, E1543), 117 MII_PHY_DESC(xxMARVELL, E3016), 118 MII_PHY_DESC(xxMARVELL, E3082), 119 MII_PHY_DESC(xxMARVELL, PHYG65G), 120 MII_PHY_DESC(xxMARVELL, I347), 121 MII_PHY_END, 122 }; 123 124 #define MAKARG_PDOWN true /* Power DOWN */ 125 #define MAKARG_PUP false /* Power UP */ 126 127 static bool 128 makphy_isi210(device_t parent, struct mii_attach_args *ma) 129 { 130 131 /* I21[01]'s model number is 0 */ 132 if ((MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxMARVELL) 133 && (MII_MODEL(ma->mii_id2) == MII_MODEL_xxMARVELL_I210) 134 && (device_is_a(parent, "wm"))) 135 return true; 136 return false; 137 } 138 139 static int 140 makphymatch(device_t parent, cfdata_t match, void *aux) 141 { 142 struct mii_attach_args *ma = aux; 143 144 if (mii_phy_match(ma, makphys) != NULL) 145 return 10; 146 147 if (makphy_isi210(parent, ma)) 148 return 10; 149 150 return 0; 151 } 152 153 static void 154 makphyattach(device_t parent, device_t self, void *aux) 155 { 156 struct mii_softc *sc = device_private(self); 157 struct mii_attach_args *ma = aux; 158 struct mii_data *mii = ma->mii_data; 159 const struct mii_phydesc *mpd; 160 struct makphy_softc *maksc = (struct makphy_softc *)sc; 161 const char *name; 162 uint16_t reg, model; 163 int rv; 164 165 mpd = mii_phy_match(ma, makphys); 166 aprint_naive(": Media interface\n"); 167 if (mpd) 168 name = mpd->mpd_name; 169 else if (makphy_isi210(parent, ma)) { 170 name = MII_STR_xxMARVELL_I210; 171 maksc->sc_flags |= MAKPHY_F_I210; 172 } else 173 panic("Unknown PHY"); 174 aprint_normal(": %s, rev. %d\n", name, MII_REV(ma->mii_id2)); 175 176 sc->mii_dev = self; 177 sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2); 178 sc->mii_mpd_model = model = MII_MODEL(ma->mii_id2); 179 sc->mii_mpd_rev = MII_REV(ma->mii_id2); 180 sc->mii_inst = mii->mii_instance; 181 sc->mii_phy = ma->mii_phyno; 182 sc->mii_funcs = &makphy_funcs; 183 sc->mii_pdata = mii; 184 sc->mii_flags = ma->mii_flags; 185 186 mii_lock(mii); 187 188 switch (model) { 189 case MII_MODEL_xxMARVELL_E1000: 190 if ((maksc->sc_flags & MAKPHY_F_I210) != 0) 191 goto page0; 192 /* FALLTHROUGH */ 193 case MII_MODEL_xxMARVELL_E1000_3: 194 case MII_MODEL_xxMARVELL_E1000S: 195 case MII_MODEL_xxMARVELL_E1000_5: 196 /* 88E1000 series has no EADR */ 197 break; 198 default: 199 page0: 200 /* Make sure page 0 is selected. */ 201 if (PHY_WRITE(sc, MAKPHY_EADR, 0) != 0) 202 aprint_verbose_dev(self, 203 "Failed to access EADR. Are you an emulator?\n"); 204 break; 205 } 206 207 PHY_RESET(sc); 208 209 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities); 210 sc->mii_capabilities &= ma->mii_capmask; 211 if (sc->mii_capabilities & BMSR_EXTSTAT) { 212 rv = PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities); 213 if (rv != 0) { 214 aprint_verbose_dev(self, "Failed to read EXTSR. " 215 "Are you an emulator?. " 216 "Regard as 1000BASE-T.\n"); 217 sc->mii_extcapabilities 218 |= EXTSR_1000TFDX | EXTSR_1000THDX; 219 } 220 } 221 222 if (((sc->mii_extcapabilities & (EXTSR_1000TFDX | EXTSR_1000THDX)) 223 != 0) 224 && ((sc->mii_extcapabilities & (EXTSR_1000XFDX | EXTSR_1000XHDX)) 225 != 0)) { 226 bool fiberonly = false, copperonly = false; 227 228 /* Both copper and fiber are set. check MODE[] */ 229 switch (sc->mii_mpd_model) { 230 case MII_MODEL_xxMARVELL_E1011: 231 case MII_MODEL_xxMARVELL_E1111: 232 /* These devices have ESSR register */ 233 rv = PHY_READ(sc, MAKPHY_ESSR, ®); 234 if (rv != 0) { 235 /* 236 * XXX Emulator (e.g qemu) may not implement 237 * the ESSR register. If so, regard as copper 238 * media. 239 */ 240 copperonly = true; 241 aprint_verbose_dev(self, "Failed to access " 242 "ESSR. Are you an emulator? Regard as " 243 "copper only media.\n"); 244 } else if ((reg & ESSR_AUTOSEL_DISABLE) != 0) { 245 switch (reg & ESSR_HWCFG_MODE) { 246 case ESSR_RTBI_FIBER: 247 case ESSR_RGMII_FIBER: 248 case ESSR_RGMII_SGMII: /* right? */ 249 case ESSR_TBI_FIBER: 250 case ESSR_GMII_FIBER: 251 fiberonly = true; 252 break; 253 case ESSR_SGMII_WC_COPPER: 254 case ESSR_SGMII_WOC_COPPER: 255 case ESSR_RTBI_COPPER: 256 case ESSR_RGMII_COPPER: 257 case ESSR_GMII_COPPER: 258 copperonly = true; 259 default: 260 break; 261 } 262 } else 263 maksc->sc_flags |= MAKPHY_F_FICO_AUTOSEL; 264 break; 265 default: 266 break; 267 } 268 if (fiberonly || copperonly) 269 aprint_debug_dev(self, "both copper and fiber are set " 270 "but MODE[] is %s only.\n", 271 fiberonly ? "fiber" : "copper"); 272 if (fiberonly) 273 sc->mii_extcapabilities 274 &= ~(EXTSR_1000TFDX | EXTSR_1000THDX); 275 else if (copperonly) { 276 sc->mii_extcapabilities 277 &= ~(EXTSR_1000XFDX | EXTSR_1000XHDX); 278 sc->mii_flags &= ~MIIF_IS_1000X; 279 } 280 } 281 mii_unlock(mii); 282 mii_phy_add_media(sc); 283 } 284 285 static void 286 makphy_reset(struct mii_softc *sc) 287 { 288 struct makphy_softc *maksc = (struct makphy_softc *)sc; 289 uint16_t reg; 290 291 KASSERT(mii_locked(sc->mii_pdata)); 292 293 mii_phy_reset(sc); 294 295 /* Initialize PHY Specific Control Register. */ 296 PHY_READ(sc, MAKPHY_PSCR, ®); 297 298 /* Assert CRS on transmit. */ 299 switch (sc->mii_mpd_model) { 300 case MII_MODEL_MARVELL_E1000_0: 301 if ((maksc->sc_flags & MAKPHY_F_I210) != 0) 302 break; 303 /* FALLTHROUGH */ 304 case MII_MODEL_MARVELL_E1000_3: 305 case MII_MODEL_MARVELL_E1000_5: 306 case MII_MODEL_MARVELL_E1000_6: 307 case MII_MODEL_xxMARVELL_E1000S: 308 case MII_MODEL_xxMARVELL_E1011: 309 case MII_MODEL_xxMARVELL_E1111: 310 reg |= PSCR_CRS_ON_TX; 311 break; 312 default: /* No PSCR_CRS_ON_TX bit */ 313 break; 314 } 315 316 /* Enable scrambler if necessary. */ 317 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) 318 reg &= ~E3016_PSCR_SCRAMBLE_DIS; 319 320 /* 321 * Store next page in the Link Partner Next Page register for 322 * compatibility with 802.3ab. 323 */ 324 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) 325 reg |= E3016_PSCR_REG8NXTPG; 326 327 PHY_WRITE(sc, MAKPHY_PSCR, reg); 328 329 /* Configure LEDs if they were left unconfigured. */ 330 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) { 331 PHY_READ(sc, 0x16, ®); 332 if (reg == 0) { 333 reg = (0x0b << 8) | (0x05 << 4) | 0x04; /* XXX */ 334 PHY_WRITE(sc, 0x16, reg); 335 } 336 } 337 338 mii_phy_reset(sc); 339 } 340 341 static void 342 makphy_pdown(struct mii_softc *sc, bool pdown) 343 { 344 uint16_t bmcr, new; 345 bool need_reset = false; 346 347 /* 348 * XXX 349 * PSCR (register 16) should be modified on some chips. 350 */ 351 352 PHY_READ(sc, MII_BMCR, &bmcr); 353 if (pdown) 354 new = bmcr | BMCR_PDOWN; 355 else 356 new = bmcr & ~BMCR_PDOWN; 357 if (bmcr != new) 358 need_reset = true; 359 360 if (need_reset) 361 new |= BMCR_RESET; 362 PHY_WRITE(sc, MII_BMCR, new); 363 } 364 365 static int 366 makphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 367 { 368 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 369 uint16_t bmcr; 370 371 if (!device_is_active(sc->mii_dev)) 372 return ENXIO; 373 374 KASSERT(mii_locked(mii)); 375 376 switch (cmd) { 377 case MII_POLLSTAT: 378 /* If we're not polling our PHY instance, just return. */ 379 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 380 return 0; 381 break; 382 383 case MII_MEDIACHG: 384 /* 385 * If the media indicates a different PHY instance, 386 * isolate ourselves. 387 */ 388 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 389 PHY_READ(sc, MII_BMCR, &bmcr); 390 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO); 391 return 0; 392 } 393 394 /* If the interface is not up, don't do anything. */ 395 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 396 break; 397 398 /* Try to power up the PHY in case it's down */ 399 if (IFM_SUBTYPE(ife->ifm_media) != IFM_NONE) 400 makphy_pdown(sc, MAKARG_PUP); 401 402 mii_phy_setmedia(sc); 403 404 /* 405 * If autonegitation is not enabled, we need a 406 * software reset for the settings to take effect. 407 */ 408 if (IFM_SUBTYPE(ife->ifm_media) == IFM_NONE) 409 makphy_pdown(sc, MAKARG_PDOWN); 410 else if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) { 411 PHY_READ(sc, MII_BMCR, &bmcr); 412 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_RESET); 413 } 414 break; 415 416 case MII_TICK: 417 /* If we're not currently selected, just return. */ 418 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 419 return 0; 420 421 if (mii_phy_tick(sc) == EJUSTRETURN) 422 return 0; 423 break; 424 425 case MII_DOWN: 426 mii_phy_down(sc); 427 return 0; 428 } 429 430 /* Update the media status. */ 431 mii_phy_status(sc); 432 433 /* Callback if something changed. */ 434 mii_phy_update(sc, cmd); 435 return 0; 436 } 437 438 static void 439 makphy_status(struct mii_softc *sc) 440 { 441 struct mii_data *mii = sc->mii_pdata; 442 uint16_t bmcr, gsr, pssr, essr; 443 444 KASSERT(mii_locked(mii)); 445 446 mii->mii_media_status = IFM_AVALID; 447 mii->mii_media_active = IFM_ETHER; 448 449 PHY_READ(sc, MII_BMCR, &bmcr); 450 /* XXX FIXME: Use different page for Fiber on newer chips */ 451 PHY_READ(sc, MAKPHY_PSSR, &pssr); 452 453 if (pssr & MAKPHY_PSSR_LINK) 454 mii->mii_media_status |= IFM_ACTIVE; 455 456 if (bmcr & BMCR_LOOP) 457 mii->mii_media_active |= IFM_LOOP; 458 459 if (bmcr & (BMCR_ISO | BMCR_PDOWN)) { 460 mii->mii_media_active |= IFM_NONE; 461 return; 462 } 463 464 if ((bmcr & BMCR_AUTOEN) != 0) { 465 /* 466 * Check Speed and Duplex Resolved bit. 467 * Note that this bit is always 1 when autonego is not enabled. 468 */ 469 if (!(pssr & MAKPHY_PSSR_RESOLVED)) { 470 /* Erg, still trying, I guess... */ 471 mii->mii_media_active |= IFM_NONE; 472 return; 473 } 474 } else { 475 if ((pssr & MAKPHY_PSSR_LINK) == 0) { 476 mii->mii_media_active |= IFM_NONE; 477 return; 478 } 479 } 480 481 /* 482 * XXX The following code support Fiber/Copper auto select mode 483 * only for 88E1011, 88E1111 and 88E1112. For other chips, the document 484 * is required. 485 */ 486 if (sc->mii_flags & MIIF_IS_1000X) { 487 /* Not in Fiber/Copper auto select mode */ 488 mii->mii_media_active |= IFM_1000_SX; 489 } else if ((sc->mii_mpd_model == MII_MODEL_xxMARVELL_E1011) || 490 (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E1111)) { 491 struct makphy_softc *maksc = (struct makphy_softc *)sc; 492 493 if ((maksc->sc_flags & MAKPHY_F_FICO_AUTOSEL) != 0) { 494 /* Fiber/Copper auto select mode */ 495 PHY_READ(sc, MAKPHY_ESSR, &essr); 496 if ((essr & ESSR_FIBER_LINK) == 0) 497 goto copper; 498 else { 499 /* Regard as 1000BASE-SX */ 500 mii->mii_media_active |= IFM_1000_SX; 501 } 502 } else 503 goto copper; 504 } else if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E1112) { 505 /* Fiber/Copper auto select mode */ 506 507 PHY_READ(sc, MAKPHY_PSSR, &pssr); 508 if ((pssr & MAKPHY_PSSR_RESOLUTION_FIBER) == 0) 509 goto copper; 510 511 switch (MAKPHY_PSSR_SPEED_get(pssr)) { 512 case SPEED_1000: 513 mii->mii_media_active |= IFM_1000_SX; 514 break; 515 case SPEED_100: 516 mii->mii_media_active |= IFM_100_FX; 517 break; 518 default: /* Undefined (reserved) value */ 519 mii->mii_media_active |= IFM_NONE; 520 mii->mii_media_status = 0; 521 return; 522 } 523 } else { 524 copper: 525 switch (MAKPHY_PSSR_SPEED_get(pssr)) { 526 case SPEED_1000: 527 mii->mii_media_active |= IFM_1000_T; 528 break; 529 case SPEED_100: 530 mii->mii_media_active |= IFM_100_TX; 531 break; 532 case SPEED_10: 533 mii->mii_media_active |= IFM_10_T; 534 break; 535 default: /* Undefined (reserved) value */ 536 mii->mii_media_active |= IFM_NONE; 537 mii->mii_media_status = 0; 538 return; 539 } 540 } 541 542 if (pssr & MAKPHY_PSSR_DUPLEX) 543 mii->mii_media_active |= mii_phy_flowstatus(sc) | IFM_FDX; 544 else 545 mii->mii_media_active |= IFM_HDX; 546 547 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) { 548 PHY_READ(sc, MII_100T2SR, &gsr); 549 if (gsr & GTSR_MS_RES) 550 mii->mii_media_active |= IFM_ETH_MASTER; 551 } 552 } 553
Indexes created Thu Sep 25 16:09:42 GMT 2025