xref: /dflybsd-src/sys/dev/netif/mii_layer/rlphy.c (revision 39b5d600dedf02a61b8b1213f9fdaaee4b8292e0)
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.8 2005/10/24 16:55:40 dillon 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 int	rlphy_service (struct mii_softc *, struct mii_data *, int);
83 void	rlphy_status (struct mii_softc *);
84 
85 static int rlphy_probe(dev)
86 	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 rlphy_attach(dev)
121 	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 	sc->mii_capabilities =
164 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
165 	device_printf(dev, " ");
166 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
167 		printf("no media present");
168 	else
169 		mii_add_media(sc, sc->mii_capabilities);
170 	printf("\n");
171 #undef ADD
172 	MIIBUS_MEDIAINIT(sc->mii_dev);
173 	return(0);
174 }
175 
176 static int rlphy_detach(dev)
177 	device_t		dev;
178 {
179 	struct mii_softc	*sc;
180 	struct mii_data		*mii;
181 
182 	sc = device_get_softc(dev);
183 	mii = device_get_softc(device_get_softc(dev));
184 	mii_phy_auto_stop(sc);
185 	sc->mii_dev = NULL;
186 	LIST_REMOVE(sc, mii_list);
187 
188 	return(0);
189 }
190 
191 int
192 rlphy_service(sc, mii, cmd)
193 	struct mii_softc *sc;
194 	struct mii_data *mii;
195 	int cmd;
196 {
197 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
198 
199 	/*
200 	 * We can't isolate the RealTek PHY, so it has to be the only one!
201 	 */
202 	if (IFM_INST(ife->ifm_media) != sc->mii_inst)
203 		panic("rlphy_service: can't isolate RealTek PHY");
204 
205 	switch (cmd) {
206 	case MII_POLLSTAT:
207 		break;
208 
209 	case MII_MEDIACHG:
210 		/*
211 		 * If the interface is not up, don't do anything.
212 		 */
213 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
214 			break;
215 
216 		switch (IFM_SUBTYPE(ife->ifm_media)) {
217 		case IFM_AUTO:
218 			/*
219 			 * If we're already in auto mode, just return.
220 			 */
221 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
222 				return (0);
223 			(void) mii_phy_auto(sc, 0);
224 			break;
225 		case IFM_100_T4:
226 			/*
227 			 * XXX Not supported as a manual setting right now.
228 			 */
229 			return (EINVAL);
230 		default:
231 			/*
232 			 * BMCR data is stored in the ifmedia entry.
233 			 */
234 			PHY_WRITE(sc, MII_ANAR,
235 			    mii_anar(ife->ifm_media));
236 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
237 		}
238 		break;
239 
240 	case MII_TICK:
241 		/*
242 		 * Only used for autonegotiation.
243 		 */
244 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
245 			return (0);
246 
247 		/*
248 		 * Is the interface even up?
249 		 */
250 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
251 			return (0);
252 
253 		/*
254 		 * Only retry autonegotiation every 5 seconds.
255 		 */
256 		if (++sc->mii_ticks != 5)
257 			return (0);
258 
259 		sc->mii_ticks = 0;
260 
261 		/*
262 		 * The RealTek PHY's autonegotiation doesn't need to be
263 		 * kicked; it continues in the background.
264 		 */
265 		break;
266 	}
267 
268 	/* Update the media status. */
269 	rlphy_status(sc);
270 
271 	/* Callback if something changed. */
272 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
273 		MIIBUS_STATCHG(sc->mii_dev);
274 		sc->mii_active = mii->mii_media_active;
275 	}
276 	return (0);
277 }
278 
279 void
280 rlphy_status(phy)
281 	struct mii_softc *phy;
282 {
283 	struct mii_data *mii = phy->mii_pdata;
284 	int bmsr, bmcr, anlpar;
285 	device_t		parent;
286 
287 	mii->mii_media_status = IFM_AVALID;
288 	mii->mii_media_active = IFM_ETHER;
289 
290 	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
291 	if (bmsr & BMSR_LINK)
292 		mii->mii_media_status |= IFM_ACTIVE;
293 
294 	bmcr = PHY_READ(phy, MII_BMCR);
295 	if (bmcr & BMCR_ISO) {
296 		mii->mii_media_active |= IFM_NONE;
297 		mii->mii_media_status = 0;
298 		return;
299 	}
300 
301 	if (bmcr & BMCR_LOOP)
302 		mii->mii_media_active |= IFM_LOOP;
303 
304 	if (bmcr & BMCR_AUTOEN) {
305 		/*
306 		 * NWay autonegotiation takes the highest-order common
307 		 * bit of the ANAR and ANLPAR (i.e. best media advertised
308 		 * both by us and our link partner).
309 		 */
310 		if ((bmsr & BMSR_ACOMP) == 0) {
311 			/* Erg, still trying, I guess... */
312 			mii->mii_media_active |= IFM_NONE;
313 			return;
314 		}
315 
316 		if ((anlpar = PHY_READ(phy, MII_ANAR) &
317 		    PHY_READ(phy, MII_ANLPAR))) {
318 			if (anlpar & ANLPAR_T4)
319 				mii->mii_media_active |= IFM_100_T4;
320 			else if (anlpar & ANLPAR_TX_FD)
321 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
322 			else if (anlpar & ANLPAR_TX)
323 				mii->mii_media_active |= IFM_100_TX;
324 			else if (anlpar & ANLPAR_10_FD)
325 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
326 			else if (anlpar & ANLPAR_10)
327 				mii->mii_media_active |= IFM_10_T;
328 			else
329 				mii->mii_media_active |= IFM_NONE;
330 			return;
331 		}
332 		/*
333 		 * If the other side doesn't support NWAY, then the
334 		 * best we can do is determine if we have a 10Mbps or
335 		 * 100Mbps link. There's no way to know if the link
336 		 * is full or half duplex, so we default to half duplex
337 		 * and hope that the user is clever enough to manually
338 		 * change the media settings if we're wrong.
339 		 */
340 
341 
342 		/*
343 		 * The RealTek PHY supports non-NWAY link speed
344 		 * detection, however it does not report the link
345 		 * detection results via the ANLPAR or BMSR registers.
346 		 * (What? RealTek doesn't do things the way everyone
347 		 * else does? I'm just shocked, shocked I tell you.)
348 		 * To determine the link speed, we have to do one
349 		 * of two things:
350 		 *
351 		 * - If this is a standalone RealTek RTL8201(L) PHY,
352 		 *   we can determine the link speed by testing bit 0
353 		 *   in the magic, vendor-specific register at offset
354 		 *   0x19.
355 		 *
356 		 * - If this is a RealTek MAC with integrated PHY, we
357 		 *   can test the 'SPEED10' bit of the MAC's media status
358 		 *   register.
359 		 */
360 		parent = device_get_parent(phy->mii_dev);
361 		if (strcmp(device_get_name(parent), "rl") != 0) {
362 			if (PHY_READ(phy, 0x0019) & 0x01)
363 				mii->mii_media_active |= IFM_100_TX;
364 			else
365 				mii->mii_media_active |= IFM_10_T;
366 		} else {
367 			if (PHY_READ(phy, RL_MEDIASTAT) &
368 			    RL_MEDIASTAT_SPEED10)
369 				mii->mii_media_active |= IFM_10_T;
370 			else
371 				mii->mii_media_active |= IFM_100_TX;
372 		}
373 
374 	} else
375 		mii->mii_media_active = mii_media_from_bmcr(bmcr);
376 }
377