Home | History | Annotate | Line # | Download | only in mii
tlphy.c revision 1.67
      1 /*	$NetBSD: tlphy.c,v 1.67 2019/11/27 10:19:21 msaitoh Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
      9  * NASA Ames Research Center.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in the
     18  *    documentation and/or other materials provided with the distribution.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     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 THE
     30  * POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 /*
     34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
     35  *
     36  * Redistribution and use in source and binary forms, with or without
     37  * modification, are permitted provided that the following conditions
     38  * are met:
     39  * 1. Redistributions of source code must retain the above copyright
     40  *    notice, this list of conditions and the following disclaimer.
     41  * 2. Redistributions in binary form must reproduce the above copyright
     42  *    notice, this list of conditions and the following disclaimer in the
     43  *    documentation and/or other materials provided with the distribution.
     44  *
     45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     55  */
     56 
     57 /*
     58  * Driver for Texas Instruments's ThunderLAN PHYs
     59  */
     60 
     61 #include <sys/cdefs.h>
     62 __KERNEL_RCSID(0, "$NetBSD: tlphy.c,v 1.67 2019/11/27 10:19:21 msaitoh Exp $");
     63 
     64 #include <sys/param.h>
     65 #include <sys/systm.h>
     66 #include <sys/kernel.h>
     67 #include <sys/device.h>
     68 #include <sys/socket.h>
     69 #include <sys/errno.h>
     70 
     71 #include <sys/bus.h>
     72 
     73 #include <net/if.h>
     74 #include <net/if_media.h>
     75 
     76 #include <net/if_ether.h>
     77 
     78 #include <dev/mii/mii.h>
     79 #include <dev/mii/miivar.h>
     80 #include <dev/mii/miidevs.h>
     81 
     82 #include <dev/mii/tlphyreg.h>
     83 #include <dev/mii/tlphyvar.h>
     84 
     85 /* ThunderLAN PHY can only be on a ThunderLAN */
     86 #include <dev/pci/if_tlvar.h>
     87 
     88 struct tlphy_softc {
     89 	struct mii_softc sc_mii;		/* generic PHY */
     90 	int sc_tlphycap;
     91 	int sc_need_acomp;
     92 };
     93 
     94 static int	tlphymatch(device_t, cfdata_t, void *);
     95 static void	tlphyattach(device_t, device_t, void *);
     96 
     97 CFATTACH_DECL_NEW(tlphy, sizeof(struct tlphy_softc),
     98     tlphymatch, tlphyattach, mii_phy_detach, mii_phy_activate);
     99 
    100 static int	tlphy_service(struct mii_softc *, struct mii_data *, int);
    101 static int	tlphy_auto(struct tlphy_softc *, int);
    102 static void	tlphy_acomp(struct tlphy_softc *);
    103 static void	tlphy_status(struct mii_softc *);
    104 
    105 static const struct mii_phy_funcs tlphy_funcs = {
    106 	tlphy_service, tlphy_status, mii_phy_reset,
    107 };
    108 
    109 static const struct mii_phydesc tlphys[] = {
    110 	MII_PHY_DESC(TI, TLAN10T),
    111 	MII_PHY_END,
    112 };
    113 
    114 static int
    115 tlphymatch(device_t parent, cfdata_t match, void *aux)
    116 {
    117 	struct mii_attach_args *ma = aux;
    118 
    119 	if (mii_phy_match(ma, tlphys) != NULL)
    120 		return 10;
    121 
    122 	return 0;
    123 }
    124 
    125 static void
    126 tlphyattach(device_t parent, device_t self, void *aux)
    127 {
    128 	struct tlphy_softc *tsc = device_private(self);
    129 	struct mii_softc *sc = &tsc->sc_mii;
    130 	struct tl_softc *tlsc = device_private(device_parent(self));
    131 	struct mii_attach_args *ma = aux;
    132 	struct mii_data *mii = ma->mii_data;
    133 	const struct mii_phydesc *mpd;
    134 	const char *sep = "";
    135 
    136 	mpd = mii_phy_match(ma, tlphys);
    137 	aprint_naive(": Media interface\n");
    138 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    139 
    140 	sc->mii_dev = self;
    141 	sc->mii_inst = mii->mii_instance;
    142 	sc->mii_phy = ma->mii_phyno;
    143 	sc->mii_funcs = &tlphy_funcs;
    144 	sc->mii_pdata = mii;
    145 	sc->mii_flags = ma->mii_flags;
    146 
    147 	PHY_RESET(sc);
    148 
    149 	/*
    150 	 * Note that if we're on a device that also supports 100baseTX, we are
    151 	 * not going to want to use the built-in 10baseT port, since there will
    152 	 * be another PHY on the MII wired up to the UTP connector.  The parent
    153 	 * indicates this to us by specifying the TLPHY_MEDIA_NO_10_T bit.
    154 	 */
    155 	tsc->sc_tlphycap = tlsc->tl_product->tp_tlphymedia;
    156 	if ((tsc->sc_tlphycap & TLPHY_MEDIA_NO_10_T) == 0) {
    157 		PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    158 		sc->mii_capabilities &= ma->mii_capmask;
    159 	} else
    160 		sc->mii_capabilities = 0;
    161 
    162 
    163 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
    164 #define	PRINT(str)	aprint_normal("%s%s", sep, str); sep = ", "
    165 
    166 	if (tsc->sc_tlphycap) {
    167 		sc->mii_anegticks = MII_ANEGTICKS;
    168 		aprint_normal_dev(self, "");
    169 		if (tsc->sc_tlphycap & TLPHY_MEDIA_10_2) {
    170 			ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_2, 0, sc->mii_inst),
    171 			    0);
    172 			PRINT("10base2");
    173 		} else if (tsc->sc_tlphycap & TLPHY_MEDIA_10_5) {
    174 			ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_5, 0, sc->mii_inst),
    175 			    0);
    176 			PRINT("10base5");
    177 		}
    178 		aprint_normal("\n");
    179 	}
    180 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
    181 		mii_phy_add_media(sc);
    182 	else {
    183 		if ((tsc->sc_tlphycap &
    184 		    (TLPHY_MEDIA_10_2 | TLPHY_MEDIA_10_5)) == 0)
    185 			aprint_error_dev(self, "no media present\n");
    186 		/*
    187 		 * mii_phy_add_media() automatically install power handler,
    188 		 * but if_media_add() doesn't. Do it now.
    189 		 */
    190 		if (!pmf_device_register(self, NULL, mii_phy_resume)) {
    191 			aprint_error_dev(self,
    192 			    "couldn't establish power handler\n");
    193 		}
    194 	}
    195 #undef ADD
    196 #undef PRINT
    197 }
    198 
    199 static int
    200 tlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    201 {
    202 	struct tlphy_softc *tsc = (struct tlphy_softc *)sc;
    203 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    204 	uint16_t reg;
    205 
    206 	if ((sc->mii_flags & MIIF_DOINGAUTO) == 0 && tsc->sc_need_acomp)
    207 		tlphy_acomp(tsc);
    208 
    209 	switch (cmd) {
    210 	case MII_POLLSTAT:
    211 		/* If we're not polling our PHY instance, just return. */
    212 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    213 			return 0;
    214 		break;
    215 
    216 	case MII_MEDIACHG:
    217 		/*
    218 		 * If the media indicates a different PHY instance,
    219 		 * isolate ourselves.
    220 		 */
    221 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    222 			PHY_READ(sc, MII_BMCR, &reg);
    223 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    224 			return 0;
    225 		}
    226 
    227 		/* If the interface is not up, don't do anything. */
    228 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    229 			break;
    230 
    231 		switch (IFM_SUBTYPE(ife->ifm_media)) {
    232 		case IFM_AUTO:
    233 			/*
    234 			 * The ThunderLAN PHY doesn't self-configure after
    235 			 * an autonegotiation cycle, so there's no such
    236 			 * thing as "already in auto mode".
    237 			 */
    238 			(void) tlphy_auto(tsc, 1);
    239 			break;
    240 		case IFM_10_2:
    241 		case IFM_10_5:
    242 			PHY_WRITE(sc, MII_BMCR, 0);
    243 			PHY_WRITE(sc, MII_TLPHY_CTRL, CTRL_AUISEL);
    244 			delay(100000);
    245 			break;
    246 		default:
    247 			PHY_WRITE(sc, MII_TLPHY_CTRL, 0);
    248 			delay(100000);
    249 			mii_phy_setmedia(sc);
    250 		}
    251 		break;
    252 
    253 	case MII_TICK:
    254 		/* If we're not currently selected, just return. */
    255 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    256 			return 0;
    257 
    258 		/*
    259 		 * XXX WHAT ABOUT CHECKING LINK ON THE BNC/AUI?!
    260 		 */
    261 
    262 		if (mii_phy_tick(sc) == EJUSTRETURN)
    263 			return 0;
    264 		break;
    265 
    266 	case MII_DOWN:
    267 		mii_phy_down(sc);
    268 		return 0;
    269 	}
    270 
    271 	/* Update the media status. */
    272 	mii_phy_status(sc);
    273 
    274 	/* Callback if something changed. */
    275 	mii_phy_update(sc, cmd);
    276 	return 0;
    277 }
    278 
    279 static void
    280 tlphy_status(struct mii_softc *sc)
    281 {
    282 	struct tlphy_softc *tsc = (struct tlphy_softc *)sc;
    283 	struct mii_data *mii = sc->mii_pdata;
    284 	uint16_t bmsr, bmcr, tlctrl;
    285 
    286 	mii->mii_media_status = IFM_AVALID;
    287 	mii->mii_media_active = IFM_ETHER;
    288 
    289 	PHY_READ(sc, MII_BMCR, &bmcr);
    290 	if (bmcr & BMCR_ISO) {
    291 		mii->mii_media_active |= IFM_NONE;
    292 		mii->mii_media_status = 0;
    293 		return;
    294 	}
    295 
    296 	PHY_READ(sc, MII_TLPHY_CTRL, &tlctrl);
    297 	if (tlctrl & CTRL_AUISEL) {
    298 		if (tsc->sc_tlphycap & TLPHY_MEDIA_10_2)
    299 			mii->mii_media_active |= IFM_10_2;
    300 		else if (tsc->sc_tlphycap & TLPHY_MEDIA_10_5)
    301 			mii->mii_media_active |= IFM_10_5;
    302 		else
    303 			printf("%s: AUI selected with no matching media !\n",
    304 			    device_xname(sc->mii_dev));
    305 		mii->mii_media_status |= IFM_ACTIVE;
    306 		return;
    307 	}
    308 
    309 	PHY_READ(sc, MII_BMSR, &bmsr);
    310 	PHY_READ(sc, MII_BMSR, &bmsr);
    311 	if (bmsr & BMSR_LINK)
    312 		mii->mii_media_status |= IFM_ACTIVE;
    313 
    314 	if (bmcr & BMCR_LOOP)
    315 		mii->mii_media_active |= IFM_LOOP;
    316 
    317 	/*
    318 	 * Grr, braindead ThunderLAN PHY doesn't have any way to tell which
    319 	 * media is actually active.  (Note it also doesn't self-configure
    320 	 * after autonegotiation.)  We just have to report what's in the BMCR.
    321 	 */
    322 	if (bmcr & BMCR_FDX)
    323 		mii->mii_media_active |= IFM_FDX;
    324 	else
    325 		mii->mii_media_active |= IFM_HDX;
    326 	mii->mii_media_active |= IFM_10_T;
    327 }
    328 
    329 static int
    330 tlphy_auto(struct tlphy_softc *tsc, int waitfor)
    331 {
    332 	struct mii_softc *sc = &tsc->sc_mii;
    333 	int error;
    334 
    335 	switch ((error = mii_phy_auto(sc, waitfor))) {
    336 	case EIO:
    337 		/*
    338 		 * Just assume we're not in full-duplex mode.
    339 		 * XXX Check link and try AUI/BNC?
    340 		 */
    341 		PHY_WRITE(sc, MII_BMCR, 0);
    342 		break;
    343 
    344 	case EJUSTRETURN:
    345 		/* Flag that we need to program when it completes. */
    346 		tsc->sc_need_acomp = 1;
    347 		break;
    348 
    349 	default:
    350 		tlphy_acomp(tsc);
    351 	}
    352 
    353 	return error;
    354 }
    355 
    356 static void
    357 tlphy_acomp(struct tlphy_softc *tsc)
    358 {
    359 	struct mii_softc *sc = &tsc->sc_mii;
    360 	uint16_t aner, anar, anlpar, result;
    361 
    362 	tsc->sc_need_acomp = 0;
    363 
    364 	/*
    365 	 * Grr, braindead ThunderLAN PHY doesn't self-configure
    366 	 * after autonegotiation.  We have to do it ourselves
    367 	 * based on the link partner status.
    368 	 */
    369 
    370 	PHY_READ(sc, MII_ANER, &aner);
    371 	if (aner & ANER_LPAN) {
    372 		PHY_READ(sc, MII_ANAR, &anar);
    373 		PHY_READ(sc, MII_ANLPAR, &anlpar);
    374 		result = anar & anlpar;
    375 		if (result & ANAR_10_FD) {
    376 			PHY_WRITE(sc, MII_BMCR, BMCR_FDX);
    377 			return;
    378 		}
    379 	}
    380 	PHY_WRITE(sc, MII_BMCR, 0);
    381 }
    382