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