1 /* $NetBSD: nsphyter.c,v 1.46 2020/03/28 18:37:18 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000, 2001 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 /* 58 * driver for National Semiconductor's DP83843 `PHYTER' ethernet 10/100 PHY 59 * Data Sheet available from www.national.com 60 * 61 * We also support the DP83815 MacPHYER internal PHY since, for our 62 * purposes, they are compatible. 63 */ 64 65 #include <sys/cdefs.h> 66 __KERNEL_RCSID(0, "$NetBSD: nsphyter.c,v 1.46 2020/03/28 18:37:18 thorpej Exp $"); 67 68 #include <sys/param.h> 69 #include <sys/systm.h> 70 #include <sys/kernel.h> 71 #include <sys/device.h> 72 #include <sys/socket.h> 73 #include <sys/errno.h> 74 75 #include <net/if.h> 76 #include <net/if_media.h> 77 78 #include <dev/mii/mii.h> 79 #include <dev/mii/miivar.h> 80 #include <dev/mii/miidevs.h> 81 82 #include <dev/mii/nsphyterreg.h> 83 84 static int nsphytermatch(device_t, cfdata_t, void *); 85 static void nsphyterattach(device_t, device_t, void *); 86 87 CFATTACH_DECL_NEW(nsphyter, sizeof(struct mii_softc), 88 nsphytermatch, nsphyterattach, mii_phy_detach, mii_phy_activate); 89 90 static int nsphyter_service(struct mii_softc *, struct mii_data *, int); 91 static void nsphyter_status(struct mii_softc *); 92 static void nsphyter_reset(struct mii_softc *); 93 94 static const struct mii_phy_funcs nsphyter_funcs = { 95 nsphyter_service, nsphyter_status, nsphyter_reset, 96 }; 97 98 static const struct mii_phydesc nsphyters[] = { 99 MII_PHY_DESC(xxNATSEMI, DP83843), 100 MII_PHY_DESC(xxNATSEMI, DP83847), 101 MII_PHY_DESC(xxNATSEMI, DP83849), 102 MII_PHY_DESC(xxNATSEMI, DP83815), 103 MII_PHY_END, 104 }; 105 106 static int 107 nsphytermatch(device_t parent, cfdata_t match, void *aux) 108 { 109 struct mii_attach_args *ma = aux; 110 111 if (mii_phy_match(ma, nsphyters) != NULL) 112 return 10; 113 114 return 0; 115 } 116 117 static void 118 nsphyterattach(device_t parent, device_t self, void *aux) 119 { 120 struct mii_softc *sc = device_private(self); 121 struct mii_attach_args *ma = aux; 122 struct mii_data *mii = ma->mii_data; 123 const struct mii_phydesc *mpd; 124 125 mpd = mii_phy_match(ma, nsphyters); 126 aprint_naive(": Media interface\n"); 127 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2)); 128 129 sc->mii_dev = self; 130 sc->mii_inst = mii->mii_instance; 131 sc->mii_phy = ma->mii_phyno; 132 sc->mii_funcs = &nsphyter_funcs; 133 sc->mii_pdata = mii; 134 sc->mii_flags = ma->mii_flags; 135 136 mii_lock(mii); 137 138 PHY_RESET(sc); 139 140 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities); 141 sc->mii_capabilities &= ma->mii_capmask; 142 143 mii_unlock(mii); 144 145 mii_phy_add_media(sc); 146 } 147 148 static int 149 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 150 { 151 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 152 uint16_t reg; 153 154 KASSERT(mii_locked(mii)); 155 156 switch (cmd) { 157 case MII_POLLSTAT: 158 /* If we're not polling our PHY instance, just return. */ 159 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 160 return 0; 161 break; 162 163 case MII_MEDIACHG: 164 /* 165 * If the media indicates a different PHY instance, 166 * isolate ourselves. 167 */ 168 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 169 PHY_READ(sc, MII_BMCR, ®); 170 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 171 return 0; 172 } 173 174 /* If the interface is not up, don't do anything. */ 175 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 176 break; 177 178 mii_phy_setmedia(sc); 179 break; 180 181 case MII_TICK: 182 /* If we're not currently selected, just return. */ 183 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 184 return 0; 185 186 if (mii_phy_tick(sc) == EJUSTRETURN) 187 return 0; 188 break; 189 190 case MII_DOWN: 191 mii_phy_down(sc); 192 return 0; 193 } 194 195 /* Update the media status. */ 196 mii_phy_status(sc); 197 198 /* Callback if something changed. */ 199 mii_phy_update(sc, cmd); 200 return 0; 201 } 202 203 static void 204 nsphyter_status(struct mii_softc *sc) 205 { 206 struct mii_data *mii = sc->mii_pdata; 207 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 208 uint16_t bmsr, bmcr, physts; 209 210 KASSERT(mii_locked(mii)); 211 212 mii->mii_media_status = IFM_AVALID; 213 mii->mii_media_active = IFM_ETHER; 214 215 PHY_READ(sc, MII_BMSR, &bmsr); 216 PHY_READ(sc, MII_BMSR, &bmsr); 217 PHY_READ(sc, MII_NSPHYTER_PHYSTS, &physts); 218 219 if (physts & PHYSTS_LINK) 220 mii->mii_media_status |= IFM_ACTIVE; 221 222 PHY_READ(sc, MII_BMCR, &bmcr); 223 if (bmcr & BMCR_ISO) { 224 mii->mii_media_active |= IFM_NONE; 225 mii->mii_media_status = 0; 226 return; 227 } 228 229 if (bmcr & BMCR_LOOP) 230 mii->mii_media_active |= IFM_LOOP; 231 232 if (bmcr & BMCR_AUTOEN) { 233 /* 234 * The media status bits are only valid if autonegotiation 235 * has completed (or it's disabled). 236 */ 237 if ((bmsr & BMSR_ACOMP) == 0) { 238 /* Erg, still trying, I guess... */ 239 mii->mii_media_active |= IFM_NONE; 240 return; 241 } 242 243 if (physts & PHYSTS_SPEED10) 244 mii->mii_media_active |= IFM_10_T; 245 else 246 mii->mii_media_active |= IFM_100_TX; 247 248 if (physts & PHYSTS_DUPLEX) 249 mii->mii_media_active |= 250 IFM_FDX | mii_phy_flowstatus(sc); 251 else 252 mii->mii_media_active |= IFM_HDX; 253 } else 254 mii->mii_media_active = ife->ifm_media; 255 } 256 257 static void 258 nsphyter_reset(struct mii_softc *sc) 259 { 260 int i; 261 uint16_t reg; 262 263 KASSERT(mii_locked(sc->mii_pdata)); 264 265 if (sc->mii_flags & MIIF_NOISOLATE) 266 reg = BMCR_RESET; 267 else 268 reg = BMCR_RESET | BMCR_ISO; 269 PHY_WRITE(sc, MII_BMCR, reg); 270 271 /* 272 * It is best to allow a little time for the reset to settle 273 * in before we start polling the BMCR again. Notably, the 274 * DP83840A manual states that there should be a 500us delay 275 * between asserting software reset and attempting MII serial 276 * operations. Also, a DP83815 can get into a bad state on 277 * cable removal and reinsertion if we do not delay here. 278 */ 279 delay(500); 280 281 /* Wait another 100ms for it to complete. */ 282 for (i = 0; i < 100; i++) { 283 PHY_READ(sc, MII_BMCR, ®); 284 if ((reg & BMCR_RESET) == 0) 285 break; 286 delay(1000); 287 } 288 289 if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0)) 290 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 291 } 292