Home | History | Annotate | Line # | Download | only in mii
nsphyter.c revision 1.44
      1 /*	$NetBSD: nsphyter.c,v 1.44 2019/11/27 10:19:21 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 DP83843 `PHYTER' ethernet 10/100 PHY
     59  * Data Sheet available from www.national.com
     60  *
     61  * We also support the DP83815 MacPHYER internal PHY since, for our
     62  * purposes, they are compatible.
     63  */
     64 
     65 #include <sys/cdefs.h>
     66 __KERNEL_RCSID(0, "$NetBSD: nsphyter.c,v 1.44 2019/11/27 10:19:21 msaitoh Exp $");
     67 
     68 #include <sys/param.h>
     69 #include <sys/systm.h>
     70 #include <sys/kernel.h>
     71 #include <sys/device.h>
     72 #include <sys/socket.h>
     73 #include <sys/errno.h>
     74 
     75 #include <net/if.h>
     76 #include <net/if_media.h>
     77 
     78 #include <dev/mii/mii.h>
     79 #include <dev/mii/miivar.h>
     80 #include <dev/mii/miidevs.h>
     81 
     82 #include <dev/mii/nsphyterreg.h>
     83 
     84 static int	nsphytermatch(device_t, cfdata_t, void *);
     85 static void	nsphyterattach(device_t, device_t, void *);
     86 
     87 CFATTACH_DECL3_NEW(nsphyter, sizeof(struct mii_softc),
     88     nsphytermatch, nsphyterattach, mii_phy_detach, mii_phy_activate, NULL,
     89     NULL, DVF_DETACH_SHUTDOWN);
     90 
     91 static int	nsphyter_service(struct mii_softc *, struct mii_data *, int);
     92 static void	nsphyter_status(struct mii_softc *);
     93 static void	nsphyter_reset(struct mii_softc *);
     94 
     95 static const struct mii_phy_funcs nsphyter_funcs = {
     96 	nsphyter_service, nsphyter_status, nsphyter_reset,
     97 };
     98 
     99 static const struct mii_phydesc nsphyters[] = {
    100 	MII_PHY_DESC(xxNATSEMI, DP83843),
    101 	MII_PHY_DESC(xxNATSEMI, DP83847),
    102 	MII_PHY_DESC(xxNATSEMI, DP83849),
    103 	MII_PHY_DESC(xxNATSEMI, DP83815),
    104 	MII_PHY_END,
    105 };
    106 
    107 static int
    108 nsphytermatch(device_t parent, cfdata_t match, void *aux)
    109 {
    110 	struct mii_attach_args *ma = aux;
    111 
    112 	if (mii_phy_match(ma, nsphyters) != NULL)
    113 		return 10;
    114 
    115 	return 0;
    116 }
    117 
    118 static void
    119 nsphyterattach(device_t parent, device_t self, void *aux)
    120 {
    121 	struct mii_softc *sc = device_private(self);
    122 	struct mii_attach_args *ma = aux;
    123 	struct mii_data *mii = ma->mii_data;
    124 	const struct mii_phydesc *mpd;
    125 
    126 	mpd = mii_phy_match(ma, nsphyters);
    127 	aprint_naive(": Media interface\n");
    128 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    129 
    130 	sc->mii_dev = self;
    131 	sc->mii_inst = mii->mii_instance;
    132 	sc->mii_phy = ma->mii_phyno;
    133 	sc->mii_funcs = &nsphyter_funcs;
    134 	sc->mii_pdata = mii;
    135 	sc->mii_flags = ma->mii_flags;
    136 
    137 	PHY_RESET(sc);
    138 
    139 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    140 	sc->mii_capabilities &= ma->mii_capmask;
    141 
    142 	mii_phy_add_media(sc);
    143 }
    144 
    145 static int
    146 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    147 {
    148 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    149 	uint16_t reg;
    150 
    151 	switch (cmd) {
    152 	case MII_POLLSTAT:
    153 		/* If we're not polling our PHY instance, just return. */
    154 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    155 			return 0;
    156 		break;
    157 
    158 	case MII_MEDIACHG:
    159 		/*
    160 		 * If the media indicates a different PHY instance,
    161 		 * isolate ourselves.
    162 		 */
    163 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    164 			PHY_READ(sc, MII_BMCR, &reg);
    165 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    166 			return 0;
    167 		}
    168 
    169 		/* If the interface is not up, don't do anything. */
    170 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    171 			break;
    172 
    173 		mii_phy_setmedia(sc);
    174 		break;
    175 
    176 	case MII_TICK:
    177 		/* If we're not currently selected, just return. */
    178 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    179 			return 0;
    180 
    181 		if (mii_phy_tick(sc) == EJUSTRETURN)
    182 			return 0;
    183 		break;
    184 
    185 	case MII_DOWN:
    186 		mii_phy_down(sc);
    187 		return 0;
    188 	}
    189 
    190 	/* Update the media status. */
    191 	mii_phy_status(sc);
    192 
    193 	/* Callback if something changed. */
    194 	mii_phy_update(sc, cmd);
    195 	return 0;
    196 }
    197 
    198 static void
    199 nsphyter_status(struct mii_softc *sc)
    200 {
    201 	struct mii_data *mii = sc->mii_pdata;
    202 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    203 	uint16_t bmsr, bmcr, physts;
    204 
    205 	mii->mii_media_status = IFM_AVALID;
    206 	mii->mii_media_active = IFM_ETHER;
    207 
    208 	PHY_READ(sc, MII_BMSR, &bmsr);
    209 	PHY_READ(sc, MII_BMSR, &bmsr);
    210 	PHY_READ(sc, MII_NSPHYTER_PHYSTS, &physts);
    211 
    212 	if (physts & PHYSTS_LINK)
    213 		mii->mii_media_status |= IFM_ACTIVE;
    214 
    215 	PHY_READ(sc, MII_BMCR, &bmcr);
    216 	if (bmcr & BMCR_ISO) {
    217 		mii->mii_media_active |= IFM_NONE;
    218 		mii->mii_media_status = 0;
    219 		return;
    220 	}
    221 
    222 	if (bmcr & BMCR_LOOP)
    223 		mii->mii_media_active |= IFM_LOOP;
    224 
    225 	if (bmcr & BMCR_AUTOEN) {
    226 		/*
    227 		 * The media status bits are only valid if autonegotiation
    228 		 * has completed (or it's disabled).
    229 		 */
    230 		if ((bmsr & BMSR_ACOMP) == 0) {
    231 			/* Erg, still trying, I guess... */
    232 			mii->mii_media_active |= IFM_NONE;
    233 			return;
    234 		}
    235 
    236 		if (physts & PHYSTS_SPEED10)
    237 			mii->mii_media_active |= IFM_10_T;
    238 		else
    239 			mii->mii_media_active |= IFM_100_TX;
    240 
    241 		if (physts & PHYSTS_DUPLEX)
    242 			mii->mii_media_active |=
    243 			    IFM_FDX | mii_phy_flowstatus(sc);
    244 		else
    245 			mii->mii_media_active |= IFM_HDX;
    246 	} else
    247 		mii->mii_media_active = ife->ifm_media;
    248 }
    249 
    250 static void
    251 nsphyter_reset(struct mii_softc *sc)
    252 {
    253 	int i;
    254 	uint16_t reg;
    255 
    256 	if (sc->mii_flags & MIIF_NOISOLATE)
    257 		reg = BMCR_RESET;
    258 	else
    259 		reg = BMCR_RESET | BMCR_ISO;
    260 	PHY_WRITE(sc, MII_BMCR, reg);
    261 
    262 	/*
    263 	 * It is best to allow a little time for the reset to settle
    264 	 * in before we start polling the BMCR again.  Notably, the
    265 	 * DP83840A manual states that there should be a 500us delay
    266 	 * between asserting software reset and attempting MII serial
    267 	 * operations.  Also, a DP83815 can get into a bad state on
    268 	 * cable removal and reinsertion if we do not delay here.
    269 	 */
    270 	delay(500);
    271 
    272 	/* Wait another 100ms for it to complete. */
    273 	for (i = 0; i < 100; i++) {
    274 		PHY_READ(sc, MII_BMCR, &reg);
    275 		if ((reg & BMCR_RESET) == 0)
    276 			break;
    277 		delay(1000);
    278 	}
    279 
    280 	if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
    281 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    282 }
    283