xref: /freebsd/sys/dev/dc/dcphy.c (revision 87569f75a91f298c52a71823c04d41cf53c88889)
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 (0);
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 
145 	sc = device_get_softc(dev);
146 	ma = device_get_ivars(dev);
147 	sc->mii_dev = device_get_parent(dev);
148 	mii = device_get_softc(sc->mii_dev);
149 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
150 
151 	sc->mii_inst = mii->mii_instance;
152 	sc->mii_phy = ma->mii_phyno;
153 	sc->mii_service = dcphy_service;
154 	sc->mii_pdata = mii;
155 
156 	sc->mii_flags |= MIIF_NOISOLATE;
157 	mii->mii_instance++;
158 
159 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
160 
161 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
162 	    BMCR_ISO);
163 
164 	/*dcphy_reset(sc);*/
165 	dc_sc = mii->mii_ifp->if_softc;
166 	CSR_WRITE_4(dc_sc, DC_10BTSTAT, 0);
167 	CSR_WRITE_4(dc_sc, DC_10BTCTRL, 0);
168 
169 	switch(pci_read_config(device_get_parent(sc->mii_dev),
170 	    DC_PCI_CSID, 4)) {
171 	case COMPAQ_PRESARIO_ID:
172 		/* Example of how to only allow 10Mbps modes. */
173 		sc->mii_capabilities = BMSR_ANEG|BMSR_10TFDX|BMSR_10THDX;
174 		break;
175 	default:
176 		if (dc_sc->dc_pmode == DC_PMODE_SIA) {
177 			sc->mii_capabilities =
178 			    BMSR_ANEG|BMSR_10TFDX|BMSR_10THDX;
179 		} else {
180 			ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP,
181 			    sc->mii_inst), BMCR_LOOP|BMCR_S100);
182 
183 			sc->mii_capabilities =
184 			    BMSR_ANEG|BMSR_100TXFDX|BMSR_100TXHDX|
185 			    BMSR_10TFDX|BMSR_10THDX;
186 		}
187 		break;
188 	}
189 
190 	sc->mii_capabilities &= ma->mii_capmask;
191 	device_printf(dev, " ");
192 	mii_add_media(sc);
193 	printf("\n");
194 #undef ADD
195 
196 	MIIBUS_MEDIAINIT(sc->mii_dev);
197 	return(0);
198 }
199 
200 static int
201 dcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
202 {
203 	struct dc_softc		*dc_sc;
204 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
205 	int reg;
206 	u_int32_t		mode;
207 
208 	dc_sc = mii->mii_ifp->if_softc;
209 
210 	switch (cmd) {
211 	case MII_POLLSTAT:
212 		/*
213 		 * If we're not polling our PHY instance, just return.
214 		 */
215 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
216 			return (0);
217 		}
218 		break;
219 
220 	case MII_MEDIACHG:
221 		/*
222 		 * If the media indicates a different PHY instance,
223 		 * isolate ourselves.
224 		 */
225 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
226 			return (0);
227 		}
228 
229 		/*
230 		 * If the interface is not up, don't do anything.
231 		 */
232 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
233 			break;
234 
235 		sc->mii_flags = 0;
236 		mii->mii_media_active = IFM_NONE;
237 		mode = CSR_READ_4(dc_sc, DC_NETCFG);
238 		mode &= ~(DC_NETCFG_FULLDUPLEX|DC_NETCFG_PORTSEL|
239 		    DC_NETCFG_PCS|DC_NETCFG_SCRAMBLER|DC_NETCFG_SPEEDSEL);
240 
241 		switch (IFM_SUBTYPE(ife->ifm_media)) {
242 		case IFM_AUTO:
243 			/*dcphy_reset(sc);*/
244 			(void) dcphy_auto(sc);
245 			break;
246 		case IFM_100_T4:
247 			/*
248 			 * XXX Not supported as a manual setting right now.
249 			 */
250 			return (EINVAL);
251 		case IFM_100_TX:
252 			dcphy_reset(sc);
253 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
254 			mode |= DC_NETCFG_PORTSEL|DC_NETCFG_PCS|
255 			    DC_NETCFG_SCRAMBLER;
256 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
257 				mode |= DC_NETCFG_FULLDUPLEX;
258 			else
259 				mode &= ~DC_NETCFG_FULLDUPLEX;
260 			CSR_WRITE_4(dc_sc, DC_NETCFG, mode);
261 			break;
262 		case IFM_10_T:
263 			DC_CLRBIT(dc_sc, DC_SIARESET, DC_SIA_RESET);
264 			DC_CLRBIT(dc_sc, DC_10BTCTRL, 0xFFFF);
265 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
266 				DC_SETBIT(dc_sc, DC_10BTCTRL, 0x7F3D);
267 			else
268 				DC_SETBIT(dc_sc, DC_10BTCTRL, 0x7F3F);
269 			DC_SETBIT(dc_sc, DC_SIARESET, DC_SIA_RESET);
270 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
271 			mode &= ~DC_NETCFG_PORTSEL;
272 			mode |= DC_NETCFG_SPEEDSEL;
273 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
274 				mode |= DC_NETCFG_FULLDUPLEX;
275 			else
276 				mode &= ~DC_NETCFG_FULLDUPLEX;
277 			CSR_WRITE_4(dc_sc, DC_NETCFG, mode);
278 			break;
279 		default:
280 			return(EINVAL);
281 		}
282 		break;
283 
284 	case MII_TICK:
285 		/*
286 		 * If we're not currently selected, just return.
287 		 */
288 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
289 			return (0);
290 
291 		/*
292 		 * Is the interface even up?
293 		 */
294 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
295 			return (0);
296 
297 		/*
298 		 * Only used for autonegotiation.
299 		 */
300 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
301 			break;
302 
303 		reg = CSR_READ_4(dc_sc, DC_10BTSTAT);
304 		if (!(reg & DC_TSTAT_LS10) || !(reg & DC_TSTAT_LS100))
305 			break;
306 
307                 /*
308                  * Only retry autonegotiation every 5 seconds.
309 		 *
310 		 * Otherwise, fall through to calling dcphy_status()
311 		 * since real Intel 21143 chips don't show valid link
312 		 * status until autonegotiation is switched off, and
313 		 * that only happens in dcphy_status().  Without this,
314 		 * successful autonegotiation is never recognised on
315 		 * these chips.
316                  */
317                 if (++sc->mii_ticks <= 50)
318 			break;
319 
320 		sc->mii_ticks = 0;
321 		dcphy_auto(sc);
322 
323 		break;
324 	}
325 
326 	/* Update the media status. */
327 	dcphy_status(sc);
328 
329 	/* Callback if something changed. */
330 	mii_phy_update(sc, cmd);
331 	return (0);
332 }
333 
334 static void
335 dcphy_status(struct mii_softc *sc)
336 {
337 	struct mii_data *mii = sc->mii_pdata;
338 	int reg, anlpar, tstat = 0;
339 	struct dc_softc		*dc_sc;
340 
341 	dc_sc = mii->mii_ifp->if_softc;
342 
343 	mii->mii_media_status = IFM_AVALID;
344 	mii->mii_media_active = IFM_ETHER;
345 
346 	if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
347 		return;
348 
349 	reg = CSR_READ_4(dc_sc, DC_10BTSTAT);
350 	if (!(reg & DC_TSTAT_LS10) || !(reg & DC_TSTAT_LS100))
351 		mii->mii_media_status |= IFM_ACTIVE;
352 
353 	if (CSR_READ_4(dc_sc, DC_10BTCTRL) & DC_TCTL_AUTONEGENBL) {
354 		/* Erg, still trying, I guess... */
355 		tstat = CSR_READ_4(dc_sc, DC_10BTSTAT);
356 		if ((tstat & DC_TSTAT_ANEGSTAT) != DC_ASTAT_AUTONEGCMP) {
357 			if ((DC_IS_MACRONIX(dc_sc) || DC_IS_PNICII(dc_sc)) &&
358 			    (tstat & DC_TSTAT_ANEGSTAT) == DC_ASTAT_DISABLE)
359 				goto skip;
360 			mii->mii_media_active |= IFM_NONE;
361 			return;
362 		}
363 
364 		if (tstat & DC_TSTAT_LP_CAN_NWAY) {
365 			anlpar = tstat >> 16;
366 			if (anlpar & ANLPAR_T4 &&
367 			    sc->mii_capabilities & BMSR_100TXHDX)
368 				mii->mii_media_active |= IFM_100_T4;
369 			else if (anlpar & ANLPAR_TX_FD &&
370 			    sc->mii_capabilities & BMSR_100TXFDX)
371 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
372 			else if (anlpar & ANLPAR_TX &&
373 			    sc->mii_capabilities & BMSR_100TXHDX)
374 				mii->mii_media_active |= IFM_100_TX;
375 			else if (anlpar & ANLPAR_10_FD)
376 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
377 			else if (anlpar & ANLPAR_10)
378 				mii->mii_media_active |= IFM_10_T;
379 			else
380 				mii->mii_media_active |= IFM_NONE;
381 			if (DC_IS_INTEL(dc_sc))
382 				DC_CLRBIT(dc_sc, DC_10BTCTRL,
383 				    DC_TCTL_AUTONEGENBL);
384 			return;
385 		}
386 		/*
387 		 * If the other side doesn't support NWAY, then the
388 		 * best we can do is determine if we have a 10Mbps or
389 		 * 100Mbps link. There's no way to know if the link
390 		 * is full or half duplex, so we default to half duplex
391 		 * and hope that the user is clever enough to manually
392 		 * change the media settings if we're wrong.
393 		 */
394 		if (!(reg & DC_TSTAT_LS100))
395 			mii->mii_media_active |= IFM_100_TX;
396 		else if (!(reg & DC_TSTAT_LS10))
397 			mii->mii_media_active |= IFM_10_T;
398 		else
399 			mii->mii_media_active |= IFM_NONE;
400 		if (DC_IS_INTEL(dc_sc))
401 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
402 		return;
403 	}
404 
405 skip:
406 
407 	if (CSR_READ_4(dc_sc, DC_NETCFG) & DC_NETCFG_SPEEDSEL)
408 		mii->mii_media_active |= IFM_10_T;
409 	else
410 		mii->mii_media_active |= IFM_100_TX;
411 	if (CSR_READ_4(dc_sc, DC_NETCFG) & DC_NETCFG_FULLDUPLEX)
412 		mii->mii_media_active |= IFM_FDX;
413 
414 	return;
415 }
416 
417 static int
418 dcphy_auto(struct mii_softc *mii)
419 {
420 	struct dc_softc		*sc;
421 
422 	sc = mii->mii_pdata->mii_ifp->if_softc;
423 
424 	DC_CLRBIT(sc, DC_NETCFG, DC_NETCFG_PORTSEL);
425 	DC_SETBIT(sc, DC_NETCFG, DC_NETCFG_FULLDUPLEX);
426 	DC_CLRBIT(sc, DC_SIARESET, DC_SIA_RESET);
427 	if (mii->mii_capabilities & BMSR_100TXHDX)
428 		CSR_WRITE_4(sc, DC_10BTCTRL, 0x3FFFF);
429 	else
430 		CSR_WRITE_4(sc, DC_10BTCTRL, 0xFFFF);
431 	DC_SETBIT(sc, DC_SIARESET, DC_SIA_RESET);
432 	DC_SETBIT(sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
433 	DC_SETBIT(sc, DC_10BTSTAT, DC_ASTAT_TXDISABLE);
434 
435 	return(EJUSTRETURN);
436 }
437 
438 static void
439 dcphy_reset(struct mii_softc *mii)
440 {
441 	struct dc_softc		*sc;
442 
443 	sc = mii->mii_pdata->mii_ifp->if_softc;
444 
445 	DC_CLRBIT(sc, DC_SIARESET, DC_SIA_RESET);
446 	DELAY(1000);
447 	DC_SETBIT(sc, DC_SIARESET, DC_SIA_RESET);
448 
449 	return;
450 }
451 
452