sys/dev/netif/mii_layer/qsphy.c

   1 /*      $OpenBSD: qsphy.c,v 1.13 2005/02/19 06:00:04 brad Exp $ */
   2 /*      NetBSD: qsphy.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  * $FreeBSD: src/sys/dev/mii/qsphy.c,v 1.1.2.2 2002/10/21 21:21:42 semenu Exp $
  41  */
  42
  43 /*
  44  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
  45  *
  46  * Redistribution and use in source and binary forms, with or without
  47  * modification, are permitted provided that the following conditions
  48  * are met:
  49  * 1. Redistributions of source code must retain the above copyright
  50  *    notice, this list of conditions and the following disclaimer.
  51  * 2. Redistributions in binary form must reproduce the above copyright
  52  *    notice, this list of conditions and the following disclaimer in the
  53  *    documentation and/or other materials provided with the distribution.
  54  * 3. All advertising materials mentioning features or use of this software
  55  *    must display the following acknowledgement:
  56  *      This product includes software developed by Manuel Bouyer.
  57  * 4. The name of the author may not be used to endorse or promote products
  58  *    derived from this software without specific prior written permission.
  59  *
  60  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  61  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  62  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  63  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  64  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  65  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  66  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  67  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  68  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  69  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  70  */
  71
  72 /*
  73  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
  74  * datasheet from www.qualitysemi.com
  75  */
  76
  77 #include <sys/param.h>
  78 #include <sys/systm.h>
  79 #include <sys/kernel.h>
  80 #include <sys/socket.h>
  81 #include <sys/errno.h>
  82 #include <sys/module.h>
  83 #include <sys/bus.h>
  84
  85 #include <net/if.h>
  86 #include <net/if_var.h>
  87 #include <net/if_media.h>
  88
  89 #include "mii.h"
  90 #include "miivar.h"
  91 #include "miidevs.h"
  92
  93 #include "qsphyreg.h"
  94
  95 #include "miibus_if.h"
  96
  97 static int qsphy_probe          (device_t);
  98 static int qsphy_attach         (device_t);
  99
 100 static device_method_t qsphy_methods[] = {
 101         /* device interface */
 102         DEVMETHOD(device_probe,         qsphy_probe),
 103         DEVMETHOD(device_attach,        qsphy_attach),
 104         DEVMETHOD(device_detach,        ukphy_detach),
 105         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 106         DEVMETHOD_END
 107 };
 108
 109 static const struct mii_phydesc qsphys[] = {
 110         MII_PHYDESC(QUALSEMI,   QS6612),
 111         MII_PHYDESC_NULL
 112 };
 113
 114 static devclass_t qsphy_devclass;
 115
 116 static driver_t qsphy_driver = {
 117         "qsphy",
 118         qsphy_methods,
 119         sizeof(struct mii_softc)
 120 };
 121
 122 DRIVER_MODULE(qsphy, miibus, qsphy_driver, qsphy_devclass, NULL, NULL);
 123
 124 static int      qsphy_service(struct mii_softc *, struct mii_data *, int);
 125 static void     qsphy_reset(struct mii_softc *);
 126 static void     qsphy_status(struct mii_softc *);
 127
 128 static int
 129 qsphy_probe(device_t dev)
 130 {
 131         struct mii_attach_args *ma = device_get_ivars(dev);
 132         const struct mii_phydesc *mpd;
 133
 134         mpd = mii_phy_match(ma, qsphys);
 135         if (mpd != NULL) {
 136                 device_set_desc(dev, mpd->mpd_name);
 137                 return (0);
 138         }
 139         return (ENXIO);
 140 }
 141
 142 static int
 143 qsphy_attach(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         mii_softc_init(sc, ma);
 152         sc->mii_dev = device_get_parent(dev);
 153         mii = device_get_softc(sc->mii_dev);
 154         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 155
 156         sc->mii_inst = mii->mii_instance;
 157         sc->mii_service = qsphy_service;
 158         sc->mii_reset = qsphy_reset;
 159         sc->mii_pdata = mii;
 160         sc->mii_flags |= MIIF_NOISOLATE;
 161
 162         qsphy_reset(sc);
 163
 164         mii->mii_instance++;
 165
 166         sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 167         device_printf(dev, " ");
 168         if (sc->mii_capabilities & BMSR_MEDIAMASK)
 169                 mii_phy_add_media(sc);
 170         else
 171                 kprintf("no media present");
 172         kprintf("\n");
 173
 174         MIIBUS_MEDIAINIT(sc->mii_dev);
 175         return (0);
 176 }
 177
 178 static int
 179 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 180 {
 181         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 182         int reg;
 183
 184         /*
 185          * If we're not selected, then do nothing, just isolate, if
 186          * changing media.
 187          */
 188         if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 189                 if (cmd == MII_MEDIACHG) {
 190                         reg = PHY_READ(sc, MII_BMCR);
 191                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 192                 }
 193
 194                 return (0);
 195         }
 196
 197         switch (cmd) {
 198         case MII_POLLSTAT:
 199                 break;
 200
 201         case MII_MEDIACHG:
 202                 /*
 203                  * If the interface is not up, don't do anything.
 204                  */
 205                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 206                         break;
 207
 208                 mii_phy_set_media(sc);
 209                 break;
 210
 211         case MII_TICK:
 212                 /*
 213                  * Is the interface even up?
 214                  */
 215                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 216                         return (0);
 217
 218                 /*
 219                  * Only used for autonegotiation.
 220                  */
 221                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 222                         break;
 223
 224                 /*
 225                  * This PHY's autonegotiation doesn't need to be kicked.
 226                  */
 227                 break;
 228         }
 229
 230         /* Update the media status. */
 231         qsphy_status(sc);
 232
 233         /* Callback if something changed. */
 234         mii_phy_update(sc, cmd);
 235         return (0);
 236 }
 237
 238 static void
 239 qsphy_status(struct mii_softc *sc)
 240 {
 241         struct mii_data *mii = sc->mii_pdata;
 242         int bmsr, bmcr, pctl;
 243
 244         mii->mii_media_status = IFM_AVALID;
 245         mii->mii_media_active = IFM_ETHER;
 246
 247         bmsr = PHY_READ(sc, MII_BMSR) |
 248             PHY_READ(sc, MII_BMSR);
 249         if (bmsr & BMSR_LINK)
 250                 mii->mii_media_status |= IFM_ACTIVE;
 251
 252         bmcr = PHY_READ(sc, MII_BMCR);
 253         if (bmcr & BMCR_ISO) {
 254                 mii->mii_media_active |= IFM_NONE;
 255                 mii->mii_media_status = 0;
 256                 return;
 257         }
 258
 259         if (bmcr & BMCR_LOOP)
 260                 mii->mii_media_active |= IFM_LOOP;
 261
 262         if (bmcr & BMCR_AUTOEN) {
 263                 if ((bmsr & BMSR_ACOMP) == 0) {
 264                         /* Erg, still trying, I guess... */
 265                         mii->mii_media_active |= IFM_NONE;
 266                         return;
 267                 }
 268
 269                 pctl = PHY_READ(sc, MII_QSPHY_PCTL);
 270                 switch (pctl & PCTL_OPMASK) {
 271                 case PCTL_10_T:
 272                         mii->mii_media_active |= IFM_10_T;
 273                         break;
 274                 case PCTL_10_T_FDX:
 275                         mii->mii_media_active |= IFM_10_T|IFM_FDX;
 276                         break;
 277                 case PCTL_100_TX:
 278                         mii->mii_media_active |= IFM_100_TX;
 279                         break;
 280                 case PCTL_100_TX_FDX:
 281                         mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 282                         break;
 283                 case PCTL_100_T4:
 284                         mii->mii_media_active |= IFM_100_T4;
 285                         break;
 286                 case PCTL_AN:
 287                         mii->mii_media_active |= IFM_NONE;
 288                         break;
 289                 default:
 290                         /* Erg... this shouldn't happen. */
 291                         mii->mii_media_active |= IFM_NONE;
 292                         break;
 293                 }
 294         } else {
 295                 mii->mii_media_active = mii->mii_media.ifm_cur->ifm_media;
 296         }
 297 }
 298
 299 static void
 300 qsphy_reset(struct mii_softc *sc)
 301 {
 302         mii_phy_reset(sc);
 303         PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
 304 }