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