1 /* 2 * Copyright (c) 1997, 1998, 1999 3 * Bill Paul <[email protected]>. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by Bill Paul. 16 * 4. Neither the name of the author nor the names of any co-contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 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 30 * THE POSSIBILITY OF SUCH DAMAGE. 31 * 32 * $FreeBSD$ 33 */ 34 35 /* 36 * driver for Micro Linear 6692 PHYs 37 * 38 * The Micro Linear 6692 is a strange beast, and dealing with it using 39 * this code framework is tricky. The 6692 is actually a 100Mbps-only 40 * device, which means that a second PHY is required to support 10Mbps 41 * modes. However, even though the 6692 does not support 10Mbps modes, 42 * it can still advertise them when performing autonegotiation. If a 43 * 10Mbps mode is negotiated, we must program the registers of the 44 * companion PHY accordingly in addition to programming the registers 45 * of the 6692. 46 * 47 * This device also does not have vendor/device ID registers. 48 */ 49 50 #include <sys/param.h> 51 #include <sys/systm.h> 52 #include <sys/kernel.h> 53 #include <sys/malloc.h> 54 #include <sys/socket.h> 55 #include <sys/module.h> 56 #include <sys/bus.h> 57 58 #include <machine/clock.h> 59 60 #include <net/if.h> 61 #include <net/if_media.h> 62 63 #include <dev/mii/mii.h> 64 #include <dev/mii/miivar.h> 65 66 #include "miibus_if.h" 67 68 #define ML_STATE_AUTO_SELF 1 69 #define ML_STATE_AUTO_OTHER 2 70 71 struct mlphy_softc { 72 struct mii_softc ml_mii; 73 int ml_state; 74 int ml_linked; 75 }; 76 77 static int mlphy_probe __P((device_t)); 78 static int mlphy_attach __P((device_t)); 79 static int mlphy_detach __P((device_t)); 80 81 static device_method_t mlphy_methods[] = { 82 /* device interface */ 83 DEVMETHOD(device_probe, mlphy_probe), 84 DEVMETHOD(device_attach, mlphy_attach), 85 DEVMETHOD(device_detach, mlphy_detach), 86 DEVMETHOD(device_shutdown, bus_generic_shutdown), 87 { 0, 0 } 88 }; 89 90 static devclass_t mlphy_devclass; 91 92 static driver_t mlphy_driver = { 93 "mlphy", 94 mlphy_methods, 95 sizeof(struct mlphy_softc) 96 }; 97 98 DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0); 99 100 static int mlphy_service __P((struct mii_softc *, struct mii_data *, int)); 101 static void mlphy_reset __P((struct mii_softc *)); 102 static void mlphy_status __P((struct mii_softc *)); 103 104 static int mlphy_probe(dev) 105 device_t dev; 106 { 107 struct mii_attach_args *ma; 108 device_t parent; 109 110 ma = device_get_ivars(dev); 111 parent = device_get_parent(device_get_parent(dev)); 112 113 /* 114 * Micro Linear PHY reports oui == 0 model == 0 115 */ 116 if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 && 117 MII_MODEL(ma->mii_id2) != 0) 118 return (ENXIO); 119 120 /* 121 * Make sure the parent is a `tl'. So far, I have only 122 * encountered the 6692 on an Olicom card with a ThunderLAN 123 * controller chip. 124 */ 125 if (strcmp(device_get_name(parent), "tl") != 0) 126 return (ENXIO); 127 128 device_set_desc(dev, "Micro Linear 6692 media interface"); 129 130 return (0); 131 } 132 133 static int mlphy_attach(dev) 134 device_t dev; 135 { 136 struct mlphy_softc *msc; 137 struct mii_softc *sc; 138 struct mii_attach_args *ma; 139 struct mii_data *mii; 140 141 msc = device_get_softc(dev); 142 sc = &msc->ml_mii; 143 ma = device_get_ivars(dev); 144 sc->mii_dev = device_get_parent(dev); 145 mii = device_get_softc(sc->mii_dev); 146 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 147 148 sc->mii_inst = mii->mii_instance; 149 sc->mii_phy = ma->mii_phyno; 150 sc->mii_service = mlphy_service; 151 sc->mii_pdata = mii; 152 153 mii->mii_instance++; 154 155 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 156 157 #if 0 /* See above. */ 158 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst), 159 BMCR_ISO); 160 #endif 161 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 162 BMCR_LOOP|BMCR_S100); 163 164 sc->mii_flags &= ~MIIF_NOISOLATE; 165 mii_phy_reset(sc); 166 sc->mii_flags |= MIIF_NOISOLATE; 167 168 sc->mii_capabilities = 169 PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 170 ma->mii_capmask = ~sc->mii_capabilities; 171 device_printf(dev, " "); 172 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0) 173 printf("no media present"); 174 else 175 mii_add_media(mii, sc->mii_capabilities, 176 sc->mii_inst); 177 printf("\n"); 178 #undef ADD 179 MIIBUS_MEDIAINIT(sc->mii_dev); 180 return(0); 181 } 182 183 static int mlphy_detach(dev) 184 device_t dev; 185 { 186 struct mlphy_softc *sc; 187 struct mii_data *mii; 188 189 sc = device_get_softc(dev); 190 mii = device_get_softc(device_get_parent(dev)); 191 sc->ml_mii.mii_dev = NULL; 192 LIST_REMOVE(&sc->ml_mii, mii_list); 193 194 return(0); 195 } 196 197 static int 198 mlphy_service(xsc, mii, cmd) 199 struct mii_softc *xsc; 200 struct mii_data *mii; 201 int cmd; 202 { 203 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 204 int reg; 205 struct mii_softc *other = NULL; 206 struct mlphy_softc *msc = (struct mlphy_softc *)xsc; 207 struct mii_softc *sc = (struct mii_softc *)&msc->ml_mii; 208 device_t *devlist; 209 int devs, i; 210 211 /* 212 * See if there's another PHY on this bus with us. 213 * If so, we may need it for 10Mbps modes. 214 */ 215 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs); 216 for (i = 0; i < devs; i++) { 217 if (strcmp(device_get_name(devlist[i]), "mlphy")) { 218 other = device_get_softc(devlist[i]); 219 break; 220 } 221 } 222 223 switch (cmd) { 224 case MII_POLLSTAT: 225 /* 226 * If we're not polling our PHY instance, just return. 227 */ 228 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 229 return (0); 230 break; 231 232 case MII_MEDIACHG: 233 /* 234 * If the media indicates a different PHY instance, 235 * isolate ourselves. 236 */ 237 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 238 reg = PHY_READ(sc, MII_BMCR); 239 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 240 return (0); 241 } 242 243 /* 244 * If the interface is not up, don't do anything. 245 */ 246 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 247 break; 248 249 switch (IFM_SUBTYPE(ife->ifm_media)) { 250 case IFM_AUTO: 251 /* 252 * For autonegotiation, reset and isolate the 253 * companion PHY (if any) and then do NWAY 254 * autonegotiation ourselves. 255 */ 256 msc->ml_state = ML_STATE_AUTO_SELF; 257 if (other != NULL) { 258 mii_phy_reset(other); 259 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 260 } 261 (void) mii_phy_auto(sc, 1); 262 msc->ml_linked = 0; 263 return(0); 264 break; 265 case IFM_10_T: 266 /* 267 * For 10baseT modes, reset and program the 268 * companion PHY (of any), then program ourselves 269 * to match. This will put us in pass-through 270 * mode and let the companion PHY do all the 271 * work. 272 * 273 * BMCR data is stored in the ifmedia entry. 274 */ 275 if (other != NULL) { 276 mii_phy_reset(other); 277 PHY_WRITE(other, MII_BMCR, ife->ifm_data); 278 } 279 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media)); 280 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 281 msc->ml_state = 0; 282 break; 283 case IFM_100_TX: 284 /* 285 * For 100baseTX modes, reset and isolate the 286 * companion PHY (if any), then program ourselves 287 * accordingly. 288 * 289 * BMCR data is stored in the ifmedia entry. 290 */ 291 if (other != NULL) { 292 mii_phy_reset(other); 293 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 294 } 295 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media)); 296 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 297 msc->ml_state = 0; 298 break; 299 case IFM_100_T4: 300 /* 301 * XXX Not supported as a manual setting right now. 302 */ 303 return (EINVAL); 304 default: 305 break; 306 307 } 308 break; 309 310 case MII_TICK: 311 /* 312 * If we're not currently selected, just return. 313 */ 314 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 315 return (0); 316 317 /* 318 * Only used for autonegotiation. 319 */ 320 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) 321 return (0); 322 323 /* 324 * Is the interface even up? 325 */ 326 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 327 return (0); 328 329 /* 330 * Only retry autonegotiation every 5 seconds. 331 */ 332 if (++sc->mii_ticks != 5) 333 return (0); 334 335 sc->mii_ticks = 0; 336 337 /* 338 * Check to see if we have link. If we do, we don't 339 * need to restart the autonegotiation process. Read 340 * the BMSR twice in case it's latched. 341 * If we're in a 10Mbps mode, check the link of the 342 * 10Mbps PHY. Sometimes the Micro Linear PHY's 343 * linkstat bit will clear while the linkstat bit of 344 * the companion PHY will remain set. 345 */ 346 if (msc->ml_state == ML_STATE_AUTO_OTHER) { 347 reg = PHY_READ(other, MII_BMSR) | 348 PHY_READ(other, MII_BMSR); 349 } else { 350 reg = PHY_READ(sc, MII_BMSR) | 351 PHY_READ(sc, MII_BMSR); 352 } 353 354 if (reg & BMSR_LINK) { 355 if (!msc->ml_linked) { 356 msc->ml_linked = 1; 357 mlphy_status(sc); 358 break; 359 } 360 return(0); 361 } 362 363 msc->ml_linked = 0; 364 mii->mii_media_active = IFM_NONE; 365 mii_phy_reset(sc); 366 msc->ml_state = ML_STATE_AUTO_SELF; 367 if (other != NULL) { 368 mii_phy_reset(other); 369 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 370 } 371 if (mii_phy_auto(sc, 0) == EJUSTRETURN) 372 return(0); 373 break; 374 } 375 376 /* Update the media status. */ 377 378 if (msc->ml_state == ML_STATE_AUTO_OTHER) { 379 int other_inst; 380 other_inst = other->mii_inst; 381 other->mii_inst = sc->mii_inst; 382 (void) (*other->mii_service)(other, mii, MII_POLLSTAT); 383 other->mii_inst = other_inst; 384 sc->mii_active = other->mii_active; 385 } else 386 ukphy_status(sc); 387 388 /* Callback if something changed. */ 389 if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) { 390 MIIBUS_STATCHG(sc->mii_dev); 391 sc->mii_active = mii->mii_media_active; 392 } 393 394 return (0); 395 } 396 397 /* 398 * The Micro Linear PHY comes out of reset with the 'autoneg 399 * enable' bit set, which we don't want. 400 */ 401 static void mlphy_reset(sc) 402 struct mii_softc *sc; 403 { 404 int reg; 405 406 mii_phy_reset(sc); 407 reg = PHY_READ(sc, MII_BMCR); 408 reg &= ~BMCR_AUTOEN; 409 PHY_WRITE(sc, MII_BMCR, reg); 410 411 return; 412 } 413 414 /* 415 * If we negotiate a 10Mbps mode, we need to check for an alternate 416 * PHY and make sure it's enabled and set correctly. 417 */ 418 static void mlphy_status(sc) 419 struct mii_softc *sc; 420 { 421 struct mlphy_softc *msc = (struct mlphy_softc *)sc; 422 struct mii_data *mii = msc->ml_mii.mii_pdata; 423 struct mii_softc *other = NULL; 424 device_t *devlist; 425 int devs, i; 426 427 /* See if there's another PHY on the bus with us. */ 428 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs); 429 for (i = 0; i < devs; i++) { 430 if (strcmp(device_get_name(devlist[i]), "mlphy")) { 431 other = device_get_softc(devlist[i]); 432 break; 433 } 434 } 435 436 if (other == NULL) 437 return; 438 439 ukphy_status(sc); 440 441 if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) { 442 msc->ml_state = ML_STATE_AUTO_SELF; 443 mii_phy_reset(other); 444 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 445 } 446 447 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) { 448 msc->ml_state = ML_STATE_AUTO_OTHER; 449 mlphy_reset(&msc->ml_mii); 450 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO); 451 mii_phy_reset(other); 452 mii_phy_auto(other, 1); 453 } 454 455 return; 456 } 457