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