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.4 2003/08/27 09:38:31 rob Exp $
  34  *
  35  * $FreeBSD: src/sys/dev/mii/amphy.c,v 1.2.2.2 2002/11/08 21:53:49 semenu Exp $
  36  */
  37
  38 /*
  39  * driver for AMD AM79c873 PHYs
  40  * This driver also works for the Davicom DM9101 PHY, which appears to
  41  * be an AM79c873 workalike.
  42  */
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/kernel.h>
  47 #include <sys/socket.h>
  48 #include <sys/bus.h>
  49
  50 #include <net/if.h>
  51 #include <net/if_media.h>
  52
  53 #include "mii.h"
  54 #include "miivar.h"
  55 #include "miidevs.h"
  56
  57 #include "amphyreg.h"
  58
  59 #include "miibus_if.h"
  60
  61 static int amphy_probe          (device_t);
  62 static int amphy_attach         (device_t);
  63 static int amphy_detach         (device_t);
  64
  65 static device_method_t amphy_methods[] = {
  66         /* device interface */
  67         DEVMETHOD(device_probe,         amphy_probe),
  68         DEVMETHOD(device_attach,        amphy_attach),
  69         DEVMETHOD(device_detach,        amphy_detach),
  70         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  71         { 0, 0 }
  72 };
  73
  74 static devclass_t amphy_devclass;
  75
  76 static driver_t amphy_driver = {
  77         "amphy",
  78         amphy_methods,
  79         sizeof(struct mii_softc)
  80 };
  81
  82 DRIVER_MODULE(amphy, miibus, amphy_driver, amphy_devclass, 0, 0);
  83
  84 int     amphy_service (struct mii_softc *, struct mii_data *, int);
  85 void    amphy_status (struct mii_softc *);
  86
  87 static int amphy_probe(dev)
  88         device_t                dev;
  89 {
  90         struct mii_attach_args *ma;
  91
  92         ma = device_get_ivars(dev);
  93
  94         if ((MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxAMD ||
  95             MII_MODEL(ma->mii_id2) != MII_MODEL_xxAMD_79C873) &&
  96             (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxDAVICOM ||
  97             MII_MODEL(ma->mii_id2) != MII_MODEL_xxDAVICOM_DM9101))
  98                 return(ENXIO);
  99
 100         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxAMD)
 101                 device_set_desc(dev, MII_STR_xxAMD_79C873);
 102         else if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxDAVICOM)
 103                 device_set_desc(dev, MII_STR_xxDAVICOM_DM9101);
 104
 105         return(0);
 106 }
 107
 108 static int amphy_attach(dev)
 109         device_t                dev;
 110 {
 111         struct mii_softc *sc;
 112         struct mii_attach_args *ma;
 113         struct mii_data *mii;
 114
 115         sc = device_get_softc(dev);
 116         ma = device_get_ivars(dev);
 117         sc->mii_dev = device_get_parent(dev);
 118         mii = device_get_softc(sc->mii_dev);
 119         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 120
 121         sc->mii_inst = mii->mii_instance;
 122         sc->mii_phy = ma->mii_phyno;
 123         sc->mii_service = amphy_service;
 124         sc->mii_pdata = mii;
 125
 126         sc->mii_flags |= MIIF_NOISOLATE;
 127         mii->mii_instance++;
 128
 129 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 130
 131         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 132             BMCR_ISO);
 133 #if 0
 134         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 135             BMCR_LOOP|BMCR_S100);
 136 #endif
 137
 138         mii_phy_reset(sc);
 139
 140         sc->mii_capabilities =
 141             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 142         device_printf(dev, " ");
 143         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
 144                 printf("no media present");
 145         else
 146                 mii_add_media(mii, sc->mii_capabilities,
 147                     sc->mii_inst);
 148         printf("\n");
 149 #undef ADD
 150         MIIBUS_MEDIAINIT(sc->mii_dev);
 151         return(0);
 152 }
 153
 154 static int amphy_detach(dev)
 155         device_t                dev;
 156 {
 157         struct mii_softc *sc;
 158         struct mii_data *mii;
 159
 160         sc = device_get_softc(dev);
 161         mii = device_get_softc(device_get_parent(dev));
 162         mii_phy_auto_stop(sc);
 163         sc->mii_dev = NULL;
 164         LIST_REMOVE(sc, mii_list);
 165
 166         return(0);
 167 }
 168 int
 169 amphy_service(sc, mii, cmd)
 170         struct mii_softc *sc;
 171         struct mii_data *mii;
 172         int cmd;
 173 {
 174         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 175         int reg;
 176
 177         switch (cmd) {
 178         case MII_POLLSTAT:
 179                 /*
 180                  * If we're not polling our PHY instance, just return.
 181                  */
 182                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 183                         return (0);
 184                 break;
 185
 186         case MII_MEDIACHG:
 187                 /*
 188                  * If the media indicates a different PHY instance,
 189                  * isolate ourselves.
 190                  */
 191                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 192                         reg = PHY_READ(sc, MII_BMCR);
 193                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 194                         return (0);
 195                 }
 196
 197                 /*
 198                  * If the interface is not up, don't do anything.
 199                  */
 200                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 201                         break;
 202
 203                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 204                 case IFM_AUTO:
 205                         /*
 206                          * If we're already in auto mode, just return.
 207                          */
 208                         if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
 209                                 return (0);
 210                         (void) mii_phy_auto(sc, 1);
 211                         break;
 212                 case IFM_100_T4:
 213                         /*
 214                          * XXX Not supported as a manual setting right now.
 215                          */
 216                         return (EINVAL);
 217                 default:
 218                         /*
 219                          * BMCR data is stored in the ifmedia entry.
 220                          */
 221                         PHY_WRITE(sc, MII_ANAR,
 222                             mii_anar(ife->ifm_media));
 223                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 224                 }
 225                 break;
 226
 227         case MII_TICK:
 228                 /*
 229                  * If we're not currently selected, just return.
 230                  */
 231                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 232                         return (0);
 233
 234                 /*
 235                  * Only used for autonegotiation.
 236                  */
 237                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
 238                         return (0);
 239
 240                 /*
 241                  * Is the interface even up?
 242                  */
 243                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 244                         return (0);
 245
 246                 /*
 247                  * Only retry autonegotiation every 5 seconds.
 248                  */
 249                 if (++sc->mii_ticks != 5)
 250                         return (0);
 251
 252                 sc->mii_ticks = 0;
 253
 254                 /*
 255                  * Check to see if we have link.  If we do, we don't
 256                  * need to restart the autonegotiation process.  Read
 257                  * the BMSR twice in case it's latched.
 258                  */
 259                 reg = PHY_READ(sc, MII_BMSR) |
 260                     PHY_READ(sc, MII_BMSR);
 261                 if (reg & BMSR_LINK)
 262                         break;
 263
 264                 mii_phy_reset(sc);
 265                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
 266                         return(0);
 267                 break;
 268         }
 269
 270         /* Update the media status. */
 271         amphy_status(sc);
 272
 273         /* Callback if something changed. */
 274         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
 275                 MIIBUS_STATCHG(sc->mii_dev);
 276                 sc->mii_active = mii->mii_media_active;
 277         }
 278         return (0);
 279 }
 280
 281 void
 282 amphy_status(sc)
 283         struct mii_softc *sc;
 284 {
 285         struct mii_data *mii = sc->mii_pdata;
 286         int bmsr, bmcr, par, anlpar;
 287
 288         mii->mii_media_status = IFM_AVALID;
 289         mii->mii_media_active = IFM_ETHER;
 290
 291         bmsr = PHY_READ(sc, MII_BMSR) |
 292             PHY_READ(sc, MII_BMSR);
 293         if (bmsr & BMSR_LINK)
 294                 mii->mii_media_status |= IFM_ACTIVE;
 295
 296         bmcr = PHY_READ(sc, MII_BMCR);
 297         if (bmcr & BMCR_ISO) {
 298                 mii->mii_media_active |= IFM_NONE;
 299                 mii->mii_media_status = 0;
 300                 return;
 301         }
 302
 303         if (bmcr & BMCR_LOOP)
 304                 mii->mii_media_active |= IFM_LOOP;
 305
 306         if (bmcr & BMCR_AUTOEN) {
 307                 /*
 308                  * The PAR status bits are only valid of autonegotiation
 309                  * has completed (or it's disabled).
 310                  */
 311                 if ((bmsr & BMSR_ACOMP) == 0) {
 312                         /* Erg, still trying, I guess... */
 313                         mii->mii_media_active |= IFM_NONE;
 314                         return;
 315                 }
 316
 317                 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
 318                         anlpar = PHY_READ(sc, MII_ANAR) &
 319                             PHY_READ(sc, MII_ANLPAR);
 320                         if (anlpar & ANLPAR_T4)
 321                                 mii->mii_media_active |= IFM_100_T4;
 322                         else if (anlpar & ANLPAR_TX_FD)
 323                                 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 324                         else if (anlpar & ANLPAR_TX)
 325                                 mii->mii_media_active |= IFM_100_TX;
 326                         else if (anlpar & ANLPAR_10_FD)
 327                                 mii->mii_media_active |= IFM_10_T|IFM_FDX;
 328                         else if (anlpar & ANLPAR_10)
 329                                 mii->mii_media_active |= IFM_10_T;
 330                         else
 331                                 mii->mii_media_active |= IFM_NONE;
 332                         return;
 333                 }
 334
 335                 /*
 336                  * Link partner is not capable of autonegotiation.
 337                  */
 338                 par = PHY_READ(sc, MII_AMPHY_DSCSR);
 339                 if (par & DSCSR_100FDX)
 340                         mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 341                 else if (par & DSCSR_100HDX)
 342                         mii->mii_media_active |= IFM_100_TX;
 343                 else if (par & DSCSR_10FDX)
 344                         mii->mii_media_active |= IFM_10_T|IFM_HDX;
 345                 else if (par & DSCSR_10HDX)
 346                         mii->mii_media_active |= IFM_10_T;
 347         } else
 348                 mii->mii_media_active = mii_media_from_bmcr(bmcr);
 349 }