Add icsphy(4), Integrated Circuit Systems PHY driver, ported from

NetBSD. ATM the only consumer of the PHY is XBox with nfe(4) driver.

Submitted by:	Ed Schouten <ed@fxq.nl>
Tested by:	Ed Schouten <ed@fxq.nl>

2 files changed, 438 insertions, 0 deletions

diff --git a/sys/dev/mii/icsphy.c b/sys/dev/mii/icsphy.c
new file mode 100644
index 0000000..9c1c351
--- /dev/null
+++ b/sys/dev/mii/icsphy.c
@@ -0,0 +1,302 @@
+/*	$NetBSD: icsphy.c,v 1.41 2006/11/16 21:24:07 christos 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.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *	This product includes software developed by the NetBSD
+ *	Foundation, Inc. and its contributors.
+ * 4. Neither the name of The NetBSD Foundation 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 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.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *	This product includes software developed by Manuel Bouyer.
+ * 4. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * 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.
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+/*
+ * driver for Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY
+ * datasheet from www.icst.com
+ */
+
+#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_media.h>
+
+#include <dev/mii/mii.h>
+#include <dev/mii/miivar.h>
+#include "miidevs.h"
+
+#include <dev/mii/icsphyreg.h>
+
+#include "miibus_if.h"
+
+static int	icsphy_probe(device_t dev);
+static int	icsphy_attach(device_t dev);
+
+struct icsphy_softc {
+	struct mii_softc mii_sc;
+	int mii_model;
+};
+
+static device_method_t icsphy_methods[] = {
+	/* device interface */
+	DEVMETHOD(device_probe,		icsphy_probe),
+	DEVMETHOD(device_attach,	icsphy_attach),
+	DEVMETHOD(device_detach,	mii_phy_detach),
+	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
+	{ 0, 0 }
+};
+
+static devclass_t icsphy_devclass;
+
+static driver_t icsphy_driver = {
+	"icsphy",
+	icsphy_methods,
+	sizeof(struct icsphy_softc)
+};
+
+DRIVER_MODULE(icsphy, miibus, icsphy_driver, icsphy_devclass, 0, 0);
+
+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_phydesc icsphys[] = {
+	MII_PHY_DESC(xxICS, 1889),
+	MII_PHY_DESC(xxICS, 1890),
+	MII_PHY_DESC(xxICS, 1892),
+	MII_PHY_DESC(xxICS, 1893),
+	MII_PHY_END
+};
+
+static int
+icsphy_probe(device_t dev)
+{
+
+	return (mii_phy_dev_probe(dev, icsphys, BUS_PROBE_DEFAULT));
+}
+
+static int
+icsphy_attach(device_t dev)
+{
+	struct icsphy_softc *isc;
+	struct mii_softc *sc;
+	struct mii_attach_args *ma;
+	struct mii_data *mii;
+
+	isc = device_get_softc(dev);
+	sc = &isc->mii_sc;
+	ma = device_get_ivars(dev);
+	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_phy = ma->mii_phyno;
+	sc->mii_service = icsphy_service;
+	sc->mii_pdata = mii;
+	sc->mii_anegticks = MII_ANEGTICKS;
+	sc->mii_flags |= MIIF_NOISOLATE;
+
+	mii->mii_instance++;
+
+	ifmedia_add(&mii->mii_media,
+	    IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
+	    MII_MEDIA_100_TX, NULL);
+
+	isc->mii_model = MII_MODEL(ma->mii_id2);
+	icsphy_reset(sc);
+
+	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
+	device_printf(dev, " ");
+	mii_phy_add_media(sc);
+	printf("\n");
+
+	MIIBUS_MEDIAINIT(sc->mii_dev);
+
+	return (0);
+}
+
+static int
+icsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
+{
+	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
+	int reg;
+
+	/*
+	 * If we're not selected, then do nothing, just isolate, if
+	 * changing media.
+	 */
+	if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
+		if (cmd == MII_MEDIACHG) {
+			reg = PHY_READ(sc, MII_BMCR);
+			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
+		}
+                return (0);
+        }
+
+	switch (cmd) {
+	case MII_POLLSTAT:
+		break;
+
+	case MII_MEDIACHG:
+		/*
+		 * 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 (mii_phy_tick(sc) == EJUSTRETURN)
+			return (0);
+		break;
+	}
+
+	/* Update the media status. */
+	icsphy_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;
+	int bmcr, qpr;
+
+	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.
+	 */
+	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
+	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
+
+	if (qpr & QPR_LINK)
+		mii->mii_media_status |= IFM_ACTIVE;
+
+	bmcr = PHY_READ(sc, MII_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)
+{
+	struct icsphy_softc *isc = (struct icsphy_softc *)sc;
+
+	mii_phy_reset(sc);
+	/* set powerdown feature */
+	switch (isc->mii_model) {
+		case MII_MODEL_xxICS_1890:
+		case MII_MODEL_xxICS_1893:
+			PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
+			break;
+		case MII_MODEL_xxICS_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);
+}
diff --git a/sys/dev/mii/icsphyreg.h b/sys/dev/mii/icsphyreg.h
new file mode 100644
index 0000000..22e4486
--- /dev/null
+++ b/sys/dev/mii/icsphyreg.h
@@ -0,0 +1,136 @@
+/*	$NetBSD: icsphyreg.h,v 1.2 2003/07/01 22:46:08 msaitoh Exp $	*/
+
+/*-
+ * Copyright (c) 1998 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.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *	This product includes software developed by the NetBSD
+ *	Foundation, Inc. and its contributors.
+ * 4. Neither the name of The NetBSD Foundation 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 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.
+ *
+ * $FreeBSD$
+ */
+
+#ifndef _DEV_MII_ICSPHYREG_H_
+#define	_DEV_MII_ICSPHYREG_H_
+
+/*
+ * ICS1890 registers.
+ *	http://www.icst.com/pdf/18??.pdf
+ */
+
+/* HEX				1889	1890	1892	1893
+ *--------------------------------------------------------------
+ *  0 Control			*	*	*	*
+ *  1 Status			*	*	*	*
+ *  2 PHY Identifier		*	*	*	*
+ *  3 PHY Identifier		*	*	*	*
+ *  4 Auto-Neg. Advertisement		*	*	*
+ *  5 Auto-Neg. Link Parent Adv		*	*	*
+ *  6 Auto-Neg. Expansion		*	*	*
+ *  7 Auto-Neg. Next Page Tx			*	*
+ *  8 ANg Nxt Page Lnk Parnt Abl		*	*
+ * 10 Extended Control		*	*	*	*
+ * 11 Quick Poll Status		*	*	*	*
+ * 12 10Base-T Operation		*	*	*
+ * 13 Extended Control2			*	*	*
+ */
+
+#define	MII_ICSPHY_ECR		0x10	/* Extended Control Register */
+#define	ECR_OVR			0x8000	/* disable command reg overwrites */
+#define	ECR_PHYADDR_MASK	0x07c0	/* PHY address mask */
+#define	ECR_CTEST		0x0020	/* Stream Cipher Test Mode */
+#define	ECR_IECT		0x0004	/* Invalid Error Code Test */
+#define	ECR_SSD			0x0001	/* Stream Cipher Disable */
+
+#define	MII_ICSPHY_QPR		0x11	/* Quick Poll Register */
+#define	QPR_SPEED		0x8000	/* 100Mbps */
+#define	QPR_FDX			0x4000	/* Full dupled */
+#define	QPR_ANB2		0x2000	/* Autoneg monitor bit 2 */
+#define	QPR_ANB1		0x1000	/* Autoneg monitor bit 1 */
+#define	QPR_ANB0		0x0800	/* Autoneg monitor bit 0 */
+#define	QPR_RXERR		0x0400	/* Receive signal lost */
+#define	QPR_PLLERR		0x0200	/* PLL error */
+#define	QPR_FCARR		0x0100	/* False carrier detected */
+#define	QPR_INVALSYM		0x0080	/* Invalid Symbol Detected */
+#define	QPR_HALT		0x0040	/* Halt Symbol Detected */
+#define	QPR_PREEM		0x0020	/* Two Idle Symbols together */
+#define	QPR_ACOMP		0x0010	/* Autonegotiation complete */
+#define	QPR_SDETECT		0x0008	/* signal detect */
+#define	QPR_JABBER		0x0004	/* Jabber detected */
+#define	QPR_RFAULT		0x0002	/* Remote Fault */
+#define	QPR_LINK		0x0001	/* Link */
+
+#define	MII_ICSPHY_TTR		0x12	/* 10baseT Operations Register */
+#define	TTR_RJABBER		0x8000	/* Remote Jabber */
+#define	TTR_POLARITY		0x4000	/* Polarity Reversed */
+#define	TTR_NOJABBER		0x0020	/* Disable Jabber Check */
+#define	TTR_LOOP		0x0010	/* Loopback mode */
+#define	TTR_NOAPOLARITY		0x0008	/* Disable auto polarity correction */
+#define	TTR_NOSQE		0x0004	/* Disable SQE check */
+#define	TTR_NOLINK		0x0002	/* Disable Link check */
+#define	TTR_NOSQUELCH		0x0001	/* Disable squelch */
+
+
+/*
+ * Extended Control Register 2
+ *
+ * HEX					1889	1890	1892	1893
+ *-------------------------------------------------------------------
+ * 8000	Node/Repeater Mode			*	*	*
+ * 4000 Hardware/Software Mode			*	*	*
+ * 2000 Link Partner Support Remote Flt		*
+ * 2000 Remote Fault					*	*
+ * 1000
+ * 0800
+ * 0400 Xmitted Remote Fault status		*
+ * 0200
+ * 0100
+ * 0080 Tri-state Enable					*
+ * 0040
+ * 0020
+ * 0010 A-N Powerup Remote Flt			*
+ * 0008
+ * 0004
+ * 0002 Automatic 10Base-T Power Down			*
+ * 0001 Automatic 100Base-TX Power Down		*	*	*
+ */
+
+#define	MII_ICSPHY_ECR2		0x13	/* Extended Control Register 2 */
+#define	ECR2_REPEATER		0x8000	/* Repeater Mode */
+#define	ECR2_HWSW		0x4000	/* hw/sw config priority */
+#define	ECR2_LPRF		0x2000	/* link partner supports rem fault */
+#define	ECR2_FORCERF		0x0400	/* Force transmit of rem fault */
+#define	ECR2_RFPUP		0x0010	/* A-N Powerup Remote fault */
+#define	ECR2_10AUTOPWRDN	0x0002	/* Automatic 10baseT power down */
+#define	ECR2_100AUTOPWRDN	0x0001	/* Automatic 100baseTX power down */
+
+#endif /* _DEV_MII_ICSPHYREG_H_ */