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