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 const struct mii_phydesc lxtphys[] = {
 125         MII_PHY_DESC(xxLEVEL1, LXT970),
 126         MII_PHY_END
 127 };
 128
 129 static int
 130 lxtphy_probe(device_t dev)
 131 {
 132
 133         return (mii_phy_dev_probe(dev, lxtphys, BUS_PROBE_DEFAULT));
 134 }
 135
 136 static int
 137 lxtphy_attach(device_t dev)
 138 {
 139         struct mii_softc *sc;
 140         struct mii_attach_args *ma;
 141         struct mii_data *mii;
 142         const char *nic;
 143
 144         sc = device_get_softc(dev);
 145         ma = device_get_ivars(dev);
 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 = lxtphy_service;
 153         sc->mii_pdata = mii;
 154
 155         mii->mii_instance++;
 156
 157         mii_phy_reset(sc);
 158
 159         sc->mii_capabilities =
 160             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 161         device_printf(dev, " ");
 162
 163         /*
 164          * On Apple BMAC controllers, we end up in a weird state
 165          * of partially-completed autonegotiation on boot. So
 166          * force autonegotation to try again.
 167          */
 168         nic = device_get_name(device_get_parent(sc->mii_dev));
 169         if (strcmp(nic, "bm") == 0)
 170                 sc->mii_flags |= MIIF_FORCEANEG | MIIF_NOISOLATE;
 171
 172 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 173         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
 174             MII_MEDIA_100_TX);
 175         printf("100baseFX, ");
 176         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
 177             MII_MEDIA_100_TX_FDX);
 178         printf("100baseFX-FDX, ");
 179 #undef ADD
 180
 181         mii_phy_add_media(sc);
 182         printf("\n");
 183
 184         MIIBUS_MEDIAINIT(sc->mii_dev);
 185         return (0);
 186 }
 187
 188 static int
 189 lxtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 190 {
 191         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 192         int reg;
 193
 194         switch (cmd) {
 195         case MII_POLLSTAT:
 196                 /*
 197                  * If we're not polling our PHY instance, just return.
 198                  */
 199                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 200                         return (0);
 201                 break;
 202
 203         case MII_MEDIACHG:
 204                 /*
 205                  * If the media indicates a different PHY instance,
 206                  * isolate ourselves.
 207                  */
 208                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 209                         reg = PHY_READ(sc, MII_BMCR);
 210                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 211                         return (0);
 212                 }
 213
 214                 /*
 215                  * If the interface is not up, don't do anything.
 216                  */
 217                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 218                         break;
 219
 220                 if (IFM_SUBTYPE(ife->ifm_media) == IFM_100_FX)
 221                         lxtphy_set_fx(sc);
 222                 else
 223                         lxtphy_set_tp(sc);
 224
 225                 mii_phy_setmedia(sc);
 226                 break;
 227
 228         case MII_TICK:
 229                 /*
 230                  * If we're not currently selected, just return.
 231                  */
 232                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 233                         return (0);
 234                 if (mii_phy_tick(sc) == EJUSTRETURN)
 235                         return (0);
 236                 break;
 237         }
 238
 239         /* Update the media status. */
 240         lxtphy_status(sc);
 241
 242         /* Callback if something changed. */
 243         mii_phy_update(sc, cmd);
 244         return (0);
 245 }
 246
 247 static void
 248 lxtphy_status(struct mii_softc *sc)
 249 {
 250         struct mii_data *mii = sc->mii_pdata;
 251         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 252         int bmcr, bmsr, csr;
 253
 254         mii->mii_media_status = IFM_AVALID;
 255         mii->mii_media_active = IFM_ETHER;
 256
 257         /*
 258          * Get link status from the CSR; we need to read the CSR
 259          * for media type anyhow, and the link status in the CSR
 260          * doens't latch, so fewer register reads are required.
 261          */
 262         csr = PHY_READ(sc, MII_LXTPHY_CSR);
 263         if (csr & CSR_LINK)
 264                 mii->mii_media_status |= IFM_ACTIVE;
 265
 266         bmcr = PHY_READ(sc, MII_BMCR);
 267         if (bmcr & BMCR_ISO) {
 268                 mii->mii_media_active |= IFM_NONE;
 269                 mii->mii_media_status = 0;
 270                 return;
 271         }
 272
 273         if (bmcr & BMCR_LOOP)
 274                 mii->mii_media_active |= IFM_LOOP;
 275
 276         if (bmcr & BMCR_AUTOEN) {
 277                 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 278                 if ((bmsr & BMSR_ACOMP) == 0) {
 279                         /* Erg, still trying, I guess... */
 280                         mii->mii_media_active |= IFM_NONE;
 281                         return;
 282                 }
 283                 if (csr & CSR_SPEED)
 284                         mii->mii_media_active |= IFM_100_TX;
 285                 else
 286                         mii->mii_media_active |= IFM_10_T;
 287                 if (csr & CSR_DUPLEX)
 288                         mii->mii_media_active |= IFM_FDX;
 289         } else
 290                 mii->mii_media_active = ife->ifm_media;
 291 }
 292
 293 static void
 294 lxtphy_set_tp(struct mii_softc *sc)
 295 {
 296         int cfg;
 297
 298         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 299         cfg &= ~CONFIG_100BASEFX;
 300         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 301 }
 302
 303 static void
 304 lxtphy_set_fx(struct mii_softc *sc)
 305 {
 306         int cfg;
 307
 308         cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
 309         cfg |= CONFIG_100BASEFX;
 310         PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
 311 }