1 /*	$NetBSD: mii_physubr.c,v 1.5 1999/08/03 19:41:49 drochner Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  *
39  * $FreeBSD: src/sys/dev/mii/mii_physubr.c,v 1.2.2.1 2000/12/12 19:29:14 wpaul Exp $
40  * $DragonFly: src/sys/dev/netif/mii_layer/mii_physubr.c,v 1.11 2005/12/11 01:54:08 swildner Exp $
41  */
42 
43 /*
44  * Subroutines common to all PHYs.
45  */
46 
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/socket.h>
51 #include <sys/errno.h>
52 #include <sys/module.h>
53 #include <sys/bus.h>
54 #include <sys/thread2.h>
55 
56 #include <machine/clock.h>
57 
58 #include <net/if.h>
59 #include <net/if_media.h>
60 
61 #include "mii.h"
62 #include "miivar.h"
63 
64 #include "miibus_if.h"
65 
66 void	mii_phy_auto_timeout (void *);
67 
68 void
69 mii_softc_init(struct mii_softc *mii, struct mii_attach_args *ma)
70 {
71 	callout_init(&mii->mii_auto_ch);
72 	mii->mii_phy = ma->mii_phyno;
73 	mii->mii_flags |= ma->mii_flags;
74 }
75 
76 int
77 mii_phy_auto(struct mii_softc *mii, int waitfor)
78 {
79 	int bmsr, i;
80 
81 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
82 		PHY_WRITE(mii, MII_ANAR, mii_bmsr_media_to_anar(mii));
83 		PHY_WRITE(mii, MII_BMCR, BMCR_AUTOEN | BMCR_STARTNEG);
84 	}
85 
86 	if (waitfor) {
87 		/* Wait 500ms for it to complete. */
88 		for (i = 0; i < 500; i++) {
89 			if ((bmsr = PHY_READ(mii, MII_BMSR)) & BMSR_ACOMP)
90 				return (0);
91 			DELAY(1000);
92 #if 0
93 		if ((bmsr & BMSR_ACOMP) == 0)
94 			printf("%s: autonegotiation failed to complete\n",
95 			    mii->mii_dev.dv_xname);
96 #endif
97 		}
98 
99 		/*
100 		 * Don't need to worry about clearing MIIF_DOINGAUTO.
101 		 * If that's set, a timeout is pending, and it will
102 		 * clear the flag.
103 		 */
104 		return (EIO);
105 	}
106 
107 	/*
108 	 * Just let it finish asynchronously.  This is for the benefit of
109 	 * the tick handler driving autonegotiation.  Don't want 500ms
110 	 * delays all the time while the system is running!
111 	 */
112 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
113 		mii->mii_flags |= MIIF_DOINGAUTO;
114 		callout_reset(&mii->mii_auto_ch, hz >> 1,
115 				mii_phy_auto_timeout, mii);
116 	}
117 	return (EJUSTRETURN);
118 }
119 
120 void
121 mii_phy_auto_stop(struct mii_softc *sc)
122 {
123 	if (sc->mii_flags & MIIF_DOINGAUTO) {
124 		sc->mii_flags &= ~MIIF_DOINGAUTO;
125 		callout_stop(&sc->mii_auto_ch);
126 	}
127 }
128 
129 void
130 mii_phy_auto_timeout(void *arg)
131 {
132 	struct mii_softc *mii = arg;
133 	int bmsr;
134 
135 	crit_enter();
136 
137 	mii->mii_flags &= ~MIIF_DOINGAUTO;
138 	bmsr = PHY_READ(mii, MII_BMSR);
139 #if 0
140 	if ((bmsr & BMSR_ACOMP) == 0)
141 		printf("%s: autonegotiation failed to complete\n",
142 		    sc->sc_dev.dv_xname);
143 #endif
144 
145 	/* Update the media status. */
146 	(void) (*mii->mii_service)(mii, mii->mii_pdata, MII_POLLSTAT);
147 
148 	crit_exit();
149 }
150 
151 void
152 mii_phy_reset(struct mii_softc *mii)
153 {
154 	int reg, i;
155 
156 	if (mii->mii_flags & MIIF_NOISOLATE)
157 		reg = BMCR_RESET;
158 	else
159 		reg = BMCR_RESET | BMCR_ISO;
160 	PHY_WRITE(mii, MII_BMCR, reg);
161 
162 	/* Wait 100ms for it to complete. */
163 	for (i = 0; i < 100; i++) {
164 		reg = PHY_READ(mii, MII_BMCR);
165 		if ((reg & BMCR_RESET) == 0)
166 			break;
167 		DELAY(1000);
168 	}
169 
170 	if (mii->mii_inst != 0 && ((mii->mii_flags & MIIF_NOISOLATE) == 0))
171 		PHY_WRITE(mii, MII_BMCR, reg | BMCR_ISO);
172 }
173 
174 /*
175  * Given an ifmedia word, return the corresponding ANAR value.
176  */
177 int
178 mii_anar(int media)
179 {
180 	int rv;
181 
182 	rv = ANAR_CSMA;
183 	switch (media & (IFM_TMASK|IFM_NMASK|IFM_FDX)) {
184 	case IFM_ETHER|IFM_1000_T:
185 		rv |= ANAR_1000;
186 		break;
187 	case IFM_ETHER|IFM_1000_T|IFM_FDX:
188 		rv |= ANAR_1000_FD;
189 		break;
190 	case IFM_ETHER|IFM_10_T:
191 		rv |= ANAR_10;
192 		break;
193 	case IFM_ETHER|IFM_10_T|IFM_FDX:
194 		rv |= ANAR_10_FD;
195 		break;
196 	case IFM_ETHER|IFM_100_TX:
197 		rv |= ANAR_TX;
198 		break;
199 	case IFM_ETHER|IFM_100_TX|IFM_FDX:
200 		rv |= ANAR_TX_FD;
201 		break;
202 	case IFM_ETHER|IFM_100_T4:
203 		rv |= ANAR_T4;
204 		break;
205 	default:
206 		rv = 0;
207 		break;
208 	}
209 	return (rv);
210 }
211 
212 /*
213  * Given a BMCR value, return the corresponding ifmedia word.
214  */
215 int
216 mii_media_from_bmcr(int bmcr)
217 {
218 	int rv = IFM_ETHER;
219 
220 	if (bmcr & BMCR_S100)
221 		rv |= IFM_100_TX;
222 	else
223 		rv |= IFM_10_T;
224 	if (bmcr & BMCR_FDX)
225 		rv |= IFM_FDX;
226 
227 	return (rv);
228 }
229 
230 /*
231  * Initialize generic PHY media based on BMSR, called when a PHY is
232  * attached.  We expect to be set up to print a comma-separated list
233  * of media names.  Does not print a newline.
234  */
235 void
236 mii_add_media(struct mii_softc *sc, int bmsr)
237 {
238 	struct mii_data *mii = sc->mii_pdata;
239 	int instance = sc->mii_inst;
240 	const char *sep = "";
241 
242 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
243 #define	PRINT(s)	printf("%s%s", sep, s); sep = ", "
244 
245 	if (bmsr & BMSR_10THDX) {
246 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, 0, instance), 0);
247 		PRINT("10baseT");
248 	}
249 	if (bmsr & BMSR_10TFDX) {
250 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_FDX, instance),
251 		    BMCR_FDX);
252 		PRINT("10baseT-FDX");
253 	}
254 	if (bmsr & BMSR_100TXHDX) {
255 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, 0, instance),
256 		    BMCR_S100);
257 		PRINT("100baseTX");
258 	}
259 	if (bmsr & BMSR_100TXFDX) {
260 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_FDX, instance),
261 		    BMCR_S100|BMCR_FDX);
262 		PRINT("100baseTX-FDX");
263 	}
264 	if (bmsr & BMSR_100T4) {
265 		/*
266 		 * XXX How do you enable 100baseT4?  I assume we set
267 		 * XXX BMCR_S100 and then assume the PHYs will take
268 		 * XXX watever action is necessary to switch themselves
269 		 * XXX into T4 mode.
270 		 */
271 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_T4, 0, instance),
272 		    BMCR_S100);
273 		PRINT("100baseT4");
274 	}
275 	if (sc->mii_flags & MIIF_IS_1000X) {
276 		if (bmsr & BMSR_1000) {
277 			ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, IFM_FDX,
278 			    instance), BMCR_S1000);
279 			PRINT("1000baseT-FDX");
280 		}
281 	}
282 	if (bmsr & BMSR_ANEG) {
283 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, instance),
284 		    BMCR_AUTOEN);
285 		PRINT("auto");
286 	}
287 #undef ADD
288 #undef PRINT
289 }
290 
291 int
292 mii_bmsr_media_to_anar(struct mii_softc *mii)
293 {
294 	int bmsr = mii->mii_capabilities;
295  	int res = ANAR_CSMA;
296 
297 	if (bmsr & BMSR_100T4)
298 		res |= ANAR_T4;
299 	if (bmsr & BMSR_100TXFDX)
300 		res |= ANAR_TX_FD;
301 	if (bmsr & BMSR_100TXHDX)
302 		res |= ANAR_TX;
303 	if (bmsr & BMSR_10TFDX)
304 		res |= ANAR_10_FD;
305 	if (bmsr & BMSR_10THDX)
306 		res |= ANAR_10;
307 	if (mii->mii_flags & MIIF_IS_1000X) {
308 		if (bmsr & BMSR_1000)
309 			res |= ANAR_1000_FD;
310 	}
311 	return (res);
312 }
313