sys/dev/mii/icsphy.c

   1 /*      $NetBSD: icsphy.c,v 1.41 2006/11/16 21:24:07 christos Exp $     */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD
   5  *
   6  * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to The NetBSD Foundation
  10  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
  11  * NASA Ames Research Center.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 /*
  36  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  48  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  49  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  50  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  51  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  52  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  53  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  54  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  55  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  56  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  57  */
  58
  59 #include <sys/cdefs.h>
  60 __FBSDID("$FreeBSD$");
  61
  62 /*
  63  * driver for Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY
  64  * datasheet from www.icst.com
  65  */
  66
  67 #include <sys/param.h>
  68 #include <sys/systm.h>
  69 #include <sys/kernel.h>
  70 #include <sys/module.h>
  71 #include <sys/socket.h>
  72 #include <sys/bus.h>
  73
  74 #include <net/if.h>
  75 #include <net/if_media.h>
  76
  77 #include <dev/mii/mii.h>
  78 #include <dev/mii/miivar.h>
  79 #include "miidevs.h"
  80
  81 #include <dev/mii/icsphyreg.h>
  82
  83 #include "miibus_if.h"
  84
  85 static int      icsphy_probe(device_t dev);
  86 static int      icsphy_attach(device_t dev);
  87
  88 static device_method_t icsphy_methods[] = {
  89         /* device interface */
  90         DEVMETHOD(device_probe,         icsphy_probe),
  91         DEVMETHOD(device_attach,        icsphy_attach),
  92         DEVMETHOD(device_detach,        mii_phy_detach),
  93         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  94         DEVMETHOD_END
  95 };
  96
  97 static devclass_t icsphy_devclass;
  98
  99 static driver_t icsphy_driver = {
 100         "icsphy",
 101         icsphy_methods,
 102         sizeof(struct mii_softc)
 103 };
 104
 105 DRIVER_MODULE(icsphy, miibus, icsphy_driver, icsphy_devclass, 0, 0);
 106
 107 static int      icsphy_service(struct mii_softc *, struct mii_data *, int);
 108 static void     icsphy_status(struct mii_softc *);
 109 static void     icsphy_reset(struct mii_softc *);
 110
 111 static const struct mii_phydesc icsphys[] = {
 112         MII_PHY_DESC(ICS, 1889),
 113         MII_PHY_DESC(ICS, 1890),
 114         MII_PHY_DESC(ICS, 1892),
 115         MII_PHY_DESC(ICS, 1893),
 116         MII_PHY_END
 117 };
 118
 119 static const struct mii_phy_funcs icsphy_funcs = {
 120         icsphy_service,
 121         icsphy_status,
 122         icsphy_reset
 123 };
 124
 125 static int
 126 icsphy_probe(device_t dev)
 127 {
 128
 129         return (mii_phy_dev_probe(dev, icsphys, BUS_PROBE_DEFAULT));
 130 }
 131
 132 static int
 133 icsphy_attach(device_t dev)
 134 {
 135
 136         mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
 137             &icsphy_funcs, 1);
 138         return (0);
 139 }
 140
 141 static int
 142 icsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
 143 {
 144
 145         switch (cmd) {
 146         case MII_POLLSTAT:
 147                 break;
 148
 149         case MII_MEDIACHG:
 150                 mii_phy_setmedia(sc);
 151                 break;
 152
 153         case MII_TICK:
 154                 if (mii_phy_tick(sc) == EJUSTRETURN)
 155                         return (0);
 156                 break;
 157         }
 158
 159         /* Update the media status. */
 160         PHY_STATUS(sc);
 161
 162         /* Callback if something changed. */
 163         mii_phy_update(sc, cmd);
 164         return (0);
 165 }
 166
 167 static void
 168 icsphy_status(struct mii_softc *sc)
 169 {
 170         struct mii_data *mii = sc->mii_pdata;
 171         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
 172         int bmcr, qpr;
 173
 174         mii->mii_media_status = IFM_AVALID;
 175         mii->mii_media_active = IFM_ETHER;
 176
 177         /*
 178          * Don't get link from the BMSR.  It's available in the QPR,
 179          * and we have to read it twice to unlatch it anyhow.  This
 180          * gives us fewer register reads.
 181          */
 182         qpr = PHY_READ(sc, MII_ICSPHY_QPR);             /* unlatch */
 183         qpr = PHY_READ(sc, MII_ICSPHY_QPR);             /* real value */
 184
 185         if (qpr & QPR_LINK)
 186                 mii->mii_media_status |= IFM_ACTIVE;
 187
 188         bmcr = PHY_READ(sc, MII_BMCR);
 189         if (bmcr & BMCR_ISO) {
 190                 mii->mii_media_active |= IFM_NONE;
 191                 mii->mii_media_status = 0;
 192                 return;
 193         }
 194
 195         if (bmcr & BMCR_LOOP)
 196                 mii->mii_media_active |= IFM_LOOP;
 197
 198         if (bmcr & BMCR_AUTOEN) {
 199                 if ((qpr & QPR_ACOMP) == 0) {
 200                         /* Erg, still trying, I guess... */
 201                         mii->mii_media_active |= IFM_NONE;
 202                         return;
 203                 }
 204                 if (qpr & QPR_SPEED)
 205                         mii->mii_media_active |= IFM_100_TX;
 206                 else
 207                         mii->mii_media_active |= IFM_10_T;
 208                 if (qpr & QPR_FDX)
 209                         mii->mii_media_active |=
 210                             IFM_FDX | mii_phy_flowstatus(sc);
 211                 else
 212                         mii->mii_media_active |= IFM_HDX;
 213         } else
 214                 mii->mii_media_active = ife->ifm_media;
 215 }
 216
 217 static void
 218 icsphy_reset(struct mii_softc *sc)
 219 {
 220
 221         mii_phy_reset(sc);
 222         /* set powerdown feature */
 223         switch (sc->mii_mpd_model) {
 224                 case MII_MODEL_ICS_1890:
 225                 case MII_MODEL_ICS_1893:
 226                         PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
 227                         break;
 228                 case MII_MODEL_ICS_1892:
 229                         PHY_WRITE(sc, MII_ICSPHY_ECR2,
 230                             ECR2_10AUTOPWRDN|ECR2_100AUTOPWRDN);
 231                         break;
 232                 default:
 233                         /* 1889 have no ECR2 */
 234                         break;
 235         }
 236         /*
 237          * There is no description that the reset do auto-negotiation in the
 238          * data sheet.
 239          */
 240         PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_STARTNEG|BMCR_FDX);
 241 }