sys/dev/mii/rlphy.c

   1 /*-
   2  * Copyright (c) 1997, 1998, 1999
   3  *      Bill Paul <wpaul@ctr.columbia.edu>.  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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  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
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 /*
  37  * driver for RealTek 8139 internal PHYs
  38  */
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/kernel.h>
  43 #include <sys/module.h>
  44 #include <sys/socket.h>
  45 #include <sys/bus.h>
  46
  47 #include <net/if.h>
  48 #include <net/if_arp.h>
  49 #include <net/if_media.h>
  50
  51 #include <dev/mii/mii.h>
  52 #include <dev/mii/miivar.h>
  53 #include "miidevs.h"
  54
  55 #include <machine/bus.h>
  56 #include <pci/if_rlreg.h>
  57
  58 #include "miibus_if.h"
  59
  60 struct rlphy_softc {
  61         struct mii_softc sc_mii;        /* generic PHY */
  62         int sc_is_RTL8201L;             /* is an external RTL8201L PHY */
  63 };
  64
  65 static int rlphy_probe(device_t);
  66 static int rlphy_attach(device_t);
  67
  68 static device_method_t rlphy_methods[] = {
  69         /* device interface */
  70         DEVMETHOD(device_probe,         rlphy_probe),
  71         DEVMETHOD(device_attach,        rlphy_attach),
  72         DEVMETHOD(device_detach,        mii_phy_detach),
  73         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  74         { 0, 0 }
  75 };
  76
  77 static devclass_t rlphy_devclass;
  78
  79 static driver_t rlphy_driver = {
  80         "rlphy",
  81         rlphy_methods,
  82         sizeof(struct rlphy_softc)
  83 };
  84
  85 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
  86
  87 static int      rlphy_service(struct mii_softc *, struct mii_data *, int);
  88 static void     rlphy_status(struct mii_softc *);
  89
  90 /*
  91  * RealTek internal PHYs don't have vendor/device ID registers;
  92  * re(4) and rl(4) fake up a return value of all zeros.
  93  */
  94 static const struct mii_phydesc rlintphys[] = {
  95         { 0, 0, "RealTek internal media interface" },
  96         MII_PHY_END
  97 };
  98
  99 static const struct mii_phydesc rlphys[] = {
 100         MII_PHY_DESC(REALTEK, RTL8201L),
 101         MII_PHY_DESC(ICPLUS, IP101),
 102         MII_PHY_END
 103 };
 104
 105 static int
 106 rlphy_probe(device_t dev)
 107 {
 108         const char *nic;
 109         int rv;
 110
 111         rv = mii_phy_dev_probe(dev, rlphys, BUS_PROBE_DEFAULT);
 112         if (rv <= 0)
 113                 return (rv);
 114
 115         nic = device_get_name(device_get_parent(device_get_parent(dev)));
 116         if (strcmp(nic, "rl") == 0 || strcmp(nic, "re") == 0)
 117                 return (mii_phy_dev_probe(dev, rlintphys, BUS_PROBE_DEFAULT));
 118         return (ENXIO);
 119 }
 120
 121 static int
 122 rlphy_attach(device_t dev)
 123 {
 124         struct mii_softc        *sc;
 125         struct mii_attach_args  *ma;
 126         struct mii_data         *mii;
 127         struct rlphy_softc      *rsc;
 128
 129         sc = device_get_softc(dev);
 130         ma = device_get_ivars(dev);
 131         sc->mii_dev = device_get_parent(dev);
 132         mii = device_get_softc(sc->mii_dev);
 133
 134         /*
 135          * Check whether we're the RTL8201L PHY and remember so the status
 136          * routine can query the proper register for speed detection.
 137          */
 138         rsc = (struct rlphy_softc *)sc;
 139         if (mii_phy_dev_probe(dev, rlphys, 0) == 0)
 140                 rsc->sc_is_RTL8201L++;
 141
 142         /*
 143          * The RealTek PHY can never be isolated, so never allow non-zero
 144          * instances!
 145          */
 146         if (mii->mii_instance != 0) {
 147                 device_printf(dev, "ignoring this PHY, non-zero instance\n");
 148                 return (ENXIO);
 149         }
 150
 151         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 152
 153         sc->mii_inst = mii->mii_instance;
 154         sc->mii_phy = ma->mii_phyno;
 155         sc->mii_service = rlphy_service;
 156         sc->mii_pdata = mii;
 157         mii->mii_instance++;
 158
 159         sc->mii_flags |= MIIF_NOISOLATE;
 160
 161 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 162
 163         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 164             MII_MEDIA_100_TX);
 165
 166         mii_phy_reset(sc);
 167
 168         sc->mii_capabilities =
 169             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 170         device_printf(dev, " ");
 171         mii_phy_add_media(sc);
 172         printf("\n");
 173 #undef ADD
 174         MIIBUS_MEDIAINIT(sc->mii_dev);
 175         return (0);
 176 }
 177
 178 static int
 179 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 180 {
 181         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 182
 183         /*
 184          * We can't isolate the RealTek PHY, so it has to be the only one!
 185          */
 186         if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 187                 panic("rlphy_service: can't isolate RealTek PHY");
 188
 189         switch (cmd) {
 190         case MII_POLLSTAT:
 191                 break;
 192
 193         case MII_MEDIACHG:
 194                 /*
 195                  * If the interface is not up, don't do anything.
 196                  */
 197                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 198                         break;
 199
 200                 mii_phy_setmedia(sc);
 201                 break;
 202
 203         case MII_TICK:
 204                 /*
 205                  * Is the interface even up?
 206                  */
 207                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 208                         return (0);
 209
 210                 /*
 211                  * The RealTek PHY's autonegotiation doesn't need to be
 212                  * kicked; it continues in the background.
 213                  */
 214                 break;
 215         }
 216
 217         /* Update the media status. */
 218         rlphy_status(sc);
 219
 220         /* Callback if something changed. */
 221         mii_phy_update(sc, cmd);
 222         return (0);
 223 }
 224
 225 static void
 226 rlphy_status(struct mii_softc *phy)
 227 {
 228         struct rlphy_softc *rsc =(struct rlphy_softc *)phy;
 229         struct mii_data *mii = phy->mii_pdata;
 230         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 231         int bmsr, bmcr, anlpar;
 232
 233         mii->mii_media_status = IFM_AVALID;
 234         mii->mii_media_active = IFM_ETHER;
 235
 236         bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
 237         if (bmsr & BMSR_LINK)
 238                 mii->mii_media_status |= IFM_ACTIVE;
 239
 240         bmcr = PHY_READ(phy, MII_BMCR);
 241         if (bmcr & BMCR_ISO) {
 242                 mii->mii_media_active |= IFM_NONE;
 243                 mii->mii_media_status = 0;
 244                 return;
 245         }
 246
 247         if (bmcr & BMCR_LOOP)
 248                 mii->mii_media_active |= IFM_LOOP;
 249
 250         if (bmcr & BMCR_AUTOEN) {
 251                 /*
 252                  * NWay autonegotiation takes the highest-order common
 253                  * bit of the ANAR and ANLPAR (i.e. best media advertised
 254                  * both by us and our link partner).
 255                  */
 256                 if ((bmsr & BMSR_ACOMP) == 0) {
 257                         /* Erg, still trying, I guess... */
 258                         mii->mii_media_active |= IFM_NONE;
 259                         return;
 260                 }
 261
 262                 if ((anlpar = PHY_READ(phy, MII_ANAR) &
 263                     PHY_READ(phy, MII_ANLPAR))) {
 264                         if (anlpar & ANLPAR_TX_FD)
 265                                 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 266                         else if (anlpar & ANLPAR_T4)
 267                                 mii->mii_media_active |= IFM_100_T4;
 268                         else if (anlpar & ANLPAR_TX)
 269                                 mii->mii_media_active |= IFM_100_TX;
 270                         else if (anlpar & ANLPAR_10_FD)
 271                                 mii->mii_media_active |= IFM_10_T|IFM_FDX;
 272                         else if (anlpar & ANLPAR_10)
 273                                 mii->mii_media_active |= IFM_10_T;
 274                         else
 275                                 mii->mii_media_active |= IFM_NONE;
 276                         return;
 277                 }
 278                 /*
 279                  * If the other side doesn't support NWAY, then the
 280                  * best we can do is determine if we have a 10Mbps or
 281                  * 100Mbps link. There's no way to know if the link
 282                  * is full or half duplex, so we default to half duplex
 283                  * and hope that the user is clever enough to manually
 284                  * change the media settings if we're wrong.
 285                  */
 286
 287                 /*
 288                  * The RealTek PHY supports non-NWAY link speed
 289                  * detection, however it does not report the link
 290                  * detection results via the ANLPAR or BMSR registers.
 291                  * (What? RealTek doesn't do things the way everyone
 292                  * else does? I'm just shocked, shocked I tell you.)
 293                  * To determine the link speed, we have to do one
 294                  * of two things:
 295                  *
 296                  * - If this is a standalone RealTek RTL8201(L) PHY,
 297                  *   we can determine the link speed by testing bit 0
 298                  *   in the magic, vendor-specific register at offset
 299                  *   0x19.
 300                  *
 301                  * - If this is a RealTek MAC with integrated PHY, we
 302                  *   can test the 'SPEED10' bit of the MAC's media status
 303                  *   register.
 304                  */
 305                 if (rsc->sc_is_RTL8201L) {
 306                         if (PHY_READ(phy, 0x0019) & 0x01)
 307                                 mii->mii_media_active |= IFM_100_TX;
 308                         else
 309                                 mii->mii_media_active |= IFM_10_T;
 310                 } else {
 311                         if (PHY_READ(phy, RL_MEDIASTAT) &
 312                             RL_MEDIASTAT_SPEED10)
 313                                 mii->mii_media_active |= IFM_10_T;
 314                         else
 315                                 mii->mii_media_active |= IFM_100_TX;
 316                 }
 317         } else
 318                 mii->mii_media_active = ife->ifm_media;
 319 }