1 /* 2 * Copyright (c) 2001 Wind River Systems 3 * Copyright (c) 2001 4 * Bill Paul <wpaul@bsdi.com>. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Bill Paul. 17 * 4. Neither the name of the author nor the names of any co-contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 31 * THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 * $FreeBSD: src/sys/dev/mii/nsgphy.c,v 1.1.2.3 2002/11/08 21:53:49 semenu Exp $ 34 * $DragonFly: src/sys/dev/netif/mii_layer/nsgphy.c,v 1.5 2004/09/18 19:32:59 dillon Exp $ 35 * 36 * $FreeBSD: src/sys/dev/mii/nsgphy.c,v 1.1.2.3 2002/11/08 21:53:49 semenu Exp $ 37 */ 38 39 /* 40 * Driver for the National Semiconductor DP83891 and DP83861 41 * 10/100/1000 PHYs. 42 * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf 43 * 44 * The DP83891 is the older NatSemi gigE PHY which isn't being sold 45 * anymore. The DP83861 is its replacement, which is an 'enhanced' 46 * firmware driven component. The major difference between the 47 * two is that the 83891 can't generate interrupts, while the 48 * 83861 can. (I think it wasn't originally designed to do this, but 49 * it can now thanks to firmware updates.) The 83861 also allows 50 * access to its internal RAM via indirect register access. 51 */ 52 53 #include <sys/param.h> 54 #include <sys/systm.h> 55 #include <sys/kernel.h> 56 #include <sys/socket.h> 57 #include <sys/bus.h> 58 59 #include <machine/clock.h> 60 61 #include <net/if.h> 62 #include <net/if_media.h> 63 64 #include "mii.h" 65 #include "miivar.h" 66 #include "miidevs.h" 67 68 #include "nsgphyreg.h" 69 70 #include "miibus_if.h" 71 72 static int nsgphy_probe (device_t); 73 static int nsgphy_attach (device_t); 74 static int nsgphy_detach (device_t); 75 76 static device_method_t nsgphy_methods[] = { 77 /* device interface */ 78 DEVMETHOD(device_probe, nsgphy_probe), 79 DEVMETHOD(device_attach, nsgphy_attach), 80 DEVMETHOD(device_detach, nsgphy_detach), 81 DEVMETHOD(device_shutdown, bus_generic_shutdown), 82 { 0, 0 } 83 }; 84 85 static devclass_t nsgphy_devclass; 86 87 static driver_t nsgphy_driver = { 88 "nsgphy", 89 nsgphy_methods, 90 sizeof(struct mii_softc) 91 }; 92 93 DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, nsgphy_devclass, 0, 0); 94 95 int nsgphy_service (struct mii_softc *, struct mii_data *, int); 96 void nsgphy_status (struct mii_softc *); 97 98 static int nsgphy_mii_phy_auto (struct mii_softc *, int); 99 extern void mii_phy_auto_timeout (void *); 100 101 static int nsgphy_probe(dev) 102 device_t dev; 103 { 104 struct mii_attach_args *ma; 105 106 ma = device_get_ivars(dev); 107 108 if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI) { 109 if (MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83891) { 110 device_set_desc(dev, MII_STR_NATSEMI_DP83891); 111 return(0); 112 } 113 if (MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83861) { 114 device_set_desc(dev, MII_STR_NATSEMI_DP83861); 115 return(0); 116 } 117 } 118 119 return(ENXIO); 120 } 121 122 static int nsgphy_attach(dev) 123 device_t dev; 124 { 125 struct mii_softc *sc; 126 struct mii_attach_args *ma; 127 struct mii_data *mii; 128 const char *sep = ""; 129 130 sc = device_get_softc(dev); 131 ma = device_get_ivars(dev); 132 mii_softc_init(sc); 133 sc->mii_dev = device_get_parent(dev); 134 mii = device_get_softc(sc->mii_dev); 135 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 136 137 sc->mii_inst = mii->mii_instance; 138 sc->mii_phy = ma->mii_phyno; 139 sc->mii_service = nsgphy_service; 140 sc->mii_pdata = mii; 141 142 sc->mii_flags |= MIIF_NOISOLATE; 143 mii->mii_instance++; 144 145 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 146 #define PRINT(s) printf("%s%s", sep, s); sep = ", " 147 148 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst), 149 BMCR_ISO); 150 #if 0 151 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 152 BMCR_LOOP|BMCR_S100); 153 #endif 154 155 mii_phy_reset(sc); 156 157 device_printf(dev, " "); 158 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, IFM_FDX, sc->mii_inst), 159 NSGPHY_S1000|NSGPHY_BMCR_FDX); 160 PRINT("1000baseTX-FDX"); 161 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, 0, sc->mii_inst), 162 NSGPHY_S1000); 163 PRINT("1000baseTX"); 164 sc->mii_capabilities = 165 (PHY_READ(sc, MII_BMSR) | 166 (BMSR_10TFDX|BMSR_10THDX)) & ma->mii_capmask; 167 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_FDX, sc->mii_inst), 168 NSGPHY_S100|NSGPHY_BMCR_FDX); 169 PRINT("100baseTX-FDX"); 170 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, 0, sc->mii_inst), NSGPHY_S100); 171 PRINT("100baseTX"); 172 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_FDX, sc->mii_inst), 173 NSGPHY_S10|NSGPHY_BMCR_FDX); 174 PRINT("10baseT-FDX"); 175 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, 0, sc->mii_inst), NSGPHY_S10); 176 PRINT("10baseT"); 177 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0); 178 PRINT("auto"); 179 printf("\n"); 180 #undef ADD 181 #undef PRINT 182 183 MIIBUS_MEDIAINIT(sc->mii_dev); 184 return(0); 185 } 186 187 static int nsgphy_detach(dev) 188 device_t dev; 189 { 190 struct mii_softc *sc; 191 struct mii_data *mii; 192 193 sc = device_get_softc(dev); 194 mii = device_get_softc(device_get_parent(dev)); 195 if (sc->mii_flags & MIIF_DOINGAUTO) 196 callout_stop(&sc->mii_auto_ch); 197 sc->mii_dev = NULL; 198 LIST_REMOVE(sc, mii_list); 199 200 return(0); 201 } 202 int 203 nsgphy_service(sc, mii, cmd) 204 struct mii_softc *sc; 205 struct mii_data *mii; 206 int cmd; 207 { 208 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 209 int reg; 210 211 switch (cmd) { 212 case MII_POLLSTAT: 213 /* 214 * If we're not polling our PHY instance, just return. 215 */ 216 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 217 return (0); 218 break; 219 220 case MII_MEDIACHG: 221 /* 222 * If the media indicates a different PHY instance, 223 * isolate ourselves. 224 */ 225 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 226 reg = PHY_READ(sc, MII_BMCR); 227 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 228 return (0); 229 } 230 231 /* 232 * If the interface is not up, don't do anything. 233 */ 234 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 235 break; 236 237 238 switch (IFM_SUBTYPE(ife->ifm_media)) { 239 case IFM_AUTO: 240 #ifdef foo 241 /* 242 * If we're already in auto mode, just return. 243 */ 244 if (PHY_READ(sc, NSGPHY_MII_BMCR) & NSGPHY_BMCR_AUTOEN) 245 return (0); 246 #endif 247 (void) nsgphy_mii_phy_auto(sc, 0); 248 break; 249 case IFM_1000_TX: 250 if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) { 251 PHY_WRITE(sc, NSGPHY_MII_BMCR, 252 NSGPHY_BMCR_FDX|NSGPHY_BMCR_SPD1); 253 } else { 254 PHY_WRITE(sc, NSGPHY_MII_BMCR, 255 NSGPHY_BMCR_SPD1); 256 } 257 PHY_WRITE(sc, NSGPHY_MII_ANAR, NSGPHY_SEL_TYPE); 258 259 /* 260 * When setting the link manually, one side must 261 * be the master and the other the slave. However 262 * ifmedia doesn't give us a good way to specify 263 * this, so we fake it by using one of the LINK 264 * flags. If LINK0 is set, we program the PHY to 265 * be a master, otherwise it's a slave. 266 */ 267 if ((mii->mii_ifp->if_flags & IFF_LINK0)) { 268 PHY_WRITE(sc, NSGPHY_MII_1000CTL, 269 NSGPHY_1000CTL_MSE|NSGPHY_1000CTL_MSC); 270 } else { 271 PHY_WRITE(sc, NSGPHY_MII_1000CTL, 272 NSGPHY_1000CTL_MSE); 273 } 274 break; 275 case IFM_100_T4: 276 /* 277 * XXX Not supported as a manual setting right now. 278 */ 279 return (EINVAL); 280 case IFM_NONE: 281 PHY_WRITE(sc, MII_BMCR, BMCR_ISO|BMCR_PDOWN); 282 break; 283 default: 284 /* 285 * BMCR data is stored in the ifmedia entry. 286 */ 287 PHY_WRITE(sc, MII_ANAR, 288 mii_anar(ife->ifm_media)); 289 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 290 break; 291 } 292 break; 293 294 case MII_TICK: 295 /* 296 * If we're not currently selected, just return. 297 */ 298 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 299 return (0); 300 301 /* 302 * Only used for autonegotiation. 303 */ 304 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) 305 return (0); 306 307 /* 308 * Is the interface even up? 309 */ 310 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 311 return (0); 312 313 /* 314 * Only retry autonegotiation every 17 seconds. 315 * Actually, for gigE PHYs, we should wait longer, since 316 * 5 seconds is the mimimum time the documentation 317 * says to wait for a 1000mbps link to be established. 318 */ 319 if (++sc->mii_ticks != 17) 320 return (0); 321 322 sc->mii_ticks = 0; 323 324 /* 325 * Check to see if we have link. 326 */ 327 reg = PHY_READ(sc, NSGPHY_MII_PHYSUP); 328 if (reg & NSGPHY_PHYSUP_LNKSTS) 329 break; 330 331 mii_phy_reset(sc); 332 if (nsgphy_mii_phy_auto(sc, 0) == EJUSTRETURN) 333 return(0); 334 break; 335 } 336 337 /* Update the media status. */ 338 nsgphy_status(sc); 339 340 /* Callback if something changed. */ 341 if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) { 342 MIIBUS_STATCHG(sc->mii_dev); 343 sc->mii_active = mii->mii_media_active; 344 } 345 return (0); 346 } 347 348 void 349 nsgphy_status(sc) 350 struct mii_softc *sc; 351 { 352 struct mii_data *mii = sc->mii_pdata; 353 int bmsr, bmcr, physup, anlpar, gstat; 354 355 mii->mii_media_status = IFM_AVALID; 356 mii->mii_media_active = IFM_ETHER; 357 358 bmsr = PHY_READ(sc, NSGPHY_MII_BMSR); 359 physup = PHY_READ(sc, NSGPHY_MII_PHYSUP); 360 if (physup & NSGPHY_PHYSUP_LNKSTS) 361 mii->mii_media_status |= IFM_ACTIVE; 362 363 bmcr = PHY_READ(sc, NSGPHY_MII_BMCR); 364 365 if (bmcr & NSGPHY_BMCR_LOOP) 366 mii->mii_media_active |= IFM_LOOP; 367 368 if (bmcr & NSGPHY_BMCR_AUTOEN) { 369 if ((bmsr & NSGPHY_BMSR_ACOMP) == 0) { 370 /* Erg, still trying, I guess... */ 371 mii->mii_media_active |= IFM_NONE; 372 return; 373 } 374 anlpar = PHY_READ(sc, NSGPHY_MII_ANLPAR); 375 gstat = PHY_READ(sc, NSGPHY_MII_1000STS); 376 if (gstat & NSGPHY_1000STS_LPFD) 377 mii->mii_media_active |= IFM_1000_TX|IFM_FDX; 378 else if (gstat & NSGPHY_1000STS_LPHD) 379 mii->mii_media_active |= IFM_1000_TX|IFM_HDX; 380 else if (anlpar & NSGPHY_ANLPAR_100T4) 381 mii->mii_media_active |= IFM_100_T4; 382 else if (anlpar & NSGPHY_ANLPAR_100FDX) 383 mii->mii_media_active |= IFM_100_TX|IFM_FDX; 384 else if (anlpar & NSGPHY_ANLPAR_100HDX) 385 mii->mii_media_active |= IFM_100_TX; 386 else if (anlpar & NSGPHY_ANLPAR_10FDX) 387 mii->mii_media_active |= IFM_10_T|IFM_FDX; 388 else if (anlpar & NSGPHY_ANLPAR_10HDX) 389 mii->mii_media_active |= IFM_10_T|IFM_HDX; 390 else 391 mii->mii_media_active |= IFM_NONE; 392 return; 393 } 394 395 switch(bmcr & (NSGPHY_BMCR_SPD1|NSGPHY_BMCR_SPD0)) { 396 case NSGPHY_S1000: 397 mii->mii_media_active |= IFM_1000_TX; 398 break; 399 case NSGPHY_S100: 400 mii->mii_media_active |= IFM_100_TX; 401 break; 402 case NSGPHY_S10: 403 mii->mii_media_active |= IFM_10_T; 404 break; 405 default: 406 break; 407 } 408 409 if (bmcr & NSGPHY_BMCR_FDX) 410 mii->mii_media_active |= IFM_FDX; 411 else 412 mii->mii_media_active |= IFM_HDX; 413 414 return; 415 } 416 417 418 static int 419 nsgphy_mii_phy_auto(mii, waitfor) 420 struct mii_softc *mii; 421 int waitfor; 422 { 423 int bmsr, ktcr = 0, i; 424 425 if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) { 426 mii_phy_reset(mii); 427 PHY_WRITE(mii, NSGPHY_MII_BMCR, 0); 428 DELAY(1000); 429 ktcr = PHY_READ(mii, NSGPHY_MII_1000CTL); 430 PHY_WRITE(mii, NSGPHY_MII_1000CTL, ktcr | 431 (NSGPHY_1000CTL_AFD|NSGPHY_1000CTL_AHD)); 432 ktcr = PHY_READ(mii, NSGPHY_MII_1000CTL); 433 DELAY(1000); 434 PHY_WRITE(mii, NSGPHY_MII_ANAR, 435 BMSR_MEDIA_TO_ANAR(mii->mii_capabilities) | ANAR_CSMA); 436 DELAY(1000); 437 PHY_WRITE(mii, NSGPHY_MII_BMCR, 438 NSGPHY_BMCR_AUTOEN | NSGPHY_BMCR_STARTNEG); 439 } 440 441 if (waitfor) { 442 /* Wait 500ms for it to complete. */ 443 for (i = 0; i < 500; i++) { 444 if ((bmsr = PHY_READ(mii, NSGPHY_MII_BMSR)) & 445 NSGPHY_BMSR_ACOMP) 446 return (0); 447 DELAY(1000); 448 #if 0 449 if ((bmsr & BMSR_ACOMP) == 0) 450 printf("%s: autonegotiation failed to complete\n", 451 mii->mii_dev.dv_xname); 452 #endif 453 } 454 455 /* 456 * Don't need to worry about clearing MIIF_DOINGAUTO. 457 * If that's set, a timeout is pending, and it will 458 * clear the flag. 459 */ 460 return (EIO); 461 } 462 463 /* 464 * Just let it finish asynchronously. This is for the benefit of 465 * the tick handler driving autonegotiation. Don't want 500ms 466 * delays all the time while the system is running! 467 */ 468 if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) { 469 mii->mii_flags |= MIIF_DOINGAUTO; 470 callout_reset(&mii->mii_auto_ch, hz >> 1, 471 mii_phy_auto_timeout, mii); 472 } 473 return (EJUSTRETURN); 474 } 475