sys/dev/mii/tdkphy.c

   1 /*-
   2  * Copyright (c) 2000,2001 Jonathan Chen.
   3  * 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  *    without modification, immediately at the beginning of the file.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 /*
  33  * Driver for the TDK 78Q2120 MII
  34  *
  35  * References:
  36  *   Datasheet for the 78Q2120 - http://www.tsc.tdk.com/lan/78q2120.pdf
  37  *   Most of this code stolen from ukphy.c
  38  */
  39
  40 /*
  41  * The TDK 78Q2120 is found on some Xircom X3201 based cardbus cards,
  42  * also spotted on some 3C575 cards.  It's just like any other normal
  43  * phy, except it does auto negotiation in a different way.
  44  */
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/kernel.h>
  49 #include <sys/socket.h>
  50 #include <sys/errno.h>
  51 #include <sys/module.h>
  52 #include <sys/bus.h>
  53
  54 #include <net/if.h>
  55 #include <net/if_media.h>
  56
  57 #include <dev/mii/mii.h>
  58 #include <dev/mii/miivar.h>
  59 #include "miidevs.h"
  60
  61 #include <dev/mii/tdkphyreg.h>
  62
  63 #include "miibus_if.h"
  64
  65 static int tdkphy_probe(device_t);
  66 static int tdkphy_attach(device_t);
  67
  68 static device_method_t tdkphy_methods[] = {
  69         /* device interface */
  70         DEVMETHOD(device_probe,         tdkphy_probe),
  71         DEVMETHOD(device_attach,        tdkphy_attach),
  72         DEVMETHOD(device_detach,        mii_phy_detach),
  73         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  74         { 0, 0 }
  75 };
  76
  77 static devclass_t tdkphy_devclass;
  78
  79 static driver_t tdkphy_driver = {
  80         "tdkphy",
  81         tdkphy_methods,
  82         sizeof(struct mii_softc)
  83 };
  84
  85 DRIVER_MODULE(tdkphy, miibus, tdkphy_driver, tdkphy_devclass, 0, 0);
  86
  87 static int tdkphy_service(struct mii_softc *, struct mii_data *, int);
  88 static void tdkphy_status(struct mii_softc *);
  89
  90 static const struct mii_phydesc tdkphys[] = {
  91         MII_PHY_DESC(TDK, 78Q2120),
  92         MII_PHY_END
  93 };
  94
  95 static int
  96 tdkphy_probe(device_t dev)
  97 {
  98
  99         return (mii_phy_dev_probe(dev, tdkphys, BUS_PROBE_DEFAULT));
 100 }
 101
 102 static int
 103 tdkphy_attach(device_t dev)
 104 {
 105         struct mii_softc *sc;
 106         struct mii_attach_args *ma;
 107         struct mii_data *mii;
 108         sc = device_get_softc(dev);
 109         ma = device_get_ivars(dev);
 110         sc->mii_dev = device_get_parent(dev);
 111         mii = device_get_softc(sc->mii_dev);
 112         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 113
 114         if (bootverbose)
 115                 device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
 116                     MII_OUI(ma->mii_id1, ma->mii_id2),
 117                     MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
 118
 119         sc->mii_inst = mii->mii_instance;
 120         sc->mii_phy = ma->mii_phyno;
 121         sc->mii_service = tdkphy_service;
 122         sc->mii_pdata = mii;
 123
 124         mii->mii_instance++;
 125
 126         /*
 127          * Apparently, we can't do loopback on this PHY.
 128          */
 129         sc->mii_flags |= MIIF_NOLOOP;
 130
 131         mii_phy_reset(sc);
 132
 133         sc->mii_capabilities =
 134             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 135         device_printf(dev, " ");
 136         mii_phy_add_media(sc);
 137         printf("\n");
 138
 139         MIIBUS_MEDIAINIT(sc->mii_dev);
 140         return (0);
 141 }
 142
 143 static int
 144 tdkphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 145 {
 146         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 147         int reg;
 148
 149         switch (cmd) {
 150         case MII_POLLSTAT:
 151                 /*
 152                  * If we're not polling our PHY instance, just return.
 153                  */
 154                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 155                         return (0);
 156                 break;
 157
 158         case MII_MEDIACHG:
 159                 /*
 160                  * If the media indicates a different PHY instance,
 161                  * isolate ourselves.
 162                  */
 163                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
 164                         reg = PHY_READ(sc, MII_BMCR);
 165                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
 166                         return (0);
 167                 }
 168
 169                 /*
 170                  * If the interface is not up, don't do anything.
 171                  */
 172                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 173                         break;
 174
 175                 mii_phy_setmedia(sc);
 176                 break;
 177
 178         case MII_TICK:
 179                 /*
 180                  * If we're not currently selected, just return.
 181                  */
 182                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
 183                         return (0);
 184                 if (mii_phy_tick(sc) == EJUSTRETURN)
 185                         return (0);
 186                 break;
 187         }
 188
 189         /* Update the media status. */
 190         tdkphy_status(sc);
 191         if (sc->mii_pdata->mii_media_active & IFM_FDX)
 192                 PHY_WRITE(sc, MII_BMCR, PHY_READ(sc, MII_BMCR) | BMCR_FDX);
 193         else
 194                 PHY_WRITE(sc, MII_BMCR, PHY_READ(sc, MII_BMCR) & ~BMCR_FDX);
 195
 196         /* Callback if something changed. */
 197         mii_phy_update(sc, cmd);
 198         return (0);
 199 }
 200
 201 static void
 202 tdkphy_status(struct mii_softc *phy)
 203 {
 204         struct mii_data *mii = phy->mii_pdata;
 205         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 206         int bmsr, bmcr, anlpar, diag;
 207
 208         mii->mii_media_status = IFM_AVALID;
 209         mii->mii_media_active = IFM_ETHER;
 210
 211         bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
 212         if (bmsr & BMSR_LINK)
 213                 mii->mii_media_status |= IFM_ACTIVE;
 214
 215         bmcr = PHY_READ(phy, MII_BMCR);
 216         if (bmcr & BMCR_ISO) {
 217                 mii->mii_media_active |= IFM_NONE;
 218                 mii->mii_media_status = 0;
 219                 return;
 220         }
 221
 222         if (bmcr & BMCR_LOOP)
 223                 mii->mii_media_active |= IFM_LOOP;
 224
 225         if (bmcr & BMCR_AUTOEN) {
 226                 /*
 227                  * NWay autonegotiation takes the highest-order common
 228                  * bit of the ANAR and ANLPAR (i.e. best media advertised
 229                  * both by us and our link partner).
 230                  */
 231                 if ((bmsr & BMSR_ACOMP) == 0) {
 232                         /* Erg, still trying, I guess... */
 233                         mii->mii_media_active |= IFM_NONE;
 234                         return;
 235                 }
 236
 237                 anlpar = PHY_READ(phy, MII_ANAR) & PHY_READ(phy, MII_ANLPAR);
 238                 /*
 239                  * ANLPAR doesn't get set on my card, but we check it anyway,
 240                  * since it is mentioned in the 78Q2120 specs.
 241                  */
 242                 if (anlpar & ANLPAR_TX_FD)
 243                         mii->mii_media_active |= IFM_100_TX|IFM_FDX;
 244                 else if (anlpar & ANLPAR_T4)
 245                         mii->mii_media_active |= IFM_100_T4;
 246                 else if (anlpar & ANLPAR_TX)
 247                         mii->mii_media_active |= IFM_100_TX;
 248                 else if (anlpar & ANLPAR_10_FD)
 249                         mii->mii_media_active |= IFM_10_T|IFM_FDX;
 250                 else if (anlpar & ANLPAR_10)
 251                         mii->mii_media_active |= IFM_10_T;
 252                 else {
 253                         /*
 254                          * ANLPAR isn't set, which leaves two possibilities:
 255                          * 1) Auto negotiation failed
 256                          * 2) Auto negotiation completed, but the card forgot
 257                          *    to set ANLPAR.
 258                          * So we check the MII_DIAG(18) register...
 259                          */
 260                         diag = PHY_READ(phy, MII_DIAG);
 261                         if (diag & DIAG_NEGFAIL) /* assume 10baseT if no neg */
 262                                 mii->mii_media_active |= IFM_10_T;
 263                         else {
 264                                 if (diag & DIAG_DUPLEX)
 265                                         mii->mii_media_active |= IFM_FDX;
 266                                 if (diag & DIAG_RATE_100)
 267                                         mii->mii_media_active |= IFM_100_TX;
 268                                 else
 269                                         mii->mii_media_active |= IFM_10_T;
 270                         }
 271                 }
 272         } else
 273                 mii->mii_media_active = ife->ifm_media;
 274 }