rlphy.c revision 164711
1/*-
2 * Copyright (c) 1997, 1998, 1999
3 *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33#include <sys/cdefs.h>
34__FBSDID("$FreeBSD: head/sys/dev/mii/rlphy.c 164711 2006-11-28 01:14:09Z marius $");
35
36/*
37 * driver for RealTek 8139 internal PHYs
38 */
39
40#include <sys/param.h>
41#include <sys/systm.h>
42#include <sys/kernel.h>
43#include <sys/module.h>
44#include <sys/socket.h>
45#include <sys/bus.h>
46
47#include <net/if.h>
48#include <net/if_arp.h>
49#include <net/if_media.h>
50
51#include <dev/mii/mii.h>
52#include <dev/mii/miivar.h>
53#include "miidevs.h"
54
55#include <machine/bus.h>
56#include <pci/if_rlreg.h>
57
58#include "miibus_if.h"
59
60static int rlphy_probe(device_t);
61static int rlphy_attach(device_t);
62
63static device_method_t rlphy_methods[] = {
64	/* device interface */
65	DEVMETHOD(device_probe,		rlphy_probe),
66	DEVMETHOD(device_attach,	rlphy_attach),
67	DEVMETHOD(device_detach,	mii_phy_detach),
68	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
69	{ 0, 0 }
70};
71
72static devclass_t rlphy_devclass;
73
74static driver_t rlphy_driver = {
75	"rlphy",
76	rlphy_methods,
77	sizeof(struct mii_softc)
78};
79
80DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
81
82static int	rlphy_service(struct mii_softc *, struct mii_data *, int);
83static void	rlphy_status(struct mii_softc *);
84
85static int
86rlphy_probe(device_t dev)
87{
88	struct mii_attach_args *ma;
89	device_t		parent;
90
91	ma = device_get_ivars(dev);
92	parent = device_get_parent(device_get_parent(dev));
93
94	/* Test for RealTek 8201L PHY */
95	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_REALTEK &&
96	    MII_MODEL(ma->mii_id2) == MII_MODEL_REALTEK_RTL8201L) {
97		device_set_desc(dev, MII_STR_REALTEK_RTL8201L);
98		return (BUS_PROBE_DEFAULT);
99	}
100
101	/*
102	 * RealTek PHY doesn't have vendor/device ID registers:
103	 * the rl driver fakes up a return value of all zeros.
104	 */
105	if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
106	    MII_MODEL(ma->mii_id2) != 0)
107		return (ENXIO);
108
109	/*
110	 * Make sure the parent is an `rl' or an `re'.
111	 */
112	if (strcmp(device_get_name(parent), "rl") != 0 &&
113	    strcmp(device_get_name(parent), "re") != 0)
114		return (ENXIO);
115
116	device_set_desc(dev, "RealTek internal media interface");
117
118	return (BUS_PROBE_DEFAULT);
119}
120
121static int
122rlphy_attach(device_t dev)
123{
124	struct mii_softc	*sc;
125	struct mii_attach_args	*ma;
126	struct mii_data		*mii;
127
128	sc = device_get_softc(dev);
129	ma = device_get_ivars(dev);
130	sc->mii_dev = device_get_parent(dev);
131	mii = device_get_softc(sc->mii_dev);
132
133	/*
134	 * The RealTek PHY can never be isolated, so never allow non-zero
135	 * instances!
136	 */
137	if (mii->mii_instance != 0) {
138		device_printf(dev, "ignoring this PHY, non-zero instance\n");
139		return (ENXIO);
140	}
141
142	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
143
144	sc->mii_inst = mii->mii_instance;
145	sc->mii_phy = ma->mii_phyno;
146	sc->mii_service = rlphy_service;
147	sc->mii_pdata = mii;
148	mii->mii_instance++;
149
150	sc->mii_flags |= MIIF_NOISOLATE;
151
152#define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
153
154	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
155	    BMCR_LOOP|BMCR_S100);
156
157	mii_phy_reset(sc);
158
159	sc->mii_capabilities =
160	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
161	device_printf(dev, " ");
162	mii_phy_add_media(sc);
163	printf("\n");
164#undef ADD
165	MIIBUS_MEDIAINIT(sc->mii_dev);
166	return (0);
167}
168
169static int
170rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
171{
172	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
173
174	/*
175	 * We can't isolate the RealTek PHY, so it has to be the only one!
176	 */
177	if (IFM_INST(ife->ifm_media) != sc->mii_inst)
178		panic("rlphy_service: can't isolate RealTek PHY");
179
180	switch (cmd) {
181	case MII_POLLSTAT:
182		break;
183
184	case MII_MEDIACHG:
185		/*
186		 * If the interface is not up, don't do anything.
187		 */
188		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
189			break;
190
191		mii_phy_setmedia(sc);
192		break;
193
194	case MII_TICK:
195		/*
196		 * Is the interface even up?
197		 */
198		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
199			return (0);
200
201		/*
202		 * The RealTek PHY's autonegotiation doesn't need to be
203		 * kicked; it continues in the background.
204		 */
205		break;
206	}
207
208	/* Update the media status. */
209	rlphy_status(sc);
210
211	/* Callback if something changed. */
212	mii_phy_update(sc, cmd);
213	return (0);
214}
215
216static void
217rlphy_status(struct mii_softc *phy)
218{
219	struct mii_data *mii = phy->mii_pdata;
220	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
221	int bmsr, bmcr, anlpar;
222
223	mii->mii_media_status = IFM_AVALID;
224	mii->mii_media_active = IFM_ETHER;
225
226	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
227	if (bmsr & BMSR_LINK)
228		mii->mii_media_status |= IFM_ACTIVE;
229
230	bmcr = PHY_READ(phy, MII_BMCR);
231	if (bmcr & BMCR_ISO) {
232		mii->mii_media_active |= IFM_NONE;
233		mii->mii_media_status = 0;
234		return;
235	}
236
237	if (bmcr & BMCR_LOOP)
238		mii->mii_media_active |= IFM_LOOP;
239
240	if (bmcr & BMCR_AUTOEN) {
241		/*
242		 * NWay autonegotiation takes the highest-order common
243		 * bit of the ANAR and ANLPAR (i.e. best media advertised
244		 * both by us and our link partner).
245		 */
246		if ((bmsr & BMSR_ACOMP) == 0) {
247			/* Erg, still trying, I guess... */
248			mii->mii_media_active |= IFM_NONE;
249			return;
250		}
251
252		if ((anlpar = PHY_READ(phy, MII_ANAR) &
253		    PHY_READ(phy, MII_ANLPAR))) {
254			if (anlpar & ANLPAR_T4)
255				mii->mii_media_active |= IFM_100_T4;
256			else if (anlpar & ANLPAR_TX_FD)
257				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
258			else if (anlpar & ANLPAR_TX)
259				mii->mii_media_active |= IFM_100_TX;
260			else if (anlpar & ANLPAR_10_FD)
261				mii->mii_media_active |= IFM_10_T|IFM_FDX;
262			else if (anlpar & ANLPAR_10)
263				mii->mii_media_active |= IFM_10_T;
264			else
265				mii->mii_media_active |= IFM_NONE;
266			return;
267		}
268		/*
269		 * If the other side doesn't support NWAY, then the
270		 * best we can do is determine if we have a 10Mbps or
271		 * 100Mbps link. There's no way to know if the link
272		 * is full or half duplex, so we default to half duplex
273		 * and hope that the user is clever enough to manually
274		 * change the media settings if we're wrong.
275		 */
276
277		/*
278		 * The RealTek PHY supports non-NWAY link speed
279		 * detection, however it does not report the link
280		 * detection results via the ANLPAR or BMSR registers.
281		 * (What? RealTek doesn't do things the way everyone
282		 * else does? I'm just shocked, shocked I tell you.)
283		 * To determine the link speed, we have to do one
284		 * of two things:
285		 *
286		 * - If this is a standalone RealTek RTL8201(L) PHY,
287		 *   we can determine the link speed by testing bit 0
288		 *   in the magic, vendor-specific register at offset
289		 *   0x19.
290		 *
291		 * - If this is a RealTek MAC with integrated PHY, we
292		 *   can test the 'SPEED10' bit of the MAC's media status
293		 *   register.
294		 */
295		if (strcmp(mii->mii_ifp->if_dname, "rl") != 0) {
296			if (PHY_READ(phy, 0x0019) & 0x01)
297				mii->mii_media_active |= IFM_100_TX;
298			else
299				mii->mii_media_active |= IFM_10_T;
300		} else {
301			if (PHY_READ(phy, RL_MEDIASTAT) &
302			    RL_MEDIASTAT_SPEED10)
303				mii->mii_media_active |= IFM_10_T;
304			else
305				mii->mii_media_active |= IFM_100_TX;
306		}
307	} else
308		mii->mii_media_active = ife->ifm_media;
309}
310