xref: /netbsd-src/sys/dev/mii/makphy.c (revision cac8e449158efc7261bebc8657cbb0125a2cfdde)
1 /*	$NetBSD: makphy.c,v 1.28 2008/05/04 17:06:09 xtraeme Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2001 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  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
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 THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by Manuel Bouyer.
47  * 4. The name of the author may not be used to endorse or promote products
48  *    derived from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
59  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  */
61 
62 /*
63  * Driver for the Marvell 88E1000 ``Alaska'' 10/100/1000 PHY.
64  */
65 
66 #include <sys/cdefs.h>
67 __KERNEL_RCSID(0, "$NetBSD: makphy.c,v 1.28 2008/05/04 17:06:09 xtraeme Exp $");
68 
69 #include <sys/param.h>
70 #include <sys/systm.h>
71 #include <sys/kernel.h>
72 #include <sys/device.h>
73 #include <sys/socket.h>
74 #include <sys/errno.h>
75 
76 #include <net/if.h>
77 #include <net/if_media.h>
78 
79 #include <dev/mii/mii.h>
80 #include <dev/mii/miivar.h>
81 #include <dev/mii/miidevs.h>
82 
83 #include <dev/mii/makphyreg.h>
84 
85 static int	makphymatch(device_t, cfdata_t, void *);
86 static void	makphyattach(device_t, device_t, void *);
87 
88 CFATTACH_DECL_NEW(makphy, sizeof(struct mii_softc),
89     makphymatch, makphyattach, mii_phy_detach, mii_phy_activate);
90 
91 static int	makphy_service(struct mii_softc *, struct mii_data *, int);
92 static void	makphy_status(struct mii_softc *);
93 static void	makphy_reset(struct mii_softc *);
94 
95 static const struct mii_phy_funcs makphy_funcs = {
96 	makphy_service, makphy_status, makphy_reset,
97 };
98 
99 static const struct mii_phydesc makphys[] = {
100 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1000_3,
101 	  MII_STR_xxMARVELL_E1000_3 },
102 
103 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1000_5,
104 	  MII_STR_xxMARVELL_E1000_5 },
105 
106 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1011,
107 	  MII_STR_xxMARVELL_E1011 },
108 
109 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1111,
110 	  MII_STR_xxMARVELL_E1111 },
111 
112 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1116,
113 	  MII_STR_xxMARVELL_E1116 },
114 
115 	{ 0,				0,
116 	  NULL },
117 };
118 
119 static int
120 makphymatch(device_t parent, cfdata_t match, void *aux)
121 {
122 	struct mii_attach_args *ma = aux;
123 
124 	if (mii_phy_match(ma, makphys) != NULL)
125 		return (10);
126 
127 	return (0);
128 }
129 
130 static void
131 makphyattach(device_t parent, device_t self, void *aux)
132 {
133 	struct mii_softc *sc = device_private(self);
134 	struct mii_attach_args *ma = aux;
135 	struct mii_data *mii = ma->mii_data;
136 	const struct mii_phydesc *mpd;
137 
138 	mpd = mii_phy_match(ma, makphys);
139 	aprint_naive(": Media interface\n");
140 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
141 
142 	sc->mii_dev = self;
143 	sc->mii_inst = mii->mii_instance;
144 	sc->mii_phy = ma->mii_phyno;
145 	sc->mii_funcs = &makphy_funcs;
146 	sc->mii_pdata = mii;
147 	sc->mii_flags = ma->mii_flags;
148 	sc->mii_anegticks = MII_ANEGTICKS;
149 
150 	PHY_RESET(sc);
151 
152 	sc->mii_capabilities =
153 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
154 	if (sc->mii_capabilities & BMSR_EXTSTAT)
155 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
156 
157 	aprint_normal_dev(self, "");
158 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
159 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
160 		aprint_error("no media present");
161 	else
162 		mii_phy_add_media(sc);
163 	aprint_normal("\n");
164 
165 	if (!pmf_device_register(self, NULL, mii_phy_resume))
166 		aprint_error_dev(self, "couldn't establish power handler\n");
167 }
168 
169 static void
170 makphy_reset(struct mii_softc *sc)
171 {
172 	uint16_t pscr;
173 
174 	/* Assert CRS on transmit */
175 	pscr = PHY_READ(sc, MII_MAKPHY_PSCR);
176 	PHY_WRITE(sc, MII_MAKPHY_PSCR, pscr | PSCR_CRS_ON_TX);
177 
178 	mii_phy_reset(sc);
179 }
180 
181 static int
182 makphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
183 {
184 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
185 	int reg;
186 
187 	switch (cmd) {
188 	case MII_POLLSTAT:
189 		/*
190 		 * If we're not polling our PHY instance, just return.
191 		 */
192 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
193 			return (0);
194 		break;
195 
196 	case MII_MEDIACHG:
197 		/*
198 		 * If the media indicates a different PHY instance,
199 		 * isolate ourselves.
200 		 */
201 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
202 			reg = PHY_READ(sc, MII_BMCR);
203 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
204 			return (0);
205 		}
206 
207 		/*
208 		 * If the interface is not up, don't do anything.
209 		 */
210 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
211 			break;
212 
213 		mii_phy_setmedia(sc);
214 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
215 			/*
216 			 * when not in auto mode, we need to restart nego
217 			 * anyway, or a switch from a fixed mode to another
218 			 * fixed mode may not be seen by the switch.
219 			 */
220 			PHY_WRITE(sc, MII_BMCR,
221 			    PHY_READ(sc, MII_BMCR) | BMCR_STARTNEG);
222 		}
223 		break;
224 
225 	case MII_TICK:
226 		/*
227 		 * If we're not currently selected, just return.
228 		 */
229 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
230 			return (0);
231 
232 		if (mii_phy_tick(sc) == EJUSTRETURN)
233 			return (0);
234 		break;
235 
236 	case MII_DOWN:
237 		mii_phy_down(sc);
238 		return (0);
239 	}
240 
241 	/* Update the media status. */
242 	mii_phy_status(sc);
243 
244 	/* Callback if something changed. */
245 	mii_phy_update(sc, cmd);
246 	return (0);
247 }
248 
249 static void
250 makphy_status(struct mii_softc *sc)
251 {
252 	struct mii_data *mii = sc->mii_pdata;
253 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
254 	int bmcr, pssr, gtsr;
255 
256 	mii->mii_media_status = IFM_AVALID;
257 	mii->mii_media_active = IFM_ETHER;
258 
259 	pssr = PHY_READ(sc, MII_MAKPHY_PSSR);
260 
261 	if (pssr & PSSR_LINK)
262 		mii->mii_media_status |= IFM_ACTIVE;
263 
264 	bmcr = PHY_READ(sc, MII_BMCR);
265 	if (bmcr & BMCR_ISO) {
266 		mii->mii_media_active |= IFM_NONE;
267 		mii->mii_media_status = 0;
268 		return;
269 	}
270 
271 	if (bmcr & BMCR_LOOP)
272 		mii->mii_media_active |= IFM_LOOP;
273 
274 	if (bmcr & BMCR_AUTOEN) {
275 		/*
276 		 * The media status bits are only valid of autonegotiation
277 		 * has completed (or it's disabled).
278 		 */
279 		if ((pssr & PSSR_RESOLVED) == 0) {
280 			/* Erg, still trying, I guess... */
281 			mii->mii_media_active |= IFM_NONE;
282 			return;
283 		}
284 
285 		switch (PSSR_SPEED_get(pssr)) {
286 		case SPEED_1000:
287 			mii->mii_media_active |= IFM_1000_T;
288 			gtsr = PHY_READ(sc, MII_100T2SR);
289 			if (gtsr & GTSR_MS_RES)
290 				mii->mii_media_active |= IFM_ETH_MASTER;
291 			break;
292 
293 		case SPEED_100:
294 			mii->mii_media_active |= IFM_100_TX;
295 			break;
296 
297 		case SPEED_10:
298 			mii->mii_media_active |= IFM_10_T;
299 			break;
300 
301 		default:
302 			mii->mii_media_active |= IFM_NONE;
303 			mii->mii_media_status = 0;
304 			return;
305 		}
306 
307 		if (pssr & PSSR_DUPLEX)
308 			mii->mii_media_active |=
309 			    IFM_FDX | mii_phy_flowstatus(sc);
310 	} else
311 		mii->mii_media_active = ife->ifm_media;
312 }
313