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