1 /* $OpenBSD: rlphy.c,v 1.23 2006/05/16 02:24:45 brad Exp $ */ 2 3 /* 4 * Copyright (c) 1997, 1998, 1999 5 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by Bill Paul. 18 * 4. Neither the name of the author nor the names of any co-contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 32 * THE POSSIBILITY OF SUCH DAMAGE. 33 * 34 * $FreeBSD: src/sys/dev/mii/rlphy.c,v 1.2.2.4 2002/11/08 21:53:49 semenu Exp $ 35 * $DragonFly: src/sys/dev/netif/mii_layer/rlphy.c,v 1.12 2006/12/22 23:26:20 swildner Exp $ 36 */ 37 38 /* 39 * driver for RealTek 8139 internal PHYs 40 */ 41 42 #include <sys/param.h> 43 #include <sys/systm.h> 44 #include <sys/kernel.h> 45 #include <sys/socket.h> 46 #include <sys/bus.h> 47 48 #include <net/if.h> 49 #include <net/if_arp.h> 50 #include <net/if_media.h> 51 52 #include "mii.h" 53 #include "miivar.h" 54 #include "miidevs.h" 55 56 #include "../rl/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 static int rlphy_service(struct mii_softc *, struct mii_data *, int); 63 static void rlphy_status(struct mii_softc *); 64 65 static device_method_t rlphy_methods[] = { 66 /* device interface */ 67 DEVMETHOD(device_probe, rlphy_probe), 68 DEVMETHOD(device_attach, rlphy_attach), 69 DEVMETHOD(device_detach, ukphy_detach), 70 DEVMETHOD(device_shutdown, bus_generic_shutdown), 71 { 0, 0 } 72 }; 73 74 static const struct mii_phydesc rlphys[] = { 75 MII_PHYDESC(REALTEK, RTL8201L), 76 MII_PHYDESC(ICPLUS, IP101), 77 MII_PHYDESC_NULL 78 }; 79 80 static devclass_t rlphy_devclass; 81 82 static driver_t rlphy_driver = { 83 "rlphy", 84 rlphy_methods, 85 sizeof(struct mii_softc) 86 }; 87 88 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0); 89 90 static int 91 rlphy_probe(device_t dev) 92 { 93 struct mii_attach_args *ma = device_get_ivars(dev); 94 const struct mii_phydesc *mpd; 95 device_t parent; 96 97 /* 98 * A "real" phy should get preference, but on the 8139 there 99 * is no phyid register. 100 */ 101 mpd = mii_phy_match(ma, rlphys); 102 if (mpd != NULL) { 103 device_set_desc(dev, mpd->mpd_name); 104 return (0); 105 } 106 107 /* 108 * RealTek PHY doesn't have vendor/device ID registers: 109 * the rl driver fakes up a return value of all zeros. 110 */ 111 if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 || 112 MII_MODEL(ma->mii_id2) != 0) 113 return (ENXIO); 114 115 parent = device_get_parent(device_get_parent(dev)); 116 117 /* 118 * Make sure the parent is an `rl'. 119 */ 120 if (strcmp(device_get_name(parent), "rl") != 0) 121 return (ENXIO); 122 123 device_set_desc(dev, "RealTek internal media interface"); 124 125 return (0); 126 } 127 128 static int 129 rlphy_attach(device_t dev) 130 { 131 struct mii_softc *sc; 132 struct mii_attach_args *ma; 133 struct mii_data *mii; 134 135 sc = device_get_softc(dev); 136 ma = device_get_ivars(dev); 137 mii_softc_init(sc, ma); 138 sc->mii_dev = device_get_parent(dev); 139 mii = device_get_softc(sc->mii_dev); 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_service = rlphy_service; 154 sc->mii_pdata = mii; 155 mii->mii_instance++; 156 157 sc->mii_flags |= MIIF_NOISOLATE; 158 159 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL) 160 161 #if 0 /* See above. */ 162 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst), 163 BMCR_ISO); 164 #endif 165 166 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 167 MII_MEDIA_100_TX); 168 169 mii_phy_reset(sc); 170 171 /* 172 * After PHY is reset, BMCR_AUTOEN will be cleared. 173 * If it is *not* turned on here, mii_pollstat() will 174 * lie about the active media until mii_mediachg() is 175 * called(in rl_init()). 176 */ 177 PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN); 178 179 sc->mii_capabilities = 180 PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 181 device_printf(dev, " "); 182 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0) 183 kprintf("no media present"); 184 else 185 mii_phy_add_media(sc); 186 kprintf("\n"); 187 #undef ADD 188 MIIBUS_MEDIAINIT(sc->mii_dev); 189 return(0); 190 } 191 192 static int 193 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 194 { 195 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 196 197 /* 198 * We can't isolate the RealTek PHY, so it has to be the only one! 199 */ 200 KASSERT(IFM_INST(ife->ifm_media) == sc->mii_inst, 201 ("rlphy_service: can't isolate RealTek PHY")); 202 203 switch (cmd) { 204 case MII_POLLSTAT: 205 break; 206 207 case MII_MEDIACHG: 208 /* 209 * If the interface is not up, don't do anything. 210 */ 211 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 212 break; 213 214 if (IFM_SUBTYPE(ife->ifm_media) == IFM_100_T4) { 215 /* 216 * XXX Not supported as a manual setting right now. 217 */ 218 return (EINVAL); 219 } 220 221 mii_phy_set_media(sc); 222 break; 223 224 case MII_TICK: 225 /* 226 * Is the interface even up? 227 */ 228 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 229 return (0); 230 231 /* 232 * Only used for autonegotiation. 233 */ 234 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) 235 break; 236 237 /* 238 * The RealTek PHY's autonegotiation doesn't need to be 239 * kicked; it continues in the background. 240 */ 241 break; 242 } 243 244 /* Update the media status. */ 245 rlphy_status(sc); 246 247 /* Callback if something changed. */ 248 mii_phy_update(sc, cmd); 249 return (0); 250 } 251 252 static void 253 rlphy_status(struct mii_softc *sc) 254 { 255 struct mii_data *mii = sc->mii_pdata; 256 int bmsr, bmcr, anlpar; 257 258 mii->mii_media_status = IFM_AVALID; 259 mii->mii_media_active = IFM_ETHER; 260 261 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR); 262 if (bmsr & BMSR_LINK) 263 mii->mii_media_status |= IFM_ACTIVE; 264 265 bmcr = PHY_READ(sc, MII_BMCR); 266 if (bmcr & BMCR_ISO) { 267 mii->mii_media_active |= IFM_NONE; 268 mii->mii_media_status = 0; 269 return; 270 } 271 272 if (bmcr & BMCR_LOOP) 273 mii->mii_media_active |= IFM_LOOP; 274 275 if (bmcr & BMCR_AUTOEN) { 276 device_t parent; 277 278 /* 279 * NWay autonegotiation takes the highest-order common 280 * bit of the ANAR and ANLPAR (i.e. best media advertised 281 * both by us and our link partner). 282 */ 283 if ((bmsr & BMSR_ACOMP) == 0) { 284 /* Erg, still trying, I guess... */ 285 mii->mii_media_active |= IFM_NONE; 286 return; 287 } 288 289 if ((anlpar = PHY_READ(sc, MII_ANAR) & 290 PHY_READ(sc, MII_ANLPAR))) { 291 if (anlpar & ANLPAR_T4) 292 mii->mii_media_active |= IFM_100_T4; 293 else if (anlpar & ANLPAR_TX_FD) 294 mii->mii_media_active |= IFM_100_TX|IFM_FDX; 295 else if (anlpar & ANLPAR_TX) 296 mii->mii_media_active |= IFM_100_TX; 297 else if (anlpar & ANLPAR_10_FD) 298 mii->mii_media_active |= IFM_10_T|IFM_FDX; 299 else if (anlpar & ANLPAR_10) 300 mii->mii_media_active |= IFM_10_T; 301 else 302 mii->mii_media_active |= IFM_NONE; 303 return; 304 } 305 /* 306 * If the other side doesn't support NWAY, then the 307 * best we can do is determine if we have a 10Mbps or 308 * 100Mbps link. There's no way to know if the link 309 * is full or half duplex, so we default to half duplex 310 * and hope that the user is clever enough to manually 311 * change the media settings if we're wrong. 312 */ 313 314 /* 315 * The RealTek PHY supports non-NWAY link speed 316 * detection, however it does not report the link 317 * detection results via the ANLPAR or BMSR registers. 318 * (What? RealTek doesn't do things the way everyone 319 * else does? I'm just shocked, shocked I tell you.) 320 * To determine the link speed, we have to do one 321 * of two things: 322 * 323 * - If this is a standalone RealTek RTL8201(L) PHY, 324 * we can determine the link speed by testing bit 0 325 * in the magic, vendor-specific register at offset 326 * 0x19. 327 * 328 * - If this is a RealTek MAC with integrated PHY, we 329 * can test the 'SPEED10' bit of the MAC's media status 330 * register. 331 */ 332 parent = device_get_parent(sc->mii_dev); 333 if (strcmp(device_get_name(parent), "rl") != 0) { 334 if (PHY_READ(sc, 0x0019) & 0x01) 335 mii->mii_media_active |= IFM_100_TX; 336 else 337 mii->mii_media_active |= IFM_10_T; 338 } else { 339 if (PHY_READ(sc, RL_MEDIASTAT) & 340 RL_MEDIASTAT_SPEED10) 341 mii->mii_media_active |= IFM_10_T; 342 else 343 mii->mii_media_active |= IFM_100_TX; 344 } 345 } else { 346 mii->mii_media_active = mii->mii_media.ifm_cur->ifm_media; 347 } 348 } 349