1 /*	$NetBSD: makphy.c,v 1.41 2016/07/07 06:55:41 msaitoh 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.41 2016/07/07 06:55:41 msaitoh 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 	/* XXX: reported not to work on eg. HP XW9400 */
105 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1149,
106 	  MII_STR_xxMARVELL_E1149 },
107 
108 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1149R,
109 	  MII_STR_xxMARVELL_E1149R },
110 
111 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1111,
112 	  MII_STR_xxMARVELL_E1111 },
113 
114 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1116,
115 	  MII_STR_xxMARVELL_E1116 },
116 
117 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1145,
118 	  MII_STR_xxMARVELL_E1145 },
119 
120 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1116R,
121 	  MII_STR_xxMARVELL_E1116R },
122 
123 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1116R_29,
124 	  MII_STR_xxMARVELL_E1116R_29 },
125 
126 	{ MII_OUI_xxMARVELL,		MII_MODEL_xxMARVELL_E1543,
127 	  MII_STR_xxMARVELL_E1543 },
128 
129 	{ 0,				0,
130 	  NULL },
131 };
132 
133 static int
makphymatch(device_t parent,cfdata_t match,void * aux)134 makphymatch(device_t parent, cfdata_t match, void *aux)
135 {
136 	struct mii_attach_args *ma = aux;
137 
138 	if (mii_phy_match(ma, makphys) != NULL)
139 		return (10);
140 
141 	return (0);
142 }
143 
144 static void
makphyattach(device_t parent,device_t self,void * aux)145 makphyattach(device_t parent, device_t self, void *aux)
146 {
147 	struct mii_softc *sc = device_private(self);
148 	struct mii_attach_args *ma = aux;
149 	struct mii_data *mii = ma->mii_data;
150 	const struct mii_phydesc *mpd;
151 
152 	mpd = mii_phy_match(ma, makphys);
153 	aprint_naive(": Media interface\n");
154 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
155 
156 	sc->mii_dev = self;
157 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
158 	sc->mii_inst = mii->mii_instance;
159 	sc->mii_phy = ma->mii_phyno;
160 	sc->mii_funcs = &makphy_funcs;
161 	sc->mii_pdata = mii;
162 	sc->mii_flags = ma->mii_flags;
163 	sc->mii_anegticks = MII_ANEGTICKS;
164 
165 	switch (sc->mii_mpd_model) {
166 	case MII_MODEL_xxMARVELL_E1011:
167 	case MII_MODEL_xxMARVELL_E1112:
168 		if (PHY_READ(sc, MII_MAKPHY_ESSR) & ESSR_FIBER_LINK)
169 			sc->mii_flags |= MIIF_HAVEFIBER;
170                 break;
171 	case MII_MODEL_xxMARVELL_E1149:
172 	case MII_MODEL_xxMARVELL_E1149R:
173 		/*
174 		 * Some 88E1149 PHY's page select is initialized to
175 		 * point to other bank instead of copper/fiber bank
176 		 * which in turn resulted in wrong registers were
177 		 * accessed during PHY operation. It is believed that
178 		 * page 0 should be used for copper PHY so reinitialize
179 		 * MII_MAKPHY_EADR to select default copper PHY. If parent
180 		 * device know the type of PHY(either copper or fiber),
181 		 * that information should be used to select default
182 		 * type of PHY.
183 		 */
184 		PHY_WRITE(sc, MII_MAKPHY_EADR, 0);
185 		break;
186 	default:
187 		break;
188 	}
189 
190 	PHY_RESET(sc);
191 
192 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
193 	if (sc->mii_capabilities & BMSR_EXTSTAT)
194 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
195 
196 	aprint_normal_dev(self, "");
197 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
198 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
199 		aprint_error("no media present");
200 	else
201 		mii_phy_add_media(sc);
202 	aprint_normal("\n");
203 }
204 
205 static void
makphy_reset(struct mii_softc * sc)206 makphy_reset(struct mii_softc *sc)
207 {
208 	uint16_t pscr;
209 
210 	/* Assert CRS on transmit */
211 	pscr = PHY_READ(sc, MII_MAKPHY_PSCR);
212 	PHY_WRITE(sc, MII_MAKPHY_PSCR, pscr | PSCR_CRS_ON_TX);
213 
214 	mii_phy_reset(sc);
215 }
216 
217 static int
makphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)218 makphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
219 {
220 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
221 	int reg;
222 
223 	switch (cmd) {
224 	case MII_POLLSTAT:
225 		/*
226 		 * If we're not polling our PHY instance, just return.
227 		 */
228 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
229 			return (0);
230 		break;
231 
232 	case MII_MEDIACHG:
233 		/*
234 		 * If the media indicates a different PHY instance,
235 		 * isolate ourselves.
236 		 */
237 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
238 			reg = PHY_READ(sc, MII_BMCR);
239 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
240 			return (0);
241 		}
242 
243 		/*
244 		 * If the interface is not up, don't do anything.
245 		 */
246 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
247 			break;
248 
249 		mii_phy_setmedia(sc);
250 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
251 			/*
252 			 * when not in auto mode, we need to restart nego
253 			 * anyway, or a switch from a fixed mode to another
254 			 * fixed mode may not be seen by the switch.
255 			 */
256 			PHY_WRITE(sc, MII_BMCR,
257 			    PHY_READ(sc, MII_BMCR) | BMCR_STARTNEG);
258 		}
259 		break;
260 
261 	case MII_TICK:
262 		/*
263 		 * If we're not currently selected, just return.
264 		 */
265 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
266 			return (0);
267 
268 		if (mii_phy_tick(sc) == EJUSTRETURN)
269 			return (0);
270 		break;
271 
272 	case MII_DOWN:
273 		mii_phy_down(sc);
274 		return (0);
275 	}
276 
277 	/* Update the media status. */
278 	mii_phy_status(sc);
279 
280 	/* Callback if something changed. */
281 	mii_phy_update(sc, cmd);
282 	return (0);
283 }
284 
285 static void
makphy_status(struct mii_softc * sc)286 makphy_status(struct mii_softc *sc)
287 {
288 	struct mii_data *mii = sc->mii_pdata;
289 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
290 	int bmcr, pssr, gtsr;
291 
292 	mii->mii_media_status = IFM_AVALID;
293 	mii->mii_media_active = IFM_ETHER;
294 
295 	pssr = PHY_READ(sc, MII_MAKPHY_PSSR);
296 
297 	if (pssr & PSSR_LINK)
298 		mii->mii_media_status |= IFM_ACTIVE;
299 
300 	bmcr = PHY_READ(sc, MII_BMCR);
301 	if (bmcr & BMCR_ISO) {
302 		mii->mii_media_active |= IFM_NONE;
303 		mii->mii_media_status = 0;
304 		return;
305 	}
306 
307 	if (bmcr & BMCR_LOOP)
308 		mii->mii_media_active |= IFM_LOOP;
309 
310 	if (bmcr & BMCR_AUTOEN) {
311 		/*
312 		 * The media status bits are only valid of autonegotiation
313 		 * has completed (or it's disabled).
314 		 */
315 		if ((pssr & PSSR_RESOLVED) == 0) {
316 			/* Erg, still trying, I guess... */
317 			mii->mii_media_active |= IFM_NONE;
318 			return;
319 		}
320 
321 		switch (PSSR_SPEED_get(pssr)) {
322 		case SPEED_1000:
323 			mii->mii_media_active |= IFM_1000_T;
324 			gtsr = PHY_READ(sc, MII_100T2SR);
325 			if (gtsr & GTSR_MS_RES)
326 				mii->mii_media_active |= IFM_ETH_MASTER;
327 			break;
328 
329 		case SPEED_100:
330 			mii->mii_media_active |= IFM_100_TX;
331 			break;
332 
333 		case SPEED_10:
334 			mii->mii_media_active |= IFM_10_T;
335 			break;
336 
337 		default:
338 			mii->mii_media_active |= IFM_NONE;
339 			mii->mii_media_status = 0;
340 			return;
341 		}
342 
343 		if (pssr & PSSR_DUPLEX)
344 			mii->mii_media_active |=
345 			    IFM_FDX | mii_phy_flowstatus(sc);
346 		else
347 			mii->mii_media_active |= IFM_HDX;
348 	} else
349 		mii->mii_media_active = ife->ifm_media;
350 }
351