sys/dev/netif/mii_layer/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  * $FreeBSD: src/sys/dev/mii/rlphy.c,v 1.2.2.4 2002/11/08 21:53:49 semenu Exp $
  33  */
  34
  35 /*
  36  * driver for RealTek 8139 internal PHYs
  37  */
  38
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41 #include <sys/kernel.h>
  42 #include <sys/socket.h>
  43 #include <sys/bus.h>
  44
  45 #include <net/if.h>
  46 #include <net/if_arp.h>
  47 #include <net/if_media.h>
  48
  49 #include <dev/mii/mii.h>
  50 #include <dev/mii/miivar.h>
  51 #include <dev/mii/miidevs.h>
  52
  53 #include <machine/bus.h>
  54 #include <pci/if_rlreg.h>
  55
  56 #include "miibus_if.h"
  57
  58 #if !defined(lint)
  59 static const char rcsid[] =
  60    "$FreeBSD: src/sys/dev/mii/rlphy.c,v 1.2.2.4 2002/11/08 21:53:49 semenu Exp $";
  61 #endif
  62
  63 static int rlphy_probe          __P((device_t));
  64 static int rlphy_attach         __P((device_t));
  65 static int rlphy_detach         __P((device_t));
  66
  67 static device_method_t rlphy_methods[] = {
  68         /* device interface */
  69         DEVMETHOD(device_probe,         rlphy_probe),
  70         DEVMETHOD(device_attach,        rlphy_attach),
  71         DEVMETHOD(device_detach,        rlphy_detach),
  72         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  73         { 0, 0 }
  74 };
  75
  76 static devclass_t rlphy_devclass;
  77
  78 static driver_t rlphy_driver = {
  79         "rlphy",
  80         rlphy_methods,
  81         sizeof(struct mii_softc)
  82 };
  83
  84 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
  85
  86 int     rlphy_service __P((struct mii_softc *, struct mii_data *, int));
  87 void    rlphy_status __P((struct mii_softc *));
  88
  89 static int rlphy_probe(dev)
  90         device_t                dev;
  91 {
  92         struct mii_attach_args *ma;
  93         device_t                parent;
  94
  95         ma = device_get_ivars(dev);
  96         parent = device_get_parent(device_get_parent(dev));
  97
  98         /* Test for RealTek 8201L PHY */
  99         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_REALTEK &&
 100             MII_MODEL(ma->mii_id2) == MII_MODEL_REALTEK_RTL8201L) {
 101                 device_set_desc(dev, MII_STR_REALTEK_RTL8201L);
 102                 return(0);
 103         }
 104
 105         /*
 106          * RealTek PHY doesn't have vendor/device ID registers:
 107          * the rl driver fakes up a return value of all zeros.
 108          */
 109         if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
 110             MII_MODEL(ma->mii_id2) != 0)
 111                 return (ENXIO);
 112
 113         /*
 114          * Make sure the parent is an `rl'.
 115          */
 116         if (strcmp(device_get_name(parent), "rl") != 0)
 117                 return (ENXIO);
 118
 119         device_set_desc(dev, "RealTek internal media interface");
 120
 121         return (0);
 122 }
 123
 124 static int rlphy_attach(dev)
 125         device_t                dev;
 126 {
 127         struct mii_softc        *sc;
 128         struct mii_attach_args  *ma;
 129         struct mii_data         *mii;
 130
 131         sc = device_get_softc(dev);
 132         ma = device_get_ivars(dev);
 133         sc->mii_dev = device_get_parent(dev);
 134         mii = device_get_softc(sc->mii_dev);
 135
 136         /*
 137          * The RealTek PHY can never be isolated, so never allow non-zero
 138          * instances!
 139          */
 140         if (mii->mii_instance != 0) {
 141                 device_printf(dev, "ignoring this PHY, non-zero instance\n");
 142                 return(ENXIO);
 143         }
 144
 145         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 146
 147         sc->mii_inst = mii->mii_instance;
 148         sc->mii_phy = ma->mii_phyno;
 149         sc->mii_service = rlphy_service;
 150         sc->mii_pdata = mii;
 151         mii->mii_instance++;
 152
 153         sc->mii_flags |= MIIF_NOISOLATE;
 154
 155 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 156
 157 #if 0 /* See above. */
 158         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 159             BMCR_ISO);
 160 #endif
 161
 162         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 163             BMCR_LOOP|BMCR_S100);
 164
 165         mii_phy_reset(sc);
 166
 167         sc->mii_capabilities =
 168             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 169         device_printf(dev, " ");
 170         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 171                 printf("no media present");
 172         else
 173                 mii_add_media(mii, sc->mii_capabilities,
 174                     sc->mii_inst);
 175         printf("\n");
 176 #undef ADD
 177         MIIBUS_MEDIAINIT(sc->mii_dev);
 178         return(0);
 179 }
 180
 181 static int rlphy_detach(dev)
 182         device_t                dev;
 183 {
 184         struct mii_softc        *sc;
 185         struct mii_data         *mii;
 186
 187         sc = device_get_softc(dev);
 188         mii = device_get_softc(device_get_softc(dev));
 189         mii_phy_auto_stop(sc);
 190         sc->mii_dev = NULL;
 191         LIST_REMOVE(sc, mii_list);
 192
 193         return(0);
 194 }
 195
 196 int
 197 rlphy_service(sc, mii, cmd)
 198         struct mii_softc *sc;
 199         struct mii_data *mii;
 200         int cmd;
 201 {
 202         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 203
 204         /*
 205          * We can't isolate the RealTek PHY, so it has to be the only one!
 206          */
 207         if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 208                 panic("rlphy_service: can't isolate RealTek PHY");
 209
 210         switch (cmd) {
 211         case MII_POLLSTAT:
 212                 break;
 213
 214         case MII_MEDIACHG:
 215                 /*
 216                  * If the interface is not up, don't do anything.
 217                  */
 218                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 219                         break;
 220
 221                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 222                 case IFM_AUTO:
 223                         /*
 224                          * If we're already in auto mode, just return.
 225                          */
 226                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 227                                 return (0);
 228                         (void) mii_phy_auto(sc, 0);
 229                         break;
 230                 case IFM_100_T4:
 231                         /*
 232                          * XXX Not supported as a manual setting right now.
 233                          */
 234                         return (EINVAL);
 235                 default:
 236                         /*
 237                          * BMCR data is stored in the ifmedia entry.
 238                          */
 239                         PHY_WRITE(sc, MII_ANAR,
 240                             mii_anar(ife->ifm_media));
 241                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 242                 }
 243                 break;
 244
 245         case MII_TICK:
 246                 /*
 247                  * Only used for autonegotiation.
 248                  */
 249                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 250                         return (0);
 251
 252                 /*
 253                  * Is the interface even up?
 254                  */
 255                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 256                         return (0);
 257
 258                 /*
 259                  * Only retry autonegotiation every 5 seconds.
 260                  */
 261                 if (++sc->mii_ticks != 5)
 262                         return (0);
 263
 264                 sc->mii_ticks = 0;
 265
 266                 /*
 267                  * The RealTek PHY's autonegotiation doesn't need to be
 268                  * kicked; it continues in the background.
 269                  */
 270                 break;
 271         }
 272
 273         /* Update the media status. */
 274         rlphy_status(sc);
 275
 276         /* Callback if something changed. */
 277         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 278                 MIIBUS_STATCHG(sc->mii_dev);
 279                 sc->mii_active = mii->mii_media_active;
 280         }
 281         return (0);
 282 }
 283
 284 void
 285 rlphy_status(phy)
 286         struct mii_softc *phy;
 287 {
 288         struct mii_data *mii = phy->mii_pdata;
 289         int bmsr, bmcr, anlpar;
 290         device_t                parent;
 291
 292         mii->mii_media_status = IFM_AVALID;
 293         mii->mii_media_active = IFM_ETHER;
 294
 295         bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
 296         if (bmsr & BMSR_LINK)
 297                 mii->mii_media_status |= IFM_ACTIVE;
 298
 299         bmcr = PHY_READ(phy, MII_BMCR);
 300         if (bmcr & BMCR_ISO) {
 301                 mii->mii_media_active |= IFM_NONE;
 302                 mii->mii_media_status = 0;
 303                 return;
 304         }
 305
 306         if (bmcr & BMCR_LOOP)
 307                 mii->mii_media_active |= IFM_LOOP;
 308
 309         if (bmcr & BMCR_AUTOEN) {
 310                 /*
 311                  * NWay autonegotiation takes the highest-order common
 312                  * bit of the ANAR and ANLPAR (i.e. best media advertised
 313                  * both by us and our link partner).
 314                  */
 315                 if ((bmsr & BMSR_ACOMP) == 0) {
 316                         /* Erg, still trying, I guess... */
 317                         mii->mii_media_active |= IFM_NONE;
 318                         return;
 319                 }
 320
 321                 if ((anlpar = PHY_READ(phy, MII_ANAR) &
 322                     PHY_READ(phy, MII_ANLPAR))) {
 323                         if (anlpar & ANLPAR_T4)
 324                                 mii->mii_media_active |= IFM_100_T4;
 325                         else if (anlpar & ANLPAR_TX_FD)
 326                                 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 327                         else if (anlpar & ANLPAR_TX)
 328                                 mii->mii_media_active |= IFM_100_TX;
 329                         else if (anlpar & ANLPAR_10_FD)
 330                                 mii->mii_media_active |= IFM_10_T|IFM_FDX;
 331                         else if (anlpar & ANLPAR_10)
 332                                 mii->mii_media_active |= IFM_10_T;
 333                         else
 334                                 mii->mii_media_active |= IFM_NONE;
 335                         return;
 336                 }
 337                 /*
 338                  * If the other side doesn't support NWAY, then the
 339                  * best we can do is determine if we have a 10Mbps or
 340                  * 100Mbps link. There's no way to know if the link
 341                  * is full or half duplex, so we default to half duplex
 342                  * and hope that the user is clever enough to manually
 343                  * change the media settings if we're wrong.
 344                  */
 345
 346
 347                 /*
 348                  * The RealTek PHY supports non-NWAY link speed
 349                  * detection, however it does not report the link
 350                  * detection results via the ANLPAR or BMSR registers.
 351                  * (What? RealTek doesn't do things the way everyone
 352                  * else does? I'm just shocked, shocked I tell you.)
 353                  * To determine the link speed, we have to do one
 354                  * of two things:
 355                  *
 356                  * - If this is a standalone RealTek RTL8201(L) PHY,
 357                  *   we can determine the link speed by testing bit 0
 358                  *   in the magic, vendor-specific register at offset
 359                  *   0x19.
 360                  *
 361                  * - If this is a RealTek MAC with integrated PHY, we
 362                  *   can test the 'SPEED10' bit of the MAC's media status
 363                  *   register.
 364                  */
 365                 parent = device_get_parent(phy->mii_dev);
 366                 if (strcmp(device_get_name(parent), "rl") != 0) {
 367                         if (PHY_READ(phy, 0x0019) & 0x01)
 368                                 mii->mii_media_active |= IFM_100_TX;
 369                         else
 370                                 mii->mii_media_active |= IFM_10_T;
 371                 } else {
 372                         if (PHY_READ(phy, RL_MEDIASTAT) &
 373                             RL_MEDIASTAT_SPEED10)
 374                                 mii->mii_media_active |= IFM_10_T;
 375                         else
 376                                 mii->mii_media_active |= IFM_100_TX;
 377                 }
 378
 379         } else
 380                 mii->mii_media_active = mii_media_from_bmcr(bmcr);
 381 }