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