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.10 2006/09/05 00:55:40 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
 106 mlphy_probe(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
 135 mlphy_attach(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, ma);
 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_service = mlphy_service;
 152         sc->mii_reset = mlphy_reset;
 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             MII_MEDIA_NONE);
 162 #endif
 163         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 164             MII_MEDIA_100_TX);
 165
 166         sc->mii_flags &= ~MIIF_NOISOLATE;
 167         mii_phy_reset(sc);
 168         sc->mii_flags |= MIIF_NOISOLATE;
 169
 170         sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 171
 172         device_printf(dev, " ");
 173         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 174                 printf("no media present");
 175         else
 176                 mii_phy_add_media(sc);
 177         printf("\n");
 178 #undef ADD
 179         MIIBUS_MEDIAINIT(sc->mii_dev);
 180         return(0);
 181 }
 182
 183 static int
 184 mlphy_detach(device_t dev)
 185 {
 186         struct mlphy_softc *sc;
 187
 188         sc = device_get_softc(dev);
 189         mii_phy_auto_stop(&sc->ml_mii);
 190         sc->ml_mii.mii_dev = NULL;
 191         LIST_REMOVE(&sc->ml_mii, mii_list);
 192
 193         return(0);
 194 }
 195
 196 static int
 197 mlphy_service(struct mii_softc *xsc, struct mii_data *mii, int cmd)
 198 {
 199         struct ifmedia_entry    *ife = mii->mii_media.ifm_cur;
 200         int                     reg;
 201         struct mii_softc        *other = NULL;
 202         struct mlphy_softc      *msc = (struct mlphy_softc *)xsc;
 203         struct mii_softc        *sc = (struct mii_softc *)&msc->ml_mii;
 204         device_t                *devlist;
 205         int                     devs, i;
 206         const struct mii_media  *mm;
 207
 208         /*
 209          * See if there's another PHY on this bus with us.
 210          * If so, we may need it for 10Mbps modes.
 211          */
 212         device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
 213         for (i = 0; i < devs; i++) {
 214                 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
 215                         other = device_get_softc(devlist[i]);
 216                         break;
 217                 }
 218         }
 219         kfree(devlist, M_TEMP);
 220
 221         KKASSERT(ife->ifm_data >= 0 && ife->ifm_data < MII_NMEDIA);
 222         mm = &mii_media_table[ife->ifm_data];
 223
 224         switch (cmd) {
 225         case MII_POLLSTAT:
 226                 /*
 227                  * If we're not polling our PHY instance, just return.
 228                  */
 229                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 230                         return (0);
 231                 break;
 232
 233         case MII_MEDIACHG:
 234                 /*
 235                  * If the media indicates a different PHY instance,
 236                  * isolate ourselves.
 237                  */
 238                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 239                         reg = PHY_READ(sc, MII_BMCR);
 240                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 241                         return (0);
 242                 }
 243
 244                 /*
 245                  * If the interface is not up, don't do anything.
 246                  */
 247                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 248                         break;
 249
 250                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 251                 case IFM_AUTO:
 252                         /*
 253                          * For autonegotiation, reset and isolate the
 254                          * companion PHY (if any) and then do NWAY
 255                          * autonegotiation ourselves.
 256                          */
 257                         msc->ml_state = ML_STATE_AUTO_SELF;
 258                         if (other != NULL) {
 259                                 mii_phy_reset(other);
 260                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 261                         }
 262                         mii_phy_auto(sc, 1);
 263                         msc->ml_linked = 0;
 264                         return(0);
 265
 266                 case IFM_10_T:
 267                         /*
 268                          * For 10baseT modes, reset and program the
 269                          * companion PHY (of any), then program ourselves
 270                          * to match. This will put us in pass-through
 271                          * mode and let the companion PHY do all the
 272                          * work.
 273                          */
 274                         if (other != NULL) {
 275                                 mii_phy_reset(other);
 276                                 PHY_WRITE(other, MII_BMCR, mm->mm_bmcr);
 277                         }
 278                         PHY_WRITE(sc, MII_ANAR, mm->mm_anar);
 279                         PHY_WRITE(sc, MII_BMCR, mm->mm_bmcr);
 280                         msc->ml_state = 0;
 281                         break;
 282
 283                 case IFM_100_TX:
 284                         /*
 285                          * For 100baseTX modes, reset and isolate the
 286                          * companion PHY (if any), then program ourselves
 287                          * accordingly.
 288                          */
 289                         if (other != NULL) {
 290                                 mii_phy_reset(other);
 291                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 292                         }
 293                         PHY_WRITE(sc, MII_ANAR, mm->mm_anar);
 294                         PHY_WRITE(sc, MII_BMCR, mm->mm_bmcr);
 295                         msc->ml_state = 0;
 296                         break;
 297
 298                 case IFM_100_T4:
 299                         /*
 300                          * XXX Not supported as a manual setting right now.
 301                          */
 302                         return (EINVAL);
 303                 default:
 304                         break;
 305                 }
 306                 break;
 307
 308         case MII_TICK:
 309                 /*
 310                  * If we're not currently selected, just return.
 311                  */
 312                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 313                         return (0);
 314
 315                 /*
 316                  * Is the interface even up?
 317                  */
 318                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 319                         return (0);
 320
 321                 /*
 322                  * Only used for autonegotiation.
 323                  */
 324                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 325                         break;
 326
 327                 /*
 328                  * Only retry autonegotiation every 5 seconds.
 329                  */
 330                 if (++sc->mii_ticks <= sc->mii_anegticks)
 331                         return (0);
 332
 333                 sc->mii_ticks = 0;
 334
 335                 /*
 336                  * Check to see if we have link.  If we do, we don't
 337                  * need to restart the autonegotiation process.  Read
 338                  * the BMSR twice in case it's latched.
 339                  * If we're in a 10Mbps mode, check the link of the
 340                  * 10Mbps PHY. Sometimes the Micro Linear PHY's
 341                  * linkstat bit will clear while the linkstat bit of
 342                  * the companion PHY will remain set.
 343                  */
 344                 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
 345                         reg = PHY_READ(other, MII_BMSR) |
 346                             PHY_READ(other, MII_BMSR);
 347                 } else {
 348                         reg = PHY_READ(sc, MII_BMSR) |
 349                             PHY_READ(sc, MII_BMSR);
 350                 }
 351
 352                 if (reg & BMSR_LINK) {
 353                         if (!msc->ml_linked) {
 354                                 msc->ml_linked = 1;
 355                                 mlphy_status(sc);
 356                                 break;
 357                         }
 358                         return(0);
 359                 }
 360
 361                 msc->ml_linked = 0;
 362                 mii->mii_media_active = IFM_NONE;
 363                 mii_phy_reset(sc);
 364                 msc->ml_state = ML_STATE_AUTO_SELF;
 365                 if (other != NULL) {
 366                         mii_phy_reset(other);
 367                         PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 368                 }
 369                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 370                         return(0);
 371                 break;
 372         }
 373
 374         /* Update the media status. */
 375         if (msc->ml_state == ML_STATE_AUTO_OTHER) {
 376                 int other_inst;
 377
 378                 other_inst = other->mii_inst;
 379                 other->mii_inst = sc->mii_inst;
 380                 other->mii_service(other, mii, MII_POLLSTAT);
 381                 other->mii_inst = other_inst;
 382                 sc->mii_media_active = other->mii_media_active;
 383                 sc->mii_media_status = other->mii_media_status;
 384         } else {
 385                 ukphy_status(sc);
 386         }
 387
 388         /* Callback if something changed. */
 389         mii_phy_update(sc, cmd);
 390         return (0);
 391 }
 392
 393 /*
 394  * The Micro Linear PHY comes out of reset with the 'autoneg
 395  * enable' bit set, which we don't want.
 396  */
 397 static void
 398 mlphy_reset(struct mii_softc *sc)
 399 {
 400         int                     reg;
 401
 402         mii_phy_reset(sc);
 403         reg = PHY_READ(sc, MII_BMCR);
 404         reg &= ~BMCR_AUTOEN;
 405         PHY_WRITE(sc, MII_BMCR, reg);
 406 }
 407
 408 /*
 409  * If we negotiate a 10Mbps mode, we need to check for an alternate
 410  * PHY and make sure it's enabled and set correctly.
 411  */
 412 static void
 413 mlphy_status(struct mii_softc *sc)
 414 {
 415         struct mlphy_softc      *msc = (struct mlphy_softc *)sc;
 416         struct mii_data         *mii = msc->ml_mii.mii_pdata;
 417         struct mii_softc        *other = NULL;
 418         device_t                *devlist;
 419         int                     devs, i;
 420
 421         /* See if there's another PHY on the bus with us. */
 422         device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
 423         for (i = 0; i < devs; i++) {
 424                 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
 425                         other = device_get_softc(devlist[i]);
 426                         break;
 427                 }
 428         }
 429         kfree(devlist, M_TEMP);
 430
 431         if (other == NULL)
 432                 return;
 433
 434         ukphy_status(sc);
 435
 436         if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) {
 437                 msc->ml_state = ML_STATE_AUTO_SELF;
 438                 mii_phy_reset(other);
 439                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
 440         }
 441
 442         if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) {
 443                 msc->ml_state = ML_STATE_AUTO_OTHER;
 444                 mlphy_reset(&msc->ml_mii);
 445                 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO);
 446                 mii_phy_reset(other);
 447                 mii_phy_auto(other, 1);
 448         }
 449 }