tlphy.c revision 1.13 1 /* $NetBSD: tlphy.c,v 1.13 1998/11/04 23:07:15 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 1998 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 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 /*
41 * Copyright (c) 1997 Manuel Bouyer. All rights reserved.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by Manuel Bouyer.
54 * 4. The name of the author may not be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 */
68
69 /*
70 * Driver for Texas Instruments's ThunderLAN PHYs
71 */
72
73 #include <sys/param.h>
74 #include <sys/systm.h>
75 #include <sys/kernel.h>
76 #include <sys/device.h>
77 #include <sys/socket.h>
78
79 #include <machine/bus.h>
80
81 #include <net/if.h>
82 #include <net/if_media.h>
83
84 #include <net/if_ether.h>
85
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 #include <dev/mii/miidevs.h>
89
90 #include <dev/i2c/i2c_bus.h>
91
92 #include <dev/mii/tlphyreg.h>
93 #include <dev/mii/tlphyvar.h>
94
95 /* ThunderLAN PHY can only be on a ThunderLAN */
96 #include <dev/pci/if_tlvar.h>
97
98 struct tlphy_softc {
99 struct mii_softc sc_mii; /* generic PHY */
100 int sc_ticks;
101 int sc_tlphycap;
102 int sc_active;
103 };
104
105 int tlphymatch __P((struct device *, struct cfdata *, void *));
106 void tlphyattach __P((struct device *, struct device *, void *));
107
108 struct cfattach tlphy_ca = {
109 sizeof(struct tlphy_softc), tlphymatch, tlphyattach
110 };
111
112 int tlphy_service __P((struct mii_softc *, struct mii_data *, int));
113 void tlphy_reset __P((struct tlphy_softc *));
114 void tlphy_auto __P((struct tlphy_softc *));
115 void tlphy_status __P((struct tlphy_softc *));
116
117 int
118 tlphymatch(parent, match, aux)
119 struct device *parent;
120 struct cfdata *match;
121 void *aux;
122 {
123 struct mii_attach_args *ma = aux;
124
125 if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_TI &&
126 MII_MODEL(ma->mii_id2) == MII_MODEL_TI_TLAN10T)
127 return (1);
128
129 return (0);
130 }
131
132 void
133 tlphyattach(parent, self, aux)
134 struct device *parent, *self;
135 void *aux;
136 {
137 struct tlphy_softc *sc = (struct tlphy_softc *)self;
138 struct tl_softc *tlsc = (struct tl_softc *)self->dv_parent;
139 struct mii_attach_args *ma = aux;
140 struct mii_data *mii = ma->mii_data;
141 const char *sep = "";
142
143 printf(": %s, rev. %d\n", MII_STR_TI_TLAN10T,
144 MII_REV(ma->mii_id2));
145
146 sc->sc_mii.mii_inst = mii->mii_instance;
147 sc->sc_mii.mii_phy = ma->mii_phyno;
148 sc->sc_mii.mii_service = tlphy_service;
149 sc->sc_mii.mii_pdata = mii;
150
151 tlphy_reset(sc);
152
153 /*
154 * Note that if we're on a device that also supports 100baseTX,
155 * we are not going to want to use the built-in 10baseT port,
156 * since there will be another PHY on the MII wired up to the
157 * UTP connector. The parent indicates this to us by specifying
158 * the TLPHY_MEDIA_NO_10_T bit.
159 */
160 sc->sc_tlphycap = tlsc->tl_product->tp_tlphymedia;
161 if ((sc->sc_tlphycap & TLPHY_MEDIA_NO_10_T) == 0)
162 sc->sc_mii.mii_capabilities =
163 PHY_READ(&sc->sc_mii, MII_BMSR) & ma->mii_capmask;
164 else
165 sc->sc_mii.mii_capabilities = 0;
166
167 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL)
168
169 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->sc_mii.mii_inst),
170 BMCR_ISO);
171
172 if ((sc->sc_tlphycap & TLPHY_MEDIA_NO_10_T) == 0)
173 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_LOOP,
174 sc->sc_mii.mii_inst), BMCR_LOOP);
175
176 #define PRINT(s) printf("%s%s", sep, s); sep = ", "
177
178 printf("%s: ", sc->sc_mii.mii_dev.dv_xname);
179 if (sc->sc_tlphycap) {
180 if (sc->sc_tlphycap & TLPHY_MEDIA_10_2) {
181 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_2, 0,
182 sc->sc_mii.mii_inst), 0);
183 PRINT("10base2/BNC");
184 } else if (sc->sc_tlphycap & TLPHY_MEDIA_10_5) {
185 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_5, 0,
186 sc->sc_mii.mii_inst), 0);
187 PRINT("10base5/AUI");
188 }
189 }
190 if (sc->sc_mii.mii_capabilities & BMSR_MEDIAMASK) {
191 printf(sep);
192 mii_add_media(mii, sc->sc_mii.mii_capabilities,
193 sc->sc_mii.mii_inst);
194 } else if ((sc->sc_tlphycap & (TLPHY_MEDIA_10_2 | TLPHY_MEDIA_10_5))
195 == 0)
196 printf("no media present");
197 printf("\n");
198 #undef ADD
199 #undef PRINT
200 }
201
202 int
203 tlphy_service(self, mii, cmd)
204 struct mii_softc *self;
205 struct mii_data *mii;
206 int cmd;
207 {
208 struct tlphy_softc *sc = (struct tlphy_softc *)self;
209 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
210 int reg;
211
212 switch (cmd) {
213 case MII_POLLSTAT:
214 /*
215 * If we're not polling our PHY instance, just return.
216 */
217 if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst)
218 return (0);
219 break;
220
221 case MII_MEDIACHG:
222 /*
223 * If the media indicates a different PHY instance,
224 * isolate ourselves.
225 */
226 if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst) {
227 reg = PHY_READ(&sc->sc_mii, MII_BMCR);
228 PHY_WRITE(&sc->sc_mii, MII_BMCR, reg | BMCR_ISO);
229 return (0);
230 }
231
232 /*
233 * If the interface is not up, don't do anything.
234 */
235 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
236 break;
237
238 switch (IFM_SUBTYPE(ife->ifm_media)) {
239 case IFM_AUTO:
240 /*
241 * The ThunderLAN PHY doesn't self-configure after
242 * an autonegotiation cycle, so there's no such
243 * thing as "already in auto mode".
244 */
245 tlphy_auto(sc);
246 break;
247 case IFM_10_2:
248 case IFM_10_5:
249 PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
250 PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, CTRL_AUISEL);
251 delay(100000);
252 break;
253 default:
254 PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, 0);
255 delay(100000);
256 PHY_WRITE(&sc->sc_mii, MII_ANAR,
257 mii_anar(ife->ifm_media));
258 PHY_WRITE(&sc->sc_mii, MII_BMCR, ife->ifm_data);
259 }
260 break;
261
262 case MII_TICK:
263 /*
264 * If we're not currently selected, just return.
265 */
266 if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst)
267 return (0);
268
269 /*
270 * Only used for autonegotiation.
271 */
272 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
273 return (0);
274
275 /*
276 * Is the interface even up?
277 */
278 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
279 return (0);
280
281 /*
282 * Check to see if we have link. If we do, we don't
283 * need to restart the autonegotiation process. Read
284 * the BMSR twice in case it's latched.
285 *
286 * XXX WHAT ABOUT CHECKING LINK ON THE BNC/AUI?!
287 */
288 reg = PHY_READ(&sc->sc_mii, MII_BMSR) |
289 PHY_READ(&sc->sc_mii, MII_BMSR);
290 if (reg & BMSR_LINK)
291 return (0);
292
293 /*
294 * Only retry autonegotiation every 5 seconds.
295 */
296 if (++sc->sc_ticks != 5)
297 return (0);
298
299 sc->sc_ticks = 0;
300 tlphy_reset(sc);
301 tlphy_auto(sc);
302 break;
303 }
304
305 /* Update the media status. */
306 tlphy_status(sc);
307
308 /* Callback if something changed. */
309 if (sc->sc_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
310 (*mii->mii_statchg)(sc->sc_mii.mii_dev.dv_parent);
311 sc->sc_active = mii->mii_media_active;
312 }
313 return (0);
314 }
315
316 void
317 tlphy_status(sc)
318 struct tlphy_softc *sc;
319 {
320 struct mii_data *mii = sc->sc_mii.mii_pdata;
321 struct tl_softc *tlsc = (struct tl_softc *)sc->sc_mii.mii_dev.dv_parent;
322 int bmsr, bmcr, tlctrl;
323
324 mii->mii_media_status = IFM_AVALID;
325 mii->mii_media_active = IFM_ETHER;
326
327 bmcr = PHY_READ(&sc->sc_mii, MII_BMCR);
328 if (bmcr & BMCR_ISO) {
329 mii->mii_media_active |= IFM_NONE;
330 mii->mii_media_status = 0;
331 return;
332 }
333
334 tlctrl = PHY_READ(&sc->sc_mii, MII_TLPHY_CTRL);
335 if (tlctrl & CTRL_AUISEL) {
336 if (sc->sc_tlphycap & TLPHY_MEDIA_10_2)
337 mii->mii_media_active |= IFM_10_2;
338 else if (sc->sc_tlphycap & TLPHY_MEDIA_10_5)
339 mii->mii_media_active |= IFM_10_5;
340 else
341 printf("%s: AUI selected with no matching media !\n",
342 sc->sc_mii.mii_dev.dv_xname);
343 if (tlsc->tl_flags & TL_IFACT)
344 mii->mii_media_status |= IFM_ACTIVE;
345 return;
346 }
347
348 bmsr = PHY_READ(&sc->sc_mii, MII_BMSR) |
349 PHY_READ(&sc->sc_mii, MII_BMSR);
350 if (bmsr & BMSR_LINK)
351 mii->mii_media_status |= IFM_ACTIVE;
352
353 if (bmcr & BMCR_LOOP)
354 mii->mii_media_active |= IFM_LOOP;
355
356 /*
357 * Grr, braindead ThunderLAN PHY doesn't have any way to
358 * tell which media is actually active. (Note it also
359 * doesn't self-configure after autonegotiation.) We
360 * just have to report what's in the BMCR.
361 */
362 if (bmcr & BMCR_FDX)
363 mii->mii_media_active |= IFM_FDX;
364 mii->mii_media_active |= IFM_10_T;
365 }
366
367 void
368 tlphy_auto(sc)
369 struct tlphy_softc *sc;
370 {
371 int aner, anlpar;
372
373 if (mii_phy_auto(&sc->sc_mii) == 0)
374 goto dflt;
375
376 /*
377 * Grr, braindead ThunderLAN PHY doesn't self-configure
378 * after autonegotiation. We have to do it ourselves
379 * based on the link partner status.
380 */
381
382 aner = PHY_READ(&sc->sc_mii, MII_ANER);
383 if (aner & ANER_LPAN) {
384 anlpar = PHY_READ(&sc->sc_mii, MII_ANLPAR) &
385 PHY_READ(&sc->sc_mii, MII_ANAR);
386 if (anlpar & ANAR_10_FD) {
387 PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_FDX);
388 return;
389 }
390 }
391
392 dflt:
393 /*
394 * Just assume we're not in full-duplex mode.
395 * XXX Check link and try AUI/BNC?
396 */
397 PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
398 }
399
400 void
401 tlphy_reset(sc)
402 struct tlphy_softc *sc;
403 {
404 int reg, i;
405
406 PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_RESET|BMCR_ISO);
407
408 /* Wait 100ms for it to complete. */
409 for (i = 0; i < 100; i++) {
410 reg = PHY_READ(&sc->sc_mii, MII_BMCR);
411 if ((reg & BMCR_RESET) == 0)
412 break;
413 delay(1000);
414 }
415
416 /* Make sure the PHY is isolated. */
417 if (sc->sc_mii.mii_inst != 0)
418 PHY_WRITE(&sc->sc_mii, MII_BMCR, reg | BMCR_ISO);
419 }
420