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