mlphy.c revision 213364
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 */ 33 34#include <sys/cdefs.h> 35__FBSDID("$FreeBSD: head/sys/dev/mii/mlphy.c 213364 2010-10-02 18:53:12Z marius $"); 36 37/* 38 * driver for Micro Linear 6692 PHYs 39 * 40 * The Micro Linear 6692 is a strange beast, and dealing with it using 41 * this code framework is tricky. The 6692 is actually a 100Mbps-only 42 * device, which means that a second PHY is required to support 10Mbps 43 * modes. However, even though the 6692 does not support 10Mbps modes, 44 * it can still advertise them when performing autonegotiation. If a 45 * 10Mbps mode is negotiated, we must program the registers of the 46 * companion PHY accordingly in addition to programming the registers 47 * of the 6692. 48 * 49 * This device also does not have vendor/device ID registers. 50 */ 51 52#include <sys/param.h> 53#include <sys/systm.h> 54#include <sys/kernel.h> 55#include <sys/socket.h> 56#include <sys/module.h> 57#include <sys/bus.h> 58#include <sys/malloc.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 71struct mlphy_softc { 72 struct mii_softc ml_mii; 73 int ml_state; 74 int ml_linked; 75}; 76 77static int mlphy_probe(device_t); 78static int mlphy_attach(device_t); 79 80static device_method_t mlphy_methods[] = { 81 /* device interface */ 82 DEVMETHOD(device_probe, mlphy_probe), 83 DEVMETHOD(device_attach, mlphy_attach), 84 DEVMETHOD(device_detach, mii_phy_detach), 85 DEVMETHOD(device_shutdown, bus_generic_shutdown), 86 { 0, 0 } 87}; 88 89static devclass_t mlphy_devclass; 90 91static driver_t mlphy_driver = { 92 "mlphy", 93 mlphy_methods, 94 sizeof(struct mlphy_softc) 95}; 96 97DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0); 98 99static int mlphy_service(struct mii_softc *, struct mii_data *, int); 100static void mlphy_reset(struct mii_softc *); 101static void mlphy_status(struct mii_softc *); 102 103static int 104mlphy_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 (BUS_PROBE_DEFAULT); 131} 132 133static int 134mlphy_attach(dev) 135 device_t dev; 136{ 137 struct mlphy_softc *msc; 138 struct mii_softc *sc; 139 struct mii_attach_args *ma; 140 struct mii_data *mii; 141 142 msc = device_get_softc(dev); 143 sc = &msc->ml_mii; 144 ma = device_get_ivars(dev); 145 sc->mii_dev = device_get_parent(dev); 146 mii = ma->mii_data; 147 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 148 149 sc->mii_inst = mii->mii_instance++; 150 sc->mii_phy = ma->mii_phyno; 151 sc->mii_service = mlphy_service; 152 sc->mii_pdata = mii; 153 154#define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 155 156 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 157 BMCR_LOOP|BMCR_S100); 158 159 mii_phy_reset(sc); 160 161 sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 162 ma->mii_capmask = ~sc->mii_capabilities; 163 device_printf(dev, " "); 164 mii_add_media(sc); 165 printf("\n"); 166#undef ADD 167 MIIBUS_MEDIAINIT(sc->mii_dev); 168 return (0); 169} 170 171static struct mii_softc * 172mlphy_find_other(device_t mii) 173{ 174 device_t *devlist; 175 struct mii_softc *retval; 176 int i, devs; 177 178 retval = NULL; 179 if (device_get_children(mii, &devlist, &devs)) 180 return (NULL); 181 for (i = 0; i < devs; i++) 182 if (strcmp(device_get_name(devlist[i]), "mlphy")) { 183 retval = device_get_softc(devlist[i]); 184 break; 185 } 186 free(devlist, M_TEMP); 187 return (retval); 188} 189 190static int 191mlphy_service(xsc, mii, cmd) 192 struct mii_softc *xsc; 193 struct mii_data *mii; 194 int cmd; 195{ 196 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 197 struct mii_softc *other = NULL; 198 struct mlphy_softc *msc = (struct mlphy_softc *)xsc; 199 struct mii_softc *sc = (struct mii_softc *)&msc->ml_mii; 200 int other_inst, reg; 201 202 /* 203 * See if there's another PHY on this bus with us. 204 * If so, we may need it for 10Mbps modes. 205 */ 206 other = mlphy_find_other(msc->ml_mii.mii_dev); 207 208 switch (cmd) { 209 case MII_POLLSTAT: 210 break; 211 212 case MII_MEDIACHG: 213 /* 214 * If the interface is not up, don't do anything. 215 */ 216 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 217 break; 218 219 switch (IFM_SUBTYPE(ife->ifm_media)) { 220 case IFM_AUTO: 221 /* 222 * For autonegotiation, reset and isolate the 223 * companion PHY (if any) and then do NWAY 224 * autonegotiation ourselves. 225 */ 226 msc->ml_state = ML_STATE_AUTO_SELF; 227 if (other != NULL) { 228 mii_phy_reset(other); 229 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 230 } 231 (void) mii_phy_auto(sc); 232 msc->ml_linked = 0; 233 return (0); 234 case IFM_10_T: 235 /* 236 * For 10baseT modes, reset and program the 237 * companion PHY (of any), then program ourselves 238 * to match. This will put us in pass-through 239 * mode and let the companion PHY do all the 240 * work. 241 * 242 * BMCR data is stored in the ifmedia entry. 243 */ 244 if (other != NULL) { 245 mii_phy_reset(other); 246 PHY_WRITE(other, MII_BMCR, ife->ifm_data); 247 } 248 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media)); 249 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 250 msc->ml_state = 0; 251 break; 252 case IFM_100_TX: 253 /* 254 * For 100baseTX modes, reset and isolate the 255 * companion PHY (if any), then program ourselves 256 * accordingly. 257 * 258 * BMCR data is stored in the ifmedia entry. 259 */ 260 if (other != NULL) { 261 mii_phy_reset(other); 262 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 263 } 264 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media)); 265 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 266 msc->ml_state = 0; 267 break; 268 case IFM_100_T4: 269 /* 270 * XXX Not supported as a manual setting right now. 271 */ 272 return (EINVAL); 273 default: 274 break; 275 276 } 277 break; 278 279 case MII_TICK: 280 /* 281 * Is the interface even up? 282 */ 283 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 284 return (0); 285 286 /* 287 * Only used for autonegotiation. 288 */ 289 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) 290 break; 291 292 /* 293 * Check to see if we have link. If we do, we don't 294 * need to restart the autonegotiation process. Read 295 * the BMSR twice in case it's latched. 296 * If we're in a 10Mbps mode, check the link of the 297 * 10Mbps PHY. Sometimes the Micro Linear PHY's 298 * linkstat bit will clear while the linkstat bit of 299 * the companion PHY will remain set. 300 */ 301 if (msc->ml_state == ML_STATE_AUTO_OTHER) { 302 reg = PHY_READ(other, MII_BMSR) | 303 PHY_READ(other, MII_BMSR); 304 } else { 305 reg = PHY_READ(sc, MII_BMSR) | 306 PHY_READ(sc, MII_BMSR); 307 } 308 309 if (reg & BMSR_LINK) { 310 if (!msc->ml_linked) { 311 msc->ml_linked = 1; 312 mlphy_status(sc); 313 } 314 break; 315 } 316 317 /* 318 * Only retry autonegotiation every 5 seconds. 319 */ 320 if (++sc->mii_ticks <= MII_ANEGTICKS) 321 break; 322 323 sc->mii_ticks = 0; 324 msc->ml_linked = 0; 325 mii->mii_media_active = IFM_NONE; 326 mii_phy_reset(sc); 327 msc->ml_state = ML_STATE_AUTO_SELF; 328 if (other != NULL) { 329 mii_phy_reset(other); 330 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 331 } 332 mii_phy_auto(sc); 333 return (0); 334 } 335 336 /* Update the media status. */ 337 338 if (msc->ml_state == ML_STATE_AUTO_OTHER) { 339 other_inst = other->mii_inst; 340 other->mii_inst = sc->mii_inst; 341 if (IFM_INST(ife->ifm_media) == other->mii_inst) 342 (void)(*other->mii_service)(other, mii, MII_POLLSTAT); 343 other->mii_inst = other_inst; 344 sc->mii_media_active = other->mii_media_active; 345 sc->mii_media_status = other->mii_media_status; 346 } else 347 ukphy_status(sc); 348 349 /* Callback if something changed. */ 350 mii_phy_update(sc, cmd); 351 return (0); 352} 353 354/* 355 * The Micro Linear PHY comes out of reset with the 'autoneg 356 * enable' bit set, which we don't want. 357 */ 358static void 359mlphy_reset(sc) 360 struct mii_softc *sc; 361{ 362 int reg; 363 364 mii_phy_reset(sc); 365 reg = PHY_READ(sc, MII_BMCR); 366 reg &= ~BMCR_AUTOEN; 367 PHY_WRITE(sc, MII_BMCR, reg); 368} 369 370/* 371 * If we negotiate a 10Mbps mode, we need to check for an alternate 372 * PHY and make sure it's enabled and set correctly. 373 */ 374static void 375mlphy_status(sc) 376 struct mii_softc *sc; 377{ 378 struct mlphy_softc *msc = (struct mlphy_softc *)sc; 379 struct mii_data *mii = msc->ml_mii.mii_pdata; 380 struct mii_softc *other = NULL; 381 382 /* See if there's another PHY on the bus with us. */ 383 other = mlphy_find_other(msc->ml_mii.mii_dev); 384 if (other == NULL) 385 return; 386 387 ukphy_status(sc); 388 389 if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) { 390 msc->ml_state = ML_STATE_AUTO_SELF; 391 mii_phy_reset(other); 392 PHY_WRITE(other, MII_BMCR, BMCR_ISO); 393 } 394 395 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) { 396 msc->ml_state = ML_STATE_AUTO_OTHER; 397 mlphy_reset(&msc->ml_mii); 398 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO); 399 mii_phy_reset(other); 400 mii_phy_auto(other); 401 } 402} 403