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