sys/dev/netif/mii_layer/qsphy.c

   1 /*      OpenBSD: qsphy.c,v 1.6 2000/08/26 20:04:18 nate 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  * $DragonFly: src/sys/dev/netif/mii_layer/qsphy.c,v 1.5 2004/09/18 19:32:59 dillon Exp $
  42  */
  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 Quality Semiconductor's QS6612 ethernet 10/100 PHY
  75  * datasheet from www.qualitysemi.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 "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 static int qsphy_detach         (device_t);
 100
 101 static device_method_t qsphy_methods[] = {
 102         /* device interface */
 103         DEVMETHOD(device_probe,         qsphy_probe),
 104         DEVMETHOD(device_attach,        qsphy_attach),
 105         DEVMETHOD(device_detach,        qsphy_detach),
 106         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 107         { 0, 0 }
 108 };
 109
 110 static devclass_t qsphy_devclass;
 111
 112 static driver_t qsphy_driver = {
 113         "qsphy",
 114         qsphy_methods,
 115         sizeof(struct mii_softc)
 116 };
 117
 118 DRIVER_MODULE(qsphy, miibus, qsphy_driver, qsphy_devclass, 0, 0);
 119
 120 int     qsphy_service (struct mii_softc *, struct mii_data *, int);
 121 void    qsphy_reset (struct mii_softc *);
 122 void    qsphy_status (struct mii_softc *);
 123
 124 static int qsphy_probe(dev)
 125         device_t                dev;
 126 {
 127         struct mii_attach_args *ma;
 128
 129         ma = device_get_ivars(dev);
 130
 131         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_QUALSEMI &&
 132             MII_MODEL(ma->mii_id2) == MII_MODEL_QUALSEMI_QS6612) {
 133                 device_set_desc(dev, MII_STR_QUALSEMI_QS6612);
 134         } else
 135                 return (ENXIO);
 136
 137         return (0);
 138 }
 139
 140 static int qsphy_attach(dev)
 141         device_t                dev;
 142 {
 143         struct mii_softc *sc;
 144         struct mii_attach_args *ma;
 145         struct mii_data *mii;
 146
 147         sc = device_get_softc(dev);
 148         ma = device_get_ivars(dev);
 149         mii_softc_init(sc);
 150         sc->mii_dev = device_get_parent(dev);
 151         mii = device_get_softc(sc->mii_dev);
 152         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 153
 154         sc->mii_inst = mii->mii_instance;
 155         sc->mii_phy = ma->mii_phyno;
 156         sc->mii_service = qsphy_service;
 157         sc->mii_pdata = mii;
 158         sc->mii_flags |= MIIF_NOISOLATE;
 159
 160         qsphy_reset(sc);
 161
 162         mii->mii_instance++;
 163
 164         sc->mii_capabilities =
 165             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 166         device_printf(dev, " ");
 167         if (sc->mii_capabilities & BMSR_MEDIAMASK)
 168                 mii_add_media(mii, sc->mii_capabilities,
 169                     sc->mii_inst);
 170         printf("\n");
 171
 172         MIIBUS_MEDIAINIT(sc->mii_dev);
 173         return (0);
 174 }
 175
 176 static int qsphy_detach(dev)
 177         device_t                dev;
 178 {
 179         struct mii_softc *sc;
 180         struct mii_data *mii;
 181
 182         sc = device_get_softc(dev);
 183         mii = device_get_softc(device_get_parent(dev));
 184         sc->mii_dev = NULL;
 185         LIST_REMOVE(sc, mii_list);
 186
 187         return(0);
 188 }
 189
 190 int
 191 qsphy_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         /*
 200          * If we're not selected, then do nothing, just isolate, if
 201          * changing media.
 202          */
 203         if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 204                 if (cmd == MII_MEDIACHG) {
 205                         reg = PHY_READ(sc, MII_BMCR);
 206                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 207                 }
 208
 209                 return (0);
 210         }
 211
 212         switch (cmd) {
 213         case MII_POLLSTAT:
 214                 break;
 215
 216         case MII_MEDIACHG:
 217                 /*
 218                  * If the interface is not up, don't do anything.
 219                  */
 220                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 221                         break;
 222
 223                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 224                 case IFM_AUTO:
 225                         /*
 226                          * If we're already in auto mode, just return.
 227                          */
 228                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 229                                 return (0);
 230
 231                         (void) mii_phy_auto(sc, 1);
 232                         break;
 233
 234                 default:
 235                         /*
 236                          * BMCR data is stored in the ifmedia entry.
 237                          */
 238                         PHY_WRITE(sc, MII_ANAR,
 239                             mii_anar(ife->ifm_media));
 240                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 241                 }
 242                 break;
 243
 244         case MII_TICK:
 245                 /*
 246                  * Is the interface even up?
 247                  */
 248                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 249                         return (0);
 250
 251                 /*
 252                  * Only used for autonegotiation.
 253                  */
 254                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 255                         break;
 256
 257                 /*
 258                  * This PHY's autonegotiation doesn't need to be kicked.
 259                  */
 260                 break;
 261         }
 262
 263         /* Update the media status. */
 264         qsphy_status(sc);
 265
 266         /* Callback if something changed. */
 267         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 268                 MIIBUS_STATCHG(sc->mii_dev);
 269                 sc->mii_active = mii->mii_media_active;
 270         }
 271         return (0);
 272 }
 273
 274 void
 275 qsphy_status(sc)
 276         struct mii_softc *sc;
 277 {
 278         struct mii_data *mii = sc->mii_pdata;
 279         int bmsr, bmcr, pctl;
 280
 281         mii->mii_media_status = IFM_AVALID;
 282         mii->mii_media_active = IFM_ETHER;
 283
 284         bmsr = PHY_READ(sc, MII_BMSR) |
 285             PHY_READ(sc, MII_BMSR);
 286         if (bmsr & BMSR_LINK)
 287                 mii->mii_media_status |= IFM_ACTIVE;
 288
 289         bmcr = PHY_READ(sc, MII_BMCR);
 290         if (bmcr & BMCR_ISO) {
 291                 mii->mii_media_active |= IFM_NONE;
 292                 mii->mii_media_status = 0;
 293                 return;
 294         }
 295
 296         if (bmcr & BMCR_LOOP)
 297                 mii->mii_media_active |= IFM_LOOP;
 298
 299         pctl = PHY_READ(sc, MII_QSPHY_PCTL);
 300         switch (pctl & PCTL_OPMASK) {
 301         case PCTL_10_T:
 302                 mii->mii_media_active |= IFM_10_T;
 303                 break;
 304         case PCTL_10_T_FDX:
 305                 mii->mii_media_active |= IFM_10_T|IFM_FDX;
 306                 break;
 307         case PCTL_100_TX:
 308                 mii->mii_media_active |= IFM_100_TX;
 309                 break;
 310         case PCTL_100_TX_FDX:
 311                 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 312                 break;
 313         case PCTL_100_T4:
 314                 mii->mii_media_active |= IFM_100_T4;
 315                 break;
 316         case PCTL_AN:
 317                 mii->mii_media_active |= IFM_NONE;
 318                 break;
 319         default:
 320                 /* Erg... this shouldn't happen. */
 321                 mii->mii_media_active |= IFM_NONE;
 322                 break;
 323         }
 324 }
 325
 326 void
 327 qsphy_reset(sc)
 328         struct mii_softc *sc;
 329 {
 330
 331         mii_phy_reset(sc);
 332         PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
 333 }