Home | History | Annotate | Line # | Download | only in mii
bmtphy.c revision 1.29
      1 /*	$NetBSD: bmtphy.c,v 1.29 2009/01/18 10:00:51 mrg 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  * 3. All advertising materials mentioning features or use of this software
     45  *    must display the following acknowledgement:
     46  *	This product includes software developed by Manuel Bouyer.
     47  * 4. The name of the author may not be used to endorse or promote products
     48  *    derived from this software without specific prior written permission.
     49  *
     50  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     53  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     59  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     60  */
     61 
     62 /*
     63  * Driver for the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
     64  * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
     65  * the 3c905C data sheet.
     66  */
     67 
     68 #include <sys/cdefs.h>
     69 __KERNEL_RCSID(0, "$NetBSD: bmtphy.c,v 1.29 2009/01/18 10:00:51 mrg 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/bmtphyreg.h>
     86 
     87 static int	bmtphymatch(device_t, cfdata_t, void *);
     88 static void	bmtphyattach(device_t, device_t, void *);
     89 
     90 CFATTACH_DECL_NEW(bmtphy, sizeof(struct mii_softc),
     91     bmtphymatch, bmtphyattach, mii_phy_detach, mii_phy_activate);
     92 
     93 static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
     94 static void	bmtphy_status(struct mii_softc *);
     95 static void	bmtphy_reset(struct mii_softc *);
     96 
     97 static const struct mii_phy_funcs bmtphy_funcs = {
     98 	bmtphy_service, bmtphy_status, bmtphy_reset,
     99 };
    100 
    101 static const struct mii_phydesc bmtphys[] = {
    102 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_3C905B,
    103 	  MII_STR_xxBROADCOM_3C905B },
    104 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_3C905C,
    105 	  MII_STR_xxBROADCOM_3C905C },
    106 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5201,
    107 	  MII_STR_xxBROADCOM_BCM5201 },
    108 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5214,
    109 	  MII_STR_xxBROADCOM_BCM5214 },
    110 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5221,
    111 	  MII_STR_xxBROADCOM_BCM5221 },
    112 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5222,
    113 	  MII_STR_xxBROADCOM_BCM5222 },
    114 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM4401,
    115 	  MII_STR_xxBROADCOM_BCM4401 },
    116 
    117 	{ 0,				0,
    118 	  NULL },
    119 };
    120 
    121 static int
    122 bmtphymatch(device_t parent, cfdata_t match, void *aux)
    123 {
    124 	struct mii_attach_args *ma = aux;
    125 
    126 	if (mii_phy_match(ma, bmtphys) != NULL)
    127 		return (10);
    128 
    129 	return (0);
    130 }
    131 
    132 static void
    133 bmtphyattach(device_t parent, device_t self, void *aux)
    134 {
    135 	struct mii_softc *sc = device_private(self);
    136 	struct mii_attach_args *ma = aux;
    137 	struct mii_data *mii = ma->mii_data;
    138 	const struct mii_phydesc *mpd;
    139 
    140 	mpd = mii_phy_match(ma, bmtphys);
    141 	aprint_naive(": Media interface\n");
    142 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    143 
    144 	sc->mii_dev = self;
    145 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
    146 	sc->mii_inst = mii->mii_instance;
    147 	sc->mii_phy = ma->mii_phyno;
    148 	sc->mii_funcs = &bmtphy_funcs;
    149 	sc->mii_pdata = mii;
    150 	sc->mii_flags = ma->mii_flags;
    151 	sc->mii_anegticks = MII_ANEGTICKS;
    152 
    153 	PHY_RESET(sc);
    154 
    155 	/*
    156 	 * XXX Check AUX_STS_FX_MODE to set MIIF_HAVE_FIBER?
    157 	 */
    158 
    159 	sc->mii_capabilities =
    160 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
    161 	aprint_normal_dev(self, "");
    162 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
    163 		aprint_error("no media present");
    164 	else
    165 		mii_phy_add_media(sc);
    166 	aprint_normal("\n");
    167 }
    168 
    169 static int
    170 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    171 {
    172 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    173 	int reg;
    174 
    175 	switch (cmd) {
    176 	case MII_POLLSTAT:
    177 		/*
    178 		 * If we're not polling our PHY instance, just return.
    179 		 */
    180 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    181 			return (0);
    182 		break;
    183 
    184 	case MII_MEDIACHG:
    185 		/*
    186 		 * If the media indicates a different PHY instance,
    187 		 * isolate ourselves.
    188 		 */
    189 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    190 			reg = PHY_READ(sc, MII_BMCR);
    191 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    192 			return (0);
    193 		}
    194 
    195 		/*
    196 		 * If the interface is not up, don't do anything.
    197 		 */
    198 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    199 			break;
    200 
    201 		mii_phy_setmedia(sc);
    202 		break;
    203 
    204 	case MII_TICK:
    205 		/*
    206 		 * If we're not currently selected, just return.
    207 		 */
    208 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    209 			return (0);
    210 
    211 		if (mii_phy_tick(sc) == EJUSTRETURN)
    212 			return (0);
    213 		break;
    214 
    215 	case MII_DOWN:
    216 		mii_phy_down(sc);
    217 		return (0);
    218 	}
    219 
    220 	/* Update the media status. */
    221 	mii_phy_status(sc);
    222 
    223 	/* Callback if something changed. */
    224 	mii_phy_update(sc, cmd);
    225 	return (0);
    226 }
    227 
    228 static void
    229 bmtphy_status(struct mii_softc *sc)
    230 {
    231 	struct mii_data *mii = sc->mii_pdata;
    232 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    233 	int bmsr, bmcr, aux_csr;
    234 
    235 	mii->mii_media_status = IFM_AVALID;
    236 	mii->mii_media_active = IFM_ETHER;
    237 
    238 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
    239 
    240 	if (bmsr & BMSR_LINK)
    241 		mii->mii_media_status |= IFM_ACTIVE;
    242 
    243 	bmcr = PHY_READ(sc, MII_BMCR);
    244 	if (bmcr & BMCR_ISO) {
    245 		mii->mii_media_active |= IFM_NONE;
    246 		mii->mii_media_status = 0;
    247 		return;
    248 	}
    249 
    250 	if (bmcr & BMCR_LOOP)
    251 		mii->mii_media_active |= IFM_LOOP;
    252 
    253 	if (bmcr & BMCR_AUTOEN) {
    254 		/*
    255 		 * The media status bits are only valid of autonegotiation
    256 		 * has completed (or it's disabled).
    257 		 */
    258 		if ((bmsr & BMSR_ACOMP) == 0) {
    259 			/* Erg, still trying, I guess... */
    260 			mii->mii_media_active |= IFM_NONE;
    261 			return;
    262 		}
    263 
    264 		aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
    265 		if (aux_csr & AUX_CSR_SPEED)
    266 			mii->mii_media_active |= IFM_100_TX;
    267 		else
    268 			mii->mii_media_active |= IFM_10_T;
    269 		if (aux_csr & AUX_CSR_FDX)
    270 			mii->mii_media_active |= IFM_FDX;
    271 		else
    272 			mii->mii_media_active |= IFM_HDX;
    273 
    274 		if (mii->mii_media_active & IFM_FDX)
    275 			mii->mii_media_active |= mii_phy_flowstatus(sc);
    276 	} else
    277 		mii->mii_media_active = ife->ifm_media;
    278 }
    279 
    280 static void
    281 bmtphy_reset(struct mii_softc *sc)
    282 {
    283 	u_int16_t data;
    284 
    285 	mii_phy_reset(sc);
    286 
    287 	if (sc->mii_mpd_model == MII_MODEL_xxBROADCOM_BCM5221) {
    288 		/* Enable shadow register mode */
    289 		data = PHY_READ(sc, 0x1f);
    290 		PHY_WRITE(sc, 0x1f, data | 0x0080);
    291 
    292 		/* Enable APD (Auto PowerDetect) */
    293 		data = PHY_READ(sc, MII_BMTPHY_AUX2);
    294 		PHY_WRITE(sc, MII_BMTPHY_AUX2, data | 0x0020);
    295 
    296 		/* Enable clocks across APD for
    297 		 * Auto-MDIX functionality */
    298 		data = PHY_READ(sc, MII_BMTPHY_INTR);
    299 		PHY_WRITE(sc, MII_BMTPHY_INTR, data | 0x0004);
    300 
    301 		/* Disable shadow register mode */
    302 		data = PHY_READ(sc, 0x1f);
    303 		PHY_WRITE(sc, 0x1f, data & ~0x0080);
    304 	}
    305 }
    306