Home | History | Annotate | Line # | Download | only in mii
      1 /*	$NetBSD: icsphy.c,v 1.56 2020/03/15 23:04:50 thorpej 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.56 2020/03/15 23:04:50 thorpej 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_PHY_DESC(ICS, 1889),
     96 	MII_PHY_DESC(ICS, 1890),
     97 	MII_PHY_DESC(ICS, 1892),
     98 	MII_PHY_DESC(ICS, 1893),
     99 	MII_PHY_DESC(ICS, 1893C),
    100 	MII_PHY_END,
    101 };
    102 
    103 static int
    104 icsphymatch(device_t parent, cfdata_t match, void *aux)
    105 {
    106 	struct mii_attach_args *ma = aux;
    107 
    108 	if (mii_phy_match(ma, icsphys) != NULL)
    109 		return 10;
    110 
    111 	return 0;
    112 }
    113 
    114 static void
    115 icsphyattach(device_t parent, device_t self, void *aux)
    116 {
    117 	struct mii_softc *sc = device_private(self);
    118 	struct mii_attach_args *ma = aux;
    119 	struct mii_data *mii = ma->mii_data;
    120 	const struct mii_phydesc *mpd;
    121 
    122 	mpd = mii_phy_match(ma, icsphys);
    123 	aprint_naive(": Media interface\n");
    124 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    125 
    126 	sc->mii_dev = self;
    127 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
    128 	sc->mii_inst = mii->mii_instance;
    129 	sc->mii_phy = ma->mii_phyno;
    130 	sc->mii_funcs = &icsphy_funcs;
    131 	sc->mii_pdata = mii;
    132 	sc->mii_flags = ma->mii_flags;
    133 
    134 	mii_lock(mii);
    135 
    136 	PHY_RESET(sc);
    137 
    138 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    139 	sc->mii_capabilities &= ma->mii_capmask;
    140 
    141 	mii_unlock(mii);
    142 
    143 	mii_phy_add_media(sc);
    144 }
    145 
    146 static int
    147 icsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    148 {
    149 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    150 	uint16_t reg;
    151 
    152 	KASSERT(mii_locked(mii));
    153 
    154 	switch (cmd) {
    155 	case MII_POLLSTAT:
    156 		/* If we're not polling our PHY instance, just return. */
    157 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    158 			return 0;
    159 		break;
    160 
    161 	case MII_MEDIACHG:
    162 		/*
    163 		 * If the media indicates a different PHY instance,
    164 		 * isolate ourselves.
    165 		 */
    166 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    167 			PHY_READ(sc, MII_BMCR, &reg);
    168 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    169 			return 0;
    170 		}
    171 
    172 		/* If the interface is not up, don't do anything. */
    173 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    174 			break;
    175 
    176 		mii_phy_setmedia(sc);
    177 		break;
    178 
    179 	case MII_TICK:
    180 		/* If we're not currently selected, just return. */
    181 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    182 			return 0;
    183 
    184 		if (mii_phy_tick(sc) == EJUSTRETURN)
    185 			return 0;
    186 		break;
    187 
    188 	case MII_DOWN:
    189 		mii_phy_down(sc);
    190 		return 0;
    191 	}
    192 
    193 	/* Update the media status. */
    194 	mii_phy_status(sc);
    195 
    196 	/* Callback if something changed. */
    197 	mii_phy_update(sc, cmd);
    198 	return 0;
    199 }
    200 
    201 static void
    202 icsphy_status(struct mii_softc *sc)
    203 {
    204 	struct mii_data *mii = sc->mii_pdata;
    205 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    206 	uint16_t bmcr, qpr;
    207 
    208 	KASSERT(mii_locked(mii));
    209 
    210 	mii->mii_media_status = IFM_AVALID;
    211 	mii->mii_media_active = IFM_ETHER;
    212 
    213 	/*
    214 	 * Don't get link from the BMSR.  It's available in the QPR,
    215 	 * and we have to read it twice to unlatch it anyhow.  This
    216 	 * gives us fewer register reads.
    217 	 */
    218 	PHY_READ(sc, MII_ICSPHY_QPR, &qpr);	/* unlatch */
    219 	PHY_READ(sc, MII_ICSPHY_QPR, &qpr);	/* real value */
    220 
    221 	if (qpr & QPR_LINK)
    222 		mii->mii_media_status |= IFM_ACTIVE;
    223 
    224 	PHY_READ(sc, MII_BMCR, &bmcr);
    225 	if (bmcr & BMCR_ISO) {
    226 		mii->mii_media_active |= IFM_NONE;
    227 		mii->mii_media_status = 0;
    228 		return;
    229 	}
    230 
    231 	if (bmcr & BMCR_LOOP)
    232 		mii->mii_media_active |= IFM_LOOP;
    233 
    234 	if (bmcr & BMCR_AUTOEN) {
    235 		if ((qpr & QPR_ACOMP) == 0) {
    236 			/* Erg, still trying, I guess... */
    237 			mii->mii_media_active |= IFM_NONE;
    238 			return;
    239 		}
    240 		if (qpr & QPR_SPEED)
    241 			mii->mii_media_active |= IFM_100_TX;
    242 		else
    243 			mii->mii_media_active |= IFM_10_T;
    244 
    245 		if (qpr & QPR_FDX)
    246 			mii->mii_media_active |= IFM_FDX;
    247 		else
    248 			mii->mii_media_active |= IFM_HDX;
    249 	} else
    250 		mii->mii_media_active = ife->ifm_media;
    251 }
    252 
    253 static void
    254 icsphy_reset(struct mii_softc *sc)
    255 {
    256 
    257 	KASSERT(mii_locked(sc->mii_pdata));
    258 
    259 	mii_phy_reset(sc);
    260 	/* Set powerdown feature */
    261 	switch (sc->mii_mpd_model) {
    262 		case MII_MODEL_ICS_1890:
    263 		case MII_MODEL_ICS_1893:
    264 			PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
    265 			break;
    266 		case MII_MODEL_ICS_1892:
    267 			PHY_WRITE(sc, MII_ICSPHY_ECR2,
    268 			    ECR2_10AUTOPWRDN | ECR2_100AUTOPWRDN);
    269 			break;
    270 		default:
    271 			/* 1889 have no ECR2 */
    272 			break;
    273 	}
    274 	/*
    275 	 * There is no description that the reset do auto-negotiation in the
    276 	 * data sheet.
    277 	 */
    278 	PHY_WRITE(sc, MII_BMCR, BMCR_S100 | BMCR_STARTNEG | BMCR_FDX);
    279 }
    280