Home | History | Annotate | Line # | Download | only in mii
inphy.c revision 1.1
      1 /*	$NetBSD: inphy.c,v 1.1 1998/08/11 00:00:28 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 Intel's i82555 ethernet 10/100 PHY
     71  * Data Sheet available from www.intel.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/inphyreg.h>
     89 
     90 struct inphy_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	inphymatch __P((struct device *, struct cfdata *, void *));
     98 void	inphyattach __P((struct device *, struct device *, void *));
     99 
    100 struct cfattach inphy_ca = {
    101 	sizeof(struct inphy_softc), inphymatch, inphyattach
    102 };
    103 
    104 #define	INPHY_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	INPHY_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	inphy_service __P((struct mii_softc *, struct mii_data *, int));
    113 void	inphy_reset __P((struct inphy_softc *));
    114 void	inphy_auto __P((struct inphy_softc *));
    115 void	inphy_status __P((struct inphy_softc *));
    116 
    117 int
    118 inphymatch(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_INTEL &&
    126 	    MII_MODEL(ma->mii_id2) == MII_MODEL_INTEL_I82555)
    127 		return (1);
    128 
    129 	return (0);
    130 }
    131 
    132 void
    133 inphyattach(parent, self, aux)
    134 	struct device *parent, *self;
    135 	void *aux;
    136 {
    137 	struct inphy_softc *sc = (struct inphy_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_INTEL_I82555,
    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 = inphy_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 	inphy_reset(sc);
    160 
    161 	sc->sc_capabilities = INPHY_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 inphy_service(self, mii, cmd)
    173 	struct mii_softc *self;
    174 	struct mii_data *mii;
    175 	int cmd;
    176 {
    177 	struct inphy_softc *sc = (struct inphy_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 = INPHY_READ(sc, MII_BMCR);
    198 			INPHY_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 		switch (IFM_SUBTYPE(mii->mii_media.ifm_media)) {
    209 		case IFM_AUTO:
    210 			/*
    211 			 * If we're already in auto mode, just return.
    212 			 */
    213 			if (INPHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
    214 				return (0);
    215 			inphy_auto(sc);
    216 			break;
    217 		case IFM_100_T4:
    218 			/*
    219 			 * XXX Not supported as a manual setting right now.
    220 			 */
    221 			return (EINVAL);
    222 		default:
    223 			/*
    224 			 * BMCR data is stored in the ifmedia entry.
    225 			 */
    226 			INPHY_WRITE(sc, MII_ANAR,
    227 			    mii_anar(mii->mii_media.ifm_media));
    228 			INPHY_WRITE(sc, MII_BMCR,
    229 			    mii->mii_media.ifm_cur->ifm_data);
    230 		}
    231 		break;
    232 
    233 	case MII_TICK:
    234 		/*
    235 		 * If we're not currently selected, just return.
    236 		 */
    237 		if (IFM_INST(mii->mii_media.ifm_media) !=
    238 		    sc->sc_mii.mii_inst)
    239 			return (0);
    240 
    241 		/*
    242 		 * Only used for autonegotiation.
    243 		 */
    244 		if (IFM_SUBTYPE(mii->mii_media.ifm_media) != IFM_AUTO)
    245 			return (0);
    246 
    247 		/*
    248 		 * Is the interface even up?
    249 		 */
    250 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    251 			return (0);
    252 
    253 		/*
    254 		 * Check to see if we have link.  If we do, we don't
    255 		 * need to restart the autonegotiation process.  Read
    256 		 * the BMSR twice in case it's latched.
    257 		 */
    258 		reg = INPHY_READ(sc, MII_BMSR) | INPHY_READ(sc, MII_BMSR);
    259 		if (reg & BMSR_LINK)
    260 			return (0);
    261 
    262 		/*
    263 		 * Only retry autonegotiation every 5 seconds.
    264 		 */
    265 		if (++sc->sc_ticks != 5)
    266 			return (0);
    267 
    268 		sc->sc_ticks = 0;
    269 		inphy_reset(sc);
    270 		inphy_auto(sc);
    271 		break;
    272 	}
    273 
    274 	/* Update the media status. */
    275 	inphy_status(sc);
    276 
    277 	/* Callback if something changed. */
    278 	if (sc->sc_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
    279 		(*mii->mii_statchg)(sc->sc_mii.mii_dev.dv_parent);
    280 		sc->sc_active = mii->mii_media_active;
    281 	}
    282 	return (0);
    283 }
    284 
    285 void
    286 inphy_status(sc)
    287 	struct inphy_softc *sc;
    288 {
    289 	struct mii_data *mii = sc->sc_mii.mii_pdata;
    290 	int bmsr, bmcr, scr;
    291 
    292 	mii->mii_media_status = IFM_AVALID;
    293 	mii->mii_media_active = IFM_ETHER;
    294 
    295 	bmsr = INPHY_READ(sc, MII_BMSR) | INPHY_READ(sc, MII_BMSR);
    296 	if (bmsr & BMSR_LINK)
    297 		mii->mii_media_status |= IFM_ACTIVE;
    298 
    299 	bmcr = INPHY_READ(sc, MII_BMCR);
    300 	if (bmcr & BMCR_ISO) {
    301 		mii->mii_media_active |= IFM_NONE;
    302 		mii->mii_media_status = 0;
    303 		return;
    304 	}
    305 
    306 	if (bmcr & BMCR_LOOP)
    307 		mii->mii_media_active |= IFM_LOOP;
    308 
    309 	if (bmcr & BMCR_AUTOEN) {
    310 		scr = INPHY_READ(sc, MII_INPHY_SCR);
    311 		if (scr & SCR_T4)
    312 			mii->mii_media_active |= IFM_100_T4;
    313 		else if (scr & SCR_S100)
    314 			mii->mii_media_active |= IFM_100_TX;
    315 		else
    316 			mii->mii_media_active |= IFM_10_T;
    317 		if (scr & SCR_FDX)
    318 			mii->mii_media_active |= IFM_FDX;
    319 	} else {
    320 		if (bmcr & BMCR_S100)
    321 			mii->mii_media_active |= IFM_100_TX;
    322 		else
    323 			mii->mii_media_active |= IFM_10_T;
    324 		if (bmcr & BMCR_FDX)
    325 			mii->mii_media_active |= IFM_FDX;
    326 	}
    327 }
    328 
    329 void
    330 inphy_auto(sc)
    331 	struct inphy_softc *sc;
    332 {
    333 	int bmsr, i;
    334 
    335 	INPHY_WRITE(sc, MII_ANAR,
    336 	    BMSR_MEDIA_TO_ANAR(sc->sc_capabilities) | ANAR_CSMA);
    337 	INPHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN | BMCR_STARTNEG);
    338 
    339 	/* Wait 500ms for it to complete. */
    340 	for (i = 0; i < 500; i++) {
    341 		if ((bmsr = INPHY_READ(sc, MII_BMSR)) & BMSR_ACOMP)
    342 			return;
    343 		delay(1000);
    344 	}
    345 	if ((bmsr & BMSR_ACOMP) == 0)
    346 		printf("%s: autonegotiation failed to complete\n",
    347 		    sc->sc_mii.mii_dev.dv_xname);
    348 }
    349 
    350 void
    351 inphy_reset(sc)
    352 	struct inphy_softc *sc;
    353 {
    354 	int reg, i;
    355 
    356 	/*
    357 	 * The i82557 wedges if we isolate all of its PHYs!
    358 	 */
    359 	if (sc->sc_mii.mii_inst == 0)
    360 		INPHY_WRITE(sc, MII_BMCR, BMCR_RESET);
    361 	else
    362 		INPHY_WRITE(sc, MII_BMCR, BMCR_RESET|BMCR_ISO);
    363 
    364 	/* Wait 100ms for it to complete. */
    365 	for (i = 0; i < 100; i++) {
    366 		reg = INPHY_READ(sc, MII_BMCR);
    367 		if ((reg & BMCR_RESET) == 0)
    368 			break;
    369 		delay(1000);
    370 	}
    371 
    372 	/* Make sure the PHY is isolated. */
    373 	if (sc->sc_mii.mii_inst != 0)
    374 		INPHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    375 }
    376