1 /* $NetBSD: lxtphy.c,v 1.56 2021/08/20 20:25:28 andvar 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.56 2021/08/20 20:25:28 andvar 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
lxtphymatch(device_t parent,cfdata_t match,void * aux)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
lxtphyattach(device_t parent,device_t self,void * aux)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
141 mii_lock(mii);
142
143 PHY_RESET(sc);
144
145 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
146 sc->mii_capabilities &= ma->mii_capmask;
147
148 mii_unlock(mii);
149
150 if (sc->mii_flags & MIIF_HAVEFIBER) {
151 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL)
152 mii_lock(mii);
153 sc->mii_anegticks = MII_ANEGTICKS;
154 mii_unlock(mii);
155 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
156 MII_MEDIA_100_TX);
157 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
158 MII_MEDIA_100_TX_FDX);
159 aprint_normal_dev(self, "100baseFX, 100baseFX-FDX\n");
160 #undef ADD
161 }
162
163 mii_phy_add_media(sc);
164 }
165
166 static int
lxtphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)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 KASSERT(mii_locked(mii));
173
174 switch (cmd) {
175 case MII_POLLSTAT:
176 /* If we're not polling our PHY instance, just return. */
177 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
178 return 0;
179 break;
180
181 case MII_MEDIACHG:
182 /*
183 * If the media indicates a different PHY instance,
184 * isolate ourselves.
185 */
186 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
187 PHY_READ(sc, MII_BMCR, ®);
188 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
189 return 0;
190 }
191
192 /* If the interface is not up, don't do anything. */
193 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
194 break;
195
196 if (IFM_SUBTYPE(ife->ifm_media) == IFM_100_FX)
197 lxtphy_set_fx(sc);
198 else
199 lxtphy_set_tp(sc);
200
201 mii_phy_setmedia(sc);
202 break;
203
204 case MII_TICK:
205 /* If we're not currently selected, just return. */
206 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
207 return 0;
208
209 if (mii_phy_tick(sc) == EJUSTRETURN)
210 return 0;
211 break;
212
213 case MII_DOWN:
214 mii_phy_down(sc);
215 return 0;
216 }
217
218 /* Update the media status. */
219 mii_phy_status(sc);
220
221 /* Callback if something changed. */
222 mii_phy_update(sc, cmd);
223 return 0;
224 }
225
226 static void
lxtphy_status(struct mii_softc * sc)227 lxtphy_status(struct mii_softc *sc)
228 {
229 struct mii_data *mii = sc->mii_pdata;
230 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
231 uint16_t bmcr, bmsr, csr;
232
233 KASSERT(mii_locked(mii));
234
235 mii->mii_media_status = IFM_AVALID;
236 mii->mii_media_active = IFM_ETHER;
237
238 /*
239 * Get link status from the CSR; we need to read the CSR
240 * for media type anyhow, and the link status in the CSR
241 * doesn't latch, so fewer register reads are required.
242 */
243 PHY_READ(sc, MII_LXTPHY_CSR, &csr);
244 if (csr & CSR_LINK)
245 mii->mii_media_status |= IFM_ACTIVE;
246
247 PHY_READ(sc, MII_BMCR, &bmcr);
248 if (bmcr & BMCR_ISO) {
249 mii->mii_media_active |= IFM_NONE;
250 mii->mii_media_status = 0;
251 return;
252 }
253
254 if (bmcr & BMCR_LOOP)
255 mii->mii_media_active |= IFM_LOOP;
256
257 if (bmcr & BMCR_AUTOEN) {
258 PHY_READ(sc, MII_BMSR, &bmsr);
259 PHY_READ(sc, MII_BMSR, &bmsr);
260 if ((bmsr & BMSR_ACOMP) == 0) {
261 /* Erg, still trying, I guess... */
262 mii->mii_media_active |= IFM_NONE;
263 return;
264 }
265 if (csr & CSR_SPEED)
266 mii->mii_media_active |= IFM_100_TX;
267 else
268 mii->mii_media_active |= IFM_10_T;
269
270 if (csr & CSR_DUPLEX)
271 mii->mii_media_active |= IFM_FDX;
272 else
273 mii->mii_media_active |= IFM_HDX;
274 } else
275 mii->mii_media_active = ife->ifm_media;
276 }
277
278 static void
lxtphy_reset(struct mii_softc * sc)279 lxtphy_reset(struct mii_softc *sc)
280 {
281 uint16_t ier;
282
283 KASSERT(mii_locked(sc->mii_pdata));
284
285 mii_phy_reset(sc);
286 PHY_READ(sc, MII_LXTPHY_IER, &ier);
287 ier &= ~IER_INTEN;
288 PHY_WRITE(sc, MII_LXTPHY_IER, ier);
289 }
290
291 static void
lxtphy_set_tp(struct mii_softc * sc)292 lxtphy_set_tp(struct mii_softc *sc)
293 {
294 uint16_t cfg;
295
296 PHY_READ(sc, MII_LXTPHY_CONFIG, &cfg);
297 cfg &= ~CONFIG_100BASEFX;
298 PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
299 }
300
301 static void
lxtphy_set_fx(struct mii_softc * sc)302 lxtphy_set_fx(struct mii_softc *sc)
303 {
304 uint16_t cfg;
305
306 PHY_READ(sc, MII_LXTPHY_CONFIG, &cfg);
307 cfg |= CONFIG_100BASEFX;
308 PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
309 }
310