sys/dev/mii/nsgphy.c

   1 /*-
   2  * Copyright (c) 2001 Wind River Systems
   3  * Copyright (c) 2001
   4  *      Bill Paul <wpaul@bsdi.com>.  All rights reserved.
   5  * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to The NetBSD Foundation
   9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
  10  * NASA Ames Research Center.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by Bill Paul.
  23  * 4. Neither the name of the author nor the names of any co-contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  37  * THE POSSIBILITY OF SUCH DAMAGE.
  38  */
  39
  40 #include <sys/cdefs.h>
  41 __FBSDID("$FreeBSD$");
  42
  43 /*
  44  * Driver for the National Semiconductor DP83891 and DP83861
  45  * 10/100/1000 PHYs.
  46  * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf
  47  *
  48  * The DP83891 is the older NatSemi gigE PHY which isn't being sold
  49  * anymore. The DP83861 is its replacement, which is an 'enhanced'
  50  * firmware driven component. The major difference between the
  51  * two is that the 83891 can't generate interrupts, while the
  52  * 83861 can. (I think it wasn't originally designed to do this, but
  53  * it can now thanks to firmware updates.) The 83861 also allows
  54  * access to its internal RAM via indirect register access.
  55  */
  56
  57 #include <sys/param.h>
  58 #include <sys/systm.h>
  59 #include <sys/kernel.h>
  60 #include <sys/module.h>
  61 #include <sys/socket.h>
  62 #include <sys/bus.h>
  63
  64 #include <machine/clock.h>
  65
  66 #include <net/if.h>
  67 #include <net/if_media.h>
  68
  69 #include <dev/mii/mii.h>
  70 #include <dev/mii/miivar.h>
  71 #include "miidevs.h"
  72
  73 #include <dev/mii/nsgphyreg.h>
  74
  75 #include "miibus_if.h"
  76
  77 static int nsgphy_probe(device_t);
  78 static int nsgphy_attach(device_t);
  79
  80 static device_method_t nsgphy_methods[] = {
  81         /* device interface */
  82         DEVMETHOD(device_probe,         nsgphy_probe),
  83         DEVMETHOD(device_attach,        nsgphy_attach),
  84         DEVMETHOD(device_detach,        mii_phy_detach),
  85         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  86         { 0, 0 }
  87 };
  88
  89 static devclass_t nsgphy_devclass;
  90
  91 static driver_t nsgphy_driver = {
  92         "nsgphy",
  93         nsgphy_methods,
  94         sizeof(struct mii_softc)
  95 };
  96
  97
  98 DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, nsgphy_devclass, 0, 0);
  99
 100 static int      nsgphy_service(struct mii_softc *, struct mii_data *,int);
 101 static void     nsgphy_status(struct mii_softc *);
 102
 103 const struct mii_phydesc gphyters[] = {
 104         MII_PHY_DESC(NATSEMI, DP83861),
 105         MII_PHY_DESC(NATSEMI, DP83891),
 106         MII_PHY_END
 107 };
 108
 109 static int
 110 nsgphy_probe(device_t dev)
 111 {
 112         struct mii_attach_args *ma;
 113         const struct mii_phydesc *mpd;
 114
 115         ma = device_get_ivars(dev);
 116         mpd = mii_phy_match(ma, gphyters);
 117         if (mpd != NULL) {
 118                 device_set_desc(dev, mpd->mpd_name);
 119                 return(0);
 120         }
 121
 122         return(ENXIO);
 123 }
 124
 125 static int
 126 nsgphy_attach(device_t dev)
 127 {
 128         struct mii_softc *sc;
 129         struct mii_attach_args *ma;
 130         struct mii_data *mii;
 131
 132         sc = device_get_softc(dev);
 133         ma = device_get_ivars(dev);
 134         if (bootverbose)
 135                 device_printf(dev, "<rev. %d>\n", MII_REV(ma->mii_id2));
 136         device_printf(dev, " ");
 137         sc->mii_dev = device_get_parent(dev);
 138         mii = device_get_softc(sc->mii_dev);
 139         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 140
 141         sc->mii_inst = mii->mii_instance;
 142         sc->mii_phy = ma->mii_phyno;
 143         sc->mii_service = nsgphy_service;
 144         sc->mii_pdata = mii;
 145         sc->mii_anegticks = 5;
 146
 147         mii->mii_instance++;
 148
 149         sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
 150             (BMSR_10TFDX|BMSR_10THDX)) & ma->mii_capmask;
 151         if (sc->mii_capabilities & BMSR_EXTSTAT)
 152                 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
 153
 154         mii_phy_add_media(sc);
 155         printf("\n");
 156
 157         MIIBUS_MEDIAINIT(sc->mii_dev);
 158         return(0);
 159 }
 160
 161 static int
 162 nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 163 {
 164         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 165         int reg;
 166
 167         switch (cmd) {
 168         case MII_POLLSTAT:
 169                 /*
 170                  * If we're not polling our PHY instance, just return.
 171                  */
 172                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 173                         return (0);
 174                 break;
 175
 176         case MII_MEDIACHG:
 177                 /*
 178                  * If the media indicates a different PHY instance,
 179                  * isolate ourselves.
 180                  */
 181                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 182                         reg = PHY_READ(sc, MII_BMCR);
 183                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 184                         return (0);
 185                 }
 186
 187                 /*
 188                  * If the interface is not up, don't do anything.
 189                  */
 190                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 191                         break;
 192
 193                 mii_phy_setmedia(sc);
 194                 break;
 195
 196         case MII_TICK:
 197                 /*
 198                  * If we're not currently selected, just return.
 199                  */
 200                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 201                         return (0);
 202
 203                 if (mii_phy_tick(sc) == EJUSTRETURN)
 204                         return (0);
 205                 break;
 206         }
 207
 208         /* Update the media status. */
 209         nsgphy_status(sc);
 210
 211         /* Callback if something changed. */
 212         mii_phy_update(sc, cmd);
 213         return (0);
 214 }
 215
 216 static void
 217 nsgphy_status(struct mii_softc *sc)
 218 {
 219         struct mii_data *mii = sc->mii_pdata;
 220         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 221         int bmsr, bmcr, physup, gtsr;
 222
 223         mii->mii_media_status = IFM_AVALID;
 224         mii->mii_media_active = IFM_ETHER;
 225
 226         bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 227
 228         physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
 229
 230         if (physup & PHY_SUP_LINK)
 231                 mii->mii_media_status |= IFM_ACTIVE;
 232
 233         bmcr = PHY_READ(sc, MII_BMCR);
 234         if (bmcr & BMCR_ISO) {
 235                 mii->mii_media_active |= IFM_NONE;
 236                 mii->mii_media_status = 0;
 237                 return;
 238         }
 239
 240         if (bmcr & BMCR_LOOP)
 241                 mii->mii_media_active |= IFM_LOOP;
 242
 243         if (bmcr & BMCR_AUTOEN) {
 244                 /*
 245                  * The media status bits are only valid if autonegotiation
 246                  * has completed (or it's disabled).
 247                  */
 248                 if ((bmsr & BMSR_ACOMP) == 0) {
 249                         /* Erg, still trying, I guess... */
 250                         mii->mii_media_active |= IFM_NONE;
 251                         return;
 252                 }
 253
 254                 switch (physup & (PHY_SUP_SPEED1|PHY_SUP_SPEED0)) {
 255                 case PHY_SUP_SPEED1:
 256                         mii->mii_media_active |= IFM_1000_T;
 257                         gtsr = PHY_READ(sc, MII_100T2SR);
 258                         if (gtsr & GTSR_MS_RES)
 259                                 mii->mii_media_active |= IFM_ETH_MASTER;
 260                         break;
 261
 262                 case PHY_SUP_SPEED0:
 263                         mii->mii_media_active |= IFM_100_TX;
 264                         break;
 265
 266                 case 0:
 267                         mii->mii_media_active |= IFM_10_T;
 268                         break;
 269
 270                 default:
 271                         mii->mii_media_active |= IFM_NONE;
 272                         mii->mii_media_status = 0;
 273                 }
 274                 if (physup & PHY_SUP_DUPLEX)
 275                         mii->mii_media_active |= IFM_FDX;
 276         } else
 277                 mii->mii_media_active = ife->ifm_media;
 278 }