Home | History | Annotate | Line # | Download | only in mii
brgphy.c revision 1.10
      1 /*	$NetBSD: brgphy.c,v 1.10 2002/07/13 01:23:27 thorpej 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  * 3. All advertising materials mentioning features or use of this software
     20  *    must display the following acknowledgement:
     21  *	This product includes software developed by the NetBSD
     22  *	Foundation, Inc. and its contributors.
     23  * 4. Neither the name of The NetBSD Foundation nor the names of its
     24  *    contributors may be used to endorse or promote products derived
     25  *    from this software without specific prior written permission.
     26  *
     27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     37  * POSSIBILITY OF SUCH DAMAGE.
     38  */
     39 
     40 /*
     41  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
     42  *
     43  * Redistribution and use in source and binary forms, with or without
     44  * modification, are permitted provided that the following conditions
     45  * are met:
     46  * 1. Redistributions of source code must retain the above copyright
     47  *    notice, this list of conditions and the following disclaimer.
     48  * 2. Redistributions in binary form must reproduce the above copyright
     49  *    notice, this list of conditions and the following disclaimer in the
     50  *    documentation and/or other materials provided with the distribution.
     51  * 3. All advertising materials mentioning features or use of this software
     52  *    must display the following acknowledgement:
     53  *	This product includes software developed by Manuel Bouyer.
     54  * 4. The name of the author may not be used to endorse or promote products
     55  *    derived from this software without specific prior written permission.
     56  *
     57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     67  */
     68 
     69 /*
     70  * driver for the Broadcom BCM5400 Gig-E PHY.
     71  *
     72  * Programming information for this PHY was gleaned from FreeBSD
     73  * (they were apparently able to get a datasheet from Broadcom).
     74  */
     75 
     76 #include <sys/cdefs.h>
     77 __KERNEL_RCSID(0, "$NetBSD: brgphy.c,v 1.10 2002/07/13 01:23:27 thorpej Exp $");
     78 
     79 #include <sys/param.h>
     80 #include <sys/systm.h>
     81 #include <sys/kernel.h>
     82 #include <sys/device.h>
     83 #include <sys/socket.h>
     84 #include <sys/errno.h>
     85 
     86 #include <net/if.h>
     87 #include <net/if_media.h>
     88 
     89 #include <dev/mii/mii.h>
     90 #include <dev/mii/miivar.h>
     91 #include <dev/mii/miidevs.h>
     92 
     93 #include <dev/mii/brgphyreg.h>
     94 
     95 int	brgphymatch(struct device *, struct cfdata *, void *);
     96 void	brgphyattach(struct device *, struct device *, void *);
     97 
     98 struct cfattach brgphy_ca = {
     99 	sizeof(struct mii_softc), brgphymatch, brgphyattach,
    100 	    mii_phy_detach, mii_phy_activate
    101 };
    102 
    103 int	brgphy_service(struct mii_softc *, struct mii_data *, int);
    104 void	brgphy_status(struct mii_softc *);
    105 
    106 void	brgphy_5401_reset(struct mii_softc *);
    107 void	brgphy_5411_reset(struct mii_softc *);
    108 
    109 const struct mii_phy_funcs brgphy_funcs = {
    110 	brgphy_service, brgphy_status, mii_phy_reset,
    111 };
    112 
    113 const struct mii_phy_funcs brgphy_5401_funcs = {
    114 	brgphy_service, brgphy_status, brgphy_5401_reset,
    115 };
    116 
    117 const struct mii_phy_funcs brgphy_5411_funcs = {
    118 	brgphy_service, brgphy_status, brgphy_5411_reset,
    119 };
    120 
    121 const struct mii_phydesc brgphys[] = {
    122 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5400,
    123 	  MII_STR_BROADCOM_BCM5400 },
    124 
    125 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5401,
    126 	  MII_STR_BROADCOM_BCM5401 },
    127 
    128 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5411,
    129 	  MII_STR_BROADCOM_BCM5411 },
    130 
    131 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5421,
    132 	  MII_STR_BROADCOM_BCM5421 },
    133 
    134 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5701,
    135 	  MII_STR_BROADCOM_BCM5701 },
    136 
    137 	{ 0,				0,
    138 	  NULL },
    139 };
    140 
    141 static void bcm5401_load_dspcode(struct mii_softc *);
    142 static void bcm5411_load_dspcode(struct mii_softc *);
    143 
    144 int
    145 brgphymatch(struct device *parent, struct cfdata *match, void *aux)
    146 {
    147 	struct mii_attach_args *ma = aux;
    148 
    149 	if (mii_phy_match(ma, brgphys) != NULL)
    150 		return (10);
    151 
    152 	return (0);
    153 }
    154 
    155 void
    156 brgphyattach(struct device *parent, struct device *self, void *aux)
    157 {
    158 	struct mii_softc *sc = (struct mii_softc *)self;
    159 	struct mii_attach_args *ma = aux;
    160 	struct mii_data *mii = ma->mii_data;
    161 	const struct mii_phydesc *mpd;
    162 
    163 	mpd = mii_phy_match(ma, brgphys);
    164 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    165 
    166 	sc->mii_inst = mii->mii_instance;
    167 	sc->mii_phy = ma->mii_phyno;
    168 	sc->mii_pdata = mii;
    169 	sc->mii_flags = ma->mii_flags;
    170 	sc->mii_anegticks = 5;
    171 
    172 	switch (MII_MODEL(ma->mii_id2)) {
    173 	case MII_MODEL_BROADCOM_BCM5400:
    174 		sc->mii_funcs = &brgphy_5401_funcs;
    175 		printf("%s: using BCM5401 DSP patch\n", sc->mii_dev.dv_xname);
    176 		break;
    177 
    178 	case MII_MODEL_BROADCOM_BCM5401:
    179 		if (MII_REV(ma->mii_id2) == 1 || MII_REV(ma->mii_id2) == 3) {
    180 			sc->mii_funcs = &brgphy_5401_funcs;
    181 			printf("%s: using BCM5401 DSP patch\n",
    182 			    sc->mii_dev.dv_xname);
    183 		} else
    184 			sc->mii_funcs = &brgphy_funcs;
    185 		break;
    186 
    187 	case MII_MODEL_BROADCOM_BCM5411:
    188 		sc->mii_funcs = &brgphy_5411_funcs;
    189 		printf("%s: using BCM5411 DSP patch\n", sc->mii_dev.dv_xname);
    190 		break;
    191 
    192 	default:
    193 		sc->mii_funcs = &brgphy_funcs;
    194 		break;
    195 	}
    196 
    197 	PHY_RESET(sc);
    198 
    199 	sc->mii_capabilities =
    200 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
    201 	if (sc->mii_capabilities & BMSR_EXTSTAT)
    202 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
    203 
    204 	printf("%s: ", sc->mii_dev.dv_xname);
    205 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
    206 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
    207 		printf("no media present");
    208 	else
    209 		mii_phy_add_media(sc);
    210 	printf("\n");
    211 }
    212 
    213 int
    214 brgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    215 {
    216 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    217 	int reg;
    218 
    219 	switch (cmd) {
    220 	case MII_POLLSTAT:
    221 		/*
    222 		 * If we're not polling our PHY instance, just return.
    223 		 */
    224 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    225 			return (0);
    226 		break;
    227 
    228 	case MII_MEDIACHG:
    229 		/*
    230 		 * If the media indicates a different PHY instance,
    231 		 * isolate ourselves.
    232 		 */
    233 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    234 			reg = PHY_READ(sc, MII_BMCR);
    235 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    236 			return (0);
    237 		}
    238 
    239 		/*
    240 		 * If the interface is not up, don't do anything.
    241 		 */
    242 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    243 			break;
    244 
    245 		mii_phy_reset(sc);	/* XXX hardware bug work-around */
    246 		mii_phy_setmedia(sc);
    247 		break;
    248 
    249 	case MII_TICK:
    250 		/*
    251 		 * If we're not currently selected, just return.
    252 		 */
    253 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    254 			return (0);
    255 
    256 		if (mii_phy_tick(sc) == EJUSTRETURN)
    257 			return (0);
    258 		break;
    259 
    260 	case MII_DOWN:
    261 		mii_phy_down(sc);
    262 		return (0);
    263 	}
    264 
    265 	/* Update the media status. */
    266 	mii_phy_status(sc);
    267 
    268 	/*
    269 	 * Callback if something changed.  Note that we need to poke
    270 	 * the DSP on the Broadcom PHYs if the media changes.
    271 	 */
    272 	if (sc->mii_media_active != mii->mii_media_active ||
    273 	    sc->mii_media_status != mii->mii_media_status ||
    274 	    cmd == MII_MEDIACHG) {
    275 		mii_phy_update(sc, cmd);
    276 		if (sc->mii_funcs == &brgphy_5401_funcs)
    277 			bcm5401_load_dspcode(sc);
    278 		else if (sc->mii_funcs == &brgphy_5411_funcs)
    279 			bcm5411_load_dspcode(sc);
    280 	}
    281 	return (0);
    282 }
    283 
    284 void
    285 brgphy_status(struct mii_softc *sc)
    286 {
    287 	struct mii_data *mii = sc->mii_pdata;
    288 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    289 	int bmcr, auxsts, gtsr;
    290 
    291 	mii->mii_media_status = IFM_AVALID;
    292 	mii->mii_media_active = IFM_ETHER;
    293 
    294 	auxsts = PHY_READ(sc, BRGPHY_MII_AUXSTS);
    295 
    296 	if (auxsts & BRGPHY_AUXSTS_LINK)
    297 		mii->mii_media_status |= IFM_ACTIVE;
    298 
    299 	bmcr = PHY_READ(sc, MII_BMCR);
    300 	if (bmcr & BMCR_ISO) {
    301 		mii->mii_media_active |= IFM_NONE;
    302 		mii->mii_media_status = 0;
    303 		return;
    304 	}
    305 
    306 	if (bmcr & BMCR_LOOP)
    307 		mii->mii_media_active |= IFM_LOOP;
    308 
    309 	if (bmcr & BMCR_AUTOEN) {
    310 		/*
    311 		 * The media status bits are only valid of autonegotiation
    312 		 * has completed (or it's disabled).
    313 		 */
    314 		if ((auxsts & BRGPHY_AUXSTS_ACOMP) == 0) {
    315 			/* Erg, still trying, I guess... */
    316 			mii->mii_media_active |= IFM_NONE;
    317 			return;
    318 		}
    319 
    320 		switch (auxsts & BRGPHY_AUXSTS_AN_RES) {
    321 		case BRGPHY_RES_1000FD:
    322 			mii->mii_media_active |= IFM_1000_T|IFM_FDX;
    323 			gtsr = PHY_READ(sc, MII_100T2SR);
    324 			if (gtsr & GTSR_MS_RES)
    325 				mii->mii_media_active |= IFM_ETH_MASTER;
    326 			break;
    327 
    328 		case BRGPHY_RES_1000HD:
    329 			mii->mii_media_active |= IFM_1000_T;
    330 			gtsr = PHY_READ(sc, MII_100T2SR);
    331 			if (gtsr & GTSR_MS_RES)
    332 				mii->mii_media_active |= IFM_ETH_MASTER;
    333 			break;
    334 
    335 		case BRGPHY_RES_100FD:
    336 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
    337 			break;
    338 
    339 		case BRGPHY_RES_100T4:
    340 			mii->mii_media_active |= IFM_100_T4;
    341 			break;
    342 
    343 		case BRGPHY_RES_100HD:
    344 			mii->mii_media_active |= IFM_100_TX;
    345 			break;
    346 
    347 		case BRGPHY_RES_10FD:
    348 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
    349 			break;
    350 
    351 		case BRGPHY_RES_10HD:
    352 			mii->mii_media_active |= IFM_10_T;
    353 			break;
    354 
    355 		default:
    356 			mii->mii_media_active |= IFM_NONE;
    357 			mii->mii_media_status = 0;
    358 		}
    359 	} else
    360 		mii->mii_media_active = ife->ifm_media;
    361 }
    362 
    363 void
    364 brgphy_5401_reset(struct mii_softc *sc)
    365 {
    366 
    367 	mii_phy_reset(sc);
    368 	bcm5401_load_dspcode(sc);
    369 }
    370 
    371 void
    372 brgphy_5411_reset(struct mii_softc *sc)
    373 {
    374 
    375 	mii_phy_reset(sc);
    376 	bcm5411_load_dspcode(sc);
    377 }
    378 
    379 static void
    380 bcm5401_load_dspcode(struct mii_softc *sc)
    381 {
    382 	static const struct {
    383 		int		reg;
    384 		uint16_t	val;
    385 	} dspcode[] = {
    386 		{ BRGPHY_MII_AUXCTL,		0x4c20 },
    387 		{ BRGPHY_MII_DSP_ADDR_REG,	0x0012 },
    388 		{ BRGPHY_MII_DSP_RW_PORT,	0x1804 },
    389 		{ BRGPHY_MII_DSP_ADDR_REG,	0x0013 },
    390 		{ BRGPHY_MII_DSP_RW_PORT,	0x1204 },
    391 		{ BRGPHY_MII_DSP_ADDR_REG,	0x8006 },
    392 		{ BRGPHY_MII_DSP_RW_PORT,	0x0132 },
    393 		{ BRGPHY_MII_DSP_ADDR_REG,	0x8006 },
    394 		{ BRGPHY_MII_DSP_RW_PORT,	0x0232 },
    395 		{ BRGPHY_MII_DSP_ADDR_REG,	0x201f },
    396 		{ BRGPHY_MII_DSP_RW_PORT,	0x0a20 },
    397 		{ 0,				0 },
    398 	};
    399 	int i;
    400 
    401 	for (i = 0; dspcode[i].reg != 0; i++)
    402 		PHY_WRITE(sc, dspcode[i].reg, dspcode[i].val);
    403 }
    404 
    405 static void
    406 bcm5411_load_dspcode(struct mii_softc *sc)
    407 {
    408 	static const struct {
    409 		int		reg;
    410 		uint16_t	val;
    411 	} dspcode[] = {
    412 		{ 0x1c,				0x8c23 },
    413 		{ 0x1c,				0x8ca3 },
    414 		{ 0x1c,				0x8c23 },
    415 		{ 0,				0 },
    416 	};
    417 	int i;
    418 
    419 	for (i = 0; dspcode[i].reg != 0; i++)
    420 		PHY_WRITE(sc, dspcode[i].reg, dspcode[i].val);
    421 }
    422