sys/dev/mii/ruephy.c

   1 /*-
   2  * Copyright (c) 2001-2003, Shunsuke Akiyama <akiyama@FreeBSD.org>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 /*
  32  * driver for RealTek RTL8150 internal PHY
  33  */
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/kernel.h>
  38 #include <sys/malloc.h>
  39 #include <sys/module.h>
  40 #include <sys/socket.h>
  41 #include <sys/bus.h>
  42
  43 #include <net/if.h>
  44 #include <net/if_arp.h>
  45 #include <net/if_media.h>
  46
  47 #include <dev/mii/mii.h>
  48 #include <dev/mii/miivar.h>
  49 #include "miidevs.h"
  50
  51 #include <machine/bus.h>
  52 #include <dev/mii/ruephyreg.h>
  53
  54 #include "miibus_if.h"
  55
  56 static int ruephy_probe(device_t);
  57 static int ruephy_attach(device_t);
  58
  59 static device_method_t ruephy_methods[] = {
  60         /* device interface */
  61         DEVMETHOD(device_probe,         ruephy_probe),
  62         DEVMETHOD(device_attach,        ruephy_attach),
  63         DEVMETHOD(device_detach,        mii_phy_detach),
  64         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  65         { 0, 0 }
  66 };
  67
  68 static devclass_t ruephy_devclass;
  69
  70 static driver_t ruephy_driver = {
  71         "ruephy",
  72         ruephy_methods,
  73         sizeof(struct mii_softc)
  74 };
  75
  76 DRIVER_MODULE(ruephy, miibus, ruephy_driver, ruephy_devclass, 0, 0);
  77
  78 static int ruephy_service(struct mii_softc *, struct mii_data *, int);
  79 static void ruephy_reset(struct mii_softc *);
  80 static void ruephy_status(struct mii_softc *);
  81
  82 /*
  83  * The RealTek RTL8150 internal PHY doesn't have vendor/device ID
  84  * registers; rue(4) fakes up a return value of all zeros.
  85  */
  86 static const struct mii_phydesc ruephys[] = {
  87         { 0, 0, "RealTek RTL8150 internal media interface" },
  88         MII_PHY_END
  89 };
  90
  91 static int
  92 ruephy_probe(device_t dev)
  93 {
  94
  95         if (strcmp(device_get_name(device_get_parent(device_get_parent(dev))),
  96             "rue") == 0)
  97                 return (mii_phy_dev_probe(dev, ruephys, BUS_PROBE_DEFAULT));
  98         return (ENXIO);
  99 }
 100
 101 static int
 102 ruephy_attach(device_t dev)
 103 {
 104         struct mii_softc        *sc;
 105         struct mii_attach_args  *ma;
 106         struct mii_data         *mii;
 107
 108         sc = device_get_softc(dev);
 109         ma = device_get_ivars(dev);
 110         sc->mii_dev = device_get_parent(dev);
 111         mii = device_get_softc(sc->mii_dev);
 112
 113         /*
 114          * The RealTek PHY can never be isolated, so never allow non-zero
 115          * instances!
 116          */
 117         if (mii->mii_instance != 0) {
 118                 device_printf(dev, "ignoring this PHY, non-zero instance\n");
 119                 return (ENXIO);
 120         }
 121
 122         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 123
 124         sc->mii_inst = mii->mii_instance;
 125         sc->mii_phy = ma->mii_phyno;
 126         sc->mii_service = ruephy_service;
 127         sc->mii_pdata = mii;
 128         mii->mii_instance++;
 129
 130         /*
 131          * Apparently, we can't neither isolate nor do loopback on this PHY.
 132          */
 133         sc->mii_flags |= MIIF_NOISOLATE | MIIF_NOLOOP;
 134
 135         ruephy_reset(sc);
 136
 137         sc->mii_capabilities =
 138             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 139         device_printf(dev, " ");
 140         mii_phy_add_media(sc);
 141         printf("\n");
 142
 143         MIIBUS_MEDIAINIT(sc->mii_dev);
 144         return (0);
 145 }
 146
 147 static int
 148 ruephy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 149 {
 150         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 151         int reg;
 152
 153         /*
 154          * We can't isolate the RealTek RTL8150 PHY,
 155          * so it has to be the only one!
 156          */
 157         if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 158                 panic("ruephy_service: can't isolate RealTek RTL8150 PHY");
 159
 160         switch (cmd) {
 161         case MII_POLLSTAT:
 162                 break;
 163
 164         case MII_MEDIACHG:
 165                 /*
 166                  * If the interface is not up, don't do anything.
 167                  */
 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                 /*
 176                  * Is the interface even up?
 177                  */
 178                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 179                         return (0);
 180
 181                 /*
 182                  * Only used for autonegotiation.
 183                  */
 184                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 185                         break;
 186
 187                 /*
 188                  * Check to see if we have link.  If we do, we don't
 189                  * need to restart the autonegotiation process.  Read
 190                  * the MSR twice in case it's latched.
 191                  */
 192                 reg = PHY_READ(sc, RUEPHY_MII_MSR) |
 193                     PHY_READ(sc, RUEPHY_MII_MSR);
 194                 if (reg & RUEPHY_MSR_LINK)
 195                         break;
 196
 197                 /*
 198                  * Only retry autonegotiation every 5 seconds.
 199                  */
 200                 if (++sc->mii_ticks <= MII_ANEGTICKS)
 201                         break;
 202
 203                 sc->mii_ticks = 0;
 204                 ruephy_reset(sc);
 205                 if (mii_phy_auto(sc) == EJUSTRETURN)
 206                         return (0);
 207                 break;
 208         }
 209
 210         /* Update the media status. */
 211         ruephy_status(sc);
 212
 213         /* Callback if something changed. */
 214         mii_phy_update(sc, cmd);
 215
 216         return (0);
 217 }
 218
 219 static void
 220 ruephy_reset(struct mii_softc *sc)
 221 {
 222
 223         mii_phy_reset(sc);
 224
 225         /*
 226          * XXX RealTek RTL8150 PHY doesn't set the BMCR properly after
 227          * XXX reset, which breaks autonegotiation.
 228          */
 229         PHY_WRITE(sc, MII_BMCR, (BMCR_S100 | BMCR_AUTOEN | BMCR_FDX));
 230 }
 231
 232 static void
 233 ruephy_status(struct mii_softc *phy)
 234 {
 235         struct mii_data *mii = phy->mii_pdata;
 236         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 237         int bmsr, bmcr, msr;
 238
 239         mii->mii_media_status = IFM_AVALID;
 240         mii->mii_media_active = IFM_ETHER;
 241
 242         msr = PHY_READ(phy, RUEPHY_MII_MSR) | PHY_READ(phy, RUEPHY_MII_MSR);
 243         if (msr & RUEPHY_MSR_LINK)
 244                 mii->mii_media_status |= IFM_ACTIVE;
 245
 246         bmcr = PHY_READ(phy, MII_BMCR);
 247         if (bmcr & BMCR_ISO) {
 248                 mii->mii_media_active |= IFM_NONE;
 249                 mii->mii_media_status = 0;
 250                 return;
 251         }
 252
 253         bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
 254         if (bmcr & BMCR_AUTOEN) {
 255                 if ((bmsr & BMSR_ACOMP) == 0) {
 256                         /* Erg, still trying, I guess... */
 257                         mii->mii_media_active |= IFM_NONE;
 258                         return;
 259                 }
 260
 261                 if (msr & RUEPHY_MSR_SPEED100)
 262                         mii->mii_media_active |= IFM_100_TX;
 263                 else
 264                         mii->mii_media_active |= IFM_10_T;
 265
 266                 if (msr & RUEPHY_MSR_DUPLEX)
 267                         mii->mii_media_active |= IFM_FDX;
 268         } else
 269                 mii->mii_media_active = ife->ifm_media;
 270 }