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