Home | History | Annotate | Line # | Download | only in mii
jmphy.c revision 1.2
      1 /*	$NetBSD: jmphy.c,v 1.2 2019/11/26 08:19:51 msaitoh Exp $ */
      2 /*	$OpenBSD: jmphy.c,v 1.6 2015/03/14 03:38:48 jsg Exp $	*/
      3 /*-
      4  * Copyright (c) 2008, Pyun YongHyeon <yongari (at) FreeBSD.org>
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice unmodified, this list of conditions, and the following
     12  *    disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     27  * SUCH DAMAGE.
     28  *
     29  * $FreeBSD: src/sys/dev/mii/jmphy.c,v 1.1 2008/05/27 01:16:40 yongari Exp $
     30  * $DragonFly: src/sys/dev/netif/mii_layer/jmphy.c,v 1.1 2008/07/22 11:28:49 sephe Exp $
     31  */
     32 
     33 /*
     34  * Driver for the JMicron JMP211 10/100/1000, JMP202 10/100 PHY.
     35  */
     36 
     37 #include <sys/param.h>
     38 #include <sys/systm.h>
     39 #include <sys/device.h>
     40 #include <sys/socket.h>
     41 
     42 #include <net/if.h>
     43 #include <net/if_media.h>
     44 
     45 #include <dev/mii/mii.h>
     46 #include <dev/mii/miivar.h>
     47 #include <dev/mii/miidevs.h>
     48 #include <dev/mii/jmphyreg.h>
     49 
     50 static int	jmphy_service(struct mii_softc *, struct mii_data *, int);
     51 static void	jmphy_status(struct mii_softc *);
     52 static int	jmphy_match(device_t, cfdata_t, void *);
     53 static void	jmphy_attach(device_t, device_t, void *);
     54 static void	jmphy_reset(struct mii_softc *);
     55 static uint16_t	jmphy_anar(struct ifmedia_entry *);
     56 static int	jmphy_auto(struct mii_softc *, struct ifmedia_entry *);
     57 
     58 static const struct mii_phy_funcs jmphy_funcs = {
     59 	jmphy_service, jmphy_status, jmphy_reset,
     60 };
     61 
     62 CFATTACH_DECL_NEW(jmphy, sizeof (struct mii_softc),
     63     jmphy_match, jmphy_attach, mii_phy_detach, mii_phy_activate);
     64 
     65 static const struct mii_phydesc jmphys[] = {
     66 	MII_PHY_DESC(JMICRON, JMP202),
     67 	MII_PHY_DESC(JMICRON, JMP211),
     68 	MII_PHY_END,
     69 };
     70 
     71 static int
     72 jmphy_match(device_t parent, cfdata_t match, void *aux)
     73 {
     74 	struct mii_attach_args *ma = aux;
     75 
     76 	if (mii_phy_match(ma, jmphys) != NULL)
     77 		return 10;
     78 
     79 	return 0;
     80 }
     81 
     82 static void
     83 jmphy_attach(device_t parent, device_t self, void *aux)
     84 {
     85 	struct mii_softc *sc = device_private(self);
     86 	struct mii_attach_args *ma = aux;
     87 	struct mii_data *mii = ma->mii_data;
     88 	const struct mii_phydesc *mpd;
     89 
     90 	mpd = mii_phy_match(ma, jmphys);
     91 	aprint_naive(": Media interface\n");
     92 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
     93 
     94 	sc->mii_dev = self;
     95 	sc->mii_inst = mii->mii_instance;
     96 	sc->mii_phy = ma->mii_phyno;
     97 	sc->mii_funcs = &jmphy_funcs;
     98 	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
     99 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
    100 	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
    101 	sc->mii_pdata = mii;
    102 	sc->mii_flags = ma->mii_flags;
    103 
    104 	sc->mii_flags |= MIIF_NOISOLATE | MIIF_NOLOOP;
    105 
    106 	PHY_RESET(sc);
    107 
    108 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    109 	sc->mii_capabilities &= ma->mii_capmask;
    110 	if (sc->mii_capabilities & BMSR_EXTSTAT)
    111 		PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
    112 
    113 	aprint_normal_dev(self, "");
    114 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
    115 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
    116 		aprint_error("no media present");
    117 	else
    118 		mii_phy_add_media(sc);
    119 	aprint_normal("\n");
    120 }
    121 
    122 static int
    123 jmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    124 {
    125 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    126 	uint16_t bmcr, ssr;
    127 
    128 	switch (cmd) {
    129 	case MII_POLLSTAT:
    130 		/* If we're not polling our PHY instance, just return. */
    131 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    132 			return 0;
    133 		break;
    134 
    135 	case MII_MEDIACHG:
    136 		/*
    137 		 * If the media indicates a different PHY instance,
    138 		 * isolate ourselves.
    139 		 */
    140 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    141 			PHY_READ(sc, MII_BMCR, &bmcr);
    142 			PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO);
    143 			return 0;
    144 		}
    145 
    146 		/* If the interface is not up, don't do anything. */
    147 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    148 			break;
    149 
    150 		if (jmphy_auto(sc, ife) != EJUSTRETURN)
    151 			return EINVAL;
    152 		break;
    153 
    154 	case MII_TICK:
    155 		/* If we're not currently selected, just return. */
    156 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    157 			return 0;
    158 
    159 		/* Is the interface even up? */
    160 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    161 			return 0;
    162 
    163 		/* Only used for autonegotiation. */
    164 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
    165 			break;
    166 
    167 		/* Check for link. */
    168 		PHY_READ(sc, JMPHY_SSR, &ssr);
    169 		if (ssr & JMPHY_SSR_LINK_UP) {
    170 			sc->mii_ticks = 0;
    171 			break;
    172 		}
    173 
    174 		/* Announce link loss right after it happens. */
    175 		if (sc->mii_ticks++ == 0)
    176 			break;
    177 		if (sc->mii_ticks <= sc->mii_anegticks)
    178 			return 0;
    179 
    180 		sc->mii_ticks = 0;
    181 		jmphy_auto(sc, ife);
    182 		break;
    183 	}
    184 
    185 	/* Update the media status. */
    186 	jmphy_status(sc);
    187 
    188 	/* Callback if something changed. */
    189 	mii_phy_update(sc, cmd);
    190 	return 0;
    191 }
    192 
    193 static void
    194 jmphy_status(struct mii_softc *sc)
    195 {
    196 	struct mii_data *mii = sc->mii_pdata;
    197 	uint16_t bmcr, ssr, gtsr;
    198 
    199 	mii->mii_media_status = IFM_AVALID;
    200 	mii->mii_media_active = IFM_ETHER;
    201 
    202 	PHY_READ(sc, JMPHY_SSR, &ssr);
    203 	if ((ssr & JMPHY_SSR_LINK_UP) != 0)
    204 		mii->mii_media_status |= IFM_ACTIVE;
    205 
    206 	PHY_READ(sc, MII_BMCR, &bmcr);
    207 	if ((bmcr & BMCR_ISO) != 0) {
    208 		mii->mii_media_active |= IFM_NONE;
    209 		mii->mii_media_status = 0;
    210 		return;
    211 	}
    212 
    213 	if ((bmcr & BMCR_LOOP) != 0)
    214 		mii->mii_media_active |= IFM_LOOP;
    215 
    216 	if ((ssr & JMPHY_SSR_SPD_DPLX_RESOLVED) == 0) {
    217 		/* Erg, still trying, I guess... */
    218 		mii->mii_media_active |= IFM_NONE;
    219 		return;
    220 	}
    221 
    222 	switch ((ssr & JMPHY_SSR_SPEED_MASK)) {
    223 	case JMPHY_SSR_SPEED_1000:
    224 		mii->mii_media_active |= IFM_1000_T;
    225 		/*
    226 		 * jmphy(4) got a valid link so reset mii_ticks.
    227 		 * Resetting mii_ticks is needed in order to
    228 		 * detect link loss after auto-negotiation.
    229 		 */
    230 		sc->mii_ticks = 0;
    231 		break;
    232 	case JMPHY_SSR_SPEED_100:
    233 		mii->mii_media_active |= IFM_100_TX;
    234 		sc->mii_ticks = 0;
    235 		break;
    236 	case JMPHY_SSR_SPEED_10:
    237 		mii->mii_media_active |= IFM_10_T;
    238 		sc->mii_ticks = 0;
    239 		break;
    240 	default:
    241 		mii->mii_media_active |= IFM_NONE;
    242 		return;
    243 	}
    244 
    245 	if ((ssr & JMPHY_SSR_DUPLEX) != 0)
    246 		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
    247 	else
    248 		mii->mii_media_active |= IFM_HDX;
    249 
    250 	if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) {
    251 		PHY_READ(sc, MII_GTSR, &gtsr);
    252 		if ((gtsr & GTSR_MS_RES) != 0)
    253 			mii->mii_media_active |= IFM_ETH_MASTER;
    254 	}
    255 }
    256 
    257 static void
    258 jmphy_reset(struct mii_softc *sc)
    259 {
    260 	int i;
    261 	uint16_t val;
    262 
    263 	/* Disable sleep mode. */
    264 	PHY_READ(sc, JMPHY_TMCTL, &val);
    265 	PHY_WRITE(sc, JMPHY_TMCTL, val & ~JMPHY_TMCTL_SLEEP_ENB);
    266 
    267 	PHY_READ(sc, MII_BMCR, &val);
    268 	PHY_WRITE(sc, MII_BMCR, val | BMCR_RESET);
    269 
    270 	for (i = 0; i < 1000; i++) {
    271 		DELAY(1);
    272 		PHY_READ(sc, MII_BMCR, &val);
    273 		if ((val & BMCR_RESET) == 0)
    274 			break;
    275 	}
    276 }
    277 
    278 static uint16_t
    279 jmphy_anar(struct ifmedia_entry *ife)
    280 {
    281 	uint16_t anar;
    282 
    283 	anar = 0;
    284 	switch (IFM_SUBTYPE(ife->ifm_media)) {
    285 	case IFM_AUTO:
    286 		anar |= ANAR_TX_FD | ANAR_TX | ANAR_10_FD | ANAR_10;
    287 		break;
    288 	case IFM_1000_T:
    289 		break;
    290 	case IFM_100_TX:
    291 		anar |= ANAR_TX | ANAR_TX_FD;
    292 		break;
    293 	case IFM_10_T:
    294 		anar |= ANAR_10 | ANAR_10_FD;
    295 		break;
    296 	default:
    297 		break;
    298 	}
    299 
    300 	return anar;
    301 }
    302 
    303 static int
    304 jmphy_auto(struct mii_softc *sc, struct ifmedia_entry *ife)
    305 {
    306 	uint16_t anar, bmcr, gig;
    307 
    308 	gig = 0;
    309 	PHY_READ(sc, MII_BMCR, &bmcr);
    310 	switch (IFM_SUBTYPE(ife->ifm_media)) {
    311 	case IFM_AUTO:
    312 		gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
    313 		break;
    314 	case IFM_1000_T:
    315 		gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
    316 		break;
    317 	case IFM_100_TX:
    318 	case IFM_10_T:
    319 		break;
    320 	case IFM_NONE:
    321 		PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO | BMCR_PDOWN);
    322 		return EJUSTRETURN;
    323 	default:
    324 		return EINVAL;
    325 	}
    326 
    327 	if ((ife->ifm_media & IFM_LOOP) != 0)
    328 		bmcr |= BMCR_LOOP;
    329 
    330 	anar = jmphy_anar(ife);
    331 	if (sc->mii_flags & MIIF_DOPAUSE)
    332 		anar |= ANAR_PAUSE_TOWARDS;
    333 
    334 	if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0) {
    335 #ifdef notyet
    336 		struct mii_data *mii;
    337 
    338 		mii = sc->mii_pdata;
    339 		if ((mii->mii_media.ifm_media & IFM_ETH_MASTER) != 0)
    340 			gig |= GTCR_MAN_MS | GTCR_MAN_ADV;
    341 #endif
    342 		PHY_WRITE(sc, MII_100T2CR, gig);
    343 	}
    344 	PHY_WRITE(sc, MII_ANAR, anar | ANAR_CSMA);
    345 	PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_AUTOEN | BMCR_STARTNEG);
    346 
    347 	return EJUSTRETURN;
    348 }
    349