1 /* $NetBSD: makphy.c,v 1.59 2019/03/25 07:34:13 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.59 2019/03/25 07:34:13 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_END, 121 }; 122 123 #define MAKARG_PDOWN true /* Power DOWN */ 124 #define MAKARG_PUP false /* Power UP */ 125 126 static bool 127 makphy_isi210(device_t parent, struct mii_attach_args *ma) 128 { 129 130 /* I21[01]'s model number is 0 */ 131 if ((MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxMARVELL) 132 && (MII_MODEL(ma->mii_id2) == MII_MODEL_xxMARVELL_I210) 133 && (device_is_a(parent, "wm"))) 134 return true; 135 return false; 136 } 137 138 static int 139 makphymatch(device_t parent, cfdata_t match, void *aux) 140 { 141 struct mii_attach_args *ma = aux; 142 143 if (mii_phy_match(ma, makphys) != NULL) 144 return 10; 145 146 if (makphy_isi210(parent, ma)) 147 return 10; 148 149 return 0; 150 } 151 152 static void 153 makphyattach(device_t parent, device_t self, void *aux) 154 { 155 struct mii_softc *sc = device_private(self); 156 struct mii_attach_args *ma = aux; 157 struct mii_data *mii = ma->mii_data; 158 const struct mii_phydesc *mpd; 159 struct makphy_softc *maksc = (struct makphy_softc *)sc; 160 const char *name; 161 uint16_t reg, model; 162 163 mpd = mii_phy_match(ma, makphys); 164 aprint_naive(": Media interface\n"); 165 if (mpd) 166 name = mpd->mpd_name; 167 else if (makphy_isi210(parent, ma)) { 168 name = MII_STR_xxMARVELL_I210; 169 maksc->sc_flags |= MAKPHY_F_I210; 170 } else 171 panic("Unknown PHY"); 172 aprint_normal(": %s, rev. %d\n", name, MII_REV(ma->mii_id2)); 173 174 sc->mii_dev = self; 175 sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2); 176 sc->mii_mpd_model = model = MII_MODEL(ma->mii_id2); 177 sc->mii_mpd_rev = MII_REV(ma->mii_id2); 178 sc->mii_inst = mii->mii_instance; 179 sc->mii_phy = ma->mii_phyno; 180 sc->mii_funcs = &makphy_funcs; 181 sc->mii_pdata = mii; 182 sc->mii_flags = ma->mii_flags; 183 sc->mii_anegticks = MII_ANEGTICKS; 184 185 switch (model) { 186 case MII_MODEL_xxMARVELL_E1000: 187 if ((maksc->sc_flags & MAKPHY_F_I210) != 0) 188 goto page0; 189 /* FALLTHROUGH */ 190 case MII_MODEL_xxMARVELL_E1000_3: 191 case MII_MODEL_xxMARVELL_E1000S: 192 case MII_MODEL_xxMARVELL_E1000_5: 193 /* 88E1000 series has no EADR */ 194 break; 195 default: 196 page0: 197 /* Make sure page 0 is selected. */ 198 if (PHY_WRITE(sc, MAKPHY_EADR, 0) != 0) 199 aprint_verbose_dev(self, 200 "Failed to access EADR. Are you an emulator?\n"); 201 break; 202 } 203 204 switch (model) { 205 case MII_MODEL_xxMARVELL_E1011: 206 case MII_MODEL_xxMARVELL_E1112: 207 PHY_READ(sc, MAKPHY_ESSR, ®); 208 if (reg & ESSR_FIBER_LINK) 209 sc->mii_flags |= MIIF_HAVEFIBER; 210 break; 211 default: 212 break; 213 } 214 215 PHY_RESET(sc); 216 217 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities); 218 sc->mii_capabilities &= ma->mii_capmask; 219 if (sc->mii_capabilities & BMSR_EXTSTAT) 220 PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities); 221 222 aprint_normal_dev(self, ""); 223 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 && 224 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0) 225 aprint_error("no media present"); 226 else 227 mii_phy_add_media(sc); 228 aprint_normal("\n"); 229 } 230 231 static void 232 makphy_reset(struct mii_softc *sc) 233 { 234 struct makphy_softc *maksc = (struct makphy_softc *)sc; 235 uint16_t reg; 236 237 mii_phy_reset(sc); 238 239 /* 240 * Initialize PHY Specific Control Register. 241 */ 242 PHY_READ(sc, MAKPHY_PSCR, ®); 243 244 /* Assert CRS on transmit. */ 245 switch (sc->mii_mpd_model) { 246 case MII_MODEL_MARVELL_E1000_0: 247 if ((maksc->sc_flags & MAKPHY_F_I210) != 0) 248 break; 249 /* FALLTHROUGH */ 250 case MII_MODEL_MARVELL_E1000_3: 251 case MII_MODEL_MARVELL_E1000_5: 252 case MII_MODEL_MARVELL_E1000_6: 253 case MII_MODEL_xxMARVELL_E1000S: 254 case MII_MODEL_xxMARVELL_E1011: 255 case MII_MODEL_xxMARVELL_E1111: 256 reg |= PSCR_CRS_ON_TX; 257 break; 258 default: /* No PSCR_CRS_ON_TX bit */ 259 break; 260 } 261 262 /* Enable scrambler if necessary. */ 263 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) 264 reg &= ~E3016_PSCR_SCRAMBLE_DIS; 265 266 /* 267 * Store next page in the Link Partner Next Page register for 268 * compatibility with 802.3ab. 269 */ 270 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) 271 reg |= E3016_PSCR_REG8NXTPG; 272 273 PHY_WRITE(sc, MAKPHY_PSCR, reg); 274 275 /* Configure LEDs if they were left unconfigured. */ 276 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) { 277 PHY_READ(sc, 0x16, ®); 278 if (reg == 0) { 279 reg = (0x0b << 8) | (0x05 << 4) | 0x04; /* XXX */ 280 PHY_WRITE(sc, 0x16, reg); 281 } 282 } 283 284 mii_phy_reset(sc); 285 } 286 287 static void 288 makphy_pdown(struct mii_softc *sc, bool pdown) 289 { 290 uint16_t bmcr, new; 291 bool need_reset = false; 292 293 /* 294 * XXX 295 * PSCR (register 16) should be modified on some chips. 296 */ 297 298 PHY_READ(sc, MII_BMCR, &bmcr); 299 if (pdown) 300 new = bmcr | BMCR_PDOWN; 301 else 302 new = bmcr & ~BMCR_PDOWN; 303 if (bmcr != new) 304 need_reset = true; 305 306 if (need_reset) 307 new |= BMCR_RESET; 308 PHY_WRITE(sc, MII_BMCR, new); 309 } 310 311 static int 312 makphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 313 { 314 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 315 uint16_t bmcr; 316 317 if (!device_is_active(sc->mii_dev)) 318 return ENXIO; 319 320 switch (cmd) { 321 case MII_POLLSTAT: 322 /* If we're not polling our PHY instance, just return. */ 323 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 324 return 0; 325 break; 326 327 case MII_MEDIACHG: 328 /* 329 * If the media indicates a different PHY instance, 330 * isolate ourselves. 331 */ 332 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 333 PHY_READ(sc, MII_BMCR, &bmcr); 334 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO); 335 return 0; 336 } 337 338 /* If the interface is not up, don't do anything. */ 339 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 340 break; 341 342 /* Try to power up the PHY in case it's down */ 343 if (IFM_SUBTYPE(ife->ifm_media) != IFM_NONE) 344 makphy_pdown(sc, MAKARG_PUP); 345 346 mii_phy_setmedia(sc); 347 348 /* 349 * If autonegitation is not enabled, we need a 350 * software reset for the settings to take effect. 351 */ 352 if (IFM_SUBTYPE(ife->ifm_media) == IFM_NONE) 353 makphy_pdown(sc, MAKARG_PDOWN); 354 else if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) { 355 PHY_READ(sc, MII_BMCR, &bmcr); 356 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_RESET); 357 } 358 break; 359 360 case MII_TICK: 361 /* If we're not currently selected, just return. */ 362 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 363 return 0; 364 365 if (mii_phy_tick(sc) == EJUSTRETURN) 366 return 0; 367 break; 368 369 case MII_DOWN: 370 mii_phy_down(sc); 371 return 0; 372 } 373 374 /* Update the media status. */ 375 mii_phy_status(sc); 376 377 /* Callback if something changed. */ 378 mii_phy_update(sc, cmd); 379 return 0; 380 } 381 382 static void 383 makphy_status(struct mii_softc *sc) 384 { 385 struct mii_data *mii = sc->mii_pdata; 386 uint16_t bmcr, gsr, pssr; 387 388 mii->mii_media_status = IFM_AVALID; 389 mii->mii_media_active = IFM_ETHER; 390 391 PHY_READ(sc, MII_BMCR, &bmcr); 392 /* XXX FIXME: Use different page for Fiber on newer chips */ 393 PHY_READ(sc, MAKPHY_PSSR, &pssr); 394 395 if (pssr & PSSR_LINK) 396 mii->mii_media_status |= IFM_ACTIVE; 397 398 if (bmcr & BMCR_LOOP) 399 mii->mii_media_active |= IFM_LOOP; 400 401 if (bmcr & BMCR_ISO) { 402 mii->mii_media_active |= IFM_NONE; 403 mii->mii_media_status = 0; 404 return; 405 } 406 407 if ((bmcr & BMCR_AUTOEN) != 0) { 408 /* 409 * Check Speed and Duplex Resolved bit. 410 * Note that this bit is always 1 when autonego is not enabled. 411 */ 412 if (!(pssr & PSSR_RESOLVED)) { 413 /* Erg, still trying, I guess... */ 414 mii->mii_media_active |= IFM_NONE; 415 return; 416 } 417 } else { 418 if ((pssr & PSSR_LINK) == 0) { 419 mii->mii_media_active |= IFM_NONE; 420 return; 421 } 422 } 423 424 /* XXX FIXME: Use different page for Fiber on newer chips */ 425 if (sc->mii_flags & MIIF_IS_1000X) { 426 mii->mii_media_active |= IFM_1000_SX; 427 } else { 428 switch (PSSR_SPEED_get(pssr)) { 429 case SPEED_1000: 430 mii->mii_media_active |= IFM_1000_T; 431 break; 432 case SPEED_100: 433 mii->mii_media_active |= IFM_100_TX; 434 break; 435 case SPEED_10: 436 mii->mii_media_active |= IFM_10_T; 437 break; 438 default: /* Undefined (reserved) value */ 439 mii->mii_media_active |= IFM_NONE; 440 mii->mii_media_status = 0; 441 return; 442 } 443 } 444 445 if (pssr & PSSR_DUPLEX) 446 mii->mii_media_active |= mii_phy_flowstatus(sc) | IFM_FDX; 447 else 448 mii->mii_media_active |= IFM_HDX; 449 450 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) { 451 PHY_READ(sc, MII_100T2SR, &gsr); 452 if (gsr & GTSR_MS_RES) 453 mii->mii_media_active |= IFM_ETH_MASTER; 454 } 455 } 456