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