xref: /netbsd-src/sys/dev/mii/lxtphy.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: lxtphy.c,v 1.50 2016/07/07 06:55:41 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 Level One's LXT-970 ethernet 10/100 PHY
59  * datasheet from www.level1.com
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: lxtphy.c,v 1.50 2016/07/07 06:55:41 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/lxtphyreg.h>
80 
81 static int	lxtphymatch(device_t, cfdata_t, void *);
82 static void	lxtphyattach(device_t, device_t, void *);
83 
84 CFATTACH_DECL_NEW(lxtphy, sizeof(struct mii_softc),
85     lxtphymatch, lxtphyattach, mii_phy_detach, mii_phy_activate);
86 
87 static int	lxtphy_service(struct mii_softc *, struct mii_data *, int);
88 static void	lxtphy_status(struct mii_softc *);
89 static void	lxtphy_reset(struct mii_softc *);
90 
91 static void lxtphy_set_tp(struct mii_softc *);
92 static void lxtphy_set_fx(struct mii_softc *);
93 
94 static const struct mii_phy_funcs lxtphy_funcs = {
95 	lxtphy_service, lxtphy_status, lxtphy_reset,
96 };
97 
98 static const struct mii_phy_funcs lxtphy971_funcs = {
99 	lxtphy_service, ukphy_status, lxtphy_reset,
100 };
101 
102 static const struct mii_phydesc lxtphys[] = {
103 	{ MII_OUI_xxLEVEL1,		MII_MODEL_xxLEVEL1_LXT970,
104 	  MII_STR_xxLEVEL1_LXT970 },
105 
106 	{ MII_OUI_LEVEL1,		MII_MODEL_LEVEL1_LXT971,
107 	  MII_STR_LEVEL1_LXT971 },
108 
109 	{ 0,				0,
110 	  NULL },
111 };
112 
113 static int
114 lxtphymatch(device_t parent, cfdata_t match, void *aux)
115 {
116 	struct mii_attach_args *ma = aux;
117 
118 	if (mii_phy_match(ma, lxtphys) != NULL)
119 		return (10);
120 
121 	return (0);
122 }
123 
124 static void
125 lxtphyattach(device_t parent, device_t self, void *aux)
126 {
127 	struct mii_softc *sc = device_private(self);
128 	struct mii_attach_args *ma = aux;
129 	struct mii_data *mii = ma->mii_data;
130 	const struct mii_phydesc *mpd;
131 
132 	mpd = mii_phy_match(ma, lxtphys);
133 	aprint_naive(": Media interface\n");
134 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
135 
136 	sc->mii_dev = self;
137 	sc->mii_inst = mii->mii_instance;
138 	sc->mii_phy = ma->mii_phyno;
139 	if (mpd->mpd_model == MII_MODEL_LEVEL1_LXT971)
140 		sc->mii_funcs = &lxtphy971_funcs;
141 	else
142 		sc->mii_funcs = &lxtphy_funcs;
143 	sc->mii_pdata = mii;
144 	sc->mii_flags = ma->mii_flags;
145 	sc->mii_anegticks = MII_ANEGTICKS;
146 
147 	PHY_RESET(sc);
148 
149 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
150 	aprint_normal_dev(self, "");
151 
152 	if (sc->mii_flags & MIIF_HAVEFIBER) {
153 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
154 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
155 		    MII_MEDIA_100_TX);
156 		aprint_normal("100baseFX, ");
157 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
158 		    MII_MEDIA_100_TX_FDX);
159 		aprint_normal("100baseFX-FDX, ");
160 #undef ADD
161 	}
162 
163 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
164 		aprint_error("no media present");
165 	else
166 		mii_phy_add_media(sc);
167 	aprint_normal("\n");
168 }
169 
170 static int
171 lxtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
172 {
173 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
174 	int reg;
175 
176 	switch (cmd) {
177 	case MII_POLLSTAT:
178 		/*
179 		 * If we're not polling our PHY instance, just return.
180 		 */
181 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
182 			return (0);
183 		break;
184 
185 	case MII_MEDIACHG:
186 		/*
187 		 * If the media indicates a different PHY instance,
188 		 * isolate ourselves.
189 		 */
190 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
191 			reg = PHY_READ(sc, MII_BMCR);
192 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
193 			return (0);
194 		}
195 
196 		/*
197 		 * If the interface is not up, don't do anything.
198 		 */
199 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
200 			break;
201 
202 		if (IFM_SUBTYPE(ife->ifm_media) == IFM_100_FX)
203 			lxtphy_set_fx(sc);
204 		else
205 			lxtphy_set_tp(sc);
206 
207 		mii_phy_setmedia(sc);
208 		break;
209 
210 	case MII_TICK:
211 		/*
212 		 * If we're not currently selected, just return.
213 		 */
214 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
215 			return (0);
216 
217 		if (mii_phy_tick(sc) == EJUSTRETURN)
218 			return (0);
219 		break;
220 
221 	case MII_DOWN:
222 		mii_phy_down(sc);
223 		return (0);
224 	}
225 
226 	/* Update the media status. */
227 	mii_phy_status(sc);
228 
229 	/* Callback if something changed. */
230 	mii_phy_update(sc, cmd);
231 	return (0);
232 }
233 
234 static void
235 lxtphy_status(struct mii_softc *sc)
236 {
237 	struct mii_data *mii = sc->mii_pdata;
238 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
239 	int bmcr, bmsr, csr;
240 
241 	mii->mii_media_status = IFM_AVALID;
242 	mii->mii_media_active = IFM_ETHER;
243 
244 	/*
245 	 * Get link status from the CSR; we need to read the CSR
246 	 * for media type anyhow, and the link status in the CSR
247 	 * doens't latch, so fewer register reads are required.
248 	 */
249 	csr = PHY_READ(sc, MII_LXTPHY_CSR);
250 	if (csr & CSR_LINK)
251 		mii->mii_media_status |= IFM_ACTIVE;
252 
253 	bmcr = PHY_READ(sc, MII_BMCR);
254 	if (bmcr & BMCR_ISO) {
255 		mii->mii_media_active |= IFM_NONE;
256 		mii->mii_media_status = 0;
257 		return;
258 	}
259 
260 	if (bmcr & BMCR_LOOP)
261 		mii->mii_media_active |= IFM_LOOP;
262 
263 	if (bmcr & BMCR_AUTOEN) {
264 		bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
265 		if ((bmsr & BMSR_ACOMP) == 0) {
266 			/* Erg, still trying, I guess... */
267 			mii->mii_media_active |= IFM_NONE;
268 			return;
269 		}
270 		if (csr & CSR_SPEED)
271 			mii->mii_media_active |= IFM_100_TX;
272 		else
273 			mii->mii_media_active |= IFM_10_T;
274 
275 		if (csr & CSR_DUPLEX)
276 			mii->mii_media_active |= IFM_FDX;
277 		else
278 			mii->mii_media_active |= IFM_HDX;
279 	} else
280 		mii->mii_media_active = ife->ifm_media;
281 }
282 
283 static void
284 lxtphy_reset(struct mii_softc *sc)
285 {
286 
287 	mii_phy_reset(sc);
288 	PHY_WRITE(sc, MII_LXTPHY_IER,
289 	    PHY_READ(sc, MII_LXTPHY_IER) & ~IER_INTEN);
290 }
291 
292 static void
293 lxtphy_set_tp(struct mii_softc *sc)
294 {
295 	int cfg;
296 
297 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
298 	cfg &= ~CONFIG_100BASEFX;
299 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
300 }
301 
302 static void
303 lxtphy_set_fx(struct mii_softc *sc)
304 {
305 	int cfg;
306 
307 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
308 	cfg |= CONFIG_100BASEFX;
309 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
310 }
311