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.8 2005/10/24 16:55:40 dillon 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, ma);
 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_service = amphy_service;
 122         sc->mii_pdata = mii;
 123
 124         sc->mii_flags |= MIIF_NOISOLATE;
 125         mii->mii_instance++;
 126
 127 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 128
 129         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 130             BMCR_ISO);
 131 #if 0
 132         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 133             BMCR_LOOP|BMCR_S100);
 134 #endif
 135
 136         mii_phy_reset(sc);
 137
 138         sc->mii_capabilities =
 139             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 140         device_printf(dev, " ");
 141         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 142                 printf("no media present");
 143         else
 144                 mii_add_media(sc, sc->mii_capabilities);
 145         printf("\n");
 146 #undef ADD
 147         MIIBUS_MEDIAINIT(sc->mii_dev);
 148         return(0);
 149 }
 150
 151 static int amphy_detach(dev)
 152         device_t                dev;
 153 {
 154         struct mii_softc *sc;
 155         struct mii_data *mii;
 156
 157         sc = device_get_softc(dev);
 158         mii = device_get_softc(device_get_parent(dev));
 159         mii_phy_auto_stop(sc);
 160         sc->mii_dev = NULL;
 161         LIST_REMOVE(sc, mii_list);
 162
 163         return(0);
 164 }
 165 int
 166 amphy_service(sc, mii, cmd)
 167         struct mii_softc *sc;
 168         struct mii_data *mii;
 169         int cmd;
 170 {
 171         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 172         int reg;
 173
 174         switch (cmd) {
 175         case MII_POLLSTAT:
 176                 /*
 177                  * If we're not polling our PHY instance, just return.
 178                  */
 179                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 180                         return (0);
 181                 break;
 182
 183         case MII_MEDIACHG:
 184                 /*
 185                  * If the media indicates a different PHY instance,
 186                  * isolate ourselves.
 187                  */
 188                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 189                         reg = PHY_READ(sc, MII_BMCR);
 190                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 191                         return (0);
 192                 }
 193
 194                 /*
 195                  * If the interface is not up, don't do anything.
 196                  */
 197                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 198                         break;
 199
 200                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 201                 case IFM_AUTO:
 202                         /*
 203                          * If we're already in auto mode, just return.
 204                          */
 205                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 206                                 return (0);
 207                         (void) mii_phy_auto(sc, 1);
 208                         break;
 209                 case IFM_100_T4:
 210                         /*
 211                          * XXX Not supported as a manual setting right now.
 212                          */
 213                         return (EINVAL);
 214                 default:
 215                         /*
 216                          * BMCR data is stored in the ifmedia entry.
 217                          */
 218                         PHY_WRITE(sc, MII_ANAR,
 219                             mii_anar(ife->ifm_media));
 220                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 221                 }
 222                 break;
 223
 224         case MII_TICK:
 225                 /*
 226                  * If we're not currently selected, just return.
 227                  */
 228                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 229                         return (0);
 230
 231                 /*
 232                  * Only used for autonegotiation.
 233                  */
 234                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 235                         return (0);
 236
 237                 /*
 238                  * Is the interface even up?
 239                  */
 240                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 241                         return (0);
 242
 243                 /*
 244                  * Only retry autonegotiation every 5 seconds.
 245                  */
 246                 if (++sc->mii_ticks != 5)
 247                         return (0);
 248
 249                 sc->mii_ticks = 0;
 250
 251                 /*
 252                  * Check to see if we have link.  If we do, we don't
 253                  * need to restart the autonegotiation process.  Read
 254                  * the BMSR twice in case it's latched.
 255                  */
 256                 reg = PHY_READ(sc, MII_BMSR) |
 257                     PHY_READ(sc, MII_BMSR);
 258                 if (reg & BMSR_LINK)
 259                         break;
 260
 261                 mii_phy_reset(sc);
 262                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 263                         return(0);
 264                 break;
 265         }
 266
 267         /* Update the media status. */
 268         amphy_status(sc);
 269
 270         /* Callback if something changed. */
 271         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 272                 MIIBUS_STATCHG(sc->mii_dev);
 273                 sc->mii_active = mii->mii_media_active;
 274         }
 275         return (0);
 276 }
 277
 278 void
 279 amphy_status(sc)
 280         struct mii_softc *sc;
 281 {
 282         struct mii_data *mii = sc->mii_pdata;
 283         int bmsr, bmcr, par, anlpar;
 284
 285         mii->mii_media_status = IFM_AVALID;
 286         mii->mii_media_active = IFM_ETHER;
 287
 288         bmsr = PHY_READ(sc, MII_BMSR) |
 289             PHY_READ(sc, MII_BMSR);
 290         if (bmsr & BMSR_LINK)
 291                 mii->mii_media_status |= IFM_ACTIVE;
 292
 293         bmcr = PHY_READ(sc, MII_BMCR);
 294         if (bmcr & BMCR_ISO) {
 295                 mii->mii_media_active |= IFM_NONE;
 296                 mii->mii_media_status = 0;
 297                 return;
 298         }
 299
 300         if (bmcr & BMCR_LOOP)
 301                 mii->mii_media_active |= IFM_LOOP;
 302
 303         if (bmcr & BMCR_AUTOEN) {
 304                 /*
 305                  * The PAR status bits are only valid of autonegotiation
 306                  * has completed (or it's disabled).
 307                  */
 308                 if ((bmsr & BMSR_ACOMP) == 0) {
 309                         /* Erg, still trying, I guess... */
 310                         mii->mii_media_active |= IFM_NONE;
 311                         return;
 312                 }
 313
 314                 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
 315                         anlpar = PHY_READ(sc, MII_ANAR) &
 316                             PHY_READ(sc, MII_ANLPAR);
 317                         if (anlpar & ANLPAR_T4)
 318                                 mii->mii_media_active |= IFM_100_T4;
 319                         else if (anlpar & ANLPAR_TX_FD)
 320                                 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 321                         else if (anlpar & ANLPAR_TX)
 322                                 mii->mii_media_active |= IFM_100_TX;
 323                         else if (anlpar & ANLPAR_10_FD)
 324                                 mii->mii_media_active |= IFM_10_T|IFM_FDX;
 325                         else if (anlpar & ANLPAR_10)
 326                                 mii->mii_media_active |= IFM_10_T;
 327                         else
 328                                 mii->mii_media_active |= IFM_NONE;
 329                         return;
 330                 }
 331
 332                 /*
 333                  * Link partner is not capable of autonegotiation.
 334                  */
 335                 par = PHY_READ(sc, MII_AMPHY_DSCSR);
 336                 if (par & DSCSR_100FDX)
 337                         mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 338                 else if (par & DSCSR_100HDX)
 339                         mii->mii_media_active |= IFM_100_TX;
 340                 else if (par & DSCSR_10FDX)
 341                         mii->mii_media_active |= IFM_10_T|IFM_HDX;
 342                 else if (par & DSCSR_10HDX)
 343                         mii->mii_media_active |= IFM_10_T;
 344         } else
 345                 mii->mii_media_active = mii_media_from_bmcr(bmcr);
 346 }