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.7 2005/10/24 16:45:19 dillon 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 device_method_t ukphy_methods[] = {
  95         /* device interface */
  96         DEVMETHOD(device_probe,         ukphy_probe),
  97         DEVMETHOD(device_attach,        ukphy_attach),
  98         DEVMETHOD(device_detach,        ukphy_detach),
  99         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 100         { 0, 0 }
 101 };
 102
 103 static devclass_t ukphy_devclass;
 104
 105 static driver_t ukphy_driver = {
 106         "ukphy",
 107         ukphy_methods,
 108         sizeof(struct mii_softc)
 109 };
 110
 111 DRIVER_MODULE(ukphy, miibus, ukphy_driver, ukphy_devclass, 0, 0);
 112
 113 int     ukphy_service (struct mii_softc *, struct mii_data *, int);
 114
 115 int
 116 ukphy_probe(device_t dev)
 117 {
 118
 119         /*
 120          * We know something is here, so always match at a low priority.
 121          */
 122         device_set_desc(dev, "Generic IEEE 802.3u media interface");
 123         return (-100);
 124 }
 125
 126 int
 127 ukphy_attach(device_t dev)
 128 {
 129         struct mii_softc *sc;
 130         struct mii_attach_args *ma;
 131         struct mii_data *mii;
 132
 133         sc = device_get_softc(dev);
 134         ma = device_get_ivars(dev);
 135         mii_softc_init(sc);
 136         sc->mii_dev = device_get_parent(dev);
 137         mii = device_get_softc(sc->mii_dev);
 138         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 139
 140         if (bootverbose)
 141                 device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
 142                     MII_OUI(ma->mii_id1, ma->mii_id2),
 143                     MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
 144
 145         sc->mii_inst = mii->mii_instance;
 146         sc->mii_phy = ma->mii_phyno;
 147         sc->mii_service = ukphy_service;
 148         sc->mii_pdata = mii;
 149
 150         mii->mii_instance++;
 151
 152         sc->mii_flags |= ma->mii_flags;
 153         sc->mii_flags |= MIIF_NOISOLATE;
 154
 155 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 156
 157         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 158             BMCR_ISO);
 159 #if 0
 160         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 161             BMCR_LOOP|BMCR_S100);
 162 #endif
 163
 164         mii_phy_reset(sc);
 165
 166         sc->mii_capabilities =
 167             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 168         device_printf(dev, " ");
 169         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 170                 printf("no media present");
 171         else
 172                 mii_add_media(sc, sc->mii_capabilities);
 173         printf("\n");
 174 #undef ADD
 175
 176         MIIBUS_MEDIAINIT(sc->mii_dev);
 177
 178         return(0);
 179 }
 180
 181 int
 182 ukphy_detach(device_t dev)
 183 {
 184         struct mii_softc *sc;
 185         struct mii_data *mii;
 186
 187         sc = device_get_softc(dev);
 188         mii = device_get_softc(device_get_parent(dev));
 189         mii_phy_auto_stop(sc);
 190         sc->mii_dev = NULL;
 191         LIST_REMOVE(sc, mii_list);
 192
 193         return(0);
 194 }
 195
 196 int
 197 ukphy_service(sc, mii, cmd)
 198         struct mii_softc *sc;
 199         struct mii_data *mii;
 200         int cmd;
 201 {
 202         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 203         int reg;
 204
 205         switch (cmd) {
 206         case MII_POLLSTAT:
 207                 /*
 208                  * If we're not polling our PHY instance, just return.
 209                  */
 210                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 211                         return (0);
 212                 break;
 213
 214         case MII_MEDIACHG:
 215                 /*
 216                  * If the media indicates a different PHY instance,
 217                  * isolate ourselves.
 218                  */
 219                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 220                         reg = PHY_READ(sc, MII_BMCR);
 221                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 222                         return (0);
 223                 }
 224
 225                 /*
 226                  * If the interface is not up, don't do anything.
 227                  */
 228                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 229                         break;
 230
 231                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 232                 case IFM_AUTO:
 233                         /*
 234                          * If we're already in auto mode, just return.
 235                          */
 236                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 237                                 return (0);
 238                         (void) mii_phy_auto(sc, 1);
 239                         break;
 240                 case IFM_100_T4:
 241                         /*
 242                          * XXX Not supported as a manual setting right now.
 243                          */
 244                         return (EINVAL);
 245                 default:
 246                         /*
 247                          * BMCR data is stored in the ifmedia entry.
 248                          */
 249                         PHY_WRITE(sc, MII_ANAR,
 250                             mii_anar(ife->ifm_media));
 251                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 252                 }
 253                 break;
 254
 255         case MII_TICK:
 256                 /*
 257                  * If we're not currently selected, just return.
 258                  */
 259                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 260                         return (0);
 261
 262                 /*
 263                  * Only used for autonegotiation.
 264                  */
 265                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 266                         return (0);
 267
 268                 /*
 269                  * Is the interface even up?
 270                  */
 271                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 272                         return (0);
 273
 274                 /*
 275                  * Check to see if we have link.  If we do, we don't
 276                  * need to restart the autonegotiation process.  Read
 277                  * the BMSR twice in case it's latched.
 278                  */
 279                 reg = PHY_READ(sc, MII_BMSR) |
 280                     PHY_READ(sc, MII_BMSR);
 281                 if (reg & BMSR_LINK)
 282                         return (0);
 283
 284                 /*
 285                  * Only retry autonegotiation every 5 seconds.
 286                  */
 287                 if (++sc->mii_ticks != 5)
 288                         return (0);
 289
 290                 sc->mii_ticks = 0;
 291                 mii_phy_reset(sc);
 292                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 293                         return (0);
 294                 break;
 295         }
 296
 297         /* Update the media status. */
 298         ukphy_status(sc);
 299
 300         /* Callback if something changed. */
 301         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 302                 MIIBUS_STATCHG(sc->mii_dev);
 303                 sc->mii_active = mii->mii_media_active;
 304         }
 305         return (0);
 306 }