Home | History | Annotate | Line # | Download | only in mii
nsphy.c revision 1.11
      1 /*	$NetBSD: nsphy.c,v 1.11 1998/11/04 22:15:40 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998 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 National Semiconductor's DP83840A ethernet 10/100 PHY
     71  * Data Sheet available from www.national.com
     72  */
     73 
     74 #include <sys/param.h>
     75 #include <sys/systm.h>
     76 #include <sys/kernel.h>
     77 #include <sys/device.h>
     78 #include <sys/malloc.h>
     79 #include <sys/socket.h>
     80 
     81 #include <net/if.h>
     82 #include <net/if_media.h>
     83 
     84 #include <dev/mii/mii.h>
     85 #include <dev/mii/miivar.h>
     86 #include <dev/mii/miidevs.h>
     87 
     88 #include <dev/mii/nsphyreg.h>
     89 
     90 struct nsphy_softc {
     91 	struct mii_softc sc_mii;		/* generic PHY */
     92 	int sc_capabilities;
     93 	int sc_ticks;
     94 	int sc_active;
     95 };
     96 
     97 int	nsphymatch __P((struct device *, struct cfdata *, void *));
     98 void	nsphyattach __P((struct device *, struct device *, void *));
     99 
    100 struct cfattach nsphy_ca = {
    101 	sizeof(struct nsphy_softc), nsphymatch, nsphyattach
    102 };
    103 
    104 int	nsphy_service __P((struct mii_softc *, struct mii_data *, int));
    105 void	nsphy_reset __P((struct nsphy_softc *));
    106 void	nsphy_auto __P((struct nsphy_softc *));
    107 void	nsphy_status __P((struct nsphy_softc *));
    108 
    109 int
    110 nsphymatch(parent, match, aux)
    111 	struct device *parent;
    112 	struct cfdata *match;
    113 	void *aux;
    114 {
    115 	struct mii_attach_args *ma = aux;
    116 
    117 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI &&
    118 	    MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83840)
    119 		return (1);
    120 
    121 	return (0);
    122 }
    123 
    124 void
    125 nsphyattach(parent, self, aux)
    126 	struct device *parent, *self;
    127 	void *aux;
    128 {
    129 	struct nsphy_softc *sc = (struct nsphy_softc *)self;
    130 	struct mii_attach_args *ma = aux;
    131 	struct mii_data *mii = ma->mii_data;
    132 
    133 	printf(": %s, rev. %d\n", MII_STR_NATSEMI_DP83840,
    134 	    MII_REV(ma->mii_id2));
    135 
    136 	sc->sc_mii.mii_inst = mii->mii_instance;
    137 	sc->sc_mii.mii_phy = ma->mii_phyno;
    138 	sc->sc_mii.mii_service = nsphy_service;
    139 	sc->sc_mii.mii_pdata = mii;
    140 
    141 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
    142 
    143 #if 0
    144 	/* Can't do this on the i82557! */
    145 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->sc_mii.mii_inst),
    146 	    BMCR_ISO);
    147 #endif
    148 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->sc_mii.mii_inst),
    149 	    BMCR_LOOP|BMCR_S100);
    150 
    151 	nsphy_reset(sc);
    152 
    153 	sc->sc_capabilities = PHY_READ(&sc->sc_mii, MII_BMSR) & ma->mii_capmask;
    154 	printf("%s: ", sc->sc_mii.mii_dev.dv_xname);
    155 	if ((sc->sc_capabilities & BMSR_MEDIAMASK) == 0)
    156 		printf("no media present");
    157 	else
    158 		mii_add_media(mii, sc->sc_capabilities, sc->sc_mii.mii_inst);
    159 	printf("\n");
    160 #undef ADD
    161 }
    162 
    163 int
    164 nsphy_service(self, mii, cmd)
    165 	struct mii_softc *self;
    166 	struct mii_data *mii;
    167 	int cmd;
    168 {
    169 	struct nsphy_softc *sc = (struct nsphy_softc *)self;
    170 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    171 	int reg;
    172 
    173 	switch (cmd) {
    174 	case MII_POLLSTAT:
    175 		/*
    176 		 * If we're not polling our PHY instance, just return.
    177 		 */
    178 		if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst)
    179 			return (0);
    180 		break;
    181 
    182 	case MII_MEDIACHG:
    183 		/*
    184 		 * If the media indicates a different PHY instance,
    185 		 * isolate ourselves.
    186 		 */
    187 		if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst) {
    188 			reg = PHY_READ(&sc->sc_mii, MII_BMCR);
    189 			PHY_WRITE(&sc->sc_mii, MII_BMCR, reg | BMCR_ISO);
    190 			return (0);
    191 		}
    192 
    193 		/*
    194 		 * If the interface is not up, don't do anything.
    195 		 */
    196 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    197 			break;
    198 
    199 		reg = PHY_READ(&sc->sc_mii, MII_NSPHY_PCR);
    200 
    201 		/*
    202 		 * Set up the PCR to use LED4 to indicate full-duplex
    203 		 * in both 10baseT and 100baseTX modes.
    204 		 */
    205 		reg |= PCR_LED4MODE;
    206 
    207 		/*
    208 		 * Make sure Carrier Intgrity Monitor function is
    209 		 * disabled (normal for Node operation, but sometimes
    210 		 * it's not set?!)
    211 		 */
    212 		reg |= PCR_CIMDIS;
    213 
    214 		/*
    215 		 * Make sure "force link good" is not set.  It's only
    216 		 * intended for debugging, but sometimes it's set
    217 		 * after a reset.
    218 		 */
    219 		reg &= ~PCR_FLINK100;
    220 
    221 #if 0
    222 		/*
    223 		 * Mystery bits which are supposedly `reserved',
    224 		 * but we seem to need to set them when the PHY
    225 		 * is connected to some interfaces!
    226 		 */
    227 		reg |= 0x0100 | 0x0400;
    228 #endif
    229 
    230 		PHY_WRITE(&sc->sc_mii, MII_NSPHY_PCR, reg);
    231 
    232 		switch (IFM_SUBTYPE(ife->ifm_media)) {
    233 		case IFM_AUTO:
    234 			/*
    235 			 * If we're already in auto mode, just return.
    236 			 */
    237 			if (PHY_READ(&sc->sc_mii, MII_BMCR) & BMCR_AUTOEN)
    238 				return (0);
    239 			nsphy_auto(sc);
    240 			break;
    241 		case IFM_100_T4:
    242 			/*
    243 			 * XXX Not supported as a manual setting right now.
    244 			 */
    245 			return (EINVAL);
    246 		default:
    247 			/*
    248 			 * BMCR data is stored in the ifmedia entry.
    249 			 */
    250 			PHY_WRITE(&sc->sc_mii, MII_ANAR,
    251 			    mii_anar(ife->ifm_media));
    252 			PHY_WRITE(&sc->sc_mii, MII_BMCR, ife->ifm_data);
    253 		}
    254 		break;
    255 
    256 	case MII_TICK:
    257 		/*
    258 		 * If we're not currently selected, just return.
    259 		 */
    260 		if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst)
    261 			return (0);
    262 
    263 		/*
    264 		 * Only used for autonegotiation.
    265 		 */
    266 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
    267 			return (0);
    268 
    269 		/*
    270 		 * Is the interface even up?
    271 		 */
    272 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    273 			return (0);
    274 
    275 		/*
    276 		 * Check to see if we have link.  If we do, we don't
    277 		 * need to restart the autonegotiation process.  Read
    278 		 * the BMSR twice in case it's latched.
    279 		 */
    280 		reg = PHY_READ(&sc->sc_mii, MII_BMSR) |
    281 		    PHY_READ(&sc->sc_mii, MII_BMSR);
    282 		if (reg & BMSR_LINK)
    283 			return (0);
    284 
    285 		/*
    286 		 * Only retry autonegotiation every 5 seconds.
    287 		 */
    288 		if (++sc->sc_ticks != 5)
    289 			return (0);
    290 
    291 		sc->sc_ticks = 0;
    292 		nsphy_reset(sc);
    293 		nsphy_auto(sc);
    294 		break;
    295 	}
    296 
    297 	/* Update the media status. */
    298 	nsphy_status(sc);
    299 
    300 	/* Callback if something changed. */
    301 	if (sc->sc_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
    302 		(*mii->mii_statchg)(sc->sc_mii.mii_dev.dv_parent);
    303 		sc->sc_active = mii->mii_media_active;
    304 	}
    305 	return (0);
    306 }
    307 
    308 void
    309 nsphy_status(sc)
    310 	struct nsphy_softc *sc;
    311 {
    312 	struct mii_data *mii = sc->sc_mii.mii_pdata;
    313 	int bmsr, bmcr, par, anlpar;
    314 
    315 	mii->mii_media_status = IFM_AVALID;
    316 	mii->mii_media_active = IFM_ETHER;
    317 
    318 	bmsr = PHY_READ(&sc->sc_mii, MII_BMSR) |
    319 	    PHY_READ(&sc->sc_mii, MII_BMSR);
    320 	if (bmsr & BMSR_LINK)
    321 		mii->mii_media_status |= IFM_ACTIVE;
    322 
    323 	bmcr = PHY_READ(&sc->sc_mii, MII_BMCR);
    324 	if (bmcr & BMCR_ISO) {
    325 		mii->mii_media_active |= IFM_NONE;
    326 		mii->mii_media_status = 0;
    327 		return;
    328 	}
    329 
    330 	if (bmcr & BMCR_LOOP)
    331 		mii->mii_media_active |= IFM_LOOP;
    332 
    333 	if (bmcr & BMCR_AUTOEN) {
    334 		/*
    335 		 * The PAR status bits are only valid of autonegotiation
    336 		 * has completed (or it's disabled).
    337 		 */
    338 		if ((bmsr & BMSR_ACOMP) == 0) {
    339 			/* Erg, still trying, I guess... */
    340 			mii->mii_media_active |= IFM_NONE;
    341 			return;
    342 		}
    343 
    344 		/*
    345 		 * Argh.  The PAR doesn't seem to indicate duplex mode
    346 		 * properly!  Determine media based on link partner's
    347 		 * advertised capabilities.
    348 		 */
    349 		if (PHY_READ(&sc->sc_mii, MII_ANER) & ANER_LPAN) {
    350 			anlpar = PHY_READ(&sc->sc_mii, MII_ANAR) &
    351 			    PHY_READ(&sc->sc_mii, MII_ANLPAR);
    352 			if (anlpar & ANLPAR_T4)
    353 				mii->mii_media_active |= IFM_100_T4;
    354 			else if (anlpar & ANLPAR_TX_FD)
    355 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
    356 			else if (anlpar & ANLPAR_TX)
    357 				mii->mii_media_active |= IFM_100_TX;
    358 			else if (anlpar & ANLPAR_10_FD)
    359 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
    360 			else if (anlpar & ANLPAR_10)
    361 				mii->mii_media_active |= IFM_10_T;
    362 			else
    363 				mii->mii_media_active |= IFM_NONE;
    364 			return;
    365 		}
    366 
    367 		/*
    368 		 * Link partner is not capable of autonegotiation.
    369 		 * We will never be in full-duplex mode if this is
    370 		 * the case, so reading the PAR is OK.
    371 		 */
    372 		par = PHY_READ(&sc->sc_mii, MII_NSPHY_PAR);
    373 		if (par & PAR_10)
    374 			mii->mii_media_active |= IFM_10_T;
    375 		else
    376 			mii->mii_media_active |= IFM_100_TX;
    377 #if 0
    378 		if (par & PAR_FDX)
    379 			mii->mii_media_active |= IFM_FDX;
    380 #endif
    381 	} else {
    382 		if (bmcr & BMCR_S100)
    383 			mii->mii_media_active |= IFM_100_TX;
    384 		else
    385 			mii->mii_media_active |= IFM_10_T;
    386 		if (bmcr & BMCR_FDX)
    387 			mii->mii_media_active |= IFM_FDX;
    388 	}
    389 }
    390 
    391 void
    392 nsphy_auto(sc)
    393 	struct nsphy_softc *sc;
    394 {
    395 	int bmsr, i;
    396 
    397 	PHY_WRITE(&sc->sc_mii, MII_ANAR,
    398 	    BMSR_MEDIA_TO_ANAR(sc->sc_capabilities) | ANAR_CSMA);
    399 	PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_AUTOEN | BMCR_STARTNEG);
    400 
    401 	/* Wait 500ms for it to complete. */
    402 	for (i = 0; i < 500; i++) {
    403 		if ((bmsr = PHY_READ(&sc->sc_mii, MII_BMSR)) & BMSR_ACOMP)
    404 			return;
    405 		delay(1000);
    406 	}
    407 #if 0
    408 	if ((bmsr & BMSR_ACOMP) == 0)
    409 		printf("%s: autonegotiation failed to complete\n",
    410 		    sc->sc_mii.mii_dev.dv_xname);
    411 #endif
    412 }
    413 
    414 void
    415 nsphy_reset(sc)
    416 	struct nsphy_softc *sc;
    417 {
    418 	int reg, i;
    419 
    420 	/*
    421 	 * The i82557 wedges if we isolate all of its PHYs!
    422 	 */
    423 	if (sc->sc_mii.mii_inst == 0)
    424 		PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_RESET);
    425 	else
    426 		PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_RESET|BMCR_ISO);
    427 
    428 	/* Wait 100ms for it to complete. */
    429 	for (i = 0; i < 100; i++) {
    430 		reg = PHY_READ(&sc->sc_mii, MII_BMCR);
    431 		if ((reg & BMCR_RESET) == 0)
    432 			break;
    433 		delay(1000);
    434 	}
    435 
    436 	/* Make sure the PHY is isolated. */
    437 	if (sc->sc_mii.mii_inst != 0)
    438 		PHY_WRITE(&sc->sc_mii, MII_BMCR, reg | BMCR_ISO);
    439 }
    440