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