xref: /freebsd/sys/dev/mii/rlphy.c (revision aa0a1e58f0189b0fde359a8bda032887e72057fa)
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 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
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/module.h>
44 #include <sys/socket.h>
45 #include <sys/bus.h>
46 
47 #include <net/if.h>
48 #include <net/if_arp.h>
49 #include <net/if_media.h>
50 
51 #include <dev/mii/mii.h>
52 #include <dev/mii/miivar.h>
53 #include "miidevs.h"
54 
55 #include <machine/bus.h>
56 #include <pci/if_rlreg.h>
57 
58 #include "miibus_if.h"
59 
60 struct rlphy_softc {
61 	struct mii_softc sc_mii;	/* generic PHY */
62 	int sc_is_RTL8201L;		/* is an external RTL8201L PHY */
63 };
64 
65 static int rlphy_probe(device_t);
66 static int rlphy_attach(device_t);
67 
68 static device_method_t rlphy_methods[] = {
69 	/* device interface */
70 	DEVMETHOD(device_probe,		rlphy_probe),
71 	DEVMETHOD(device_attach,	rlphy_attach),
72 	DEVMETHOD(device_detach,	mii_phy_detach),
73 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
74 	{ 0, 0 }
75 };
76 
77 static devclass_t rlphy_devclass;
78 
79 static driver_t rlphy_driver = {
80 	"rlphy",
81 	rlphy_methods,
82 	sizeof(struct rlphy_softc)
83 };
84 
85 DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
86 
87 static int	rlphy_service(struct mii_softc *, struct mii_data *, int);
88 static void	rlphy_status(struct mii_softc *);
89 
90 /*
91  * RealTek internal PHYs don't have vendor/device ID registers;
92  * re(4) and rl(4) fake up a return value of all zeros.
93  */
94 static const struct mii_phydesc rlintphys[] = {
95 	{ 0, 0, "RealTek internal media interface" },
96 	MII_PHY_END
97 };
98 
99 static const struct mii_phydesc rlphys[] = {
100 	MII_PHY_DESC(REALTEK, RTL8201L),
101 	MII_PHY_DESC(xxREALTEK, RTL8201E),
102 	MII_PHY_DESC(ICPLUS, IP101),
103 	MII_PHY_END
104 };
105 
106 static int
107 rlphy_probe(device_t dev)
108 {
109 	const char *nic;
110 	int rv;
111 
112 	rv = mii_phy_dev_probe(dev, rlphys, BUS_PROBE_DEFAULT);
113 	if (rv <= 0)
114 		return (rv);
115 
116 	nic = device_get_name(device_get_parent(device_get_parent(dev)));
117 	if (strcmp(nic, "rl") == 0 || strcmp(nic, "re") == 0)
118 		return (mii_phy_dev_probe(dev, rlintphys, BUS_PROBE_DEFAULT));
119 	return (ENXIO);
120 }
121 
122 static int
123 rlphy_attach(device_t dev)
124 {
125 	struct mii_softc	*sc;
126 	struct mii_attach_args	*ma;
127 	struct mii_data		*mii;
128 	struct rlphy_softc 	*rsc;
129 
130 	sc = device_get_softc(dev);
131 	ma = device_get_ivars(dev);
132 	sc->mii_dev = device_get_parent(dev);
133 	mii = ma->mii_data;
134 
135         /*
136          * Check whether we're the RTL8201L PHY and remember so the status
137          * routine can query the proper register for speed detection.
138          */
139 	rsc = (struct rlphy_softc *)sc;
140 	if (mii_phy_dev_probe(dev, rlphys, 0) == 0)
141 		rsc->sc_is_RTL8201L++;
142 
143 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
144 
145 	sc->mii_flags = miibus_get_flags(dev);
146 	sc->mii_inst = mii->mii_instance++;
147 	sc->mii_phy = ma->mii_phyno;
148 	sc->mii_service = rlphy_service;
149 	sc->mii_pdata = mii;
150 
151 	/*
152 	 * The RealTek PHY can never be isolated.
153 	 */
154 	sc->mii_flags |= MIIF_NOISOLATE;
155 
156 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
157 
158 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
159 	    MII_MEDIA_100_TX);
160 
161 	mii_phy_reset(sc);
162 
163 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
164 	device_printf(dev, " ");
165 	mii_phy_add_media(sc);
166 	printf("\n");
167 #undef ADD
168 	MIIBUS_MEDIAINIT(sc->mii_dev);
169 	return (0);
170 }
171 
172 static int
173 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
174 {
175 
176 	switch (cmd) {
177 	case MII_POLLSTAT:
178 		break;
179 
180 	case MII_MEDIACHG:
181 		/*
182 		 * If the interface is not up, don't do anything.
183 		 */
184 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
185 			break;
186 
187 		mii_phy_setmedia(sc);
188 		break;
189 
190 	case MII_TICK:
191 		/*
192 		 * Is the interface even up?
193 		 */
194 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
195 			return (0);
196 
197 		/*
198 		 * The RealTek PHY's autonegotiation doesn't need to be
199 		 * kicked; it continues in the background.
200 		 */
201 		break;
202 	}
203 
204 	/* Update the media status. */
205 	rlphy_status(sc);
206 
207 	/* Callback if something changed. */
208 	mii_phy_update(sc, cmd);
209 	return (0);
210 }
211 
212 static void
213 rlphy_status(struct mii_softc *phy)
214 {
215 	struct rlphy_softc *rsc =(struct rlphy_softc *)phy;
216 	struct mii_data *mii = phy->mii_pdata;
217 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
218 	int bmsr, bmcr, anlpar;
219 
220 	mii->mii_media_status = IFM_AVALID;
221 	mii->mii_media_active = IFM_ETHER;
222 
223 	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
224 	if (bmsr & BMSR_LINK)
225 		mii->mii_media_status |= IFM_ACTIVE;
226 
227 	bmcr = PHY_READ(phy, MII_BMCR);
228 	if (bmcr & BMCR_ISO) {
229 		mii->mii_media_active |= IFM_NONE;
230 		mii->mii_media_status = 0;
231 		return;
232 	}
233 
234 	if (bmcr & BMCR_LOOP)
235 		mii->mii_media_active |= IFM_LOOP;
236 
237 	if (bmcr & BMCR_AUTOEN) {
238 		/*
239 		 * NWay autonegotiation takes the highest-order common
240 		 * bit of the ANAR and ANLPAR (i.e. best media advertised
241 		 * both by us and our link partner).
242 		 */
243 		if ((bmsr & BMSR_ACOMP) == 0) {
244 			/* Erg, still trying, I guess... */
245 			mii->mii_media_active |= IFM_NONE;
246 			return;
247 		}
248 
249 		if ((anlpar = PHY_READ(phy, MII_ANAR) &
250 		    PHY_READ(phy, MII_ANLPAR))) {
251 			if (anlpar & ANLPAR_TX_FD)
252 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
253 			else if (anlpar & ANLPAR_T4)
254 				mii->mii_media_active |= IFM_100_T4|IFM_HDX;
255 			else if (anlpar & ANLPAR_TX)
256 				mii->mii_media_active |= IFM_100_TX|IFM_HDX;
257 			else if (anlpar & ANLPAR_10_FD)
258 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
259 			else if (anlpar & ANLPAR_10)
260 				mii->mii_media_active |= IFM_10_T|IFM_HDX;
261 			else
262 				mii->mii_media_active |= IFM_NONE;
263 			return;
264 		}
265 		/*
266 		 * If the other side doesn't support NWAY, then the
267 		 * best we can do is determine if we have a 10Mbps or
268 		 * 100Mbps link. There's no way to know if the link
269 		 * is full or half duplex, so we default to half duplex
270 		 * and hope that the user is clever enough to manually
271 		 * change the media settings if we're wrong.
272 		 */
273 
274 		/*
275 		 * The RealTek PHY supports non-NWAY link speed
276 		 * detection, however it does not report the link
277 		 * detection results via the ANLPAR or BMSR registers.
278 		 * (What? RealTek doesn't do things the way everyone
279 		 * else does? I'm just shocked, shocked I tell you.)
280 		 * To determine the link speed, we have to do one
281 		 * of two things:
282 		 *
283 		 * - If this is a standalone RealTek RTL8201(L) PHY,
284 		 *   we can determine the link speed by testing bit 0
285 		 *   in the magic, vendor-specific register at offset
286 		 *   0x19.
287 		 *
288 		 * - If this is a RealTek MAC with integrated PHY, we
289 		 *   can test the 'SPEED10' bit of the MAC's media status
290 		 *   register.
291 		 */
292 		if (rsc->sc_is_RTL8201L) {
293 			if (PHY_READ(phy, 0x0019) & 0x01)
294 				mii->mii_media_active |= IFM_100_TX;
295 			else
296 				mii->mii_media_active |= IFM_10_T;
297 		} else {
298 			if (PHY_READ(phy, RL_MEDIASTAT) &
299 			    RL_MEDIASTAT_SPEED10)
300 				mii->mii_media_active |= IFM_10_T;
301 			else
302 				mii->mii_media_active |= IFM_100_TX;
303 		}
304 		mii->mii_media_active |= IFM_HDX;
305 	} else
306 		mii->mii_media_active = ife->ifm_media;
307 }
308