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  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the following acknowledgement:
  16  *      This product includes software developed by Bill Paul.
  17  * 4. Neither the name of the author nor the names of any co-contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  31  * THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * $FreeBSD$
  34  */
  35
  36 /*
  37  * Driver for the National Semiconductor DP83891 and DP83861
  38  * 10/100/1000 PHYs.
  39  * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf
  40  *
  41  * The DP83891 is the older NatSemi gigE PHY which isn't being sold
  42  * anymore. The DP83861 is its replacement, which is an 'enhanced'
  43  * firmware driven component. The major difference between the
  44  * two is that the 83891 can't generate interrupts, while the
  45  * 83861 can. (I think it wasn't originally designed to do this, but
  46  * it can now thanks to firmware updates.) The 83861 also allows
  47  * access to its internal RAM via indirect register access.
  48  */
  49
  50 #include <sys/param.h>
  51 #include <sys/systm.h>
  52 #include <sys/kernel.h>
  53 #include <sys/malloc.h>
  54 #include <sys/socket.h>
  55 #include <sys/bus.h>
  56
  57 #include <machine/clock.h>
  58
  59 #include <net/if.h>
  60 #include <net/if_media.h>
  61
  62 #include <dev/mii/mii.h>
  63 #include <dev/mii/miivar.h>
  64 #include <dev/mii/miidevs.h>
  65
  66 #include <dev/mii/nsgphyreg.h>
  67
  68 #include "miibus_if.h"
  69
  70 #if !defined(lint)
  71 static const char rcsid[] =
  72   "$FreeBSD$";
  73 #endif
  74
  75 static int nsgphy_probe         (device_t);
  76 static int nsgphy_attach        (device_t);
  77 static int nsgphy_detach        (device_t);
  78
  79 static device_method_t nsgphy_methods[] = {
  80         /* device interface */
  81         DEVMETHOD(device_probe,         nsgphy_probe),
  82         DEVMETHOD(device_attach,        nsgphy_attach),
  83         DEVMETHOD(device_detach,        nsgphy_detach),
  84         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  85         { 0, 0 }
  86 };
  87
  88 static devclass_t nsgphy_devclass;
  89
  90 static driver_t nsgphy_driver = {
  91         "nsgphy",
  92         nsgphy_methods,
  93         sizeof(struct mii_softc)
  94 };
  95
  96 DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, nsgphy_devclass, 0, 0);
  97
  98 static int      nsgphy_service(struct mii_softc *, struct mii_data *,int);
  99 static void     nsgphy_status(struct mii_softc *);
 100 static int      nsgphy_mii_phy_auto(struct mii_softc *, int);
 101 extern void     mii_phy_auto_timeout(void *);
 102
 103 static int
 104 nsgphy_probe(device_t dev)
 105 {
 106         struct mii_attach_args *ma;
 107
 108         ma = device_get_ivars(dev);
 109
 110         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI) {
 111                 if (MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83891) {
 112                         device_set_desc(dev, MII_STR_NATSEMI_DP83891);
 113                         return(0);
 114                 }
 115                 if (MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83861) {
 116                         device_set_desc(dev, MII_STR_NATSEMI_DP83861);
 117                         return(0);
 118                 }
 119         }
 120
 121         return(ENXIO);
 122 }
 123
 124 static int
 125 nsgphy_attach(device_t dev)
 126 {
 127         struct mii_softc *sc;
 128         struct mii_attach_args *ma;
 129         struct mii_data *mii;
 130         const char *sep = "";
 131
 132         sc = device_get_softc(dev);
 133         ma = device_get_ivars(dev);
 134         sc->mii_dev = device_get_parent(dev);
 135         mii = device_get_softc(sc->mii_dev);
 136         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 137
 138         sc->mii_inst = mii->mii_instance;
 139         sc->mii_phy = ma->mii_phyno;
 140         sc->mii_service = nsgphy_service;
 141         sc->mii_pdata = mii;
 142
 143         sc->mii_flags |= MIIF_NOISOLATE;
 144         mii->mii_instance++;
 145
 146 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 147 #define PRINT(s)        printf("%s%s", sep, s); sep = ", "
 148
 149         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 150             BMCR_ISO);
 151 #if 0
 152         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 153             BMCR_LOOP|BMCR_S100);
 154 #endif
 155
 156         mii_phy_reset(sc);
 157
 158         device_printf(dev, " ");
 159         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, IFM_FDX, sc->mii_inst),
 160             BMCR_S1000|BMCR_FDX);
 161         PRINT("1000baseTX-FDX");
 162         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, 0, sc->mii_inst),
 163             BMCR_S1000);
 164         PRINT("1000baseTX");
 165         sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
 166             (BMSR_10TFDX|BMSR_10THDX)) & ma->mii_capmask;
 167         if (sc->mii_capabilities & BMSR_EXTSTAT)
 168                 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
 169         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_FDX, sc->mii_inst),
 170             BMCR_S100|BMCR_FDX);
 171         PRINT("100baseTX-FDX");
 172         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, 0, sc->mii_inst), BMCR_S100);
 173         PRINT("100baseTX");
 174         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_FDX, sc->mii_inst),
 175             BMCR_S10|BMCR_FDX);
 176         PRINT("10baseT-FDX");
 177         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, 0, sc->mii_inst), BMCR_S10);
 178         PRINT("10baseT");
 179         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
 180         PRINT("auto");
 181         printf("\n");
 182 #undef ADD
 183 #undef PRINT
 184
 185         MIIBUS_MEDIAINIT(sc->mii_dev);
 186         return(0);
 187 }
 188
 189 static int
 190 nsgphy_detach(device_t dev)
 191 {
 192         struct mii_softc *sc;
 193         struct mii_data *mii;
 194
 195         sc = device_get_softc(dev);
 196         mii = device_get_softc(device_get_parent(dev));
 197         if (sc->mii_flags & MIIF_DOINGAUTO)
 198                 untimeout(mii_phy_auto_timeout, sc, sc->mii_auto_ch);
 199         sc->mii_dev = NULL;
 200         LIST_REMOVE(sc, mii_list);
 201
 202         return(0);
 203 }
 204
 205 static int
 206 nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 207 {
 208         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 209         int reg;
 210
 211         switch (cmd) {
 212         case MII_POLLSTAT:
 213                 /*
 214                  * If we're not polling our PHY instance, just return.
 215                  */
 216                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 217                         return (0);
 218                 break;
 219
 220         case MII_MEDIACHG:
 221                 /*
 222                  * If the media indicates a different PHY instance,
 223                  * isolate ourselves.
 224                  */
 225                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 226                         reg = PHY_READ(sc, MII_BMCR);
 227                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 228                         return (0);
 229                 }
 230
 231                 /*
 232                  * If the interface is not up, don't do anything.
 233                  */
 234                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 235                         break;
 236
 237
 238                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 239                 case IFM_AUTO:
 240 #ifdef foo
 241                         /*
 242                          * If we're already in auto mode, just return.
 243                          */
 244                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 245                                 return (0);
 246 #endif
 247                         (void) nsgphy_mii_phy_auto(sc, 0);
 248                         break;
 249                 case IFM_1000_T:
 250                         if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
 251                                 PHY_WRITE(sc, MII_BMCR,
 252                                     BMCR_FDX|BMCR_SPEED1);
 253                         } else {
 254                                 PHY_WRITE(sc, MII_BMCR,
 255                                     BMCR_SPEED1);
 256                         }
 257                         PHY_WRITE(sc, MII_ANAR, ANAR_CSMA);
 258
 259                         /*
 260                          * When setting the link manually, one side must
 261                          * be the master and the other the slave. However
 262                          * ifmedia doesn't give us a good way to specify
 263                          * this, so we fake it by using one of the LINK
 264                          * flags. If LINK0 is set, we program the PHY to
 265                          * be a master, otherwise it's a slave.
 266                          */
 267                         if ((mii->mii_ifp->if_flags & IFF_LINK0)) {
 268                                 PHY_WRITE(sc, MII_100T2CR,
 269                                     GTCR_MAN_MS|GTCR_ADV_MS);
 270                         } else {
 271                                 PHY_WRITE(sc, MII_100T2CR, GTCR_MAN_MS);
 272                         }
 273                         break;
 274                 case IFM_100_T4:
 275                         /*
 276                          * XXX Not supported as a manual setting right now.
 277                          */
 278                         return (EINVAL);
 279                 case IFM_NONE:
 280                         PHY_WRITE(sc, MII_BMCR, BMCR_ISO|BMCR_PDOWN);
 281                         break;
 282                 default:
 283                         /*
 284                          * BMCR data is stored in the ifmedia entry.
 285                          */
 286                         PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
 287                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 288                         break;
 289                 }
 290                 break;
 291
 292         case MII_TICK:
 293                 /*
 294                  * If we're not currently selected, just return.
 295                  */
 296                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 297                         return (0);
 298
 299                 /*
 300                  * Is the interface even up?
 301                  */
 302                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 303                         return (0);
 304
 305                 /*
 306                  * Only used for autonegotiation.
 307                  */
 308                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 309                         break;
 310
 311                 /*
 312                  * Check to see if we have link.
 313                  */
 314                 reg = PHY_READ(sc, NSGPHY_MII_PHYSUP);
 315                 if (reg & NSGPHY_PHYSUP_LNKSTS)
 316                         break;
 317
 318                 /*
 319                  * Only retry autonegotiation every 5 seconds.
 320                  * Actually, for gigE PHYs, we should wait longer, since
 321                  * 5 seconds is the mimimum time the documentation
 322                  * says to wait for a 1000mbps link to be established.
 323                  */
 324                 if (++sc->mii_ticks != 10)
 325                         return (0);
 326
 327                 sc->mii_ticks = 0;
 328
 329                 mii_phy_reset(sc);
 330                 if (nsgphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
 331                         return(0);
 332                 break;
 333         }
 334
 335         /* Update the media status. */
 336         nsgphy_status(sc);
 337
 338         /* Callback if something changed. */
 339         mii_phy_update(sc, cmd);
 340         return (0);
 341 }
 342
 343 static void
 344 nsgphy_status(struct mii_softc *sc)
 345 {
 346         struct mii_data *mii = sc->mii_pdata;
 347         int bmsr, bmcr, physup, anlpar, gstat;
 348
 349         mii->mii_media_status = IFM_AVALID;
 350         mii->mii_media_active = IFM_ETHER;
 351
 352         bmsr = PHY_READ(sc, MII_BMSR);
 353
 354         physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
 355
 356         if (physup & NSGPHY_PHYSUP_LNKSTS)
 357                 mii->mii_media_status |= IFM_ACTIVE;
 358
 359         bmcr = PHY_READ(sc, MII_BMCR);
 360
 361         if (bmcr & BMCR_LOOP)
 362                 mii->mii_media_active |= IFM_LOOP;
 363
 364         if (bmcr & BMCR_AUTOEN) {
 365                 /*
 366                  * The media status bits are only valid if autonegotiation
 367                  * has completed (or it's disabled).
 368                  */
 369                 if ((bmsr & BMSR_ACOMP) == 0) {
 370                         /* Erg, still trying, I guess... */
 371                         mii->mii_media_active |= IFM_NONE;
 372                         return;
 373                 }
 374                 anlpar = PHY_READ(sc, MII_ANLPAR);
 375                 gstat = PHY_READ(sc, MII_100T2SR);
 376                 if (gstat & GTSR_LP_1000TFDX)
 377                         mii->mii_media_active |= IFM_1000_T|IFM_FDX;
 378                 else if (gstat & GTSR_LP_1000THDX)
 379                         mii->mii_media_active |= IFM_1000_T|IFM_HDX;
 380                 else if (anlpar & ANLPAR_T4)
 381                         mii->mii_media_active |= IFM_100_T4;
 382                 else if (anlpar & ANLPAR_TX_FD)
 383                         mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 384                 else if (anlpar & ANLPAR_TX)
 385                         mii->mii_media_active |= IFM_100_TX;
 386                 else if (anlpar & ANLPAR_10_FD)
 387                         mii->mii_media_active |= IFM_10_T|IFM_FDX;
 388                 else if (anlpar & ANLPAR_10)
 389                         mii->mii_media_active |= IFM_10_T|IFM_HDX;
 390                 else
 391                         mii->mii_media_active |= IFM_NONE;
 392                 return;
 393         }
 394
 395         switch(bmcr & (BMCR_SPEED1|BMCR_SPEED0)) {
 396         case BMCR_S1000:
 397                 mii->mii_media_active |= IFM_1000_T;
 398                 break;
 399         case BMCR_S100:
 400                 mii->mii_media_active |= IFM_100_TX;
 401                 break;
 402         case BMCR_S10:
 403                 mii->mii_media_active |= IFM_10_T;
 404                 break;
 405         default:
 406                 break;
 407         }
 408
 409         if (bmcr & BMCR_FDX)
 410                 mii->mii_media_active |= IFM_FDX;
 411         else
 412                 mii->mii_media_active |= IFM_HDX;
 413
 414         return;
 415 }
 416
 417
 418 static int
 419 nsgphy_mii_phy_auto(struct mii_softc *mii, int waitfor)
 420 {
 421         int bmsr, ktcr = 0, i;
 422
 423         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
 424                 mii_phy_reset(mii);
 425                 PHY_WRITE(mii, MII_BMCR, 0);
 426                 DELAY(1000);
 427                 ktcr = PHY_READ(mii, MII_100T2CR);
 428                 PHY_WRITE(mii, MII_100T2CR, ktcr |
 429                     (GTCR_ADV_1000TFDX|GTCR_ADV_1000THDX));
 430                 ktcr = PHY_READ(mii, MII_100T2CR);
 431                 DELAY(1000);
 432                 PHY_WRITE(mii, MII_ANAR,
 433                     BMSR_MEDIA_TO_ANAR(mii->mii_capabilities) | ANAR_CSMA);
 434                 DELAY(1000);
 435                 PHY_WRITE(mii, MII_BMCR,
 436                     BMCR_AUTOEN | BMCR_STARTNEG);
 437         }
 438
 439         if (waitfor) {
 440                 /* Wait 500ms for it to complete. */
 441                 for (i = 0; i < 500; i++) {
 442                         if ((bmsr = PHY_READ(mii, MII_BMSR)) & BMSR_ACOMP)
 443                                 return (0);
 444                         DELAY(1000);
 445 #if 0
 446                 if ((bmsr & BMSR_ACOMP) == 0)
 447                         printf("%s: autonegotiation failed to complete\n",
 448                             mii->mii_dev.dv_xname);
 449 #endif
 450                 }
 451
 452                 /*
 453                  * Don't need to worry about clearing MIIF_DOINGAUTO.
 454                  * If that's set, a timeout is pending, and it will
 455                  * clear the flag.
 456                  */
 457                 return (EIO);
 458         }
 459
 460         /*
 461          * Just let it finish asynchronously.  This is for the benefit of
 462          * the tick handler driving autonegotiation.  Don't want 500ms
 463          * delays all the time while the system is running!
 464          */
 465         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
 466                 mii->mii_flags |= MIIF_DOINGAUTO;
 467                 mii->mii_auto_ch = timeout(mii_phy_auto_timeout, mii, hz >> 1);
 468         }
 469         return (EJUSTRETURN);
 470 }