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