/*      $NetBSD: gphyter.c,v 1.37 2020/03/15 23:04:50 thorpej Exp $     */

/*-
 * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
 * NASA Ames Research Center.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * driver for National Semiconductor's DP83891, DP83861 and DP83865
 * `Gig PHYTER' ethernet 10/100/1000 PHYs.  The DP83891 is an older,
 * non-firmware-driven version of the DP83861.  The DP83865 is a low
 * power version of the DP83861.
 *
 * Data Sheets available from www.national.com:
 *   http://www.national.com/ds/DP/DP83861.pdf
 *   http://www.national.com/ds/DP/DP83865.pdf
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: gphyter.c,v 1.37 2020/03/15 23:04:50 thorpej Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/device.h>
#include <sys/socket.h>
#include <sys/errno.h>

#include <net/if.h>
#include <net/if_media.h>

#include <dev/mii/mii.h>
#include <dev/mii/miivar.h>
#include <dev/mii/miidevs.h>

#include <dev/mii/gphyterreg.h>

static int      gphytermatch(device_t, cfdata_t, void *);
static void     gphyterattach(device_t, device_t, void *);

CFATTACH_DECL_NEW(gphyter, sizeof(struct mii_softc),
    gphytermatch, gphyterattach, mii_phy_detach, mii_phy_activate);

static int      gphyter_service(struct mii_softc *, struct mii_data *, int);
static void     gphyter_status(struct mii_softc *);
static void     gphyter_reset(struct mii_softc *);

static const struct mii_phy_funcs gphyter_funcs = {
        gphyter_service, gphyter_status, gphyter_reset,
};

static const struct mii_phydesc gphyters[] = {
        MII_PHY_DESC(xxNATSEMI, DP83861),
        MII_PHY_DESC(xxNATSEMI, DP83865),
        MII_PHY_DESC(xxNATSEMI, DP83891),
        MII_PHY_END,
};

static int
gphytermatch(device_t parent, cfdata_t match, void *aux)
{
        struct mii_attach_args *ma = aux;

        if (mii_phy_match(ma, gphyters) != NULL)
                return 10;

        return 0;
}

static void
gphyterattach(device_t parent, device_t self, void *aux)
{
        struct mii_softc *sc = device_private(self);
        struct mii_attach_args *ma = aux;
        struct mii_data *mii = ma->mii_data;
        const struct mii_phydesc *mpd;
        uint16_t anar, strap;

        mpd = mii_phy_match(ma, gphyters);
        aprint_naive(": Media interface\n");
        aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));

        sc->mii_dev = self;
        sc->mii_inst = mii->mii_instance;
        sc->mii_phy = ma->mii_phyno;
        sc->mii_funcs = &gphyter_funcs;
        sc->mii_pdata = mii;
        sc->mii_flags = ma->mii_flags;

        mii_lock(mii);

        PHY_RESET(sc);

        PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
        sc->mii_capabilities &= ma->mii_capmask;
        if (sc->mii_capabilities & BMSR_EXTSTAT)
                PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);

        /*
         * The Gig PHYTER seems to have the 10baseT BMSR bits hard-wired to 0,
         * even though the device supports 10baseT. What we do instead is read
         * the post-reset ANAR, who's 10baseT-related bits are set by strapping
         * pin 180, and fake the BMSR bits.
         */
        PHY_READ(sc, MII_ANAR, &anar);
        if (anar & ANAR_10)
                sc->mii_capabilities |= (BMSR_10THDX & ma->mii_capmask);
        if (anar & ANAR_10_FD)
                sc->mii_capabilities |= (BMSR_10TFDX & ma->mii_capmask);

        mii_unlock(mii);

        mii_phy_add_media(sc);

        mii_lock(mii);
        PHY_READ(sc, MII_GPHYTER_STRAP, &strap);
        mii_unlock(mii);
        aprint_normal_dev(self, "strapped to %s mode",
            (strap & STRAP_MS_VAL) ? "master" : "slave");
        if (strap & STRAP_NC_MODE)
                aprint_normal(", pre-C5 BCM5400 compat enabled");
        aprint_normal("\n");
}

static int
gphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
{
        struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
        uint16_t reg;

        KASSERT(mii_locked(mii));

        switch (cmd) {
        case MII_POLLSTAT:
                /* If we're not polling our PHY instance, just return. */
                if (IFM_INST(ife->ifm_media) != sc->mii_inst)
                        return 0;
                break;

        case MII_MEDIACHG:
                /*
                 * If the media indicates a different PHY instance,
                 * isolate ourselves.
                 */
                if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
                        PHY_READ(sc, MII_BMCR, &reg);
                        PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
                        return 0;
                }

                /* If the interface is not up, don't do anything. */
                if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
                        break;

                mii_phy_setmedia(sc);
                break;

        case MII_TICK:
                /* If we're not currently selected, just return. */
                if (IFM_INST(ife->ifm_media) != sc->mii_inst)
                        return 0;

                if (mii_phy_tick(sc) == EJUSTRETURN)
                        return 0;
                break;

        case MII_DOWN:
                mii_phy_down(sc);
                return 0;
        }

        /* Update the media status. */
        mii_phy_status(sc);

        /* Callback if something changed. */
        mii_phy_update(sc, cmd);
        return 0;
}

static void
gphyter_status(struct mii_softc *sc)
{
        struct mii_data *mii = sc->mii_pdata;
        struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
        uint16_t bmsr, bmcr, physup, gtsr;

        KASSERT(mii_locked(mii));

        mii->mii_media_status = IFM_AVALID;
        mii->mii_media_active = IFM_ETHER;

        PHY_READ(sc, MII_BMSR, &bmsr);
        PHY_READ(sc, MII_BMSR, &bmsr);

        PHY_READ(sc, MII_GPHYTER_PHY_SUP, &physup);

        if (physup & PHY_SUP_LINK)
                mii->mii_media_status |= IFM_ACTIVE;

        PHY_READ(sc, MII_BMCR, &bmcr);
        if (bmcr & BMCR_ISO) {
                mii->mii_media_active |= IFM_NONE;
                mii->mii_media_status = 0;
                return;
        }

        if (bmcr & BMCR_LOOP)
                mii->mii_media_active |= IFM_LOOP;

        if (bmcr & BMCR_AUTOEN) {
                /*
                 * The media status bits are only valid if autonegotiation
                 * has completed (or it's disabled).
                 */
                if ((bmsr & BMSR_ACOMP) == 0) {
                        /* Erg, still trying, I guess... */
                        mii->mii_media_active |= IFM_NONE;
                        return;
                }

                switch (physup & (PHY_SUP_SPEED1 | PHY_SUP_SPEED0)) {
                case PHY_SUP_SPEED1:
                        mii->mii_media_active |= IFM_1000_T;
                        PHY_READ(sc, MII_100T2SR, &gtsr);
                        if (gtsr & GTSR_MS_RES)
                                mii->mii_media_active |= IFM_ETH_MASTER;
                        break;

                case PHY_SUP_SPEED0:
                        mii->mii_media_active |= IFM_100_TX;
                        break;

                case 0:
                        mii->mii_media_active |= IFM_10_T;
                        break;

                default:
                        mii->mii_media_active |= IFM_NONE;
                        mii->mii_media_status = 0;
                }
                if (physup & PHY_SUP_DUPLEX)
                        mii->mii_media_active |=
                            IFM_FDX | mii_phy_flowstatus(sc);
                else
                        mii->mii_media_active |= IFM_HDX;
        } else
                mii->mii_media_active = ife->ifm_media;
}

void
gphyter_reset(struct mii_softc *sc)
{
        int i;
        uint16_t reg;

        KASSERT(mii_locked(sc->mii_pdata));

        if (sc->mii_flags & MIIF_NOISOLATE)
                reg = BMCR_RESET;
        else
                reg = BMCR_RESET | BMCR_ISO;
        PHY_WRITE(sc, MII_BMCR, reg);

        /*
         * It is best to allow a little time for the reset to settle in before
         * we start polling the BMCR again.  Notably, the DP83840A manual
         * states that there should be a 500us delay between asserting software
         * reset and attempting MII serial operations. Also, a DP83815 can get
         * into a bad state on cable removal and reinsertion if we do not
         * delay here.
         */
        delay(500);

        /* Wait another 100ms for it to complete. */
        for (i = 0; i < 100; i++) {
                PHY_READ(sc, MII_BMCR, &reg);
                if ((reg & BMCR_RESET) == 0)
                        break;
                delay(1000);
        }

        if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
                PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
}