/*
 * Copyright (c) 2000
 *      Bill Paul <wpaul@ee.columbia.edu>.  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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Bill Paul.
 * 4. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD
 * 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.
 *
 * $FreeBSD: src/sys/dev/mii/xmphy.c,v 1.1.2.5 2002/11/08 21:53:49 semenu Exp $
 */

/*
 * driver for the XaQti XMAC II's internal PHY. This is sort of
 * like a 10/100 PHY, except the only thing we're really autoselecting
 * here is full/half duplex. Speed is always 1000mbps.
 */

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

#include <machine/clock.h>

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

#include "mii.h"
#include "miivar.h"
#include "miidevs.h"

#include "xmphyreg.h"

#include "miibus_if.h"

static int xmphy_probe          (device_t);
static int xmphy_attach         (device_t);

static device_method_t xmphy_methods[] = {
        /* device interface */
        DEVMETHOD(device_probe,         xmphy_probe),
        DEVMETHOD(device_attach,        xmphy_attach),
        DEVMETHOD(device_detach,        ukphy_detach),
        DEVMETHOD(device_shutdown,      bus_generic_shutdown),
        DEVMETHOD_END
};

static const struct mii_phydesc xmphys[] = {
        MII_PHYDESC(xxXAQTI,    XMACII),
        MII_PHYDESC(JATO,       BASEX),
        MII_PHYDESC_NULL
};

static devclass_t xmphy_devclass;

static driver_t xmphy_driver = {
        "xmphy",
        xmphy_methods,
        sizeof(struct mii_softc)
};

DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, NULL, NULL);

static int      xmphy_service(struct mii_softc *, struct mii_data *, int);
static void     xmphy_status(struct mii_softc *);

static int      xmphy_mii_phy_auto(struct mii_softc *, int);

static int
xmphy_probe(device_t dev)
{
        struct mii_attach_args *ma = device_get_ivars(dev);
        const struct mii_phydesc *mpd;

        mpd = mii_phy_match(ma, xmphys);
        if (mpd != NULL) {
                device_set_desc(dev, mpd->mpd_name);
                return (0);
        }
        return (ENXIO);
}

static int
xmphy_attach(device_t dev)
{
        struct mii_softc *sc;
        struct mii_attach_args *ma;
        struct mii_data *mii;
        const char *sep = "";

        sc = device_get_softc(dev);
        ma = device_get_ivars(dev);
        mii_softc_init(sc, ma);
        sc->mii_dev = device_get_parent(dev);
        mii = device_get_softc(sc->mii_dev);
        LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);

        sc->mii_inst = mii->mii_instance;
        sc->mii_service = xmphy_service;
        sc->mii_reset = mii_phy_reset;
        sc->mii_pdata = mii;

        sc->mii_flags |= MIIF_NOISOLATE;
        mii->mii_instance++;

#define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
#define PRINT(s)        kprintf("%s%s", sep, s); sep = ", "

        ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
            BMCR_ISO);
#if 0
        ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
            BMCR_LOOP|BMCR_S100);
#endif

        mii_phy_reset(sc);

        device_printf(dev, " ");
        ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
            XMPHY_BMCR_FDX);
        PRINT("1000baseSX");
        ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
        PRINT("1000baseSX-FDX");
        ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
        PRINT("auto");

        kprintf("\n");
#undef ADD
#undef PRINT

        MIIBUS_MEDIAINIT(sc->mii_dev);
        return(0);
}

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

        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) {
                        reg = PHY_READ(sc, MII_BMCR);
                        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;

                switch (IFM_SUBTYPE(ife->ifm_media)) {
                case IFM_AUTO:
#ifdef foo
                        /*
                         * If we're already in auto mode, just return.
                         */
                        if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
                                return (0);
#endif
                        xmphy_mii_phy_auto(sc, 1);
                        break;
                case IFM_1000_SX:
                        mii_phy_reset(sc);
                        if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
                                PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
                                PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
                        } else {
                                PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
                                PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
                        }
                        break;
                case IFM_100_T4:
                case IFM_100_TX:
                case IFM_10_T:
                default:
                        return (EINVAL);
                }
                break;

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

                /*
                 * Is the interface even up?
                 */
                if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
                        return (0);

                /*
                 * Only used for autonegotiation.
                 */
                if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
                        break;

                /*
                 * Check to see if we have link.  If we do, we don't
                 * need to restart the autonegotiation process.  Read
                 * the BMSR twice in case it's latched.
                 */
                reg = PHY_READ(sc, XMPHY_MII_BMSR) |
                    PHY_READ(sc, XMPHY_MII_BMSR);
                if (reg & XMPHY_BMSR_LINK) {
                        sc->mii_ticks = 0;
                        break;
                }

                /*
                 * Only retry autonegotiation every mii_anegticks seconds.
                 */
                if (++sc->mii_ticks <= sc->mii_anegticks)
                        return (0);
                
                sc->mii_ticks = 0;

                mii_phy_reset(sc);
                if (xmphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
                        return(0);
                break;
        }

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

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

static void
xmphy_status(struct mii_softc *sc)
{
        struct mii_data *mii = sc->mii_pdata;
        int bmsr, bmcr, anlpar;

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

        bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
            PHY_READ(sc, XMPHY_MII_BMSR);
        if (bmsr & XMPHY_BMSR_LINK)
                mii->mii_media_status |= IFM_ACTIVE;

        /* Do dummy read of extended status register. */
        bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);

        bmcr = PHY_READ(sc, XMPHY_MII_BMCR);

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

        if (bmcr & XMPHY_BMCR_AUTOEN) {
                if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
                        if (bmsr & XMPHY_BMSR_LINK) {
                                mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
                                return;
                        }
                        /* Erg, still trying, I guess... */
                        mii->mii_media_active |= IFM_NONE;
                        return;
                }

                mii->mii_media_active |= IFM_1000_SX;
                anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
                    PHY_READ(sc, XMPHY_MII_ANLPAR);
                if (anlpar & XMPHY_ANLPAR_FDX)
                        mii->mii_media_active |= IFM_FDX;
                else
                        mii->mii_media_active |= IFM_HDX;
                return;
        }

        mii->mii_media_active |= IFM_1000_SX;
        if (bmcr & XMPHY_BMCR_FDX)
                mii->mii_media_active |= IFM_FDX;
        else
                mii->mii_media_active |= IFM_HDX;
}

static int
xmphy_mii_phy_auto(struct mii_softc *sc, int waitfor)
{
        int bmsr, anar = 0, i;

        anar = PHY_READ(sc, XMPHY_MII_ANAR);
        anar |= XMPHY_ANAR_FDX | XMPHY_ANAR_HDX;
        PHY_WRITE(sc, XMPHY_MII_ANAR, anar);
        DELAY(1000);
        PHY_WRITE(sc, XMPHY_MII_BMCR,
            XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);

        if (waitfor) {
                /* Wait 500ms for it to complete. */
                for (i = 0; i < 500; i++) {
                        bmsr = PHY_READ(sc, XMPHY_MII_BMSR);
                        if (bmsr & XMPHY_BMSR_ACOMP)
                                return (0);
                        DELAY(1000);
                }
                return (EIO);
        }
        return (EJUSTRETURN);
}