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