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