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