xref: /netbsd-src/sys/dev/mii/icsphy.c (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: icsphy.c,v 1.34 2004/08/23 06:16:06 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  * driver for Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY
71  * datasheet from www.icst.com
72  */
73 
74 #include <sys/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: icsphy.c,v 1.34 2004/08/23 06:16:06 thorpej Exp $");
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/kernel.h>
80 #include <sys/device.h>
81 #include <sys/socket.h>
82 
83 #include <net/if.h>
84 #include <net/if_media.h>
85 
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 #include <dev/mii/miidevs.h>
89 
90 #include <dev/mii/icsphyreg.h>
91 
92 static int	icsphymatch(struct device *, struct cfdata *, void *);
93 static void	icsphyattach(struct device *, struct device *, void *);
94 
95 CFATTACH_DECL(icsphy, sizeof(struct mii_softc),
96     icsphymatch, icsphyattach, mii_phy_detach, mii_phy_activate);
97 
98 static int	icsphy_service(struct mii_softc *, struct mii_data *, int);
99 static void	icsphy_status(struct mii_softc *);
100 static void	icsphy_reset(struct mii_softc *);
101 
102 static const struct mii_phy_funcs icsphy_funcs = {
103 	icsphy_service, icsphy_status, icsphy_reset,
104 };
105 
106 static const struct mii_phydesc icsphys[] = {
107 	{ MII_OUI_ICS,		MII_MODEL_ICS_1889,
108 	  MII_STR_ICS_1889 },
109 
110 	{ MII_OUI_ICS,		MII_MODEL_ICS_1890,
111 	  MII_STR_ICS_1890 },
112 
113 	{ MII_OUI_ICS,		MII_MODEL_ICS_1892,
114 	  MII_STR_ICS_1892 },
115 
116 	{ MII_OUI_ICS,		MII_MODEL_ICS_1893,
117 	  MII_STR_ICS_1893 },
118 
119 	{ 0,			0,
120 	  NULL },
121 };
122 
123 static int
124 icsphymatch(struct device *parent, struct cfdata *match, void *aux)
125 {
126 	struct mii_attach_args *ma = aux;
127 
128 	if (mii_phy_match(ma, icsphys) != NULL)
129 		return (10);
130 
131 	return (0);
132 }
133 
134 static void
135 icsphyattach(struct device *parent, struct device *self, void *aux)
136 {
137 	struct mii_softc *sc = (struct mii_softc *)self;
138 	struct mii_attach_args *ma = aux;
139 	struct mii_data *mii = ma->mii_data;
140 	const struct mii_phydesc *mpd;
141 
142 	mpd = mii_phy_match(ma, icsphys);
143 	aprint_naive(": Media interface\n");
144 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
145 
146 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
147 	sc->mii_inst = mii->mii_instance;
148 	sc->mii_phy = ma->mii_phyno;
149 	sc->mii_funcs = &icsphy_funcs;
150 	sc->mii_pdata = mii;
151 	sc->mii_flags = ma->mii_flags;
152 	sc->mii_anegticks = 5;
153 
154 	PHY_RESET(sc);
155 
156 	sc->mii_capabilities =
157 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
158 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
159 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
160 		aprint_error("no media present");
161 	else
162 		mii_phy_add_media(sc);
163 	aprint_normal("\n");
164 }
165 
166 static int
167 icsphy_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 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
173 		return (ENXIO);
174 
175 	switch (cmd) {
176 	case MII_POLLSTAT:
177 		/*
178 		 * If we're not polling our PHY instance, just return.
179 		 */
180 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
181 			return (0);
182 		break;
183 
184 	case MII_MEDIACHG:
185 		/*
186 		 * If the media indicates a different PHY instance,
187 		 * isolate ourselves.
188 		 */
189 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
190 			reg = PHY_READ(sc, MII_BMCR);
191 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
192 			return (0);
193 		}
194 
195 		/*
196 		 * If the interface is not up, don't do anything.
197 		 */
198 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
199 			break;
200 
201 		mii_phy_setmedia(sc);
202 		break;
203 
204 	case MII_TICK:
205 		/*
206 		 * If we're not currently selected, just return.
207 		 */
208 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
209 			return (0);
210 
211 		if (mii_phy_tick(sc) == EJUSTRETURN)
212 			return (0);
213 		break;
214 
215 	case MII_DOWN:
216 		mii_phy_down(sc);
217 		return (0);
218 	}
219 
220 	/* Update the media status. */
221 	mii_phy_status(sc);
222 
223 	/* Callback if something changed. */
224 	mii_phy_update(sc, cmd);
225 	return (0);
226 }
227 
228 static void
229 icsphy_status(struct mii_softc *sc)
230 {
231 	struct mii_data *mii = sc->mii_pdata;
232 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
233 	int bmcr, qpr;
234 
235 	mii->mii_media_status = IFM_AVALID;
236 	mii->mii_media_active = IFM_ETHER;
237 
238 	/*
239 	 * Don't get link from the BMSR.  It's available in the QPR,
240 	 * and we have to read it twice to unlatch it anyhow.  This
241 	 * gives us fewer register reads.
242 	 */
243 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
244 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
245 
246 	if (qpr & QPR_LINK)
247 		mii->mii_media_status |= IFM_ACTIVE;
248 
249 	bmcr = PHY_READ(sc, MII_BMCR);
250 	if (bmcr & BMCR_ISO) {
251 		mii->mii_media_active |= IFM_NONE;
252 		mii->mii_media_status = 0;
253 		return;
254 	}
255 
256 	if (bmcr & BMCR_LOOP)
257 		mii->mii_media_active |= IFM_LOOP;
258 
259 	if (bmcr & BMCR_AUTOEN) {
260 		if ((qpr & QPR_ACOMP) == 0) {
261 			/* Erg, still trying, I guess... */
262 			mii->mii_media_active |= IFM_NONE;
263 			return;
264 		}
265 		if (qpr & QPR_SPEED)
266 			mii->mii_media_active |= IFM_100_TX;
267 		else
268 			mii->mii_media_active |= IFM_10_T;
269 		if (qpr & QPR_FDX)
270 			mii->mii_media_active |= IFM_FDX;
271 	} else
272 		mii->mii_media_active = ife->ifm_media;
273 }
274 
275 static void
276 icsphy_reset(struct mii_softc *sc)
277 {
278 
279 	mii_phy_reset(sc);
280 	/* set powerdown feature */
281 	switch (sc->mii_mpd_model) {
282 		case MII_MODEL_ICS_1890:
283 		case MII_MODEL_ICS_1893:
284 			PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
285 			break;
286 		case MII_MODEL_ICS_1892:
287 			PHY_WRITE(sc, MII_ICSPHY_ECR2,
288 			    ECR2_10AUTOPWRDN|ECR2_100AUTOPWRDN);
289 			break;
290 		default:
291 			/* 1889 have no ECR2 */
292 			break;
293 	}
294 	/*
295 	 * There is no description that the reset do auto-negotiation in the
296 	 * data sheet.
297 	 */
298 	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_STARTNEG|BMCR_FDX);
299 }
300