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