sys/dev/mii/rdcphy.c

   1 /*-
   2  * Copyright (c) 2010, Pyun YongHyeon <yongari@FreeBSD.org>
   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 unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 /*
  32  * Driver for the RDC Semiconductor R6040 10/100 PHY.
  33  */
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/kernel.h>
  38 #include <sys/module.h>
  39 #include <sys/socket.h>
  40 #include <sys/bus.h>
  41
  42 #include <net/if.h>
  43 #include <net/if_media.h>
  44
  45 #include <dev/mii/mii.h>
  46 #include <dev/mii/miivar.h>
  47 #include "miidevs.h"
  48
  49 #include <dev/mii/rdcphyreg.h>
  50
  51 #include "miibus_if.h"
  52
  53 static device_probe_t   rdcphy_probe;
  54 static device_attach_t  rdcphy_attach;
  55
  56 struct rdcphy_softc {
  57         struct mii_softc mii_sc;
  58         int mii_model;
  59         int mii_link_tick;
  60 #define RDCPHY_MANNEG_TICK      3
  61 };
  62
  63 static device_method_t rdcphy_methods[] = {
  64         /* device interface */
  65         DEVMETHOD(device_probe,         rdcphy_probe),
  66         DEVMETHOD(device_attach,        rdcphy_attach),
  67         DEVMETHOD(device_detach,        mii_phy_detach),
  68         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  69         KOBJMETHOD_END
  70 };
  71
  72 static devclass_t rdcphy_devclass;
  73
  74 static driver_t rdcphy_driver = {
  75         "rdcphy",
  76         rdcphy_methods,
  77         sizeof(struct rdcphy_softc)
  78 };
  79
  80 DRIVER_MODULE(rdcphy, miibus, rdcphy_driver, rdcphy_devclass, 0, 0);
  81
  82 static int      rdcphy_service(struct mii_softc *, struct mii_data *, int);
  83 static void     rdcphy_status(struct mii_softc *);
  84
  85 static const struct mii_phydesc rdcphys[] = {
  86         MII_PHY_DESC(RDC, R6040),
  87         MII_PHY_END
  88 };
  89
  90 static int
  91 rdcphy_probe(device_t dev)
  92 {
  93
  94         return (mii_phy_dev_probe(dev, rdcphys, BUS_PROBE_DEFAULT));
  95 }
  96
  97 static int
  98 rdcphy_attach(device_t dev)
  99 {
 100         struct rdcphy_softc *rsc;
 101         struct mii_softc *sc;
 102         struct mii_attach_args *ma;
 103         struct mii_data *mii;
 104
 105         rsc = device_get_softc(dev);
 106         sc = &rsc->mii_sc;
 107         ma = device_get_ivars(dev);
 108         sc->mii_dev = device_get_parent(dev);
 109         mii = ma->mii_data;
 110         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
 111
 112         sc->mii_flags = miibus_get_flags(dev);
 113         sc->mii_inst = mii->mii_instance++;
 114         sc->mii_phy = ma->mii_phyno;
 115         sc->mii_service = rdcphy_service;
 116         sc->mii_pdata = mii;
 117
 118         sc->mii_flags |= MIIF_NOMANPAUSE;
 119
 120         rsc->mii_model = MII_MODEL(ma->mii_id2);
 121         if (bootverbose)
 122                 device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
 123                     MII_OUI(ma->mii_id1, ma->mii_id2), MII_MODEL(ma->mii_id2),
 124                     MII_REV(ma->mii_id2));
 125
 126         mii_phy_reset(sc);
 127
 128         sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
 129         if (sc->mii_capabilities & BMSR_EXTSTAT)
 130                 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
 131         device_printf(dev, " ");
 132         mii_phy_add_media(sc);
 133         printf("\n");
 134
 135         MIIBUS_MEDIAINIT(sc->mii_dev);
 136         return (0);
 137 }
 138
 139 static int
 140 rdcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 141 {
 142         struct rdcphy_softc *rsc;
 143         struct ifmedia_entry *ife;
 144
 145         rsc = (struct rdcphy_softc *)sc;
 146         ife = mii->mii_media.ifm_cur;
 147
 148         switch (cmd) {
 149         case MII_POLLSTAT:
 150                 break;
 151
 152         case MII_MEDIACHG:
 153                 /*
 154                  * If the interface is not up, don't do anything.
 155                  */
 156                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
 157                         break;
 158
 159                 mii_phy_setmedia(sc);
 160                 switch (IFM_SUBTYPE(ife->ifm_media)) {
 161                 case IFM_100_TX:
 162                 case IFM_10_T:
 163                         /*
 164                          * Report fake lost link event to parent
 165                          * driver.  This will stop MAC of parent
 166                          * driver and make it possible to reconfigure
 167                          * MAC after completion of link establishment.
 168                          * Note, the parent MAC seems to require
 169                          * restarting MAC when underlying any PHY
 170                          * configuration was changed even if the
 171                          * resolved speed/duplex was not changed at
 172                          * all.
 173                          */
 174                         mii->mii_media_status = 0;
 175                         mii->mii_media_active = IFM_ETHER | IFM_NONE;
 176                         rsc->mii_link_tick = RDCPHY_MANNEG_TICK;
 177                         /* Immediately report link down. */
 178                         mii_phy_update(sc, MII_MEDIACHG);
 179                         return (0);
 180                 default:
 181                         break;
 182                 }
 183                 break;
 184
 185         case MII_TICK:
 186                 if (mii_phy_tick(sc) == EJUSTRETURN)
 187                         return (0);
 188                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
 189                         /*
 190                          * It seems the PHY hardware does not correctly
 191                          * report link status changes when manual link
 192                          * configuration is in progress.  It is also
 193                          * possible for the PHY to complete establishing
 194                          * a link within one second such that mii(4)
 195                          * did not notice the link change.  To workaround
 196                          * the issue, emulate lost link event and wait
 197                          * for 3 seconds when manual link configuration
 198                          * is in progress.  3 seconds would be long
 199                          * enough to absorb transient link flips.
 200                          */
 201                         if (rsc->mii_link_tick > 0) {
 202                                 rsc->mii_link_tick--;
 203                                 return (0);
 204                         }
 205                 }
 206                 break;
 207         }
 208
 209         /* Update the media status. */
 210         rdcphy_status(sc);
 211
 212         /* Callback if something changed. */
 213         mii_phy_update(sc, cmd);
 214         return (0);
 215 }
 216
 217 static void
 218 rdcphy_status(struct mii_softc *sc)
 219 {
 220         struct mii_data *mii;
 221         struct ifmedia_entry *ife;
 222         int bmsr, bmcr, physts;
 223
 224         mii = sc->mii_pdata;
 225         ife = mii->mii_media.ifm_cur;
 226
 227         mii->mii_media_status = IFM_AVALID;
 228         mii->mii_media_active = IFM_ETHER;
 229
 230         bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
 231         physts = PHY_READ(sc, MII_RDCPHY_STATUS);
 232
 233         if ((physts & STATUS_LINK_UP) != 0)
 234                 mii->mii_media_status |= IFM_ACTIVE;
 235
 236         bmcr = PHY_READ(sc, MII_BMCR);
 237         if ((bmcr & BMCR_ISO) != 0) {
 238                 mii->mii_media_active |= IFM_NONE;
 239                 mii->mii_media_status = 0;
 240                 return;
 241         }
 242
 243         if ((bmcr & BMCR_LOOP) != 0)
 244                 mii->mii_media_active |= IFM_LOOP;
 245
 246         if ((bmcr & BMCR_AUTOEN) != 0) {
 247                 if ((bmsr & BMSR_ACOMP) == 0) {
 248                         /* Erg, still trying, I guess... */
 249                         mii->mii_media_active |= IFM_NONE;
 250                         return;
 251                 }
 252         }
 253
 254         switch (physts & STATUS_SPEED_MASK) {
 255         case STATUS_SPEED_100:
 256                 mii->mii_media_active |= IFM_100_TX;
 257                 break;
 258         case STATUS_SPEED_10:
 259                 mii->mii_media_active |= IFM_10_T;
 260                 break;
 261         default:
 262                 mii->mii_media_active |= IFM_NONE;
 263                 return;
 264         }
 265         if ((physts & STATUS_FULL_DUPLEX) != 0)
 266                 mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
 267         else
 268                 mii->mii_media_active |= IFM_HDX;
 269 }