Driver for the RealTek 8169S/8110S internal 10/100/1000 PHY

from FreeBSD

1 files changed, 444 insertions, 0 deletions

diff --git a/sys/dev/mii/rgephy.c b/sys/dev/mii/rgephy.c
new file mode 100644
index 00000000000..f44f1b8a1e3
--- /dev/null
+++ b/sys/dev/mii/rgephy.c
@@ -0,0 +1,444 @@
+/*	$OpenBSD: rgephy.c,v 1.1 2004/06/05 05:49:29 pvalchev Exp $	*/
+/*
+ * Copyright (c) 2003
+ *	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.
+ */
+
+/*
+ * Driver for the RealTek 8169S/8110S internal 10/100/1000 PHY.
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/kernel.h>
+#include <sys/device.h>
+#include <sys/malloc.h>
+#include <sys/socket.h>
+#include <sys/errno.h>
+
+#include <net/if.h>
+#include <net/if_media.h>
+
+#ifdef INET
+#include <netinet/in.h>
+#include <netinet/if_ether.h>
+#endif
+
+#include <dev/pci/pcivar.h>
+
+#include <dev/mii/mii.h>
+#include <dev/mii/miivar.h>
+#include <dev/mii/miidevs.h>
+
+#include <dev/mii/rgephyreg.h>
+
+#include <machine/bus.h>
+
+#include <dev/ic/rtl81x9reg.h>
+
+int	rgephymatch(struct device *, void *, void *);
+void	rgephyattach(struct device *, struct device *, void *);
+
+struct cfattach rgephy_ca = {
+	sizeof(struct mii_softc),
+	rgephymatch,
+	rgephyattach,
+	mii_phy_detach,
+	mii_phy_activate
+};
+
+struct cfdriver rgephy_cd = {
+	NULL, "rgephy", DV_DULL
+};
+
+int	rgephy_service(struct mii_softc *, struct mii_data *, int);
+void	rgephy_status(struct mii_softc *);
+int	rgephy_mii_phy_auto(struct mii_softc *);
+void	rgephy_reset(struct mii_softc *);
+void	rgephy_loop(struct mii_softc *);
+void	rgephy_load_dspcode(struct mii_softc *);
+int	rgephy_mii_model;
+
+int
+rgephymatch(parent, match, aux)
+	struct device *parent;
+	void *match;
+	void *aux;
+{
+	struct mii_attach_args *ma = aux;
+
+	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxREALTEK &&
+	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxREALTEK_RTL8169S) {
+		return(10);
+	}
+
+	return(0);
+}
+
+void
+rgephyattach(parent, self, aux)
+	struct device *parent, *self;
+	void *aux;
+{
+	struct mii_softc *sc = (struct mii_softc *)self;
+	struct mii_attach_args *ma = aux;
+	struct mii_data *mii = ma->mii_data;
+
+	printf(": %s, rev. %d PHY\n", MII_STR_xxREALTEK_RTL8169S,
+	    MII_REV(ma->mii_id2));
+
+	sc->mii_inst = mii->mii_instance;
+	sc->mii_phy = ma->mii_phyno;
+	sc->mii_model = MII_MODEL(ma->mii_id2);
+	sc->mii_rev = MII_REV(ma->mii_id2);
+	sc->mii_service = rgephy_service;
+	sc->mii_status = rgephy_status;
+	sc->mii_pdata = mii;
+	sc->mii_flags = mii->mii_flags | MIIF_NOISOLATE;
+	sc->mii_ticks = 0; /* XXX */
+	sc->mii_anegticks = 5;
+
+	rgephy_reset(sc);
+
+	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
+
+	if (sc->mii_capabilities & BMSR_EXTSTAT)
+		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
+	if ((sc->mii_capabilities & BMSR_MEDIAMASK) ||
+	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK))
+		mii_phy_add_media(sc);
+}
+
+int
+rgephy_service(sc, mii, cmd)
+	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:
+		/*
+		 * 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;
+
+		rgephy_reset(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, RGEPHY_MII_BMCR) & RGEPHY_BMCR_AUTOEN)
+				return (0);
+#endif
+			(void) rgephy_mii_phy_auto(sc);
+			break;
+		case IFM_1000_T:
+			speed = RGEPHY_S1000;
+			goto setit;
+		case IFM_100_TX:
+			speed = RGEPHY_S100;
+			goto setit;
+		case IFM_10_T:
+			speed = RGEPHY_S10;
+setit:
+			rgephy_loop(sc);
+			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
+				speed |= RGEPHY_BMCR_FDX;
+				gig = RGEPHY_1000CTL_AFD;
+			} else {
+				gig = RGEPHY_1000CTL_AHD;
+			}
+
+			PHY_WRITE(sc, RGEPHY_MII_1000CTL, 0);
+			PHY_WRITE(sc, RGEPHY_MII_BMCR, speed);
+			PHY_WRITE(sc, RGEPHY_MII_ANAR, RGEPHY_SEL_TYPE);
+
+			if (IFM_SUBTYPE(ife->ifm_media) != IFM_1000_T) 
+				break;
+
+			PHY_WRITE(sc, RGEPHY_MII_1000CTL, gig);
+			PHY_WRITE(sc, RGEPHY_MII_BMCR,
+			    speed|RGEPHY_BMCR_AUTOEN|RGEPHY_BMCR_STARTNEG);
+
+			/*
+			 * When settning the link manually, one side must
+			 * be the master and the other the slave. However
+			 * ifmedia doesn't give us a good way to specify
+			 * this, so we fake it by using one of the LINK
+			 * flags. If LINK0 is set, we program the PHY to
+			 * be a master, otherwise it's a slave.
+			 */
+			if ((mii->mii_ifp->if_flags & IFF_LINK0)) {
+				PHY_WRITE(sc, RGEPHY_MII_1000CTL,
+				    gig|RGEPHY_1000CTL_MSE|RGEPHY_1000CTL_MSC);
+			} else {
+				PHY_WRITE(sc, RGEPHY_MII_1000CTL,
+				    gig|RGEPHY_1000CTL_MSE);
+			}
+			break;
+#ifdef foo
+		case IFM_NONE:
+			PHY_WRITE(sc, MII_BMCR, BMCR_ISO|BMCR_PDOWN);
+			break;
+#endif
+		case IFM_100_T4:
+		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, RL_GMEDIASTAT);
+		if (reg & RL_GMEDIASTAT_LINK)
+			break;
+
+		/*
+		 * Only retry autonegotiation every 5 seconds.
+		 */
+		if (++sc->mii_ticks <= sc->mii_anegticks /*10*/)
+			break;
+		
+		sc->mii_ticks = 0;
+		rgephy_mii_phy_auto(sc);
+		return (0);
+	}
+
+	/* Update the media status. */
+	rgephy_status(sc);
+
+	/*
+	 * Callback if something changed. Note that we need to poke
+	 * the DSP on the RealTek PHYs if the media changes.
+	 *
+	 */
+	if (sc->mii_media_active != mii->mii_media_active || 
+	    sc->mii_media_status != mii->mii_media_status ||
+	    cmd == MII_MEDIACHG) {
+		rgephy_load_dspcode(sc);
+	}
+	mii_phy_update(sc, cmd);
+	return (0);
+}
+
+void
+rgephy_status(sc)
+	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, RL_GMEDIASTAT);
+
+	if (bmsr & RL_GMEDIASTAT_LINK)
+		mii->mii_media_status |= IFM_ACTIVE;
+	bmsr = PHY_READ(sc, RGEPHY_MII_BMSR);
+
+	bmcr = PHY_READ(sc, RGEPHY_MII_BMCR);
+
+	if (bmcr & RGEPHY_BMCR_LOOP)
+		mii->mii_media_active |= IFM_LOOP;
+
+	if (bmcr & RGEPHY_BMCR_AUTOEN) {
+		if ((bmsr & RGEPHY_BMSR_ACOMP) == 0) {
+			/* Erg, still trying, I guess... */
+			mii->mii_media_active |= IFM_NONE;
+			return;
+		}
+	}
+
+	bmsr = PHY_READ(sc, RL_GMEDIASTAT);
+	if (bmsr & RL_GMEDIASTAT_10MBPS)
+		mii->mii_media_active |= IFM_10_T;
+	if (bmsr & RL_GMEDIASTAT_100MBPS)
+		mii->mii_media_active |= IFM_100_TX;
+	if (bmsr & RL_GMEDIASTAT_1000MBPS)
+		mii->mii_media_active |= IFM_1000_T;
+	if (bmsr & RL_GMEDIASTAT_FDX)
+		mii->mii_media_active |= IFM_FDX;
+}
+
+
+int
+rgephy_mii_phy_auto(mii)
+	struct mii_softc *mii;
+{
+	rgephy_loop(mii);
+	rgephy_reset(mii);
+
+	PHY_WRITE(mii, RGEPHY_MII_ANAR,
+	    BMSR_MEDIA_TO_ANAR(mii->mii_capabilities) | ANAR_CSMA);
+	DELAY(1000);
+	PHY_WRITE(mii, RGEPHY_MII_1000CTL, RGEPHY_1000CTL_AFD);
+	DELAY(1000);
+	PHY_WRITE(mii, RGEPHY_MII_BMCR,
+	    RGEPHY_BMCR_AUTOEN | RGEPHY_BMCR_STARTNEG);
+	DELAY(100);
+
+	return (EJUSTRETURN);
+}
+
+void
+rgephy_loop(struct mii_softc *sc)
+{
+	u_int32_t bmsr;
+	int i;
+
+	PHY_WRITE(sc, RGEPHY_MII_BMCR, RGEPHY_BMCR_PDOWN);
+	DELAY(1000);
+
+	for (i = 0; i < 15000; i++) {
+		bmsr = PHY_READ(sc, RGEPHY_MII_BMSR);
+		if (!(bmsr & RGEPHY_BMSR_LINK)) {
+#if 0
+			device_printf(sc->mii_dev, "looped %d\n", i);
+#endif
+			break;
+		}
+		DELAY(10);
+	}
+}
+
+#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)))
+
+/*
+ * Initialize RealTek PHY per the datasheet. The DSP in the PHYs of
+ * existing revisions of the 8169S/8110S chips need to be tuned in
+ * order to reliably negotiate a 1000Mbps link. Later revs of the
+ * chips may not require this software tuning.
+ */
+void
+rgephy_load_dspcode(struct mii_softc *sc)
+{
+	int val;
+
+	PHY_WRITE(sc, 31, 0x0001);
+	PHY_WRITE(sc, 21, 0x1000);
+	PHY_WRITE(sc, 24, 0x65C7);
+	PHY_CLRBIT(sc, 4, 0x0800);
+	val = PHY_READ(sc, 4) & 0xFFF;
+	PHY_WRITE(sc, 4, val);
+	PHY_WRITE(sc, 3, 0x00A1);
+	PHY_WRITE(sc, 2, 0x0008);
+	PHY_WRITE(sc, 1, 0x1020);
+	PHY_WRITE(sc, 0, 0x1000);
+	PHY_SETBIT(sc, 4, 0x0800);
+	PHY_CLRBIT(sc, 4, 0x0800);
+	val = (PHY_READ(sc, 4) & 0xFFF) | 0x7000;
+	PHY_WRITE(sc, 4, val);
+	PHY_WRITE(sc, 3, 0xFF41);
+	PHY_WRITE(sc, 2, 0xDE60);
+	PHY_WRITE(sc, 1, 0x0140);
+	PHY_WRITE(sc, 0, 0x0077);
+	val = (PHY_READ(sc, 4) & 0xFFF) | 0xA000;
+	PHY_WRITE(sc, 4, val);
+	PHY_WRITE(sc, 3, 0xDF01);
+	PHY_WRITE(sc, 2, 0xDF20);
+	PHY_WRITE(sc, 1, 0xFF95);
+	PHY_WRITE(sc, 0, 0xFA00);
+	val = (PHY_READ(sc, 4) & 0xFFF) | 0xB000;
+	PHY_WRITE(sc, 4, val);
+	PHY_WRITE(sc, 3, 0xFF41);
+	PHY_WRITE(sc, 2, 0xDE20);
+	PHY_WRITE(sc, 1, 0x0140);
+	PHY_WRITE(sc, 0, 0x00BB);
+	val = (PHY_READ(sc, 4) & 0xFFF) | 0xF000;
+	PHY_WRITE(sc, 4, val);
+	PHY_WRITE(sc, 3, 0xDF01);
+	PHY_WRITE(sc, 2, 0xDF20);
+	PHY_WRITE(sc, 1, 0xFF95);
+	PHY_WRITE(sc, 0, 0xBF00);
+	PHY_SETBIT(sc, 4, 0x0800);
+	PHY_CLRBIT(sc, 4, 0x0800);
+	PHY_WRITE(sc, 31, 0x0000);
+	
+	DELAY(40);
+}
+
+void
+rgephy_reset(struct mii_softc *sc)
+{
+	mii_phy_reset(sc);
+	DELAY(1000);
+	rgephy_load_dspcode(sc);
+}