xref: /dragonfly/sys/dev/netif/mii_layer/rlphy.c (revision 49781055)
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: src/sys/dev/mii/rlphy.c,v 1.2.2.4 2002/11/08 21:53:49 semenu Exp $
33  * $DragonFly: src/sys/dev/netif/mii_layer/rlphy.c,v 1.9 2005/10/31 09:20:05 sephe Exp $
34  */
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/socket.h>
44 #include <sys/bus.h>
45 
46 #include <net/if.h>
47 #include <net/if_arp.h>
48 #include <net/if_media.h>
49 
50 #include "mii.h"
51 #include "miivar.h"
52 #include "miidevs.h"
53 
54 #include <machine/bus.h>
55 #include "../rl/if_rlreg.h"
56 
57 #include "miibus_if.h"
58 
59 static int rlphy_probe		(device_t);
60 static int rlphy_attach		(device_t);
61 static int rlphy_detach		(device_t);
62 
63 static device_method_t rlphy_methods[] = {
64 	/* device interface */
65 	DEVMETHOD(device_probe,		rlphy_probe),
66 	DEVMETHOD(device_attach,	rlphy_attach),
67 	DEVMETHOD(device_detach,	rlphy_detach),
68 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
69 	{ 0, 0 }
70 };
71 
72 static devclass_t rlphy_devclass;
73 
74 static driver_t rlphy_driver = {
75 	"rlphy",
76 	rlphy_methods,
77 	sizeof(struct mii_softc)
78 };
79 
80 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
81 
82 static int	rlphy_service(struct mii_softc *, struct mii_data *, int);
83 static void	rlphy_status(struct mii_softc *);
84 
85 static int
86 rlphy_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(0);
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'.
111 	 */
112 	if (strcmp(device_get_name(parent), "rl") != 0)
113 		return (ENXIO);
114 
115 	device_set_desc(dev, "RealTek internal media interface");
116 
117 	return (0);
118 }
119 
120 static int
121 rlphy_attach(device_t dev)
122 {
123 	struct mii_softc	*sc;
124 	struct mii_attach_args	*ma;
125 	struct mii_data		*mii;
126 
127 	sc = device_get_softc(dev);
128 	ma = device_get_ivars(dev);
129 	mii_softc_init(sc, ma);
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_service = rlphy_service;
146 	sc->mii_pdata = mii;
147 	mii->mii_instance++;
148 
149 	sc->mii_flags |= MIIF_NOISOLATE;
150 
151 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
152 
153 #if 0 /* See above. */
154 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
155 	    BMCR_ISO);
156 #endif
157 
158 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
159 	    BMCR_LOOP|BMCR_S100);
160 
161 	mii_phy_reset(sc);
162 
163 	/*
164 	 * After PHY is reset, BMCR_AUTOEN will be cleared.
165 	 * If it is *not* turned on here, mii_pollstat() will
166 	 * lie about the active media until mii_mediachg() is
167 	 * called(in rl_init()).
168 	 */
169 	PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN);
170 
171 	sc->mii_capabilities =
172 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
173 	device_printf(dev, " ");
174 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
175 		printf("no media present");
176 	else
177 		mii_add_media(sc, sc->mii_capabilities);
178 	printf("\n");
179 #undef ADD
180 	MIIBUS_MEDIAINIT(sc->mii_dev);
181 	return(0);
182 }
183 
184 static int
185 rlphy_detach(device_t dev)
186 {
187 	struct mii_softc	*sc;
188 	struct mii_data		*mii;
189 
190 	sc = device_get_softc(dev);
191 	mii = device_get_softc(device_get_softc(dev));
192 	mii_phy_auto_stop(sc);
193 	sc->mii_dev = NULL;
194 	LIST_REMOVE(sc, mii_list);
195 
196 	return(0);
197 }
198 
199 static int
200 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
201 {
202 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
203 
204 	/*
205 	 * We can't isolate the RealTek PHY, so it has to be the only one!
206 	 */
207 	if (IFM_INST(ife->ifm_media) != sc->mii_inst)
208 		panic("rlphy_service: can't isolate RealTek PHY");
209 
210 	switch (cmd) {
211 	case MII_POLLSTAT:
212 		break;
213 
214 	case MII_MEDIACHG:
215 		/*
216 		 * If the interface is not up, don't do anything.
217 		 */
218 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
219 			break;
220 
221 		switch (IFM_SUBTYPE(ife->ifm_media)) {
222 		case IFM_AUTO:
223 			/*
224 			 * If we're already in auto mode, just return.
225 			 */
226 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
227 				return (0);
228 			(void) mii_phy_auto(sc, 0);
229 			break;
230 		case IFM_100_T4:
231 			/*
232 			 * XXX Not supported as a manual setting right now.
233 			 */
234 			return (EINVAL);
235 		default:
236 			/*
237 			 * BMCR data is stored in the ifmedia entry.
238 			 */
239 			PHY_WRITE(sc, MII_ANAR,
240 			    mii_anar(ife->ifm_media));
241 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
242 		}
243 		break;
244 
245 	case MII_TICK:
246 		/*
247 		 * Only used for autonegotiation.
248 		 */
249 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
250 			return (0);
251 
252 		/*
253 		 * Is the interface even up?
254 		 */
255 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
256 			return (0);
257 
258 		/*
259 		 * Only retry autonegotiation every 5 seconds.
260 		 */
261 		if (++sc->mii_ticks != 5)
262 			return (0);
263 
264 		sc->mii_ticks = 0;
265 
266 		/*
267 		 * The RealTek PHY's autonegotiation doesn't need to be
268 		 * kicked; it continues in the background.
269 		 */
270 		break;
271 	}
272 
273 	/* Update the media status. */
274 	rlphy_status(sc);
275 
276 	/* Callback if something changed. */
277 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
278 		MIIBUS_STATCHG(sc->mii_dev);
279 		sc->mii_active = mii->mii_media_active;
280 	}
281 	return (0);
282 }
283 
284 static void
285 rlphy_status(struct mii_softc *phy)
286 {
287 	struct mii_data *mii = phy->mii_pdata;
288 	int bmsr, bmcr, anlpar;
289 	device_t		parent;
290 
291 	mii->mii_media_status = IFM_AVALID;
292 	mii->mii_media_active = IFM_ETHER;
293 
294 	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
295 	if (bmsr & BMSR_LINK)
296 		mii->mii_media_status |= IFM_ACTIVE;
297 
298 	bmcr = PHY_READ(phy, MII_BMCR);
299 	if (bmcr & BMCR_ISO) {
300 		mii->mii_media_active |= IFM_NONE;
301 		mii->mii_media_status = 0;
302 		return;
303 	}
304 
305 	if (bmcr & BMCR_LOOP)
306 		mii->mii_media_active |= IFM_LOOP;
307 
308 	if (bmcr & BMCR_AUTOEN) {
309 		/*
310 		 * NWay autonegotiation takes the highest-order common
311 		 * bit of the ANAR and ANLPAR (i.e. best media advertised
312 		 * both by us and our link partner).
313 		 */
314 		if ((bmsr & BMSR_ACOMP) == 0) {
315 			/* Erg, still trying, I guess... */
316 			mii->mii_media_active |= IFM_NONE;
317 			return;
318 		}
319 
320 		if ((anlpar = PHY_READ(phy, MII_ANAR) &
321 		    PHY_READ(phy, MII_ANLPAR))) {
322 			if (anlpar & ANLPAR_T4)
323 				mii->mii_media_active |= IFM_100_T4;
324 			else if (anlpar & ANLPAR_TX_FD)
325 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
326 			else if (anlpar & ANLPAR_TX)
327 				mii->mii_media_active |= IFM_100_TX;
328 			else if (anlpar & ANLPAR_10_FD)
329 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
330 			else if (anlpar & ANLPAR_10)
331 				mii->mii_media_active |= IFM_10_T;
332 			else
333 				mii->mii_media_active |= IFM_NONE;
334 			return;
335 		}
336 		/*
337 		 * If the other side doesn't support NWAY, then the
338 		 * best we can do is determine if we have a 10Mbps or
339 		 * 100Mbps link. There's no way to know if the link
340 		 * is full or half duplex, so we default to half duplex
341 		 * and hope that the user is clever enough to manually
342 		 * change the media settings if we're wrong.
343 		 */
344 
345 
346 		/*
347 		 * The RealTek PHY supports non-NWAY link speed
348 		 * detection, however it does not report the link
349 		 * detection results via the ANLPAR or BMSR registers.
350 		 * (What? RealTek doesn't do things the way everyone
351 		 * else does? I'm just shocked, shocked I tell you.)
352 		 * To determine the link speed, we have to do one
353 		 * of two things:
354 		 *
355 		 * - If this is a standalone RealTek RTL8201(L) PHY,
356 		 *   we can determine the link speed by testing bit 0
357 		 *   in the magic, vendor-specific register at offset
358 		 *   0x19.
359 		 *
360 		 * - If this is a RealTek MAC with integrated PHY, we
361 		 *   can test the 'SPEED10' bit of the MAC's media status
362 		 *   register.
363 		 */
364 		parent = device_get_parent(phy->mii_dev);
365 		if (strcmp(device_get_name(parent), "rl") != 0) {
366 			if (PHY_READ(phy, 0x0019) & 0x01)
367 				mii->mii_media_active |= IFM_100_TX;
368 			else
369 				mii->mii_media_active |= IFM_10_T;
370 		} else {
371 			if (PHY_READ(phy, RL_MEDIASTAT) &
372 			    RL_MEDIASTAT_SPEED10)
373 				mii->mii_media_active |= IFM_10_T;
374 			else
375 				mii->mii_media_active |= IFM_100_TX;
376 		}
377 
378 	} else
379 		mii->mii_media_active = mii_media_from_bmcr(bmcr);
380 }
381