Home | History | Annotate | Line # | Download | only in mii
rlphy.c revision 1.30.18.2
      1 /*	$NetBSD: rlphy.c,v 1.30.18.2 2020/04/08 14:08:08 martin Exp $	*/
      2 /*	$OpenBSD: rlphy.c,v 1.20 2005/07/31 05:27:30 pvalchev Exp $	*/
      3 
      4 /*
      5  * Copyright (c) 1998, 1999 Jason L. Wright (jason (at) thought.net)
      6  * All rights reserved.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     20  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
     21  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     26  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     27  * POSSIBILITY OF SUCH DAMAGE.
     28  */
     29 
     30 /*
     31  * Driver for the internal PHY found on RTL8139 based nics, based
     32  * on drivers for the 'exphy' (Internal 3Com phys) and 'nsphy'
     33  * (National Semiconductor DP83840).
     34  */
     35 
     36 /*
     37  * Ported to NetBSD by Juan Romero Pardines <xtraeme (at) NetBSD.org>
     38  */
     39 
     40 #include <sys/cdefs.h>
     41 __KERNEL_RCSID(0, "$NetBSD: rlphy.c,v 1.30.18.2 2020/04/08 14:08:08 martin Exp $");
     42 
     43 #include <sys/param.h>
     44 #include <sys/systm.h>
     45 #include <sys/kernel.h>
     46 #include <sys/device.h>
     47 #include <sys/socket.h>
     48 #include <sys/errno.h>
     49 
     50 #include <net/if.h>
     51 #include <net/if_media.h>
     52 
     53 #include <dev/mii/mii.h>
     54 #include <dev/mii/miivar.h>
     55 #include <dev/mii/miidevs.h>
     56 #include <sys/bus.h>
     57 #include <dev/ic/rtl81x9reg.h>
     58 
     59 struct rlphy_softc {
     60 	struct mii_softc sc_mii;
     61 	int sc_rtl8201;
     62 };
     63 
     64 static int	rlphymatch(device_t, cfdata_t, void *);
     65 static void	rlphyattach(device_t, device_t, void *);
     66 
     67 CFATTACH_DECL_NEW(rlphy, sizeof(struct rlphy_softc),
     68     rlphymatch, rlphyattach, mii_phy_detach, mii_phy_activate);
     69 
     70 static int	rlphy_service(struct mii_softc *, struct mii_data *, int);
     71 static void	rlphy_status(struct mii_softc *);
     72 static void	rlphy_reset(struct mii_softc *);
     73 
     74 const struct mii_phy_funcs rlphy_funcs = {
     75 	rlphy_service, rlphy_status, rlphy_reset,
     76 };
     77 
     78 static const struct mii_phydesc rlphys[] = {
     79 	MII_PHY_DESC(yyREALTEK, RTL8201L),
     80 	MII_PHY_DESC(REALTEK, RTL8201E),
     81 	MII_PHY_DESC(ICPLUS, IP101),
     82 	MII_PHY_END,
     83 };
     84 
     85 static int
     86 rlphymatch(device_t parent, cfdata_t match, void *aux)
     87 {
     88 	struct mii_attach_args *ma = aux;
     89 	struct mii_data *mii = ma->mii_data;
     90 
     91 	if (mii->mii_instance != 0)
     92 		return 0;
     93 
     94 	if (mii_phy_match(ma, rlphys) != NULL)
     95 		return 10;
     96 
     97 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
     98 	    MII_MODEL(ma->mii_id2) != 0)
     99 		return 0;
    100 
    101 	if (!device_is_a(parent, "rtk") && !device_is_a(parent, "re"))
    102 		return 0;
    103 
    104 	/*
    105 	 * A "real" phy should get preference, but on the 8139 there
    106 	 * is no phyid register.
    107 	 */
    108 	return 5;
    109 }
    110 
    111 static void
    112 rlphyattach(device_t parent, device_t self, void *aux)
    113 {
    114 	struct rlphy_softc *rsc = device_private(self);
    115 	struct mii_softc *sc = &rsc->sc_mii;
    116 	struct mii_attach_args *ma = aux;
    117 	struct mii_data *mii = ma->mii_data;
    118 
    119 	aprint_naive("\n");
    120 	if (MII_MODEL(ma->mii_id2) == MII_MODEL_yyREALTEK_RTL8201L) {
    121 		rsc->sc_rtl8201 = 1;
    122 		aprint_normal(": %s, rev. %d\n", MII_STR_yyREALTEK_RTL8201L,
    123 		    MII_REV(ma->mii_id2));
    124 	} else if (MII_MODEL(ma->mii_id2) == MII_MODEL_REALTEK_RTL8201E) {
    125 		rsc->sc_rtl8201 = 1;
    126 		aprint_normal(": %s, rev. %d\n", MII_STR_REALTEK_RTL8201E,
    127 		    MII_REV(ma->mii_id2));
    128 	} else
    129 		aprint_normal(": Realtek internal PHY\n");
    130 
    131 	sc->mii_dev = self;
    132 	sc->mii_inst = mii->mii_instance;
    133 	sc->mii_phy = ma->mii_phyno;
    134 	sc->mii_funcs = &rlphy_funcs;
    135 	sc->mii_pdata = mii;
    136 	sc->mii_flags = ma->mii_flags;
    137 
    138 	sc->mii_flags |= MIIF_NOISOLATE;
    139 
    140 	mii_lock(mii);
    141 
    142 	PHY_RESET(sc);
    143 
    144 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    145 	sc->mii_capabilities &= ma->mii_capmask;
    146 
    147 	mii_unlock(mii);
    148 
    149 	mii_phy_add_media(sc);
    150 }
    151 
    152 static int
    153 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    154 {
    155 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    156 
    157 	/* Can't isolate the RTL8139 phy, so it has to be the only one. */
    158 	if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    159 		panic("rlphy_service: attempt to isolate phy");
    160 
    161 	KASSERT(mii_locked(mii));
    162 
    163 	switch (cmd) {
    164 	case MII_POLLSTAT:
    165 		break;
    166 
    167 	case MII_MEDIACHG:
    168 		/* If the interface is not up, don't do anything. */
    169 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    170 			break;
    171 
    172 		mii_phy_setmedia(sc);
    173 		break;
    174 
    175 	case MII_TICK:
    176 		/* Is the interface even up? */
    177 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    178 			return 0;
    179 
    180 		/* Only used for autonegotiation. */
    181 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
    182 			break;
    183 
    184 		/*
    185 		 * The RealTek PHY's autonegotiation doesn't need to be
    186 		 * kicked; it continues in the background.
    187 		 */
    188 		break;
    189 
    190 	case MII_DOWN:
    191 		mii_phy_down(sc);
    192 		return 0;
    193 	}
    194 
    195 	/* Update the media status. */
    196 	mii_phy_status(sc);
    197 
    198 	/* Callback if something changed. */
    199 	mii_phy_update(sc, cmd);
    200 	return 0;
    201 }
    202 
    203 static void
    204 rlphy_status(struct mii_softc *sc)
    205 {
    206 	struct rlphy_softc *rsc = (void *)sc;
    207 	struct mii_data *mii = sc->mii_pdata;
    208 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    209 	uint16_t bmsr, bmcr, anar, anlpar, result, reg;
    210 
    211 	KASSERT(mii_locked(mii));
    212 
    213 	mii->mii_media_status = IFM_AVALID;
    214 	mii->mii_media_active = IFM_ETHER;
    215 
    216 	PHY_READ(sc, MII_BMSR, &bmsr);
    217 	PHY_READ(sc, MII_BMSR, &bmsr);
    218 	if (bmsr & BMSR_LINK)
    219 		mii->mii_media_status |= IFM_ACTIVE;
    220 
    221 	PHY_READ(sc, MII_BMCR, &bmcr);
    222 	if (bmcr & BMCR_ISO) {
    223 		mii->mii_media_active |= IFM_NONE;
    224 		mii->mii_media_status = 0;
    225 		return;
    226 	}
    227 
    228 	if (bmcr & BMCR_LOOP)
    229 		mii->mii_media_active |= IFM_LOOP;
    230 
    231 	if (bmcr & BMCR_AUTOEN) {
    232 		/*
    233 		 * NWay autonegotiation takes the highest-order common
    234 		 * bit of the ANAR and ANLPAR (i.e. best media advertised
    235 		 * both by us and our link partner).
    236 		 */
    237 		if ((bmsr & BMSR_ACOMP) == 0) {
    238 			/* Erg, still trying, I guess... */
    239 			mii->mii_media_active |= IFM_NONE;
    240 			return;
    241 		}
    242 
    243 		PHY_READ(sc, MII_ANAR, &anar);
    244 		PHY_READ(sc, MII_ANLPAR, &anlpar);
    245 		result = anar & anlpar;
    246 		if (result != 0) {
    247 			if (result & ANLPAR_TX_FD)
    248 				mii->mii_media_active |= IFM_100_TX | IFM_FDX;
    249 			else if (result & ANLPAR_T4)
    250 				mii->mii_media_active |= IFM_100_T4 | IFM_HDX;
    251 			else if (result & ANLPAR_TX)
    252 				mii->mii_media_active |= IFM_100_TX | IFM_HDX;
    253 			else if (result & ANLPAR_10_FD)
    254 				mii->mii_media_active |= IFM_10_T | IFM_FDX;
    255 			else if (result & ANLPAR_10)
    256 				mii->mii_media_active |= IFM_10_T | IFM_HDX;
    257 			else
    258 				mii->mii_media_active |= IFM_NONE;
    259 			return;
    260 		}
    261 
    262 		/*
    263 		 * If the other side doesn't support NWAY, then the
    264 		 * best we can do is determine if we have a 10Mbps or
    265 		 * 100Mbps link. There's no way to know if the link
    266 		 * is full or half duplex, so we default to half duplex
    267 		 * and hope that the user is clever enough to manually
    268 		 * change the media settings if we're wrong.
    269 		 */
    270 
    271 		/*
    272 		 * The RealTek PHY supports non-NWAY link speed
    273 		 * detection, however it does not report the link
    274 		 * detection results via the ANLPAR or BMSR registers.
    275 		 * (What? RealTek doesn't do things the way everyone
    276 		 * else does? I'm just shocked, shocked I tell you.)
    277 		 * To determine the link speed, we have to do one
    278 		 * of two things:
    279 		 *
    280 		 * - If this is a standalone RealTek RTL8201 PHY,
    281 		 *   we can determine the link speed by testing bit 0
    282 		 *   in the magic, vendor-specific register at offset
    283 		 *   0x19.
    284 		 *
    285 		 * - If this is a RealTek MAC with integrated PHY, we
    286 		 *   can test the 'SPEED10' bit of the MAC's media status
    287 		 *   register.
    288 		 */
    289 		if (rsc->sc_rtl8201) {
    290 			PHY_READ(sc, 0x0019, &reg);
    291 			if (reg & 0x01)
    292 				mii->mii_media_active |= IFM_100_TX;
    293 			else
    294 				mii->mii_media_active |= IFM_10_T;
    295 		} else {
    296 			PHY_READ(sc, RTK_MEDIASTAT, &reg);
    297 			if (reg & RTK_MEDIASTAT_SPEED10)
    298 				mii->mii_media_active |= IFM_10_T;
    299 			else
    300 				mii->mii_media_active |= IFM_100_TX;
    301 		}
    302 		mii->mii_media_active |= IFM_HDX;
    303 	} else
    304 		mii->mii_media_active = ife->ifm_media;
    305 }
    306 
    307 static void
    308 rlphy_reset(struct mii_softc *sc)
    309 {
    310 
    311 	KASSERT(mii_locked(sc->mii_pdata));
    312 
    313 	mii_phy_reset(sc);
    314 
    315 	/*
    316 	 * XXX RealTek PHY doesn't set the BMCR properly after
    317 	 * XXX reset, which breaks autonegotiation.
    318 	 */
    319 	PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN);
    320 }
    321