sys/dev/netif/mii_layer/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  * $FreeBSD: src/sys/dev/mii/mlphy.c,v 1.2.2.3 2001/02/09 09:50:15 asmodai Exp $
  33  * $DragonFly: src/sys/dev/netif/mii_layer/mlphy.c,v 1.5 2004/09/18 19:32:59 dillon Exp $
  34  */
  35
  36 /*
  37  * driver for Micro Linear 6692 PHYs
  38  *
  39  * The Micro Linear 6692 is a strange beast, and dealing with it using
  40  * this code framework is tricky. The 6692 is actually a 100Mbps-only
  41  * device, which means that a second PHY is required to support 10Mbps
  42  * modes. However, even though the 6692 does not support 10Mbps modes,
  43  * it can still advertise them when performing autonegotiation. If a
  44  * 10Mbps mode is negotiated, we must program the registers of the
  45  * companion PHY accordingly in addition to programming the registers
  46  * of the 6692.
  47  *
  48  * This device also does not have vendor/device ID registers.
  49  */
  50
  51 #include <sys/param.h>
  52 #include <sys/systm.h>
  53 #include <sys/kernel.h>
  54 #include <sys/malloc.h>
  55 #include <sys/socket.h>
  56 #include <sys/module.h>
  57 #include <sys/bus.h>
  58
  59 #include <machine/clock.h>
  60
  61 #include <net/if.h>
  62 #include <net/if_media.h>
  63
  64 #include "mii.h"
  65 #include "miivar.h"
  66
  67 #include "miibus_if.h"
  68
  69 #define ML_STATE_AUTO_SELF      1
  70 #define ML_STATE_AUTO_OTHER     2
  71
  72 struct mlphy_softc      {
  73         struct mii_softc        ml_mii;
  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 static int mlphy_detach         (device_t);
  81
  82 static device_method_t mlphy_methods[] = {
  83         /* device interface */
  84         DEVMETHOD(device_probe,         mlphy_probe),
  85         DEVMETHOD(device_attach,        mlphy_attach),
  86         DEVMETHOD(device_detach,        mlphy_detach),
  87         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  88         { 0, 0 }
  89 };
  90
  91 static devclass_t mlphy_devclass;
  92
  93 static driver_t mlphy_driver = {
  94         "mlphy",
  95         mlphy_methods,
  96         sizeof(struct mlphy_softc)
  97 };
  98
  99 DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0);
 100
 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 int mlphy_probe(dev)
 106         device_t                dev;
 107 {
 108         struct mii_attach_args  *ma;
 109         device_t                parent;
 110
 111         ma = device_get_ivars(dev);
 112         parent = device_get_parent(device_get_parent(dev));
 113
 114         /*
 115          * Micro Linear PHY reports oui == 0 model == 0
 116          */
 117         if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
 118             MII_MODEL(ma->mii_id2) != 0)
 119                 return (ENXIO);
 120
 121         /*
 122          * Make sure the parent is a `tl'. So far, I have only
 123          * encountered the 6692 on an Olicom card with a ThunderLAN
 124          * controller chip.
 125          */
 126         if (strcmp(device_get_name(parent), "tl") != 0)
 127                 return (ENXIO);
 128
 129         device_set_desc(dev, "Micro Linear 6692 media interface");
 130
 131         return (0);
 132 }
 133
 134 static int mlphy_attach(dev)
 135         device_t                dev;
 136 {
 137         struct mlphy_softc *msc;
 138         struct mii_softc *sc;
 139         struct mii_attach_args *ma;
 140         struct mii_data *mii;
 141
 142         msc = device_get_softc(dev);
 143         sc = &msc->ml_mii;
 144         ma = device_get_ivars(dev);
 145         mii_softc_init(sc);
 146         sc->mii_dev = device_get_parent(dev);
 147         mii = device_get_softc(sc->mii_dev);
 148         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 149
 150         sc->mii_inst = mii->mii_instance;
 151         sc->mii_phy = ma->mii_phyno;
 152         sc->mii_service = mlphy_service;
 153         sc->mii_pdata = mii;
 154
 155         mii->mii_instance++;
 156
 157 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 158
 159 #if 0 /* See above. */
 160         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 161             BMCR_ISO);
 162 #endif
 163         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 164             BMCR_LOOP|BMCR_S100);
 165
 166         sc->mii_flags &= ~MIIF_NOISOLATE;
 167         mii_phy_reset(sc);
 168         sc->mii_flags |= MIIF_NOISOLATE;
 169
 170         sc->mii_capabilities =
 171             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 172         ma->mii_capmask = ~sc->mii_capabilities;
 173         device_printf(dev, " ");
 174         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 175                 printf("no media present");
 176         else
 177                 mii_add_media(mii, sc->mii_capabilities,
 178                     sc->mii_inst);
 179         printf("\n");
 180 #undef ADD
 181         MIIBUS_MEDIAINIT(sc->mii_dev);
 182         return(0);
 183 }
 184
 185 static int mlphy_detach(dev)
 186         device_t                dev;
 187 {
 188         struct mlphy_softc      *sc;
 189         struct mii_data         *mii;
 190
 191         sc = device_get_softc(dev);
 192         mii = device_get_softc(device_get_parent(dev));
 193         mii_phy_auto_stop(&sc->ml_mii);
 194         sc->ml_mii.mii_dev = NULL;
 195         LIST_REMOVE(&sc->ml_mii, mii_list);
 196
 197         return(0);
 198 }
 199
 200 static int
 201 mlphy_service(xsc, mii, cmd)
 202         struct mii_softc *xsc;
 203         struct mii_data *mii;
 204         int cmd;
 205 {
 206         struct ifmedia_entry    *ife = mii->mii_media.ifm_cur;
 207         int                     reg;
 208         struct mii_softc        *other = NULL;
 209         struct mlphy_softc      *msc = (struct mlphy_softc *)xsc;
 210         struct mii_softc        *sc = (struct mii_softc *)&msc->ml_mii;
 211         device_t                *devlist;
 212         int                     devs, i;
 213
 214         /*
 215          * See if there's another PHY on this bus with us.
 216          * If so, we may need it for 10Mbps modes.
 217          */
 218         device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
 219         for (i = 0; i < devs; i++) {
 220                 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
 221                         other = device_get_softc(devlist[i]);
 222                         break;
 223                 }
 224         }
 225         free(devlist, M_TEMP);
 226
 227         switch (cmd) {
 228         case MII_POLLSTAT:
 229                 /*
 230                  * If we're not polling our PHY instance, just return.
 231                  */
 232                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 233                         return (0);
 234                 break;
 235
 236         case MII_MEDIACHG:
 237                 /*
 238                  * If the media indicates a different PHY instance,
 239                  * isolate ourselves.
 240                  */
 241                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 242                         reg = PHY_READ(sc, MII_BMCR);
 243                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 244                         return (0);
 245                 }
 246
 247                 /*
 248                  * If the interface is not up, don't do anything.
 249                  */
 250                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 251                         break;
 252
 253                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 254                 case IFM_AUTO:
 255                         /*
 256                          * For autonegotiation, reset and isolate the
 257                          * companion PHY (if any) and then do NWAY
 258                          * autonegotiation ourselves.
 259                          */
 260                         msc->ml_state = ML_STATE_AUTO_SELF;
 261                         if (other != NULL) {
 262                                 mii_phy_reset(other);
 263                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 264                         }
 265                         (void) mii_phy_auto(sc, 1);
 266                         msc->ml_linked = 0;
 267                         return(0);
 268                         break;
 269                 case IFM_10_T:
 270                         /*
 271                          * For 10baseT modes, reset and program the
 272                          * companion PHY (of any), then program ourselves
 273                          * to match. This will put us in pass-through
 274                          * mode and let the companion PHY do all the
 275                          * work.
 276                          *
 277                          * BMCR data is stored in the ifmedia entry.
 278                          */
 279                         if (other != NULL) {
 280                                 mii_phy_reset(other);
 281                                 PHY_WRITE(other, MII_BMCR, ife->ifm_data);
 282                         }
 283                         PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
 284                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 285                         msc->ml_state = 0;
 286                         break;
 287                 case IFM_100_TX:
 288                         /*
 289                          * For 100baseTX modes, reset and isolate the
 290                          * companion PHY (if any), then program ourselves
 291                          * accordingly.
 292                          *
 293                          * BMCR data is stored in the ifmedia entry.
 294                          */
 295                         if (other != NULL) {
 296                                 mii_phy_reset(other);
 297                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 298                         }
 299                         PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
 300                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 301                         msc->ml_state = 0;
 302                         break;
 303                 case IFM_100_T4:
 304                         /*
 305                          * XXX Not supported as a manual setting right now.
 306                          */
 307                         return (EINVAL);
 308                 default:
 309                         break;
 310
 311                 }
 312                 break;
 313
 314         case MII_TICK:
 315                 /*
 316                  * If we're not currently selected, just return.
 317                  */
 318                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 319                         return (0);
 320
 321                 /*
 322                  * Only used for autonegotiation.
 323                  */
 324                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 325                         return (0);
 326
 327                 /*
 328                  * Is the interface even up?
 329                  */
 330                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 331                         return (0);
 332
 333                 /*
 334                  * Only retry autonegotiation every 5 seconds.
 335                  */
 336                 if (++sc->mii_ticks != 5)
 337                         return (0);
 338
 339                 sc->mii_ticks = 0;
 340
 341                 /*
 342                  * Check to see if we have link.  If we do, we don't
 343                  * need to restart the autonegotiation process.  Read
 344                  * the BMSR twice in case it's latched.
 345                  * If we're in a 10Mbps mode, check the link of the
 346                  * 10Mbps PHY. Sometimes the Micro Linear PHY's
 347                  * linkstat bit will clear while the linkstat bit of
 348                  * the companion PHY will remain set.
 349                  */
 350                 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
 351                         reg = PHY_READ(other, MII_BMSR) |
 352                             PHY_READ(other, MII_BMSR);
 353                 } else {
 354                         reg = PHY_READ(sc, MII_BMSR) |
 355                             PHY_READ(sc, MII_BMSR);
 356                 }
 357
 358                 if (reg & BMSR_LINK) {
 359                         if (!msc->ml_linked) {
 360                                 msc->ml_linked = 1;
 361                                 mlphy_status(sc);
 362                                 break;
 363                         }
 364                         return(0);
 365                 }
 366
 367                 msc->ml_linked = 0;
 368                 mii->mii_media_active = IFM_NONE;
 369                 mii_phy_reset(sc);
 370                 msc->ml_state = ML_STATE_AUTO_SELF;
 371                 if (other != NULL) {
 372                         mii_phy_reset(other);
 373                         PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 374                 }
 375                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 376                         return(0);
 377                 break;
 378         }
 379
 380         /* Update the media status. */
 381
 382         if (msc->ml_state == ML_STATE_AUTO_OTHER) {
 383                 int                     other_inst;
 384                 other_inst = other->mii_inst;
 385                 other->mii_inst = sc->mii_inst;
 386                 (void) (*other->mii_service)(other, mii, MII_POLLSTAT);
 387                 other->mii_inst = other_inst;
 388                 sc->mii_active = other->mii_active;
 389         } else
 390                 ukphy_status(sc);
 391
 392         /* Callback if something changed. */
 393         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 394                 MIIBUS_STATCHG(sc->mii_dev);
 395                 sc->mii_active = mii->mii_media_active;
 396         }
 397
 398         return (0);
 399 }
 400
 401 /*
 402  * The Micro Linear PHY comes out of reset with the 'autoneg
 403  * enable' bit set, which we don't want.
 404  */
 405 static void mlphy_reset(sc)
 406         struct mii_softc        *sc;
 407 {
 408         int                     reg;
 409
 410         mii_phy_reset(sc);
 411         reg = PHY_READ(sc, MII_BMCR);
 412         reg &= ~BMCR_AUTOEN;
 413         PHY_WRITE(sc, MII_BMCR, reg);
 414
 415         return;
 416 }
 417
 418 /*
 419  * If we negotiate a 10Mbps mode, we need to check for an alternate
 420  * PHY and make sure it's enabled and set correctly.
 421  */
 422 static void mlphy_status(sc)
 423         struct mii_softc        *sc;
 424 {
 425         struct mlphy_softc      *msc = (struct mlphy_softc *)sc;
 426         struct mii_data         *mii = msc->ml_mii.mii_pdata;
 427         struct mii_softc        *other = NULL;
 428         device_t                *devlist;
 429         int                     devs, i;
 430
 431         /* See if there's another PHY on the bus with us. */
 432         device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
 433         for (i = 0; i < devs; i++) {
 434                 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
 435                         other = device_get_softc(devlist[i]);
 436                         break;
 437                 }
 438         }
 439         free(devlist, M_TEMP);
 440
 441         if (other == NULL)
 442                 return;
 443
 444         ukphy_status(sc);
 445
 446         if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) {
 447                 msc->ml_state = ML_STATE_AUTO_SELF;
 448                 mii_phy_reset(other);
 449                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 450         }
 451
 452         if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) {
 453                 msc->ml_state = ML_STATE_AUTO_OTHER;
 454                 mlphy_reset(&msc->ml_mii);
 455                 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO);
 456                 mii_phy_reset(other);
 457                 mii_phy_auto(other, 1);
 458         }
 459
 460         return;
 461 }