Home | History | Annotate | Line # | Download | only in mii
      1 /*	$NetBSD: qsphy.c,v 1.55 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 Quality Semiconductor's QS6612 ethernet 10/100 PHY
     59  * datasheet from www.qualitysemi.com
     60  */
     61 
     62 #include <sys/cdefs.h>
     63 __KERNEL_RCSID(0, "$NetBSD: qsphy.c,v 1.55 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/qsphyreg.h>
     79 
     80 static int	qsphymatch(device_t, cfdata_t, void *);
     81 static void	qsphyattach(device_t, device_t, void *);
     82 
     83 CFATTACH_DECL_NEW(qsphy, sizeof(struct mii_softc),
     84     qsphymatch, qsphyattach, mii_phy_detach, mii_phy_activate);
     85 
     86 static int	qsphy_service(struct mii_softc *, struct mii_data *, int);
     87 static void	qsphy_status(struct mii_softc *);
     88 static void	qsphy_reset(struct mii_softc *);
     89 
     90 static const struct mii_phy_funcs qsphy_funcs = {
     91 	qsphy_service, qsphy_status, qsphy_reset,
     92 };
     93 
     94 static const struct mii_phydesc qsphys[] = {
     95 	MII_PHY_DESC(xxQUALSEMI, QS6612),
     96 	MII_PHY_END,
     97 };
     98 
     99 static int
    100 qsphymatch(device_t parent, cfdata_t match, void *aux)
    101 {
    102 	struct mii_attach_args *ma = aux;
    103 
    104 	if (mii_phy_match(ma, qsphys) != NULL)
    105 		return 10;
    106 
    107 	return 0;
    108 }
    109 
    110 static void
    111 qsphyattach(device_t parent, device_t self, void *aux)
    112 {
    113 	struct mii_softc *sc = device_private(self);
    114 	struct mii_attach_args *ma = aux;
    115 	struct mii_data *mii = ma->mii_data;
    116 	const struct mii_phydesc *mpd;
    117 
    118 	mpd = mii_phy_match(ma, qsphys);
    119 	aprint_naive(": Media interface\n");
    120 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    121 
    122 	sc->mii_dev = self;
    123 	sc->mii_inst = mii->mii_instance;
    124 	sc->mii_phy = ma->mii_phyno;
    125 	sc->mii_funcs = &qsphy_funcs;
    126 	sc->mii_pdata = mii;
    127 	sc->mii_flags = ma->mii_flags;
    128 
    129 	mii_lock(mii);
    130 
    131 	PHY_RESET(sc);
    132 
    133 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
    134 	sc->mii_capabilities &= ma->mii_capmask;
    135 
    136 	mii_unlock(mii);
    137 
    138 	mii_phy_add_media(sc);
    139 }
    140 
    141 static int
    142 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    143 {
    144 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    145 	uint16_t reg;
    146 
    147 	KASSERT(mii_locked(mii));
    148 
    149 	switch (cmd) {
    150 	case MII_POLLSTAT:
    151 		/* If we're not polling our PHY instance, just return. */
    152 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    153 			return 0;
    154 		break;
    155 
    156 	case MII_MEDIACHG:
    157 		/*
    158 		 * If the media indicates a different PHY instance,
    159 		 * isolate ourselves.
    160 		 */
    161 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    162 			PHY_READ(sc, MII_BMCR, &reg);
    163 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    164 			return 0;
    165 		}
    166 
    167 		/* If the interface is not up, don't do anything. */
    168 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    169 			break;
    170 
    171 		mii_phy_setmedia(sc);
    172 		break;
    173 
    174 	case MII_TICK:
    175 		/* If we're not currently selected, just return. */
    176 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    177 			return 0;
    178 
    179 		if (mii_phy_tick(sc) == EJUSTRETURN)
    180 			return 0;
    181 		break;
    182 
    183 	case MII_DOWN:
    184 		mii_phy_down(sc);
    185 		return 0;
    186 	}
    187 
    188 	/* Update the media status. */
    189 	mii_phy_status(sc);
    190 
    191 	/* Callback if something changed. */
    192 	mii_phy_update(sc, cmd);
    193 	return 0;
    194 }
    195 
    196 static void
    197 qsphy_status(struct mii_softc *sc)
    198 {
    199 	struct mii_data *mii = sc->mii_pdata;
    200 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    201 	uint16_t bmsr, bmcr, pctl;
    202 
    203 	KASSERT(mii_locked(mii));
    204 
    205 	mii->mii_media_status = IFM_AVALID;
    206 	mii->mii_media_active = IFM_ETHER;
    207 
    208 	PHY_READ(sc, MII_BMSR, &bmsr);
    209 	PHY_READ(sc, MII_BMSR, &bmsr);
    210 	if (bmsr & BMSR_LINK)
    211 		mii->mii_media_status |= IFM_ACTIVE;
    212 
    213 	PHY_READ(sc, MII_BMCR, &bmcr);
    214 	if (bmcr & BMCR_ISO) {
    215 		mii->mii_media_active |= IFM_NONE;
    216 		mii->mii_media_status = 0;
    217 		return;
    218 	}
    219 
    220 	if (bmcr & BMCR_LOOP)
    221 		mii->mii_media_active |= IFM_LOOP;
    222 
    223 	if (bmcr & BMCR_AUTOEN) {
    224 		if ((bmsr & BMSR_ACOMP) == 0) {
    225 			/* Erg, still trying, I guess... */
    226 			mii->mii_media_active |= IFM_NONE;
    227 			return;
    228 		}
    229 		PHY_READ(sc, MII_QSPHY_PCTL, &pctl);
    230 		PHY_READ(sc, MII_QSPHY_PCTL, &pctl);
    231 		switch (pctl & PCTL_OPMASK) {
    232 		case PCTL_10_T:
    233 			mii->mii_media_active |= IFM_10_T | IFM_HDX;
    234 			break;
    235 		case PCTL_10_T_FDX:
    236 			mii->mii_media_active |= IFM_10_T | IFM_FDX;
    237 			break;
    238 		case PCTL_100_TX:
    239 			mii->mii_media_active |= IFM_100_TX | IFM_HDX;
    240 			break;
    241 		case PCTL_100_TX_FDX:
    242 			mii->mii_media_active |= IFM_100_TX | IFM_FDX;
    243 			break;
    244 		case PCTL_100_T4:
    245 			mii->mii_media_active |= IFM_100_T4 | IFM_HDX;
    246 			break;
    247 		default:
    248 			/* Erg... this shouldn't happen. */
    249 			mii->mii_media_active |= IFM_NONE;
    250 			break;
    251 		}
    252 	} else
    253 		mii->mii_media_active = ife->ifm_media;
    254 }
    255 
    256 static void
    257 qsphy_reset(struct mii_softc *sc)
    258 {
    259 
    260 	KASSERT(mii_locked(sc->mii_pdata));
    261 
    262 	mii_phy_reset(sc);
    263 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
    264 }
    265