This commit adds support for the NetBSD MII abstraction layer and

MII-compliant PHY drivers. Many 10/100 ethernet NICs available today
either use an MII transceiver or have built-in transceivers that can
be programmed using an MII interface. It makes sense then to separate
this support out into common code instead of duplicating it in all
of the NIC drivers. The mii code also handles all of the media
detection, selection and reporting via the ifmedia interface.

This is basically the same code from NetBSD's /sys/dev/mii, except
it's been adapted to FreeBSD's bus architecture. The advantage to this
is that it automatically allows everything to be turned into a
loadable module. There are some common functions for use in drivers
once an miibus has been attached (mii_mediachg(), mii_pollstat(),
mii_tick()) as well as individual PHY drivers. There is also a
generic driver for all PHYs that aren't handled by a specific driver.
It's possible to do this because all 10/100 PHYs implement the same
general register set in addition to their vendor-specific register
sets, so for the most part you can use one driver for pretty much
any PHY. There are a couple of oddball exceptions though, hence
the need to have specific drivers.

There are two layers: the generic "miibus" layer and the PHY driver
layer. The drivers are child devices of "miibus" and the "miibus" is
a child of a given NIC driver. The "miibus" code and the PHY drivers
can actually be compiled and kldoaded as completely separate modules
or compiled together into one module. For the moment I'm using the
latter approach since the code is relatively small.

Currently there are only three PHY drivers here: the generic driver,
the built-in 3Com XL driver and the NS DP83840 driver. I'll be adding
others later as I convert various NIC drivers to use this code.

I realize that I'm cvs adding this stuff instead of importing it
onto a separate vendor branch, but in my opinion the import approach
doesn't really offer any significant advantage: I'm going to be
maintaining this stuff and writing my own PHY drivers one way or
the other.

1 files changed, 178 insertions, 0 deletions

diff --git a/sys/dev/mii/miivar.h b/sys/dev/mii/miivar.h
new file mode 100644
index 0000000..bd5121e
--- /dev/null
+++ b/sys/dev/mii/miivar.h
@@ -0,0 +1,178 @@
+/*	$NetBSD: miivar.h,v 1.8 1999/04/23 04:24:32 thorpej Exp $	*/
+
+/*-
+ * Copyright (c) 1998, 1999 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.
+ *
+ * 	$Id$
+ */
+
+#ifndef _DEV_MII_MIIVAR_H_
+#define	_DEV_MII_MIIVAR_H_
+
+#include <sys/queue.h>
+
+/*
+ * Media Independent Interface autoconfiguration defintions.
+ *
+ * This file exports an interface which attempts to be compatible
+ * with the BSD/OS 3.0 interface.
+ */
+
+struct mii_softc;
+
+/*
+ * Callbacks from MII layer into network interface device driver.
+ */
+typedef	int (*mii_readreg_t) __P((struct device *, int, int));
+typedef	void (*mii_writereg_t) __P((struct device *, int, int, int));
+typedef	void (*mii_statchg_t) __P((struct device *));
+
+/*
+ * A network interface driver has one of these structures in its softc.
+ * It is the interface from the network interface driver to the MII
+ * layer.
+ */
+struct mii_data {
+	struct ifmedia mii_media;	/* media information */
+	struct ifnet *mii_ifp;		/* pointer back to network interface */
+
+	/*
+	 * For network interfaces with multiple PHYs, a list of all
+	 * PHYs is required so they can all be notified when a media
+	 * request is made.
+	 */
+	LIST_HEAD(mii_listhead, mii_softc) mii_phys;
+	int mii_instance;
+
+	/*
+	 * PHY driver fills this in with active media status.
+	 */
+	int mii_media_status;
+	int mii_media_active;
+
+	/*
+	 * Calls from MII layer into network interface driver.
+	 */
+	mii_readreg_t mii_readreg;
+	mii_writereg_t mii_writereg;
+	mii_statchg_t mii_statchg;
+};
+typedef struct mii_data mii_data_t;
+
+/*
+ * This call is used by the MII layer to call into the PHY driver
+ * to perform a `service request'.
+ */
+typedef	int (*mii_downcall_t) __P((struct mii_softc *, struct mii_data *, int));
+
+/*
+ * Requests that can be made to the downcall.
+ */
+#define	MII_TICK	1	/* once-per-second tick */
+#define	MII_MEDIACHG	2	/* user changed media; perform the switch */
+#define	MII_POLLSTAT	3	/* user requested media status; fill it in */
+
+/*
+ * Each PHY driver's softc has one of these as the first member.
+ * XXX This would be better named "phy_softc", but this is the name
+ * XXX BSDI used, and we would like to have the same interface.
+ */
+struct mii_softc {
+	device_t mii_dev;		/* generic device glue */
+	
+	LIST_ENTRY(mii_softc) mii_list;	/* entry on parent's PHY list */
+
+	int mii_phy;			/* our MII address */
+	int mii_inst;			/* instance for ifmedia */
+
+	mii_downcall_t mii_service;	/* our downcall */
+	struct mii_data *mii_pdata;	/* pointer to parent's mii_data */
+
+	int mii_flags;			/* misc. flags; see below */
+	int mii_capabilities;		/* capabilities from BMSR */
+	int mii_ticks;			/* MII_TICK counter */
+	int mii_active;			/* last active media */
+};
+typedef struct mii_softc mii_softc_t;
+
+/* mii_flags */
+#define	MIIF_NOISOLATE	0x0001		/* do not isolate the PHY */
+#define	MIIF_DOINGAUTO	0x0002		/* doing autonegotiation */
+
+/*
+ * Used to attach a PHY to a parent.
+ */
+struct mii_attach_args {
+	struct mii_data *mii_data;	/* pointer to parent data */
+	int mii_phyno;			/* MII address */
+	int mii_id1;			/* PHY ID register 1 */
+	int mii_id2;			/* PHY ID register 2 */
+	int mii_capmask;		/* capability mask from BMSR */
+};
+typedef struct mii_attach_args mii_attach_args_t;
+
+#ifdef KERNEL
+
+#define PHY_READ(p, r) \
+	MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r))
+
+#define PHY_WRITE(p, r, v) \
+	MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v))
+
+extern devclass_t	miibus_devclass;
+extern driver_t		miibus_driver;
+
+int	miibus_probe __P((device_t));
+int	miibus_attach __P((device_t));
+int	miibus_detach __P((device_t));
+
+int	mii_anar __P((int));
+int	mii_mediachg __P((struct mii_data *));
+void	mii_tick __P((struct mii_data *));
+void	mii_pollstat __P((struct mii_data *));
+int	mii_phy_probe __P((device_t, device_t *,
+	    ifm_change_cb_t, ifm_stat_cb_t));
+void	mii_add_media __P((struct mii_data *, int, int));
+
+int	mii_media_from_bmcr __P((int));
+
+int	mii_phy_auto __P((struct mii_softc *, int));
+void	mii_phy_reset __P((struct mii_softc *));
+
+void	ukphy_status __P((struct mii_softc *));
+#endif /* KERNEL */
+
+#endif /* _DEV_MII_MIIVAR_H_ */