Home | History | Annotate | Line # | Download | only in mii
icsphy.c revision 1.41.34.1
      1 /*	$NetBSD: icsphy.c,v 1.41.34.1 2007/12/26 19:46:35 ad 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.
     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 Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY
     71  * datasheet from www.icst.com
     72  */
     73 
     74 #include <sys/cdefs.h>
     75 __KERNEL_RCSID(0, "$NetBSD: icsphy.c,v 1.41.34.1 2007/12/26 19:46:35 ad Exp $");
     76 
     77 #include <sys/param.h>
     78 #include <sys/systm.h>
     79 #include <sys/kernel.h>
     80 #include <sys/device.h>
     81 #include <sys/socket.h>
     82 
     83 #include <net/if.h>
     84 #include <net/if_media.h>
     85 
     86 #include <dev/mii/mii.h>
     87 #include <dev/mii/miivar.h>
     88 #include <dev/mii/miidevs.h>
     89 
     90 #include <dev/mii/icsphyreg.h>
     91 
     92 static int	icsphymatch(struct device *, struct cfdata *, void *);
     93 static void	icsphyattach(struct device *, struct device *, void *);
     94 
     95 CFATTACH_DECL(icsphy, sizeof(struct mii_softc),
     96     icsphymatch, icsphyattach, mii_phy_detach, mii_phy_activate);
     97 
     98 static int	icsphy_service(struct mii_softc *, struct mii_data *, int);
     99 static void	icsphy_status(struct mii_softc *);
    100 static void	icsphy_reset(struct mii_softc *);
    101 
    102 static const struct mii_phy_funcs icsphy_funcs = {
    103 	icsphy_service, icsphy_status, icsphy_reset,
    104 };
    105 
    106 static const struct mii_phydesc icsphys[] = {
    107 	{ MII_OUI_ICS,		MII_MODEL_ICS_1889,
    108 	  MII_STR_ICS_1889 },
    109 
    110 	{ MII_OUI_ICS,		MII_MODEL_ICS_1890,
    111 	  MII_STR_ICS_1890 },
    112 
    113 	{ MII_OUI_ICS,		MII_MODEL_ICS_1892,
    114 	  MII_STR_ICS_1892 },
    115 
    116 	{ MII_OUI_ICS,		MII_MODEL_ICS_1893,
    117 	  MII_STR_ICS_1893 },
    118 
    119 	{ 0,			0,
    120 	  NULL },
    121 };
    122 
    123 static int
    124 icsphymatch(struct device *parent, struct cfdata *match,
    125     void *aux)
    126 {
    127 	struct mii_attach_args *ma = aux;
    128 
    129 	if (mii_phy_match(ma, icsphys) != NULL)
    130 		return (10);
    131 
    132 	return (0);
    133 }
    134 
    135 static void
    136 icsphyattach(struct device *parent, struct device *self, void *aux)
    137 {
    138 	struct mii_softc *sc = device_private(self);
    139 	struct mii_attach_args *ma = aux;
    140 	struct mii_data *mii = ma->mii_data;
    141 	const struct mii_phydesc *mpd;
    142 
    143 	mpd = mii_phy_match(ma, icsphys);
    144 	aprint_naive(": Media interface\n");
    145 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    146 
    147 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
    148 	sc->mii_inst = mii->mii_instance;
    149 	sc->mii_phy = ma->mii_phyno;
    150 	sc->mii_funcs = &icsphy_funcs;
    151 	sc->mii_pdata = mii;
    152 	sc->mii_flags = ma->mii_flags;
    153 	sc->mii_anegticks = MII_ANEGTICKS;
    154 
    155 	PHY_RESET(sc);
    156 
    157 	sc->mii_capabilities =
    158 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
    159 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
    160 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
    161 		aprint_error("no media present");
    162 	else
    163 		mii_phy_add_media(sc);
    164 	aprint_normal("\n");
    165 
    166 	if (!pmf_device_register(self, NULL, mii_phy_resume))
    167 		aprint_error_dev(self, "couldn't establish power handler\n");
    168 }
    169 
    170 static int
    171 icsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    172 {
    173 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    174 	int reg;
    175 
    176 	if (!device_is_active(&sc->mii_dev))
    177 		return (ENXIO);
    178 
    179 	switch (cmd) {
    180 	case MII_POLLSTAT:
    181 		/*
    182 		 * If we're not polling our PHY instance, just return.
    183 		 */
    184 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    185 			return (0);
    186 		break;
    187 
    188 	case MII_MEDIACHG:
    189 		/*
    190 		 * If the media indicates a different PHY instance,
    191 		 * isolate ourselves.
    192 		 */
    193 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    194 			reg = PHY_READ(sc, MII_BMCR);
    195 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    196 			return (0);
    197 		}
    198 
    199 		/*
    200 		 * If the interface is not up, don't do anything.
    201 		 */
    202 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    203 			break;
    204 
    205 		mii_phy_setmedia(sc);
    206 		break;
    207 
    208 	case MII_TICK:
    209 		/*
    210 		 * If we're not currently selected, just return.
    211 		 */
    212 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    213 			return (0);
    214 
    215 		if (mii_phy_tick(sc) == EJUSTRETURN)
    216 			return (0);
    217 		break;
    218 
    219 	case MII_DOWN:
    220 		mii_phy_down(sc);
    221 		return (0);
    222 	}
    223 
    224 	/* Update the media status. */
    225 	mii_phy_status(sc);
    226 
    227 	/* Callback if something changed. */
    228 	mii_phy_update(sc, cmd);
    229 	return (0);
    230 }
    231 
    232 static void
    233 icsphy_status(struct mii_softc *sc)
    234 {
    235 	struct mii_data *mii = sc->mii_pdata;
    236 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    237 	int bmcr, qpr;
    238 
    239 	mii->mii_media_status = IFM_AVALID;
    240 	mii->mii_media_active = IFM_ETHER;
    241 
    242 	/*
    243 	 * Don't get link from the BMSR.  It's available in the QPR,
    244 	 * and we have to read it twice to unlatch it anyhow.  This
    245 	 * gives us fewer register reads.
    246 	 */
    247 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
    248 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
    249 
    250 	if (qpr & QPR_LINK)
    251 		mii->mii_media_status |= IFM_ACTIVE;
    252 
    253 	bmcr = PHY_READ(sc, MII_BMCR);
    254 	if (bmcr & BMCR_ISO) {
    255 		mii->mii_media_active |= IFM_NONE;
    256 		mii->mii_media_status = 0;
    257 		return;
    258 	}
    259 
    260 	if (bmcr & BMCR_LOOP)
    261 		mii->mii_media_active |= IFM_LOOP;
    262 
    263 	if (bmcr & BMCR_AUTOEN) {
    264 		if ((qpr & QPR_ACOMP) == 0) {
    265 			/* Erg, still trying, I guess... */
    266 			mii->mii_media_active |= IFM_NONE;
    267 			return;
    268 		}
    269 		if (qpr & QPR_SPEED)
    270 			mii->mii_media_active |= IFM_100_TX;
    271 		else
    272 			mii->mii_media_active |= IFM_10_T;
    273 		if (qpr & QPR_FDX)
    274 			mii->mii_media_active |= IFM_FDX;
    275 	} else
    276 		mii->mii_media_active = ife->ifm_media;
    277 }
    278 
    279 static void
    280 icsphy_reset(struct mii_softc *sc)
    281 {
    282 
    283 	mii_phy_reset(sc);
    284 	/* set powerdown feature */
    285 	switch (sc->mii_mpd_model) {
    286 		case MII_MODEL_ICS_1890:
    287 		case MII_MODEL_ICS_1893:
    288 			PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
    289 			break;
    290 		case MII_MODEL_ICS_1892:
    291 			PHY_WRITE(sc, MII_ICSPHY_ECR2,
    292 			    ECR2_10AUTOPWRDN|ECR2_100AUTOPWRDN);
    293 			break;
    294 		default:
    295 			/* 1889 have no ECR2 */
    296 			break;
    297 	}
    298 	/*
    299 	 * There is no description that the reset do auto-negotiation in the
    300 	 * data sheet.
    301 	 */
    302 	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_STARTNEG|BMCR_FDX);
    303 }
    304