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.2 2003/06/17 04:28:28 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 <dev/mii/mii.h>
  90 #include <dev/mii/miivar.h>
  91
  92 #include "miibus_if.h"
  93
  94 static int ukphy_probe          __P((device_t));
  95 static int ukphy_attach         __P((device_t));
  96 static int ukphy_detach         __P((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 __P((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         sc->mii_dev = device_get_parent(dev);
 142         mii = device_get_softc(sc->mii_dev);
 143         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 144
 145         if (bootverbose)
 146                 device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
 147                     MII_OUI(ma->mii_id1, ma->mii_id2),
 148                     MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
 149
 150         sc->mii_inst = mii->mii_instance;
 151         sc->mii_phy = ma->mii_phyno;
 152         sc->mii_service = ukphy_service;
 153         sc->mii_pdata = mii;
 154
 155         mii->mii_instance++;
 156
 157         sc->mii_flags |= MIIF_NOISOLATE;
 158
 159 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 160
 161         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 162             BMCR_ISO);
 163 #if 0
 164         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 165             BMCR_LOOP|BMCR_S100);
 166 #endif
 167
 168         mii_phy_reset(sc);
 169
 170         sc->mii_capabilities =
 171             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 172         device_printf(dev, " ");
 173         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 174                 printf("no media present");
 175         else
 176                 mii_add_media(mii, sc->mii_capabilities,
 177                     sc->mii_inst);
 178         printf("\n");
 179 #undef ADD
 180
 181         MIIBUS_MEDIAINIT(sc->mii_dev);
 182
 183         return(0);
 184 }
 185
 186 static int ukphy_detach(dev)
 187         device_t                dev;
 188 {
 189         struct mii_softc *sc;
 190         struct mii_data *mii;
 191
 192         sc = device_get_softc(dev);
 193         mii = device_get_softc(device_get_parent(dev));
 194         mii_phy_auto_stop(sc);
 195         sc->mii_dev = NULL;
 196         LIST_REMOVE(sc, mii_list);
 197
 198         return(0);
 199 }
 200
 201 int
 202 ukphy_service(sc, mii, cmd)
 203         struct mii_softc *sc;
 204         struct mii_data *mii;
 205         int cmd;
 206 {
 207         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 208         int reg;
 209
 210         switch (cmd) {
 211         case MII_POLLSTAT:
 212                 /*
 213                  * If we're not polling our PHY instance, just return.
 214                  */
 215                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 216                         return (0);
 217                 break;
 218
 219         case MII_MEDIACHG:
 220                 /*
 221                  * If the media indicates a different PHY instance,
 222                  * isolate ourselves.
 223                  */
 224                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 225                         reg = PHY_READ(sc, MII_BMCR);
 226                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 227                         return (0);
 228                 }
 229
 230                 /*
 231                  * If the interface is not up, don't do anything.
 232                  */
 233                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 234                         break;
 235
 236                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 237                 case IFM_AUTO:
 238                         /*
 239                          * If we're already in auto mode, just return.
 240                          */
 241                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 242                                 return (0);
 243                         (void) mii_phy_auto(sc, 1);
 244                         break;
 245                 case IFM_100_T4:
 246                         /*
 247                          * XXX Not supported as a manual setting right now.
 248                          */
 249                         return (EINVAL);
 250                 default:
 251                         /*
 252                          * BMCR data is stored in the ifmedia entry.
 253                          */
 254                         PHY_WRITE(sc, MII_ANAR,
 255                             mii_anar(ife->ifm_media));
 256                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 257                 }
 258                 break;
 259
 260         case MII_TICK:
 261                 /*
 262                  * If we're not currently selected, just return.
 263                  */
 264                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 265                         return (0);
 266
 267                 /*
 268                  * Only used for autonegotiation.
 269                  */
 270                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 271                         return (0);
 272
 273                 /*
 274                  * Is the interface even up?
 275                  */
 276                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 277                         return (0);
 278
 279                 /*
 280                  * Check to see if we have link.  If we do, we don't
 281                  * need to restart the autonegotiation process.  Read
 282                  * the BMSR twice in case it's latched.
 283                  */
 284                 reg = PHY_READ(sc, MII_BMSR) |
 285                     PHY_READ(sc, MII_BMSR);
 286                 if (reg & BMSR_LINK)
 287                         return (0);
 288
 289                 /*
 290                  * Only retry autonegotiation every 5 seconds.
 291                  */
 292                 if (++sc->mii_ticks != 5)
 293                         return (0);
 294
 295                 sc->mii_ticks = 0;
 296                 mii_phy_reset(sc);
 297                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 298                         return (0);
 299                 break;
 300         }
 301
 302         /* Update the media status. */
 303         ukphy_status(sc);
 304
 305         /* Callback if something changed. */
 306         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 307                 MIIBUS_STATCHG(sc->mii_dev);
 308                 sc->mii_active = mii->mii_media_active;
 309         }
 310         return (0);
 311 }