xref: /netbsd-src/sys/dev/mii/tqphy.c (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: tqphy.c,v 1.24 2004/08/23 06:16:07 thorpej 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  * 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  * TDK TSC78Q2120 PHY driver
71  *
72  * Documentation available at http://www.tsc.tdk.com/lan/78Q2120.pdf .
73  */
74 
75 #include <sys/cdefs.h>
76 __KERNEL_RCSID(0, "$NetBSD: tqphy.c,v 1.24 2004/08/23 06:16:07 thorpej Exp $");
77 
78 #include <sys/param.h>
79 #include <sys/systm.h>
80 #include <sys/kernel.h>
81 #include <sys/device.h>
82 #include <sys/socket.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/tqphyreg.h>
92 
93 static int	tqphymatch(struct device *, struct cfdata *, void *);
94 static void	tqphyattach(struct device *, struct device *, void *);
95 
96 CFATTACH_DECL(tqphy, sizeof(struct mii_softc),
97     tqphymatch, tqphyattach, mii_phy_detach, mii_phy_activate);
98 
99 static int	tqphy_service(struct mii_softc *, struct mii_data *, int);
100 static void	tqphy_status(struct mii_softc *);
101 
102 static const struct mii_phy_funcs tqphy_funcs = {
103 	tqphy_service, tqphy_status, mii_phy_reset,
104 };
105 
106 static const struct mii_phydesc tqphys[] = {
107 	{ MII_OUI_xxTSC,		MII_MODEL_xxTSC_78Q2120,
108 	  MII_STR_xxTSC_78Q2120 },
109 #if 0
110 	{ MII_OUI_xxTSC,		MII_MODEL_TSC_78Q2121,
111 	  MII_STR_TSC_78Q2121 },
112 #endif
113 	{ 0,				0,
114 	  NULL },
115 };
116 
117 static int
118 tqphymatch(struct device *parent, struct cfdata *match, void *aux)
119 {
120 	struct mii_attach_args *ma = aux;
121 
122 	if (mii_phy_match(ma, tqphys) != NULL) {
123 		/* The DIAG register is unreliable on early revisions. */
124 		if (MII_MODEL(ma->mii_id2) == MII_MODEL_xxTSC_78Q2120 &&
125 		    MII_REV(ma->mii_id2) <= 3)
126 			return (0);
127 		return (10);
128 	}
129 
130 	return (0);
131 }
132 
133 static void
134 tqphyattach(struct device *parent, struct device *self, void *aux)
135 {
136 	struct mii_softc *sc = (struct mii_softc *)self;
137 	struct mii_attach_args *ma = aux;
138 	struct mii_data *mii = ma->mii_data;
139 	const struct mii_phydesc *mpd;
140 
141 	mpd = mii_phy_match(ma, tqphys);
142 	aprint_naive(": Media interface\n");
143 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
144 
145 	sc->mii_inst = mii->mii_instance;
146 	sc->mii_phy = ma->mii_phyno;
147 	sc->mii_funcs = &tqphy_funcs;
148 	sc->mii_pdata = mii;
149 	sc->mii_flags = ma->mii_flags;
150 	sc->mii_anegticks = 5;
151 
152 	/*
153 	 * Apparently, we can't do loopback on this PHY.
154 	 */
155 	sc->mii_flags |= MIIF_NOLOOP;
156 
157 	PHY_RESET(sc);
158 
159 	sc->mii_capabilities =
160 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
161 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
162 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
163 		aprint_error("no media present");
164 	else
165 		mii_phy_add_media(sc);
166 	aprint_normal("\n");
167 }
168 
169 static int
170 tqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
171 {
172 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
173 	int reg;
174 
175 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
176 		return (ENXIO);
177 
178 	switch (cmd) {
179 	case MII_POLLSTAT:
180 		/*
181 		 * If we're not polling our PHY instance, just return.
182 		 */
183 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
184 			return (0);
185 		break;
186 
187 	case MII_MEDIACHG:
188 		/*
189 		 * If the media indicates a different PHY instance,
190 		 * isolate ourselves.
191 		 */
192 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
193 			reg = PHY_READ(sc, MII_BMCR);
194 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
195 			return (0);
196 		}
197 
198 		/*
199 		 * If the interface is not up, don't do anything.
200 		 */
201 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
202 			break;
203 
204 		mii_phy_setmedia(sc);
205 		break;
206 
207 	case MII_TICK:
208 		/*
209 		 * If we're not currently selected, just return.
210 		 */
211 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
212 			return (0);
213 
214 		if (mii_phy_tick(sc) == EJUSTRETURN)
215 			return (0);
216 		break;
217 
218 	case MII_DOWN:
219 		mii_phy_down(sc);
220 		return (0);
221 	}
222 
223 	/* Update the media status. */
224 	mii_phy_status(sc);
225 
226 	/* Callback if something changed. */
227 	mii_phy_update(sc, cmd);
228 	return (0);
229 }
230 
231 static void
232 tqphy_status(struct mii_softc *sc)
233 {
234 	struct mii_data *mii = sc->mii_pdata;
235 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
236 	int bmsr, bmcr, diag;
237 
238 	mii->mii_media_status = IFM_AVALID;
239 	mii->mii_media_active = IFM_ETHER;
240 
241 	bmsr = PHY_READ(sc, MII_BMSR) |
242 	    PHY_READ(sc, MII_BMSR);
243 	if (bmsr & BMSR_LINK)
244 		mii->mii_media_status |= IFM_ACTIVE;
245 
246 	bmcr = PHY_READ(sc, MII_BMCR);
247 	if (bmcr & BMCR_ISO) {
248 		mii->mii_media_active |= IFM_NONE;
249 		mii->mii_media_status = 0;
250 		return;
251 	}
252 
253 	if (bmcr & BMCR_LOOP)
254 		mii->mii_media_active |= IFM_LOOP;
255 
256 	if (bmcr & BMCR_AUTOEN) {
257 		if ((bmsr & BMSR_ACOMP) == 0) {
258 			/* Erg, still trying, I guess... */
259 			mii->mii_media_active |= IFM_NONE;
260 			return;
261 		}
262 		diag = PHY_READ(sc, MII_TQPHY_DIAG);
263 		if (diag & DIAG_RATE)
264 			mii->mii_media_active |= IFM_100_TX;
265 		else
266 			mii->mii_media_active |= IFM_10_T;
267 		if (diag & DIAG_DPLX)
268 			mii->mii_media_active |= IFM_FDX;
269 	} else
270 		mii->mii_media_active = ife->ifm_media;
271 }
272