1/*- 2 * SPDX-License-Identifier: BSD-4-Clause 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 35#include <sys/cdefs.h> 36__FBSDID("$FreeBSD$"); 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/module.h> 46#include <sys/socket.h> 47#include <sys/bus.h> 48#include <sys/taskqueue.h> /* XXXGL: if_rlreg.h contamination */ 49 50#include <net/if.h> 51#include <net/if_arp.h> 52#include <net/if_media.h> 53 54#include <dev/mii/mii.h> 55#include <dev/mii/miivar.h> 56#include "miidevs.h" 57 58#include <machine/bus.h> 59#include <dev/rl/if_rlreg.h> 60 61#include "miibus_if.h" 62 63static int rlphy_probe(device_t); 64static int rlphy_attach(device_t); 65 66static device_method_t rlphy_methods[] = { 67 /* device interface */ 68 DEVMETHOD(device_probe, rlphy_probe), 69 DEVMETHOD(device_attach, rlphy_attach), 70 DEVMETHOD(device_detach, mii_phy_detach), 71 DEVMETHOD(device_shutdown, bus_generic_shutdown), 72 DEVMETHOD_END 73}; 74 75static devclass_t rlphy_devclass; 76 77static driver_t rlphy_driver = { 78 "rlphy", 79 rlphy_methods, 80 sizeof(struct mii_softc) 81}; 82 83DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0); 84 85static int rlphy_service(struct mii_softc *, struct mii_data *, int); 86static void rlphy_status(struct mii_softc *); 87 88/* 89 * RealTek internal PHYs don't have vendor/device ID registers; 90 * re(4) and rl(4) fake up a return value of all zeros. 91 */ 92static const struct mii_phydesc rlintphys[] = { 93 { 0, 0, "RealTek internal media interface" }, 94 MII_PHY_END 95}; 96 97static const struct mii_phydesc rlphys[] = { 98 MII_PHY_DESC(yyREALTEK, RTL8201L), 99 MII_PHY_DESC(REALTEK, RTL8201E), 100 MII_PHY_DESC(xxICPLUS, IP101), 101 MII_PHY_END 102}; 103 104static const struct mii_phy_funcs rlphy_funcs = { 105 rlphy_service, 106 rlphy_status, 107 mii_phy_reset 108}; 109 110static int 111rlphy_probe(device_t dev) 112{ 113 int rv; 114 115 rv = mii_phy_dev_probe(dev, rlphys, BUS_PROBE_DEFAULT); 116 if (rv <= 0) 117 return (rv); 118 119 if (mii_dev_mac_match(dev, "rl") || mii_dev_mac_match(dev, "re")) 120 return (mii_phy_dev_probe(dev, rlintphys, BUS_PROBE_DEFAULT)); 121 return (ENXIO); 122} 123 124static int 125rlphy_attach(device_t dev) 126{ 127 128 /* 129 * The RealTek PHY can never be isolated. 130 */ 131 mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE, 132 &rlphy_funcs, 1); 133 return (0); 134} 135 136static int 137rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 138{ 139 140 switch (cmd) { 141 case MII_POLLSTAT: 142 break; 143 144 case MII_MEDIACHG: 145 mii_phy_setmedia(sc); 146 break; 147 148 case MII_TICK: 149 /* 150 * The RealTek PHY's autonegotiation doesn't need to be 151 * kicked; it continues in the background. 152 */ 153 break; 154 } 155 156 /* Update the media status. */ 157 PHY_STATUS(sc); 158 159 /* Callback if something changed. */ 160 mii_phy_update(sc, cmd); 161 return (0); 162} 163 164static void 165rlphy_status(struct mii_softc *phy) 166{ 167 struct mii_data *mii = phy->mii_pdata; 168 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 169 int bmsr, bmcr, anlpar; 170 171 mii->mii_media_status = IFM_AVALID; 172 mii->mii_media_active = IFM_ETHER; 173 174 bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR); 175 if (bmsr & BMSR_LINK) 176 mii->mii_media_status |= IFM_ACTIVE; 177 178 bmcr = PHY_READ(phy, MII_BMCR); 179 if (bmcr & BMCR_ISO) { 180 mii->mii_media_active |= IFM_NONE; 181 mii->mii_media_status = 0; 182 return; 183 } 184 185 if (bmcr & BMCR_LOOP) 186 mii->mii_media_active |= IFM_LOOP; 187 188 if (bmcr & BMCR_AUTOEN) { 189 /* 190 * NWay autonegotiation takes the highest-order common 191 * bit of the ANAR and ANLPAR (i.e. best media advertised 192 * both by us and our link partner). 193 */ 194 if ((bmsr & BMSR_ACOMP) == 0) { 195 /* Erg, still trying, I guess... */ 196 mii->mii_media_active |= IFM_NONE; 197 return; 198 } 199 200 if ((anlpar = PHY_READ(phy, MII_ANAR) & 201 PHY_READ(phy, MII_ANLPAR))) { 202 if (anlpar & ANLPAR_TX_FD) 203 mii->mii_media_active |= IFM_100_TX|IFM_FDX; 204 else if (anlpar & ANLPAR_T4) 205 mii->mii_media_active |= IFM_100_T4|IFM_HDX; 206 else if (anlpar & ANLPAR_TX) 207 mii->mii_media_active |= IFM_100_TX|IFM_HDX; 208 else if (anlpar & ANLPAR_10_FD) 209 mii->mii_media_active |= IFM_10_T|IFM_FDX; 210 else if (anlpar & ANLPAR_10) 211 mii->mii_media_active |= IFM_10_T|IFM_HDX; 212 else 213 mii->mii_media_active |= IFM_NONE; 214 if ((mii->mii_media_active & IFM_FDX) != 0) 215 mii->mii_media_active |= 216 mii_phy_flowstatus(phy); 217 return; 218 } 219 /* 220 * If the other side doesn't support NWAY, then the 221 * best we can do is determine if we have a 10Mbps or 222 * 100Mbps link. There's no way to know if the link 223 * is full or half duplex, so we default to half duplex 224 * and hope that the user is clever enough to manually 225 * change the media settings if we're wrong. 226 */ 227 228 /* 229 * The RealTek PHY supports non-NWAY link speed 230 * detection, however it does not report the link 231 * detection results via the ANLPAR or BMSR registers. 232 * (What? RealTek doesn't do things the way everyone 233 * else does? I'm just shocked, shocked I tell you.) 234 * To determine the link speed, we have to do one 235 * of two things: 236 * 237 * - If this is a standalone RealTek RTL8201(L) or 238 * workalike PHY, we can determine the link speed by 239 * testing bit 0 in the magic, vendor-specific register 240 * at offset 0x19. 241 * 242 * - If this is a RealTek MAC with integrated PHY, we 243 * can test the 'SPEED10' bit of the MAC's media status 244 * register. 245 */ 246 if (!(phy->mii_mpd_model == 0 && phy->mii_mpd_rev == 0)) { 247 if (PHY_READ(phy, 0x0019) & 0x01) 248 mii->mii_media_active |= IFM_100_TX; 249 else 250 mii->mii_media_active |= IFM_10_T; 251 } else { 252 if (PHY_READ(phy, RL_MEDIASTAT) & 253 RL_MEDIASTAT_SPEED10) 254 mii->mii_media_active |= IFM_10_T; 255 else 256 mii->mii_media_active |= IFM_100_TX; 257 } 258 mii->mii_media_active |= IFM_HDX; 259 } else 260 mii->mii_media_active = ife->ifm_media; 261} 262