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