Home | History | Annotate | Line # | Download | only in mii
nsphy.c revision 1.5
      1 /*	$NetBSD: nsphy.c,v 1.5 1998/08/10 23:58:39 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 	int reg;
    179 
    180 	switch (cmd) {
    181 	case MII_POLLSTAT:
    182 		/*
    183 		 * If we're not polling our PHY instance, just return.
    184 		 */
    185 		if (IFM_INST(mii->mii_media.ifm_media) !=
    186 		    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(mii->mii_media.ifm_media) !=
    196 		    sc->sc_mii.mii_inst) {
    197 			reg = NSPHY_READ(sc, MII_BMCR);
    198 			NSPHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    199 			return (0);
    200 		}
    201 
    202 		/*
    203 		 * If the interface is not up, don't do anything.
    204 		 */
    205 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    206 			break;
    207 
    208 		/*
    209 		 * Set up the PCR to use LED4 to indicate full-duplex
    210 		 * in both 10baseT and 100baseTX modes.
    211 		 */
    212 		reg = NSPHY_READ(sc, MII_NSPHY_PCR);
    213 		NSPHY_WRITE(sc, MII_NSPHY_PCR, reg | PCR_LED4MODE);
    214 
    215 		switch (IFM_SUBTYPE(mii->mii_media.ifm_media)) {
    216 		case IFM_AUTO:
    217 			/*
    218 			 * If we're already in auto mode, just return.
    219 			 */
    220 			if (NSPHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
    221 				return (0);
    222 			nsphy_auto(sc);
    223 			break;
    224 		case IFM_100_T4:
    225 			/*
    226 			 * XXX Not supported as a manual setting right now.
    227 			 */
    228 			return (EINVAL);
    229 		default:
    230 			/*
    231 			 * BMCR data is stored in the ifmedia entry.
    232 			 */
    233 			NSPHY_WRITE(sc, MII_ANAR,
    234 			    mii_anar(mii->mii_media.ifm_media));
    235 			NSPHY_WRITE(sc, MII_BMCR,
    236 			    mii->mii_media.ifm_cur->ifm_data);
    237 		}
    238 		break;
    239 
    240 	case MII_TICK:
    241 		/*
    242 		 * If we're not currently selected, just return.
    243 		 */
    244 		if (IFM_INST(mii->mii_media.ifm_media) !=
    245 		    sc->sc_mii.mii_inst)
    246 			return (0);
    247 
    248 		/*
    249 		 * Only used for autonegotiation.
    250 		 */
    251 		if (IFM_SUBTYPE(mii->mii_media.ifm_media) != IFM_AUTO)
    252 			return (0);
    253 
    254 		/*
    255 		 * Is the interface even up?
    256 		 */
    257 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    258 			return (0);
    259 
    260 		/*
    261 		 * Check to see if we have link.  If we do, we don't
    262 		 * need to restart the autonegotiation process.  Read
    263 		 * the BMSR twice in case it's latched.
    264 		 */
    265 		reg = NSPHY_READ(sc, MII_BMSR) | NSPHY_READ(sc, MII_BMSR);
    266 		if (reg & BMSR_LINK)
    267 			return (0);
    268 
    269 		/*
    270 		 * Only retry autonegotiation every 5 seconds.
    271 		 */
    272 		if (++sc->sc_ticks != 5)
    273 			return (0);
    274 
    275 		sc->sc_ticks = 0;
    276 		nsphy_reset(sc);
    277 		nsphy_auto(sc);
    278 		break;
    279 	}
    280 
    281 	/* Update the media status. */
    282 	nsphy_status(sc);
    283 
    284 	/* Callback if something changed. */
    285 	if (sc->sc_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
    286 		(*mii->mii_statchg)(sc->sc_mii.mii_dev.dv_parent);
    287 		sc->sc_active = mii->mii_media_active;
    288 	}
    289 	return (0);
    290 }
    291 
    292 void
    293 nsphy_status(sc)
    294 	struct nsphy_softc *sc;
    295 {
    296 	struct mii_data *mii = sc->sc_mii.mii_pdata;
    297 	int bmsr, bmcr, par;
    298 
    299 	mii->mii_media_status = IFM_AVALID;
    300 	mii->mii_media_active = IFM_ETHER;
    301 
    302 	bmsr = NSPHY_READ(sc, MII_BMSR) | NSPHY_READ(sc, MII_BMSR);
    303 	if (bmsr & BMSR_LINK)
    304 		mii->mii_media_status |= IFM_ACTIVE;
    305 
    306 	bmcr = NSPHY_READ(sc, MII_BMCR);
    307 	if (bmcr & BMCR_ISO) {
    308 		mii->mii_media_active |= IFM_NONE;
    309 		mii->mii_media_status = 0;
    310 		return;
    311 	}
    312 
    313 	if (bmcr & BMCR_LOOP)
    314 		mii->mii_media_active |= IFM_LOOP;
    315 
    316 	if (bmcr & BMCR_AUTOEN) {
    317 		/*
    318 		 * The PAR status bits are only valid of autonegotiation
    319 		 * has completed (or it's disabled).
    320 		 */
    321 		if ((bmsr & BMSR_ACOMP) == 0) {
    322 			mii->mii_media_active |= IFM_AUTO;
    323 			return;
    324 		}
    325 		par = NSPHY_READ(sc, MII_NSPHY_PAR);
    326 		if (par & PAR_10)
    327 			mii->mii_media_active |= IFM_10_T;
    328 		else
    329 			mii->mii_media_active |= IFM_100_TX;
    330 		if (par & PAR_FDX)
    331 			mii->mii_media_active |= IFM_FDX;
    332 	} else {
    333 		if (bmcr & BMCR_S100)
    334 			mii->mii_media_active |= IFM_100_TX;
    335 		else
    336 			mii->mii_media_active |= IFM_10_T;
    337 		if (bmcr & BMCR_FDX)
    338 			mii->mii_media_active |= IFM_FDX;
    339 	}
    340 }
    341 
    342 void
    343 nsphy_auto(sc)
    344 	struct nsphy_softc *sc;
    345 {
    346 	int bmsr, i;
    347 
    348 	NSPHY_WRITE(sc, MII_ANAR,
    349 	    BMSR_MEDIA_TO_ANAR(sc->sc_capabilities) | ANAR_CSMA);
    350 	NSPHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN | BMCR_STARTNEG);
    351 
    352 	/* Wait 500ms for it to complete. */
    353 	for (i = 0; i < 500; i++) {
    354 		if ((bmsr = NSPHY_READ(sc, MII_BMSR)) & BMSR_ACOMP)
    355 			return;
    356 		delay(1000);
    357 	}
    358 	if ((bmsr & BMSR_ACOMP) == 0)
    359 		printf("%s: autonegotiation failed to complete\n",
    360 		    sc->sc_mii.mii_dev.dv_xname);
    361 }
    362 
    363 void
    364 nsphy_reset(sc)
    365 	struct nsphy_softc *sc;
    366 {
    367 	int reg, i;
    368 
    369 	/*
    370 	 * The i82557 wedges if we isolate all of its PHYs!
    371 	 */
    372 	if (sc->sc_mii.mii_inst == 0)
    373 		NSPHY_WRITE(sc, MII_BMCR, BMCR_RESET);
    374 	else
    375 		NSPHY_WRITE(sc, MII_BMCR, BMCR_RESET|BMCR_ISO);
    376 
    377 	/* Wait 100ms for it to complete. */
    378 	for (i = 0; i < 100; i++) {
    379 		reg = NSPHY_READ(sc, MII_BMCR);
    380 		if ((reg & BMCR_RESET) == 0)
    381 			break;
    382 		delay(1000);
    383 	}
    384 
    385 	/* Make sure the PHY is isolated. */
    386 	if (sc->sc_mii.mii_inst != 0)
    387 		NSPHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    388 }
    389