mlphy.c revision 96026
1/* 2 * Copyright (c) 1997, 1998, 1999 3 * Bill Paul <wpaul@ctr.columbia.edu>. 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: head/sys/dev/mii/mlphy.c 96026 2002-05-04 11:00:30Z phk $ 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/socket.h> 54#include <sys/module.h> 55#include <sys/bus.h> 56#include <sys/malloc.h> 57 58#include <net/if.h> 59#include <net/if_media.h> 60 61#include <dev/mii/mii.h> 62#include <dev/mii/miivar.h> 63 64#include "miibus_if.h" 65 66#define ML_STATE_AUTO_SELF 1 67#define ML_STATE_AUTO_OTHER 2 68 69struct mlphy_softc { 70 struct mii_softc ml_mii; 71 int ml_state; 72 int ml_linked; 73}; 74 75static int mlphy_probe (device_t); 76static int mlphy_attach (device_t); 77 78static device_method_t mlphy_methods[] = { 79 /* device interface */ 80 DEVMETHOD(device_probe, mlphy_probe), 81 DEVMETHOD(device_attach, mlphy_attach), 82 DEVMETHOD(device_detach, mii_phy_detach), 83 DEVMETHOD(device_shutdown, bus_generic_shutdown), 84 { 0, 0 } 85}; 86 87static devclass_t mlphy_devclass; 88 89static driver_t mlphy_driver = { 90 "mlphy", 91 mlphy_methods, 92 sizeof(struct mlphy_softc) 93}; 94 95DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0); 96 97static int mlphy_service(struct mii_softc *, struct mii_data *, int); 98static void mlphy_reset(struct mii_softc *); 99static void mlphy_status(struct mii_softc *); 100 101static int mlphy_probe(dev) 102 device_t dev; 103{ 104 struct mii_attach_args *ma; 105 device_t parent; 106 107 ma = device_get_ivars(dev); 108 parent = device_get_parent(device_get_parent(dev)); 109 110 /* 111 * Micro Linear PHY reports oui == 0 model == 0 112 */ 113 if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 || 114 MII_MODEL(ma->mii_id2) != 0) 115 return (ENXIO); 116 117 /* 118 * Make sure the parent is a `tl'. So far, I have only 119 * encountered the 6692 on an Olicom card with a ThunderLAN 120 * controller chip. 121 */ 122 if (strcmp(device_get_name(parent), "tl") != 0) 123 return (ENXIO); 124 125 device_set_desc(dev, "Micro Linear 6692 media interface"); 126 127 return (0); 128} 129 130static int mlphy_attach(dev) 131 device_t dev; 132{ 133 struct mlphy_softc *msc; 134 struct mii_softc *sc; 135 struct mii_attach_args *ma; 136 struct mii_data *mii; 137 138 msc = device_get_softc(dev); 139 sc = &msc->ml_mii; 140 ma = device_get_ivars(dev); 141 sc->mii_dev = device_get_parent(dev); 142 mii = device_get_softc(sc->mii_dev); 143 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 144 145 sc->mii_inst = mii->mii_instance; 146 sc->mii_phy = ma->mii_phyno; 147 sc->mii_service = mlphy_service; 148 sc->mii_pdata = mii; 149 150 mii->mii_instance++; 151 152#define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 153 154#if 0 /* See above. */ 155 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst), 156 BMCR_ISO); 157#endif 158 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 159 BMCR_LOOP|BMCR_S100); 160 161 sc->mii_flags &= ~MIIF_NOISOLATE; 162 mii_phy_reset(sc); 163 sc->mii_flags |= MIIF_NOISOLATE; 164 165 sc->mii_capabilities = 166 PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 167 ma->mii_capmask = ~sc->mii_capabilities; 168 device_printf(dev, " "); 169 mii_add_media(sc); 170 printf("\n"); 171#undef ADD 172 MIIBUS_MEDIAINIT(sc->mii_dev); 173 return(0); 174} 175 176static int 177mlphy_service(xsc, mii, cmd) 178 struct mii_softc *xsc; 179 struct mii_data *mii; 180 int cmd; 181{ 182 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 183 int reg; 184 struct mii_softc *other = NULL; 185 struct mlphy_softc *msc = (struct mlphy_softc *)xsc; 186 struct mii_softc *sc = (struct mii_softc *)&msc->ml_mii; 187 device_t *devlist; 188 int devs, i; 189 190 /* 191 * See if there's another PHY on this bus with us. 192 * If so, we may need it for 10Mbps modes. 193 */ 194 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs); 195 for (i = 0; i < devs; i++) { 196 if (strcmp(device_get_name(devlist[i]), "mlphy")) { 197 other = device_get_softc(devlist[i]); 198 break; 199 } 200 } 201 free(devlist, M_TEMP); 202 203 switch (cmd) { 204 case MII_POLLSTAT: 205 /* 206 * If we're not polling our PHY instance, just return. 207 */ 208 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 209 return (0); 210 break; 211 212 case MII_MEDIACHG: 213 /* 214 * If the media indicates a different PHY instance, 215 * isolate ourselves. 216 */ 217 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 218 reg = PHY_READ(sc, MII_BMCR); 219 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 220 return (0); 221 } 222 223 /* 224 * If the interface is not up, don't do anything. 225 */ 226 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 227 break; 228 229 switch (IFM_SUBTYPE(ife->ifm_media)) { 230 case IFM_AUTO: 231 /* 232 * For autonegotiation, reset and isolate the 233 * companion PHY (if any) and then do NWAY 234 * autonegotiation ourselves. 235 */ 236 msc->ml_state = ML_STATE_AUTO_SELF; 237 if (other != NULL) { 238 mii_phy_reset(other); 239 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 240 } 241 (void) mii_phy_auto(sc); 242 msc->ml_linked = 0; 243 return(0); 244 break; 245 case IFM_10_T: 246 /* 247 * For 10baseT modes, reset and program the 248 * companion PHY (of any), then program ourselves 249 * to match. This will put us in pass-through 250 * mode and let the companion PHY do all the 251 * work. 252 * 253 * BMCR data is stored in the ifmedia entry. 254 */ 255 if (other != NULL) { 256 mii_phy_reset(other); 257 PHY_WRITE(other, MII_BMCR, ife->ifm_data); 258 } 259 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media)); 260 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 261 msc->ml_state = 0; 262 break; 263 case IFM_100_TX: 264 /* 265 * For 100baseTX modes, reset and isolate the 266 * companion PHY (if any), then program ourselves 267 * accordingly. 268 * 269 * BMCR data is stored in the ifmedia entry. 270 */ 271 if (other != NULL) { 272 mii_phy_reset(other); 273 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 274 } 275 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media)); 276 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 277 msc->ml_state = 0; 278 break; 279 case IFM_100_T4: 280 /* 281 * XXX Not supported as a manual setting right now. 282 */ 283 return (EINVAL); 284 default: 285 break; 286 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->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 * If we're in a 10Mbps mode, check the link of the 314 * 10Mbps PHY. Sometimes the Micro Linear PHY's 315 * linkstat bit will clear while the linkstat bit of 316 * the companion PHY will remain set. 317 */ 318 if (msc->ml_state == ML_STATE_AUTO_OTHER) { 319 reg = PHY_READ(other, MII_BMSR) | 320 PHY_READ(other, MII_BMSR); 321 } else { 322 reg = PHY_READ(sc, MII_BMSR) | 323 PHY_READ(sc, MII_BMSR); 324 } 325 326 if (reg & BMSR_LINK) { 327 if (!msc->ml_linked) { 328 msc->ml_linked = 1; 329 mlphy_status(sc); 330 } 331 break; 332 } 333 334 /* 335 * Only retry autonegotiation every 5 seconds. 336 */ 337 if (++sc->mii_ticks != 5) 338 return (0); 339 340 sc->mii_ticks = 0; 341 msc->ml_linked = 0; 342 mii->mii_media_active = IFM_NONE; 343 mii_phy_reset(sc); 344 msc->ml_state = ML_STATE_AUTO_SELF; 345 if (other != NULL) { 346 mii_phy_reset(other); 347 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 348 } 349 mii_phy_auto(sc); 350 return(0); 351 } 352 353 /* Update the media status. */ 354 355 if (msc->ml_state == ML_STATE_AUTO_OTHER) { 356 int other_inst; 357 other_inst = other->mii_inst; 358 other->mii_inst = sc->mii_inst; 359 (void) (*other->mii_service)(other, mii, MII_POLLSTAT); 360 other->mii_inst = other_inst; 361 sc->mii_media_active = other->mii_media_active; 362 sc->mii_media_status = other->mii_media_status; 363 } else 364 ukphy_status(sc); 365 366 /* Callback if something changed. */ 367 mii_phy_update(sc, cmd); 368 return (0); 369} 370 371/* 372 * The Micro Linear PHY comes out of reset with the 'autoneg 373 * enable' bit set, which we don't want. 374 */ 375static void mlphy_reset(sc) 376 struct mii_softc *sc; 377{ 378 int reg; 379 380 mii_phy_reset(sc); 381 reg = PHY_READ(sc, MII_BMCR); 382 reg &= ~BMCR_AUTOEN; 383 PHY_WRITE(sc, MII_BMCR, reg); 384 385 return; 386} 387 388/* 389 * If we negotiate a 10Mbps mode, we need to check for an alternate 390 * PHY and make sure it's enabled and set correctly. 391 */ 392static void mlphy_status(sc) 393 struct mii_softc *sc; 394{ 395 struct mlphy_softc *msc = (struct mlphy_softc *)sc; 396 struct mii_data *mii = msc->ml_mii.mii_pdata; 397 struct mii_softc *other = NULL; 398 device_t *devlist; 399 int devs, i; 400 401 /* See if there's another PHY on the bus with us. */ 402 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs); 403 for (i = 0; i < devs; i++) { 404 if (strcmp(device_get_name(devlist[i]), "mlphy")) { 405 other = device_get_softc(devlist[i]); 406 break; 407 } 408 } 409 free(devlist, M_TEMP); 410 411 if (other == NULL) 412 return; 413 414 ukphy_status(sc); 415 416 if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) { 417 msc->ml_state = ML_STATE_AUTO_SELF; 418 mii_phy_reset(other); 419 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 420 } 421 422 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) { 423 msc->ml_state = ML_STATE_AUTO_OTHER; 424 mlphy_reset(&msc->ml_mii); 425 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO); 426 mii_phy_reset(other); 427 mii_phy_auto(other); 428 } 429 430 return; 431} 432