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  * $FreeBSD$
  40  */
  41
  42 /*
  43  * Driver for the National Semiconductor DP83891 and DP83861
  44  * 10/100/1000 PHYs.
  45  * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf
  46  *
  47  * The DP83891 is the older NatSemi gigE PHY which isn't being sold
  48  * anymore. The DP83861 is its replacement, which is an 'enhanced'
  49  * firmware driven component. The major difference between the
  50  * two is that the 83891 can't generate interrupts, while the
  51  * 83861 can. (I think it wasn't originally designed to do this, but
  52  * it can now thanks to firmware updates.) The 83861 also allows
  53  * access to its internal RAM via indirect register access.
  54  */
  55
  56 #include <sys/param.h>
  57 #include <sys/systm.h>
  58 #include <sys/kernel.h>
  59 #include <sys/malloc.h>
  60 #include <sys/socket.h>
  61 #include <sys/bus.h>
  62
  63 #include <machine/clock.h>
  64
  65 #include <net/if.h>
  66 #include <net/if_media.h>
  67
  68 #include <dev/mii/mii.h>
  69 #include <dev/mii/miivar.h>
  70 #include <dev/mii/miidevs.h>
  71
  72 #include <dev/mii/nsgphyreg.h>
  73
  74 #include "miibus_if.h"
  75
  76 #if !defined(lint)
  77 static const char rcsid[] =
  78   "$FreeBSD$";
  79 #endif
  80
  81 static int nsgphy_probe         (device_t);
  82 static int nsgphy_attach        (device_t);
  83
  84 static device_method_t nsgphy_methods[] = {
  85         /* device interface */
  86         DEVMETHOD(device_probe,         nsgphy_probe),
  87         DEVMETHOD(device_attach,        nsgphy_attach),
  88         DEVMETHOD(device_detach,        mii_phy_detach),
  89         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  90         { 0, 0 }
  91 };
  92
  93 static devclass_t nsgphy_devclass;
  94
  95 static driver_t nsgphy_driver = {
  96         "nsgphy",
  97         nsgphy_methods,
  98         sizeof(struct mii_softc)
  99 };
 100
 101
 102 DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, nsgphy_devclass, 0, 0);
 103
 104 static int      nsgphy_service(struct mii_softc *, struct mii_data *,int);
 105 static void     nsgphy_status(struct mii_softc *);
 106
 107 const struct mii_phydesc gphyters[] = {
 108         { MII_OUI_NATSEMI,              MII_MODEL_NATSEMI_DP83861,
 109           MII_STR_NATSEMI_DP83861 },
 110
 111         { MII_OUI_NATSEMI,              MII_MODEL_NATSEMI_DP83891,
 112           MII_STR_NATSEMI_DP83891 },
 113
 114         { 0,                            0,
 115           NULL },
 116 };
 117
 118 static int
 119 nsgphy_probe(device_t dev)
 120 {
 121         struct mii_attach_args *ma;
 122         const struct mii_phydesc *mpd;
 123
 124         ma = device_get_ivars(dev);
 125         mpd = mii_phy_match(ma, gphyters);
 126         if (mpd != NULL) {
 127                 device_set_desc(dev, mpd->mpd_name);
 128                 return(0);
 129         }
 130
 131         return(ENXIO);
 132 }
 133
 134 static int
 135 nsgphy_attach(device_t dev)
 136 {
 137         struct mii_softc *sc;
 138         struct mii_attach_args *ma;
 139         struct mii_data *mii;
 140         const struct mii_phydesc *mpd;
 141
 142         sc = device_get_softc(dev);
 143         ma = device_get_ivars(dev);
 144         mpd = mii_phy_match(ma, gphyters);
 145         if (bootverbose)
 146                 device_printf(dev, "<rev. %d>\n", MII_REV(ma->mii_id2));
 147         device_printf(dev, " ");
 148         sc->mii_dev = device_get_parent(dev);
 149         mii = device_get_softc(sc->mii_dev);
 150         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 151
 152         sc->mii_inst = mii->mii_instance;
 153         sc->mii_phy = ma->mii_phyno;
 154         sc->mii_service = nsgphy_service;
 155         sc->mii_pdata = mii;
 156         sc->mii_anegticks = 5;
 157
 158         mii->mii_instance++;
 159
 160         sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
 161             (BMSR_10TFDX|BMSR_10THDX)) & ma->mii_capmask;
 162         if (sc->mii_capabilities & BMSR_EXTSTAT)
 163                 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
 164
 165         mii_phy_add_media(sc);
 166         printf("\n");
 167
 168         MIIBUS_MEDIAINIT(sc->mii_dev);
 169         return(0);
 170 }
 171
 172 static int
 173 nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 174 {
 175         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 176         int reg;
 177
 178         switch (cmd) {
 179         case MII_POLLSTAT:
 180                 /*
 181                  * If we're not polling our PHY instance, just return.
 182                  */
 183                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 184                         return (0);
 185                 break;
 186
 187         case MII_MEDIACHG:
 188                 /*
 189                  * If the media indicates a different PHY instance,
 190                  * isolate ourselves.
 191                  */
 192                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 193                         reg = PHY_READ(sc, MII_BMCR);
 194                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 195                         return (0);
 196                 }
 197
 198                 /*
 199                  * If the interface is not up, don't do anything.
 200                  */
 201                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 202                         break;
 203
 204                 mii_phy_setmedia(sc);
 205                 break;
 206
 207         case MII_TICK:
 208                 /*
 209                  * If we're not currently selected, just return.
 210                  */
 211                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 212                         return (0);
 213
 214                 if (mii_phy_tick(sc) == EJUSTRETURN)
 215                         return (0);
 216                 break;
 217         }
 218
 219         /* Update the media status. */
 220         nsgphy_status(sc);
 221
 222         /* Callback if something changed. */
 223         mii_phy_update(sc, cmd);
 224         return (0);
 225 }
 226
 227 static void
 228 nsgphy_status(struct mii_softc *sc)
 229 {
 230         struct mii_data *mii = sc->mii_pdata;
 231         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 232         int bmsr, bmcr, physup, gtsr;
 233
 234         mii->mii_media_status = IFM_AVALID;
 235         mii->mii_media_active = IFM_ETHER;
 236
 237         bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 238
 239         physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
 240
 241         if (physup & PHY_SUP_LINK)
 242                 mii->mii_media_status |= IFM_ACTIVE;
 243
 244         bmcr = PHY_READ(sc, MII_BMCR);
 245         if (bmcr & BMCR_ISO) {
 246                 mii->mii_media_active |= IFM_NONE;
 247                 mii->mii_media_status = 0;
 248                 return;
 249         }
 250
 251         if (bmcr & BMCR_LOOP)
 252                 mii->mii_media_active |= IFM_LOOP;
 253
 254         if (bmcr & BMCR_AUTOEN) {
 255                 /*
 256                  * The media status bits are only valid if autonegotiation
 257                  * has completed (or it's disabled).
 258                  */
 259                 if ((bmsr & BMSR_ACOMP) == 0) {
 260                         /* Erg, still trying, I guess... */
 261                         mii->mii_media_active |= IFM_NONE;
 262                         return;
 263                 }
 264
 265                 switch (physup & (PHY_SUP_SPEED1|PHY_SUP_SPEED0)) {
 266                 case PHY_SUP_SPEED1:
 267                         mii->mii_media_active |= IFM_1000_T;
 268                         gtsr = PHY_READ(sc, MII_100T2SR);
 269                         if (gtsr & GTSR_MS_RES)
 270                                 mii->mii_media_active |= IFM_ETH_MASTER;
 271                         break;
 272
 273                 case PHY_SUP_SPEED0:
 274                         mii->mii_media_active |= IFM_100_TX;
 275                         break;
 276
 277                 case 0:
 278                         mii->mii_media_active |= IFM_10_T;
 279                         break;
 280
 281                 default:
 282                         mii->mii_media_active |= IFM_NONE;
 283                         mii->mii_media_status = 0;
 284                 }
 285                 if (physup & PHY_SUP_DUPLEX)
 286                         mii->mii_media_active |= IFM_FDX;
 287         } else
 288                 mii->mii_media_active = ife->ifm_media;
 289 }