sys/dev/netif/mii_layer/amphy.c

   1 /*
   2  * Copyright (c) 1997, 1998, 1999
   3  *      Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * $FreeBSD: src/sys/dev/mii/amphy.c,v 1.2.2.2 2002/11/08 21:53:49 semenu Exp $
  33  * $DragonFly: src/sys/dev/netif/mii_layer/amphy.c,v 1.6 2005/02/21 18:40:36 joerg Exp $
  34  */
  35
  36 /*
  37  * driver for AMD AM79c873 PHYs
  38  * This driver also works for the Davicom DM9101 PHY, which appears to
  39  * be an AM79c873 workalike.
  40  */
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/kernel.h>
  45 #include <sys/socket.h>
  46 #include <sys/bus.h>
  47
  48 #include <net/if.h>
  49 #include <net/if_media.h>
  50
  51 #include "mii.h"
  52 #include "miivar.h"
  53 #include "miidevs.h"
  54
  55 #include "amphyreg.h"
  56
  57 #include "miibus_if.h"
  58
  59 static int amphy_probe          (device_t);
  60 static int amphy_attach         (device_t);
  61 static int amphy_detach         (device_t);
  62
  63 static device_method_t amphy_methods[] = {
  64         /* device interface */
  65         DEVMETHOD(device_probe,         amphy_probe),
  66         DEVMETHOD(device_attach,        amphy_attach),
  67         DEVMETHOD(device_detach,        amphy_detach),
  68         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  69         { 0, 0 }
  70 };
  71
  72 static devclass_t amphy_devclass;
  73
  74 static driver_t amphy_driver = {
  75         "amphy",
  76         amphy_methods,
  77         sizeof(struct mii_softc)
  78 };
  79
  80 DRIVER_MODULE(amphy, miibus, amphy_driver, amphy_devclass, 0, 0);
  81
  82 int     amphy_service (struct mii_softc *, struct mii_data *, int);
  83 void    amphy_status (struct mii_softc *);
  84
  85 static int amphy_probe(dev)
  86         device_t                dev;
  87 {
  88         struct mii_attach_args *ma;
  89
  90         ma = device_get_ivars(dev);
  91
  92         if ((MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxAMD ||
  93             MII_MODEL(ma->mii_id2) != MII_MODEL_xxAMD_79C873) &&
  94             (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxDAVICOM ||
  95             MII_MODEL(ma->mii_id2) != MII_MODEL_xxDAVICOM_DM9101))
  96                 return(ENXIO);
  97
  98         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxAMD)
  99                 device_set_desc(dev, MII_STR_xxAMD_79C873);
 100         else if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxDAVICOM)
 101                 device_set_desc(dev, MII_STR_xxDAVICOM_DM9101);
 102
 103         return(0);
 104 }
 105
 106 static int amphy_attach(dev)
 107         device_t                dev;
 108 {
 109         struct mii_softc *sc;
 110         struct mii_attach_args *ma;
 111         struct mii_data *mii;
 112
 113         sc = device_get_softc(dev);
 114         ma = device_get_ivars(dev);
 115         mii_softc_init(sc);
 116         sc->mii_dev = device_get_parent(dev);
 117         mii = device_get_softc(sc->mii_dev);
 118         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 119
 120         sc->mii_inst = mii->mii_instance;
 121         sc->mii_phy = ma->mii_phyno;
 122         sc->mii_service = amphy_service;
 123         sc->mii_pdata = mii;
 124
 125         sc->mii_flags |= MIIF_NOISOLATE;
 126         mii->mii_instance++;
 127
 128 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 129
 130         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 131             BMCR_ISO);
 132 #if 0
 133         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 134             BMCR_LOOP|BMCR_S100);
 135 #endif
 136
 137         mii_phy_reset(sc);
 138
 139         sc->mii_capabilities =
 140             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 141         device_printf(dev, " ");
 142         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 143                 printf("no media present");
 144         else
 145                 mii_add_media(mii, sc->mii_capabilities,
 146                     sc->mii_inst);
 147         printf("\n");
 148 #undef ADD
 149         MIIBUS_MEDIAINIT(sc->mii_dev);
 150         return(0);
 151 }
 152
 153 static int amphy_detach(dev)
 154         device_t                dev;
 155 {
 156         struct mii_softc *sc;
 157         struct mii_data *mii;
 158
 159         sc = device_get_softc(dev);
 160         mii = device_get_softc(device_get_parent(dev));
 161         mii_phy_auto_stop(sc);
 162         sc->mii_dev = NULL;
 163         LIST_REMOVE(sc, mii_list);
 164
 165         return(0);
 166 }
 167 int
 168 amphy_service(sc, mii, cmd)
 169         struct mii_softc *sc;
 170         struct mii_data *mii;
 171         int cmd;
 172 {
 173         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 174         int reg;
 175
 176         switch (cmd) {
 177         case MII_POLLSTAT:
 178                 /*
 179                  * If we're not polling our PHY instance, just return.
 180                  */
 181                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 182                         return (0);
 183                 break;
 184
 185         case MII_MEDIACHG:
 186                 /*
 187                  * If the media indicates a different PHY instance,
 188                  * isolate ourselves.
 189                  */
 190                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 191                         reg = PHY_READ(sc, MII_BMCR);
 192                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 193                         return (0);
 194                 }
 195
 196                 /*
 197                  * If the interface is not up, don't do anything.
 198                  */
 199                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 200                         break;
 201
 202                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 203                 case IFM_AUTO:
 204                         /*
 205                          * If we're already in auto mode, just return.
 206                          */
 207                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 208                                 return (0);
 209                         (void) mii_phy_auto(sc, 1);
 210                         break;
 211                 case IFM_100_T4:
 212                         /*
 213                          * XXX Not supported as a manual setting right now.
 214                          */
 215                         return (EINVAL);
 216                 default:
 217                         /*
 218                          * BMCR data is stored in the ifmedia entry.
 219                          */
 220                         PHY_WRITE(sc, MII_ANAR,
 221                             mii_anar(ife->ifm_media));
 222                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 223                 }
 224                 break;
 225
 226         case MII_TICK:
 227                 /*
 228                  * If we're not currently selected, just return.
 229                  */
 230                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 231                         return (0);
 232
 233                 /*
 234                  * Only used for autonegotiation.
 235                  */
 236                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 237                         return (0);
 238
 239                 /*
 240                  * Is the interface even up?
 241                  */
 242                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 243                         return (0);
 244
 245                 /*
 246                  * Only retry autonegotiation every 5 seconds.
 247                  */
 248                 if (++sc->mii_ticks != 5)
 249                         return (0);
 250
 251                 sc->mii_ticks = 0;
 252
 253                 /*
 254                  * Check to see if we have link.  If we do, we don't
 255                  * need to restart the autonegotiation process.  Read
 256                  * the BMSR twice in case it's latched.
 257                  */
 258                 reg = PHY_READ(sc, MII_BMSR) |
 259                     PHY_READ(sc, MII_BMSR);
 260                 if (reg & BMSR_LINK)
 261                         break;
 262
 263                 mii_phy_reset(sc);
 264                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 265                         return(0);
 266                 break;
 267         }
 268
 269         /* Update the media status. */
 270         amphy_status(sc);
 271
 272         /* Callback if something changed. */
 273         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 274                 MIIBUS_STATCHG(sc->mii_dev);
 275                 sc->mii_active = mii->mii_media_active;
 276         }
 277         return (0);
 278 }
 279
 280 void
 281 amphy_status(sc)
 282         struct mii_softc *sc;
 283 {
 284         struct mii_data *mii = sc->mii_pdata;
 285         int bmsr, bmcr, par, anlpar;
 286
 287         mii->mii_media_status = IFM_AVALID;
 288         mii->mii_media_active = IFM_ETHER;
 289
 290         bmsr = PHY_READ(sc, MII_BMSR) |
 291             PHY_READ(sc, MII_BMSR);
 292         if (bmsr & BMSR_LINK)
 293                 mii->mii_media_status |= IFM_ACTIVE;
 294
 295         bmcr = PHY_READ(sc, MII_BMCR);
 296         if (bmcr & BMCR_ISO) {
 297                 mii->mii_media_active |= IFM_NONE;
 298                 mii->mii_media_status = 0;
 299                 return;
 300         }
 301
 302         if (bmcr & BMCR_LOOP)
 303                 mii->mii_media_active |= IFM_LOOP;
 304
 305         if (bmcr & BMCR_AUTOEN) {
 306                 /*
 307                  * The PAR status bits are only valid of autonegotiation
 308                  * has completed (or it's disabled).
 309                  */
 310                 if ((bmsr & BMSR_ACOMP) == 0) {
 311                         /* Erg, still trying, I guess... */
 312                         mii->mii_media_active |= IFM_NONE;
 313                         return;
 314                 }
 315
 316                 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
 317                         anlpar = PHY_READ(sc, MII_ANAR) &
 318                             PHY_READ(sc, MII_ANLPAR);
 319                         if (anlpar & ANLPAR_T4)
 320                                 mii->mii_media_active |= IFM_100_T4;
 321                         else if (anlpar & ANLPAR_TX_FD)
 322                                 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 323                         else if (anlpar & ANLPAR_TX)
 324                                 mii->mii_media_active |= IFM_100_TX;
 325                         else if (anlpar & ANLPAR_10_FD)
 326                                 mii->mii_media_active |= IFM_10_T|IFM_FDX;
 327                         else if (anlpar & ANLPAR_10)
 328                                 mii->mii_media_active |= IFM_10_T;
 329                         else
 330                                 mii->mii_media_active |= IFM_NONE;
 331                         return;
 332                 }
 333
 334                 /*
 335                  * Link partner is not capable of autonegotiation.
 336                  */
 337                 par = PHY_READ(sc, MII_AMPHY_DSCSR);
 338                 if (par & DSCSR_100FDX)
 339                         mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 340                 else if (par & DSCSR_100HDX)
 341                         mii->mii_media_active |= IFM_100_TX;
 342                 else if (par & DSCSR_10FDX)
 343                         mii->mii_media_active |= IFM_10_T|IFM_HDX;
 344                 else if (par & DSCSR_10HDX)
 345                         mii->mii_media_active |= IFM_10_T;
 346         } else
 347                 mii->mii_media_active = mii_media_from_bmcr(bmcr);
 348 }