Home | History | Annotate | Line # | Download | only in mii
ihphy.c revision 1.11
      1 /*	$NetBSD: ihphy.c,v 1.11 2019/01/22 03:42:27 msaitoh 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, and by Frank van der Linden.
     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 Intel's 82577 (Hanksville) Ethernet 10/100/1000 PHY
     59  * Data Sheet: http://download.intel.com/design/network/datashts/319439.pdf
     60  */
     61 
     62 #include <sys/cdefs.h>
     63 __KERNEL_RCSID(0, "$NetBSD: ihphy.c,v 1.11 2019/01/22 03:42:27 msaitoh 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/ihphyreg.h>
     80 
     81 static int	ihphymatch(device_t, cfdata_t, void *);
     82 static void	ihphyattach(device_t, device_t, void *);
     83 
     84 CFATTACH_DECL3_NEW(ihphy, sizeof(struct mii_softc),
     85     ihphymatch, ihphyattach, mii_phy_detach, mii_phy_activate, NULL, NULL,
     86     DVF_DETACH_SHUTDOWN);
     87 
     88 static int	ihphy_service(struct mii_softc *, struct mii_data *, int);
     89 static void	ihphy_status(struct mii_softc *);
     90 static void	ihphy_reset(struct mii_softc *);
     91 
     92 static const struct mii_phy_funcs ihphy_funcs = {
     93 	ihphy_service, ihphy_status, ihphy_reset,
     94 };
     95 
     96 static const struct mii_phydesc ihphys[] = {
     97 	{ MII_OUI_INTEL,		MII_MODEL_INTEL_I82577,
     98 	  MII_STR_INTEL_I82577 },
     99 	{ MII_OUI_INTEL,		MII_MODEL_INTEL_I82579,
    100 	  MII_STR_INTEL_I82579 },
    101 	{ MII_OUI_INTEL,		MII_MODEL_INTEL_I217,
    102 	  MII_STR_INTEL_I217 },
    103 
    104 	{ 0,				0,
    105 	  NULL },
    106 };
    107 
    108 static int
    109 ihphymatch(device_t parent, cfdata_t match, void *aux)
    110 {
    111 	struct mii_attach_args *ma = aux;
    112 
    113 	if (mii_phy_match(ma, ihphys) != NULL)
    114 		return 10;
    115 
    116 	return 0;
    117 }
    118 
    119 static void
    120 ihphyattach(device_t parent, device_t self, void *aux)
    121 {
    122 	struct mii_softc *sc = device_private(self);
    123 	struct mii_attach_args *ma = aux;
    124 	struct mii_data *mii = ma->mii_data;
    125 	const struct mii_phydesc *mpd;
    126 	uint16_t reg;
    127 
    128 	mpd = mii_phy_match(ma, ihphys);
    129 	aprint_naive(": Media interface\n");
    130 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    131 
    132 	sc->mii_dev = self;
    133 	sc->mii_inst = mii->mii_instance;
    134 	sc->mii_phy = ma->mii_phyno;
    135 	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
    136 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
    137 	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
    138 	sc->mii_funcs = &ihphy_funcs;
    139 	sc->mii_pdata = mii;
    140 	sc->mii_flags = ma->mii_flags;
    141 	sc->mii_anegticks = MII_ANEGTICKS;
    142 
    143 	PHY_RESET(sc);
    144 
    145 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    146 	sc->mii_capabilities &= ma->mii_capmask;
    147 	if (sc->mii_capabilities & BMSR_EXTSTAT)
    148 		PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
    149 	aprint_normal_dev(self, "");
    150 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
    151 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
    152 		aprint_error("no media present");
    153 	else
    154 		mii_phy_add_media(sc);
    155 	aprint_normal("\n");
    156 
    157 	/*
    158 	 * Link setup (as done by Intel's Linux driver for the 82577).
    159 	 */
    160 	PHY_READ(sc, IHPHY_MII_CFG, &reg);
    161 	reg |= IHPHY_CFG_TX_CRS;
    162 	reg |= IHPHY_CFG_DOWN_SHIFT;
    163 	PHY_WRITE(sc, IHPHY_MII_CFG, reg);
    164 }
    165 
    166 static int
    167 ihphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    168 {
    169 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    170 	uint16_t reg;
    171 
    172 	switch (cmd) {
    173 	case MII_POLLSTAT:
    174 		/*
    175 		 * If we're not polling our PHY instance, just return.
    176 		 */
    177 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    178 			return 0;
    179 		break;
    180 
    181 	case MII_MEDIACHG:
    182 		/*
    183 		 * If the media indicates a different PHY instance,
    184 		 * isolate ourselves.
    185 		 */
    186 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    187 			PHY_READ(sc, MII_BMCR, &reg);
    188 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    189 			return 0;
    190 		}
    191 
    192 		/*
    193 		 * If the interface is not up, don't do anything.
    194 		 */
    195 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    196 			break;
    197 
    198 		/*
    199 		 * If media is deselected, disable link (standby).
    200 		 */
    201 		PHY_READ(sc, IHPHY_MII_ECR, &reg);
    202 		if (IFM_SUBTYPE(ife->ifm_media) == IFM_NONE)
    203 			reg &= ~IHPHY_ECR_LNK_EN;
    204 		else
    205 			reg |= IHPHY_ECR_LNK_EN;
    206 		PHY_WRITE(sc, IHPHY_MII_ECR, reg);
    207 
    208 		/*
    209 		 * XXX Adjust MDI/MDIX configuration?  Other settings?
    210 		 */
    211 
    212 		mii_phy_setmedia(sc);
    213 		break;
    214 
    215 	case MII_TICK:
    216 		/*
    217 		 * If we're not currently selected, just return.
    218 		 */
    219 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    220 			return 0;
    221 
    222 		if (mii_phy_tick(sc) == EJUSTRETURN)
    223 			return 0;
    224 		break;
    225 
    226 	case MII_DOWN:
    227 		mii_phy_down(sc);
    228 		PHY_WRITE(sc, MII_BMCR, BMCR_PDOWN);
    229 		return 0;
    230 	}
    231 
    232 	/* Update the media status. */
    233 	mii_phy_status(sc);
    234 
    235 	/* Callback if something changed. */
    236 	mii_phy_update(sc, cmd);
    237 	return 0;
    238 }
    239 
    240 static void
    241 ihphy_status(struct mii_softc *sc)
    242 {
    243 	struct mii_data *mii = sc->mii_pdata;
    244 	uint16_t esr, bmcr, gtsr;
    245 
    246 	mii->mii_media_status = IFM_AVALID;
    247 	mii->mii_media_active = IFM_ETHER;
    248 
    249 	PHY_READ(sc, IHPHY_MII_ESR, &esr);
    250 
    251 	if (esr & IHPHY_ESR_LINK)
    252 		mii->mii_media_status |= IFM_ACTIVE;
    253 
    254 	PHY_READ(sc, MII_BMCR, &bmcr);
    255 	if (bmcr & (BMCR_ISO | BMCR_PDOWN)) {
    256 		mii->mii_media_active |= IFM_NONE;
    257 		mii->mii_media_status = 0;
    258 		return;
    259 	}
    260 
    261 	if (bmcr & BMCR_LOOP)
    262 		mii->mii_media_active |= IFM_LOOP;
    263 
    264 	if (bmcr & BMCR_AUTOEN) {
    265 		if ((esr & IHPHY_ESR_ANEG_STAT) == 0) {
    266 			/* Erg, still trying, I guess... */
    267 			mii->mii_media_active |= IFM_NONE;
    268 			return;
    269 		}
    270 	}
    271 
    272 	switch (esr & IHPHY_ESR_SPEED) {
    273 	case IHPHY_SPEED_1000:
    274 		mii->mii_media_active |= IFM_1000_T;
    275 		PHY_READ(sc, MII_100T2SR, &gtsr);
    276 		if (gtsr & GTSR_MS_RES)
    277 			mii->mii_media_active |= IFM_ETH_MASTER;
    278 		break;
    279 
    280 	case IHPHY_SPEED_100:
    281 		/* 100BASE-T2 and 100BASE-T4 are not supported. */
    282 		mii->mii_media_active |= IFM_100_TX;
    283 		break;
    284 
    285 	case IHPHY_SPEED_10:
    286 		mii->mii_media_active |= IFM_10_T;
    287 		break;
    288 
    289 	default:
    290 		mii->mii_media_active |= IFM_NONE;
    291 		mii->mii_media_status = 0;
    292 		return;
    293 	}
    294 
    295 	if (esr & IHPHY_ESR_DUPLEX)
    296 		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
    297 	else
    298 		mii->mii_media_active |= IFM_HDX;
    299 }
    300 
    301 static void
    302 ihphy_reset(struct mii_softc *sc)
    303 {
    304 	int i;
    305 	uint16_t reg;
    306 
    307 	PHY_WRITE(sc, MII_BMCR, BMCR_RESET | BMCR_ISO);
    308 
    309 	/*
    310 	 * Regarding reset, the data sheet specifies (page 55):
    311 	 *
    312 	 * "After PHY reset, a delay of 10 ms is required before
    313 	 *  any register access using MDIO."
    314 	 */
    315 	delay(10000);
    316 
    317 	/* Wait another 100ms for it to complete. */
    318 	for (i = 0; i < 100; i++) {
    319 		PHY_READ(sc, MII_BMCR, &reg);
    320 		if ((reg & BMCR_RESET) == 0)
    321 			break;
    322 		delay(1000);
    323 	}
    324 
    325 	if (sc->mii_inst != 0)
    326 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    327 }
    328