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