/*      $NetBSD: igphy.c,v 1.37 2020/11/04 09:15:10 msaitoh Exp $       */

/*
 * The Intel copyright applies to the analog register setup, and the
 * SmartSpeed workaround code.
 */

/*******************************************************************************

  Copyright (c) 2001-2003, Intel Corporation
  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. Neither the name of the Intel Corporation nor the names of its
      contributors may be used to endorse or promote products derived from
      this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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) 1998, 1999, 2000, 2003 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, and by Frank van der Linden.
 *
 * 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.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: igphy.c,v 1.37 2020/11/04 09:15:10 msaitoh Exp $");

#ifdef _KERNEL_OPT
#include "opt_mii.h"
#endif

#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/igphyreg.h>
#include <dev/mii/igphyvar.h>
#include <dev/pci/if_wmvar.h>

static void igphy_reset(struct mii_softc *);
static void igphy_load_dspcode(struct mii_softc *);
static void igphy_load_dspcode_igp3(struct mii_softc *);
static void igphy_smartspeed_workaround(struct mii_softc *sc);

static int      igphymatch(device_t, cfdata_t, void *);
static void     igphyattach(device_t, device_t, void *);

CFATTACH_DECL_NEW(igphy, sizeof(struct igphy_softc),
    igphymatch, igphyattach, mii_phy_detach, mii_phy_activate);

static int      igphy_service(struct mii_softc *, struct mii_data *, int);
static void     igphy_status(struct mii_softc *);

static const struct mii_phy_funcs igphy_funcs = {
        igphy_service, igphy_status, igphy_reset,
};

static const struct mii_phydesc igphys[] = {
        MII_PHY_DESC(yyINTEL, IGP01E1000),
        MII_PHY_DESC(yyINTEL, I82566),
        MII_PHY_END,
};

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

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

        return 0;
}

static void
igphyattach(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;
        struct igphy_softc *igsc = (struct igphy_softc *)sc;
        prop_dictionary_t dict;

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

        dict = device_properties(parent);
        if (!prop_dictionary_get_uint32(dict, "mactype", &igsc->sc_mactype))
                aprint_error("WARNING! Failed to get mactype\n");
        if (!prop_dictionary_get_uint32(dict, "macflags", &igsc->sc_macflags))
                aprint_error("WARNING! Failed to get macflags\n");

        sc->mii_dev = self;
        sc->mii_inst = mii->mii_instance;
        sc->mii_phy = ma->mii_phyno;
        sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
        sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
        sc->mii_mpd_rev = MII_REV(ma->mii_id2);
        sc->mii_funcs = &igphy_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);

        mii_unlock(mii);

        mii_phy_add_media(sc);
}

typedef struct {
        int reg;
        uint16_t val;
} dspcode;

static const dspcode igp1code[] = {
        { 0x1f95, 0x0001 },
        { 0x1f71, 0xbd21 },
        { 0x1f79, 0x0018 },
        { 0x1f30, 0x1600 },
        { 0x1f31, 0x0014 },
        { 0x1f32, 0x161c },
        { 0x1f94, 0x0003 },
        { 0x1f96, 0x003f },
        { 0x2010, 0x0008 },
        { 0, 0 },
};

static const dspcode igp1code_r2[] = {
        { 0x1f73, 0x0099 },
        { 0, 0 },
};

static const dspcode igp3code[] = {
        { 0x2f5b, 0x9018},
        { 0x2f52, 0x0000},
        { 0x2fb1, 0x8b24},
        { 0x2fb2, 0xf8f0},
        { 0x2010, 0x10b0},
        { 0x2011, 0x0000},
        { 0x20dd, 0x249a},
        { 0x20de, 0x00d3},
        { 0x28b4, 0x04ce},
        { 0x2f70, 0x29e4},
        { 0x0000, 0x0140},
        { 0x1f30, 0x1606},
        { 0x1f31, 0xb814},
        { 0x1f35, 0x002a},
        { 0x1f3e, 0x0067},
        { 0x1f54, 0x0065},
        { 0x1f55, 0x002a},
        { 0x1f56, 0x002a},
        { 0x1f72, 0x3fb0},
        { 0x1f76, 0xc0ff},
        { 0x1f77, 0x1dec},
        { 0x1f78, 0xf9ef},
        { 0x1f79, 0x0210},
        { 0x1895, 0x0003},
        { 0x1796, 0x0008},
        { 0x1798, 0xd008},
        { 0x1898, 0xd918},
        { 0x187a, 0x0800},
        { 0x0019, 0x008d},
        { 0x001b, 0x2080},
        { 0x0014, 0x0045},
        { 0x0000, 0x1340},
        { 0, 0 },
};

/* DSP patch for igp1 and igp2 */
static void
igphy_load_dspcode(struct mii_softc *sc)
{
        struct igphy_softc *igsc = (struct igphy_softc *)sc;
        const dspcode *code;
        uint16_t reg;
        int i;

        /* This workaround is only for 82541 and 82547 */
        switch (igsc->sc_mactype) {
        case WM_T_82541:
        case WM_T_82547:
                code = igp1code;
                break;
        case WM_T_82541_2:
        case WM_T_82547_2:
                code = igp1code_r2;
                break;
        default:
                return; /* byebye */
        }

        /* Delay after phy reset to enable NVM configuration to load */
        delay(20000);

        /*
         * Save off the current value of register 0x2F5B to be restored at
         * the end of this routine.
         */
        IGPHY_READ(sc, 0x2f5b, &reg);

        /* Disabled the PHY transmitter */
        IGPHY_WRITE(sc, 0x2f5b, 0x0003);

        delay(20000);

        PHY_WRITE(sc, IGPHY_PAGE_SELECT, 0x0000);
        PHY_WRITE(sc, 0x0000, 0x0140);

        delay(5000);

        for (i = 0; !((code[i].reg == 0) && (code[i].val == 0)); i++)
                IGPHY_WRITE(sc, code[i].reg, code[i].val);

        PHY_WRITE(sc, IGPHY_PAGE_SELECT, 0x0000);
        PHY_WRITE(sc, 0x0000, 0x3300);

        delay(20000);

        /* Now enable the transmitter */
        IGPHY_WRITE(sc, 0x2f5b, reg);
}

static void
igphy_load_dspcode_igp3(struct mii_softc *sc)
{
        const dspcode *code = igp3code;
        int i;

        for (i = 0; !((code[i].reg == 0) && (code[i].val == 0)); i++)
                IGPHY_WRITE(sc, code[i].reg, code[i].val);
}

static void
igphy_reset(struct mii_softc *sc)
{
        struct igphy_softc *igsc = (struct igphy_softc *)sc;
        uint16_t fused, fine, coarse;

        KASSERT(mii_locked(sc->mii_pdata));

        mii_phy_reset(sc);
        delay(150);

        switch (igsc->sc_mactype) {
        case WM_T_82541:
        case WM_T_82547:
        case WM_T_82541_2:
        case WM_T_82547_2:
                igphy_load_dspcode(sc);
                break;
        case WM_T_ICH8:
        case WM_T_ICH9:
                if ((igsc->sc_macflags & WM_F_EEPROM_INVALID) != 0)
                        igphy_load_dspcode_igp3(sc);
                break;
        default:        /* Not for ICH10, PCH and 8257[12] */
                break;
        }

        if (igsc->sc_mactype == WM_T_82547) {
                IGPHY_READ(sc, IGPHY_ANALOG_SPARE_FUSE_STATUS, &fused);
                if ((fused & ANALOG_SPARE_FUSE_ENABLED) == 0) {
                        IGPHY_READ(sc, IGPHY_ANALOG_FUSE_STATUS, &fused);

                        fine = fused & ANALOG_FUSE_FINE_MASK;
                        coarse = fused & ANALOG_FUSE_COARSE_MASK;

                        if (coarse > ANALOG_FUSE_COARSE_THRESH) {
                                coarse -= ANALOG_FUSE_COARSE_10;
                                fine -= ANALOG_FUSE_FINE_1;
                        } else if (coarse == ANALOG_FUSE_COARSE_THRESH)
                                fine -= ANALOG_FUSE_FINE_10;

                        fused = (fused & ANALOG_FUSE_POLY_MASK) |
                            (fine & ANALOG_FUSE_FINE_MASK) |
                            (coarse & ANALOG_FUSE_COARSE_MASK);

                        IGPHY_WRITE(sc, IGPHY_ANALOG_FUSE_CONTROL, fused);
                        IGPHY_WRITE(sc, IGPHY_ANALOG_FUSE_BYPASS,
                            ANALOG_FUSE_ENABLE_SW_CONTROL);
                }
        }
        PHY_WRITE(sc, IGPHY_PAGE_SELECT, 0x0000);
}


static int
igphy_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;

                PHY_READ(sc, IGPHY_PORT_CTRL, &reg);
                if (IFM_SUBTYPE(ife->ifm_media) == IFM_AUTO) {
                        reg |= PSCR_AUTO_MDIX;
                        reg &= ~PSCR_FORCE_MDI_MDIX;
                        PHY_WRITE(sc, IGPHY_PORT_CTRL, reg);
                } else {
                        reg &= ~(PSCR_AUTO_MDIX | PSCR_FORCE_MDI_MDIX);
                        PHY_WRITE(sc, IGPHY_PORT_CTRL, reg);
                }

                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;

                igphy_smartspeed_workaround(sc);

                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
igphy_status(struct mii_softc *sc)
{
        struct mii_data *mii = sc->mii_pdata;
        struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
        uint16_t bmcr, pssr, gtsr, bmsr;

        KASSERT(mii_locked(mii));

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

        PHY_READ(sc, IGPHY_PORT_STATUS, &pssr);

        if (pssr & IGPHY_PSSR_LINK_UP)
                mii->mii_media_status |= IFM_ACTIVE;

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

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

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

        /* XXX can't check if the info is valid, no 'negotiation done' bit? */
        if (bmcr & BMCR_AUTOEN) {
                if ((bmsr & BMSR_ACOMP) == 0) {
                        mii->mii_media_active |= IFM_NONE;
                        return;
                }
                switch (pssr & IGPHY_PSSR_SPEED_MASK) {
                case IGPHY_PSSR_SPEED_1000MBPS:
                        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 IGPHY_PSSR_SPEED_100MBPS:
                        mii->mii_media_active |= IFM_100_TX;
                        break;

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

                default:
                        mii->mii_media_active |= IFM_NONE;
                        mii->mii_media_status = 0;
                        return;
                }

                if (pssr & IGPHY_PSSR_FULL_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;
}

static void
igphy_smartspeed_workaround(struct mii_softc *sc)
{
        struct igphy_softc *igsc = (struct igphy_softc *)sc;
        uint16_t reg, gtsr, gtcr;

        /* This workaround is only for 82541 and 82547 */
        switch (igsc->sc_mactype) {
        case WM_T_82541:
        case WM_T_82541_2:
        case WM_T_82547:
        case WM_T_82547_2:
                break;
        default:
                /* byebye */
                return;
        }

        PHY_READ(sc, MII_BMCR, &reg);
        if ((reg & BMCR_AUTOEN) == 0)
                return;

        /* XXX Assume 1000TX-FDX is advertized if doing autonegotiation. */

        PHY_READ(sc, MII_BMSR, &reg);
        PHY_READ(sc, MII_BMSR, &reg);
        if ((reg & BMSR_LINK) == 0) {
                switch (igsc->sc_smartspeed) {
                case 0:
                        PHY_READ(sc, MII_100T2SR, &gtsr);
                        if (!(gtsr & GTSR_MAN_MS_FLT))
                                break;
                        PHY_READ(sc, MII_100T2SR, &gtsr);
                        if (gtsr & GTSR_MAN_MS_FLT) {
                                PHY_READ(sc, MII_100T2CR, &gtcr);
                                if (gtcr & GTCR_MAN_MS) {
                                        gtcr &= ~GTCR_MAN_MS;
                                        PHY_WRITE(sc, MII_100T2CR, gtcr);
                                }
                                mii_phy_auto(sc);
                        }
                        break;
                case IGPHY_TICK_DOWNSHIFT:
                        PHY_READ(sc, MII_100T2CR, &gtcr);
                        gtcr |= GTCR_MAN_MS;
                        PHY_WRITE(sc, MII_100T2CR, gtcr);
                        mii_phy_auto(sc);
                        break;
                default:
                        break;
                }
                if (igsc->sc_smartspeed++ == IGPHY_TICK_MAX)
                        igsc->sc_smartspeed = 0;
        } else
                igsc->sc_smartspeed = 0;
}