xref: /freebsd/sys/dev/dc/dcphy.c (revision b3aaa0cc21c63d388230c7ef2a80abd631ff20d5)
1 /*-
2  * Copyright (c) 1997, 1998, 1999
3  *	Bill Paul <wpaul@ee.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  * Pseudo-driver for internal NWAY support on DEC 21143 and workalike
38  * controllers.  Technically we're abusing the miibus code to handle
39  * media selection and NWAY support here since there is no MII
40  * interface.  However the logical operations are roughly the same,
41  * and the alternative is to create a fake MII interface in the driver,
42  * which is harder to do.
43  */
44 
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
48 #include <sys/socket.h>
49 #include <sys/errno.h>
50 #include <sys/lock.h>
51 #include <sys/module.h>
52 #include <sys/mutex.h>
53 #include <sys/bus.h>
54 
55 #include <net/if.h>
56 #include <net/if_arp.h>
57 #include <net/if_media.h>
58 
59 #include <dev/mii/mii.h>
60 #include <dev/mii/miivar.h>
61 #include "miidevs.h"
62 
63 #include <machine/bus.h>
64 #include <machine/resource.h>
65 #include <sys/bus.h>
66 
67 #include <dev/pci/pcivar.h>
68 
69 #include <dev/dc/if_dcreg.h>
70 
71 #include "miibus_if.h"
72 
73 #define DC_SETBIT(sc, reg, x)                           \
74         CSR_WRITE_4(sc, reg,                            \
75                 CSR_READ_4(sc, reg) | x)
76 
77 #define DC_CLRBIT(sc, reg, x)                           \
78         CSR_WRITE_4(sc, reg,                            \
79                 CSR_READ_4(sc, reg) & ~x)
80 
81 #define MIIF_AUTOTIMEOUT	0x0004
82 
83 /*
84  * This is the subsystem ID for the built-in 21143 ethernet
85  * in several Compaq Presario systems.  Apparently these are
86  * 10Mbps only, so we need to treat them specially.
87  */
88 #define COMPAQ_PRESARIO_ID	0xb0bb0e11
89 
90 static int dcphy_probe(device_t);
91 static int dcphy_attach(device_t);
92 
93 static device_method_t dcphy_methods[] = {
94 	/* device interface */
95 	DEVMETHOD(device_probe,		dcphy_probe),
96 	DEVMETHOD(device_attach,	dcphy_attach),
97 	DEVMETHOD(device_detach,	mii_phy_detach),
98 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
99 	{ 0, 0 }
100 };
101 
102 static devclass_t dcphy_devclass;
103 
104 static driver_t dcphy_driver = {
105 	"dcphy",
106 	dcphy_methods,
107 	sizeof(struct mii_softc)
108 };
109 
110 DRIVER_MODULE(dcphy, miibus, dcphy_driver, dcphy_devclass, 0, 0);
111 
112 static int	dcphy_service(struct mii_softc *, struct mii_data *, int);
113 static void	dcphy_status(struct mii_softc *);
114 static void	dcphy_reset(struct mii_softc *);
115 static int	dcphy_auto(struct mii_softc *);
116 
117 static int
118 dcphy_probe(device_t dev)
119 {
120 	struct mii_attach_args *ma;
121 
122 	ma = device_get_ivars(dev);
123 
124 	/*
125 	 * The dc driver will report the 21143 vendor and device
126 	 * ID to let us know that it wants us to attach.
127 	 */
128 	if (ma->mii_id1 != DC_VENDORID_DEC ||
129 	    ma->mii_id2 != DC_DEVICEID_21143)
130 		return (ENXIO);
131 
132 	device_set_desc(dev, "Intel 21143 NWAY media interface");
133 
134 	return (BUS_PROBE_DEFAULT);
135 }
136 
137 static int
138 dcphy_attach(device_t dev)
139 {
140 	struct mii_softc *sc;
141 	struct mii_attach_args *ma;
142 	struct mii_data *mii;
143 	struct dc_softc		*dc_sc;
144 	device_t brdev;
145 
146 	sc = device_get_softc(dev);
147 	ma = device_get_ivars(dev);
148 	sc->mii_dev = device_get_parent(dev);
149 	mii = device_get_softc(sc->mii_dev);
150 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
151 
152 	sc->mii_inst = mii->mii_instance;
153 	sc->mii_phy = ma->mii_phyno;
154 	sc->mii_service = dcphy_service;
155 	sc->mii_pdata = mii;
156 
157 	sc->mii_flags |= MIIF_NOISOLATE;
158 	mii->mii_instance++;
159 
160 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
161 
162 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
163 	    BMCR_ISO);
164 
165 	/*dcphy_reset(sc);*/
166 	dc_sc = mii->mii_ifp->if_softc;
167 	CSR_WRITE_4(dc_sc, DC_10BTSTAT, 0);
168 	CSR_WRITE_4(dc_sc, DC_10BTCTRL, 0);
169 
170 	brdev = device_get_parent(sc->mii_dev);
171 	switch (pci_get_subdevice(brdev) << 16 | pci_get_subvendor(brdev)) {
172 	case COMPAQ_PRESARIO_ID:
173 		/* Example of how to only allow 10Mbps modes. */
174 		sc->mii_capabilities = BMSR_ANEG | BMSR_10TFDX | BMSR_10THDX;
175 		break;
176 	default:
177 		if (dc_sc->dc_pmode == DC_PMODE_SIA)
178 			sc->mii_capabilities =
179 			    BMSR_ANEG | BMSR_10TFDX | BMSR_10THDX;
180 		else
181 			sc->mii_capabilities =
182 			    BMSR_ANEG | BMSR_100TXFDX | BMSR_100TXHDX |
183 			    BMSR_10TFDX | BMSR_10THDX;
184 		break;
185 	}
186 
187 	sc->mii_capabilities &= ma->mii_capmask;
188 	device_printf(dev, " ");
189 	mii_add_media(sc);
190 	printf("\n");
191 #undef ADD
192 
193 	MIIBUS_MEDIAINIT(sc->mii_dev);
194 	return (0);
195 }
196 
197 static int
198 dcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
199 {
200 	struct dc_softc		*dc_sc;
201 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
202 	int reg;
203 	u_int32_t		mode;
204 
205 	dc_sc = mii->mii_ifp->if_softc;
206 
207 	switch (cmd) {
208 	case MII_POLLSTAT:
209 		/*
210 		 * If we're not polling our PHY instance, just return.
211 		 */
212 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
213 			return (0);
214 		break;
215 
216 	case MII_MEDIACHG:
217 		/*
218 		 * If the media indicates a different PHY instance,
219 		 * isolate ourselves.
220 		 */
221 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
222 			return (0);
223 
224 		/*
225 		 * If the interface is not up, don't do anything.
226 		 */
227 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
228 			break;
229 
230 		sc->mii_flags = 0;
231 		mii->mii_media_active = IFM_NONE;
232 		mode = CSR_READ_4(dc_sc, DC_NETCFG);
233 		mode &= ~(DC_NETCFG_FULLDUPLEX | DC_NETCFG_PORTSEL |
234 		    DC_NETCFG_PCS | DC_NETCFG_SCRAMBLER | DC_NETCFG_SPEEDSEL);
235 
236 		switch (IFM_SUBTYPE(ife->ifm_media)) {
237 		case IFM_AUTO:
238 			/*dcphy_reset(sc);*/
239 			(void) dcphy_auto(sc);
240 			break;
241 		case IFM_100_T4:
242 			/*
243 			 * XXX Not supported as a manual setting right now.
244 			 */
245 			return (EINVAL);
246 		case IFM_100_TX:
247 			dcphy_reset(sc);
248 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
249 			mode |= DC_NETCFG_PORTSEL | DC_NETCFG_PCS |
250 			    DC_NETCFG_SCRAMBLER;
251 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
252 				mode |= DC_NETCFG_FULLDUPLEX;
253 			else
254 				mode &= ~DC_NETCFG_FULLDUPLEX;
255 			CSR_WRITE_4(dc_sc, DC_NETCFG, mode);
256 			break;
257 		case IFM_10_T:
258 			DC_CLRBIT(dc_sc, DC_SIARESET, DC_SIA_RESET);
259 			DC_CLRBIT(dc_sc, DC_10BTCTRL, 0xFFFF);
260 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
261 				DC_SETBIT(dc_sc, DC_10BTCTRL, 0x7F3D);
262 			else
263 				DC_SETBIT(dc_sc, DC_10BTCTRL, 0x7F3F);
264 			DC_SETBIT(dc_sc, DC_SIARESET, DC_SIA_RESET);
265 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
266 			mode &= ~DC_NETCFG_PORTSEL;
267 			mode |= DC_NETCFG_SPEEDSEL;
268 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
269 				mode |= DC_NETCFG_FULLDUPLEX;
270 			else
271 				mode &= ~DC_NETCFG_FULLDUPLEX;
272 			CSR_WRITE_4(dc_sc, DC_NETCFG, mode);
273 			break;
274 		default:
275 			return (EINVAL);
276 		}
277 		break;
278 
279 	case MII_TICK:
280 		/*
281 		 * If we're not currently selected, just return.
282 		 */
283 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
284 			return (0);
285 
286 		/*
287 		 * Is the interface even up?
288 		 */
289 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
290 			return (0);
291 
292 		/*
293 		 * Only used for autonegotiation.
294 		 */
295 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
296 			break;
297 
298 		reg = CSR_READ_4(dc_sc, DC_10BTSTAT);
299 		if (!(reg & DC_TSTAT_LS10) || !(reg & DC_TSTAT_LS100))
300 			break;
301 
302                 /*
303                  * Only retry autonegotiation every 5 seconds.
304 		 *
305 		 * Otherwise, fall through to calling dcphy_status()
306 		 * since real Intel 21143 chips don't show valid link
307 		 * status until autonegotiation is switched off, and
308 		 * that only happens in dcphy_status().  Without this,
309 		 * successful autonegotiation is never recognised on
310 		 * these chips.
311                  */
312                 if (++sc->mii_ticks <= 50)
313 			break;
314 
315 		sc->mii_ticks = 0;
316 		dcphy_auto(sc);
317 
318 		break;
319 	}
320 
321 	/* Update the media status. */
322 	dcphy_status(sc);
323 
324 	/* Callback if something changed. */
325 	mii_phy_update(sc, cmd);
326 	return (0);
327 }
328 
329 static void
330 dcphy_status(struct mii_softc *sc)
331 {
332 	struct mii_data *mii = sc->mii_pdata;
333 	int reg, anlpar, tstat = 0;
334 	struct dc_softc		*dc_sc;
335 
336 	dc_sc = mii->mii_ifp->if_softc;
337 
338 	mii->mii_media_status = IFM_AVALID;
339 	mii->mii_media_active = IFM_ETHER;
340 
341 	if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
342 		return;
343 
344 	reg = CSR_READ_4(dc_sc, DC_10BTSTAT);
345 	if (!(reg & DC_TSTAT_LS10) || !(reg & DC_TSTAT_LS100))
346 		mii->mii_media_status |= IFM_ACTIVE;
347 
348 	if (CSR_READ_4(dc_sc, DC_10BTCTRL) & DC_TCTL_AUTONEGENBL) {
349 		/* Erg, still trying, I guess... */
350 		tstat = CSR_READ_4(dc_sc, DC_10BTSTAT);
351 		if ((tstat & DC_TSTAT_ANEGSTAT) != DC_ASTAT_AUTONEGCMP) {
352 			if ((DC_IS_MACRONIX(dc_sc) || DC_IS_PNICII(dc_sc)) &&
353 			    (tstat & DC_TSTAT_ANEGSTAT) == DC_ASTAT_DISABLE)
354 				goto skip;
355 			mii->mii_media_active |= IFM_NONE;
356 			return;
357 		}
358 
359 		if (tstat & DC_TSTAT_LP_CAN_NWAY) {
360 			anlpar = tstat >> 16;
361 			if (anlpar & ANLPAR_TX_FD &&
362 			    sc->mii_capabilities & BMSR_100TXFDX)
363 				mii->mii_media_active |= IFM_100_TX | IFM_FDX;
364 			else if (anlpar & ANLPAR_T4 &&
365 			    sc->mii_capabilities & BMSR_100T4)
366 				mii->mii_media_active |= IFM_100_T4;
367 			else if (anlpar & ANLPAR_TX &&
368 			    sc->mii_capabilities & BMSR_100TXHDX)
369 				mii->mii_media_active |= IFM_100_TX;
370 			else if (anlpar & ANLPAR_10_FD)
371 				mii->mii_media_active |= IFM_10_T | IFM_FDX;
372 			else if (anlpar & ANLPAR_10)
373 				mii->mii_media_active |= IFM_10_T;
374 			else
375 				mii->mii_media_active |= IFM_NONE;
376 			if (DC_IS_INTEL(dc_sc))
377 				DC_CLRBIT(dc_sc, DC_10BTCTRL,
378 				    DC_TCTL_AUTONEGENBL);
379 			return;
380 		}
381 
382 		/*
383 		 * If the other side doesn't support NWAY, then the
384 		 * best we can do is determine if we have a 10Mbps or
385 		 * 100Mbps link.  There's no way to know if the link
386 		 * is full or half duplex, so we default to half duplex
387 		 * and hope that the user is clever enough to manually
388 		 * change the media settings if we're wrong.
389 		 */
390 		if (!(reg & DC_TSTAT_LS100))
391 			mii->mii_media_active |= IFM_100_TX;
392 		else if (!(reg & DC_TSTAT_LS10))
393 			mii->mii_media_active |= IFM_10_T;
394 		else
395 			mii->mii_media_active |= IFM_NONE;
396 		if (DC_IS_INTEL(dc_sc))
397 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
398 		return;
399 	}
400 
401 skip:
402 	if (CSR_READ_4(dc_sc, DC_NETCFG) & DC_NETCFG_SPEEDSEL)
403 		mii->mii_media_active |= IFM_10_T;
404 	else
405 		mii->mii_media_active |= IFM_100_TX;
406 	if (CSR_READ_4(dc_sc, DC_NETCFG) & DC_NETCFG_FULLDUPLEX)
407 		mii->mii_media_active |= IFM_FDX;
408 }
409 
410 static int
411 dcphy_auto(struct mii_softc *mii)
412 {
413 	struct dc_softc		*sc;
414 
415 	sc = mii->mii_pdata->mii_ifp->if_softc;
416 
417 	DC_CLRBIT(sc, DC_NETCFG, DC_NETCFG_PORTSEL);
418 	DC_SETBIT(sc, DC_NETCFG, DC_NETCFG_FULLDUPLEX);
419 	DC_CLRBIT(sc, DC_SIARESET, DC_SIA_RESET);
420 	if (mii->mii_capabilities & BMSR_100TXHDX)
421 		CSR_WRITE_4(sc, DC_10BTCTRL, 0x3FFFF);
422 	else
423 		CSR_WRITE_4(sc, DC_10BTCTRL, 0xFFFF);
424 	DC_SETBIT(sc, DC_SIARESET, DC_SIA_RESET);
425 	DC_SETBIT(sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
426 	DC_SETBIT(sc, DC_10BTSTAT, DC_ASTAT_TXDISABLE);
427 
428 	return (EJUSTRETURN);
429 }
430 
431 static void
432 dcphy_reset(struct mii_softc *mii)
433 {
434 	struct dc_softc		*sc;
435 
436 	sc = mii->mii_pdata->mii_ifp->if_softc;
437 
438 	DC_CLRBIT(sc, DC_SIARESET, DC_SIA_RESET);
439 	DELAY(1000);
440 	DC_SETBIT(sc, DC_SIARESET, DC_SIA_RESET);
441 }
442