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 const struct mii_phy_funcs ruephy_funcs = {
  92         ruephy_service,
  93         ruephy_status,
  94         ruephy_reset
  95 };
  96
  97 static int
  98 ruephy_probe(device_t dev)
  99 {
 100
 101         if (strcmp(device_get_name(device_get_parent(device_get_parent(dev))),
 102             "rue") == 0)
 103                 return (mii_phy_dev_probe(dev, ruephys, BUS_PROBE_DEFAULT));
 104         return (ENXIO);
 105 }
 106
 107 static int
 108 ruephy_attach(device_t dev)
 109 {
 110
 111         mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
 112             &ruephy_funcs, 1);
 113         return (0);
 114 }
 115
 116 static int
 117 ruephy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 118 {
 119         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 120         int reg;
 121
 122         switch (cmd) {
 123         case MII_POLLSTAT:
 124                 break;
 125
 126         case MII_MEDIACHG:
 127                 /*
 128                  * If the interface is not up, don't do anything.
 129                  */
 130                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 131                         break;
 132
 133                 mii_phy_setmedia(sc);
 134                 break;
 135
 136         case MII_TICK:
 137                 /*
 138                  * Is the interface even up?
 139                  */
 140                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 141                         return (0);
 142
 143                 /*
 144                  * Only used for autonegotiation.
 145                  */
 146                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 147                         break;
 148
 149                 /*
 150                  * Check to see if we have link.  If we do, we don't
 151                  * need to restart the autonegotiation process.  Read
 152                  * the MSR twice in case it's latched.
 153                  */
 154                 reg = PHY_READ(sc, RUEPHY_MII_MSR) |
 155                     PHY_READ(sc, RUEPHY_MII_MSR);
 156                 if (reg & RUEPHY_MSR_LINK)
 157                         break;
 158
 159                 /* Only retry autonegotiation every mii_anegticks seconds. */
 160                 if (sc->mii_ticks <= sc->mii_anegticks)
 161                         break;
 162
 163                 sc->mii_ticks = 0;
 164                 PHY_RESET(sc);
 165                 if (mii_phy_auto(sc) == EJUSTRETURN)
 166                         return (0);
 167                 break;
 168         }
 169
 170         /* Update the media status. */
 171         PHY_STATUS(sc);
 172
 173         /* Callback if something changed. */
 174         mii_phy_update(sc, cmd);
 175
 176         return (0);
 177 }
 178
 179 static void
 180 ruephy_reset(struct mii_softc *sc)
 181 {
 182
 183         mii_phy_reset(sc);
 184
 185         /*
 186          * XXX RealTek RTL8150 PHY doesn't set the BMCR properly after
 187          * XXX reset, which breaks autonegotiation.
 188          */
 189         PHY_WRITE(sc, MII_BMCR, (BMCR_S100 | BMCR_AUTOEN | BMCR_FDX));
 190 }
 191
 192 static void
 193 ruephy_status(struct mii_softc *phy)
 194 {
 195         struct mii_data *mii = phy->mii_pdata;
 196         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 197         int bmsr, bmcr, msr;
 198
 199         mii->mii_media_status = IFM_AVALID;
 200         mii->mii_media_active = IFM_ETHER;
 201
 202         msr = PHY_READ(phy, RUEPHY_MII_MSR) | PHY_READ(phy, RUEPHY_MII_MSR);
 203         if (msr & RUEPHY_MSR_LINK)
 204                 mii->mii_media_status |= IFM_ACTIVE;
 205
 206         bmcr = PHY_READ(phy, MII_BMCR);
 207         if (bmcr & BMCR_ISO) {
 208                 mii->mii_media_active |= IFM_NONE;
 209                 mii->mii_media_status = 0;
 210                 return;
 211         }
 212
 213         bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
 214         if (bmcr & BMCR_AUTOEN) {
 215                 if ((bmsr & BMSR_ACOMP) == 0) {
 216                         /* Erg, still trying, I guess... */
 217                         mii->mii_media_active |= IFM_NONE;
 218                         return;
 219                 }
 220
 221                 if (msr & RUEPHY_MSR_SPEED100)
 222                         mii->mii_media_active |= IFM_100_TX;
 223                 else
 224                         mii->mii_media_active |= IFM_10_T;
 225
 226                 if (msr & RUEPHY_MSR_DUPLEX)
 227                         mii->mii_media_active |=
 228                             IFM_FDX | mii_phy_flowstatus(phy);
 229                 else
 230                         mii->mii_media_active |= IFM_HDX;
 231         } else
 232                 mii->mii_media_active = ife->ifm_media;
 233 }