sys/dev/netif/mii_layer/xmphy.c

   1 /*
   2  * Copyright (c) 2000
   3  *      Bill Paul <wpaul@ee.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/xmphy.c,v 1.1.2.5 2002/11/08 21:53:49 semenu Exp $
  33  * $DragonFly: src/sys/dev/netif/mii_layer/xmphy.c,v 1.4 2003/08/27 09:38:31 rob Exp $
  34  *
  35  * $FreeBSD: src/sys/dev/mii/xmphy.c,v 1.1.2.5 2002/11/08 21:53:49 semenu Exp $
  36  */
  37
  38 /*
  39  * driver for the XaQti XMAC II's internal PHY. This is sort of
  40  * like a 10/100 PHY, except the only thing we're really autoselecting
  41  * here is full/half duplex. Speed is always 1000mbps.
  42  */
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/kernel.h>
  47 #include <sys/socket.h>
  48 #include <sys/bus.h>
  49
  50 #include <machine/clock.h>
  51
  52 #include <net/if.h>
  53 #include <net/if_media.h>
  54
  55 #include "mii.h"
  56 #include "miivar.h"
  57 #include "miidevs.h"
  58
  59 #include "xmphyreg.h"
  60
  61 #include "miibus_if.h"
  62
  63 static int xmphy_probe          (device_t);
  64 static int xmphy_attach         (device_t);
  65 static int xmphy_detach         (device_t);
  66
  67 static device_method_t xmphy_methods[] = {
  68         /* device interface */
  69         DEVMETHOD(device_probe,         xmphy_probe),
  70         DEVMETHOD(device_attach,        xmphy_attach),
  71         DEVMETHOD(device_detach,        xmphy_detach),
  72         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  73         { 0, 0 }
  74 };
  75
  76 static devclass_t xmphy_devclass;
  77
  78 static driver_t xmphy_driver = {
  79         "xmphy",
  80         xmphy_methods,
  81         sizeof(struct mii_softc)
  82 };
  83
  84 DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
  85
  86 int     xmphy_service (struct mii_softc *, struct mii_data *, int);
  87 void    xmphy_status (struct mii_softc *);
  88
  89 static int      xmphy_mii_phy_auto (struct mii_softc *, int);
  90 extern void     mii_phy_auto_timeout (void *);
  91
  92 static int xmphy_probe(dev)
  93         device_t                dev;
  94 {
  95         struct mii_attach_args *ma;
  96
  97         ma = device_get_ivars(dev);
  98
  99         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxXAQTI &&
 100             MII_MODEL(ma->mii_id2) == MII_MODEL_XAQTI_XMACII) {
 101                 device_set_desc(dev, MII_STR_XAQTI_XMACII);
 102                 return(0);
 103         }
 104
 105         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_JATO &&
 106             MII_MODEL(ma->mii_id2) == MII_MODEL_JATO_BASEX) {
 107                 device_set_desc(dev, MII_STR_JATO_BASEX);
 108                 return(0);
 109         }
 110
 111         return(ENXIO);
 112 }
 113
 114 static int xmphy_attach(dev)
 115         device_t                dev;
 116 {
 117         struct mii_softc *sc;
 118         struct mii_attach_args *ma;
 119         struct mii_data *mii;
 120         const char *sep = "";
 121
 122         sc = device_get_softc(dev);
 123         ma = device_get_ivars(dev);
 124         sc->mii_dev = device_get_parent(dev);
 125         mii = device_get_softc(sc->mii_dev);
 126         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 127
 128         sc->mii_inst = mii->mii_instance;
 129         sc->mii_phy = ma->mii_phyno;
 130         sc->mii_service = xmphy_service;
 131         sc->mii_pdata = mii;
 132
 133         sc->mii_flags |= MIIF_NOISOLATE;
 134         mii->mii_instance++;
 135
 136 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 137 #define PRINT(s)        printf("%s%s", sep, s); sep = ", "
 138
 139         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 140             BMCR_ISO);
 141 #if 0
 142         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 143             BMCR_LOOP|BMCR_S100);
 144 #endif
 145
 146         mii_phy_reset(sc);
 147
 148         device_printf(dev, " ");
 149         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
 150             XMPHY_BMCR_FDX);
 151         PRINT("1000baseSX");
 152         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
 153         PRINT("1000baseSX-FDX");
 154         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
 155         PRINT("auto");
 156
 157         printf("\n");
 158 #undef ADD
 159 #undef PRINT
 160
 161         MIIBUS_MEDIAINIT(sc->mii_dev);
 162         return(0);
 163 }
 164
 165 static int xmphy_detach(dev)
 166         device_t                dev;
 167 {
 168         struct mii_softc *sc;
 169         struct mii_data *mii;
 170
 171         sc = device_get_softc(dev);
 172         mii = device_get_softc(device_get_parent(dev));
 173         if (sc->mii_flags & MIIF_DOINGAUTO)
 174                 untimeout(mii_phy_auto_timeout, sc, sc->mii_auto_ch);
 175         sc->mii_dev = NULL;
 176         LIST_REMOVE(sc, mii_list);
 177
 178         return(0);
 179 }
 180 int
 181 xmphy_service(sc, mii, cmd)
 182         struct mii_softc *sc;
 183         struct mii_data *mii;
 184         int cmd;
 185 {
 186         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 187         int reg;
 188
 189         switch (cmd) {
 190         case MII_POLLSTAT:
 191                 /*
 192                  * If we're not polling our PHY instance, just return.
 193                  */
 194                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 195                         return (0);
 196                 break;
 197
 198         case MII_MEDIACHG:
 199                 /*
 200                  * If the media indicates a different PHY instance,
 201                  * isolate ourselves.
 202                  */
 203                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 204                         reg = PHY_READ(sc, MII_BMCR);
 205                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 206                         return (0);
 207                 }
 208
 209                 /*
 210                  * If the interface is not up, don't do anything.
 211                  */
 212                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 213                         break;
 214
 215                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 216                 case IFM_AUTO:
 217 #ifdef foo
 218                         /*
 219                          * If we're already in auto mode, just return.
 220                          */
 221                         if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
 222                                 return (0);
 223 #endif
 224                         (void) xmphy_mii_phy_auto(sc, 1);
 225                         break;
 226                 case IFM_1000_SX:
 227                         mii_phy_reset(sc);
 228                         if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
 229                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
 230                                 PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
 231                         } else {
 232                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
 233                                 PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
 234                         }
 235                         break;
 236                 case IFM_100_T4:
 237                 case IFM_100_TX:
 238                 case IFM_10_T:
 239                 default:
 240                         return (EINVAL);
 241                 }
 242                 break;
 243
 244         case MII_TICK:
 245                 /*
 246                  * If we're not currently selected, just return.
 247                  */
 248                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 249                         return (0);
 250
 251                 /*
 252                  * Only used for autonegotiation.
 253                  */
 254                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 255                         return (0);
 256
 257                 /*
 258                  * Is the interface even up?
 259                  */
 260                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 261                         return (0);
 262
 263                 /*
 264                  * Only retry autonegotiation every 5 seconds.
 265                  */
 266                 if (++sc->mii_ticks != 5)
 267                         return (0);
 268
 269                 sc->mii_ticks = 0;
 270
 271                 /*
 272                  * Check to see if we have link.  If we do, we don't
 273                  * need to restart the autonegotiation process.  Read
 274                  * the BMSR twice in case it's latched.
 275                  */
 276                 reg = PHY_READ(sc, XMPHY_MII_BMSR) |
 277                     PHY_READ(sc, XMPHY_MII_BMSR);
 278                 if (reg & XMPHY_BMSR_LINK)
 279                         break;
 280
 281                 mii_phy_reset(sc);
 282                 if (xmphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
 283                         return(0);
 284                 break;
 285         }
 286
 287         /* Update the media status. */
 288         xmphy_status(sc);
 289
 290         /* Callback if something changed. */
 291         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 292                 MIIBUS_STATCHG(sc->mii_dev);
 293                 sc->mii_active = mii->mii_media_active;
 294         }
 295         return (0);
 296 }
 297
 298 void
 299 xmphy_status(sc)
 300         struct mii_softc *sc;
 301 {
 302         struct mii_data *mii = sc->mii_pdata;
 303         int bmsr, bmcr, anlpar;
 304
 305         mii->mii_media_status = IFM_AVALID;
 306         mii->mii_media_active = IFM_ETHER;
 307
 308         bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
 309             PHY_READ(sc, XMPHY_MII_BMSR);
 310         if (bmsr & XMPHY_BMSR_LINK)
 311                 mii->mii_media_status |= IFM_ACTIVE;
 312
 313         /* Do dummy read of extended status register. */
 314         bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
 315
 316         bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
 317
 318         if (bmcr & XMPHY_BMCR_LOOP)
 319                 mii->mii_media_active |= IFM_LOOP;
 320
 321
 322         if (bmcr & XMPHY_BMCR_AUTOEN) {
 323                 if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
 324                         if (bmsr & XMPHY_BMSR_LINK) {
 325                                 mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
 326                                 return;
 327                         }
 328                         /* Erg, still trying, I guess... */
 329                         mii->mii_media_active |= IFM_NONE;
 330                         return;
 331                 }
 332
 333                 mii->mii_media_active |= IFM_1000_SX;
 334                 anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
 335                     PHY_READ(sc, XMPHY_MII_ANLPAR);
 336                 if (anlpar & XMPHY_ANLPAR_FDX)
 337                         mii->mii_media_active |= IFM_FDX;
 338                 else
 339                         mii->mii_media_active |= IFM_HDX;
 340                 return;
 341         }
 342
 343         mii->mii_media_active |= IFM_1000_SX;
 344         if (bmcr & XMPHY_BMCR_FDX)
 345                 mii->mii_media_active |= IFM_FDX;
 346         else
 347                 mii->mii_media_active |= IFM_HDX;
 348
 349         return;
 350 }
 351
 352
 353 static int
 354 xmphy_mii_phy_auto(mii, waitfor)
 355         struct mii_softc *mii;
 356         int waitfor;
 357 {
 358         int bmsr, anar = 0, i;
 359
 360         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
 361                 anar = PHY_READ(mii, XMPHY_MII_ANAR);
 362                 anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
 363                 PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
 364                 DELAY(1000);
 365                 PHY_WRITE(mii, XMPHY_MII_BMCR,
 366                     XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
 367         }
 368
 369         if (waitfor) {
 370                 /* Wait 500ms for it to complete. */
 371                 for (i = 0; i < 500; i++) {
 372                         if ((bmsr = PHY_READ(mii, XMPHY_MII_BMSR)) &
 373                             XMPHY_BMSR_ACOMP)
 374                                 return (0);
 375                         DELAY(1000);
 376 #if 0
 377                 if ((bmsr & BMSR_ACOMP) == 0)
 378                         printf("%s: autonegotiation failed to complete\n",
 379                             mii->mii_dev.dv_xname);
 380 #endif
 381                 }
 382
 383                 /*
 384                  * Don't need to worry about clearing MIIF_DOINGAUTO.
 385                  * If that's set, a timeout is pending, and it will
 386                  * clear the flag.
 387                  */
 388                 return (EIO);
 389         }
 390
 391         /*
 392          * Just let it finish asynchronously.  This is for the benefit of
 393          * the tick handler driving autonegotiation.  Don't want 500ms
 394          * delays all the time while the system is running!
 395          */
 396         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
 397                 mii->mii_flags |= MIIF_DOINGAUTO;
 398                 mii->mii_auto_ch = timeout(mii_phy_auto_timeout, mii, hz >> 1);
 399         }
 400         return (EJUSTRETURN);
 401 }