sys/dev/netif/mii_layer/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 /*
  70  * driver for 3Com internal 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/module.h>
  78 #include <sys/bus.h>
  79
  80 #include <net/if.h>
  81 #include <net/if_media.h>
  82
  83 #include <dev/mii/mii.h>
  84 #include <dev/mii/miivar.h>
  85 #include <dev/mii/miidevs.h>
  86
  87 #include "miibus_if.h"
  88
  89 #if !defined(lint)
  90 static const char rcsid[] =
  91   "$FreeBSD: src/sys/dev/mii/exphy.c,v 1.4.2.2 2002/11/08 21:53:49 semenu Exp $";
  92 #endif
  93
  94 static int exphy_probe          __P((device_t));
  95 static int exphy_attach         __P((device_t));
  96 static int exphy_detach         __P((device_t));
  97
  98 static device_method_t exphy_methods[] = {
  99         /* device interface */
 100         DEVMETHOD(device_probe,         exphy_probe),
 101         DEVMETHOD(device_attach,        exphy_attach),
 102         DEVMETHOD(device_detach,        exphy_detach),
 103         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 104         { 0, 0 }
 105 };
 106
 107 static devclass_t exphy_devclass;
 108
 109 static driver_t exphy_driver = {
 110         "xlphy",
 111         exphy_methods,
 112         sizeof(struct mii_softc)
 113 };
 114
 115 DRIVER_MODULE(xlphy, miibus, exphy_driver, exphy_devclass, 0, 0);
 116
 117 int     exphy_service __P((struct mii_softc *, struct mii_data *, int));
 118 void    exphy_reset __P((struct mii_softc *));
 119
 120 static int exphy_probe(dev)
 121         device_t                dev;
 122 {
 123         struct mii_attach_args *ma;
 124         device_t                parent;
 125
 126         ma = device_get_ivars(dev);
 127         parent = device_get_parent(device_get_parent(dev));
 128
 129         /*
 130          * Argh, 3Com PHY reports oui == 0 model == 0!
 131          */
 132         if ((MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
 133             MII_MODEL(ma->mii_id2) != 0) &&
 134             (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_BROADCOM ||
 135             MII_MODEL(ma->mii_id2) != MII_MODEL_BROADCOM_3c905Cphy))
 136                 return (ENXIO);
 137
 138         /*
 139          * Make sure the parent is an `ex'.
 140          */
 141         if (strcmp(device_get_name(parent), "xl") != 0)
 142                 return (ENXIO);
 143
 144         if (MII_OUI(ma->mii_id1, ma->mii_id2) == 0)
 145                 device_set_desc(dev, "3Com internal media interface");
 146         else
 147                 device_set_desc(dev, MII_STR_BROADCOM_3c905Cphy);
 148
 149         return (0);
 150 }
 151
 152 static int exphy_attach(dev)
 153         device_t                dev;
 154 {
 155         struct mii_softc *sc;
 156         struct mii_attach_args *ma;
 157         struct mii_data *mii;
 158
 159         sc = device_get_softc(dev);
 160         ma = device_get_ivars(dev);
 161         sc->mii_dev = device_get_parent(dev);
 162         mii = device_get_softc(sc->mii_dev);
 163
 164         /*
 165          * The 3Com PHY can never be isolated, so never allow non-zero
 166          * instances!
 167          */
 168         if (mii->mii_instance != 0) {
 169                 device_printf(dev, "ignoring this PHY, non-zero instance\n");
 170                 return(ENXIO);
 171         }
 172
 173         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 174
 175         sc->mii_inst = mii->mii_instance;
 176         sc->mii_phy = ma->mii_phyno;
 177         sc->mii_service = exphy_service;
 178         sc->mii_pdata = mii;
 179         mii->mii_instance++;
 180
 181         sc->mii_flags |= MIIF_NOISOLATE;
 182
 183 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 184
 185 #if 0 /* See above. */
 186         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 187             BMCR_ISO);
 188 #endif
 189
 190         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 191             BMCR_LOOP|BMCR_S100);
 192
 193         exphy_reset(sc);
 194
 195         sc->mii_capabilities =
 196             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 197         device_printf(dev, " ");
 198         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 199                 printf("no media present");
 200         else
 201                 mii_add_media(mii, sc->mii_capabilities,
 202                     sc->mii_inst);
 203         printf("\n");
 204 #undef ADD
 205         MIIBUS_MEDIAINIT(sc->mii_dev);
 206         return(0);
 207 }
 208
 209 static int exphy_detach(dev)
 210         device_t                dev;
 211 {
 212         struct mii_softc *sc;
 213         struct mii_data *mii;
 214
 215         sc = device_get_softc(dev);
 216         mii = device_get_softc(device_get_parent(dev));
 217         mii_phy_auto_stop(sc);
 218         sc->mii_dev = NULL;
 219         LIST_REMOVE(sc, mii_list);
 220
 221         return(0);
 222 }
 223
 224 int
 225 exphy_service(sc, mii, cmd)
 226         struct mii_softc *sc;
 227         struct mii_data *mii;
 228         int cmd;
 229 {
 230         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 231
 232         /*
 233          * We can't isolate the 3Com PHY, so it has to be the only one!
 234          */
 235         if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 236                 panic("exphy_service: can't isolate 3Com PHY");
 237
 238         switch (cmd) {
 239         case MII_POLLSTAT:
 240                 break;
 241
 242         case MII_MEDIACHG:
 243                 /*
 244                  * If the interface is not up, don't do anything.
 245                  */
 246                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 247                         break;
 248
 249                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 250                 case IFM_AUTO:
 251                         /*
 252                          * If we're already in auto mode, just return.
 253                          */
 254                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 255                                 return (0);
 256                         (void) mii_phy_auto(sc, 1);
 257                         break;
 258                 case IFM_100_T4:
 259                         /*
 260                          * XXX Not supported as a manual setting right now.
 261                          */
 262                         return (EINVAL);
 263                 default:
 264                         /*
 265                          * BMCR data is stored in the ifmedia entry.
 266                          */
 267                         PHY_WRITE(sc, MII_ANAR,
 268                             mii_anar(ife->ifm_media));
 269                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 270                 }
 271                 break;
 272
 273         case MII_TICK:
 274                 /*
 275                  * Only used for autonegotiation.
 276                  */
 277                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 278                         return (0);
 279
 280                 /*
 281                  * Is the interface even up?
 282                  */
 283                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 284                         return (0);
 285
 286                 /*
 287                  * The 3Com PHY's autonegotiation doesn't need to be
 288                  * kicked; it continues in the background.
 289                  */
 290                 break;
 291         }
 292
 293         /* Update the media status. */
 294         ukphy_status(sc);
 295
 296         /* Callback if something changed. */
 297         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 298                 MIIBUS_STATCHG(sc->mii_dev);
 299                 sc->mii_active = mii->mii_media_active;
 300         }
 301         return (0);
 302 }
 303
 304 void
 305 exphy_reset(sc)
 306         struct mii_softc *sc;
 307 {
 308
 309         mii_phy_reset(sc);
 310
 311         /*
 312          * XXX 3Com PHY doesn't set the BMCR properly after
 313          * XXX reset, which breaks autonegotiation.
 314          */
 315         PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_AUTOEN|BMCR_FDX);
 316 }