Home | History | Annotate | Line # | Download | only in mii
tlphy.c revision 1.19
      1 /*	$NetBSD: tlphy.c,v 1.19 1999/11/03 22:30:32 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998, 1999 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  * 3. All advertising materials mentioning features or use of this software
     20  *    must display the following acknowledgement:
     21  *	This product includes software developed by the NetBSD
     22  *	Foundation, Inc. and its contributors.
     23  * 4. Neither the name of The NetBSD Foundation nor the names of its
     24  *    contributors may be used to endorse or promote products derived
     25  *    from this software without specific prior written permission.
     26  *
     27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     37  * POSSIBILITY OF SUCH DAMAGE.
     38  */
     39 
     40 /*
     41  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
     42  *
     43  * Redistribution and use in source and binary forms, with or without
     44  * modification, are permitted provided that the following conditions
     45  * are met:
     46  * 1. Redistributions of source code must retain the above copyright
     47  *    notice, this list of conditions and the following disclaimer.
     48  * 2. Redistributions in binary form must reproduce the above copyright
     49  *    notice, this list of conditions and the following disclaimer in the
     50  *    documentation and/or other materials provided with the distribution.
     51  * 3. All advertising materials mentioning features or use of this software
     52  *    must display the following acknowledgement:
     53  *	This product includes software developed by Manuel Bouyer.
     54  * 4. The name of the author may not be used to endorse or promote products
     55  *    derived from this software without specific prior written permission.
     56  *
     57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     67  */
     68 
     69 /*
     70  * Driver for Texas Instruments's ThunderLAN PHYs
     71  */
     72 
     73 #include <sys/param.h>
     74 #include <sys/systm.h>
     75 #include <sys/kernel.h>
     76 #include <sys/device.h>
     77 #include <sys/socket.h>
     78 #include <sys/errno.h>
     79 
     80 #include <machine/bus.h>
     81 
     82 #include <net/if.h>
     83 #include <net/if_media.h>
     84 
     85 #include <net/if_ether.h>
     86 
     87 #include <dev/mii/mii.h>
     88 #include <dev/mii/miivar.h>
     89 #include <dev/mii/miidevs.h>
     90 
     91 #include <dev/i2c/i2c_bus.h>
     92 
     93 #include <dev/mii/tlphyreg.h>
     94 #include <dev/mii/tlphyvar.h>
     95 
     96 /* ThunderLAN PHY can only be on a ThunderLAN */
     97 #include <dev/pci/if_tlvar.h>
     98 
     99 struct tlphy_softc {
    100 	struct mii_softc sc_mii;		/* generic PHY */
    101 	int sc_tlphycap;
    102 	int sc_need_acomp;
    103 };
    104 
    105 int	tlphymatch __P((struct device *, struct cfdata *, void *));
    106 void	tlphyattach __P((struct device *, struct device *, void *));
    107 
    108 struct cfattach tlphy_ca = {
    109 	sizeof(struct tlphy_softc), tlphymatch, tlphyattach
    110 };
    111 
    112 int	tlphy_service __P((struct mii_softc *, struct mii_data *, int));
    113 int	tlphy_auto __P((struct tlphy_softc *, int));
    114 void	tlphy_acomp __P((struct tlphy_softc *));
    115 void	tlphy_status __P((struct tlphy_softc *));
    116 
    117 int
    118 tlphymatch(parent, match, aux)
    119 	struct device *parent;
    120 	struct cfdata *match;
    121 	void *aux;
    122 {
    123 	struct mii_attach_args *ma = aux;
    124 
    125 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxTI &&
    126 	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxTI_TLAN10T)
    127 		return (10);
    128 
    129 	return (0);
    130 }
    131 
    132 void
    133 tlphyattach(parent, self, aux)
    134 	struct device *parent, *self;
    135 	void *aux;
    136 {
    137 	struct tlphy_softc *sc = (struct tlphy_softc *)self;
    138 	struct tl_softc *tlsc = (struct tl_softc *)self->dv_parent;
    139 	struct mii_attach_args *ma = aux;
    140 	struct mii_data *mii = ma->mii_data;
    141 	const char *sep = "";
    142 
    143 	printf(": %s, rev. %d\n", MII_STR_xxTI_TLAN10T,
    144 	    MII_REV(ma->mii_id2));
    145 
    146 	sc->sc_mii.mii_inst = mii->mii_instance;
    147 	sc->sc_mii.mii_phy = ma->mii_phyno;
    148 	sc->sc_mii.mii_service = tlphy_service;
    149 	sc->sc_mii.mii_pdata = mii;
    150 
    151 	mii_phy_reset(&sc->sc_mii);
    152 
    153 	/*
    154 	 * Note that if we're on a device that also supports 100baseTX,
    155 	 * we are not going to want to use the built-in 10baseT port,
    156 	 * since there will be another PHY on the MII wired up to the
    157 	 * UTP connector.  The parent indicates this to us by specifying
    158 	 * the TLPHY_MEDIA_NO_10_T bit.
    159 	 */
    160 	sc->sc_tlphycap = tlsc->tl_product->tp_tlphymedia;
    161 	if ((sc->sc_tlphycap & TLPHY_MEDIA_NO_10_T) == 0)
    162 		sc->sc_mii.mii_capabilities =
    163 		    PHY_READ(&sc->sc_mii, MII_BMSR) & ma->mii_capmask;
    164 	else
    165 		sc->sc_mii.mii_capabilities = 0;
    166 
    167 
    168 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
    169 #define	PRINT(s)	printf("%s%s", sep, s); sep = ", "
    170 
    171 	printf("%s: ", sc->sc_mii.mii_dev.dv_xname);
    172 	if (sc->sc_tlphycap) {
    173 		if (sc->sc_tlphycap & TLPHY_MEDIA_10_2) {
    174 			ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_2, 0,
    175 			    sc->sc_mii.mii_inst), 0);
    176 			PRINT("10base2");
    177 		} else if (sc->sc_tlphycap & TLPHY_MEDIA_10_5) {
    178 			ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_5, 0,
    179 			    sc->sc_mii.mii_inst), 0);
    180 			PRINT("10base5");
    181 		}
    182 	}
    183 	if (sc->sc_mii.mii_capabilities & BMSR_MEDIAMASK) {
    184 		printf(sep);
    185 		mii_add_media(&sc->sc_mii);
    186 	} else if ((sc->sc_tlphycap &
    187 		    (TLPHY_MEDIA_10_2 | TLPHY_MEDIA_10_5)) == 0)
    188 		printf("no media present");
    189 	printf("\n");
    190 #undef ADD
    191 #undef PRINT
    192 }
    193 
    194 int
    195 tlphy_service(self, mii, cmd)
    196 	struct mii_softc *self;
    197 	struct mii_data *mii;
    198 	int cmd;
    199 {
    200 	struct tlphy_softc *sc = (struct tlphy_softc *)self;
    201 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    202 	int reg;
    203 
    204 	if ((sc->sc_mii.mii_flags & MIIF_DOINGAUTO) == 0 && sc->sc_need_acomp)
    205 		tlphy_acomp(sc);
    206 
    207 	switch (cmd) {
    208 	case MII_POLLSTAT:
    209 		/*
    210 		 * If we're not polling our PHY instance, just return.
    211 		 */
    212 		if (IFM_INST(ife->ifm_media) != sc->sc_mii.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->sc_mii.mii_inst) {
    222 			reg = PHY_READ(&sc->sc_mii, MII_BMCR);
    223 			PHY_WRITE(&sc->sc_mii, MII_BMCR, reg | BMCR_ISO);
    224 			return (0);
    225 		}
    226 
    227 		/*
    228 		 * If the interface is not up, don't do anything.
    229 		 */
    230 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    231 			break;
    232 
    233 		switch (IFM_SUBTYPE(ife->ifm_media)) {
    234 		case IFM_AUTO:
    235 			/*
    236 			 * The ThunderLAN PHY doesn't self-configure after
    237 			 * an autonegotiation cycle, so there's no such
    238 			 * thing as "already in auto mode".
    239 			 */
    240 			(void) tlphy_auto(sc, 1);
    241 			break;
    242 		case IFM_10_2:
    243 		case IFM_10_5:
    244 			PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
    245 			PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, CTRL_AUISEL);
    246 			delay(100000);
    247 			break;
    248 		default:
    249 			PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, 0);
    250 			delay(100000);
    251 			mii_phy_setmedia(&sc->sc_mii);
    252 		}
    253 		break;
    254 
    255 	case MII_TICK:
    256 		/*
    257 		 * If we're not currently selected, just return.
    258 		 */
    259 		if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst)
    260 			return (0);
    261 
    262 		/*
    263 		 * Only used for autonegotiation.
    264 		 */
    265 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
    266 			return (0);
    267 
    268 		/*
    269 		 * Is the interface even up?
    270 		 */
    271 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    272 			return (0);
    273 
    274 		/*
    275 		 * Check to see if we have link.  If we do, we don't
    276 		 * need to restart the autonegotiation process.  Read
    277 		 * the BMSR twice in case it's latched.
    278 		 *
    279 		 * XXX WHAT ABOUT CHECKING LINK ON THE BNC/AUI?!
    280 		 */
    281 		reg = PHY_READ(&sc->sc_mii, MII_BMSR) |
    282 		    PHY_READ(&sc->sc_mii, MII_BMSR);
    283 		if (reg & BMSR_LINK)
    284 			return (0);
    285 
    286 		/*
    287 		 * Only retry autonegotiation every 5 seconds.
    288 		 */
    289 		if (++sc->sc_mii.mii_ticks != 5)
    290 			return (0);
    291 
    292 		sc->sc_mii.mii_ticks = 0;
    293 		mii_phy_reset(&sc->sc_mii);
    294 		if (tlphy_auto(sc, 0) == EJUSTRETURN)
    295 			return (0);
    296 		break;
    297 	}
    298 
    299 	/* Update the media status. */
    300 	tlphy_status(sc);
    301 
    302 	/* Callback if something changed. */
    303 	if (sc->sc_mii.mii_active != mii->mii_media_active ||
    304 	    cmd == MII_MEDIACHG) {
    305 		(*mii->mii_statchg)(sc->sc_mii.mii_dev.dv_parent);
    306 		sc->sc_mii.mii_active = mii->mii_media_active;
    307 	}
    308 	return (0);
    309 }
    310 
    311 void
    312 tlphy_status(sc)
    313 	struct tlphy_softc *sc;
    314 {
    315 	struct mii_data *mii = sc->sc_mii.mii_pdata;
    316 	struct tl_softc *tlsc = (struct tl_softc *)sc->sc_mii.mii_dev.dv_parent;
    317 	int bmsr, bmcr, tlctrl;
    318 
    319 	mii->mii_media_status = IFM_AVALID;
    320 	mii->mii_media_active = IFM_ETHER;
    321 
    322 	bmcr = PHY_READ(&sc->sc_mii, MII_BMCR);
    323 	if (bmcr & BMCR_ISO) {
    324 		mii->mii_media_active |= IFM_NONE;
    325 		mii->mii_media_status = 0;
    326 		return;
    327 	}
    328 
    329 	tlctrl = PHY_READ(&sc->sc_mii, MII_TLPHY_CTRL);
    330 	if (tlctrl & CTRL_AUISEL) {
    331 		if (sc->sc_tlphycap & TLPHY_MEDIA_10_2)
    332 			mii->mii_media_active |= IFM_10_2;
    333 		else if (sc->sc_tlphycap & TLPHY_MEDIA_10_5)
    334 			mii->mii_media_active |= IFM_10_5;
    335 		else
    336 			printf("%s: AUI selected with no matching media !\n",
    337 			    sc->sc_mii.mii_dev.dv_xname);
    338 		if (tlsc->tl_flags & TL_IFACT)
    339 			mii->mii_media_status |= IFM_ACTIVE;
    340 		return;
    341 	}
    342 
    343 	bmsr = PHY_READ(&sc->sc_mii, MII_BMSR) |
    344 	    PHY_READ(&sc->sc_mii, MII_BMSR);
    345 	if (bmsr & BMSR_LINK)
    346 		mii->mii_media_status |= IFM_ACTIVE;
    347 
    348 	if (bmcr & BMCR_LOOP)
    349 		mii->mii_media_active |= IFM_LOOP;
    350 
    351 	/*
    352 	 * Grr, braindead ThunderLAN PHY doesn't have any way to
    353 	 * tell which media is actually active.  (Note it also
    354 	 * doesn't self-configure after autonegotiation.)  We
    355 	 * just have to report what's in the BMCR.
    356 	 */
    357 	if (bmcr & BMCR_FDX)
    358 		mii->mii_media_active |= IFM_FDX;
    359 	mii->mii_media_active |= IFM_10_T;
    360 }
    361 
    362 int
    363 tlphy_auto(sc, waitfor)
    364 	struct tlphy_softc *sc;
    365 	int waitfor;
    366 {
    367 	int error;
    368 
    369 	switch ((error = mii_phy_auto(&sc->sc_mii, waitfor))) {
    370 	case EIO:
    371 		/*
    372 		 * Just assume we're not in full-duplex mode.
    373 		 * XXX Check link and try AUI/BNC?
    374 		 */
    375 		PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
    376 		break;
    377 
    378 	case EJUSTRETURN:
    379 		/* Flag that we need to program when it completes. */
    380 		sc->sc_need_acomp = 1;
    381 		break;
    382 
    383 	default:
    384 		tlphy_acomp(sc);
    385 	}
    386 
    387 	return (error);
    388 }
    389 
    390 void
    391 tlphy_acomp(sc)
    392 	struct tlphy_softc *sc;
    393 {
    394 	int aner, anlpar;
    395 
    396 	sc->sc_need_acomp = 0;
    397 
    398 	/*
    399 	 * Grr, braindead ThunderLAN PHY doesn't self-configure
    400 	 * after autonegotiation.  We have to do it ourselves
    401 	 * based on the link partner status.
    402 	 */
    403 
    404 	aner = PHY_READ(&sc->sc_mii, MII_ANER);
    405 	if (aner & ANER_LPAN) {
    406 		anlpar = PHY_READ(&sc->sc_mii, MII_ANLPAR) &
    407 		    PHY_READ(&sc->sc_mii, MII_ANAR);
    408 		if (anlpar & ANAR_10_FD) {
    409 			PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_FDX);
    410 			return;
    411 		}
    412 	}
    413 	PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
    414 }
    415