nsphy.c revision 213229
1/* $NetBSD: nsphy.c,v 1.18 1999/07/14 23:57:36 thorpej 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 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 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 THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33/*- 34 * Copyright (c) 1997 Manuel Bouyer. All rights reserved. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 1. Redistributions of source code must retain the above copyright 40 * notice, this list of conditions and the following disclaimer. 41 * 2. Redistributions in binary form must reproduce the above copyright 42 * notice, this list of conditions and the following disclaimer in the 43 * documentation and/or other materials provided with the distribution. 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 55 */ 56 57#include <sys/cdefs.h> 58__FBSDID("$FreeBSD: head/sys/dev/mii/nsphy.c 213229 2010-09-27 20:31:03Z marius $"); 59 60/* 61 * driver for National Semiconductor's DP83840A ethernet 10/100 PHY 62 * Data Sheet available from www.national.com 63 */ 64 65#include <sys/param.h> 66#include <sys/systm.h> 67#include <sys/kernel.h> 68#include <sys/socket.h> 69#include <sys/errno.h> 70#include <sys/module.h> 71#include <sys/bus.h> 72 73#include <net/if.h> 74#include <net/if_media.h> 75 76#include <dev/mii/mii.h> 77#include <dev/mii/miivar.h> 78#include "miidevs.h" 79 80#include <dev/mii/nsphyreg.h> 81 82#include "miibus_if.h" 83 84static int nsphy_probe(device_t); 85static int nsphy_attach(device_t); 86 87static device_method_t nsphy_methods[] = { 88 /* device interface */ 89 DEVMETHOD(device_probe, nsphy_probe), 90 DEVMETHOD(device_attach, nsphy_attach), 91 DEVMETHOD(device_detach, mii_phy_detach), 92 DEVMETHOD(device_shutdown, bus_generic_shutdown), 93 { 0, 0 } 94}; 95 96static devclass_t nsphy_devclass; 97 98static driver_t nsphy_driver = { 99 "nsphy", 100 nsphy_methods, 101 sizeof(struct mii_softc) 102}; 103 104DRIVER_MODULE(nsphy, miibus, nsphy_driver, nsphy_devclass, 0, 0); 105 106static int nsphy_service(struct mii_softc *, struct mii_data *, int); 107static void nsphy_status(struct mii_softc *); 108static void nsphy_reset(struct mii_softc *); 109 110static const struct mii_phydesc nsphys[] = { 111 MII_PHY_DESC(NATSEMI, DP83840), 112 MII_PHY_END 113}; 114 115static int 116nsphy_probe(device_t dev) 117{ 118 119 return (mii_phy_dev_probe(dev, nsphys, BUS_PROBE_DEFAULT)); 120} 121 122static int 123nsphy_attach(device_t dev) 124{ 125 struct mii_softc *sc; 126 struct mii_attach_args *ma; 127 struct mii_data *mii; 128 const char *nic; 129 130 sc = device_get_softc(dev); 131 ma = device_get_ivars(dev); 132 sc->mii_dev = device_get_parent(dev); 133 mii = ma->mii_data; 134 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 135 136 sc->mii_inst = mii->mii_instance; 137 sc->mii_phy = ma->mii_phyno; 138 sc->mii_service = nsphy_service; 139 sc->mii_pdata = mii; 140 141 mii->mii_instance++; 142 143 nic = device_get_name(device_get_parent(sc->mii_dev)); 144 /* 145 * Am79C971 and i82557 wedge when isolating all of their 146 * (external) PHYs. 147 */ 148 if (strcmp(nic, "fxp") == 0 || strcmp(nic, "pcn") == 0) 149 sc->mii_flags |= MIIF_NOISOLATE; 150 151 /* 152 * DP83840A used with HME chips don't advertise their media 153 * capabilities themselves properly so force writing the ANAR 154 * according to the BMSR in mii_phy_setmedia(). 155 */ 156 if (strcmp(nic, "hme") == 0) 157 sc->mii_flags |= MIIF_FORCEANEG; 158 159#define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 160 161 /* 162 * In order for MII loopback to work Am79C971 and greater PCnet 163 * chips additionally need to be placed into external loopback 164 * mode which pcn(4) doesn't do so far. 165 */ 166 if (strcmp(nic, "pcn") != 0) 167#if 1 168 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, 169 sc->mii_inst), MII_MEDIA_100_TX); 170#else 171 if (strcmp(nic, "pcn") == 0) 172 sc->mii_flags |= MIIF_NOLOOP; 173#endif 174 175 nsphy_reset(sc); 176 177 sc->mii_capabilities = 178 PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 179 device_printf(dev, " "); 180 mii_phy_add_media(sc); 181 printf("\n"); 182#undef ADD 183 184 MIIBUS_MEDIAINIT(sc->mii_dev); 185 return (0); 186} 187 188static int 189nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 190{ 191 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 192 int reg; 193 194 switch (cmd) { 195 case MII_POLLSTAT: 196 /* 197 * If we're not polling our PHY instance, just return. 198 */ 199 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 200 return (0); 201 break; 202 203 case MII_MEDIACHG: 204 /* 205 * If the media indicates a different PHY instance, 206 * isolate ourselves. 207 */ 208 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 209 reg = PHY_READ(sc, MII_BMCR); 210 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 211 return (0); 212 } 213 214 /* 215 * If the interface is not up, don't do anything. 216 */ 217 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 218 break; 219 220 reg = PHY_READ(sc, MII_NSPHY_PCR); 221 222 /* 223 * Set up the PCR to use LED4 to indicate full-duplex 224 * in both 10baseT and 100baseTX modes. 225 */ 226 reg |= PCR_LED4MODE; 227 228 /* 229 * Make sure Carrier Integrity Monitor function is 230 * disabled (normal for Node operation, but sometimes 231 * it's not set?!) 232 */ 233 reg |= PCR_CIMDIS; 234 235 /* 236 * Make sure "force link good" is set to normal mode. 237 * It's only intended for debugging. 238 */ 239 reg |= PCR_FLINK100; 240 241 /* 242 * Mystery bits which are supposedly `reserved', 243 * but we seem to need to set them when the PHY 244 * is connected to some interfaces: 245 * 246 * 0x0400 is needed for fxp 247 * (Intel EtherExpress Pro 10+/100B, 82557 chip) 248 * (nsphy with a DP83840 chip) 249 * 0x0100 may be needed for some other card 250 */ 251 reg |= 0x0100 | 0x0400; 252 253 if (strcmp(mii->mii_ifp->if_dname, "fxp") == 0) 254 PHY_WRITE(sc, MII_NSPHY_PCR, reg); 255 256 mii_phy_setmedia(sc); 257 break; 258 259 case MII_TICK: 260 /* 261 * If we're not currently selected, just return. 262 */ 263 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 264 return (0); 265 if (mii_phy_tick(sc) == EJUSTRETURN) 266 return (0); 267 break; 268 } 269 270 /* Update the media status. */ 271 nsphy_status(sc); 272 273 /* Callback if something changed. */ 274 mii_phy_update(sc, cmd); 275 return (0); 276} 277 278static void 279nsphy_status(struct mii_softc *sc) 280{ 281 struct mii_data *mii = sc->mii_pdata; 282 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 283 int bmsr, bmcr, par, anlpar; 284 285 mii->mii_media_status = IFM_AVALID; 286 mii->mii_media_active = IFM_ETHER; 287 288 bmsr = PHY_READ(sc, MII_BMSR) | 289 PHY_READ(sc, MII_BMSR); 290 if (bmsr & BMSR_LINK) 291 mii->mii_media_status |= IFM_ACTIVE; 292 293 bmcr = PHY_READ(sc, MII_BMCR); 294 if (bmcr & BMCR_ISO) { 295 mii->mii_media_active |= IFM_NONE; 296 mii->mii_media_status = 0; 297 return; 298 } 299 300 if (bmcr & BMCR_LOOP) 301 mii->mii_media_active |= IFM_LOOP; 302 303 if (bmcr & BMCR_AUTOEN) { 304 /* 305 * The PAR status bits are only valid if autonegotiation 306 * has completed (or it's disabled). 307 */ 308 if ((bmsr & BMSR_ACOMP) == 0) { 309 /* Erg, still trying, I guess... */ 310 mii->mii_media_active |= IFM_NONE; 311 return; 312 } 313 314 /* 315 * Argh. The PAR doesn't seem to indicate duplex mode 316 * properly! Determine media based on link partner's 317 * advertised capabilities. 318 */ 319 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) { 320 anlpar = PHY_READ(sc, MII_ANAR) & 321 PHY_READ(sc, MII_ANLPAR); 322 if (anlpar & ANLPAR_TX_FD) 323 mii->mii_media_active |= IFM_100_TX|IFM_FDX; 324 else if (anlpar & ANLPAR_T4) 325 mii->mii_media_active |= IFM_100_T4; 326 else if (anlpar & ANLPAR_TX) 327 mii->mii_media_active |= IFM_100_TX; 328 else if (anlpar & ANLPAR_10_FD) 329 mii->mii_media_active |= IFM_10_T|IFM_FDX; 330 else if (anlpar & ANLPAR_10) 331 mii->mii_media_active |= IFM_10_T; 332 else 333 mii->mii_media_active |= IFM_NONE; 334 return; 335 } 336 337 /* 338 * Link partner is not capable of autonegotiation. 339 * We will never be in full-duplex mode if this is 340 * the case, so reading the PAR is OK. 341 */ 342 par = PHY_READ(sc, MII_NSPHY_PAR); 343 if (par & PAR_10) 344 mii->mii_media_active |= IFM_10_T; 345 else 346 mii->mii_media_active |= IFM_100_TX; 347#if 0 348 if (par & PAR_FDX) 349 mii->mii_media_active |= IFM_FDX; 350#endif 351 } else 352 mii->mii_media_active = ife->ifm_media; 353} 354 355static void 356nsphy_reset(struct mii_softc *sc) 357{ 358 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur; 359 int reg, i; 360 361 if (sc->mii_flags & MIIF_NOISOLATE) 362 reg = BMCR_RESET; 363 else 364 reg = BMCR_RESET | BMCR_ISO; 365 PHY_WRITE(sc, MII_BMCR, reg); 366 367 /* 368 * It is best to allow a little time for the reset to settle 369 * in before we start polling the BMCR again. Notably, the 370 * DP83840A manuals state that there should be a 500us delay 371 * between asserting software reset and attempting MII serial 372 * operations. Be conservative. 373 */ 374 DELAY(1000); 375 376 /* 377 * Wait another 2s for it to complete. 378 * This is only a little overkill as under normal circumstances 379 * the PHY can take up to 1s to complete reset. 380 * This is also a bit odd because after a reset, the BMCR will 381 * clear the reset bit and simply reports 0 even though the reset 382 * is not yet complete. 383 */ 384 for (i = 0; i < 1000; i++) { 385 reg = PHY_READ(sc, MII_BMCR); 386 if (reg != 0 && (reg & BMCR_RESET) == 0) 387 break; 388 DELAY(2000); 389 } 390 391 if ((sc->mii_flags & MIIF_NOISOLATE) == 0) { 392 if ((ife == NULL && sc->mii_inst != 0) || 393 (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst)) 394 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 395 } 396} 397