sys/dev/mii/exphy.c

   1 /*      $NetBSD: exphy.c,v 1.16 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 #include <sys/cdefs.h>
  70 __FBSDID("$FreeBSD$");
  71
  72 /*
  73  * driver for 3Com internal 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/module.h>
  81 #include <sys/bus.h>
  82
  83 #include <net/if.h>
  84 #include <net/if_media.h>
  85
  86 #include <dev/mii/mii.h>
  87 #include <dev/mii/miivar.h>
  88 #include "miidevs.h"
  89
  90 #include "miibus_if.h"
  91
  92 static int exphy_probe(device_t);
  93 static int exphy_attach(device_t);
  94
  95 static device_method_t exphy_methods[] = {
  96         /* device interface */
  97         DEVMETHOD(device_probe,         exphy_probe),
  98         DEVMETHOD(device_attach,        exphy_attach),
  99         DEVMETHOD(device_detach,        mii_phy_detach),
 100         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 101         { 0, 0 }
 102 };
 103
 104 static devclass_t exphy_devclass;
 105
 106 static driver_t exphy_driver = {
 107         "xlphy",
 108         exphy_methods,
 109         sizeof(struct mii_softc)
 110 };
 111
 112 DRIVER_MODULE(xlphy, miibus, exphy_driver, exphy_devclass, 0, 0);
 113
 114 static int      exphy_service(struct mii_softc *, struct mii_data *, int);
 115 static void     exphy_reset(struct mii_softc *);
 116
 117 /*
 118  * Some 3Com internal PHYs report zero for OUI and model, others use
 119  * actual values.
 120  * Note that the 3Com internal PHYs having OUI 0x105a and model 0 are
 121  * handled fine by ukphy(4); they can be isolated and don't require
 122  * special treatment after reset.
 123  */
 124 static const struct mii_phydesc exphys[] = {
 125         { 0, 0, "3Com internal media interface" },
 126         MII_PHY_DESC(BROADCOM, 3C905C),
 127         MII_PHY_END
 128 };
 129
 130 static int
 131 exphy_probe(device_t dev)
 132 {
 133
 134         if (strcmp(device_get_name(device_get_parent(device_get_parent(dev))),
 135             "xl") == 0)
 136                 return (mii_phy_dev_probe(dev, exphys, BUS_PROBE_DEFAULT));
 137         return (ENXIO);
 138 }
 139
 140 static int
 141 exphy_attach(device_t dev)
 142 {
 143         struct mii_softc *sc;
 144         struct mii_attach_args *ma;
 145         struct mii_data *mii;
 146
 147         sc = device_get_softc(dev);
 148         ma = device_get_ivars(dev);
 149         sc->mii_dev = device_get_parent(dev);
 150         mii = device_get_softc(sc->mii_dev);
 151
 152         /*
 153          * The 3Com PHY can never be isolated, so never allow non-zero
 154          * instances!
 155          */
 156         if (mii->mii_instance != 0) {
 157                 device_printf(dev, "ignoring this PHY, non-zero instance\n");
 158                 return (ENXIO);
 159         }
 160
 161         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 162
 163         sc->mii_inst = mii->mii_instance;
 164         sc->mii_phy = ma->mii_phyno;
 165         sc->mii_service = exphy_service;
 166         sc->mii_pdata = mii;
 167         mii->mii_instance++;
 168
 169         sc->mii_flags |= MIIF_NOISOLATE;
 170
 171 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 172
 173         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 174             MII_MEDIA_100_TX);
 175
 176         exphy_reset(sc);
 177
 178         sc->mii_capabilities =
 179             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 180         device_printf(dev, " ");
 181         mii_phy_add_media(sc);
 182         printf("\n");
 183 #undef ADD
 184         MIIBUS_MEDIAINIT(sc->mii_dev);
 185         return (0);
 186 }
 187
 188 static int
 189 exphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 190 {
 191         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 192
 193         /*
 194          * We can't isolate the 3Com PHY, so it has to be the only one!
 195          */
 196         if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 197                 panic("exphy_service: can't isolate 3Com PHY");
 198
 199         switch (cmd) {
 200         case MII_POLLSTAT:
 201                 break;
 202
 203         case MII_MEDIACHG:
 204                 /*
 205                  * If the interface is not up, don't do anything.
 206                  */
 207                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 208                         break;
 209
 210                 mii_phy_setmedia(sc);
 211                 break;
 212
 213         case MII_TICK:
 214                 /*
 215                  * Is the interface even up?
 216                  */
 217                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 218                         return (0);
 219
 220                 /*
 221                  * The 3Com PHY's autonegotiation doesn't need to be
 222                  * kicked; it continues in the background.
 223                  */
 224                 break;
 225         }
 226
 227         /* Update the media status. */
 228         ukphy_status(sc);
 229
 230         /* Callback if something changed. */
 231         mii_phy_update(sc, cmd);
 232         return (0);
 233 }
 234
 235 static void
 236 exphy_reset(struct mii_softc *sc)
 237 {
 238
 239         mii_phy_reset(sc);
 240
 241         /*
 242          * XXX 3Com PHY doesn't set the BMCR properly after
 243          * XXX reset, which breaks autonegotiation.
 244          */
 245         PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_AUTOEN|BMCR_FDX);
 246 }