Home | History | Annotate | Line # | Download | only in mii
qsphy.c revision 1.1
      1 /*	$NetBSD: qsphy.c,v 1.1 1998/08/11 00:01:03 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 Quality Semiconductor's QS6612 ethernet 10/100 PHY
     71  * datasheet from www.qualitysemi.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/qsphyreg.h>
     89 
     90 struct qsphy_softc {
     91 	struct mii_softc sc_mii;		/* generic PHY */
     92 	int sc_capabilities;
     93 	int sc_active;
     94 };
     95 
     96 int	qsphymatch __P((struct device *, struct cfdata *, void *));
     97 void	qsphyattach __P((struct device *, struct device *, void *));
     98 
     99 struct cfattach qsphy_ca = {
    100 	sizeof(struct qsphy_softc), qsphymatch, qsphyattach
    101 };
    102 
    103 #define	QSPHY_READ(sc, reg) \
    104     (*(sc)->sc_mii.mii_pdata->mii_readreg)((sc)->sc_mii.mii_dev.dv_parent, \
    105 	(sc)->sc_mii.mii_phy, (reg))
    106 
    107 #define	QSPHY_WRITE(sc, reg, val) \
    108     (*(sc)->sc_mii.mii_pdata->mii_writereg)((sc)->sc_mii.mii_dev.dv_parent, \
    109 	(sc)->sc_mii.mii_phy, (reg), (val))
    110 
    111 int	qsphy_service __P((struct mii_softc *, struct mii_data *, int));
    112 void	qsphy_reset __P((struct qsphy_softc *));
    113 void	qsphy_auto __P((struct qsphy_softc *));
    114 void	qsphy_status __P((struct qsphy_softc *));
    115 
    116 int
    117 qsphymatch(parent, match, aux)
    118 	struct device *parent;
    119 	struct cfdata *match;
    120 	void *aux;
    121 {
    122 	struct mii_attach_args *ma = aux;
    123 
    124 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_QUALSEMI &&
    125 	    MII_MODEL(ma->mii_id2) == MII_MODEL_QUALSEMI_QS6612)
    126 		return (1);
    127 
    128 	return (0);
    129 }
    130 
    131 void
    132 qsphyattach(parent, self, aux)
    133 	struct device *parent, *self;
    134 	void *aux;
    135 {
    136 	struct qsphy_softc *sc = (struct qsphy_softc *)self;
    137 	struct mii_attach_args *ma = aux;
    138 	struct mii_data *mii = ma->mii_data;
    139 
    140 	printf(": %s, rev. %d\n", MII_STR_QUALSEMI_QS6612,
    141 	    MII_REV(ma->mii_id2));
    142 
    143 	sc->sc_mii.mii_inst = mii->mii_instance;
    144 	sc->sc_mii.mii_phy = ma->mii_phyno;
    145 	sc->sc_mii.mii_service = qsphy_service;
    146 	sc->sc_mii.mii_pdata = mii;
    147 
    148 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
    149 
    150 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->sc_mii.mii_inst),
    151 	    BMCR_ISO);
    152 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->sc_mii.mii_inst),
    153 	    BMCR_LOOP|BMCR_S100);
    154 
    155 	qsphy_reset(sc);
    156 
    157 	sc->sc_capabilities = QSPHY_READ(sc, MII_BMSR) & ma->mii_capmask;
    158 	printf("%s: ", sc->sc_mii.mii_dev.dv_xname);
    159 	if ((sc->sc_capabilities & BMSR_MEDIAMASK) == 0)
    160 		printf("no media present");
    161 	else
    162 		mii_add_media(mii, sc->sc_capabilities, sc->sc_mii.mii_inst);
    163 	printf("\n");
    164 #undef ADD
    165 }
    166 
    167 int
    168 qsphy_service(self, mii, cmd)
    169 	struct mii_softc *self;
    170 	struct mii_data *mii;
    171 	int cmd;
    172 {
    173 	struct qsphy_softc *sc = (struct qsphy_softc *)self;
    174 	int reg;
    175 
    176 	switch (cmd) {
    177 	case MII_POLLSTAT:
    178 		/*
    179 		 * If we're not polling our PHY instance, just return.
    180 		 */
    181 		if (IFM_INST(mii->mii_media.ifm_media) !=
    182 		    sc->sc_mii.mii_inst)
    183 			return (0);
    184 		break;
    185 
    186 	case MII_MEDIACHG:
    187 		/*
    188 		 * If the media indicates a different PHY instance,
    189 		 * isolate ourselves.
    190 		 */
    191 		if (IFM_INST(mii->mii_media.ifm_media) !=
    192 		    sc->sc_mii.mii_inst) {
    193 			reg = QSPHY_READ(sc, MII_BMCR);
    194 			QSPHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    195 			return (0);
    196 		}
    197 
    198 		/*
    199 		 * If the interface is not up, don't do anything.
    200 		 */
    201 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    202 			break;
    203 
    204 		switch (IFM_SUBTYPE(mii->mii_media.ifm_media)) {
    205 		case IFM_AUTO:
    206 			/*
    207 			 * If we're already in auto mode, just return.
    208 			 */
    209 			if (QSPHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
    210 				return (0);
    211 			qsphy_auto(sc);
    212 			break;
    213 		case IFM_100_T4:
    214 			/*
    215 			 * XXX Not supported as a manual setting right now.
    216 			 */
    217 			return (EINVAL);
    218 		default:
    219 			/*
    220 			 * BMCR data is stored in the ifmedia entry.
    221 			 */
    222 			QSPHY_WRITE(sc, MII_ANAR,
    223 			    mii_anar(mii->mii_media.ifm_media));
    224 			QSPHY_WRITE(sc, MII_BMCR,
    225 			    mii->mii_media.ifm_cur->ifm_data);
    226 		}
    227 		break;
    228 
    229 	case MII_TICK:
    230 		/*
    231 		 * If we're not currently selected, just return.
    232 		 */
    233 		if (IFM_INST(mii->mii_media.ifm_media) !=
    234 		    sc->sc_mii.mii_inst)
    235 			return (0);
    236 
    237 		/*
    238 		 * Only used for autonegotiation.
    239 		 */
    240 		if (IFM_SUBTYPE(mii->mii_media.ifm_media) != IFM_AUTO)
    241 			return (0);
    242 
    243 		/*
    244 		 * Is the interface even up?
    245 		 */
    246 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    247 			return (0);
    248 
    249 		/*
    250 		 * The QS6612's autonegotiation doesn't need to be
    251 		 * kicked; it continues in the background.
    252 		 */
    253 		break;
    254 	}
    255 
    256 	/* Update the media status. */
    257 	qsphy_status(sc);
    258 
    259 	/* Callback if something changed. */
    260 	if (sc->sc_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
    261 		(*mii->mii_statchg)(sc->sc_mii.mii_dev.dv_parent);
    262 		sc->sc_active = mii->mii_media_active;
    263 	}
    264 	return (0);
    265 }
    266 
    267 void
    268 qsphy_status(sc)
    269 	struct qsphy_softc *sc;
    270 {
    271 	struct mii_data *mii = sc->sc_mii.mii_pdata;
    272 	int bmsr, bmcr, pctl;
    273 
    274 	mii->mii_media_status = IFM_AVALID;
    275 	mii->mii_media_active = IFM_ETHER;
    276 
    277 	bmsr = QSPHY_READ(sc, MII_BMSR) | QSPHY_READ(sc, MII_BMSR);
    278 	if (bmsr & BMSR_LINK)
    279 		mii->mii_media_status |= IFM_ACTIVE;
    280 
    281 	bmcr = QSPHY_READ(sc, MII_BMCR);
    282 	if (bmcr & BMCR_ISO) {
    283 		mii->mii_media_active |= IFM_NONE;
    284 		mii->mii_media_status = 0;
    285 		return;
    286 	}
    287 
    288 	if (bmcr & BMCR_LOOP)
    289 		mii->mii_media_active |= IFM_LOOP;
    290 
    291 	pctl = QSPHY_READ(sc, MII_QSPHY_PCTL) | QSPHY_READ(sc, MII_QSPHY_PCTL);
    292 	switch (pctl & PCTL_OPMASK) {
    293 	case PCTL_10_T:
    294 		mii->mii_media_active |= IFM_10_T;
    295 		break;
    296 	case PCTL_10_T_FDX:
    297 		mii->mii_media_active |= IFM_10_T|IFM_FDX;
    298 		break;
    299 	case PCTL_100_TX:
    300 		mii->mii_media_active |= IFM_100_TX;
    301 		break;
    302 	case PCTL_100_TX_FDX:
    303 		mii->mii_media_active |= IFM_100_TX|IFM_FDX;
    304 		break;
    305 	case PCTL_100_T4:
    306 		mii->mii_media_active |= IFM_100_T4;
    307 		break;
    308 	default:
    309 		if (bmcr & BMCR_AUTOEN) {
    310 			/* Must still be in-progress. */
    311 			mii->mii_media_active |= IFM_AUTO;
    312 		} else {
    313 			/* Erg... this shouldn't happen. */
    314 			mii->mii_media_active |= IFM_NONE;
    315 		}
    316 	}
    317 }
    318 
    319 void
    320 qsphy_auto(sc)
    321 	struct qsphy_softc *sc;
    322 {
    323 	int bmsr, i;
    324 
    325 	QSPHY_WRITE(sc, MII_ANAR,
    326 	    BMSR_MEDIA_TO_ANAR(sc->sc_capabilities) | ANAR_CSMA);
    327 	QSPHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN | BMCR_STARTNEG);
    328 
    329 	/* Wait 500ms for it to complete. */
    330 	for (i = 0; i < 500; i++) {
    331 		if ((bmsr = QSPHY_READ(sc, MII_BMSR)) & BMSR_ACOMP)
    332 			return;
    333 		delay(1000);
    334 	}
    335 	if ((bmsr & BMSR_ACOMP) == 0)
    336 		printf("%s: autonegotiation failed to complete\n",
    337 		    sc->sc_mii.mii_dev.dv_xname);
    338 }
    339 
    340 void
    341 qsphy_reset(sc)
    342 	struct qsphy_softc *sc;
    343 {
    344 	int reg, i;
    345 
    346 	QSPHY_WRITE(sc, MII_BMCR, BMCR_RESET|BMCR_ISO);
    347 
    348 	/* Wait 100ms for it to complete. */
    349 	for (i = 0; i < 100; i++) {
    350 		reg = QSPHY_READ(sc, MII_BMCR);
    351 		if ((reg & BMCR_RESET) == 0)
    352 			break;
    353 		delay(1000);
    354 	}
    355 
    356 	/* Make sure the PHY is isolated. */
    357 	if (sc->sc_mii.mii_inst != 0)
    358 		QSPHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    359 
    360 	QSPHY_WRITE(sc, MII_QSPHY_IMASK, 0);
    361 }
    362