1 /*	$OpenBSD: dcphy.c,v 1.15 2005/05/27 08:04:15 brad Exp $	*/
2 
3 /*
4  * Copyright (c) 1997, 1998, 1999
5  *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD: src/sys/dev/mii/dcphy.c,v 1.6 2000/10/05 17:36:14 wpaul Exp $
35  */
36 
37 /*
38  * Pseudo-driver for internal NWAY support on DEC 21143 and workalike
39  * controllers. Technically we're abusing the miibus code to handle
40  * media selection and NWAY support here since there is no MII
41  * interface. However the logical operations are roughly the same,
42  * and the alternative is to create a fake MII interface in the driver,
43  * which is harder to do.
44  */
45 
46 #include <sys/param.h>
47 #include <sys/device.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/socket.h>
51 #include <sys/errno.h>
52 #include <sys/socket.h>
53 
54 #include <net/if.h>
55 #include <net/if_dl.h>
56 #include <net/if_types.h>
57 #include <net/if_media.h>
58 #include <netinet/in.h>
59 #include <netinet/if_ether.h>
60 
61 #include <dev/mii/mii.h>
62 #include <dev/mii/miivar.h>
63 #include <dev/mii/miidevs.h>
64 
65 #include <machine/bus.h>
66 
67 #include <dev/pci/pcivar.h>
68 
69 #include <dev/ic/dcreg.h>
70 
71 #define DC_SETBIT(sc, reg, x)                           \
72         CSR_WRITE_4(sc, reg,                            \
73                 CSR_READ_4(sc, reg) | x)
74 
75 #define DC_CLRBIT(sc, reg, x)                           \
76         CSR_WRITE_4(sc, reg,                            \
77                 CSR_READ_4(sc, reg) & ~x)
78 
79 #define MIIF_AUTOTIMEOUT	0x0004
80 
81 /*
82  * This is the subsystem ID for the built-in 21143 ethernet
83  * in several Compaq Presario systems. Apparently these are
84  * 10Mbps only, so we need to treat them specially.
85  */
86 #define COMPAQ_PRESARIO_ID	0xb0bb0e11
87 
88 int	dcphy_match(struct device *, void *, void *);
89 void	dcphy_attach(struct device *, struct device *, void *);
90 
91 struct cfattach dcphy_ca = {
92 	sizeof(struct mii_softc), dcphy_match, dcphy_attach, mii_phy_detach,
93 	    mii_phy_activate
94 };
95 
96 struct cfdriver dcphy_cd = {
97 	NULL, "dcphy", DV_DULL
98 };
99 
100 int	dcphy_service(struct mii_softc *, struct mii_data *, int);
101 void	dcphy_status(struct mii_softc *);
102 int	dcphy_mii_phy_auto(struct mii_softc *, int);
103 void	dcphy_reset(struct mii_softc *);
104 
105 const struct mii_phy_funcs dcphy_funcs = {
106 	dcphy_service, dcphy_status, dcphy_reset,
107 };
108 
109 int
dcphy_match(struct device * parent,void * match,void * aux)110 dcphy_match(struct device *parent, void *match, void *aux)
111 {
112 	struct mii_attach_args *ma = aux;
113 
114 	/*
115 	 * The dc driver will report the 21143 vendor and device
116 	 * ID to let us know that it wants us to attach.
117 	 */
118 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxDEC &&
119 	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxDEC_xxDC)
120 		return (10);
121 
122 	return (0);
123 }
124 
125 void
dcphy_attach(struct device * parent,struct device * self,void * aux)126 dcphy_attach(struct device *parent, struct device *self, void *aux)
127 {
128 	struct mii_softc *sc = (struct mii_softc *)self;
129 	struct mii_attach_args *ma = aux;
130 	struct mii_data *mii = ma->mii_data;
131 	struct dc_softc *dc_sc;
132 
133 	printf(": internal PHY\n");
134 	sc->mii_inst = mii->mii_instance;
135 	sc->mii_phy = ma->mii_phyno;
136 	sc->mii_funcs = &dcphy_funcs;
137 	sc->mii_pdata = mii;
138 	sc->mii_flags = ma->mii_flags;
139 	sc->mii_anegticks = 50;
140 
141 	sc->mii_flags |= MIIF_NOISOLATE;
142 
143 	dc_sc = mii->mii_ifp->if_softc;
144 	CSR_WRITE_4(dc_sc, DC_10BTSTAT, 0);
145 	CSR_WRITE_4(dc_sc, DC_10BTCTRL, 0);
146 
147 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
148 
149 	switch(dc_sc->dc_csid) {
150 	case COMPAQ_PRESARIO_ID:
151 		/* Example of how to only allow 10Mbps modes. */
152 		sc->mii_capabilities = BMSR_ANEG|BMSR_10TFDX|BMSR_10THDX;
153 		break;
154 	default:
155 		if (dc_sc->dc_pmode == DC_PMODE_SIA) {
156 			sc->mii_capabilities =
157 			    BMSR_ANEG|BMSR_10TFDX|BMSR_10THDX;
158 		} else {
159 			ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP,
160 			    sc->mii_inst), BMCR_LOOP|BMCR_S100);
161 
162 			sc->mii_capabilities =
163 			    BMSR_ANEG|BMSR_100TXFDX|BMSR_100TXHDX|
164 			    BMSR_10TFDX|BMSR_10THDX;
165 		}
166 		break;
167 	}
168 
169 	if (dc_sc->dc_type == DC_TYPE_21145)
170 		sc->mii_capabilities = BMSR_10THDX;
171 
172 	sc->mii_capabilities &= ma->mii_capmask;
173 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
174 		mii_phy_add_media(sc);
175 #undef ADD
176 }
177 
178 int
dcphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)179 dcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
180 {
181 	struct dc_softc *dc_sc;
182 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
183 	int reg;
184 	u_int32_t mode;
185 
186 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
187 		return (ENXIO);
188 
189 	dc_sc = mii->mii_ifp->if_softc;
190 
191 	switch (cmd) {
192 	case MII_POLLSTAT:
193 		/*
194 		 * If we're not polling our PHY instance, just return.
195 		 */
196 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
197 			return (0);
198 		}
199 		break;
200 
201 	case MII_MEDIACHG:
202 		/*
203 		 * If the media indicates a different PHY instance,
204 		 * isolate ourselves.
205 		 */
206 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
207 			return (0);
208 		}
209 
210 		/*
211 		 * If the interface is not up, don't do anything.
212 		 */
213 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
214 			break;
215 
216 		sc->mii_flags = 0;
217 		mii->mii_media_active = IFM_NONE;
218 		mode = CSR_READ_4(dc_sc, DC_NETCFG);
219 		mode &= ~(DC_NETCFG_FULLDUPLEX|DC_NETCFG_PORTSEL|
220 		    DC_NETCFG_PCS|DC_NETCFG_SCRAMBLER|DC_NETCFG_SPEEDSEL);
221 
222 		switch (IFM_SUBTYPE(ife->ifm_media)) {
223 		case IFM_AUTO:
224 			/*PHY_RESET(sc);*/
225 			sc->mii_flags &= ~MIIF_DOINGAUTO;
226 			(void) dcphy_mii_phy_auto(sc, 0);
227 			break;
228 		case IFM_100_T4:
229 			/*
230 			 * XXX Not supported as a manual setting right now.
231 			 */
232 			return (EINVAL);
233 		case IFM_100_TX:
234 			PHY_RESET(sc);
235 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
236 			mode |= DC_NETCFG_PORTSEL|DC_NETCFG_PCS|
237 			    DC_NETCFG_SCRAMBLER;
238 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
239 				mode |= DC_NETCFG_FULLDUPLEX;
240 			else
241 				mode &= ~DC_NETCFG_FULLDUPLEX;
242 			CSR_WRITE_4(dc_sc, DC_NETCFG, mode);
243 			break;
244 		case IFM_10_T:
245 			DC_CLRBIT(dc_sc, DC_SIARESET, DC_SIA_RESET);
246 			DC_CLRBIT(dc_sc, DC_10BTCTRL, 0xFFFF);
247 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
248 				DC_SETBIT(dc_sc, DC_10BTCTRL, 0x7F3D);
249 			else
250 				DC_SETBIT(dc_sc, DC_10BTCTRL, 0x7F3F);
251 			DC_SETBIT(dc_sc, DC_SIARESET, DC_SIA_RESET);
252 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
253 			mode &= ~DC_NETCFG_PORTSEL;
254 			mode |= DC_NETCFG_SPEEDSEL;
255 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX)
256 				mode |= DC_NETCFG_FULLDUPLEX;
257 			else
258 				mode &= ~DC_NETCFG_FULLDUPLEX;
259 			CSR_WRITE_4(dc_sc, DC_NETCFG, mode);
260 			break;
261 		default:
262 			return (EINVAL);
263 		}
264 		break;
265 
266 	case MII_TICK:
267 		/*
268 		 * If we're not currently selected, just return.
269 		 */
270 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
271 			return (0);
272 
273 		/*
274 		 * Is the interface even up?
275 		 */
276 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
277 			return (0);
278 
279 		/*
280 		 * Only used for autonegotiation.
281 		 */
282 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
283 			break;
284 
285 		reg = CSR_READ_4(dc_sc, DC_10BTSTAT);
286 		if (!(reg & DC_TSTAT_LS10) || !(reg & DC_TSTAT_LS100))
287 			break;
288 
289 		/*
290 		 * Only retry autonegotiation every mii_anegticks seconds.
291 		 *
292 		 * Otherwise, fall through to calling dcphy_status()
293 		 * since real Intel 21143 chips don't show valid link
294 		 * status until autonegotiation is switched off, and
295 		 * that only happens in dcphy_status().  Without this,
296 		 * successful autonegotation is never recognised on
297 		 * these chips.
298 		 */
299 		if (++sc->mii_ticks <= sc->mii_anegticks)
300 			break;
301 
302 		sc->mii_ticks = 0;
303 		sc->mii_flags &= ~MIIF_DOINGAUTO;
304 		dcphy_mii_phy_auto(sc, 0);
305 
306 		break;
307 	}
308 
309 	/* Update the media status. */
310 	mii_phy_status(sc);
311 
312 	/* Callback if something changed. */
313 	mii_phy_update(sc, cmd);
314 	return (0);
315 }
316 
317 void
dcphy_status(struct mii_softc * sc)318 dcphy_status(struct mii_softc *sc)
319 {
320 	struct mii_data *mii = sc->mii_pdata;
321 	int reg, anlpar, tstat = 0;
322 	struct dc_softc *dc_sc;
323 
324 	dc_sc = mii->mii_ifp->if_softc;
325 
326 	mii->mii_media_status = IFM_AVALID;
327 	mii->mii_media_active = IFM_ETHER;
328 
329 	if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
330 		return;
331 
332 	reg = CSR_READ_4(dc_sc, DC_10BTSTAT);
333 	if (!(reg & DC_TSTAT_LS10) || !(reg & DC_TSTAT_LS100))
334 		mii->mii_media_status |= IFM_ACTIVE;
335 
336 	if (CSR_READ_4(dc_sc, DC_10BTCTRL) & DC_TCTL_AUTONEGENBL) {
337 		/* Erg, still trying, I guess... */
338 		tstat = CSR_READ_4(dc_sc, DC_10BTSTAT);
339 		if ((tstat & DC_TSTAT_ANEGSTAT) != DC_ASTAT_AUTONEGCMP) {
340 			if ((DC_IS_MACRONIX(dc_sc) || DC_IS_PNICII(dc_sc)) &&
341 			    (tstat & DC_TSTAT_ANEGSTAT) == DC_ASTAT_DISABLE)
342 				goto skip;
343 			mii->mii_media_active |= IFM_NONE;
344 			return;
345 		}
346 
347 		if (tstat & DC_TSTAT_LP_CAN_NWAY) {
348 			anlpar = tstat >> 16;
349 			if (anlpar & ANLPAR_T4 &&
350 			    sc->mii_capabilities & BMSR_100TXHDX)
351 				mii->mii_media_active |= IFM_100_T4;
352 			else if (anlpar & ANLPAR_TX_FD &&
353 			    sc->mii_capabilities & BMSR_100TXFDX)
354 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
355 			else if (anlpar & ANLPAR_TX &&
356 			    sc->mii_capabilities & BMSR_100TXHDX)
357 				mii->mii_media_active |= IFM_100_TX;
358 			else if (anlpar & ANLPAR_10_FD)
359 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
360 			else if (anlpar & ANLPAR_10)
361 				mii->mii_media_active |= IFM_10_T;
362 			else
363 				mii->mii_media_active |= IFM_NONE;
364 			if (DC_IS_INTEL(dc_sc))
365 				DC_CLRBIT(dc_sc, DC_10BTCTRL,
366 				    DC_TCTL_AUTONEGENBL);
367 			return;
368 		}
369 		/*
370 		 * If the other side doesn't support NWAY, then the
371 		 * best we can do is determine if we have a 10Mbps or
372 		 * 100Mbps link. There's no way to know if the link
373 		 * is full or half duplex, so we default to half duplex
374 		 * and hope that the user is clever enough to manually
375 		 * change the media settings if we're wrong.
376 		 */
377 		if (!(reg & DC_TSTAT_LS100))
378 			mii->mii_media_active |= IFM_100_TX;
379 		else if (!(reg & DC_TSTAT_LS10))
380 			mii->mii_media_active |= IFM_10_T;
381 		else
382 			mii->mii_media_active |= IFM_NONE;
383 		if (DC_IS_INTEL(dc_sc))
384 			DC_CLRBIT(dc_sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
385 		return;
386 	}
387 
388 skip:
389 
390 	if (CSR_READ_4(dc_sc, DC_NETCFG) & DC_NETCFG_SPEEDSEL)
391 		mii->mii_media_active |= IFM_10_T;
392 	else
393 		mii->mii_media_active |= IFM_100_TX;
394 	if (CSR_READ_4(dc_sc, DC_NETCFG) & DC_NETCFG_FULLDUPLEX)
395 		mii->mii_media_active |= IFM_FDX;
396 
397 	return;
398 }
399 
400 int
dcphy_mii_phy_auto(struct mii_softc * mii,int waitfor)401 dcphy_mii_phy_auto(struct mii_softc *mii, int waitfor)
402 {
403 	int			i;
404 	struct dc_softc		*sc;
405 
406 	sc = mii->mii_pdata->mii_ifp->if_softc;
407 
408 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
409 		DC_CLRBIT(sc, DC_NETCFG, DC_NETCFG_PORTSEL);
410 		DC_SETBIT(sc, DC_NETCFG, DC_NETCFG_FULLDUPLEX);
411 		DC_CLRBIT(sc, DC_SIARESET, DC_SIA_RESET);
412 		if (mii->mii_capabilities & BMSR_100TXHDX)
413 			CSR_WRITE_4(sc, DC_10BTCTRL, 0x3FFFF);
414 		else
415 			CSR_WRITE_4(sc, DC_10BTCTRL, 0xFFFF);
416 		DC_SETBIT(sc, DC_SIARESET, DC_SIA_RESET);
417 		DC_SETBIT(sc, DC_10BTCTRL, DC_TCTL_AUTONEGENBL);
418 		DC_SETBIT(sc, DC_10BTSTAT, DC_ASTAT_TXDISABLE);
419 	}
420 
421 	if (waitfor) {
422 		/* Wait 500ms for it to complete. */
423 		for (i = 0; i < 500; i++) {
424 			if ((CSR_READ_4(sc, DC_10BTSTAT) & DC_TSTAT_ANEGSTAT)
425 			    == DC_ASTAT_AUTONEGCMP)
426 				return (0);
427 			DELAY(1000);
428 		}
429 		/*
430 		 * Don't need to worry about clearing MIIF_DOINGAUTO.
431 		 * If that's set, a timeout is pending, and it will
432 		 * clear the flag.
433 		 */
434 		return (EIO);
435 	}
436 
437 	/*
438 	 * Just let it finish asynchronously.  This is for the benefit of
439 	 * the tick handler driving autonegotiation.  Don't want 500ms
440 	 * delays all the time while the system is running!
441 	 */
442 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0)
443 		mii->mii_flags |= MIIF_DOINGAUTO;
444 
445 	return (EJUSTRETURN);
446 }
447 
448 void
dcphy_reset(struct mii_softc * mii)449 dcphy_reset(struct mii_softc *mii)
450 {
451 	struct dc_softc		*sc;
452 
453 	sc = mii->mii_pdata->mii_ifp->if_softc;
454 
455 	DC_CLRBIT(sc, DC_SIARESET, DC_SIA_RESET);
456 	DELAY(1000);
457 	DC_SETBIT(sc, DC_SIARESET, DC_SIA_RESET);
458 
459 	return;
460 }
461