rlphy.c revision 104094 
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 * $FreeBSD: head/sys/dev/mii/rlphy.c 104094 2002-09-28 17:15:38Z phk $
33 */
34
35/*
36 * driver for RealTek 8139 internal PHYs
37 */
38
39#include <sys/param.h>
40#include <sys/systm.h>
41#include <sys/kernel.h>
42#include <sys/socket.h>
43#include <sys/bus.h>
44
45#include <net/if.h>
46#include <net/if_arp.h>
47#include <net/if_media.h>
48
49#include <dev/mii/mii.h>
50#include <dev/mii/miivar.h>
51#include <dev/mii/miidevs.h>
52
53#include <machine/bus.h>
54#include <pci/if_rlreg.h>
55
56#include "miibus_if.h"
57
58#if !defined(lint)
59static const char rcsid[] =
60   "$FreeBSD: head/sys/dev/mii/rlphy.c 104094 2002-09-28 17:15:38Z phk $";
61#endif
62
63static int rlphy_probe		(device_t);
64static int rlphy_attach		(device_t);
65
66static device_method_t rlphy_methods[] = {
67	/* device interface */
68	DEVMETHOD(device_probe,		rlphy_probe),
69	DEVMETHOD(device_attach,	rlphy_attach),
70	DEVMETHOD(device_detach,	mii_phy_detach),
71	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
72	{ 0, 0 }
73};
74
75static devclass_t rlphy_devclass;
76
77static driver_t rlphy_driver = {
78	"rlphy",
79	rlphy_methods,
80	sizeof(struct mii_softc)
81};
82
83DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
84
85static int	rlphy_service(struct mii_softc *, struct mii_data *, int);
86static void	rlphy_status(struct mii_softc *);
87
88static int rlphy_probe(dev)
89	device_t		dev;
90{
91	struct mii_attach_args *ma;
92	device_t		parent;
93
94	ma = device_get_ivars(dev);
95	parent = device_get_parent(device_get_parent(dev));
96
97	/* Test for RealTek 8201L PHY */
98	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_REALTEK &&
99	    MII_MODEL(ma->mii_id2) == MII_MODEL_REALTEK_RTL8201L) {
100		device_set_desc(dev, MII_STR_REALTEK_RTL8201L);
101		return(0);
102	}
103
104	/*
105	 * RealTek PHY doesn't have vendor/device ID registers:
106	 * the rl driver fakes up a return value of all zeros.
107	 */
108	if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
109	    MII_MODEL(ma->mii_id2) != 0)
110		return (ENXIO);
111
112	/*
113	 * Make sure the parent is an `rl'.
114	 */
115	if (strcmp(device_get_name(parent), "rl") != 0)
116		return (ENXIO);
117
118	device_set_desc(dev, "RealTek internal media interface");
119
120	return (0);
121}
122
123static int rlphy_attach(dev)
124	device_t		dev;
125{
126	struct mii_softc	*sc;
127	struct mii_attach_args	*ma;
128	struct mii_data		*mii;
129
130	sc = device_get_softc(dev);
131	ma = device_get_ivars(dev);
132	sc->mii_dev = device_get_parent(dev);
133	mii = device_get_softc(sc->mii_dev);
134
135	/*
136	 * The RealTek PHY can never be isolated, so never allow non-zero
137	 * instances!
138	 */
139	if (mii->mii_instance != 0) {
140		device_printf(dev, "ignoring this PHY, non-zero instance\n");
141		return(ENXIO);
142	}
143
144	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
145
146	sc->mii_inst = mii->mii_instance;
147	sc->mii_phy = ma->mii_phyno;
148	sc->mii_service = rlphy_service;
149	sc->mii_pdata = mii;
150	mii->mii_instance++;
151
152	sc->mii_flags |= MIIF_NOISOLATE;
153
154#define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
155
156#if 0 /* See above. */
157	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
158	    BMCR_ISO);
159#endif
160
161	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
162	    BMCR_LOOP|BMCR_S100);
163
164	mii_phy_reset(sc);
165
166	sc->mii_capabilities =
167	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
168	device_printf(dev, " ");
169	mii_add_media(sc);
170	printf("\n");
171#undef ADD
172	MIIBUS_MEDIAINIT(sc->mii_dev);
173	return(0);
174}
175
176static int
177rlphy_service(sc, mii, cmd)
178	struct mii_softc *sc;
179	struct mii_data *mii;
180	int cmd;
181{
182	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
183
184	/*
185	 * We can't isolate the RealTek PHY, so it has to be the only one!
186	 */
187	if (IFM_INST(ife->ifm_media) != sc->mii_inst)
188		panic("rlphy_service: can't isolate RealTek PHY");
189
190	switch (cmd) {
191	case MII_POLLSTAT:
192		break;
193
194	case MII_MEDIACHG:
195		/*
196		 * If the interface is not up, don't do anything.
197		 */
198		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
199			break;
200
201		switch (IFM_SUBTYPE(ife->ifm_media)) {
202		case IFM_AUTO:
203			/*
204			 * If we're already in auto mode, just return.
205			 */
206			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
207				return (0);
208			(void) mii_phy_auto(sc);
209			break;
210		case IFM_100_T4:
211			/*
212			 * XXX Not supported as a manual setting right now.
213			 */
214			return (EINVAL);
215		default:
216			/*
217			 * BMCR data is stored in the ifmedia entry.
218			 */
219			PHY_WRITE(sc, MII_ANAR,
220			    mii_anar(ife->ifm_media));
221			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
222		}
223		break;
224
225	case MII_TICK:
226		/*
227		 * Is the interface even up?
228		 */
229		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
230			return (0);
231
232		/*
233		 * Only used for autonegotiation.
234		 */
235		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
236			break;
237
238		/*
239		 * The RealTek PHY's autonegotiation doesn't need to be
240		 * kicked; it continues in the background.
241		 */
242		break;
243	}
244
245	/* Update the media status. */
246	rlphy_status(sc);
247
248	/* Callback if something changed. */
249	mii_phy_update(sc, cmd);
250	return (0);
251}
252
253static void
254rlphy_status(phy)
255	struct mii_softc *phy;
256{
257	struct mii_data *mii = phy->mii_pdata;
258	int bmsr, bmcr, anlpar;
259	device_t		parent;
260
261	mii->mii_media_status = IFM_AVALID;
262	mii->mii_media_active = IFM_ETHER;
263
264	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
265	if (bmsr & BMSR_LINK)
266		mii->mii_media_status |= IFM_ACTIVE;
267
268	bmcr = PHY_READ(phy, MII_BMCR);
269	if (bmcr & BMCR_ISO) {
270		mii->mii_media_active |= IFM_NONE;
271		mii->mii_media_status = 0;
272		return;
273	}
274
275	if (bmcr & BMCR_LOOP)
276		mii->mii_media_active |= IFM_LOOP;
277
278	if (bmcr & BMCR_AUTOEN) {
279		/*
280		 * NWay autonegotiation takes the highest-order common
281		 * bit of the ANAR and ANLPAR (i.e. best media advertised
282		 * both by us and our link partner).
283		 */
284		if ((bmsr & BMSR_ACOMP) == 0) {
285			/* Erg, still trying, I guess... */
286			mii->mii_media_active |= IFM_NONE;
287			return;
288		}
289
290		if ((anlpar = PHY_READ(phy, MII_ANAR) &
291		    PHY_READ(phy, MII_ANLPAR))) {
292			if (anlpar & ANLPAR_T4)
293				mii->mii_media_active |= IFM_100_T4;
294			else if (anlpar & ANLPAR_TX_FD)
295				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
296			else if (anlpar & ANLPAR_TX)
297				mii->mii_media_active |= IFM_100_TX;
298			else if (anlpar & ANLPAR_10_FD)
299				mii->mii_media_active |= IFM_10_T|IFM_FDX;
300			else if (anlpar & ANLPAR_10)
301				mii->mii_media_active |= IFM_10_T;
302			else
303				mii->mii_media_active |= IFM_NONE;
304			return;
305		}
306		/*
307		 * If the other side doesn't support NWAY, then the
308		 * best we can do is determine if we have a 10Mbps or
309		 * 100Mbps link. There's no way to know if the link
310		 * is full or half duplex, so we default to half duplex
311		 * and hope that the user is clever enough to manually
312		 * change the media settings if we're wrong.
313		 */
314
315
316		/*
317		 * The RealTek PHY supports non-NWAY link speed
318		 * detection, however it does not report the link
319		 * detection results via the ANLPAR or BMSR registers.
320		 * (What? RealTek doesn't do things the way everyone
321		 * else does? I'm just shocked, shocked I tell you.)
322		 * To determine the link speed, we have to do one
323		 * of two things:
324		 *
325		 * - If this is a standalone RealTek RTL8201(L) PHY,
326		 *   we can determine the link speed by testing bit 0
327		 *   in the magic, vendor-specific register at offset
328		 *   0x19.
329		 *
330		 * - If this is a RealTek MAC with integrated PHY, we
331		 *   can test the 'SPEED10' bit of the MAC's media status
332		 *   register.
333		 */
334		parent = device_get_parent(phy->mii_dev);
335		if (strcmp(device_get_name(parent), "rl") != 0) {
336			if (PHY_READ(phy, 0x0019) & 0x01)
337				mii->mii_media_active |= IFM_100_TX;
338			else
339				mii->mii_media_active |= IFM_10_T;
340		} else {
341			if (PHY_READ(phy, RL_MEDIASTAT) &
342			    RL_MEDIASTAT_SPEED10)
343				mii->mii_media_active |= IFM_10_T;
344			else
345				mii->mii_media_active |= IFM_100_TX;
346		}
347
348	} else
349		mii->mii_media_active = mii_media_from_bmcr(bmcr);
350}
351