sys/dev/mii/gentbi.c

   1 /*      $NetBSD: gentbi.c,v 1.15 2006/03/29 07:05:24 thorpej Exp $      */
   2
   3 /*-
   4  * Copyright (c) 1998, 1999, 2000, 2001 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.
  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 ten-bit (1000BASE-SX) interfaces, built in to
  71  * many Gigabit Ethernet chips.
  72  *
  73  * All we have to do here is correctly report speed and duplex.
  74  */
  75
  76 #include <sys/cdefs.h>
  77 __FBSDID("$FreeBSD$");
  78
  79 /*
  80  * Driver for generic unknown ten-bit interfaces(1000BASE-{LX,SX}
  81  * fiber interfaces).
  82  */
  83
  84 #include <sys/param.h>
  85 #include <sys/systm.h>
  86 #include <sys/kernel.h>
  87 #include <sys/module.h>
  88 #include <sys/socket.h>
  89 #include <sys/errno.h>
  90 #include <sys/bus.h>
  91
  92 #include <net/if.h>
  93 #include <net/if_media.h>
  94
  95 #include <dev/mii/mii.h>
  96 #include <dev/mii/miivar.h>
  97 #include "miidevs.h"
  98
  99 #include "miibus_if.h"
 100
 101 static int      gentbi_probe(device_t);
 102 static int      gentbi_attach(device_t);
 103
 104 static device_method_t gentbi_methods[] = {
 105         /* device interface */
 106         DEVMETHOD(device_probe,         gentbi_probe),
 107         DEVMETHOD(device_attach,        gentbi_attach),
 108         DEVMETHOD(device_detach,        mii_phy_detach),
 109         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 110         {0, 0}
 111 };
 112
 113 static devclass_t gentbi_devclass;
 114
 115 static driver_t gentbi_driver = {
 116         "gentbi",
 117         gentbi_methods,
 118         sizeof(struct mii_softc)
 119 };
 120
 121 DRIVER_MODULE(gentbi, miibus, gentbi_driver, gentbi_devclass, 0, 0);
 122
 123 static int      gentbi_service(struct mii_softc *, struct mii_data *, int);
 124 static void     gentbi_status(struct mii_softc *);
 125
 126 static int
 127 gentbi_probe(device_t dev)
 128 {
 129         device_t parent;
 130         struct mii_attach_args *ma;
 131         int bmsr, extsr;
 132
 133         parent = device_get_parent(dev);
 134         ma = device_get_ivars(dev);
 135
 136         /*
 137          * We match as a generic TBI if:
 138          *
 139          *      - There is no media in the BMSR.
 140          *      - EXTSR has only 1000X.
 141          */
 142         bmsr = MIIBUS_READREG(parent, ma->mii_phyno, MII_BMSR);
 143         if ((bmsr & BMSR_EXTSTAT) == 0 || (bmsr & BMSR_MEDIAMASK) != 0)
 144                 return (ENXIO);
 145
 146         extsr = MIIBUS_READREG(parent, ma->mii_phyno, MII_EXTSR);
 147         if (extsr & (EXTSR_1000TFDX|EXTSR_1000THDX))
 148                 return (ENXIO);
 149
 150         if (extsr & (EXTSR_1000XFDX|EXTSR_1000XHDX)) {
 151                 /*
 152                  * We think this is a generic TBI.  Return a match
 153                  * priority higher than ukphy, but lower than what
 154                  * specific drivers will return.
 155                  */
 156                 device_set_desc(dev, "Generic ten-bit interface");
 157                 return (BUS_PROBE_LOW_PRIORITY);
 158         }
 159
 160         return (ENXIO);
 161 }
 162
 163 static int
 164 gentbi_attach(device_t dev)
 165 {
 166         struct mii_softc *sc;
 167         struct mii_attach_args *ma;
 168         struct mii_data *mii;
 169
 170         sc = device_get_softc(dev);
 171         ma = device_get_ivars(dev);
 172         sc->mii_dev = device_get_parent(dev);
 173         mii = device_get_softc(sc->mii_dev);
 174         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 175
 176         if (bootverbose)
 177                 device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
 178                     MII_OUI(ma->mii_id1, ma->mii_id2),
 179                     MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
 180
 181         sc->mii_inst = mii->mii_instance;
 182         sc->mii_phy = ma->mii_phyno;
 183         sc->mii_service = gentbi_service;
 184         sc->mii_pdata = mii;
 185
 186         mii->mii_instance++;
 187
 188         mii_phy_reset(sc);
 189
 190         /*
 191          * Mask out all media in the BMSR.  We only are really interested
 192          * in "auto".
 193          */
 194         sc->mii_capabilities =
 195             PHY_READ(sc, MII_BMSR) & ma->mii_capmask & ~BMSR_MEDIAMASK;
 196         if (sc->mii_capabilities & BMSR_EXTSTAT)
 197                 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
 198
 199         device_printf(dev, " ");
 200         mii_phy_add_media(sc);
 201         printf("\n");
 202
 203         MIIBUS_MEDIAINIT(sc->mii_dev);
 204         return (0);
 205 }
 206
 207 static int
 208 gentbi_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 209 {
 210         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 211         int reg;
 212
 213         switch (cmd) {
 214         case MII_POLLSTAT:
 215                 /*
 216                  * If we're not polling our PHY instance, just return.
 217                  */
 218                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 219                         return (0);
 220                 break;
 221
 222         case MII_MEDIACHG:
 223                 /*
 224                  * If the media indicates a different PHY instance,
 225                  * isolate ourselves.
 226                  */
 227                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 228                         reg = PHY_READ(sc, MII_BMCR);
 229                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 230                         return (0);
 231                 }
 232
 233                 /*
 234                  * If the interface is not up, don't do anything.
 235                  */
 236                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 237                         break;
 238
 239                 mii_phy_setmedia(sc);
 240                 break;
 241
 242         case MII_TICK:
 243                 /*
 244                  * If we're not currently selected, just return.
 245                  */
 246                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 247                         return (0);
 248
 249                 if (mii_phy_tick(sc) == EJUSTRETURN)
 250                         return (0);
 251                 break;
 252         }
 253
 254         /* Update the media status. */
 255         gentbi_status(sc);
 256
 257         /* Callback if something changed. */
 258         mii_phy_update(sc, cmd);
 259         return (0);
 260 }
 261
 262 static void
 263 gentbi_status(struct mii_softc *sc)
 264 {
 265         struct mii_data *mii = sc->mii_pdata;
 266         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 267         int bmsr, bmcr, anlpar;
 268
 269         mii->mii_media_status = IFM_AVALID;
 270         mii->mii_media_active = IFM_ETHER;
 271
 272         bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 273
 274         if (bmsr & BMSR_LINK)
 275                 mii->mii_media_status |= IFM_ACTIVE;
 276
 277         bmcr = PHY_READ(sc, MII_BMCR);
 278         if (bmcr & BMCR_ISO) {
 279                 mii->mii_media_active |= IFM_NONE;
 280                 mii->mii_media_status = 0;
 281                 return;
 282         }
 283
 284         if (bmcr & BMCR_LOOP)
 285                 mii->mii_media_active |= IFM_LOOP;
 286
 287         if (bmcr & BMCR_AUTOEN) {
 288                 /*
 289                  * The media status bits are only valid if autonegotiation
 290                  * has completed (or it's disabled).
 291                  */
 292                 if ((bmsr & BMSR_ACOMP) == 0) {
 293                         /* Erg, still trying, I guess... */
 294                         mii->mii_media_active |= IFM_NONE;
 295                         return;
 296                 }
 297
 298                 /*
 299                  * The media is always 1000baseSX.  Check the ANLPAR to
 300                  * see if we're doing full-duplex.
 301                  */
 302                 mii->mii_media_active |= IFM_1000_SX;
 303
 304                 anlpar = PHY_READ(sc, MII_ANLPAR);
 305                 if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0 &&
 306                     (anlpar & ANLPAR_X_FD) != 0)
 307                         mii->mii_media_active |= IFM_FDX;
 308         } else
 309                 mii->mii_media_active = ife->ifm_media;
 310 }