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 = ma->mii_data;
 111         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 112
 113         sc->mii_flags = miibus_get_flags(dev);
 114         sc->mii_inst = mii->mii_instance++;
 115         sc->mii_phy = ma->mii_phyno;
 116         sc->mii_service = xmphy_service;
 117         sc->mii_pdata = mii;
 118
 119         sc->mii_flags |= MIIF_NOISOLATE;
 120         sc->mii_anegticks = MII_ANEGTICKS;
 121
 122         mii_phy_reset(sc);
 123
 124 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 125 #define PRINT(s)        printf("%s%s", sep, s); sep = ", "
 126
 127         device_printf(dev, " ");
 128         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
 129             XMPHY_BMCR_FDX);
 130         PRINT("1000baseSX");
 131         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
 132         PRINT("1000baseSX-FDX");
 133         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
 134         PRINT("auto");
 135
 136         printf("\n");
 137 #undef ADD
 138 #undef PRINT
 139
 140         MIIBUS_MEDIAINIT(sc->mii_dev);
 141         return (0);
 142 }
 143
 144 static int
 145 xmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 146 {
 147         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 148         int reg;
 149
 150         switch (cmd) {
 151         case MII_POLLSTAT:
 152                 break;
 153
 154         case MII_MEDIACHG:
 155                 /*
 156                  * If the interface is not up, don't do anything.
 157                  */
 158                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 159                         break;
 160
 161                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 162                 case IFM_AUTO:
 163 #ifdef foo
 164                         /*
 165                          * If we're already in auto mode, just return.
 166                          */
 167                         if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
 168                                 return (0);
 169 #endif
 170                         (void)xmphy_mii_phy_auto(sc);
 171                         break;
 172                 case IFM_1000_SX:
 173                         mii_phy_reset(sc);
 174                         if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
 175                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
 176                                 PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
 177                         } else {
 178                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
 179                                 PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
 180                         }
 181                         break;
 182                 default:
 183                         return (EINVAL);
 184                 }
 185                 break;
 186
 187         case MII_TICK:
 188                 /*
 189                  * Is the interface even up?
 190                  */
 191                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 192                         return (0);
 193
 194                 /*
 195                  * Only used for autonegotiation.
 196                  */
 197                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 198                         break;
 199
 200                 /*
 201                  * Check to see if we have link.  If we do, we don't
 202                  * need to restart the autonegotiation process.  Read
 203                  * the BMSR twice in case it's latched.
 204                  */
 205                 reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 206                 if (reg & BMSR_LINK)
 207                         break;
 208
 209                 /* Only retry autonegotiation every mii_anegticks seconds. */
 210                 if (sc->mii_ticks <= sc->mii_anegticks)
 211                         break;
 212
 213                 sc->mii_ticks = 0;
 214
 215                 mii_phy_reset(sc);
 216                 xmphy_mii_phy_auto(sc);
 217                 return (0);
 218         }
 219
 220         /* Update the media status. */
 221         xmphy_status(sc);
 222
 223         /* Callback if something changed. */
 224         mii_phy_update(sc, cmd);
 225         return (0);
 226 }
 227
 228 static void
 229 xmphy_status(struct mii_softc *sc)
 230 {
 231         struct mii_data *mii = sc->mii_pdata;
 232         int bmsr, bmcr, anlpar;
 233
 234         mii->mii_media_status = IFM_AVALID;
 235         mii->mii_media_active = IFM_ETHER;
 236
 237         bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
 238             PHY_READ(sc, XMPHY_MII_BMSR);
 239         if (bmsr & XMPHY_BMSR_LINK)
 240                 mii->mii_media_status |= IFM_ACTIVE;
 241
 242         /* Do dummy read of extended status register. */
 243         bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
 244
 245         bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
 246
 247         if (bmcr & XMPHY_BMCR_LOOP)
 248                 mii->mii_media_active |= IFM_LOOP;
 249
 250
 251         if (bmcr & XMPHY_BMCR_AUTOEN) {
 252                 if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
 253                         if (bmsr & XMPHY_BMSR_LINK) {
 254                                 mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
 255                                 return;
 256                         }
 257                         /* Erg, still trying, I guess... */
 258                         mii->mii_media_active |= IFM_NONE;
 259                         return;
 260                 }
 261
 262                 mii->mii_media_active |= IFM_1000_SX;
 263                 anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
 264                     PHY_READ(sc, XMPHY_MII_ANLPAR);
 265                 if (anlpar & XMPHY_ANLPAR_FDX)
 266                         mii->mii_media_active |= IFM_FDX;
 267                 else
 268                         mii->mii_media_active |= IFM_HDX;
 269                 return;
 270         }
 271
 272         mii->mii_media_active |= IFM_1000_SX;
 273         if (bmcr & XMPHY_BMCR_FDX)
 274                 mii->mii_media_active |= IFM_FDX;
 275         else
 276                 mii->mii_media_active |= IFM_HDX;
 277 }
 278
 279 static int
 280 xmphy_mii_phy_auto(struct mii_softc *mii)
 281 {
 282         int anar = 0;
 283
 284         anar = PHY_READ(mii, XMPHY_MII_ANAR);
 285         anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
 286         PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
 287         DELAY(1000);
 288         PHY_WRITE(mii, XMPHY_MII_BMCR,
 289             XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
 290
 291         return (EJUSTRETURN);
 292 }