sys/dev/mii/nsphyter.c

   1 /*      $NetBSD: nsphyter.c,v 1.34 2009/04/02 00:09:33 dyoung Exp $     */
   2
   3 /*-
   4  * Copyright (c) 1998, 1999, 2000, 2001 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 National Semiconductor's DP83843 `PHYTER' ethernet 10/100 PHY
  59  * Data Sheet available from www.national.com
  60  *
  61  * We also support the DP83815 MacPHYER internal PHY since, for our
  62  * purposes, they are compatible.
  63  */
  64
  65 #include <sys/cdefs.h>
  66 __KERNEL_RCSID(0, "$NetBSD: nsphyter.c,v 1.34 2009/04/02 00:09:33 dyoung Exp $");
  67
  68 #include <sys/param.h>
  69 #include <sys/systm.h>
  70 #include <sys/kernel.h>
  71 #include <sys/device.h>
  72 #include <sys/socket.h>
  73 #include <sys/errno.h>
  74
  75 #include <net/if.h>
  76 #include <net/if_media.h>
  77
  78 #include <dev/mii/mii.h>
  79 #include <dev/mii/miivar.h>
  80 #include <dev/mii/miidevs.h>
  81
  82 #include <dev/mii/nsphyterreg.h>
  83
  84 static int      nsphytermatch(device_t, cfdata_t, void *);
  85 static void     nsphyterattach(device_t, device_t, void *);
  86
  87 CFATTACH_DECL3_NEW(nsphyter, sizeof(struct mii_softc),
  88     nsphytermatch, nsphyterattach, mii_phy_detach, mii_phy_activate, NULL,
  89     NULL, DVF_DETACH_SHUTDOWN);
  90
  91 static int      nsphyter_service(struct mii_softc *, struct mii_data *, int);
  92 static void     nsphyter_status(struct mii_softc *);
  93 static void     nsphyter_reset(struct mii_softc *);
  94
  95 static const struct mii_phy_funcs nsphyter_funcs = {
  96         nsphyter_service, nsphyter_status, nsphyter_reset,
  97 };
  98
  99 static const struct mii_phydesc nsphyters[] = {
 100         { MII_OUI_xxNATSEMI,            MII_MODEL_xxNATSEMI_DP83843,
 101           MII_STR_xxNATSEMI_DP83843 },
 102
 103         { MII_OUI_xxNATSEMI,            MII_MODEL_xxNATSEMI_DP83847,
 104           MII_STR_xxNATSEMI_DP83847 },
 105
 106         { MII_OUI_xxNATSEMI,            MII_MODEL_xxNATSEMI_DP83815,
 107           MII_STR_xxNATSEMI_DP83815 },
 108
 109         { 0,                            0,
 110           NULL },
 111 };
 112
 113 static int
 114 nsphytermatch(device_t parent, cfdata_t match, void *aux)
 115 {
 116         struct mii_attach_args *ma = aux;
 117
 118         if (mii_phy_match(ma, nsphyters) != NULL)
 119                 return (10);
 120
 121         return (0);
 122 }
 123
 124 static void
 125 nsphyterattach(device_t parent, device_t self, void *aux)
 126 {
 127         struct mii_softc *sc = device_private(self);
 128         struct mii_attach_args *ma = aux;
 129         struct mii_data *mii = ma->mii_data;
 130         const struct mii_phydesc *mpd;
 131
 132         mpd = mii_phy_match(ma, nsphyters);
 133         aprint_naive(": Media interface\n");
 134         aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
 135
 136         sc->mii_dev = self;
 137         sc->mii_inst = mii->mii_instance;
 138         sc->mii_phy = ma->mii_phyno;
 139         sc->mii_funcs = &nsphyter_funcs;
 140         sc->mii_pdata = mii;
 141         sc->mii_flags = ma->mii_flags;
 142         sc->mii_anegticks = MII_ANEGTICKS;
 143
 144         PHY_RESET(sc);
 145
 146         sc->mii_capabilities =
 147             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 148         aprint_normal_dev(self, "");
 149         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 150                 aprint_error("no media present");
 151         else
 152                 mii_phy_add_media(sc);
 153         aprint_normal("\n");
 154 }
 155
 156 static int
 157 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 158 {
 159         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 160         int reg;
 161
 162         switch (cmd) {
 163         case MII_POLLSTAT:
 164                 /*
 165                  * If we're not polling our PHY instance, just return.
 166                  */
 167                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 168                         return (0);
 169                 break;
 170
 171         case MII_MEDIACHG:
 172                 /*
 173                  * If the media indicates a different PHY instance,
 174                  * isolate ourselves.
 175                  */
 176                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 177                         reg = PHY_READ(sc, MII_BMCR);
 178                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 179                         return (0);
 180                 }
 181
 182                 /*
 183                  * If the interface is not up, don't do anything.
 184                  */
 185                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 186                         break;
 187
 188                 mii_phy_setmedia(sc);
 189                 break;
 190
 191         case MII_TICK:
 192                 /*
 193                  * If we're not currently selected, just return.
 194                  */
 195                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 196                         return (0);
 197
 198                 if (mii_phy_tick(sc) == EJUSTRETURN)
 199                         return (0);
 200                 break;
 201
 202         case MII_DOWN:
 203                 mii_phy_down(sc);
 204                 return (0);
 205         }
 206
 207         /* Update the media status. */
 208         mii_phy_status(sc);
 209
 210         /* Callback if something changed. */
 211         mii_phy_update(sc, cmd);
 212         return (0);
 213 }
 214
 215 static void
 216 nsphyter_status(struct mii_softc *sc)
 217 {
 218         struct mii_data *mii = sc->mii_pdata;
 219         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 220         int bmsr, bmcr, physts;
 221
 222         mii->mii_media_status = IFM_AVALID;
 223         mii->mii_media_active = IFM_ETHER;
 224
 225         bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 226         physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
 227
 228         if (physts & PHYSTS_LINK)
 229                 mii->mii_media_status |= IFM_ACTIVE;
 230
 231         bmcr = PHY_READ(sc, MII_BMCR);
 232         if (bmcr & BMCR_ISO) {
 233                 mii->mii_media_active |= IFM_NONE;
 234                 mii->mii_media_status = 0;
 235                 return;
 236         }
 237
 238         if (bmcr & BMCR_LOOP)
 239                 mii->mii_media_active |= IFM_LOOP;
 240
 241         if (bmcr & BMCR_AUTOEN) {
 242                 /*
 243                  * The media status bits are only valid of autonegotiation
 244                  * has completed (or it's disabled).
 245                  */
 246                 if ((bmsr & BMSR_ACOMP) == 0) {
 247                         /* Erg, still trying, I guess... */
 248                         mii->mii_media_active |= IFM_NONE;
 249                         return;
 250                 }
 251
 252                 if (physts & PHYSTS_SPEED10)
 253                         mii->mii_media_active |= IFM_10_T;
 254                 else
 255                         mii->mii_media_active |= IFM_100_TX;
 256                 if (physts & PHYSTS_DUPLEX)
 257                         mii->mii_media_active |=
 258                             IFM_FDX | mii_phy_flowstatus(sc);
 259         } else
 260                 mii->mii_media_active = ife->ifm_media;
 261 }
 262
 263 void
 264 nsphyter_reset(struct mii_softc *sc)
 265 {
 266         int reg, i;
 267
 268         if (sc->mii_flags & MIIF_NOISOLATE)
 269                 reg = BMCR_RESET;
 270         else
 271                 reg = BMCR_RESET | BMCR_ISO;
 272         PHY_WRITE(sc, MII_BMCR, reg);
 273
 274         /*
 275          * It is best to allow a little time for the reset to settle
 276          * in before we start polling the BMCR again.  Notably, the
 277          * DP83840A manual states that there should be a 500us delay
 278          * between asserting software reset and attempting MII serial
 279          * operations.  Also, a DP83815 can get into a bad state on
 280          * cable removal and reinsertion if we do not delay here.
 281          */
 282         delay(500);
 283
 284         /* Wait another 100ms for it to complete. */
 285         for (i = 0; i < 100; i++) {
 286                 reg = PHY_READ(sc, MII_BMCR);
 287                 if ((reg & BMCR_RESET) == 0)
 288                         break;
 289                 delay(1000);
 290         }
 291
 292         if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
 293                 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 294 }