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