sys/dev/mii/nsphy.c

   1 /*      $NetBSD: nsphy.c,v 1.18 1999/07/14 23:57:36 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.
  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 #include <sys/cdefs.h>
  70 __FBSDID("$FreeBSD$");
  71
  72 /*
  73  * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
  74  * Data Sheet available from www.national.com
  75  */
  76
  77 #include <sys/param.h>
  78 #include <sys/systm.h>
  79 #include <sys/kernel.h>
  80 #include <sys/socket.h>
  81 #include <sys/errno.h>
  82 #include <sys/module.h>
  83 #include <sys/bus.h>
  84
  85 #include <net/if.h>
  86 #include <net/if_media.h>
  87
  88 #include <dev/mii/mii.h>
  89 #include <dev/mii/miivar.h>
  90 #include "miidevs.h"
  91
  92 #include <dev/mii/nsphyreg.h>
  93
  94 #include "miibus_if.h"
  95
  96 static int nsphy_probe(device_t);
  97 static int nsphy_attach(device_t);
  98
  99 static device_method_t nsphy_methods[] = {
 100         /* device interface */
 101         DEVMETHOD(device_probe,         nsphy_probe),
 102         DEVMETHOD(device_attach,        nsphy_attach),
 103         DEVMETHOD(device_detach,        mii_phy_detach),
 104         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 105         { 0, 0 }
 106 };
 107
 108 static devclass_t nsphy_devclass;
 109
 110 static driver_t nsphy_driver = {
 111         "nsphy",
 112         nsphy_methods,
 113         sizeof(struct mii_softc)
 114 };
 115
 116 DRIVER_MODULE(nsphy, miibus, nsphy_driver, nsphy_devclass, 0, 0);
 117
 118 static int      nsphy_service(struct mii_softc *, struct mii_data *, int);
 119 static void     nsphy_status(struct mii_softc *);
 120
 121 static int
 122 nsphy_probe(device_t dev)
 123 {
 124         struct mii_attach_args *ma;
 125
 126         ma = device_get_ivars(dev);
 127
 128         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI &&
 129             MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83840) {
 130                 device_set_desc(dev, MII_STR_NATSEMI_DP83840);
 131         } else
 132                 return (ENXIO);
 133
 134         return (0);
 135 }
 136
 137 static int
 138 nsphy_attach(device_t dev)
 139 {
 140         struct mii_softc *sc;
 141         struct mii_attach_args *ma;
 142         struct mii_data *mii;
 143
 144         sc = device_get_softc(dev);
 145         ma = device_get_ivars(dev);
 146         sc->mii_dev = device_get_parent(dev);
 147         mii = device_get_softc(sc->mii_dev);
 148         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 149
 150         sc->mii_inst = mii->mii_instance;
 151         sc->mii_phy = ma->mii_phyno;
 152         sc->mii_service = nsphy_service;
 153         sc->mii_pdata = mii;
 154
 155 #ifdef foo
 156         /*
 157          * i82557 wedges if all of its PHYs are isolated!
 158          */
 159         if (strcmp(device_get_name(device_get_parent(sc->mii_dev)),
 160             "fxp") == 0 && mii->mii_instance == 0)
 161 #endif
 162
 163         sc->mii_flags |= MIIF_NOISOLATE;
 164         mii->mii_instance++;
 165
 166 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
 167
 168 #if 0
 169         /* Can't do this on the i82557! */
 170         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
 171             BMCR_ISO);
 172 #endif
 173         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
 174             BMCR_LOOP|BMCR_S100);
 175
 176         mii_phy_reset(sc);
 177
 178         sc->mii_capabilities =
 179             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 180         device_printf(dev, " ");
 181         mii_add_media(sc);
 182         printf("\n");
 183 #undef ADD
 184
 185         MIIBUS_MEDIAINIT(sc->mii_dev);
 186         return(0);
 187 }
 188
 189 static int
 190 nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 191 {
 192         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 193         int reg;
 194         device_t parent;
 195
 196         switch (cmd) {
 197         case MII_POLLSTAT:
 198                 /*
 199                  * If we're not polling our PHY instance, just return.
 200                  */
 201                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 202                         return (0);
 203                 break;
 204
 205         case MII_MEDIACHG:
 206                 /*
 207                  * If the media indicates a different PHY instance,
 208                  * isolate ourselves.
 209                  */
 210                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 211                         reg = PHY_READ(sc, MII_BMCR);
 212                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 213                         return (0);
 214                 }
 215
 216                 /*
 217                  * If the interface is not up, don't do anything.
 218                  */
 219                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 220                         break;
 221
 222                 parent = device_get_parent(sc->mii_dev);
 223
 224                 reg = PHY_READ(sc, MII_NSPHY_PCR);
 225
 226                 /*
 227                  * Set up the PCR to use LED4 to indicate full-duplex
 228                  * in both 10baseT and 100baseTX modes.
 229                  */
 230                 reg |= PCR_LED4MODE;
 231
 232                 /*
 233                  * Make sure Carrier Integrity Monitor function is
 234                  * disabled (normal for Node operation, but sometimes
 235                  * it's not set?!)
 236                  */
 237                 reg |= PCR_CIMDIS;
 238
 239                 /*
 240                  * Make sure "force link good" is set to normal mode.
 241                  * It's only intended for debugging.
 242                  */
 243                 reg |= PCR_FLINK100;
 244
 245                 /*
 246                  * Mystery bits which are supposedly `reserved',
 247                  * but we seem to need to set them when the PHY
 248                  * is connected to some interfaces:
 249                  *
 250                  * 0x0400 is needed for fxp
 251                  *        (Intel EtherExpress Pro 10+/100B, 82557 chip)
 252                  *        (nsphy with a DP83840 chip)
 253                  * 0x0100 may be needed for some other card
 254                  */
 255                 reg |= 0x0100 | 0x0400;
 256
 257                 if (strcmp(device_get_name(parent), "fxp") == 0)
 258                         PHY_WRITE(sc, MII_NSPHY_PCR, reg);
 259
 260                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 261                 case IFM_AUTO:
 262                         /*
 263                          * If we're already in auto mode and don't hang off
 264                          * of a hme(4), just return. DP83840A on hme(4) don't
 265                          * advertise their media capabilities themselves
 266                          * properly so force writing the ANAR according to
 267                          * the BMSR by mii_phy_auto() every time.
 268                          */
 269                         if ((PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN) == 0 &&
 270                             strcmp(device_get_name(parent), "hme") != 0)
 271                                 return (0);
 272                         (void) mii_phy_auto(sc);
 273                         break;
 274                 case IFM_100_T4:
 275                         /*
 276                          * XXX Not supported as a manual setting right now.
 277                          */
 278                         return (EINVAL);
 279                 default:
 280                         /*
 281                          * BMCR data is stored in the ifmedia entry.
 282                          */
 283                         PHY_WRITE(sc, MII_ANAR,
 284                             mii_anar(ife->ifm_media));
 285                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
 286                 }
 287                 break;
 288
 289         case MII_TICK:
 290                 /*
 291                  * If we're not currently selected, just return.
 292                  */
 293                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 294                         return (0);
 295                 if (mii_phy_tick(sc) == EJUSTRETURN)
 296                         return (0);
 297                 break;
 298         }
 299
 300         /* Update the media status. */
 301         nsphy_status(sc);
 302
 303         /* Callback if something changed. */
 304         mii_phy_update(sc, cmd);
 305         return (0);
 306 }
 307
 308 static void
 309 nsphy_status(struct mii_softc *sc)
 310 {
 311         struct mii_data *mii = sc->mii_pdata;
 312         int bmsr, bmcr, par, anlpar;
 313
 314         mii->mii_media_status = IFM_AVALID;
 315         mii->mii_media_active = IFM_ETHER;
 316
 317         bmsr = PHY_READ(sc, MII_BMSR) |
 318             PHY_READ(sc, MII_BMSR);
 319         if (bmsr & BMSR_LINK)
 320                 mii->mii_media_status |= IFM_ACTIVE;
 321
 322         bmcr = PHY_READ(sc, MII_BMCR);
 323         if (bmcr & BMCR_ISO) {
 324                 mii->mii_media_active |= IFM_NONE;
 325                 mii->mii_media_status = 0;
 326                 return;
 327         }
 328
 329         if (bmcr & BMCR_LOOP)
 330                 mii->mii_media_active |= IFM_LOOP;
 331
 332         if (bmcr & BMCR_AUTOEN) {
 333                 /*
 334                  * The PAR status bits are only valid of autonegotiation
 335                  * has completed (or it's disabled).
 336                  */
 337                 if ((bmsr & BMSR_ACOMP) == 0) {
 338                         /* Erg, still trying, I guess... */
 339                         mii->mii_media_active |= IFM_NONE;
 340                         return;
 341                 }
 342
 343                 /*
 344                  * Argh.  The PAR doesn't seem to indicate duplex mode
 345                  * properly!  Determine media based on link partner's
 346                  * advertised capabilities.
 347                  */
 348                 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
 349                         anlpar = PHY_READ(sc, MII_ANAR) &
 350                             PHY_READ(sc, MII_ANLPAR);
 351                         if (anlpar & ANLPAR_T4)
 352                                 mii->mii_media_active |= IFM_100_T4;
 353                         else if (anlpar & ANLPAR_TX_FD)
 354                                 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 355                         else if (anlpar & ANLPAR_TX)
 356                                 mii->mii_media_active |= IFM_100_TX;
 357                         else if (anlpar & ANLPAR_10_FD)
 358                                 mii->mii_media_active |= IFM_10_T|IFM_FDX;
 359                         else if (anlpar & ANLPAR_10)
 360                                 mii->mii_media_active |= IFM_10_T;
 361                         else
 362                                 mii->mii_media_active |= IFM_NONE;
 363                         return;
 364                 }
 365
 366                 /*
 367                  * Link partner is not capable of autonegotiation.
 368                  * We will never be in full-duplex mode if this is
 369                  * the case, so reading the PAR is OK.
 370                  */
 371                 par = PHY_READ(sc, MII_NSPHY_PAR);
 372                 if (par & PAR_10)
 373                         mii->mii_media_active |= IFM_10_T;
 374                 else
 375                         mii->mii_media_active |= IFM_100_TX;
 376 #if 0
 377                 if (par & PAR_FDX)
 378                         mii->mii_media_active |= IFM_FDX;
 379 #endif
 380         } else
 381                 mii->mii_media_active |= mii_media_from_bmcr(bmcr);
 382 }