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