sys/dev/netif/mii_layer/lxtphy.c

   1 /*      OpenBSD: lxtphy.c,v 1.5 2000/08/26 20:04:17 nate Exp    */
   2 /*      NetBSD: lxtphy.c,v 1.19 2000/02/02 23:34:57 thorpej Exp         */
   3
   4 /*-
   5  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to The NetBSD Foundation
   9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
  10  * NASA Ames Research Center.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by the NetBSD
  23  *      Foundation, Inc. and its contributors.
  24  * 4. Neither the name of The NetBSD Foundation nor the names of its
  25  *    contributors may be used to endorse or promote products derived
  26  *    from this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * $FreeBSD: src/sys/dev/mii/lxtphy.c,v 1.1.2.1 2001/06/08 19:58:33 semenu Exp $
  41  * $DragonFly: src/sys/dev/netif/mii_layer/lxtphy.c,v 1.2 2003/06/17 04:28:28 dillon Exp $
  42  */
  43
  44 /*
  45  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
  46  *
  47  * Redistribution and use in source and binary forms, with or without
  48  * modification, are permitted provided that the following conditions
  49  * are met:
  50  * 1. Redistributions of source code must retain the above copyright
  51  *    notice, this list of conditions and the following disclaimer.
  52  * 2. Redistributions in binary form must reproduce the above copyright
  53  *    notice, this list of conditions and the following disclaimer in the
  54  *    documentation and/or other materials provided with the distribution.
  55  * 3. All advertising materials mentioning features or use of this software
  56  *    must display the following acknowledgement:
  57  *      This product includes software developed by Manuel Bouyer.
  58  * 4. The name of the author may not be used to endorse or promote products
  59  *    derived from this software without specific prior written permission.
  60  *
  61  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  62  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  63  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  64  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  65  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  66  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  67  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  68  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  69  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  70  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  71  */
  72
  73 /*
  74  * driver for Level One's LXT-970 ethernet 10/100 PHY
  75  * datasheet from www.level1.com
  76  */
  77
  78 #include <sys/param.h>
  79 #include <sys/systm.h>
  80 #include <sys/kernel.h>
  81 #include <sys/socket.h>
  82 #include <sys/errno.h>
  83 #include <sys/module.h>
  84 #include <sys/bus.h>
  85
  86 #include <net/if.h>
  87 #include <net/if_media.h>
  88
  89 #include <dev/mii/mii.h>
  90 #include <dev/mii/miivar.h>
  91 #include <dev/mii/miidevs.h>
  92
  93 #include <dev/mii/lxtphyreg.h>
  94
  95 #include "miibus_if.h"
  96
  97 static int lxtphy_probe         __P((device_t));
  98 static int lxtphy_attach        __P((device_t));
  99 static int lxtphy_detach        __P((device_t));
 100
 101 static device_method_t lxtphy_methods[] = {
 102         /* device interface */
 103         DEVMETHOD(device_probe,         lxtphy_probe),
 104         DEVMETHOD(device_attach,        lxtphy_attach),
 105         DEVMETHOD(device_detach,        lxtphy_detach),
 106         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 107         { 0, 0 }
 108 };
 109
 110 static devclass_t lxtphy_devclass;
 111
 112 static driver_t lxtphy_driver = {
 113         "lxtphy",
 114         lxtphy_methods,
 115         sizeof(struct mii_softc)
 116 };
 117
 118 DRIVER_MODULE(lxtphy, miibus, lxtphy_driver, lxtphy_devclass, 0, 0);
 119
 120 static int      lxtphy_service __P((struct mii_softc *, struct mii_data *, int));
 121 static void     lxtphy_status __P((struct mii_softc *));
 122 static void     lxtphy_set_tp __P((struct mii_softc *));
 123 static void     lxtphy_set_fx __P((struct mii_softc *));
 124
 125 static int lxtphy_probe(dev)
 126         device_t                dev;
 127 {
 128         struct mii_attach_args *ma;
 129
 130         ma = device_get_ivars(dev);
 131
 132         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxLEVEL1 &&
 133             MII_MODEL(ma->mii_id2) == MII_MODEL_xxLEVEL1_LXT970) {
 134                 device_set_desc(dev, MII_STR_xxLEVEL1_LXT970);
 135         } else
 136                 return (ENXIO);
 137
 138         return (0);
 139 }
 140
 141 static int lxtphy_attach(dev)
 142         device_t                dev;
 143 {
 144         struct mii_softc *sc;
 145         struct mii_attach_args *ma;
 146         struct mii_data *mii;
 147
 148         sc = device_get_softc(dev);
 149         ma = device_get_ivars(dev);
 150         sc->mii_dev = device_get_parent(dev);
 151         mii = device_get_softc(sc->mii_dev);
 152         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 153
 154         sc->mii_inst = mii->mii_instance;
 155         sc->mii_phy = ma->mii_phyno;
 156         sc->mii_service = lxtphy_service;
 157         sc->mii_pdata = mii;
 158         sc->mii_flags |= MIIF_NOISOLATE;
 159
 160         mii_phy_reset(sc);
 161
 162         mii->mii_instance++;
 163
 164         sc->mii_capabilities =
 165             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 166         device_printf(dev, " ");
 167
 168 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 169         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 170             BMCR_ISO);
 171         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
 172             BMCR_S100);
 173         printf("100baseFX, ");
 174         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
 175             BMCR_S100|BMCR_FDX);
 176         printf("100baseFX-FDX, ");
 177 #undef ADD
 178
 179         if (sc->mii_capabilities & BMSR_MEDIAMASK)
 180                 mii_add_media(mii, sc->mii_capabilities,
 181                     sc->mii_inst);
 182         printf("\n");
 183
 184         MIIBUS_MEDIAINIT(sc->mii_dev);
 185         return(0);
 186 }
 187
 188
 189 static int lxtphy_detach(dev)
 190         device_t                dev;
 191 {
 192         struct mii_softc *sc;
 193         struct mii_data *mii;
 194
 195         sc = device_get_softc(dev);
 196         mii = device_get_softc(device_get_parent(dev));
 197         sc->mii_dev = NULL;
 198         LIST_REMOVE(sc, mii_list);
 199
 200         return(0);
 201 }
 202
 203 static int
 204 lxtphy_service(sc, mii, cmd)
 205         struct mii_softc *sc;
 206         struct mii_data *mii;
 207         int cmd;
 208 {
 209         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 210         int reg;
 211
 212         switch (cmd) {
 213         case MII_POLLSTAT:
 214                 /*
 215                  * If we're not polling our PHY instance, just return.
 216                  */
 217                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 218                         return (0);
 219                 break;
 220
 221         case MII_MEDIACHG:
 222                 /*
 223                  * If the media indicates a different PHY instance,
 224                  * isolate ourselves.
 225                  */
 226                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 227                         reg = PHY_READ(sc, MII_BMCR);
 228                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 229                         return (0);
 230                 }
 231
 232                 /*
 233                  * If the interface is not up, don't do anything.
 234                  */
 235                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 236                         break;
 237
 238                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 239                 case IFM_AUTO:
 240                         /*
 241                          * If we're already in auto mode, just return.
 242                          */
 243                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 244                                 return (0);
 245
 246                         lxtphy_set_tp(sc);
 247
 248                         (void) mii_phy_auto(sc, 1);
 249                         break;
 250                 case IFM_100_T4:
 251                         /*
 252                          * XXX Not supported as a manual setting right now.
 253                          */
 254                         return (EINVAL);
 255
 256                 case IFM_100_FX:
 257                         lxtphy_set_fx(sc);
 258
 259                 default:
 260                         /*
 261                          * BMCR data is stored in the ifmedia entry.
 262                          */
 263                         PHY_WRITE(sc, MII_ANAR,
 264                             mii_anar(ife->ifm_media));
 265                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 266                 }
 267                 break;
 268
 269         case MII_TICK:
 270                 /*
 271                  * If we're not currently selected, just return.
 272                  */
 273                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 274                         return (0);
 275
 276                 /*
 277                  * Only used for autonegotiation.
 278                  */
 279                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 280                         return (0);
 281
 282                 /*
 283                  * Is the interface even up?
 284                  */
 285                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 286                         return (0);
 287
 288                 /*
 289                  * Check to see if we have link.  If we do, we don't
 290                  * need to restart the autonegotiation process.  Read
 291                  * the BMSR twice in case it's latched.
 292                  */
 293                 reg = PHY_READ(sc, MII_BMSR) |
 294                     PHY_READ(sc, MII_BMSR);
 295                 if (reg & BMSR_LINK)
 296                         return (0);
 297
 298                 /*
 299                  * Only retry autonegotiation every 5 seconds.
 300                  */
 301                 if (++sc->mii_ticks != 5)
 302                         return (0);
 303
 304                 sc->mii_ticks = 0;
 305                 mii_phy_reset(sc);
 306                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 307                         return (0);
 308                 break;
 309         }
 310
 311         /* Update the media status. */
 312         lxtphy_status(sc);
 313
 314         /* Callback if something changed. */
 315         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 316                 MIIBUS_STATCHG(sc->mii_dev);
 317                 sc->mii_active = mii->mii_media_active;
 318         }
 319         return (0);
 320 }
 321
 322 static void
 323 lxtphy_status(sc)
 324         struct mii_softc *sc;
 325 {
 326         struct mii_data *mii = sc->mii_pdata;
 327         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 328         int bmcr, bmsr, csr;
 329
 330         mii->mii_media_status = IFM_AVALID;
 331         mii->mii_media_active = IFM_ETHER;
 332
 333         /*
 334          * Get link status from the CSR; we need to read the CSR
 335          * for media type anyhow, and the link status in the CSR
 336          * doens't latch, so fewer register reads are required.
 337          */
 338         csr = PHY_READ(sc, MII_LXTPHY_CSR);
 339         if (csr & CSR_LINK)
 340                 mii->mii_media_status |= IFM_ACTIVE;
 341
 342         bmcr = PHY_READ(sc, MII_BMCR);
 343         if (bmcr & BMCR_ISO) {
 344                 mii->mii_media_active |= IFM_NONE;
 345                 mii->mii_media_status = 0;
 346                 return;
 347         }
 348
 349         if (bmcr & BMCR_LOOP)
 350                 mii->mii_media_active |= IFM_LOOP;
 351
 352         if (bmcr & BMCR_AUTOEN) {
 353                 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 354                 if ((bmsr & BMSR_ACOMP) == 0) {
 355                         /* Erg, still trying, I guess... */
 356                         mii->mii_media_active |= IFM_NONE;
 357                         return;
 358                 }
 359                 if (csr & CSR_SPEED)
 360                         mii->mii_media_active |= IFM_100_TX;
 361                 else
 362                         mii->mii_media_active |= IFM_10_T;
 363                 if (csr & CSR_DUPLEX)
 364                         mii->mii_media_active |= IFM_FDX;
 365         } else
 366                 mii->mii_media_active = ife->ifm_media;
 367 }
 368
 369 static void
 370 lxtphy_set_tp(sc)
 371         struct mii_softc *sc;
 372 {
 373         int cfg;
 374
 375         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 376         cfg &= ~CONFIG_100BASEFX;
 377         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 378 }
 379
 380 static void
 381 lxtphy_set_fx(sc)
 382         struct mii_softc *sc;
 383 {
 384         int cfg;
 385
 386         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 387         cfg |= CONFIG_100BASEFX;
 388         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 389 }
 390