sys/dev/netif/mii_layer/ukphy.c

   1 /*      $NetBSD: ukphy.c,v 1.2 1999/04/23 04:24:32 thorpej Exp $        */
   2
   3 /*-
   4  * Copyright (c) 1998, 1999 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, and by Frank van der Linden.
  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  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the NetBSD
  22  *      Foundation, Inc. and its contributors.
  23  * 4. Neither the name of The NetBSD Foundation nor the names of its
  24  *    contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  * $FreeBSD: src/sys/dev/mii/ukphy.c,v 1.2.2.2 2002/11/08 21:53:49 semenu Exp $
  40  * $DragonFly: src/sys/dev/netif/mii_layer/ukphy.c,v 1.9 2005/10/31 13:08:35 sephe 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 generic unknown PHYs
  74  */
  75
  76 #include <sys/param.h>
  77 #include <sys/systm.h>
  78 #include <sys/kernel.h>
  79 #include <sys/socket.h>
  80 #include <sys/errno.h>
  81 #include <sys/module.h>
  82 #include <sys/bus.h>
  83
  84 #include <net/if.h>
  85 #include <net/if_media.h>
  86
  87 #include <machine/clock.h>
  88
  89 #include "mii.h"
  90 #include "miivar.h"
  91
  92 #include "miibus_if.h"
  93
  94 static int      ukphy_service(struct mii_softc *, struct mii_data *, int);
  95 static int      ukphy_probe(device_t);
  96
  97 static device_method_t ukphy_methods[] = {
  98         /* device interface */
  99         DEVMETHOD(device_probe,         ukphy_probe),
 100         DEVMETHOD(device_attach,        ukphy_attach),
 101         DEVMETHOD(device_detach,        ukphy_detach),
 102         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 103         { 0, 0 }
 104 };
 105
 106 static devclass_t ukphy_devclass;
 107
 108 static driver_t ukphy_driver = {
 109         "ukphy",
 110         ukphy_methods,
 111         sizeof(struct mii_softc)
 112 };
 113
 114 DRIVER_MODULE(ukphy, miibus, ukphy_driver, ukphy_devclass, 0, 0);
 115
 116 static int
 117 ukphy_probe(device_t dev)
 118 {
 119
 120         /*
 121          * We know something is here, so always match at a low priority.
 122          */
 123         device_set_desc(dev, "Generic IEEE 802.3u media interface");
 124         return (-100);
 125 }
 126
 127 int
 128 ukphy_attach(device_t dev)
 129 {
 130         struct mii_softc *sc;
 131         struct mii_attach_args *ma;
 132         struct mii_data *mii;
 133
 134         sc = device_get_softc(dev);
 135         ma = device_get_ivars(dev);
 136         mii_softc_init(sc, ma);
 137         sc->mii_dev = device_get_parent(dev);
 138         mii = device_get_softc(sc->mii_dev);
 139         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 140
 141         if (bootverbose)
 142                 device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
 143                     MII_OUI(ma->mii_id1, ma->mii_id2),
 144                     MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
 145
 146         sc->mii_inst = mii->mii_instance;
 147         sc->mii_service = ukphy_service;
 148         sc->mii_pdata = mii;
 149
 150         mii->mii_instance++;
 151
 152         sc->mii_flags |= MIIF_NOISOLATE;
 153
 154 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 155
 156         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 157             BMCR_ISO);
 158 #if 0
 159         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 160             BMCR_LOOP|BMCR_S100);
 161 #endif
 162
 163         mii_phy_reset(sc);
 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) == 0)
 169                 printf("no media present");
 170         else
 171                 mii_add_media(sc, sc->mii_capabilities);
 172         printf("\n");
 173 #undef ADD
 174
 175         MIIBUS_MEDIAINIT(sc->mii_dev);
 176
 177         return(0);
 178 }
 179
 180 int
 181 ukphy_detach(device_t dev)
 182 {
 183         struct mii_softc *sc;
 184         struct mii_data *mii;
 185
 186         sc = device_get_softc(dev);
 187         mii = device_get_softc(device_get_parent(dev));
 188         mii_phy_auto_stop(sc);
 189         sc->mii_dev = NULL;
 190         LIST_REMOVE(sc, mii_list);
 191
 192         return(0);
 193 }
 194
 195 static int
 196 ukphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 197 {
 198         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 199         int reg;
 200
 201         switch (cmd) {
 202         case MII_POLLSTAT:
 203                 /*
 204                  * If we're not polling our PHY instance, just return.
 205                  */
 206                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 207                         return (0);
 208                 break;
 209
 210         case MII_MEDIACHG:
 211                 /*
 212                  * If the media indicates a different PHY instance,
 213                  * isolate ourselves.
 214                  */
 215                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 216                         reg = PHY_READ(sc, MII_BMCR);
 217                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 218                         return (0);
 219                 }
 220
 221                 /*
 222                  * If the interface is not up, don't do anything.
 223                  */
 224                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 225                         break;
 226
 227                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 228                 case IFM_AUTO:
 229                         /*
 230                          * If we're already in auto mode, just return.
 231                          */
 232                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 233                                 return (0);
 234                         (void) mii_phy_auto(sc, 1);
 235                         break;
 236                 case IFM_100_T4:
 237                         /*
 238                          * XXX Not supported as a manual setting right now.
 239                          */
 240                         return (EINVAL);
 241                 default:
 242                         /*
 243                          * BMCR data is stored in the ifmedia entry.
 244                          */
 245                         PHY_WRITE(sc, MII_ANAR,
 246                             mii_anar(ife->ifm_media));
 247                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 248                 }
 249                 break;
 250
 251         case MII_TICK:
 252                 /*
 253                  * If we're not currently selected, just return.
 254                  */
 255                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 256                         return (0);
 257
 258                 /*
 259                  * Only used for autonegotiation.
 260                  */
 261                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 262                         return (0);
 263
 264                 /*
 265                  * Is the interface even up?
 266                  */
 267                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 268                         return (0);
 269
 270                 /*
 271                  * Check to see if we have link.  If we do, we don't
 272                  * need to restart the autonegotiation process.  Read
 273                  * the BMSR twice in case it's latched.
 274                  */
 275                 reg = PHY_READ(sc, MII_BMSR) |
 276                     PHY_READ(sc, MII_BMSR);
 277                 if (reg & BMSR_LINK)
 278                         return (0);
 279
 280                 /*
 281                  * Only retry autonegotiation every 5 seconds.
 282                  */
 283                 if (++sc->mii_ticks != 5)
 284                         return (0);
 285
 286                 sc->mii_ticks = 0;
 287                 mii_phy_reset(sc);
 288                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 289                         return (0);
 290                 break;
 291         }
 292
 293         /* Update the media status. */
 294         ukphy_status(sc);
 295
 296         /* Callback if something changed. */
 297         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 298                 MIIBUS_STATCHG(sc->mii_dev);
 299                 sc->mii_active = mii->mii_media_active;
 300         }
 301         return (0);
 302 }