Home | History | Annotate | Line # | Download | only in mii
sqphy.c revision 1.53
      1 /*	$NetBSD: sqphy.c,v 1.53 2019/02/24 17:22:21 christos Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998, 1999, 2000, 2001 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  *
     20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30  * POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 /*
     34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
     35  *
     36  * Redistribution and use in source and binary forms, with or without
     37  * modification, are permitted provided that the following conditions
     38  * are met:
     39  * 1. Redistributions of source code must retain the above copyright
     40  *    notice, this list of conditions and the following disclaimer.
     41  * 2. Redistributions in binary form must reproduce the above copyright
     42  *    notice, this list of conditions and the following disclaimer in the
     43  *    documentation and/or other materials provided with the distribution.
     44  *
     45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     55  */
     56 
     57 /*
     58  * driver for Seeq 80220/80221, 80223, and 80225 10/100 ethernet PHYs
     59  * datasheet from www.seeq.com
     60  */
     61 
     62 #include <sys/cdefs.h>
     63 __KERNEL_RCSID(0, "$NetBSD: sqphy.c,v 1.53 2019/02/24 17:22:21 christos Exp $");
     64 
     65 #include <sys/param.h>
     66 #include <sys/systm.h>
     67 #include <sys/kernel.h>
     68 #include <sys/device.h>
     69 #include <sys/socket.h>
     70 #include <sys/errno.h>
     71 
     72 #include <net/if.h>
     73 #include <net/if_media.h>
     74 
     75 #include <dev/mii/mii.h>
     76 #include <dev/mii/miivar.h>
     77 #include <dev/mii/miidevs.h>
     78 
     79 #include <dev/mii/sqphyreg.h>
     80 
     81 static int	sqphymatch(device_t, cfdata_t, void *);
     82 static void	sqphyattach(device_t, device_t, void *);
     83 
     84 CFATTACH_DECL_NEW(sqphy, sizeof(struct mii_softc),
     85     sqphymatch, sqphyattach, mii_phy_detach, mii_phy_activate);
     86 
     87 static int	sqphy_service(struct mii_softc *, struct mii_data *, int);
     88 static void	sqphy_status(struct mii_softc *);
     89 static void	sqphy_84220_reset(struct mii_softc *);
     90 
     91 static const struct mii_phy_funcs sqphy_funcs = {
     92 	sqphy_service, sqphy_status, mii_phy_reset,
     93 };
     94 
     95 static const struct mii_phy_funcs sqphy_84220_funcs = {
     96 	sqphy_service, sqphy_status, sqphy_84220_reset,
     97 };
     98 
     99 static const struct mii_phydesc sqphys[] = {
    100 	MII_PHY_DESC(SEEQ, 80220),
    101 	MII_PHY_DESC(SEEQ, 80225),
    102 	MII_PHY_DESC(SEEQ, 84220),
    103 	MII_PHY_END,
    104 };
    105 
    106 static int
    107 sqphymatch(device_t parent, cfdata_t match, void *aux)
    108 {
    109 	struct mii_attach_args *ma = aux;
    110 
    111 	if (mii_phy_match(ma, sqphys) != NULL)
    112 		return (10);
    113 
    114 	return (0);
    115 }
    116 
    117 static void
    118 sqphyattach(device_t parent, device_t self, void *aux)
    119 {
    120 	struct mii_softc *sc = device_private(self);
    121 	struct mii_attach_args *ma = aux;
    122 	struct mii_data *mii = ma->mii_data;
    123 	const struct mii_phydesc *mpd;
    124 
    125 	mpd = mii_phy_match(ma, sqphys);
    126 	aprint_naive(": Media interface\n");
    127 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    128 
    129 	sc->mii_dev = self;
    130 	sc->mii_inst = mii->mii_instance;
    131 	sc->mii_phy = ma->mii_phyno;
    132 	sc->mii_pdata = mii;
    133 	sc->mii_flags = ma->mii_flags;
    134 	sc->mii_anegticks = MII_ANEGTICKS;
    135 
    136 	switch (MII_MODEL(ma->mii_id2)) {
    137 	case MII_MODEL_SEEQ_84220:
    138 		sc->mii_funcs = &sqphy_84220_funcs;
    139 		aprint_normal_dev(self,
    140 		    "using Seeq 84220 isolate/reset hack\n");
    141 		break;
    142 
    143 	default:
    144 		sc->mii_funcs = &sqphy_funcs;
    145 	}
    146 
    147 	PHY_RESET(sc);
    148 
    149 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    150 	sc->mii_capabilities &= ma->mii_capmask;
    151 	aprint_normal_dev(self, "");
    152 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
    153 		aprint_error("no media present");
    154 	else
    155 		mii_phy_add_media(sc);
    156 	aprint_normal("\n");
    157 }
    158 
    159 static int
    160 sqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    161 {
    162 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    163 	uint16_t reg;
    164 
    165 	switch (cmd) {
    166 	case MII_POLLSTAT:
    167 		/*
    168 		 * If we're not polling our PHY instance, just return.
    169 		 */
    170 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    171 			return (0);
    172 		break;
    173 
    174 	case MII_MEDIACHG:
    175 		/*
    176 		 * If the media indicates a different PHY instance,
    177 		 * isolate ourselves.
    178 		 */
    179 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    180 			PHY_READ(sc, MII_BMCR, &reg);
    181 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    182 			return (0);
    183 		}
    184 
    185 		/*
    186 		 * If the interface is not up, don't do anything.
    187 		 */
    188 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    189 			break;
    190 
    191 		mii_phy_setmedia(sc);
    192 		break;
    193 
    194 	case MII_TICK:
    195 		/*
    196 		 * If we're not currently selected, just return.
    197 		 */
    198 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    199 			return (0);
    200 
    201 		if (mii_phy_tick(sc) == EJUSTRETURN)
    202 			return (0);
    203 		break;
    204 
    205 	case MII_DOWN:
    206 		mii_phy_down(sc);
    207 		return (0);
    208 	}
    209 
    210 	/* Update the media status. */
    211 	mii_phy_status(sc);
    212 
    213 	/* Callback if something changed. */
    214 	mii_phy_update(sc, cmd);
    215 	return (0);
    216 }
    217 
    218 static void
    219 sqphy_status(struct mii_softc *sc)
    220 {
    221 	struct mii_data *mii = sc->mii_pdata;
    222 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    223 	uint16_t bmsr, bmcr, status;
    224 
    225 	mii->mii_media_status = IFM_AVALID;
    226 	mii->mii_media_active = IFM_ETHER;
    227 
    228 	PHY_READ(sc, MII_BMSR, &bmsr);
    229 	PHY_READ(sc, MII_BMSR, &bmsr);
    230 	if (bmsr & BMSR_LINK)
    231 		mii->mii_media_status |= IFM_ACTIVE;
    232 
    233 	PHY_READ(sc, MII_BMCR, &bmcr);
    234 	if (bmcr & BMCR_ISO) {
    235 		mii->mii_media_active |= IFM_NONE;
    236 		mii->mii_media_status = 0;
    237 		return;
    238 	}
    239 
    240 	if (bmcr & BMCR_LOOP)
    241 		mii->mii_media_active |= IFM_LOOP;
    242 
    243 	if (bmcr & BMCR_AUTOEN) {
    244 		if ((bmsr & BMSR_ACOMP) == 0) {
    245 			/* Erg, still trying, I guess... */
    246 			mii->mii_media_active |= IFM_NONE;
    247 			return;
    248 		}
    249 		/*
    250 		 * Note: don't get fancy here -- the 80225 only
    251 		 * supports the SPD_DET and DPLX_DET bits in
    252 		 * the STATUS register.
    253 		 */
    254 		PHY_READ(sc, MII_SQPHY_STATUS, &status);
    255 		if (status & STATUS_SPD_DET)
    256 			mii->mii_media_active |= IFM_100_TX;
    257 		else
    258 			mii->mii_media_active |= IFM_10_T;
    259 		if (status & STATUS_DPLX_DET)
    260 			mii->mii_media_active |= IFM_FDX;
    261 		else
    262 			mii->mii_media_active |= IFM_HDX;
    263 	} else
    264 		mii->mii_media_active = ife->ifm_media;
    265 }
    266 
    267 static void
    268 sqphy_84220_reset(struct mii_softc *sc)
    269 {
    270 	uint16_t reg;
    271 
    272 	mii_phy_reset(sc);
    273 
    274 	/*
    275 	 * This PHY sometimes insists on coming out of reset isolated,
    276 	 * even when the MDA[0-3] pins are pulled high (to indicate
    277 	 * PHY address 0), contrary to the device's datasheet.
    278 	 *
    279 	 * Morever, simply clearing BMCR_ISO here isn't enough; the
    280 	 * change won't stick until about 30mS *after* the PHY has
    281 	 * been reset.
    282 	 *
    283 	 * This sucks.
    284 	 */
    285 	if ((sc->mii_inst != 0) && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
    286 		return;
    287 
    288 	PHY_READ(sc, MII_BMCR, &reg);
    289 	while ((reg & BMCR_ISO) != 0) {
    290 		delay(35000);
    291 		PHY_WRITE(sc, MII_BMCR, reg & ~BMCR_ISO);
    292 		delay(35000);
    293 		PHY_READ(sc, MII_BMCR, &reg);
    294 	}
    295 }
    296