sys/dev/mii/sqphy.c

   1 /*      $NetBSD: sqphy.c,v 1.48 2008/11/17 03:04:27 dyoung Exp $        */
   2
   3 /*-
   4  * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
   9  * NASA Ames Research Center.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  55  */
  56
  57 /*
  58  * driver for Seeq 80220/80221, 80223, and 80225 10/100 ethernet PHYs
  59  * datasheet from www.seeq.com
  60  */
  61
  62 #include <sys/cdefs.h>
  63 __KERNEL_RCSID(0, "$NetBSD: sqphy.c,v 1.48 2008/11/17 03:04:27 dyoung Exp $");
  64
  65 #include <sys/param.h>
  66 #include <sys/systm.h>
  67 #include <sys/kernel.h>
  68 #include <sys/device.h>
  69 #include <sys/socket.h>
  70 #include <sys/errno.h>
  71
  72 #include <net/if.h>
  73 #include <net/if_media.h>
  74
  75 #include <dev/mii/mii.h>
  76 #include <dev/mii/miivar.h>
  77 #include <dev/mii/miidevs.h>
  78
  79 #include <dev/mii/sqphyreg.h>
  80
  81 static int      sqphymatch(device_t, cfdata_t, void *);
  82 static void     sqphyattach(device_t, device_t, void *);
  83
  84 CFATTACH_DECL_NEW(sqphy, sizeof(struct mii_softc),
  85     sqphymatch, sqphyattach, mii_phy_detach, mii_phy_activate);
  86
  87 static int      sqphy_service(struct mii_softc *, struct mii_data *, int);
  88 static void     sqphy_status(struct mii_softc *);
  89 static void     sqphy_84220_reset(struct mii_softc *);
  90
  91 static const struct mii_phy_funcs sqphy_funcs = {
  92         sqphy_service, sqphy_status, mii_phy_reset,
  93 };
  94
  95 static const struct mii_phy_funcs sqphy_84220_funcs = {
  96         sqphy_service, sqphy_status, sqphy_84220_reset,
  97 };
  98
  99 static const struct mii_phydesc sqphys[] = {
 100         { MII_OUI_SEEQ,                 MII_MODEL_SEEQ_80220,
 101           MII_STR_SEEQ_80220 },
 102
 103         { MII_OUI_SEEQ,                 MII_MODEL_SEEQ_80225,
 104           MII_STR_SEEQ_80225 },
 105
 106         { MII_OUI_SEEQ,                 MII_MODEL_SEEQ_84220,
 107           MII_STR_SEEQ_84220 },
 108
 109         { 0,                            0,
 110           NULL },
 111 };
 112
 113 static int
 114 sqphymatch(device_t parent, cfdata_t match, void *aux)
 115 {
 116         struct mii_attach_args *ma = aux;
 117
 118         if (mii_phy_match(ma, sqphys) != NULL)
 119                 return (10);
 120
 121         return (0);
 122 }
 123
 124 static void
 125 sqphyattach(device_t parent, device_t self, void *aux)
 126 {
 127         struct mii_softc *sc = device_private(self);
 128         struct mii_attach_args *ma = aux;
 129         struct mii_data *mii = ma->mii_data;
 130         const struct mii_phydesc *mpd;
 131
 132         mpd = mii_phy_match(ma, sqphys);
 133         aprint_naive(": Media interface\n");
 134         aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
 135
 136         sc->mii_dev = self;
 137         sc->mii_inst = mii->mii_instance;
 138         sc->mii_phy = ma->mii_phyno;
 139         sc->mii_pdata = mii;
 140         sc->mii_flags = ma->mii_flags;
 141         sc->mii_anegticks = MII_ANEGTICKS;
 142
 143         switch (MII_MODEL(ma->mii_id2)) {
 144         case MII_MODEL_SEEQ_84220:
 145                 sc->mii_funcs = &sqphy_84220_funcs;
 146                 aprint_normal_dev(self, "using Seeq 84220 isolate/reset hack\n");
 147                 break;
 148
 149         default:
 150                 sc->mii_funcs = &sqphy_funcs;
 151         }
 152
 153         PHY_RESET(sc);
 154
 155         sc->mii_capabilities =
 156             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 157         aprint_normal_dev(self, "");
 158         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 159                 aprint_error("no media present");
 160         else
 161                 mii_phy_add_media(sc);
 162         aprint_normal("\n");
 163 }
 164
 165 static int
 166 sqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 167 {
 168         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 169         int reg;
 170
 171         switch (cmd) {
 172         case MII_POLLSTAT:
 173                 /*
 174                  * If we're not polling our PHY instance, just return.
 175                  */
 176                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 177                         return (0);
 178                 break;
 179
 180         case MII_MEDIACHG:
 181                 /*
 182                  * If the media indicates a different PHY instance,
 183                  * isolate ourselves.
 184                  */
 185                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 186                         reg = PHY_READ(sc, MII_BMCR);
 187                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 188                         return (0);
 189                 }
 190
 191                 /*
 192                  * If the interface is not up, don't do anything.
 193                  */
 194                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 195                         break;
 196
 197                 mii_phy_setmedia(sc);
 198                 break;
 199
 200         case MII_TICK:
 201                 /*
 202                  * If we're not currently selected, just return.
 203                  */
 204                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 205                         return (0);
 206
 207                 if (mii_phy_tick(sc) == EJUSTRETURN)
 208                         return (0);
 209                 break;
 210
 211         case MII_DOWN:
 212                 mii_phy_down(sc);
 213                 return (0);
 214         }
 215
 216         /* Update the media status. */
 217         mii_phy_status(sc);
 218
 219         /* Callback if something changed. */
 220         mii_phy_update(sc, cmd);
 221         return (0);
 222 }
 223
 224 static void
 225 sqphy_status(struct mii_softc *sc)
 226 {
 227         struct mii_data *mii = sc->mii_pdata;
 228         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 229         int bmsr, bmcr, status;
 230
 231         mii->mii_media_status = IFM_AVALID;
 232         mii->mii_media_active = IFM_ETHER;
 233
 234         bmsr = PHY_READ(sc, MII_BMSR) |
 235             PHY_READ(sc, MII_BMSR);
 236         if (bmsr & BMSR_LINK)
 237                 mii->mii_media_status |= IFM_ACTIVE;
 238
 239         bmcr = PHY_READ(sc, MII_BMCR);
 240         if (bmcr & BMCR_ISO) {
 241                 mii->mii_media_active |= IFM_NONE;
 242                 mii->mii_media_status = 0;
 243                 return;
 244         }
 245
 246         if (bmcr & BMCR_LOOP)
 247                 mii->mii_media_active |= IFM_LOOP;
 248
 249         if (bmcr & BMCR_AUTOEN) {
 250                 if ((bmsr & BMSR_ACOMP) == 0) {
 251                         /* Erg, still trying, I guess... */
 252                         mii->mii_media_active |= IFM_NONE;
 253                         return;
 254                 }
 255                 /*
 256                  * Note: don't get fancy here -- the 80225 only
 257                  * supports the SPD_DET and DPLX_DET bits in
 258                  * the STATUS register.
 259                  */
 260                 status = PHY_READ(sc, MII_SQPHY_STATUS);
 261                 if (status & STATUS_SPD_DET)
 262                         mii->mii_media_active |= IFM_100_TX;
 263                 else
 264                         mii->mii_media_active |= IFM_10_T;
 265                 if (status & STATUS_DPLX_DET)
 266                         mii->mii_media_active |= IFM_FDX;
 267         } else
 268                 mii->mii_media_active = ife->ifm_media;
 269 }
 270
 271 static void
 272 sqphy_84220_reset(struct mii_softc *sc)
 273 {
 274         int reg;
 275
 276         mii_phy_reset(sc);
 277
 278         /*
 279          * This PHY sometimes insists on coming out of reset isolated,
 280          * even when the MDA[0-3] pins are pulled high (to indicate
 281          * PHY address 0), contrary to the device's datasheet.
 282          *
 283          * Morever, simply clearing BMCR_ISO here isn't enough; the
 284          * change won't stick until about 30mS *after* the PHY has
 285          * been reset.
 286          *
 287          * This sucks.
 288          */
 289         while ((sc->mii_inst == 0 || (sc->mii_flags & MIIF_NOISOLATE)) &&
 290             ((reg = PHY_READ(sc, MII_BMCR)) & BMCR_ISO) != 0) {
 291
 292                 delay(35000);
 293                 PHY_WRITE(sc, MII_BMCR, reg & ~BMCR_ISO);
 294                 delay(35000);
 295         }
 296 }