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