Home | History | Annotate | Line # | Download | only in mii
nsphy.c revision 1.59
      1  1.59   msaitoh /*	$NetBSD: nsphy.c,v 1.59 2014/06/16 16:48:16 msaitoh Exp $	*/
      2   1.5   thorpej 
      3   1.5   thorpej /*-
      4  1.27   thorpej  * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
      5   1.5   thorpej  * All rights reserved.
      6   1.5   thorpej  *
      7   1.5   thorpej  * This code is derived from software contributed to The NetBSD Foundation
      8   1.5   thorpej  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
      9   1.5   thorpej  * NASA Ames Research Center.
     10   1.5   thorpej  *
     11   1.5   thorpej  * Redistribution and use in source and binary forms, with or without
     12   1.5   thorpej  * modification, are permitted provided that the following conditions
     13   1.5   thorpej  * are met:
     14   1.5   thorpej  * 1. Redistributions of source code must retain the above copyright
     15   1.5   thorpej  *    notice, this list of conditions and the following disclaimer.
     16   1.5   thorpej  * 2. Redistributions in binary form must reproduce the above copyright
     17   1.5   thorpej  *    notice, this list of conditions and the following disclaimer in the
     18   1.5   thorpej  *    documentation and/or other materials provided with the distribution.
     19   1.5   thorpej  *
     20   1.5   thorpej  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21   1.5   thorpej  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22   1.5   thorpej  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23   1.5   thorpej  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24   1.5   thorpej  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25   1.5   thorpej  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26   1.5   thorpej  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27   1.5   thorpej  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28   1.5   thorpej  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29   1.5   thorpej  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30   1.5   thorpej  * POSSIBILITY OF SUCH DAMAGE.
     31   1.5   thorpej  */
     32   1.5   thorpej 
     33   1.1    bouyer /*
     34   1.1    bouyer  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
     35   1.1    bouyer  *
     36   1.1    bouyer  * Redistribution and use in source and binary forms, with or without
     37   1.1    bouyer  * modification, are permitted provided that the following conditions
     38   1.1    bouyer  * are met:
     39   1.1    bouyer  * 1. Redistributions of source code must retain the above copyright
     40   1.1    bouyer  *    notice, this list of conditions and the following disclaimer.
     41   1.1    bouyer  * 2. Redistributions in binary form must reproduce the above copyright
     42   1.1    bouyer  *    notice, this list of conditions and the following disclaimer in the
     43   1.1    bouyer  *    documentation and/or other materials provided with the distribution.
     44   1.1    bouyer  *
     45   1.1    bouyer  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     46   1.1    bouyer  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     47   1.1    bouyer  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     48   1.1    bouyer  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     49   1.1    bouyer  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     50   1.1    bouyer  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     51   1.1    bouyer  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     52   1.1    bouyer  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     53   1.1    bouyer  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     54   1.1    bouyer  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     55   1.1    bouyer  */
     56   1.1    bouyer 
     57   1.5   thorpej /*
     58   1.5   thorpej  * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
     59   1.5   thorpej  * Data Sheet available from www.national.com
     60   1.5   thorpej  */
     61  1.33     lukem 
     62  1.33     lukem #include <sys/cdefs.h>
     63  1.59   msaitoh __KERNEL_RCSID(0, "$NetBSD: nsphy.c,v 1.59 2014/06/16 16:48:16 msaitoh Exp $");
     64   1.1    bouyer 
     65   1.1    bouyer #include <sys/param.h>
     66   1.1    bouyer #include <sys/systm.h>
     67   1.1    bouyer #include <sys/kernel.h>
     68   1.1    bouyer #include <sys/device.h>
     69   1.1    bouyer #include <sys/socket.h>
     70  1.17   thorpej #include <sys/errno.h>
     71   1.5   thorpej 
     72   1.1    bouyer #include <net/if.h>
     73   1.1    bouyer #include <net/if_media.h>
     74   1.1    bouyer 
     75   1.5   thorpej #include <dev/mii/mii.h>
     76   1.5   thorpej #include <dev/mii/miivar.h>
     77   1.5   thorpej #include <dev/mii/miidevs.h>
     78   1.5   thorpej 
     79   1.5   thorpej #include <dev/mii/nsphyreg.h>
     80   1.5   thorpej 
     81  1.54   xtraeme static int	nsphymatch(device_t, cfdata_t, void *);
     82  1.54   xtraeme static void	nsphyattach(device_t, device_t, void *);
     83   1.1    bouyer 
     84  1.54   xtraeme CFATTACH_DECL_NEW(nsphy, sizeof(struct mii_softc),
     85  1.38   thorpej     nsphymatch, nsphyattach, mii_phy_detach, mii_phy_activate);
     86   1.1    bouyer 
     87  1.42   thorpej static int	nsphy_service(struct mii_softc *, struct mii_data *, int);
     88  1.42   thorpej static void	nsphy_status(struct mii_softc *);
     89  1.42   thorpej static void	nsphy_reset(struct mii_softc *sc);
     90   1.5   thorpej 
     91  1.42   thorpej static const struct mii_phy_funcs nsphy_funcs = {
     92  1.40    briggs 	nsphy_service, nsphy_status, nsphy_reset,
     93  1.27   thorpej };
     94  1.27   thorpej 
     95  1.42   thorpej static const struct mii_phydesc nsphys[] = {
     96  1.31   thorpej 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83840,
     97  1.31   thorpej 	  MII_STR_xxNATSEMI_DP83840 },
     98  1.31   thorpej 
     99  1.31   thorpej 	{ 0,				0,
    100  1.31   thorpej 	  NULL },
    101  1.31   thorpej };
    102  1.31   thorpej 
    103  1.42   thorpej static int
    104  1.54   xtraeme nsphymatch(device_t parent, cfdata_t match, void *aux)
    105   1.1    bouyer {
    106   1.5   thorpej 	struct mii_attach_args *ma = aux;
    107   1.5   thorpej 
    108  1.31   thorpej 	if (mii_phy_match(ma, nsphys) != NULL)
    109  1.14   thorpej 		return (10);
    110   1.1    bouyer 
    111   1.5   thorpej 	return (0);
    112   1.1    bouyer }
    113   1.1    bouyer 
    114  1.42   thorpej static void
    115  1.54   xtraeme nsphyattach(device_t parent, device_t self, void *aux)
    116   1.1    bouyer {
    117  1.46   thorpej 	struct mii_softc *sc = device_private(self);
    118   1.5   thorpej 	struct mii_attach_args *ma = aux;
    119   1.5   thorpej 	struct mii_data *mii = ma->mii_data;
    120  1.31   thorpej 	const struct mii_phydesc *mpd;
    121   1.5   thorpej 
    122  1.31   thorpej 	mpd = mii_phy_match(ma, nsphys);
    123  1.39   thorpej 	aprint_naive(": Media interface\n");
    124  1.39   thorpej 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
    125   1.5   thorpej 
    126  1.54   xtraeme 	sc->mii_dev = self;
    127  1.15   thorpej 	sc->mii_inst = mii->mii_instance;
    128  1.15   thorpej 	sc->mii_phy = ma->mii_phyno;
    129  1.27   thorpej 	sc->mii_funcs = &nsphy_funcs;
    130  1.15   thorpej 	sc->mii_pdata = mii;
    131  1.34   thorpej 	sc->mii_flags = ma->mii_flags;
    132  1.49  christos 	sc->mii_anegticks = MII_ANEGTICKS;
    133  1.13   thorpej 
    134  1.27   thorpej 	PHY_RESET(sc);
    135   1.5   thorpej 
    136  1.15   thorpej 	sc->mii_capabilities =
    137  1.15   thorpej 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
    138  1.54   xtraeme 	aprint_normal_dev(self, "");
    139  1.15   thorpej 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
    140  1.39   thorpej 		aprint_error("no media present");
    141   1.5   thorpej 	else
    142  1.22   thorpej 		mii_phy_add_media(sc);
    143  1.39   thorpej 	aprint_normal("\n");
    144   1.5   thorpej }
    145   1.5   thorpej 
    146  1.42   thorpej static int
    147  1.32   thorpej nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
    148   1.5   thorpej {
    149  1.10   thorpej 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    150   1.5   thorpej 	int reg;
    151  1.21   thorpej 
    152   1.5   thorpej 	switch (cmd) {
    153   1.5   thorpej 	case MII_POLLSTAT:
    154   1.5   thorpej 		/*
    155   1.5   thorpej 		 * If we're not polling our PHY instance, just return.
    156   1.5   thorpej 		 */
    157  1.15   thorpej 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    158   1.5   thorpej 			return (0);
    159   1.5   thorpej 		break;
    160   1.5   thorpej 
    161   1.5   thorpej 	case MII_MEDIACHG:
    162   1.5   thorpej 		/*
    163   1.5   thorpej 		 * If the media indicates a different PHY instance,
    164   1.5   thorpej 		 * isolate ourselves.
    165   1.5   thorpej 		 */
    166  1.15   thorpej 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
    167  1.15   thorpej 			reg = PHY_READ(sc, MII_BMCR);
    168  1.15   thorpej 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    169   1.5   thorpej 			return (0);
    170   1.5   thorpej 		}
    171   1.5   thorpej 
    172   1.5   thorpej 		/*
    173   1.5   thorpej 		 * If the interface is not up, don't do anything.
    174   1.5   thorpej 		 */
    175   1.5   thorpej 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
    176   1.5   thorpej 			break;
    177   1.5   thorpej 
    178  1.15   thorpej 		reg = PHY_READ(sc, MII_NSPHY_PCR);
    179   1.9   thorpej 
    180   1.5   thorpej 		/*
    181   1.5   thorpej 		 * Set up the PCR to use LED4 to indicate full-duplex
    182   1.5   thorpej 		 * in both 10baseT and 100baseTX modes.
    183   1.5   thorpej 		 */
    184   1.9   thorpej 		reg |= PCR_LED4MODE;
    185   1.9   thorpej 
    186   1.9   thorpej 		/*
    187  1.41       wiz 		 * Make sure Carrier Integrity Monitor function is
    188   1.9   thorpej 		 * disabled (normal for Node operation, but sometimes
    189   1.9   thorpej 		 * it's not set?!)
    190   1.9   thorpej 		 */
    191   1.9   thorpej 		reg |= PCR_CIMDIS;
    192   1.9   thorpej 
    193   1.9   thorpej 		/*
    194  1.18   thorpej 		 * Make sure "force link good" is set to normal mode.
    195  1.18   thorpej 		 * It's only intended for debugging.
    196   1.9   thorpej 		 */
    197  1.18   thorpej 		reg |= PCR_FLINK100;
    198   1.9   thorpej 
    199   1.9   thorpej 		/*
    200   1.9   thorpej 		 * Mystery bits which are supposedly `reserved',
    201   1.9   thorpej 		 * but we seem to need to set them when the PHY
    202  1.28    martin 		 * is connected to some interfaces:
    203  1.28    martin 		 *
    204  1.28    martin 		 * 0x0400 is needed for fxp
    205  1.28    martin 		 *        (Intel EtherExpress Pro 10+/100B, 82557 chip)
    206  1.28    martin 		 *        (nsphy with a DP83840 chip)
    207  1.28    martin 		 * 0x0100 may be needed for some other card
    208   1.9   thorpej 		 */
    209   1.9   thorpej 		reg |= 0x0100 | 0x0400;
    210   1.9   thorpej 
    211  1.15   thorpej 		PHY_WRITE(sc, MII_NSPHY_PCR, reg);
    212   1.5   thorpej 
    213  1.25   thorpej 		mii_phy_setmedia(sc);
    214   1.5   thorpej 		break;
    215   1.5   thorpej 
    216   1.5   thorpej 	case MII_TICK:
    217   1.5   thorpej 		/*
    218   1.5   thorpej 		 * If we're not currently selected, just return.
    219   1.5   thorpej 		 */
    220  1.15   thorpej 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
    221   1.5   thorpej 			return (0);
    222   1.5   thorpej 
    223  1.26   thorpej 		if (mii_phy_tick(sc) == EJUSTRETURN)
    224  1.17   thorpej 			return (0);
    225   1.5   thorpej 		break;
    226  1.20   thorpej 
    227  1.20   thorpej 	case MII_DOWN:
    228  1.20   thorpej 		mii_phy_down(sc);
    229  1.20   thorpej 		return (0);
    230   1.5   thorpej 	}
    231   1.5   thorpej 
    232   1.5   thorpej 	/* Update the media status. */
    233  1.24   thorpej 	mii_phy_status(sc);
    234   1.5   thorpej 
    235   1.5   thorpej 	/* Callback if something changed. */
    236  1.26   thorpej 	mii_phy_update(sc, cmd);
    237   1.5   thorpej 	return (0);
    238   1.5   thorpej }
    239   1.5   thorpej 
    240  1.42   thorpej static void
    241  1.32   thorpej nsphy_status(struct mii_softc *sc)
    242   1.5   thorpej {
    243  1.15   thorpej 	struct mii_data *mii = sc->mii_pdata;
    244  1.19   thorpej 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
    245   1.8   thorpej 	int bmsr, bmcr, par, anlpar;
    246   1.5   thorpej 
    247   1.5   thorpej 	mii->mii_media_status = IFM_AVALID;
    248   1.5   thorpej 	mii->mii_media_active = IFM_ETHER;
    249   1.1    bouyer 
    250  1.15   thorpej 	bmsr = PHY_READ(sc, MII_BMSR) |
    251  1.15   thorpej 	    PHY_READ(sc, MII_BMSR);
    252   1.5   thorpej 	if (bmsr & BMSR_LINK)
    253   1.5   thorpej 		mii->mii_media_status |= IFM_ACTIVE;
    254   1.5   thorpej 
    255  1.15   thorpej 	bmcr = PHY_READ(sc, MII_BMCR);
    256   1.5   thorpej 	if (bmcr & BMCR_ISO) {
    257   1.5   thorpej 		mii->mii_media_active |= IFM_NONE;
    258   1.5   thorpej 		mii->mii_media_status = 0;
    259   1.1    bouyer 		return;
    260   1.1    bouyer 	}
    261   1.5   thorpej 
    262   1.5   thorpej 	if (bmcr & BMCR_LOOP)
    263   1.5   thorpej 		mii->mii_media_active |= IFM_LOOP;
    264   1.5   thorpej 
    265   1.5   thorpej 	if (bmcr & BMCR_AUTOEN) {
    266   1.5   thorpej 		/*
    267  1.58   msaitoh 		 * The PAR status bits are only valid if autonegotiation
    268   1.5   thorpej 		 * has completed (or it's disabled).
    269   1.5   thorpej 		 */
    270   1.5   thorpej 		if ((bmsr & BMSR_ACOMP) == 0) {
    271   1.7   thorpej 			/* Erg, still trying, I guess... */
    272   1.7   thorpej 			mii->mii_media_active |= IFM_NONE;
    273   1.5   thorpej 			return;
    274   1.5   thorpej 		}
    275   1.8   thorpej 
    276   1.8   thorpej 		/*
    277   1.8   thorpej 		 * Argh.  The PAR doesn't seem to indicate duplex mode
    278   1.8   thorpej 		 * properly!  Determine media based on link partner's
    279   1.8   thorpej 		 * advertised capabilities.
    280   1.8   thorpej 		 */
    281  1.15   thorpej 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
    282  1.15   thorpej 			anlpar = PHY_READ(sc, MII_ANAR) &
    283  1.15   thorpej 			    PHY_READ(sc, MII_ANLPAR);
    284  1.56    cegger 			if (anlpar & ANLPAR_TX_FD)
    285  1.56    cegger 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
    286  1.56    cegger 			else if (anlpar & ANLPAR_T4)
    287  1.59   msaitoh 				mii->mii_media_active |= IFM_100_T4|IFM_HDX;
    288   1.8   thorpej 			else if (anlpar & ANLPAR_TX)
    289  1.59   msaitoh 				mii->mii_media_active |= IFM_100_TX|IFM_HDX;
    290   1.8   thorpej 			else if (anlpar & ANLPAR_10_FD)
    291   1.8   thorpej 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
    292   1.8   thorpej 			else if (anlpar & ANLPAR_10)
    293  1.59   msaitoh 				mii->mii_media_active |= IFM_10_T|IFM_HDX;
    294   1.8   thorpej 			else
    295   1.8   thorpej 				mii->mii_media_active |= IFM_NONE;
    296   1.8   thorpej 			return;
    297   1.8   thorpej 		}
    298   1.8   thorpej 
    299   1.8   thorpej 		/*
    300   1.8   thorpej 		 * Link partner is not capable of autonegotiation.
    301   1.8   thorpej 		 * We will never be in full-duplex mode if this is
    302   1.8   thorpej 		 * the case, so reading the PAR is OK.
    303   1.8   thorpej 		 */
    304  1.15   thorpej 		par = PHY_READ(sc, MII_NSPHY_PAR);
    305   1.5   thorpej 		if (par & PAR_10)
    306   1.5   thorpej 			mii->mii_media_active |= IFM_10_T;
    307   1.5   thorpej 		else
    308   1.5   thorpej 			mii->mii_media_active |= IFM_100_TX;
    309  1.59   msaitoh 		mii->mii_media_active |= IFM_HDX;
    310  1.16   thorpej 	} else
    311  1.19   thorpej 		mii->mii_media_active = ife->ifm_media;
    312   1.1    bouyer }
    313  1.40    briggs 
    314  1.42   thorpej static void
    315  1.40    briggs nsphy_reset(struct mii_softc *sc)
    316  1.40    briggs {
    317  1.40    briggs 	int reg, i;
    318  1.40    briggs 
    319  1.40    briggs 	if (sc->mii_flags & MIIF_NOISOLATE)
    320  1.40    briggs 		reg = BMCR_RESET;
    321  1.40    briggs 	else
    322  1.40    briggs 		reg = BMCR_RESET | BMCR_ISO;
    323  1.40    briggs 	PHY_WRITE(sc, MII_BMCR, reg);
    324  1.40    briggs 
    325  1.40    briggs 	/*
    326  1.40    briggs 	 * Give it a little time to settle in case we just got power.
    327  1.40    briggs 	 * The DP83840A data sheet suggests that a soft reset not happen
    328  1.40    briggs 	 * within 500us of power being applied.  Be conservative.
    329  1.40    briggs 	 */
    330  1.40    briggs 	delay(1000);
    331  1.40    briggs 
    332  1.40    briggs 	/*
    333  1.40    briggs 	 * Wait another 2s for it to complete.
    334  1.40    briggs 	 * This is only a little overkill as under normal circumstances
    335  1.40    briggs 	 * the PHY can take up to 1s to complete reset.
    336  1.40    briggs 	 * This is also a bit odd because after a reset, the BMCR will
    337  1.40    briggs 	 * clear the reset bit and simply reports 0 even though the reset
    338  1.40    briggs 	 * is not yet complete.
    339  1.40    briggs 	 */
    340  1.40    briggs 	for (i = 0; i < 1000; i++) {
    341  1.43     perry 		reg = PHY_READ(sc, MII_BMCR);
    342  1.40    briggs 		if (reg && ((reg & BMCR_RESET) == 0))
    343  1.40    briggs 			break;
    344  1.40    briggs 		delay(2000);
    345  1.40    briggs 	}
    346  1.40    briggs 
    347  1.40    briggs 	if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0)) {
    348  1.40    briggs 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
    349  1.40    briggs 	}
    350  1.40    briggs }
    351