xref: /dragonfly/sys/dev/netif/mii_layer/rlphy.c (revision 685c703c)
1 /*	$OpenBSD: rlphy.c,v 1.23 2006/05/16 02:24:45 brad Exp $	*/
2 
3 /*
4  * Copyright (c) 1997, 1998, 1999
5  *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD: src/sys/dev/mii/rlphy.c,v 1.2.2.4 2002/11/08 21:53:49 semenu Exp $
35  * $DragonFly: src/sys/dev/netif/mii_layer/rlphy.c,v 1.10 2006/08/06 10:32:23 sephe 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_service(struct mii_softc *, struct mii_data *, int);
64 static void	rlphy_status(struct mii_softc *);
65 
66 static device_method_t rlphy_methods[] = {
67 	/* device interface */
68 	DEVMETHOD(device_probe,		rlphy_probe),
69 	DEVMETHOD(device_attach,	rlphy_attach),
70 	DEVMETHOD(device_detach,	ukphy_detach),
71 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
72 	{ 0, 0 }
73 };
74 
75 static const struct mii_phydesc rlphys[] = {
76 	MII_PHYDESC(REALTEK,	RTL8201L),
77 	MII_PHYDESC(ICPLUS,	IP101),
78 	MII_PHYDESC_NULL
79 };
80 
81 static devclass_t rlphy_devclass;
82 
83 static driver_t rlphy_driver = {
84 	"rlphy",
85 	rlphy_methods,
86 	sizeof(struct mii_softc)
87 };
88 
89 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
90 
91 static int
92 rlphy_probe(device_t dev)
93 {
94 	struct mii_attach_args *ma = device_get_ivars(dev);
95 	const struct mii_phydesc *mpd;
96 	device_t parent;
97 
98 	/*
99 	 * A "real" phy should get preference, but on the 8139 there
100 	 * is no phyid register.
101 	 */
102 	mpd = mii_phy_match(ma, rlphys);
103 	if (mpd != NULL) {
104 		device_set_desc(dev, mpd->mpd_name);
105 		return (0);
106 	}
107 
108 	/*
109 	 * RealTek PHY doesn't have vendor/device ID registers:
110 	 * the rl driver fakes up a return value of all zeros.
111 	 */
112 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
113 	    MII_MODEL(ma->mii_id2) != 0)
114 		return (ENXIO);
115 
116 	parent = device_get_parent(device_get_parent(dev));
117 
118 	/*
119 	 * Make sure the parent is an `rl'.
120 	 */
121 	if (strcmp(device_get_name(parent), "rl") != 0)
122 		return (ENXIO);
123 
124 	device_set_desc(dev, "RealTek internal media interface");
125 
126 	return (0);
127 }
128 
129 static int
130 rlphy_attach(device_t dev)
131 {
132 	struct mii_softc	*sc;
133 	struct mii_attach_args	*ma;
134 	struct mii_data		*mii;
135 
136 	sc = device_get_softc(dev);
137 	ma = device_get_ivars(dev);
138 	mii_softc_init(sc, ma);
139 	sc->mii_dev = device_get_parent(dev);
140 	mii = device_get_softc(sc->mii_dev);
141 
142 	/*
143 	 * The RealTek PHY can never be isolated, so never allow non-zero
144 	 * instances!
145 	 */
146 	if (mii->mii_instance != 0) {
147 		device_printf(dev, "ignoring this PHY, non-zero instance\n");
148 		return(ENXIO);
149 	}
150 
151 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
152 
153 	sc->mii_inst = mii->mii_instance;
154 	sc->mii_service = rlphy_service;
155 	sc->mii_pdata = mii;
156 	mii->mii_instance++;
157 
158 	sc->mii_flags |= MIIF_NOISOLATE;
159 
160 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
161 
162 #if 0 /* See above. */
163 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
164 	    BMCR_ISO);
165 #endif
166 
167 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
168 	    MII_MEDIA_100_TX);
169 
170 	mii_phy_reset(sc);
171 
172 	/*
173 	 * After PHY is reset, BMCR_AUTOEN will be cleared.
174 	 * If it is *not* turned on here, mii_pollstat() will
175 	 * lie about the active media until mii_mediachg() is
176 	 * called(in rl_init()).
177 	 */
178 	PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN);
179 
180 	sc->mii_capabilities =
181 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
182 	device_printf(dev, " ");
183 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
184 		printf("no media present");
185 	else
186 		mii_phy_add_media(sc);
187 	printf("\n");
188 #undef ADD
189 	MIIBUS_MEDIAINIT(sc->mii_dev);
190 	return(0);
191 }
192 
193 static int
194 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
195 {
196 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
197 
198 	/*
199 	 * We can't isolate the RealTek PHY, so it has to be the only one!
200 	 */
201 	KASSERT(IFM_INST(ife->ifm_media) == sc->mii_inst,
202 		("rlphy_service: can't isolate RealTek PHY"));
203 
204 	switch (cmd) {
205 	case MII_POLLSTAT:
206 		break;
207 
208 	case MII_MEDIACHG:
209 		/*
210 		 * If the interface is not up, don't do anything.
211 		 */
212 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
213 			break;
214 
215 		if (IFM_SUBTYPE(ife->ifm_media) == IFM_100_T4) {
216 			/*
217 			 * XXX Not supported as a manual setting right now.
218 			 */
219 			return (EINVAL);
220 		}
221 
222 		mii_phy_set_media(sc);
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 
253 static void
254 rlphy_status(struct mii_softc *sc)
255 {
256 	struct mii_data *mii = sc->mii_pdata;
257 	int bmsr, bmcr, anlpar;
258 
259 	mii->mii_media_status = IFM_AVALID;
260 	mii->mii_media_active = IFM_ETHER;
261 
262 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
263 	if (bmsr & BMSR_LINK)
264 		mii->mii_media_status |= IFM_ACTIVE;
265 
266 	bmcr = PHY_READ(sc, MII_BMCR);
267 	if (bmcr & BMCR_ISO) {
268 		mii->mii_media_active |= IFM_NONE;
269 		mii->mii_media_status = 0;
270 		return;
271 	}
272 
273 	if (bmcr & BMCR_LOOP)
274 		mii->mii_media_active |= IFM_LOOP;
275 
276 	if (bmcr & BMCR_AUTOEN) {
277 		device_t parent;
278 
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(sc, MII_ANAR) &
291 		    PHY_READ(sc, 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 		 * The RealTek PHY supports non-NWAY link speed
317 		 * detection, however it does not report the link
318 		 * detection results via the ANLPAR or BMSR registers.
319 		 * (What? RealTek doesn't do things the way everyone
320 		 * else does? I'm just shocked, shocked I tell you.)
321 		 * To determine the link speed, we have to do one
322 		 * of two things:
323 		 *
324 		 * - If this is a standalone RealTek RTL8201(L) PHY,
325 		 *   we can determine the link speed by testing bit 0
326 		 *   in the magic, vendor-specific register at offset
327 		 *   0x19.
328 		 *
329 		 * - If this is a RealTek MAC with integrated PHY, we
330 		 *   can test the 'SPEED10' bit of the MAC's media status
331 		 *   register.
332 		 */
333 		parent = device_get_parent(sc->mii_dev);
334 		if (strcmp(device_get_name(parent), "rl") != 0) {
335 			if (PHY_READ(sc, 0x0019) & 0x01)
336 				mii->mii_media_active |= IFM_100_TX;
337 			else
338 				mii->mii_media_active |= IFM_10_T;
339 		} else {
340 			if (PHY_READ(sc, RL_MEDIASTAT) &
341 			    RL_MEDIASTAT_SPEED10)
342 				mii->mii_media_active |= IFM_10_T;
343 			else
344 				mii->mii_media_active |= IFM_100_TX;
345 		}
346 	} else {
347 		mii->mii_media_active = mii->mii_media.ifm_cur->ifm_media;
348 	}
349 }
350