/*-
 * SPDX-License-Identifier: BSD-4-Clause
 *
 * Copyright (c) 2004
 *      Bill Paul <wpaul@windriver.com>.  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.
 */

#include <sys/cdefs.h>
/*
 * Driver for the Cicada/Vitesse CS/VSC8xxx 10/100/1000 copper PHY.
 */

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

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

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

#include <dev/mii/ciphyreg.h>

#include "miibus_if.h"

#include <machine/bus.h>

static int ciphy_probe(device_t);
static int ciphy_attach(device_t);

static device_method_t ciphy_methods[] = {
        /* device interface */
        DEVMETHOD(device_probe,         ciphy_probe),
        DEVMETHOD(device_attach,        ciphy_attach),
        DEVMETHOD(device_detach,        mii_phy_detach),
        DEVMETHOD(device_shutdown,      bus_generic_shutdown),
        DEVMETHOD_END
};

static driver_t ciphy_driver = {
        "ciphy",
        ciphy_methods,
        sizeof(struct mii_softc)
};

DRIVER_MODULE(ciphy, miibus, ciphy_driver, 0, 0);

static int      ciphy_service(struct mii_softc *, struct mii_data *, int);
static void     ciphy_status(struct mii_softc *);
static void     ciphy_reset(struct mii_softc *);
static void     ciphy_fixup(struct mii_softc *);

static const struct mii_phydesc ciphys[] = {
        MII_PHY_DESC(xxCICADA, CS8201),
        MII_PHY_DESC(xxCICADA, CS8201A),
        MII_PHY_DESC(xxCICADA, CS8201B),
        MII_PHY_DESC(xxCICADA, CS8204),
        MII_PHY_DESC(xxCICADA, VSC8211),
        MII_PHY_DESC(xxCICADA, VSC8221),
        MII_PHY_DESC(xxCICADA, CS8244),
        MII_PHY_DESC(xxVITESSE, VSC8601),
        MII_PHY_DESC(xxVITESSE, VSC8641),
        MII_PHY_END
};

static const struct mii_phy_funcs ciphy_funcs = {
        ciphy_service,
        ciphy_status,
        ciphy_reset
};

static int
ciphy_probe(device_t dev)
{

        return (mii_phy_dev_probe(dev, ciphys, BUS_PROBE_DEFAULT));
}

static int
ciphy_attach(device_t dev)
{

        mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
            &ciphy_funcs, 1);
        return (0);
}

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

        switch (cmd) {
        case MII_POLLSTAT:
                break;

        case MII_MEDIACHG:
                ciphy_fixup(sc);        /* XXX hardware bug work-around */

                switch (IFM_SUBTYPE(ife->ifm_media)) {
                case IFM_AUTO:
#ifdef foo
                        /*
                         * If we're already in auto mode, just return.
                         */
                        if (PHY_READ(sc, CIPHY_MII_BMCR) & CIPHY_BMCR_AUTOEN)
                                return (0);
#endif
                        (void)mii_phy_auto(sc);
                        break;
                case IFM_1000_T:
                        speed = CIPHY_S1000;
                        goto setit;
                case IFM_100_TX:
                        speed = CIPHY_S100;
                        goto setit;
                case IFM_10_T:
                        speed = CIPHY_S10;
setit:
                        if ((ife->ifm_media & IFM_FDX) != 0) {
                                speed |= CIPHY_BMCR_FDX;
                                gig = CIPHY_1000CTL_AFD;
                        } else
                                gig = CIPHY_1000CTL_AHD;

                        if (IFM_SUBTYPE(ife->ifm_media) == IFM_1000_T) {
                                gig |= CIPHY_1000CTL_MSE;
                                if ((ife->ifm_media & IFM_ETH_MASTER) != 0)
                                        gig |= CIPHY_1000CTL_MSC;
                                speed |=
                                    CIPHY_BMCR_AUTOEN | CIPHY_BMCR_STARTNEG;
                        } else
                                gig = 0;
                        PHY_WRITE(sc, CIPHY_MII_1000CTL, gig);
                        PHY_WRITE(sc, CIPHY_MII_BMCR, speed);
                        PHY_WRITE(sc, CIPHY_MII_ANAR, CIPHY_SEL_TYPE);
                        break;
                case IFM_NONE:
                        PHY_WRITE(sc, MII_BMCR, BMCR_ISO | BMCR_PDOWN);
                        break;
                default:
                        return (EINVAL);
                }
                break;

        case MII_TICK:
                /*
                 * 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, MII_BMSR) | PHY_READ(sc, MII_BMSR);
                if (reg & BMSR_LINK)
                        break;

                /* Announce link loss right after it happens. */
                if (++sc->mii_ticks == 0)
                        break;
                /*
                 * Only retry autonegotiation every mii_anegticks seconds.
                 */
                if (sc->mii_ticks <= sc->mii_anegticks)
                        break;

                sc->mii_ticks = 0;
                mii_phy_auto(sc);
                break;
        }

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

        /*
         * Callback if something changed. Note that we need to poke
         * apply fixups for certain PHY revs.
         */
        if (sc->mii_media_active != mii->mii_media_active ||
            sc->mii_media_status != mii->mii_media_status ||
            cmd == MII_MEDIACHG) {
                ciphy_fixup(sc);
        }
        mii_phy_update(sc, cmd);
        return (0);
}

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

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

        bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);

        if (bmsr & BMSR_LINK)
                mii->mii_media_status |= IFM_ACTIVE;

        bmcr = PHY_READ(sc, CIPHY_MII_BMCR);

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

        if (bmcr & CIPHY_BMCR_AUTOEN) {
                if ((bmsr & CIPHY_BMSR_ACOMP) == 0) {
                        /* Erg, still trying, I guess... */
                        mii->mii_media_active |= IFM_NONE;
                        return;
                }
        }

        bmsr = PHY_READ(sc, CIPHY_MII_AUXCSR);
        switch (bmsr & CIPHY_AUXCSR_SPEED) {
        case CIPHY_SPEED10:
                mii->mii_media_active |= IFM_10_T;
                break;
        case CIPHY_SPEED100:
                mii->mii_media_active |= IFM_100_TX;
                break;
        case CIPHY_SPEED1000:
                mii->mii_media_active |= IFM_1000_T;
                break;
        default:
                device_printf(sc->mii_dev, "unknown PHY speed %x\n",
                    bmsr & CIPHY_AUXCSR_SPEED);
                break;
        }

        if (bmsr & CIPHY_AUXCSR_FDX)
                mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
        else
                mii->mii_media_active |= IFM_HDX;

        if ((IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) &&
           (PHY_READ(sc, CIPHY_MII_1000STS) & CIPHY_1000STS_MSR) != 0)
                mii->mii_media_active |= IFM_ETH_MASTER;
}

static void
ciphy_reset(struct mii_softc *sc)
{

        mii_phy_reset(sc);
        DELAY(1000);
}

#define PHY_SETBIT(x, y, z) \
        PHY_WRITE(x, y, (PHY_READ(x, y) | (z)))
#define PHY_CLRBIT(x, y, z) \
        PHY_WRITE(x, y, (PHY_READ(x, y) & ~(z)))

static void
ciphy_fixup(struct mii_softc *sc)
{
        uint16_t                model;
        uint16_t                status, speed;
        uint16_t                val;

        model = MII_MODEL(PHY_READ(sc, CIPHY_MII_PHYIDR2));
        status = PHY_READ(sc, CIPHY_MII_AUXCSR);
        speed = status & CIPHY_AUXCSR_SPEED;

        if (mii_phy_mac_match(sc, "nfe")) {
                /* need to set for 2.5V RGMII for NVIDIA adapters */
                val = PHY_READ(sc, CIPHY_MII_ECTL1);
                val &= ~(CIPHY_ECTL1_IOVOL | CIPHY_ECTL1_INTSEL);
                val |= (CIPHY_IOVOL_2500MV | CIPHY_INTSEL_RGMII);
                PHY_WRITE(sc, CIPHY_MII_ECTL1, val);
                /* From Linux. */
                val = PHY_READ(sc, CIPHY_MII_AUXCSR);
                val |= CIPHY_AUXCSR_MDPPS;
                PHY_WRITE(sc, CIPHY_MII_AUXCSR, val);
                val = PHY_READ(sc, CIPHY_MII_10BTCSR);
                val |= CIPHY_10BTCSR_ECHO;
                PHY_WRITE(sc, CIPHY_MII_10BTCSR, val);
        }

        switch (model) {
        case MII_MODEL_xxCICADA_CS8204:
        case MII_MODEL_xxCICADA_CS8201:

                /* Turn off "aux mode" (whatever that means) */
                PHY_SETBIT(sc, CIPHY_MII_AUXCSR, CIPHY_AUXCSR_MDPPS);

                /*
                 * Work around speed polling bug in VT3119/VT3216
                 * when using MII in full duplex mode.
                 */
                if ((speed == CIPHY_SPEED10 || speed == CIPHY_SPEED100) &&
                    (status & CIPHY_AUXCSR_FDX)) {
                        PHY_SETBIT(sc, CIPHY_MII_10BTCSR, CIPHY_10BTCSR_ECHO);
                } else {
                        PHY_CLRBIT(sc, CIPHY_MII_10BTCSR, CIPHY_10BTCSR_ECHO);
                }

                /* Enable link/activity LED blink. */
                PHY_SETBIT(sc, CIPHY_MII_LED, CIPHY_LED_LINKACTBLINK);

                break;

        case MII_MODEL_xxCICADA_CS8201A:
        case MII_MODEL_xxCICADA_CS8201B:

                /*
                 * Work around speed polling bug in VT3119/VT3216
                 * when using MII in full duplex mode.
                 */
                if ((speed == CIPHY_SPEED10 || speed == CIPHY_SPEED100) &&
                    (status & CIPHY_AUXCSR_FDX)) {
                        PHY_SETBIT(sc, CIPHY_MII_10BTCSR, CIPHY_10BTCSR_ECHO);
                } else {
                        PHY_CLRBIT(sc, CIPHY_MII_10BTCSR, CIPHY_10BTCSR_ECHO);
                }

                break;
        case MII_MODEL_xxCICADA_VSC8211:
        case MII_MODEL_xxCICADA_VSC8221:
        case MII_MODEL_xxCICADA_CS8244:
        case MII_MODEL_xxVITESSE_VSC8601:
        case MII_MODEL_xxVITESSE_VSC8641:
                break;
        default:
                device_printf(sc->mii_dev, "unknown CICADA PHY model %x\n",
                    model);
                break;
        }
}