xref: /netbsd-src/sys/dev/mii/tqphy.c (revision cac8e449158efc7261bebc8657cbb0125a2cfdde)
1 /*	$NetBSD: tqphy.c,v 1.36 2008/05/04 17:06:10 xtraeme 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  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by Manuel Bouyer.
47  * 4. The name of the author may not be used to endorse or promote products
48  *    derived from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
59  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  */
61 
62 /*
63  * TDK TSC78Q2120 PHY driver
64  *
65  * Documentation available at http://www.tsc.tdk.com/lan/78Q2120.pdf .
66  */
67 
68 #include <sys/cdefs.h>
69 __KERNEL_RCSID(0, "$NetBSD: tqphy.c,v 1.36 2008/05/04 17:06:10 xtraeme Exp $");
70 
71 #include <sys/param.h>
72 #include <sys/systm.h>
73 #include <sys/kernel.h>
74 #include <sys/device.h>
75 #include <sys/socket.h>
76 
77 #include <net/if.h>
78 #include <net/if_media.h>
79 
80 #include <dev/mii/mii.h>
81 #include <dev/mii/miivar.h>
82 #include <dev/mii/miidevs.h>
83 
84 #include <dev/mii/tqphyreg.h>
85 
86 static int	tqphymatch(device_t, cfdata_t, void *);
87 static void	tqphyattach(device_t, device_t, void *);
88 
89 CFATTACH_DECL_NEW(tqphy, sizeof(struct mii_softc),
90     tqphymatch, tqphyattach, mii_phy_detach, mii_phy_activate);
91 
92 static int	tqphy_service(struct mii_softc *, struct mii_data *, int);
93 static void	tqphy_status(struct mii_softc *);
94 
95 static const struct mii_phy_funcs tqphy_funcs = {
96 	tqphy_service, tqphy_status, mii_phy_reset,
97 };
98 
99 static const struct mii_phydesc tqphys[] = {
100 	{ MII_OUI_xxTSC,		MII_MODEL_xxTSC_78Q2120,
101 	  MII_STR_xxTSC_78Q2120 },
102 #if 0
103 	{ MII_OUI_xxTSC,		MII_MODEL_TSC_78Q2121,
104 	  MII_STR_TSC_78Q2121 },
105 #endif
106 	{ 0,				0,
107 	  NULL },
108 };
109 
110 static int
111 tqphymatch(device_t parent, cfdata_t match, void *aux)
112 {
113 	struct mii_attach_args *ma = aux;
114 
115 	if (mii_phy_match(ma, tqphys) != NULL) {
116 		/* The DIAG register is unreliable on early revisions. */
117 		if (MII_MODEL(ma->mii_id2) == MII_MODEL_xxTSC_78Q2120 &&
118 		    MII_REV(ma->mii_id2) <= 3)
119 			return (0);
120 		return (10);
121 	}
122 
123 	return (0);
124 }
125 
126 static void
127 tqphyattach(device_t parent, device_t self, void *aux)
128 {
129 	struct mii_softc *sc = device_private(self);
130 	struct mii_attach_args *ma = aux;
131 	struct mii_data *mii = ma->mii_data;
132 	const struct mii_phydesc *mpd;
133 
134 	mpd = mii_phy_match(ma, tqphys);
135 	aprint_naive(": Media interface\n");
136 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
137 
138 	sc->mii_dev = self;
139 	sc->mii_inst = mii->mii_instance;
140 	sc->mii_phy = ma->mii_phyno;
141 	sc->mii_funcs = &tqphy_funcs;
142 	sc->mii_pdata = mii;
143 	sc->mii_flags = ma->mii_flags;
144 	sc->mii_anegticks = MII_ANEGTICKS;
145 
146 	/*
147 	 * Apparently, we can't do loopback on this PHY.
148 	 */
149 	sc->mii_flags |= MIIF_NOLOOP;
150 
151 	PHY_RESET(sc);
152 
153 	sc->mii_capabilities =
154 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
155 	aprint_normal_dev(self, "");
156 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
157 		aprint_error("no media present");
158 	else
159 		mii_phy_add_media(sc);
160 	aprint_normal("\n");
161 
162 	if (!pmf_device_register(self, NULL, mii_phy_resume))
163 		aprint_error_dev(self, "couldn't establish power handler\n");
164 }
165 
166 static int
167 tqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
168 {
169 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
170 	int reg;
171 
172 	switch (cmd) {
173 	case MII_POLLSTAT:
174 		/*
175 		 * If we're not polling our PHY instance, just return.
176 		 */
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 			reg = PHY_READ(sc, MII_BMCR);
188 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
189 			return (0);
190 		}
191 
192 		/*
193 		 * If the interface is not up, don't do anything.
194 		 */
195 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
196 			break;
197 
198 		mii_phy_setmedia(sc);
199 		break;
200 
201 	case MII_TICK:
202 		/*
203 		 * If we're not currently selected, just return.
204 		 */
205 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
206 			return (0);
207 
208 		if (mii_phy_tick(sc) == EJUSTRETURN)
209 			return (0);
210 		break;
211 
212 	case MII_DOWN:
213 		mii_phy_down(sc);
214 		return (0);
215 	}
216 
217 	/* Update the media status. */
218 	mii_phy_status(sc);
219 
220 	/* Callback if something changed. */
221 	mii_phy_update(sc, cmd);
222 	return (0);
223 }
224 
225 static void
226 tqphy_status(struct mii_softc *sc)
227 {
228 	struct mii_data *mii = sc->mii_pdata;
229 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
230 	int bmsr, bmcr, diag;
231 
232 	mii->mii_media_status = IFM_AVALID;
233 	mii->mii_media_active = IFM_ETHER;
234 
235 	bmsr = PHY_READ(sc, MII_BMSR) |
236 	    PHY_READ(sc, MII_BMSR);
237 	if (bmsr & BMSR_LINK)
238 		mii->mii_media_status |= IFM_ACTIVE;
239 
240 	bmcr = PHY_READ(sc, MII_BMCR);
241 	if (bmcr & BMCR_ISO) {
242 		mii->mii_media_active |= IFM_NONE;
243 		mii->mii_media_status = 0;
244 		return;
245 	}
246 
247 	if (bmcr & BMCR_LOOP)
248 		mii->mii_media_active |= IFM_LOOP;
249 
250 	if (bmcr & BMCR_AUTOEN) {
251 		if ((bmsr & BMSR_ACOMP) == 0) {
252 			/* Erg, still trying, I guess... */
253 			mii->mii_media_active |= IFM_NONE;
254 			return;
255 		}
256 		diag = PHY_READ(sc, MII_TQPHY_DIAG);
257 		if (diag & DIAG_RATE)
258 			mii->mii_media_active |= IFM_100_TX;
259 		else
260 			mii->mii_media_active |= IFM_10_T;
261 		if (diag & DIAG_DPLX)
262 			mii->mii_media_active |= IFM_FDX;
263 	} else
264 		mii->mii_media_active = ife->ifm_media;
265 }
266