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