* Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.

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

/*-
* Copyright (c) 1998, 1999, 2000 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 Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY
* datasheet from www.icst.com
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: icsphy.c,v 1.56 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 <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/icsphyreg.h>

static int icsphymatch(device_t, cfdata_t, void *);
static void icsphyattach(device_t, device_t, void *);

CFATTACH_DECL_NEW(icsphy, sizeof(struct mii_softc),
icsphymatch, icsphyattach, mii_phy_detach, mii_phy_activate);

static int icsphy_service(struct mii_softc *, struct mii_data *, int);
static void icsphy_status(struct mii_softc *);
static void icsphy_reset(struct mii_softc *);

static const struct mii_phy_funcs icsphy_funcs = {
icsphy_service, icsphy_status, icsphy_reset,
};

static const struct mii_phydesc icsphys[] = {
MII_PHY_DESC(ICS, 1889),
MII_PHY_DESC(ICS, 1890),
MII_PHY_DESC(ICS, 1892),
MII_PHY_DESC(ICS, 1893),
MII_PHY_DESC(ICS, 1893C),
MII_PHY_END,
};

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

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

return 0;
}

static void
icsphyattach(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;

mpd = mii_phy_match(ma, icsphys);
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_mpd_model = MII_MODEL(ma->mii_id2);
sc->mii_inst = mii->mii_instance;
sc->mii_phy = ma->mii_phyno;
sc->mii_funcs = &icsphy_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;

mii_unlock(mii);

mii_phy_add_media(sc);
}

static int
icsphy_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
icsphy_status(struct mii_softc *sc)
{
struct mii_data *mii = sc->mii_pdata;
struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
uint16_t bmcr, qpr;

KASSERT(mii_locked(mii));

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

/*
* Don't get link from the BMSR. It's available in the QPR,
* and we have to read it twice to unlatch it anyhow. This
* gives us fewer register reads.
*/
PHY_READ(sc, MII_ICSPHY_QPR, &qpr); /* unlatch */
PHY_READ(sc, MII_ICSPHY_QPR, &qpr); /* real value */

if (qpr & QPR_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) {
if ((qpr & QPR_ACOMP) == 0) {
/* Erg, still trying, I guess... */
mii->mii_media_active |= IFM_NONE;
return;
}
if (qpr & QPR_SPEED)
mii->mii_media_active |= IFM_100_TX;
else
mii->mii_media_active |= IFM_10_T;

if (qpr & QPR_FDX)
mii->mii_media_active |= IFM_FDX;
else
mii->mii_media_active |= IFM_HDX;
} else
mii->mii_media_active = ife->ifm_media;
}

static void
icsphy_reset(struct mii_softc *sc)
{

KASSERT(mii_locked(sc->mii_pdata));

mii_phy_reset(sc);
/* Set powerdown feature */
switch (sc->mii_mpd_model) {
case MII_MODEL_ICS_1890:
case MII_MODEL_ICS_1893:
PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
break;
case MII_MODEL_ICS_1892:
PHY_WRITE(sc, MII_ICSPHY_ECR2,
ECR2_10AUTOPWRDN | ECR2_100AUTOPWRDN);
break;
default:
/* 1889 have no ECR2 */
break;
}
/*
* There is no description that the reset do auto-negotiation in the
* data sheet.
*/
PHY_WRITE(sc, MII_BMCR, BMCR_S100 | BMCR_STARTNEG | BMCR_FDX);
}