sys/dev/mii/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
  41 /*-
  42  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
  43  *
  44  * Redistribution and use in source and binary forms, with or without
  45  * modification, are permitted provided that the following conditions
  46  * are met:
  47  * 1. Redistributions of source code must retain the above copyright
  48  *    notice, this list of conditions and the following disclaimer.
  49  * 2. Redistributions in binary form must reproduce the above copyright
  50  *    notice, this list of conditions and the following disclaimer in the
  51  *    documentation and/or other materials provided with the distribution.
  52  * 3. All advertising materials mentioning features or use of this software
  53  *    must display the following acknowledgement:
  54  *      This product includes software developed by Manuel Bouyer.
  55  * 4. The name of the author may not be used to endorse or promote products
  56  *    derived from this software without specific prior written permission.
  57  *
  58  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  59  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  60  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  61  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  62  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  63  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  64  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  65  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  66  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  67  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  68  */
  69
  70 #include <sys/cdefs.h>
  71 __FBSDID("$FreeBSD$");
  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 "miidevs.h"
  92
  93 #include <dev/mii/lxtphyreg.h>
  94
  95 #include "miibus_if.h"
  96
  97 static int lxtphy_probe(device_t);
  98 static int lxtphy_attach(device_t);
  99
 100 static device_method_t lxtphy_methods[] = {
 101         /* device interface */
 102         DEVMETHOD(device_probe,         lxtphy_probe),
 103         DEVMETHOD(device_attach,        lxtphy_attach),
 104         DEVMETHOD(device_detach,        mii_phy_detach),
 105         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 106         { 0, 0 }
 107 };
 108
 109 static devclass_t lxtphy_devclass;
 110
 111 static driver_t lxtphy_driver = {
 112         "lxtphy",
 113         lxtphy_methods,
 114         sizeof(struct mii_softc)
 115 };
 116
 117 DRIVER_MODULE(lxtphy, miibus, lxtphy_driver, lxtphy_devclass, 0, 0);
 118
 119 static int      lxtphy_service(struct mii_softc *, struct mii_data *, int);
 120 static void     lxtphy_status(struct mii_softc *);
 121 static void     lxtphy_set_tp(struct mii_softc *);
 122 static void     lxtphy_set_fx(struct mii_softc *);
 123
 124 static int
 125 lxtphy_probe(device_t dev)
 126 {
 127         struct mii_attach_args *ma;
 128
 129         ma = device_get_ivars(dev);
 130
 131         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxLEVEL1 &&
 132             MII_MODEL(ma->mii_id2) == MII_MODEL_xxLEVEL1_LXT970) {
 133                 device_set_desc(dev, MII_STR_xxLEVEL1_LXT970);
 134         } else
 135                 return (ENXIO);
 136
 137         return (0);
 138 }
 139
 140 static int
 141 lxtphy_attach(device_t dev)
 142 {
 143         struct mii_softc *sc;
 144         struct mii_attach_args *ma;
 145         struct mii_data *mii;
 146
 147         sc = device_get_softc(dev);
 148         ma = device_get_ivars(dev);
 149         sc->mii_dev = device_get_parent(dev);
 150         mii = device_get_softc(sc->mii_dev);
 151         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 152
 153         sc->mii_inst = mii->mii_instance;
 154         sc->mii_phy = ma->mii_phyno;
 155         sc->mii_service = lxtphy_service;
 156         sc->mii_pdata = mii;
 157         sc->mii_flags |= MIIF_NOISOLATE;
 158
 159         mii_phy_reset(sc);
 160
 161         mii->mii_instance++;
 162
 163         sc->mii_capabilities =
 164             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 165         device_printf(dev, " ");
 166
 167 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 168         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 169             BMCR_ISO);
 170         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
 171             BMCR_S100);
 172         printf("100baseFX, ");
 173         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
 174             BMCR_S100|BMCR_FDX);
 175         printf("100baseFX-FDX, ");
 176 #undef ADD
 177
 178         mii_add_media(sc);
 179         printf("\n");
 180
 181         MIIBUS_MEDIAINIT(sc->mii_dev);
 182         return(0);
 183 }
 184
 185 static int
 186 lxtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 187 {
 188         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 189         int reg;
 190
 191         switch (cmd) {
 192         case MII_POLLSTAT:
 193                 /*
 194                  * If we're not polling our PHY instance, just return.
 195                  */
 196                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 197                         return (0);
 198                 break;
 199
 200         case MII_MEDIACHG:
 201                 /*
 202                  * If the media indicates a different PHY instance,
 203                  * isolate ourselves.
 204                  */
 205                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 206                         reg = PHY_READ(sc, MII_BMCR);
 207                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 208                         return (0);
 209                 }
 210
 211                 /*
 212                  * If the interface is not up, don't do anything.
 213                  */
 214                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 215                         break;
 216
 217                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 218                 case IFM_AUTO:
 219                         /*
 220                          * If we're already in auto mode, just return.
 221                          */
 222                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 223                                 return (0);
 224
 225                         lxtphy_set_tp(sc);
 226
 227                         (void) mii_phy_auto(sc);
 228                         break;
 229                 case IFM_100_T4:
 230                         /*
 231                          * XXX Not supported as a manual setting right now.
 232                          */
 233                         return (EINVAL);
 234
 235                 case IFM_100_FX:
 236                         lxtphy_set_fx(sc);
 237                         /* XXX: fall though intentional ?? */
 238                 default:
 239                         /*
 240                          * BMCR data is stored in the ifmedia entry.
 241                          */
 242                         PHY_WRITE(sc, MII_ANAR,
 243                             mii_anar(ife->ifm_media));
 244                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 245                 }
 246                 break;
 247
 248         case MII_TICK:
 249                 /*
 250                  * If we're not currently selected, just return.
 251                  */
 252                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 253                         return (0);
 254                 if (mii_phy_tick(sc) == EJUSTRETURN)
 255                         return (0);
 256                 break;
 257         }
 258
 259         /* Update the media status. */
 260         lxtphy_status(sc);
 261
 262         /* Callback if something changed. */
 263         mii_phy_update(sc, cmd);
 264         return (0);
 265 }
 266
 267 static void
 268 lxtphy_status(struct mii_softc *sc)
 269 {
 270         struct mii_data *mii = sc->mii_pdata;
 271         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 272         int bmcr, bmsr, csr;
 273
 274         mii->mii_media_status = IFM_AVALID;
 275         mii->mii_media_active = IFM_ETHER;
 276
 277         /*
 278          * Get link status from the CSR; we need to read the CSR
 279          * for media type anyhow, and the link status in the CSR
 280          * doens't latch, so fewer register reads are required.
 281          */
 282         csr = PHY_READ(sc, MII_LXTPHY_CSR);
 283         if (csr & CSR_LINK)
 284                 mii->mii_media_status |= IFM_ACTIVE;
 285
 286         bmcr = PHY_READ(sc, MII_BMCR);
 287         if (bmcr & BMCR_ISO) {
 288                 mii->mii_media_active |= IFM_NONE;
 289                 mii->mii_media_status = 0;
 290                 return;
 291         }
 292
 293         if (bmcr & BMCR_LOOP)
 294                 mii->mii_media_active |= IFM_LOOP;
 295
 296         if (bmcr & BMCR_AUTOEN) {
 297                 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 298                 if ((bmsr & BMSR_ACOMP) == 0) {
 299                         /* Erg, still trying, I guess... */
 300                         mii->mii_media_active |= IFM_NONE;
 301                         return;
 302                 }
 303                 if (csr & CSR_SPEED)
 304                         mii->mii_media_active |= IFM_100_TX;
 305                 else
 306                         mii->mii_media_active |= IFM_10_T;
 307                 if (csr & CSR_DUPLEX)
 308                         mii->mii_media_active |= IFM_FDX;
 309         } else
 310                 mii->mii_media_active = ife->ifm_media;
 311 }
 312
 313 static void
 314 lxtphy_set_tp(struct mii_softc *sc)
 315 {
 316         int cfg;
 317
 318         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 319         cfg &= ~CONFIG_100BASEFX;
 320         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 321 }
 322
 323 static void
 324 lxtphy_set_fx(struct mii_softc *sc)
 325 {
 326         int cfg;
 327
 328         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 329         cfg |= CONFIG_100BASEFX;
 330         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 331 }
 332