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 static int rlphy_probe(device_t); 61 static int rlphy_attach(device_t); 62 63 static device_method_t rlphy_methods[] = { 64 /* device interface */ 65 DEVMETHOD(device_probe, rlphy_probe), 66 DEVMETHOD(device_attach, rlphy_attach), 67 DEVMETHOD(device_detach, mii_phy_detach), 68 DEVMETHOD(device_shutdown, bus_generic_shutdown), 69 { 0, 0 } 70 }; 71 72 static devclass_t rlphy_devclass; 73 74 static driver_t rlphy_driver = { 75 "rlphy", 76 rlphy_methods, 77 sizeof(struct mii_softc) 78 }; 79 80 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0); 81 82 static int rlphy_service(struct mii_softc *, struct mii_data *, int); 83 static void rlphy_status(struct mii_softc *); 84 85 static int 86 rlphy_probe(device_t dev) 87 { 88 struct mii_attach_args *ma; 89 device_t parent; 90 91 ma = device_get_ivars(dev); 92 parent = device_get_parent(device_get_parent(dev)); 93 94 /* Test for RealTek 8201L PHY */ 95 if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_REALTEK && 96 MII_MODEL(ma->mii_id2) == MII_MODEL_REALTEK_RTL8201L) { 97 device_set_desc(dev, MII_STR_REALTEK_RTL8201L); 98 return(0); 99 } 100 101 /* 102 * RealTek PHY doesn't have vendor/device ID registers: 103 * the rl driver fakes up a return value of all zeros. 104 */ 105 if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 || 106 MII_MODEL(ma->mii_id2) != 0) 107 return (ENXIO); 108 109 /* 110 * Make sure the parent is an `rl' or an `re'. 111 */ 112 if (strcmp(device_get_name(parent), "rl") != 0 && 113 strcmp(device_get_name(parent), "re") != 0) 114 return (ENXIO); 115 116 device_set_desc(dev, "RealTek internal media interface"); 117 118 return (0); 119 } 120 121 static int 122 rlphy_attach(device_t dev) 123 { 124 struct mii_softc *sc; 125 struct mii_attach_args *ma; 126 struct mii_data *mii; 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 * The RealTek PHY can never be isolated, so never allow non-zero 135 * instances! 136 */ 137 if (mii->mii_instance != 0) { 138 device_printf(dev, "ignoring this PHY, non-zero instance\n"); 139 return(ENXIO); 140 } 141 142 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 143 144 sc->mii_inst = mii->mii_instance; 145 sc->mii_phy = ma->mii_phyno; 146 sc->mii_service = rlphy_service; 147 sc->mii_pdata = mii; 148 mii->mii_instance++; 149 150 sc->mii_flags |= MIIF_NOISOLATE; 151 152 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 153 154 #if 0 /* See above. */ 155 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst), 156 BMCR_ISO); 157 #endif 158 159 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 160 BMCR_LOOP|BMCR_S100); 161 162 mii_phy_reset(sc); 163 164 sc->mii_capabilities = 165 PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 166 device_printf(dev, " "); 167 mii_add_media(sc); 168 printf("\n"); 169 #undef ADD 170 MIIBUS_MEDIAINIT(sc->mii_dev); 171 return(0); 172 } 173 174 static int 175 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 176 { 177 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 178 179 /* 180 * We can't isolate the RealTek PHY, so it has to be the only one! 181 */ 182 if (IFM_INST(ife->ifm_media) != sc->mii_inst) 183 panic("rlphy_service: can't isolate RealTek PHY"); 184 185 switch (cmd) { 186 case MII_POLLSTAT: 187 break; 188 189 case MII_MEDIACHG: 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 switch (IFM_SUBTYPE(ife->ifm_media)) { 197 case IFM_AUTO: 198 /* 199 * If we're already in auto mode, just return. 200 */ 201 if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN) 202 return (0); 203 (void) mii_phy_auto(sc); 204 break; 205 case IFM_100_T4: 206 /* 207 * XXX Not supported as a manual setting right now. 208 */ 209 return (EINVAL); 210 default: 211 /* 212 * BMCR data is stored in the ifmedia entry. 213 */ 214 PHY_WRITE(sc, MII_ANAR, 215 mii_anar(ife->ifm_media)); 216 PHY_WRITE(sc, MII_BMCR, ife->ifm_data); 217 } 218 break; 219 220 case MII_TICK: 221 /* 222 * Is the interface even up? 223 */ 224 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 225 return (0); 226 227 /* 228 * Only used for autonegotiation. 229 */ 230 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) 231 break; 232 233 /* 234 * The RealTek PHY's autonegotiation doesn't need to be 235 * kicked; it continues in the background. 236 */ 237 break; 238 } 239 240 /* Update the media status. */ 241 rlphy_status(sc); 242 243 /* Callback if something changed. */ 244 mii_phy_update(sc, cmd); 245 return (0); 246 } 247 248 static void 249 rlphy_status(struct mii_softc *phy) 250 { 251 struct mii_data *mii = phy->mii_pdata; 252 int bmsr, bmcr, anlpar; 253 device_t parent; 254 255 mii->mii_media_status = IFM_AVALID; 256 mii->mii_media_active = IFM_ETHER; 257 258 bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR); 259 if (bmsr & BMSR_LINK) 260 mii->mii_media_status |= IFM_ACTIVE; 261 262 bmcr = PHY_READ(phy, MII_BMCR); 263 if (bmcr & BMCR_ISO) { 264 mii->mii_media_active |= IFM_NONE; 265 mii->mii_media_status = 0; 266 return; 267 } 268 269 if (bmcr & BMCR_LOOP) 270 mii->mii_media_active |= IFM_LOOP; 271 272 if (bmcr & BMCR_AUTOEN) { 273 /* 274 * NWay autonegotiation takes the highest-order common 275 * bit of the ANAR and ANLPAR (i.e. best media advertised 276 * both by us and our link partner). 277 */ 278 if ((bmsr & BMSR_ACOMP) == 0) { 279 /* Erg, still trying, I guess... */ 280 mii->mii_media_active |= IFM_NONE; 281 return; 282 } 283 284 if ((anlpar = PHY_READ(phy, MII_ANAR) & 285 PHY_READ(phy, MII_ANLPAR))) { 286 if (anlpar & ANLPAR_T4) 287 mii->mii_media_active |= IFM_100_T4; 288 else if (anlpar & ANLPAR_TX_FD) 289 mii->mii_media_active |= IFM_100_TX|IFM_FDX; 290 else if (anlpar & ANLPAR_TX) 291 mii->mii_media_active |= IFM_100_TX; 292 else if (anlpar & ANLPAR_10_FD) 293 mii->mii_media_active |= IFM_10_T|IFM_FDX; 294 else if (anlpar & ANLPAR_10) 295 mii->mii_media_active |= IFM_10_T; 296 else 297 mii->mii_media_active |= IFM_NONE; 298 return; 299 } 300 /* 301 * If the other side doesn't support NWAY, then the 302 * best we can do is determine if we have a 10Mbps or 303 * 100Mbps link. There's no way to know if the link 304 * is full or half duplex, so we default to half duplex 305 * and hope that the user is clever enough to manually 306 * change the media settings if we're wrong. 307 */ 308 309 310 /* 311 * The RealTek PHY supports non-NWAY link speed 312 * detection, however it does not report the link 313 * detection results via the ANLPAR or BMSR registers. 314 * (What? RealTek doesn't do things the way everyone 315 * else does? I'm just shocked, shocked I tell you.) 316 * To determine the link speed, we have to do one 317 * of two things: 318 * 319 * - If this is a standalone RealTek RTL8201(L) PHY, 320 * we can determine the link speed by testing bit 0 321 * in the magic, vendor-specific register at offset 322 * 0x19. 323 * 324 * - If this is a RealTek MAC with integrated PHY, we 325 * can test the 'SPEED10' bit of the MAC's media status 326 * register. 327 */ 328 parent = device_get_parent(phy->mii_dev); 329 if (strcmp(device_get_name(parent), "rl") != 0) { 330 if (PHY_READ(phy, 0x0019) & 0x01) 331 mii->mii_media_active |= IFM_100_TX; 332 else 333 mii->mii_media_active |= IFM_10_T; 334 } else { 335 if (PHY_READ(phy, RL_MEDIASTAT) & 336 RL_MEDIASTAT_SPEED10) 337 mii->mii_media_active |= IFM_10_T; 338 else 339 mii->mii_media_active |= IFM_100_TX; 340 } 341 342 } else 343 mii->mii_media_active = mii_media_from_bmcr(bmcr); 344 } 345