Home | History | Annotate | Line # | Download | only in mii
gphyter.c revision 1.31
      1 /*	$NetBSD: gphyter.c,v 1.31 2019/01/22 03:42:27 msaitoh 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 National Semiconductor's DP83891, DP83861 and DP83865
     59  * `Gig PHYTER' ethernet 10/100/1000 PHYs.  The DP83891 is an older,
     60  * non-firmware-driven version of the DP83861.  The DP83865 is a low
     61  * power version of the DP83861.
     62  *
     63  * Data Sheets available from www.national.com:
     64  *   http://www.national.com/ds/DP/DP83861.pdf
     65  *   http://www.national.com/ds/DP/DP83865.pdf
     66  */
     67 
     68 #include <sys/cdefs.h>
     69 __KERNEL_RCSID(0, "$NetBSD: gphyter.c,v 1.31 2019/01/22 03:42:27 msaitoh Exp $");
     70 
     71 #include <sys/param.h>
     72 #include <sys/systm.h>
     73 #include <sys/kernel.h>
     74 #include <sys/device.h>
     75 #include <sys/socket.h>
     76 #include <sys/errno.h>
     77 
     78 #include <net/if.h>
     79 #include <net/if_media.h>
     80 
     81 #include <dev/mii/mii.h>
     82 #include <dev/mii/miivar.h>
     83 #include <dev/mii/miidevs.h>
     84 
     85 #include <dev/mii/gphyterreg.h>
     86 
     87 static int	gphytermatch(device_t, cfdata_t, void *);
     88 static void	gphyterattach(device_t, device_t, void *);
     89 
     90 CFATTACH_DECL_NEW(gphyter, sizeof(struct mii_softc),
     91     gphytermatch, gphyterattach, mii_phy_detach, mii_phy_activate);
     92 
     93 static int	gphyter_service(struct mii_softc *, struct mii_data *, int);
     94 static void	gphyter_status(struct mii_softc *);
     95 static void	gphyter_reset(struct mii_softc *);
     96 
     97 static const struct mii_phy_funcs gphyter_funcs = {
     98 	gphyter_service, gphyter_status, gphyter_reset,
     99 };
    100 
    101 static const struct mii_phydesc gphyters[] = {
    102 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83861,
    103 	  MII_STR_xxNATSEMI_DP83861 },
    104 
    105 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83865,
    106 	  MII_STR_xxNATSEMI_DP83865 },
    107 
    108 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83891,
    109 	  MII_STR_xxNATSEMI_DP83891 },
    110 
    111 	{ 0,				0,
    112 	  NULL },
    113 };
    114 
    115 static int
    116 gphytermatch(device_t parent, cfdata_t match, void *aux)
    117 {
    118 	struct mii_attach_args *ma = aux;
    119 
    120 	if (mii_phy_match(ma, gphyters) != NULL)
    121 		return (10);
    122 
    123 	return (0);
    124 }
    125 
    126 static void
    127 gphyterattach(device_t parent, device_t 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 	uint16_t anar, strap;
    134 
    135 	mpd = mii_phy_match(ma, gphyters);
    136 	aprint_naive(": Media interface\n");
    137 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    138 
    139 	sc->mii_dev = self;
    140 	sc->mii_inst = mii->mii_instance;
    141 	sc->mii_phy = ma->mii_phyno;
    142 	sc->mii_funcs = &gphyter_funcs;
    143 	sc->mii_pdata = mii;
    144 	sc->mii_flags = ma->mii_flags;
    145 	sc->mii_anegticks = MII_ANEGTICKS;
    146 
    147 	PHY_RESET(sc);
    148 
    149 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    150 	sc->mii_capabilities &= ma->mii_capmask;
    151 	if (sc->mii_capabilities & BMSR_EXTSTAT)
    152 		PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
    153 
    154 	/*
    155 	 * The Gig PHYTER seems to have the 10baseT BMSR bits
    156 	 * hard-wired to 0, even though the device supports
    157 	 * 10baseT.  What we do instead is read the post-reset
    158 	 * ANAR, who's 10baseT-related bits are set by strapping
    159 	 * pin 180, and fake the BMSR bits.
    160 	 */
    161 	PHY_READ(sc, MII_ANAR, &anar);
    162 	if (anar & ANAR_10)
    163 		sc->mii_capabilities |= (BMSR_10THDX & ma->mii_capmask);
    164 	if (anar & ANAR_10_FD)
    165 		sc->mii_capabilities |= (BMSR_10TFDX & ma->mii_capmask);
    166 
    167 	aprint_normal_dev(self, "");
    168 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
    169 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
    170 		aprint_error("no media present");
    171 	else
    172 		mii_phy_add_media(sc);
    173 	aprint_normal("\n");
    174 
    175 	PHY_READ(sc, MII_GPHYTER_STRAP, &strap);
    176 	aprint_normal_dev(self, "strapped to %s mode",
    177 	    (strap & STRAP_MS_VAL) ? "master" : "slave");
    178 	if (strap & STRAP_NC_MODE)
    179 		aprint_normal(", pre-C5 BCM5400 compat enabled");
    180 	aprint_normal("\n");
    181 }
    182 
    183 static int
    184 gphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    185 {
    186 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    187 	uint16_t reg;
    188 
    189 	switch (cmd) {
    190 	case MII_POLLSTAT:
    191 		/*
    192 		 * If we're not polling our PHY instance, just return.
    193 		 */
    194 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    195 			return (0);
    196 		break;
    197 
    198 	case MII_MEDIACHG:
    199 		/*
    200 		 * If the media indicates a different PHY instance,
    201 		 * isolate ourselves.
    202 		 */
    203 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    204 			PHY_READ(sc, MII_BMCR, &reg);
    205 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    206 			return (0);
    207 		}
    208 
    209 		/*
    210 		 * If the interface is not up, don't do anything.
    211 		 */
    212 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    213 			break;
    214 
    215 		mii_phy_setmedia(sc);
    216 		break;
    217 
    218 	case MII_TICK:
    219 		/*
    220 		 * If we're not currently selected, just return.
    221 		 */
    222 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    223 			return (0);
    224 
    225 		if (mii_phy_tick(sc) == EJUSTRETURN)
    226 			return (0);
    227 		break;
    228 
    229 	case MII_DOWN:
    230 		mii_phy_down(sc);
    231 		return (0);
    232 	}
    233 
    234 	/* Update the media status. */
    235 	mii_phy_status(sc);
    236 
    237 	/* Callback if something changed. */
    238 	mii_phy_update(sc, cmd);
    239 	return (0);
    240 }
    241 
    242 static void
    243 gphyter_status(struct mii_softc *sc)
    244 {
    245 	struct mii_data *mii = sc->mii_pdata;
    246 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    247 	uint16_t bmsr, bmcr, physup, gtsr;
    248 
    249 	mii->mii_media_status = IFM_AVALID;
    250 	mii->mii_media_active = IFM_ETHER;
    251 
    252 	PHY_READ(sc, MII_BMSR, &bmsr);
    253 	PHY_READ(sc, MII_BMSR, &bmsr);
    254 
    255 	PHY_READ(sc, MII_GPHYTER_PHY_SUP, &physup);
    256 
    257 	if (physup & PHY_SUP_LINK)
    258 		mii->mii_media_status |= IFM_ACTIVE;
    259 
    260 	PHY_READ(sc, MII_BMCR, &bmcr);
    261 	if (bmcr & BMCR_ISO) {
    262 		mii->mii_media_active |= IFM_NONE;
    263 		mii->mii_media_status = 0;
    264 		return;
    265 	}
    266 
    267 	if (bmcr & BMCR_LOOP)
    268 		mii->mii_media_active |= IFM_LOOP;
    269 
    270 	if (bmcr & BMCR_AUTOEN) {
    271 		/*
    272 		 * The media status bits are only valid of autonegotiation
    273 		 * has completed (or it's disabled).
    274 		 */
    275 		if ((bmsr & BMSR_ACOMP) == 0) {
    276 			/* Erg, still trying, I guess... */
    277 			mii->mii_media_active |= IFM_NONE;
    278 			return;
    279 		}
    280 
    281 		switch (physup & (PHY_SUP_SPEED1|PHY_SUP_SPEED0)) {
    282 		case PHY_SUP_SPEED1:
    283 			mii->mii_media_active |= IFM_1000_T;
    284 			PHY_READ(sc, MII_100T2SR, &gtsr);
    285 			if (gtsr & GTSR_MS_RES)
    286 				mii->mii_media_active |= IFM_ETH_MASTER;
    287 			break;
    288 
    289 		case PHY_SUP_SPEED0:
    290 			mii->mii_media_active |= IFM_100_TX;
    291 			break;
    292 
    293 		case 0:
    294 			mii->mii_media_active |= IFM_10_T;
    295 			break;
    296 
    297 		default:
    298 			mii->mii_media_active |= IFM_NONE;
    299 			mii->mii_media_status = 0;
    300 		}
    301 		if (physup & PHY_SUP_DUPLEX)
    302 			mii->mii_media_active |=
    303 			    IFM_FDX | mii_phy_flowstatus(sc);
    304 		else
    305 			mii->mii_media_active |= IFM_HDX;
    306 	} else
    307 		mii->mii_media_active = ife->ifm_media;
    308 }
    309 
    310 void
    311 gphyter_reset(struct mii_softc *sc)
    312 {
    313 	int i;
    314 	uint16_t reg;
    315 
    316 	if (sc->mii_flags & MIIF_NOISOLATE)
    317 		reg = BMCR_RESET;
    318 	else
    319 		reg = BMCR_RESET | BMCR_ISO;
    320 	PHY_WRITE(sc, MII_BMCR, reg);
    321 
    322 	/*
    323 	 * It is best to allow a little time for the reset to settle
    324 	 * in before we start polling the BMCR again.  Notably, the
    325 	 * DP83840A manual states that there should be a 500us delay
    326 	 * between asserting software reset and attempting MII serial
    327 	 * operations.  Also, a DP83815 can get into a bad state on
    328 	 * cable removal and reinsertion if we do not delay here.
    329 	 */
    330 	delay(500);
    331 
    332 	/* Wait another 100ms for it to complete. */
    333 	for (i = 0; i < 100; i++) {
    334 		PHY_READ(sc, MII_BMCR, &reg);
    335 		if ((reg & BMCR_RESET) == 0)
    336 			break;
    337 		delay(1000);
    338 	}
    339 
    340 	if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
    341 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    342 }
    343