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 /*
  71  * driver for Level One's LXT-970 ethernet 10/100 PHY
  72  * datasheet from www.level1.com
  73  */
  74
  75 #include <sys/param.h>
  76 #include <sys/systm.h>
  77 #include <sys/kernel.h>
  78 #include <sys/socket.h>
  79 #include <sys/errno.h>
  80 #include <sys/module.h>
  81 #include <sys/bus.h>
  82
  83 #include <net/if.h>
  84 #include <net/if_media.h>
  85
  86 #include <dev/mii/mii.h>
  87 #include <dev/mii/miivar.h>
  88 #include <dev/mii/miidevs.h>
  89
  90 #include <dev/mii/lxtphyreg.h>
  91
  92 #include "miibus_if.h"
  93
  94 #if !defined(lint)
  95 static const char rcsid[] =
  96   "$FreeBSD$";
  97 #endif
  98
  99 static int lxtphy_probe         (device_t);
 100 static int lxtphy_attach        (device_t);
 101
 102 static device_method_t lxtphy_methods[] = {
 103         /* device interface */
 104         DEVMETHOD(device_probe,         lxtphy_probe),
 105         DEVMETHOD(device_attach,        lxtphy_attach),
 106         DEVMETHOD(device_detach,        mii_phy_detach),
 107         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 108         { 0, 0 }
 109 };
 110
 111 static devclass_t lxtphy_devclass;
 112
 113 static driver_t lxtphy_driver = {
 114         "lxtphy",
 115         lxtphy_methods,
 116         sizeof(struct mii_softc)
 117 };
 118
 119 DRIVER_MODULE(lxtphy, miibus, lxtphy_driver, lxtphy_devclass, 0, 0);
 120
 121 static int      lxtphy_service(struct mii_softc *, struct mii_data *, int);
 122 static void     lxtphy_status(struct mii_softc *);
 123 static void     lxtphy_set_tp(struct mii_softc *);
 124 static void     lxtphy_set_fx(struct mii_softc *);
 125
 126 static int lxtphy_probe(dev)
 127         device_t                dev;
 128 {
 129         struct mii_attach_args *ma;
 130
 131         ma = device_get_ivars(dev);
 132
 133         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxLEVEL1 &&
 134             MII_MODEL(ma->mii_id2) == MII_MODEL_xxLEVEL1_LXT970) {
 135                 device_set_desc(dev, MII_STR_xxLEVEL1_LXT970);
 136         } else
 137                 return (ENXIO);
 138
 139         return (0);
 140 }
 141
 142 static int lxtphy_attach(dev)
 143         device_t                dev;
 144 {
 145         struct mii_softc *sc;
 146         struct mii_attach_args *ma;
 147         struct mii_data *mii;
 148
 149         sc = device_get_softc(dev);
 150         ma = device_get_ivars(dev);
 151         sc->mii_dev = device_get_parent(dev);
 152         mii = device_get_softc(sc->mii_dev);
 153         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 154
 155         sc->mii_inst = mii->mii_instance;
 156         sc->mii_phy = ma->mii_phyno;
 157         sc->mii_service = lxtphy_service;
 158         sc->mii_pdata = mii;
 159         sc->mii_flags |= MIIF_NOISOLATE;
 160
 161         mii_phy_reset(sc);
 162
 163         mii->mii_instance++;
 164
 165         sc->mii_capabilities =
 166             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 167         device_printf(dev, " ");
 168
 169 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 170         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 171             BMCR_ISO);
 172         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
 173             BMCR_S100);
 174         printf("100baseFX, ");
 175         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
 176             BMCR_S100|BMCR_FDX);
 177         printf("100baseFX-FDX, ");
 178 #undef ADD
 179
 180         mii_add_media(sc);
 181         printf("\n");
 182
 183         MIIBUS_MEDIAINIT(sc->mii_dev);
 184         return(0);
 185 }
 186
 187 static int
 188 lxtphy_service(sc, mii, cmd)
 189         struct mii_softc *sc;
 190         struct mii_data *mii;
 191         int cmd;
 192 {
 193         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 194         int reg;
 195
 196         switch (cmd) {
 197         case MII_POLLSTAT:
 198                 /*
 199                  * If we're not polling our PHY instance, just return.
 200                  */
 201                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 202                         return (0);
 203                 break;
 204
 205         case MII_MEDIACHG:
 206                 /*
 207                  * If the media indicates a different PHY instance,
 208                  * isolate ourselves.
 209                  */
 210                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 211                         reg = PHY_READ(sc, MII_BMCR);
 212                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 213                         return (0);
 214                 }
 215
 216                 /*
 217                  * If the interface is not up, don't do anything.
 218                  */
 219                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 220                         break;
 221
 222                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 223                 case IFM_AUTO:
 224                         /*
 225                          * If we're already in auto mode, just return.
 226                          */
 227                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 228                                 return (0);
 229
 230                         lxtphy_set_tp(sc);
 231
 232                         (void) mii_phy_auto(sc);
 233                         break;
 234                 case IFM_100_T4:
 235                         /*
 236                          * XXX Not supported as a manual setting right now.
 237                          */
 238                         return (EINVAL);
 239
 240                 case IFM_100_FX:
 241                         lxtphy_set_fx(sc);
 242
 243                 default:
 244                         /*
 245                          * BMCR data is stored in the ifmedia entry.
 246                          */
 247                         PHY_WRITE(sc, MII_ANAR,
 248                             mii_anar(ife->ifm_media));
 249                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 250                 }
 251                 break;
 252
 253         case MII_TICK:
 254                 /*
 255                  * If we're not currently selected, just return.
 256                  */
 257                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 258                         return (0);
 259                 if (mii_phy_tick(sc) == EJUSTRETURN)
 260                         return (0);
 261                 break;
 262         }
 263
 264         /* Update the media status. */
 265         lxtphy_status(sc);
 266
 267         /* Callback if something changed. */
 268         mii_phy_update(sc, cmd);
 269         return (0);
 270 }
 271
 272 static void
 273 lxtphy_status(sc)
 274         struct mii_softc *sc;
 275 {
 276         struct mii_data *mii = sc->mii_pdata;
 277         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 278         int bmcr, bmsr, csr;
 279
 280         mii->mii_media_status = IFM_AVALID;
 281         mii->mii_media_active = IFM_ETHER;
 282
 283         /*
 284          * Get link status from the CSR; we need to read the CSR
 285          * for media type anyhow, and the link status in the CSR
 286          * doens't latch, so fewer register reads are required.
 287          */
 288         csr = PHY_READ(sc, MII_LXTPHY_CSR);
 289         if (csr & CSR_LINK)
 290                 mii->mii_media_status |= IFM_ACTIVE;
 291
 292         bmcr = PHY_READ(sc, MII_BMCR);
 293         if (bmcr & BMCR_ISO) {
 294                 mii->mii_media_active |= IFM_NONE;
 295                 mii->mii_media_status = 0;
 296                 return;
 297         }
 298
 299         if (bmcr & BMCR_LOOP)
 300                 mii->mii_media_active |= IFM_LOOP;
 301
 302         if (bmcr & BMCR_AUTOEN) {
 303                 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 304                 if ((bmsr & BMSR_ACOMP) == 0) {
 305                         /* Erg, still trying, I guess... */
 306                         mii->mii_media_active |= IFM_NONE;
 307                         return;
 308                 }
 309                 if (csr & CSR_SPEED)
 310                         mii->mii_media_active |= IFM_100_TX;
 311                 else
 312                         mii->mii_media_active |= IFM_10_T;
 313                 if (csr & CSR_DUPLEX)
 314                         mii->mii_media_active |= IFM_FDX;
 315         } else
 316                 mii->mii_media_active = ife->ifm_media;
 317 }
 318
 319 static void
 320 lxtphy_set_tp(sc)
 321         struct mii_softc *sc;
 322 {
 323         int cfg;
 324
 325         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 326         cfg &= ~CONFIG_100BASEFX;
 327         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 328 }
 329
 330 static void
 331 lxtphy_set_fx(sc)
 332         struct mii_softc *sc;
 333 {
 334         int cfg;
 335
 336         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 337         cfg |= CONFIG_100BASEFX;
 338         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 339 }
 340