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