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 #include <sys/cdefs.h> 34 __FBSDID("$FreeBSD$"); 35 36 /* 37 * driver for RealTek 8139 internal PHYs 38 */ 39 40 #include <sys/param.h> 41 #include <sys/systm.h> 42 #include <sys/kernel.h> 43 #include <sys/module.h> 44 #include <sys/socket.h> 45 #include <sys/bus.h> 46 47 #include <net/if.h> 48 #include <net/if_arp.h> 49 #include <net/if_media.h> 50 51 #include <dev/mii/mii.h> 52 #include <dev/mii/miivar.h> 53 #include "miidevs.h" 54 55 #include <machine/bus.h> 56 #include <pci/if_rlreg.h> 57 58 #include "miibus_if.h" 59 60 struct rlphy_softc { 61 struct mii_softc sc_mii; /* generic PHY */ 62 int sc_is_RTL8201L; /* is an external RTL8201L PHY */ 63 }; 64 65 static int rlphy_probe(device_t); 66 static int rlphy_attach(device_t); 67 68 static device_method_t rlphy_methods[] = { 69 /* device interface */ 70 DEVMETHOD(device_probe, rlphy_probe), 71 DEVMETHOD(device_attach, rlphy_attach), 72 DEVMETHOD(device_detach, mii_phy_detach), 73 DEVMETHOD(device_shutdown, bus_generic_shutdown), 74 { 0, 0 } 75 }; 76 77 static devclass_t rlphy_devclass; 78 79 static driver_t rlphy_driver = { 80 "rlphy", 81 rlphy_methods, 82 sizeof(struct rlphy_softc) 83 }; 84 85 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0); 86 87 static int rlphy_service(struct mii_softc *, struct mii_data *, int); 88 static void rlphy_status(struct mii_softc *); 89 90 /* 91 * RealTek internal PHYs don't have vendor/device ID registers; 92 * re(4) and rl(4) fake up a return value of all zeros. 93 */ 94 static const struct mii_phydesc rlintphys[] = { 95 { 0, 0, "RealTek internal media interface" }, 96 MII_PHY_END 97 }; 98 99 static const struct mii_phydesc rlphys[] = { 100 MII_PHY_DESC(REALTEK, RTL8201L), 101 MII_PHY_END 102 }; 103 104 static int 105 rlphy_probe(device_t dev) 106 { 107 const char *nic; 108 int rv; 109 110 rv = mii_phy_dev_probe(dev, rlphys, BUS_PROBE_DEFAULT); 111 if (rv <= 0) 112 return (rv); 113 114 nic = device_get_name(device_get_parent(device_get_parent(dev))); 115 if (strcmp(nic, "rl") == 0 || strcmp(nic, "re") == 0) 116 return (mii_phy_dev_probe(dev, rlintphys, BUS_PROBE_DEFAULT)); 117 return (ENXIO); 118 } 119 120 static int 121 rlphy_attach(device_t dev) 122 { 123 struct mii_softc *sc; 124 struct mii_attach_args *ma; 125 struct mii_data *mii; 126 struct rlphy_softc *rsc; 127 128 sc = device_get_softc(dev); 129 ma = device_get_ivars(dev); 130 sc->mii_dev = device_get_parent(dev); 131 mii = device_get_softc(sc->mii_dev); 132 133 /* 134 * Check whether we're the RTL8201L PHY and remember so the status 135 * routine can query the proper register for speed detection. 136 */ 137 rsc = (struct rlphy_softc *)sc; 138 if (mii_phy_dev_probe(dev, rlphys, 0) == 0) 139 rsc->sc_is_RTL8201L++; 140 141 /* 142 * The RealTek PHY can never be isolated, so never allow non-zero 143 * instances! 144 */ 145 if (mii->mii_instance != 0) { 146 device_printf(dev, "ignoring this PHY, non-zero instance\n"); 147 return (ENXIO); 148 } 149 150 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 151 152 sc->mii_inst = mii->mii_instance; 153 sc->mii_phy = ma->mii_phyno; 154 sc->mii_service = rlphy_service; 155 sc->mii_pdata = mii; 156 mii->mii_instance++; 157 158 sc->mii_flags |= MIIF_NOISOLATE; 159 160 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 161 162 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 163 MII_MEDIA_100_TX); 164 165 mii_phy_reset(sc); 166 167 sc->mii_capabilities = 168 PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 169 device_printf(dev, " "); 170 mii_phy_add_media(sc); 171 printf("\n"); 172 #undef ADD 173 MIIBUS_MEDIAINIT(sc->mii_dev); 174 return (0); 175 } 176 177 static int 178 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 179 { 180 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 181 182 /* 183 * We can't isolate the RealTek PHY, so it has to be the only one! 184 */ 185 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 186 panic("rlphy_service: can't isolate RealTek PHY"); 187 188 switch (cmd) { 189 case MII_POLLSTAT: 190 break; 191 192 case MII_MEDIACHG: 193 /* 194 * If the interface is not up, don't do anything. 195 */ 196 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 197 break; 198 199 mii_phy_setmedia(sc); 200 break; 201 202 case MII_TICK: 203 /* 204 * Is the interface even up? 205 */ 206 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 207 return (0); 208 209 /* 210 * The RealTek PHY's autonegotiation doesn't need to be 211 * kicked; it continues in the background. 212 */ 213 break; 214 } 215 216 /* Update the media status. */ 217 rlphy_status(sc); 218 219 /* Callback if something changed. */ 220 mii_phy_update(sc, cmd); 221 return (0); 222 } 223 224 static void 225 rlphy_status(struct mii_softc *phy) 226 { 227 struct rlphy_softc *rsc =(struct rlphy_softc *)phy; 228 struct mii_data *mii = phy->mii_pdata; 229 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 230 int bmsr, bmcr, anlpar; 231 232 mii->mii_media_status = IFM_AVALID; 233 mii->mii_media_active = IFM_ETHER; 234 235 bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR); 236 if (bmsr & BMSR_LINK) 237 mii->mii_media_status |= IFM_ACTIVE; 238 239 bmcr = PHY_READ(phy, MII_BMCR); 240 if (bmcr & BMCR_ISO) { 241 mii->mii_media_active |= IFM_NONE; 242 mii->mii_media_status = 0; 243 return; 244 } 245 246 if (bmcr & BMCR_LOOP) 247 mii->mii_media_active |= IFM_LOOP; 248 249 if (bmcr & BMCR_AUTOEN) { 250 /* 251 * NWay autonegotiation takes the highest-order common 252 * bit of the ANAR and ANLPAR (i.e. best media advertised 253 * both by us and our link partner). 254 */ 255 if ((bmsr & BMSR_ACOMP) == 0) { 256 /* Erg, still trying, I guess... */ 257 mii->mii_media_active |= IFM_NONE; 258 return; 259 } 260 261 if ((anlpar = PHY_READ(phy, MII_ANAR) & 262 PHY_READ(phy, MII_ANLPAR))) { 263 if (anlpar & ANLPAR_T4) 264 mii->mii_media_active |= IFM_100_T4; 265 else if (anlpar & ANLPAR_TX_FD) 266 mii->mii_media_active |= IFM_100_TX|IFM_FDX; 267 else if (anlpar & ANLPAR_TX) 268 mii->mii_media_active |= IFM_100_TX; 269 else if (anlpar & ANLPAR_10_FD) 270 mii->mii_media_active |= IFM_10_T|IFM_FDX; 271 else if (anlpar & ANLPAR_10) 272 mii->mii_media_active |= IFM_10_T; 273 else 274 mii->mii_media_active |= IFM_NONE; 275 return; 276 } 277 /* 278 * If the other side doesn't support NWAY, then the 279 * best we can do is determine if we have a 10Mbps or 280 * 100Mbps link. There's no way to know if the link 281 * is full or half duplex, so we default to half duplex 282 * and hope that the user is clever enough to manually 283 * change the media settings if we're wrong. 284 */ 285 286 /* 287 * The RealTek PHY supports non-NWAY link speed 288 * detection, however it does not report the link 289 * detection results via the ANLPAR or BMSR registers. 290 * (What? RealTek doesn't do things the way everyone 291 * else does? I'm just shocked, shocked I tell you.) 292 * To determine the link speed, we have to do one 293 * of two things: 294 * 295 * - If this is a standalone RealTek RTL8201(L) PHY, 296 * we can determine the link speed by testing bit 0 297 * in the magic, vendor-specific register at offset 298 * 0x19. 299 * 300 * - If this is a RealTek MAC with integrated PHY, we 301 * can test the 'SPEED10' bit of the MAC's media status 302 * register. 303 */ 304 if (rsc->sc_is_RTL8201L) { 305 if (PHY_READ(phy, 0x0019) & 0x01) 306 mii->mii_media_active |= IFM_100_TX; 307 else 308 mii->mii_media_active |= IFM_10_T; 309 } else { 310 if (PHY_READ(phy, RL_MEDIASTAT) & 311 RL_MEDIASTAT_SPEED10) 312 mii->mii_media_active |= IFM_10_T; 313 else 314 mii->mii_media_active |= IFM_100_TX; 315 } 316 } else 317 mii->mii_media_active = ife->ifm_media; 318 } 319