1 /* $NetBSD: nsphy.c,v 1.50 2007/12/09 20:28:04 jmcneill Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000 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 40 /* 41 * Copyright (c) 1997 Manuel Bouyer. All rights reserved. 42 * 43 * Redistribution and use in source and binary forms, with or without 44 * modification, are permitted provided that the following conditions 45 * are met: 46 * 1. Redistributions of source code must retain the above copyright 47 * notice, this list of conditions and the following disclaimer. 48 * 2. Redistributions in binary form must reproduce the above copyright 49 * notice, this list of conditions and the following disclaimer in the 50 * documentation and/or other materials provided with the distribution. 51 * 3. All advertising materials mentioning features or use of this software 52 * must display the following acknowledgement: 53 * This product includes software developed by Manuel Bouyer. 54 * 4. The name of the author may not be used to endorse or promote products 55 * derived from this software without specific prior written permission. 56 * 57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 62 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 63 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 64 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 66 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 67 */ 68 69 /* 70 * driver for National Semiconductor's DP83840A ethernet 10/100 PHY 71 * Data Sheet available from www.national.com 72 */ 73 74 #include <sys/cdefs.h> 75 __KERNEL_RCSID(0, "$NetBSD: nsphy.c,v 1.50 2007/12/09 20:28:04 jmcneill Exp $"); 76 77 #include <sys/param.h> 78 #include <sys/systm.h> 79 #include <sys/kernel.h> 80 #include <sys/device.h> 81 #include <sys/socket.h> 82 #include <sys/errno.h> 83 84 #include <net/if.h> 85 #include <net/if_media.h> 86 87 #include <dev/mii/mii.h> 88 #include <dev/mii/miivar.h> 89 #include <dev/mii/miidevs.h> 90 91 #include <dev/mii/nsphyreg.h> 92 93 static int nsphymatch(struct device *, struct cfdata *, void *); 94 static void nsphyattach(struct device *, struct device *, void *); 95 96 CFATTACH_DECL(nsphy, sizeof(struct mii_softc), 97 nsphymatch, nsphyattach, mii_phy_detach, mii_phy_activate); 98 99 static int nsphy_service(struct mii_softc *, struct mii_data *, int); 100 static void nsphy_status(struct mii_softc *); 101 static void nsphy_reset(struct mii_softc *sc); 102 103 static const struct mii_phy_funcs nsphy_funcs = { 104 nsphy_service, nsphy_status, nsphy_reset, 105 }; 106 107 static const struct mii_phydesc nsphys[] = { 108 { MII_OUI_xxNATSEMI, MII_MODEL_xxNATSEMI_DP83840, 109 MII_STR_xxNATSEMI_DP83840 }, 110 111 { 0, 0, 112 NULL }, 113 }; 114 115 static int 116 nsphymatch(struct device *parent, struct cfdata *match, 117 void *aux) 118 { 119 struct mii_attach_args *ma = aux; 120 121 if (mii_phy_match(ma, nsphys) != NULL) 122 return (10); 123 124 return (0); 125 } 126 127 static void 128 nsphyattach(struct device *parent, struct device *self, void *aux) 129 { 130 struct mii_softc *sc = device_private(self); 131 struct mii_attach_args *ma = aux; 132 struct mii_data *mii = ma->mii_data; 133 const struct mii_phydesc *mpd; 134 135 mpd = mii_phy_match(ma, nsphys); 136 aprint_naive(": Media interface\n"); 137 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2)); 138 139 sc->mii_inst = mii->mii_instance; 140 sc->mii_phy = ma->mii_phyno; 141 sc->mii_funcs = &nsphy_funcs; 142 sc->mii_pdata = mii; 143 sc->mii_flags = ma->mii_flags; 144 sc->mii_anegticks = MII_ANEGTICKS; 145 146 PHY_RESET(sc); 147 148 sc->mii_capabilities = 149 PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 150 aprint_normal("%s: ", sc->mii_dev.dv_xname); 151 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0) 152 aprint_error("no media present"); 153 else 154 mii_phy_add_media(sc); 155 aprint_normal("\n"); 156 157 if (!pmf_device_register(self, NULL, mii_phy_resume)) 158 aprint_error_dev(self, "couldn't establish power handler\n"); 159 } 160 161 static int 162 nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 163 { 164 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 165 int reg; 166 167 if (!device_is_active(&sc->mii_dev)) 168 return (ENXIO); 169 170 switch (cmd) { 171 case MII_POLLSTAT: 172 /* 173 * If we're not polling our PHY instance, just return. 174 */ 175 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 176 return (0); 177 break; 178 179 case MII_MEDIACHG: 180 /* 181 * If the media indicates a different PHY instance, 182 * isolate ourselves. 183 */ 184 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 185 reg = PHY_READ(sc, MII_BMCR); 186 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 187 return (0); 188 } 189 190 /* 191 * If the interface is not up, don't do anything. 192 */ 193 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 194 break; 195 196 reg = PHY_READ(sc, MII_NSPHY_PCR); 197 198 /* 199 * Set up the PCR to use LED4 to indicate full-duplex 200 * in both 10baseT and 100baseTX modes. 201 */ 202 reg |= PCR_LED4MODE; 203 204 /* 205 * Make sure Carrier Integrity Monitor function is 206 * disabled (normal for Node operation, but sometimes 207 * it's not set?!) 208 */ 209 reg |= PCR_CIMDIS; 210 211 /* 212 * Make sure "force link good" is set to normal mode. 213 * It's only intended for debugging. 214 */ 215 reg |= PCR_FLINK100; 216 217 /* 218 * Mystery bits which are supposedly `reserved', 219 * but we seem to need to set them when the PHY 220 * is connected to some interfaces: 221 * 222 * 0x0400 is needed for fxp 223 * (Intel EtherExpress Pro 10+/100B, 82557 chip) 224 * (nsphy with a DP83840 chip) 225 * 0x0100 may be needed for some other card 226 */ 227 reg |= 0x0100 | 0x0400; 228 229 PHY_WRITE(sc, MII_NSPHY_PCR, reg); 230 231 mii_phy_setmedia(sc); 232 break; 233 234 case MII_TICK: 235 /* 236 * If we're not currently selected, just return. 237 */ 238 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 239 return (0); 240 241 if (mii_phy_tick(sc) == EJUSTRETURN) 242 return (0); 243 break; 244 245 case MII_DOWN: 246 mii_phy_down(sc); 247 return (0); 248 } 249 250 /* Update the media status. */ 251 mii_phy_status(sc); 252 253 /* Callback if something changed. */ 254 mii_phy_update(sc, cmd); 255 return (0); 256 } 257 258 static void 259 nsphy_status(struct mii_softc *sc) 260 { 261 struct mii_data *mii = sc->mii_pdata; 262 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 263 int bmsr, bmcr, par, anlpar; 264 265 mii->mii_media_status = IFM_AVALID; 266 mii->mii_media_active = IFM_ETHER; 267 268 bmsr = PHY_READ(sc, MII_BMSR) | 269 PHY_READ(sc, MII_BMSR); 270 if (bmsr & BMSR_LINK) 271 mii->mii_media_status |= IFM_ACTIVE; 272 273 bmcr = PHY_READ(sc, MII_BMCR); 274 if (bmcr & BMCR_ISO) { 275 mii->mii_media_active |= IFM_NONE; 276 mii->mii_media_status = 0; 277 return; 278 } 279 280 if (bmcr & BMCR_LOOP) 281 mii->mii_media_active |= IFM_LOOP; 282 283 if (bmcr & BMCR_AUTOEN) { 284 /* 285 * The PAR status bits are only valid of autonegotiation 286 * has completed (or it's disabled). 287 */ 288 if ((bmsr & BMSR_ACOMP) == 0) { 289 /* Erg, still trying, I guess... */ 290 mii->mii_media_active |= IFM_NONE; 291 return; 292 } 293 294 /* 295 * Argh. The PAR doesn't seem to indicate duplex mode 296 * properly! Determine media based on link partner's 297 * advertised capabilities. 298 */ 299 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) { 300 anlpar = PHY_READ(sc, MII_ANAR) & 301 PHY_READ(sc, MII_ANLPAR); 302 if (anlpar & ANLPAR_T4) 303 mii->mii_media_active |= IFM_100_T4; 304 else if (anlpar & ANLPAR_TX_FD) 305 mii->mii_media_active |= IFM_100_TX|IFM_FDX; 306 else if (anlpar & ANLPAR_TX) 307 mii->mii_media_active |= IFM_100_TX; 308 else if (anlpar & ANLPAR_10_FD) 309 mii->mii_media_active |= IFM_10_T|IFM_FDX; 310 else if (anlpar & ANLPAR_10) 311 mii->mii_media_active |= IFM_10_T; 312 else 313 mii->mii_media_active |= IFM_NONE; 314 return; 315 } 316 317 /* 318 * Link partner is not capable of autonegotiation. 319 * We will never be in full-duplex mode if this is 320 * the case, so reading the PAR is OK. 321 */ 322 par = PHY_READ(sc, MII_NSPHY_PAR); 323 if (par & PAR_10) 324 mii->mii_media_active |= IFM_10_T; 325 else 326 mii->mii_media_active |= IFM_100_TX; 327 #if 0 328 if (par & PAR_FDX) 329 mii->mii_media_active |= IFM_FDX; 330 #endif 331 } else 332 mii->mii_media_active = ife->ifm_media; 333 } 334 335 static void 336 nsphy_reset(struct mii_softc *sc) 337 { 338 int reg, i; 339 340 if (sc->mii_flags & MIIF_NOISOLATE) 341 reg = BMCR_RESET; 342 else 343 reg = BMCR_RESET | BMCR_ISO; 344 PHY_WRITE(sc, MII_BMCR, reg); 345 346 /* 347 * Give it a little time to settle in case we just got power. 348 * The DP83840A data sheet suggests that a soft reset not happen 349 * within 500us of power being applied. Be conservative. 350 */ 351 delay(1000); 352 353 /* 354 * Wait another 2s for it to complete. 355 * This is only a little overkill as under normal circumstances 356 * the PHY can take up to 1s to complete reset. 357 * This is also a bit odd because after a reset, the BMCR will 358 * clear the reset bit and simply reports 0 even though the reset 359 * is not yet complete. 360 */ 361 for (i = 0; i < 1000; i++) { 362 reg = PHY_READ(sc, MII_BMCR); 363 if (reg && ((reg & BMCR_RESET) == 0)) 364 break; 365 delay(2000); 366 } 367 368 if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0)) { 369 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 370 } 371 } 372