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.5 2004/09/18 19:32:59 dillon 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         mii_softc_init(sc);
 125         sc->mii_dev = device_get_parent(dev);
 126         mii = device_get_softc(sc->mii_dev);
 127         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 128
 129         sc->mii_inst = mii->mii_instance;
 130         sc->mii_phy = ma->mii_phyno;
 131         sc->mii_service = xmphy_service;
 132         sc->mii_pdata = mii;
 133
 134         sc->mii_flags |= MIIF_NOISOLATE;
 135         mii->mii_instance++;
 136
 137 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 138 #define PRINT(s)        printf("%s%s", sep, s); sep = ", "
 139
 140         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 141             BMCR_ISO);
 142 #if 0
 143         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 144             BMCR_LOOP|BMCR_S100);
 145 #endif
 146
 147         mii_phy_reset(sc);
 148
 149         device_printf(dev, " ");
 150         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
 151             XMPHY_BMCR_FDX);
 152         PRINT("1000baseSX");
 153         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
 154         PRINT("1000baseSX-FDX");
 155         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
 156         PRINT("auto");
 157
 158         printf("\n");
 159 #undef ADD
 160 #undef PRINT
 161
 162         MIIBUS_MEDIAINIT(sc->mii_dev);
 163         return(0);
 164 }
 165
 166 static int xmphy_detach(dev)
 167         device_t                dev;
 168 {
 169         struct mii_softc *sc;
 170         struct mii_data *mii;
 171
 172         sc = device_get_softc(dev);
 173         mii = device_get_softc(device_get_parent(dev));
 174         if (sc->mii_flags & MIIF_DOINGAUTO)
 175                 callout_stop(&sc->mii_auto_ch);
 176         sc->mii_dev = NULL;
 177         LIST_REMOVE(sc, mii_list);
 178
 179         return(0);
 180 }
 181 int
 182 xmphy_service(sc, mii, cmd)
 183         struct mii_softc *sc;
 184         struct mii_data *mii;
 185         int cmd;
 186 {
 187         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 188         int reg;
 189
 190         switch (cmd) {
 191         case MII_POLLSTAT:
 192                 /*
 193                  * If we're not polling our PHY instance, just return.
 194                  */
 195                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 196                         return (0);
 197                 break;
 198
 199         case MII_MEDIACHG:
 200                 /*
 201                  * If the media indicates a different PHY instance,
 202                  * isolate ourselves.
 203                  */
 204                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 205                         reg = PHY_READ(sc, MII_BMCR);
 206                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 207                         return (0);
 208                 }
 209
 210                 /*
 211                  * If the interface is not up, don't do anything.
 212                  */
 213                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 214                         break;
 215
 216                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 217                 case IFM_AUTO:
 218 #ifdef foo
 219                         /*
 220                          * If we're already in auto mode, just return.
 221                          */
 222                         if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
 223                                 return (0);
 224 #endif
 225                         (void) xmphy_mii_phy_auto(sc, 1);
 226                         break;
 227                 case IFM_1000_SX:
 228                         mii_phy_reset(sc);
 229                         if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
 230                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
 231                                 PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
 232                         } else {
 233                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
 234                                 PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
 235                         }
 236                         break;
 237                 case IFM_100_T4:
 238                 case IFM_100_TX:
 239                 case IFM_10_T:
 240                 default:
 241                         return (EINVAL);
 242                 }
 243                 break;
 244
 245         case MII_TICK:
 246                 /*
 247                  * If we're not currently selected, just return.
 248                  */
 249                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 250                         return (0);
 251
 252                 /*
 253                  * Only used for autonegotiation.
 254                  */
 255                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 256                         return (0);
 257
 258                 /*
 259                  * Is the interface even up?
 260                  */
 261                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 262                         return (0);
 263
 264                 /*
 265                  * Only retry autonegotiation every 5 seconds.
 266                  */
 267                 if (++sc->mii_ticks != 5)
 268                         return (0);
 269
 270                 sc->mii_ticks = 0;
 271
 272                 /*
 273                  * Check to see if we have link.  If we do, we don't
 274                  * need to restart the autonegotiation process.  Read
 275                  * the BMSR twice in case it's latched.
 276                  */
 277                 reg = PHY_READ(sc, XMPHY_MII_BMSR) |
 278                     PHY_READ(sc, XMPHY_MII_BMSR);
 279                 if (reg & XMPHY_BMSR_LINK)
 280                         break;
 281
 282                 mii_phy_reset(sc);
 283                 if (xmphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
 284                         return(0);
 285                 break;
 286         }
 287
 288         /* Update the media status. */
 289         xmphy_status(sc);
 290
 291         /* Callback if something changed. */
 292         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 293                 MIIBUS_STATCHG(sc->mii_dev);
 294                 sc->mii_active = mii->mii_media_active;
 295         }
 296         return (0);
 297 }
 298
 299 void
 300 xmphy_status(sc)
 301         struct mii_softc *sc;
 302 {
 303         struct mii_data *mii = sc->mii_pdata;
 304         int bmsr, bmcr, anlpar;
 305
 306         mii->mii_media_status = IFM_AVALID;
 307         mii->mii_media_active = IFM_ETHER;
 308
 309         bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
 310             PHY_READ(sc, XMPHY_MII_BMSR);
 311         if (bmsr & XMPHY_BMSR_LINK)
 312                 mii->mii_media_status |= IFM_ACTIVE;
 313
 314         /* Do dummy read of extended status register. */
 315         bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
 316
 317         bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
 318
 319         if (bmcr & XMPHY_BMCR_LOOP)
 320                 mii->mii_media_active |= IFM_LOOP;
 321
 322
 323         if (bmcr & XMPHY_BMCR_AUTOEN) {
 324                 if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
 325                         if (bmsr & XMPHY_BMSR_LINK) {
 326                                 mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
 327                                 return;
 328                         }
 329                         /* Erg, still trying, I guess... */
 330                         mii->mii_media_active |= IFM_NONE;
 331                         return;
 332                 }
 333
 334                 mii->mii_media_active |= IFM_1000_SX;
 335                 anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
 336                     PHY_READ(sc, XMPHY_MII_ANLPAR);
 337                 if (anlpar & XMPHY_ANLPAR_FDX)
 338                         mii->mii_media_active |= IFM_FDX;
 339                 else
 340                         mii->mii_media_active |= IFM_HDX;
 341                 return;
 342         }
 343
 344         mii->mii_media_active |= IFM_1000_SX;
 345         if (bmcr & XMPHY_BMCR_FDX)
 346                 mii->mii_media_active |= IFM_FDX;
 347         else
 348                 mii->mii_media_active |= IFM_HDX;
 349
 350         return;
 351 }
 352
 353
 354 static int
 355 xmphy_mii_phy_auto(mii, waitfor)
 356         struct mii_softc *mii;
 357         int waitfor;
 358 {
 359         int bmsr, anar = 0, i;
 360
 361         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
 362                 anar = PHY_READ(mii, XMPHY_MII_ANAR);
 363                 anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
 364                 PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
 365                 DELAY(1000);
 366                 PHY_WRITE(mii, XMPHY_MII_BMCR,
 367                     XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
 368         }
 369
 370         if (waitfor) {
 371                 /* Wait 500ms for it to complete. */
 372                 for (i = 0; i < 500; i++) {
 373                         if ((bmsr = PHY_READ(mii, XMPHY_MII_BMSR)) &
 374                             XMPHY_BMSR_ACOMP)
 375                                 return (0);
 376                         DELAY(1000);
 377 #if 0
 378                 if ((bmsr & BMSR_ACOMP) == 0)
 379                         printf("%s: autonegotiation failed to complete\n",
 380                             mii->mii_dev.dv_xname);
 381 #endif
 382                 }
 383
 384                 /*
 385                  * Don't need to worry about clearing MIIF_DOINGAUTO.
 386                  * If that's set, a timeout is pending, and it will
 387                  * clear the flag.
 388                  */
 389                 return (EIO);
 390         }
 391
 392         /*
 393          * Just let it finish asynchronously.  This is for the benefit of
 394          * the tick handler driving autonegotiation.  Don't want 500ms
 395          * delays all the time while the system is running!
 396          */
 397         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
 398                 mii->mii_flags |= MIIF_DOINGAUTO;
 399                 callout_reset(&mii->mii_auto_ch, hz >> 1,
 400                                 mii_phy_auto_timeout, mii);
 401         }
 402         return (EJUSTRETURN);
 403 }