Home | History | Annotate | Line # | Download | only in mii
qsphy.c revision 1.41
      1 /*	$NetBSD: qsphy.c,v 1.41 2007/12/09 20:28:04 jmcneill Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998, 1999, 2000 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/cdefs.h>
     75 __KERNEL_RCSID(0, "$NetBSD: qsphy.c,v 1.41 2007/12/09 20:28:04 jmcneill Exp $");
     76 
     77 #include <sys/param.h>
     78 #include <sys/systm.h>
     79 #include <sys/kernel.h>
     80 #include <sys/device.h>
     81 #include <sys/socket.h>
     82 
     83 #include <net/if.h>
     84 #include <net/if_media.h>
     85 
     86 #include <dev/mii/mii.h>
     87 #include <dev/mii/miivar.h>
     88 #include <dev/mii/miidevs.h>
     89 
     90 #include <dev/mii/qsphyreg.h>
     91 
     92 static int	qsphymatch(struct device *, struct cfdata *, void *);
     93 static void	qsphyattach(struct device *, struct device *, void *);
     94 
     95 CFATTACH_DECL(qsphy, sizeof(struct mii_softc),
     96     qsphymatch, qsphyattach, mii_phy_detach, mii_phy_activate);
     97 
     98 static int	qsphy_service(struct mii_softc *, struct mii_data *, int);
     99 static void	qsphy_status(struct mii_softc *);
    100 static void	qsphy_reset(struct mii_softc *);
    101 
    102 static const struct mii_phy_funcs qsphy_funcs = {
    103 	qsphy_service, qsphy_status, qsphy_reset,
    104 };
    105 
    106 static const struct mii_phydesc qsphys[] = {
    107 	{ MII_OUI_xxQUALSEMI,		MII_MODEL_xxQUALSEMI_QS6612,
    108 	  MII_STR_xxQUALSEMI_QS6612 },
    109 
    110 	{ 0,				0,
    111 	  NULL },
    112 };
    113 
    114 static int
    115 qsphymatch(struct device *parent, struct cfdata *match,
    116     void *aux)
    117 {
    118 	struct mii_attach_args *ma = aux;
    119 
    120 	if (mii_phy_match(ma, qsphys) != NULL)
    121 		return (10);
    122 
    123 	return (0);
    124 }
    125 
    126 static void
    127 qsphyattach(struct device *parent, struct device *self, void *aux)
    128 {
    129 	struct mii_softc *sc = device_private(self);
    130 	struct mii_attach_args *ma = aux;
    131 	struct mii_data *mii = ma->mii_data;
    132 	const struct mii_phydesc *mpd;
    133 
    134 	mpd = mii_phy_match(ma, qsphys);
    135 	aprint_naive(": Media interface\n");
    136 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    137 
    138 	sc->mii_inst = mii->mii_instance;
    139 	sc->mii_phy = ma->mii_phyno;
    140 	sc->mii_funcs = &qsphy_funcs;
    141 	sc->mii_pdata = mii;
    142 	sc->mii_flags = ma->mii_flags;
    143 	sc->mii_anegticks = MII_ANEGTICKS;
    144 
    145 	PHY_RESET(sc);
    146 
    147 	sc->mii_capabilities =
    148 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
    149 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
    150 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
    151 		aprint_error("no media present");
    152 	else
    153 		mii_phy_add_media(sc);
    154 	aprint_normal("\n");
    155 
    156 	if (!pmf_device_register(self, NULL, mii_phy_resume))
    157 		aprint_error_dev(self, "couldn't establish power handler\n");
    158 }
    159 
    160 static int
    161 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    162 {
    163 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    164 	int reg;
    165 
    166 	if (!device_is_active(&sc->mii_dev))
    167 		return (ENXIO);
    168 
    169 	switch (cmd) {
    170 	case MII_POLLSTAT:
    171 		/*
    172 		 * If we're not polling our PHY instance, just return.
    173 		 */
    174 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    175 			return (0);
    176 		break;
    177 
    178 	case MII_MEDIACHG:
    179 		/*
    180 		 * If the media indicates a different PHY instance,
    181 		 * isolate ourselves.
    182 		 */
    183 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    184 			reg = PHY_READ(sc, MII_BMCR);
    185 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    186 			return (0);
    187 		}
    188 
    189 		/*
    190 		 * If the interface is not up, don't do anything.
    191 		 */
    192 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    193 			break;
    194 
    195 		mii_phy_setmedia(sc);
    196 		break;
    197 
    198 	case MII_TICK:
    199 		/*
    200 		 * If we're not currently selected, just return.
    201 		 */
    202 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    203 			return (0);
    204 
    205 		if (mii_phy_tick(sc) == EJUSTRETURN)
    206 			return (0);
    207 		break;
    208 
    209 	case MII_DOWN:
    210 		mii_phy_down(sc);
    211 		return (0);
    212 	}
    213 
    214 	/* Update the media status. */
    215 	mii_phy_status(sc);
    216 
    217 	/* Callback if something changed. */
    218 	mii_phy_update(sc, cmd);
    219 	return (0);
    220 }
    221 
    222 static void
    223 qsphy_status(struct mii_softc *sc)
    224 {
    225 	struct mii_data *mii = sc->mii_pdata;
    226 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    227 	int bmsr, bmcr, pctl;
    228 
    229 	mii->mii_media_status = IFM_AVALID;
    230 	mii->mii_media_active = IFM_ETHER;
    231 
    232 	bmsr = PHY_READ(sc, MII_BMSR) |
    233 	    PHY_READ(sc, MII_BMSR);
    234 	if (bmsr & BMSR_LINK)
    235 		mii->mii_media_status |= IFM_ACTIVE;
    236 
    237 	bmcr = PHY_READ(sc, MII_BMCR);
    238 	if (bmcr & BMCR_ISO) {
    239 		mii->mii_media_active |= IFM_NONE;
    240 		mii->mii_media_status = 0;
    241 		return;
    242 	}
    243 
    244 	if (bmcr & BMCR_LOOP)
    245 		mii->mii_media_active |= IFM_LOOP;
    246 
    247 	if (bmcr & BMCR_AUTOEN) {
    248 		if ((bmsr & BMSR_ACOMP) == 0) {
    249 			/* Erg, still trying, I guess... */
    250 			mii->mii_media_active |= IFM_NONE;
    251 			return;
    252 		}
    253 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
    254 		    PHY_READ(sc, MII_QSPHY_PCTL);
    255 		switch (pctl & PCTL_OPMASK) {
    256 		case PCTL_10_T:
    257 			mii->mii_media_active |= IFM_10_T;
    258 			break;
    259 		case PCTL_10_T_FDX:
    260 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
    261 			break;
    262 		case PCTL_100_TX:
    263 			mii->mii_media_active |= IFM_100_TX;
    264 			break;
    265 		case PCTL_100_TX_FDX:
    266 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
    267 			break;
    268 		case PCTL_100_T4:
    269 			mii->mii_media_active |= IFM_100_T4;
    270 			break;
    271 		default:
    272 			/* Erg... this shouldn't happen. */
    273 			mii->mii_media_active |= IFM_NONE;
    274 			break;
    275 		}
    276 	} else
    277 		mii->mii_media_active = ife->ifm_media;
    278 }
    279 
    280 static void
    281 qsphy_reset(struct mii_softc *sc)
    282 {
    283 
    284 	mii_phy_reset(sc);
    285 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
    286 }
    287