1 /* $NetBSD: tlphy.c,v 1.18 1999/05/14 11:40:28 drochner Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999 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 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 * 39 * $FreeBSD: src/sys/dev/mii/tlphy.c,v 1.2.2.2 2001/07/29 22:48:37 kris Exp $ 40 * $DragonFly: src/sys/dev/netif/mii_layer/tlphy.c,v 1.10 2006/09/05 00:55:40 dillon Exp $ 41 */ 42 43 /* 44 * Copyright (c) 1997 Manuel Bouyer. All rights reserved. 45 * 46 * Redistribution and use in source and binary forms, with or without 47 * modification, are permitted provided that the following conditions 48 * are met: 49 * 1. Redistributions of source code must retain the above copyright 50 * notice, this list of conditions and the following disclaimer. 51 * 2. Redistributions in binary form must reproduce the above copyright 52 * notice, this list of conditions and the following disclaimer in the 53 * documentation and/or other materials provided with the distribution. 54 * 3. All advertising materials mentioning features or use of this software 55 * must display the following acknowledgement: 56 * This product includes software developed by Manuel Bouyer. 57 * 4. The name of the author may not be used to endorse or promote products 58 * derived from this software without specific prior written permission. 59 * 60 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 61 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 62 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 63 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 64 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 65 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 66 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 67 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 68 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 69 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 70 */ 71 72 /* 73 * Driver for Texas Instruments's ThunderLAN PHYs 74 */ 75 76 #include <sys/param.h> 77 #include <sys/systm.h> 78 #include <sys/kernel.h> 79 #include <sys/socket.h> 80 #include <sys/errno.h> 81 #include <sys/module.h> 82 #include <sys/bus.h> 83 #include <sys/malloc.h> 84 85 #include <machine/bus.h> 86 #include <machine/clock.h> 87 88 #include <net/if.h> 89 #include <net/if_media.h> 90 91 #include "mii.h" 92 #include "miivar.h" 93 #include "miidevs.h" 94 95 #include "tlphyreg.h" 96 97 #include "miibus_if.h" 98 99 struct tlphy_softc { 100 struct mii_softc sc_mii; /* generic PHY */ 101 int sc_need_acomp; 102 }; 103 104 static int tlphy_probe (device_t); 105 static int tlphy_attach (device_t); 106 107 static device_method_t tlphy_methods[] = { 108 /* device interface */ 109 DEVMETHOD(device_probe, tlphy_probe), 110 DEVMETHOD(device_attach, tlphy_attach), 111 DEVMETHOD(device_detach, ukphy_detach), 112 DEVMETHOD(device_shutdown, bus_generic_shutdown), 113 { 0, 0 } 114 }; 115 116 static const struct mii_phydesc tlphys[] = { 117 MII_PHYDESC(xxTI, TLAN10T), 118 MII_PHYDESC_NULL 119 }; 120 121 static devclass_t tlphy_devclass; 122 123 static driver_t tlphy_driver = { 124 "tlphy", 125 tlphy_methods, 126 sizeof(struct tlphy_softc) 127 }; 128 129 DRIVER_MODULE(tlphy, miibus, tlphy_driver, tlphy_devclass, 0, 0); 130 131 static int tlphy_service(struct mii_softc *, struct mii_data *, int); 132 static int tlphy_auto(struct tlphy_softc *, int); 133 static void tlphy_acomp(struct tlphy_softc *); 134 static void tlphy_status(struct tlphy_softc *); 135 136 static int 137 tlphy_probe(device_t dev) 138 { 139 struct mii_attach_args *ma = device_get_ivars(dev); 140 const struct mii_phydesc *mpd; 141 142 mpd = mii_phy_match(ma, tlphys); 143 if (mpd != NULL) { 144 device_set_desc(dev, mpd->mpd_name); 145 return (0); 146 } 147 return (ENXIO); 148 } 149 150 static int 151 tlphy_attach(device_t dev) 152 { 153 struct tlphy_softc *sc; 154 struct mii_attach_args *ma; 155 struct mii_data *mii; 156 const char *sep = ""; 157 int capmask = 0xFFFFFFFF; 158 159 sc = device_get_softc(dev); 160 ma = device_get_ivars(dev); 161 mii_softc_init(&sc->sc_mii, ma); 162 sc->sc_mii.mii_dev = device_get_parent(dev); 163 mii = device_get_softc(sc->sc_mii.mii_dev); 164 LIST_INSERT_HEAD(&mii->mii_phys, &sc->sc_mii, mii_list); 165 166 sc->sc_mii.mii_inst = mii->mii_instance; 167 sc->sc_mii.mii_service = tlphy_service; 168 sc->sc_mii.mii_reset = mii_phy_reset; 169 sc->sc_mii.mii_pdata = mii; 170 171 if (mii->mii_instance) { 172 struct mii_softc *other; 173 device_t *devlist; 174 int devs, i; 175 176 device_get_children(sc->sc_mii.mii_dev, &devlist, &devs); 177 for (i = 0; i < devs; i++) { 178 if (strcmp(device_get_name(devlist[i]), "tlphy")) { 179 other = device_get_softc(devlist[i]); 180 capmask &= ~other->mii_capabilities; 181 break; 182 } 183 } 184 kfree(devlist, M_TEMP); 185 } 186 187 mii->mii_instance++; 188 189 sc->sc_mii.mii_flags &= ~MIIF_NOISOLATE; 190 mii_phy_reset(&sc->sc_mii); 191 sc->sc_mii.mii_flags |= MIIF_NOISOLATE; 192 193 /* 194 * Note that if we're on a device that also supports 100baseTX, 195 * we are not going to want to use the built-in 10baseT port, 196 * since there will be another PHY on the MII wired up to the 197 * UTP connector. The parent indicates this to us by specifying 198 * the TLPHY_MEDIA_NO_10_T bit. 199 */ 200 sc->sc_mii.mii_capabilities = 201 PHY_READ(&sc->sc_mii, MII_BMSR) & capmask /*ma->mii_capmask*/; 202 203 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 204 205 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_LOOP, 206 sc->sc_mii.mii_inst), MII_MEDIA_10_T); 207 208 #define PRINT(s) printf("%s%s", sep, s); sep = ", " 209 210 device_printf(dev, " "); 211 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_2, 0, sc->sc_mii.mii_inst), 0); 212 PRINT("10base2/BNC"); 213 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_5, 0, sc->sc_mii.mii_inst), 0); 214 PRINT("10base5/AUI"); 215 216 if (sc->sc_mii.mii_capabilities & BMSR_MEDIAMASK) { 217 printf("%s", sep); 218 mii_phy_add_media(&sc->sc_mii); 219 } else { 220 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->sc_mii.mii_inst), 221 MII_MEDIA_NONE); 222 } 223 224 printf("\n"); 225 #undef ADD 226 #undef PRINT 227 MIIBUS_MEDIAINIT(sc->sc_mii.mii_dev); 228 return(0); 229 } 230 231 static int 232 tlphy_service(struct mii_softc *self, struct mii_data *mii, int cmd) 233 { 234 struct tlphy_softc *sc = (struct tlphy_softc *)self; 235 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 236 int reg; 237 238 if ((sc->sc_mii.mii_flags & MIIF_DOINGAUTO) == 0 && sc->sc_need_acomp) 239 tlphy_acomp(sc); 240 241 switch (cmd) { 242 case MII_POLLSTAT: 243 /* 244 * If we're not polling our PHY instance, just return. 245 */ 246 if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst) 247 return (0); 248 break; 249 250 case MII_MEDIACHG: 251 /* 252 * If the media indicates a different PHY instance, 253 * isolate ourselves. 254 */ 255 if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst) { 256 reg = PHY_READ(&sc->sc_mii, MII_BMCR); 257 PHY_WRITE(&sc->sc_mii, MII_BMCR, reg | BMCR_ISO); 258 return (0); 259 } 260 261 /* 262 * If the interface is not up, don't do anything. 263 */ 264 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 265 break; 266 267 switch (IFM_SUBTYPE(ife->ifm_media)) { 268 case IFM_AUTO: 269 /* 270 * The ThunderLAN PHY doesn't self-configure after 271 * an autonegotiation cycle, so there's no such 272 * thing as "already in auto mode". 273 */ 274 tlphy_auto(sc, 1); 275 break; 276 case IFM_10_2: 277 case IFM_10_5: 278 PHY_WRITE(&sc->sc_mii, MII_BMCR, 0); 279 PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, CTRL_AUISEL); 280 DELAY(100000); 281 break; 282 default: 283 PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, 0); 284 DELAY(100000); 285 mii_phy_set_media(&sc->sc_mii); 286 break; 287 } 288 break; 289 290 case MII_TICK: 291 /* 292 * If we're not currently selected, just return. 293 */ 294 if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst) 295 return (0); 296 297 /* 298 * Is the interface even up? 299 */ 300 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 301 return (0); 302 303 /* 304 * Only used for autonegotiation. 305 */ 306 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) 307 break; 308 309 /* 310 * Check to see if we have link. If we do, we don't 311 * need to restart the autonegotiation process. Read 312 * the BMSR twice in case it's latched. 313 * 314 * XXX WHAT ABOUT CHECKING LINK ON THE BNC/AUI?! 315 */ 316 reg = PHY_READ(&sc->sc_mii, MII_BMSR) | 317 PHY_READ(&sc->sc_mii, MII_BMSR); 318 if (reg & BMSR_LINK) 319 return (0); 320 321 /* 322 * Only retry autonegotiation every mii_anegticks seconds. 323 */ 324 if (++sc->sc_mii.mii_ticks <= sc->sc_mii.mii_anegticks) 325 return (0); 326 327 sc->sc_mii.mii_ticks = 0; 328 mii_phy_reset(&sc->sc_mii); 329 if (tlphy_auto(sc, 0) == EJUSTRETURN) 330 return (0); 331 break; 332 } 333 334 /* Update the media status. */ 335 tlphy_status(sc); 336 337 /* Callback if something changed. */ 338 mii_phy_update(&sc->sc_mii, cmd); 339 return (0); 340 } 341 342 static void 343 tlphy_status(struct tlphy_softc *sc) 344 { 345 struct mii_data *mii = sc->sc_mii.mii_pdata; 346 int bmsr, bmcr, tlctrl; 347 348 mii->mii_media_status = IFM_AVALID; 349 mii->mii_media_active = IFM_ETHER; 350 351 bmcr = PHY_READ(&sc->sc_mii, MII_BMCR); 352 if (bmcr & BMCR_ISO) { 353 mii->mii_media_active |= IFM_NONE; 354 mii->mii_media_status = 0; 355 return; 356 } 357 358 tlctrl = PHY_READ(&sc->sc_mii, MII_TLPHY_CTRL); 359 if (tlctrl & CTRL_AUISEL) { 360 mii->mii_media_status = 0; 361 mii->mii_media_active = mii->mii_media.ifm_cur->ifm_media; 362 return; 363 } 364 365 bmsr = PHY_READ(&sc->sc_mii, MII_BMSR) | 366 PHY_READ(&sc->sc_mii, MII_BMSR); 367 if (bmsr & BMSR_LINK) 368 mii->mii_media_status |= IFM_ACTIVE; 369 370 if (bmcr & BMCR_LOOP) 371 mii->mii_media_active |= IFM_LOOP; 372 373 /* 374 * Grr, braindead ThunderLAN PHY doesn't have any way to 375 * tell which media is actually active. (Note it also 376 * doesn't self-configure after autonegotiation.) We 377 * just have to report what's in the BMCR. 378 */ 379 if (bmcr & BMCR_FDX) 380 mii->mii_media_active |= IFM_FDX; 381 mii->mii_media_active |= IFM_10_T; 382 } 383 384 static int 385 tlphy_auto(struct tlphy_softc *sc, int waitfor) 386 { 387 int error; 388 389 switch ((error = mii_phy_auto(&sc->sc_mii, waitfor))) { 390 case EIO: 391 /* 392 * Just assume we're not in full-duplex mode. 393 * XXX Check link and try AUI/BNC? 394 */ 395 PHY_WRITE(&sc->sc_mii, MII_BMCR, 0); 396 break; 397 398 case EJUSTRETURN: 399 /* Flag that we need to program when it completes. */ 400 sc->sc_need_acomp = 1; 401 break; 402 403 default: 404 tlphy_acomp(sc); 405 } 406 407 return (error); 408 } 409 410 void 411 tlphy_acomp(struct tlphy_softc *sc) 412 { 413 int aner, anlpar; 414 415 sc->sc_need_acomp = 0; 416 417 /* 418 * Grr, braindead ThunderLAN PHY doesn't self-configure 419 * after autonegotiation. We have to do it ourselves 420 * based on the link partner status. 421 */ 422 423 aner = PHY_READ(&sc->sc_mii, MII_ANER); 424 if (aner & ANER_LPAN) { 425 anlpar = PHY_READ(&sc->sc_mii, MII_ANLPAR) & 426 PHY_READ(&sc->sc_mii, MII_ANAR); 427 if (anlpar & ANAR_10_FD) { 428 PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_FDX); 429 return; 430 } 431 } 432 PHY_WRITE(&sc->sc_mii, MII_BMCR, 0); 433 } 434