sys/dev/mii/mlphy.c

   1 /*-
   2  * Copyright (c) 1997, 1998, 1999
   3  *      Bill Paul <wpaul@ctr.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
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36
  37 /*
  38  * driver for Micro Linear 6692 PHYs
  39  *
  40  * The Micro Linear 6692 is a strange beast, and dealing with it using
  41  * this code framework is tricky. The 6692 is actually a 100Mbps-only
  42  * device, which means that a second PHY is required to support 10Mbps
  43  * modes. However, even though the 6692 does not support 10Mbps modes,
  44  * it can still advertise them when performing autonegotiation. If a
  45  * 10Mbps mode is negotiated, we must program the registers of the
  46  * companion PHY accordingly in addition to programming the registers
  47  * of the 6692.
  48  *
  49  * This device also does not have vendor/device ID registers.
  50  */
  51
  52 #include <sys/param.h>
  53 #include <sys/systm.h>
  54 #include <sys/kernel.h>
  55 #include <sys/socket.h>
  56 #include <sys/module.h>
  57 #include <sys/bus.h>
  58 #include <sys/malloc.h>
  59
  60 #include <net/if.h>
  61 #include <net/if_media.h>
  62
  63 #include <dev/mii/mii.h>
  64 #include <dev/mii/miivar.h>
  65
  66 #include "miibus_if.h"
  67
  68 #define ML_STATE_AUTO_SELF      1
  69 #define ML_STATE_AUTO_OTHER     2
  70
  71 struct mlphy_softc      {
  72         struct mii_softc        ml_mii;
  73         device_t                ml_dev;
  74         int                     ml_state;
  75         int                     ml_linked;
  76 };
  77
  78 static int mlphy_probe(device_t);
  79 static int mlphy_attach(device_t);
  80
  81 static device_method_t mlphy_methods[] = {
  82         /* device interface */
  83         DEVMETHOD(device_probe,         mlphy_probe),
  84         DEVMETHOD(device_attach,        mlphy_attach),
  85         DEVMETHOD(device_detach,        mii_phy_detach),
  86         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  87         DEVMETHOD_END
  88 };
  89
  90 static devclass_t mlphy_devclass;
  91
  92 static driver_t mlphy_driver = {
  93         "mlphy",
  94         mlphy_methods,
  95         sizeof(struct mlphy_softc)
  96 };
  97
  98 DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0);
  99
 100 static struct mii_softc *mlphy_find_other(struct mlphy_softc *);
 101 static int      mlphy_service(struct mii_softc *, struct mii_data *, int);
 102 static void     mlphy_reset(struct mii_softc *);
 103 static void     mlphy_status(struct mii_softc *);
 104
 105 static const struct mii_phy_funcs mlphy_funcs = {
 106         mlphy_service,
 107         mlphy_status,
 108         mlphy_reset
 109 };
 110
 111 static int
 112 mlphy_probe(dev)
 113         device_t                dev;
 114 {
 115         struct mii_attach_args  *ma;
 116
 117         ma = device_get_ivars(dev);
 118
 119         /*
 120          * Micro Linear PHY reports oui == 0 model == 0
 121          */
 122         if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
 123             MII_MODEL(ma->mii_id2) != 0)
 124                 return (ENXIO);
 125
 126         /*
 127          * Make sure the parent is a `tl'. So far, I have only
 128          * encountered the 6692 on an Olicom card with a ThunderLAN
 129          * controller chip.
 130          */
 131         if (!mii_dev_mac_match(dev, "tl"))
 132                 return (ENXIO);
 133
 134         device_set_desc(dev, "Micro Linear 6692 media interface");
 135
 136         return (BUS_PROBE_DEFAULT);
 137 }
 138
 139 static int
 140 mlphy_attach(dev)
 141         device_t                dev;
 142 {
 143         struct mlphy_softc *msc;
 144         struct mii_softc *sc;
 145
 146         msc = device_get_softc(dev);
 147         sc = &msc->ml_mii;
 148         msc->ml_dev = dev;
 149         mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &mlphy_funcs, 0);
 150
 151         PHY_RESET(sc);
 152
 153         sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & sc->mii_capmask;
 154         /* Let the companion PHY (if any) only handle the media we don't. */
 155         sc->mii_capmask = ~sc->mii_capabilities;
 156         device_printf(dev, " ");
 157         mii_phy_add_media(sc);
 158         printf("\n");
 159
 160         MIIBUS_MEDIAINIT(sc->mii_dev);
 161         return (0);
 162 }
 163
 164 static struct mii_softc *
 165 mlphy_find_other(struct mlphy_softc *msc)
 166 {
 167         device_t                *devlist;
 168         struct mii_softc *retval;
 169         int i, devs;
 170
 171         retval = NULL;
 172         if (device_get_children(msc->ml_mii.mii_dev, &devlist, &devs) != 0)
 173                 return (NULL);
 174         for (i = 0; i < devs; i++) {
 175                 if (devlist[i] != msc->ml_dev) {
 176                         retval = device_get_softc(devlist[i]);
 177                         break;
 178                 }
 179         }
 180         free(devlist, M_TEMP);
 181         return (retval);
 182 }
 183
 184 static int
 185 mlphy_service(xsc, mii, cmd)
 186         struct mii_softc *xsc;
 187         struct mii_data *mii;
 188         int cmd;
 189 {
 190         struct ifmedia_entry    *ife = mii->mii_media.ifm_cur;
 191         struct mii_softc        *other = NULL;
 192         struct mlphy_softc      *msc = (struct mlphy_softc *)xsc;
 193         struct mii_softc        *sc = (struct mii_softc *)&msc->ml_mii;
 194         int                     other_inst, reg;
 195
 196         /*
 197          * See if there's another PHY on this bus with us.
 198          * If so, we may need it for 10Mbps modes.
 199          */
 200         other = mlphy_find_other(msc);
 201
 202         switch (cmd) {
 203         case MII_POLLSTAT:
 204                 break;
 205
 206         case MII_MEDIACHG:
 207                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 208                 case IFM_AUTO:
 209                         /*
 210                          * For autonegotiation, reset and isolate the
 211                          * companion PHY (if any) and then do NWAY
 212                          * autonegotiation ourselves.
 213                          */
 214                         msc->ml_state = ML_STATE_AUTO_SELF;
 215                         if (other != NULL) {
 216                                 PHY_RESET(other);
 217                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 218                         }
 219                         (void)mii_phy_auto(sc);
 220                         msc->ml_linked = 0;
 221                         return (0);
 222                 case IFM_10_T:
 223                 case IFM_100_TX:
 224                         /*
 225                          * For 10baseT and 100baseTX modes, reset and isolate
 226                          * the companion PHY (if any), then program ourselves
 227                          * accordingly.
 228                          */
 229                         if (other != NULL) {
 230                                 PHY_RESET(other);
 231                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 232                         }
 233                         mii_phy_setmedia(sc);
 234                         msc->ml_state = 0;
 235                         break;
 236                 default:
 237                         return (EINVAL);
 238
 239                 }
 240                 break;
 241
 242         case MII_TICK:
 243                 /*
 244                  * Only used for autonegotiation.
 245                  */
 246                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 247                         break;
 248
 249                 /*
 250                  * Check to see if we have link.  If we do, we don't
 251                  * need to restart the autonegotiation process.  Read
 252                  * the BMSR twice in case it's latched.
 253                  * If we're in a 10Mbps mode, check the link of the
 254                  * 10Mbps PHY. Sometimes the Micro Linear PHY's
 255                  * linkstat bit will clear while the linkstat bit of
 256                  * the companion PHY will remain set.
 257                  */
 258                 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
 259                         reg = PHY_READ(other, MII_BMSR) |
 260                             PHY_READ(other, MII_BMSR);
 261                 } else {
 262                         reg = PHY_READ(sc, MII_BMSR) |
 263                             PHY_READ(sc, MII_BMSR);
 264                 }
 265
 266                 if (reg & BMSR_LINK) {
 267                         if (!msc->ml_linked) {
 268                                 msc->ml_linked = 1;
 269                                 PHY_STATUS(sc);
 270                         }
 271                         break;
 272                 }
 273
 274                 /*
 275                  * Only retry autonegotiation every 5 seconds.
 276                  */
 277                 if (++sc->mii_ticks <= MII_ANEGTICKS)
 278                         break;
 279
 280                 sc->mii_ticks = 0;
 281                 msc->ml_linked = 0;
 282                 mii->mii_media_active = IFM_NONE;
 283                 PHY_RESET(sc);
 284                 msc->ml_state = ML_STATE_AUTO_SELF;
 285                 if (other != NULL) {
 286                         PHY_RESET(other);
 287                         PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 288                 }
 289                 mii_phy_auto(sc);
 290                 return (0);
 291         }
 292
 293         /* Update the media status. */
 294
 295         if (msc->ml_state == ML_STATE_AUTO_OTHER) {
 296                 other_inst = other->mii_inst;
 297                 other->mii_inst = sc->mii_inst;
 298                 if (IFM_INST(ife->ifm_media) == other->mii_inst)
 299                         (void)PHY_SERVICE(other, mii, MII_POLLSTAT);
 300                 other->mii_inst = other_inst;
 301                 sc->mii_media_active = other->mii_media_active;
 302                 sc->mii_media_status = other->mii_media_status;
 303         } else
 304                 ukphy_status(sc);
 305
 306         /* Callback if something changed. */
 307         mii_phy_update(sc, cmd);
 308         return (0);
 309 }
 310
 311 /*
 312  * The Micro Linear PHY comes out of reset with the 'autoneg
 313  * enable' bit set, which we don't want.
 314  */
 315 static void
 316 mlphy_reset(sc)
 317         struct mii_softc        *sc;
 318 {
 319         int                     reg;
 320
 321         mii_phy_reset(sc);
 322         reg = PHY_READ(sc, MII_BMCR);
 323         reg &= ~BMCR_AUTOEN;
 324         PHY_WRITE(sc, MII_BMCR, reg);
 325 }
 326
 327 /*
 328  * If we negotiate a 10Mbps mode, we need to check for an alternate
 329  * PHY and make sure it's enabled and set correctly.
 330  */
 331 static void
 332 mlphy_status(sc)
 333         struct mii_softc        *sc;
 334 {
 335         struct mlphy_softc      *msc = (struct mlphy_softc *)sc;
 336         struct mii_data         *mii = msc->ml_mii.mii_pdata;
 337         struct mii_softc        *other = NULL;
 338
 339         /* See if there's another PHY on the bus with us. */
 340         other = mlphy_find_other(msc);
 341         if (other == NULL)
 342                 return;
 343
 344         ukphy_status(sc);
 345
 346         if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) {
 347                 msc->ml_state = ML_STATE_AUTO_SELF;
 348                 PHY_RESET(other);
 349                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 350         }
 351
 352         if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) {
 353                 msc->ml_state = ML_STATE_AUTO_OTHER;
 354                 PHY_RESET(&msc->ml_mii);
 355                 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO);
 356                 PHY_RESET(other);
 357                 mii_phy_auto(other);
 358         }
 359 }