xref: /netbsd-src/sys/dev/mii/inphy.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: inphy.c,v 1.55 2016/11/08 07:22:26 msaitoh Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000 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 Intel's i82555 ethernet 10/100 PHY
59  * Data Sheet available from www.intel.com
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: inphy.c,v 1.55 2016/11/08 07:22:26 msaitoh Exp $");
64 
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/device.h>
69 #include <sys/socket.h>
70 #include <sys/errno.h>
71 
72 #include <net/if.h>
73 #include <net/if_media.h>
74 
75 #include <dev/mii/mii.h>
76 #include <dev/mii/miivar.h>
77 #include <dev/mii/miidevs.h>
78 
79 #include <dev/mii/inphyreg.h>
80 
81 static int	inphymatch(device_t, cfdata_t, void *);
82 static void	inphyattach(device_t, device_t, void *);
83 
84 CFATTACH_DECL_NEW(inphy, sizeof(struct mii_softc),
85     inphymatch, inphyattach, mii_phy_detach, mii_phy_activate);
86 
87 static int	inphy_service(struct mii_softc *, struct mii_data *, int);
88 static void	inphy_status(struct mii_softc *);
89 
90 static const struct mii_phy_funcs inphy_funcs = {
91 	inphy_service, inphy_status, mii_phy_reset,
92 };
93 
94 static const struct mii_phydesc inphys[] = {
95 	{ MII_OUI_yyINTEL,		MII_MODEL_yyINTEL_I82555,
96 	  MII_STR_yyINTEL_I82555 },
97 
98 	{ MII_OUI_yyINTEL,		MII_MODEL_yyINTEL_I82562EH,
99 	  MII_STR_yyINTEL_I82562EH },
100 
101 	{ MII_OUI_yyINTEL,		MII_MODEL_yyINTEL_I82562EM,
102 	  MII_STR_yyINTEL_I82562EM },
103 
104 	{ MII_OUI_yyINTEL,		MII_MODEL_yyINTEL_I82562ET,
105 	  MII_STR_yyINTEL_I82562ET },
106 
107 	{ MII_OUI_yyINTEL,		MII_MODEL_yyINTEL_I82562G,
108 	  MII_STR_yyINTEL_I82562G },
109 
110 	{ 0,				0,
111 	  NULL },
112 };
113 
114 static int
115 inphymatch(device_t parent, cfdata_t match, void *aux)
116 {
117 	struct mii_attach_args *ma = aux;
118 
119 	if (mii_phy_match(ma, inphys) != NULL)
120 		return (10);
121 
122 	return (0);
123 }
124 
125 static void
126 inphyattach(device_t parent, device_t self, void *aux)
127 {
128 	struct mii_softc *sc = device_private(self);
129 	struct mii_attach_args *ma = aux;
130 	struct mii_data *mii = ma->mii_data;
131 	const struct mii_phydesc *mpd;
132 
133 	mpd = mii_phy_match(ma, inphys);
134 	aprint_naive(": Media interface\n");
135 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
136 
137 	sc->mii_dev = self;
138 	sc->mii_inst = mii->mii_instance;
139 	sc->mii_phy = ma->mii_phyno;
140 	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
141 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
142 	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
143 	sc->mii_funcs = &inphy_funcs;
144 	sc->mii_pdata = mii;
145 	sc->mii_flags = ma->mii_flags;
146 	sc->mii_anegticks = MII_ANEGTICKS;
147 
148 	PHY_RESET(sc);
149 
150 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
151 	aprint_normal_dev(self, "");
152 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
153 		aprint_error("no media present");
154 	else
155 		mii_phy_add_media(sc);
156 	aprint_normal("\n");
157 }
158 
159 static int
160 inphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
161 {
162 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
163 	int reg;
164 
165 	switch (cmd) {
166 	case MII_POLLSTAT:
167 		/*
168 		 * If we're not polling our PHY instance, just return.
169 		 */
170 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
171 			return (0);
172 		break;
173 
174 	case MII_MEDIACHG:
175 		/*
176 		 * If the media indicates a different PHY instance,
177 		 * isolate ourselves.
178 		 */
179 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
180 			reg = PHY_READ(sc, MII_BMCR);
181 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
182 			return (0);
183 		}
184 
185 		/*
186 		 * If the interface is not up, don't do anything.
187 		 */
188 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
189 			break;
190 
191 		mii_phy_setmedia(sc);
192 		break;
193 
194 	case MII_TICK:
195 		/*
196 		 * If we're not currently selected, just return.
197 		 */
198 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
199 			return (0);
200 
201 		if (mii_phy_tick(sc) == EJUSTRETURN)
202 			return (0);
203 		break;
204 
205 	case MII_DOWN:
206 		mii_phy_down(sc);
207 		return (0);
208 	}
209 
210 	/* Update the media status. */
211 	mii_phy_status(sc);
212 
213 	/* Callback if something changed. */
214 	mii_phy_update(sc, cmd);
215 	return (0);
216 }
217 
218 static void
219 inphy_status(struct mii_softc *sc)
220 {
221 	struct mii_data *mii = sc->mii_pdata;
222 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
223 	int bmsr, bmcr, scr;
224 
225 	mii->mii_media_status = IFM_AVALID;
226 	mii->mii_media_active = IFM_ETHER;
227 
228 	bmsr = PHY_READ(sc, MII_BMSR) |
229 	    PHY_READ(sc, MII_BMSR);
230 	if (bmsr & BMSR_LINK)
231 		mii->mii_media_status |= IFM_ACTIVE;
232 
233 	bmcr = PHY_READ(sc, MII_BMCR);
234 	if (bmcr & BMCR_ISO) {
235 		mii->mii_media_active |= IFM_NONE;
236 		mii->mii_media_status = 0;
237 		return;
238 	}
239 
240 	if (bmcr & BMCR_LOOP)
241 		mii->mii_media_active |= IFM_LOOP;
242 
243 	if (bmcr & BMCR_AUTOEN) {
244 		if ((bmsr & BMSR_ACOMP) == 0) {
245 			/* Erg, still trying, I guess... */
246 			mii->mii_media_active |= IFM_NONE;
247 			return;
248 		}
249 
250 		scr = PHY_READ(sc, MII_INPHY_SCR);
251 		if (scr & SCR_S100)
252 			mii->mii_media_active |= IFM_100_TX;
253 		else if ((bmsr & BMSR_100T4) && (scr & SCR_T4))
254 			mii->mii_media_active |= IFM_100_T4;
255 		else
256 			mii->mii_media_active |= IFM_10_T;
257 
258 		if (scr & SCR_FDX)
259 			mii->mii_media_active |= IFM_FDX;
260 		else
261 			mii->mii_media_active |= IFM_HDX;
262 
263 		if (mii->mii_media_active & IFM_FDX)
264 			mii->mii_media_active |= mii_phy_flowstatus(sc);
265 	} else
266 		mii->mii_media_active = ife->ifm_media;
267 }
268