Home | History | Annotate | Line # | Download | only in mii
bmtphy.c revision 1.33
      1 /*	$NetBSD: bmtphy.c,v 1.33 2019/01/22 03:42:27 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 the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
     59  * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
     60  * the 3c905C data sheet.
     61  */
     62 
     63 #include <sys/cdefs.h>
     64 __KERNEL_RCSID(0, "$NetBSD: bmtphy.c,v 1.33 2019/01/22 03:42:27 msaitoh Exp $");
     65 
     66 #include <sys/param.h>
     67 #include <sys/systm.h>
     68 #include <sys/kernel.h>
     69 #include <sys/device.h>
     70 #include <sys/socket.h>
     71 #include <sys/errno.h>
     72 
     73 #include <net/if.h>
     74 #include <net/if_media.h>
     75 
     76 #include <dev/mii/mii.h>
     77 #include <dev/mii/miivar.h>
     78 #include <dev/mii/miidevs.h>
     79 
     80 #include <dev/mii/bmtphyreg.h>
     81 
     82 static int	bmtphymatch(device_t, cfdata_t, void *);
     83 static void	bmtphyattach(device_t, device_t, void *);
     84 
     85 CFATTACH_DECL_NEW(bmtphy, sizeof(struct mii_softc),
     86     bmtphymatch, bmtphyattach, mii_phy_detach, mii_phy_activate);
     87 
     88 static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
     89 static void	bmtphy_status(struct mii_softc *);
     90 static void	bmtphy_reset(struct mii_softc *);
     91 
     92 static const struct mii_phy_funcs bmtphy_funcs = {
     93 	bmtphy_service, bmtphy_status, bmtphy_reset,
     94 };
     95 
     96 static const struct mii_phydesc bmtphys[] = {
     97 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_3C905B,
     98 	  MII_STR_xxBROADCOM_3C905B },
     99 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_3C905C,
    100 	  MII_STR_xxBROADCOM_3C905C },
    101 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5201,
    102 	  MII_STR_xxBROADCOM_BCM5201 },
    103 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5214,
    104 	  MII_STR_xxBROADCOM_BCM5214 },
    105 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5221,
    106 	  MII_STR_xxBROADCOM_BCM5221 },
    107 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5222,
    108 	  MII_STR_xxBROADCOM_BCM5222 },
    109 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM4401,
    110 	  MII_STR_xxBROADCOM_BCM4401 },
    111 
    112 	{ 0,				0,
    113 	  NULL },
    114 };
    115 
    116 static int
    117 bmtphymatch(device_t parent, cfdata_t match, void *aux)
    118 {
    119 	struct mii_attach_args *ma = aux;
    120 
    121 	if (mii_phy_match(ma, bmtphys) != NULL)
    122 		return (10);
    123 
    124 	return (0);
    125 }
    126 
    127 static void
    128 bmtphyattach(device_t parent, device_t self, void *aux)
    129 {
    130 	struct mii_softc *sc = device_private(self);
    131 	struct mii_attach_args *ma = aux;
    132 	struct mii_data *mii = ma->mii_data;
    133 	const struct mii_phydesc *mpd;
    134 
    135 	mpd = mii_phy_match(ma, bmtphys);
    136 	aprint_naive(": Media interface\n");
    137 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    138 
    139 	sc->mii_dev = self;
    140 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
    141 	sc->mii_inst = mii->mii_instance;
    142 	sc->mii_phy = ma->mii_phyno;
    143 	sc->mii_funcs = &bmtphy_funcs;
    144 	sc->mii_pdata = mii;
    145 	sc->mii_flags = ma->mii_flags;
    146 	sc->mii_anegticks = MII_ANEGTICKS;
    147 
    148 	PHY_RESET(sc);
    149 
    150 	/*
    151 	 * XXX Check AUX_STS_FX_MODE to set MIIF_HAVE_FIBER?
    152 	 */
    153 
    154 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    155 	sc->mii_capabilities &= ma->mii_capmask;
    156 	aprint_normal_dev(self, "");
    157 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
    158 		aprint_error("no media present");
    159 	else
    160 		mii_phy_add_media(sc);
    161 	aprint_normal("\n");
    162 }
    163 
    164 static int
    165 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    166 {
    167 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    168 	uint16_t reg;
    169 
    170 	switch (cmd) {
    171 	case MII_POLLSTAT:
    172 		/*
    173 		 * If we're not polling our PHY instance, just return.
    174 		 */
    175 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    176 			return (0);
    177 		break;
    178 
    179 	case MII_MEDIACHG:
    180 		/*
    181 		 * If the media indicates a different PHY instance,
    182 		 * isolate ourselves.
    183 		 */
    184 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    185 			PHY_READ(sc, MII_BMCR, &reg);
    186 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    187 			return (0);
    188 		}
    189 
    190 		/*
    191 		 * If the interface is not up, don't do anything.
    192 		 */
    193 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    194 			break;
    195 
    196 		mii_phy_setmedia(sc);
    197 		break;
    198 
    199 	case MII_TICK:
    200 		/*
    201 		 * If we're not currently selected, just return.
    202 		 */
    203 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    204 			return (0);
    205 
    206 		if (mii_phy_tick(sc) == EJUSTRETURN)
    207 			return (0);
    208 		break;
    209 
    210 	case MII_DOWN:
    211 		mii_phy_down(sc);
    212 		return (0);
    213 	}
    214 
    215 	/* Update the media status. */
    216 	mii_phy_status(sc);
    217 
    218 	/* Callback if something changed. */
    219 	mii_phy_update(sc, cmd);
    220 	return (0);
    221 }
    222 
    223 static void
    224 bmtphy_status(struct mii_softc *sc)
    225 {
    226 	struct mii_data *mii = sc->mii_pdata;
    227 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    228 	uint16_t bmsr, bmcr, aux_csr;
    229 
    230 	mii->mii_media_status = IFM_AVALID;
    231 	mii->mii_media_active = IFM_ETHER;
    232 
    233 	PHY_READ(sc, MII_BMSR, &bmsr);
    234 	PHY_READ(sc, MII_BMSR, &bmsr);
    235 
    236 	if (bmsr & BMSR_LINK)
    237 		mii->mii_media_status |= IFM_ACTIVE;
    238 
    239 	PHY_READ(sc, MII_BMCR, &bmcr);
    240 	if (bmcr & BMCR_ISO) {
    241 		mii->mii_media_active |= IFM_NONE;
    242 		mii->mii_media_status = 0;
    243 		return;
    244 	}
    245 
    246 	if (bmcr & BMCR_LOOP)
    247 		mii->mii_media_active |= IFM_LOOP;
    248 
    249 	if (bmcr & BMCR_AUTOEN) {
    250 		/*
    251 		 * The media status bits are only valid if autonegotiation
    252 		 * has completed (or it's disabled).
    253 		 */
    254 		if ((bmsr & BMSR_ACOMP) == 0) {
    255 			/* Erg, still trying, I guess... */
    256 			mii->mii_media_active |= IFM_NONE;
    257 			return;
    258 		}
    259 
    260 		PHY_READ(sc, MII_BMTPHY_AUX_CSR, &aux_csr);
    261 		if (aux_csr & AUX_CSR_SPEED)
    262 			mii->mii_media_active |= IFM_100_TX;
    263 		else
    264 			mii->mii_media_active |= IFM_10_T;
    265 		if (aux_csr & AUX_CSR_FDX)
    266 			mii->mii_media_active |= IFM_FDX;
    267 		else
    268 			mii->mii_media_active |= IFM_HDX;
    269 
    270 		if (mii->mii_media_active & IFM_FDX)
    271 			mii->mii_media_active |= mii_phy_flowstatus(sc);
    272 	} else
    273 		mii->mii_media_active = ife->ifm_media;
    274 }
    275 
    276 static void
    277 bmtphy_reset(struct mii_softc *sc)
    278 {
    279 	uint16_t data;
    280 
    281 	mii_phy_reset(sc);
    282 
    283 	if (sc->mii_mpd_model == MII_MODEL_xxBROADCOM_BCM5221) {
    284 		/* Enable shadow register mode */
    285 		PHY_READ(sc, 0x1f, &data);
    286 		PHY_WRITE(sc, 0x1f, data | 0x0080);
    287 
    288 		/* Enable APD (Auto PowerDetect) */
    289 		PHY_READ(sc, MII_BMTPHY_AUX2, &data);
    290 		PHY_WRITE(sc, MII_BMTPHY_AUX2, data | 0x0020);
    291 
    292 		/* Enable clocks across APD for Auto-MDIX functionality */
    293 		PHY_READ(sc, MII_BMTPHY_INTR, &data);
    294 		PHY_WRITE(sc, MII_BMTPHY_INTR, data | 0x0004);
    295 
    296 		/* Disable shadow register mode */
    297 		PHY_READ(sc, 0x1f, &data);
    298 		PHY_WRITE(sc, 0x1f, data & ~0x0080);
    299 	}
    300 }
    301