tlphy.c revision 95722
1/*	$NetBSD: tlphy.c,v 1.18 1999/05/14 11:40:28 drochner Exp $	*/
2
3/*-
4 * Copyright (c) 1998, 1999 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/socket.h>
77#include <sys/errno.h>
78#include <sys/module.h>
79#include <sys/bus.h>
80#include <sys/malloc.h>
81
82#include <machine/bus.h>
83
84#include <net/if.h>
85#include <net/if_media.h>
86
87#include <dev/mii/mii.h>
88#include <dev/mii/miivar.h>
89#include <dev/mii/miidevs.h>
90
91#include <dev/mii/tlphyreg.h>
92
93#include "miibus_if.h"
94
95#if !defined(lint)
96static const char rcsid[] =
97  "$FreeBSD: head/sys/dev/mii/tlphy.c 95722 2002-04-29 13:07:38Z phk $";
98#endif
99
100struct tlphy_softc {
101	struct mii_softc sc_mii;		/* generic PHY */
102	int sc_need_acomp;
103};
104
105static int tlphy_probe		(device_t);
106static int tlphy_attach		(device_t);
107
108static device_method_t tlphy_methods[] = {
109	/* device interface */
110	DEVMETHOD(device_probe,		tlphy_probe),
111	DEVMETHOD(device_attach,	tlphy_attach),
112	DEVMETHOD(device_detach,	mii_phy_detach),
113	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
114	{ 0, 0 }
115};
116
117static devclass_t tlphy_devclass;
118
119static driver_t tlphy_driver = {
120	"tlphy",
121	tlphy_methods,
122	sizeof(struct tlphy_softc)
123};
124
125DRIVER_MODULE(tlphy, miibus, tlphy_driver, tlphy_devclass, 0, 0);
126
127static int	tlphy_service(struct mii_softc *, struct mii_data *, int);
128static int	tlphy_auto(struct tlphy_softc *, int);
129static void	tlphy_acomp(struct tlphy_softc *);
130static void	tlphy_status(struct tlphy_softc *);
131
132static int tlphy_probe(dev)
133	device_t		dev;
134{
135	struct mii_attach_args *ma;
136
137	ma = device_get_ivars(dev);
138
139	if (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxTI ||
140	    MII_MODEL(ma->mii_id2) != MII_MODEL_xxTI_TLAN10T)
141		return (ENXIO);
142
143	device_set_desc(dev, MII_STR_xxTI_TLAN10T);
144
145	return (0);
146}
147
148static int tlphy_attach(dev)
149	device_t		dev;
150{
151	struct tlphy_softc *sc;
152	struct mii_attach_args *ma;
153	struct mii_data *mii;
154	const char *sep = "";
155	int capmask = 0xFFFFFFFF;
156
157	sc = device_get_softc(dev);
158	ma = device_get_ivars(dev);
159	sc->sc_mii.mii_dev = device_get_parent(dev);
160	mii = device_get_softc(sc->sc_mii.mii_dev);
161	LIST_INSERT_HEAD(&mii->mii_phys, &sc->sc_mii, mii_list);
162
163	sc->sc_mii.mii_inst = mii->mii_instance;
164	sc->sc_mii.mii_phy = ma->mii_phyno;
165	sc->sc_mii.mii_service = tlphy_service;
166	sc->sc_mii.mii_pdata = mii;
167
168	if (mii->mii_instance) {
169		struct mii_softc	*other;
170		device_t		*devlist;
171		int			devs, i;
172
173		device_get_children(sc->sc_mii.mii_dev, &devlist, &devs);
174		for (i = 0; i < devs; i++) {
175			if (strcmp(device_get_name(devlist[i]), "tlphy")) {
176				other = device_get_softc(devlist[i]);
177				capmask &= ~other->mii_capabilities;
178				break;
179			}
180		}
181		free(devlist, M_TEMP);
182	}
183
184	mii->mii_instance++;
185
186	sc->sc_mii.mii_flags &= ~MIIF_NOISOLATE;
187	mii_phy_reset(&sc->sc_mii);
188	sc->sc_mii.mii_flags |= MIIF_NOISOLATE;
189
190	/*
191	 * Note that if we're on a device that also supports 100baseTX,
192	 * we are not going to want to use the built-in 10baseT port,
193	 * since there will be another PHY on the MII wired up to the
194	 * UTP connector.  The parent indicates this to us by specifying
195	 * the TLPHY_MEDIA_NO_10_T bit.
196	 */
197	sc->sc_mii.mii_capabilities =
198	    PHY_READ(&sc->sc_mii, MII_BMSR) & capmask /*ma->mii_capmask*/;
199
200#define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
201
202	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->sc_mii.mii_inst),
203	    BMCR_ISO);
204
205	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_LOOP,
206	    sc->sc_mii.mii_inst), BMCR_LOOP);
207
208#define	PRINT(s)	printf("%s%s", sep, s); sep = ", "
209
210	device_printf(dev, " ");
211	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_2, 0, sc->sc_mii.mii_inst), 0);
212	PRINT("10base2/BNC");
213	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_5, 0, sc->sc_mii.mii_inst), 0);
214	PRINT("10base5/AUI");
215
216	if (sc->sc_mii.mii_capabilities & BMSR_MEDIAMASK) {
217		printf("%s", sep);
218		mii_add_media(&sc->sc_mii);
219	}
220
221	printf("\n");
222#undef ADD
223#undef PRINT
224	MIIBUS_MEDIAINIT(sc->sc_mii.mii_dev);
225	return(0);
226}
227
228static int
229tlphy_service(self, mii, cmd)
230	struct mii_softc *self;
231	struct mii_data *mii;
232	int cmd;
233{
234	struct tlphy_softc *sc = (struct tlphy_softc *)self;
235	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
236	int reg;
237
238	if ((sc->sc_mii.mii_flags & MIIF_DOINGAUTO) == 0 && sc->sc_need_acomp)
239		tlphy_acomp(sc);
240
241	switch (cmd) {
242	case MII_POLLSTAT:
243		/*
244		 * If we're not polling our PHY instance, just return.
245		 */
246		if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst)
247			return (0);
248		break;
249
250	case MII_MEDIACHG:
251		/*
252		 * If the media indicates a different PHY instance,
253		 * isolate ourselves.
254		 */
255		if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst) {
256			reg = PHY_READ(&sc->sc_mii, MII_BMCR);
257			PHY_WRITE(&sc->sc_mii, MII_BMCR, reg | BMCR_ISO);
258			return (0);
259		}
260
261		/*
262		 * If the interface is not up, don't do anything.
263		 */
264		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
265			break;
266
267		switch (IFM_SUBTYPE(ife->ifm_media)) {
268		case IFM_AUTO:
269			/*
270			 * The ThunderLAN PHY doesn't self-configure after
271			 * an autonegotiation cycle, so there's no such
272			 * thing as "already in auto mode".
273			 */
274			(void) tlphy_auto(sc, 1);
275			break;
276		case IFM_10_2:
277		case IFM_10_5:
278			PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
279			PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, CTRL_AUISEL);
280			DELAY(100000);
281			break;
282		default:
283			PHY_WRITE(&sc->sc_mii, MII_TLPHY_CTRL, 0);
284			DELAY(100000);
285			PHY_WRITE(&sc->sc_mii, MII_ANAR,
286			    mii_anar(ife->ifm_media));
287			PHY_WRITE(&sc->sc_mii, MII_BMCR, ife->ifm_data);
288		}
289		break;
290
291	case MII_TICK:
292		/*
293		 * If we're not currently selected, just return.
294		 */
295		if (IFM_INST(ife->ifm_media) != sc->sc_mii.mii_inst)
296			return (0);
297
298		/*
299		 * Is the interface even up?
300		 */
301		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
302			return (0);
303
304		/*
305		 * Only used for autonegotiation.
306		 */
307		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
308			break;
309
310		/*
311		 * Check to see if we have link.  If we do, we don't
312		 * need to restart the autonegotiation process.  Read
313		 * the BMSR twice in case it's latched.
314		 *
315		 * XXX WHAT ABOUT CHECKING LINK ON THE BNC/AUI?!
316		 */
317		reg = PHY_READ(&sc->sc_mii, MII_BMSR) |
318		    PHY_READ(&sc->sc_mii, MII_BMSR);
319		if (reg & BMSR_LINK)
320			break;
321
322		/*
323		 * Only retry autonegotiation every 5 seconds.
324		 */
325		if (++sc->sc_mii.mii_ticks != 5)
326			return (0);
327
328		sc->sc_mii.mii_ticks = 0;
329		mii_phy_reset(&sc->sc_mii);
330		if (tlphy_auto(sc, 0) == EJUSTRETURN)
331			return (0);
332		break;
333	}
334
335	/* Update the media status. */
336	tlphy_status(sc);
337
338	/* Callback if something changed. */
339	mii_phy_update(&sc->sc_mii, cmd);
340	return (0);
341}
342
343static void
344tlphy_status(sc)
345	struct tlphy_softc *sc;
346{
347	struct mii_data *mii = sc->sc_mii.mii_pdata;
348	int bmsr, bmcr, tlctrl;
349
350	mii->mii_media_status = IFM_AVALID;
351	mii->mii_media_active = IFM_ETHER;
352
353	bmcr = PHY_READ(&sc->sc_mii, MII_BMCR);
354	if (bmcr & BMCR_ISO) {
355		mii->mii_media_active |= IFM_NONE;
356		mii->mii_media_status = 0;
357		return;
358	}
359
360	tlctrl = PHY_READ(&sc->sc_mii, MII_TLPHY_CTRL);
361	if (tlctrl & CTRL_AUISEL) {
362		mii->mii_media_status = 0;
363		mii->mii_media_active = mii->mii_media.ifm_cur->ifm_media;
364		return;
365	}
366
367	bmsr = PHY_READ(&sc->sc_mii, MII_BMSR) |
368	    PHY_READ(&sc->sc_mii, MII_BMSR);
369	if (bmsr & BMSR_LINK)
370		mii->mii_media_status |= IFM_ACTIVE;
371
372	if (bmcr & BMCR_LOOP)
373		mii->mii_media_active |= IFM_LOOP;
374
375	/*
376	 * Grr, braindead ThunderLAN PHY doesn't have any way to
377	 * tell which media is actually active.  (Note it also
378	 * doesn't self-configure after autonegotiation.)  We
379	 * just have to report what's in the BMCR.
380	 */
381	if (bmcr & BMCR_FDX)
382		mii->mii_media_active |= IFM_FDX;
383	mii->mii_media_active |= IFM_10_T;
384}
385
386static int
387tlphy_auto(sc, waitfor)
388	struct tlphy_softc *sc;
389	int waitfor;
390{
391	int error;
392
393	switch ((error = mii_phy_auto(&sc->sc_mii, waitfor))) {
394	case EIO:
395		/*
396		 * Just assume we're not in full-duplex mode.
397		 * XXX Check link and try AUI/BNC?
398		 */
399		PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
400		break;
401
402	case EJUSTRETURN:
403		/* Flag that we need to program when it completes. */
404		sc->sc_need_acomp = 1;
405		break;
406
407	default:
408		tlphy_acomp(sc);
409	}
410
411	return (error);
412}
413
414static void
415tlphy_acomp(sc)
416	struct tlphy_softc *sc;
417{
418	int aner, anlpar;
419
420	sc->sc_need_acomp = 0;
421
422	/*
423	 * Grr, braindead ThunderLAN PHY doesn't self-configure
424	 * after autonegotiation.  We have to do it ourselves
425	 * based on the link partner status.
426	 */
427
428	aner = PHY_READ(&sc->sc_mii, MII_ANER);
429	if (aner & ANER_LPAN) {
430		anlpar = PHY_READ(&sc->sc_mii, MII_ANLPAR) &
431		    PHY_READ(&sc->sc_mii, MII_ANAR);
432		if (anlpar & ANAR_10_FD) {
433			PHY_WRITE(&sc->sc_mii, MII_BMCR, BMCR_FDX);
434			return;
435		}
436	}
437	PHY_WRITE(&sc->sc_mii, MII_BMCR, 0);
438}
439