xref: /netbsd-src/sys/dev/mii/icsphy.c (revision 93f9db1b75d415b78f73ed629beeb86235153473)
1 /*	$NetBSD: icsphy.c,v 1.8 1998/11/05 04:08:01 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998 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' ICS1890 ethernet 10/100 PHY
71  * datasheet from www.icst.com
72  */
73 
74 #include <sys/param.h>
75 #include <sys/systm.h>
76 #include <sys/kernel.h>
77 #include <sys/device.h>
78 #include <sys/malloc.h>
79 #include <sys/socket.h>
80 
81 #include <net/if.h>
82 #include <net/if_media.h>
83 
84 #include <dev/mii/mii.h>
85 #include <dev/mii/miivar.h>
86 #include <dev/mii/miidevs.h>
87 
88 #include <dev/mii/icsphyreg.h>
89 
90 int	icsphymatch __P((struct device *, struct cfdata *, void *));
91 void	icsphyattach __P((struct device *, struct device *, void *));
92 
93 struct cfattach icsphy_ca = {
94 	sizeof(struct mii_softc), icsphymatch, icsphyattach
95 };
96 
97 int	icsphy_service __P((struct mii_softc *, struct mii_data *, int));
98 void	icsphy_reset __P((struct mii_softc *));
99 void	icsphy_status __P((struct mii_softc *));
100 
101 int
102 icsphymatch(parent, match, aux)
103 	struct device *parent;
104 	struct cfdata *match;
105 	void *aux;
106 {
107 	struct mii_attach_args *ma = aux;
108 
109 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_ICS &&
110 	    MII_MODEL(ma->mii_id2) == MII_MODEL_ICS_1890)
111 		return (10);
112 
113 	return (0);
114 }
115 
116 void
117 icsphyattach(parent, self, aux)
118 	struct device *parent, *self;
119 	void *aux;
120 {
121 	struct mii_softc *sc = (struct mii_softc *)self;
122 	struct mii_attach_args *ma = aux;
123 	struct mii_data *mii = ma->mii_data;
124 
125 	printf(": %s, rev. %d\n", MII_STR_ICS_1890,
126 	    MII_REV(ma->mii_id2));
127 
128 	sc->mii_inst = mii->mii_instance;
129 	sc->mii_phy = ma->mii_phyno;
130 	sc->mii_service = icsphy_service;
131 	sc->mii_pdata = mii;
132 
133 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
134 
135 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
136 	    BMCR_ISO);
137 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
138 	    BMCR_LOOP|BMCR_S100);
139 
140 	icsphy_reset(sc);
141 
142 	sc->mii_capabilities =
143 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
144 	printf("%s: ", sc->mii_dev.dv_xname);
145 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
146 		printf("no media present");
147 	else
148 		mii_add_media(mii, sc->mii_capabilities,
149 		    sc->mii_inst);
150 	printf("\n");
151 #undef ADD
152 }
153 
154 int
155 icsphy_service(sc, mii, cmd)
156 	struct mii_softc *sc;
157 	struct mii_data *mii;
158 	int cmd;
159 {
160 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
161 	int reg;
162 
163 	switch (cmd) {
164 	case MII_POLLSTAT:
165 		/*
166 		 * If we're not polling our PHY instance, just return.
167 		 */
168 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
169 			return (0);
170 		break;
171 
172 	case MII_MEDIACHG:
173 		/*
174 		 * If the media indicates a different PHY instance,
175 		 * isolate ourselves.
176 		 */
177 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
178 			reg = PHY_READ(sc, MII_BMCR);
179 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
180 			return (0);
181 		}
182 
183 		/*
184 		 * If the interface is not up, don't do anything.
185 		 */
186 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
187 			break;
188 
189 		switch (IFM_SUBTYPE(ife->ifm_media)) {
190 		case IFM_AUTO:
191 			/*
192 			 * If we're already in auto mode, just return.
193 			 */
194 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
195 				return (0);
196 			(void) mii_phy_auto(sc);
197 			break;
198 		case IFM_100_T4:
199 			/*
200 			 * XXX Not supported as a manual setting right now.
201 			 */
202 			return (EINVAL);
203 		default:
204 			/*
205 			 * BMCR data is stored in the ifmedia entry.
206 			 */
207 			PHY_WRITE(sc, MII_ANAR,
208 			    mii_anar(ife->ifm_media));
209 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
210 		}
211 		break;
212 
213 	case MII_TICK:
214 		/*
215 		 * If we're not currently selected, just return.
216 		 */
217 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
218 			return (0);
219 
220 		/*
221 		 * Only used for autonegotiation.
222 		 */
223 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
224 			return (0);
225 
226 		/*
227 		 * Is the interface even up?
228 		 */
229 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
230 			return (0);
231 
232 		/*
233 		 * The ICS1890's autonegotiation doesn't need to be
234 		 * kicked; it continues in the background.
235 		 */
236 		break;
237 	}
238 
239 	/* Update the media status. */
240 	icsphy_status(sc);
241 
242 	/* Callback if something changed. */
243 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
244 		(*mii->mii_statchg)(sc->mii_dev.dv_parent);
245 		sc->mii_active = mii->mii_media_active;
246 	}
247 	return (0);
248 }
249 
250 void
251 icsphy_status(sc)
252 	struct mii_softc *sc;
253 {
254 	struct mii_data *mii = sc->mii_pdata;
255 	int bmcr, qpr;
256 
257 	mii->mii_media_status = IFM_AVALID;
258 	mii->mii_media_active = IFM_ETHER;
259 
260 	/*
261 	 * Don't get link from the BMSR.  It's available in the QPR,
262 	 * and we have to read it twice to unlatch it anyhow.  This
263 	 * gives us fewer register reads.
264 	 */
265 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
266 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
267 
268 	if (qpr & QPR_LINK)
269 		mii->mii_media_status |= IFM_ACTIVE;
270 
271 	bmcr = PHY_READ(sc, MII_BMCR);
272 	if (bmcr & BMCR_ISO) {
273 		mii->mii_media_active |= IFM_NONE;
274 		mii->mii_media_status = 0;
275 		return;
276 	}
277 
278 	if (bmcr & BMCR_LOOP)
279 		mii->mii_media_active |= IFM_LOOP;
280 
281 	if (bmcr & BMCR_AUTOEN) {
282 		if ((qpr & QPR_ACOMP) == 0) {
283 			/* Erg, still trying, I guess... */
284 			mii->mii_media_active |= IFM_NONE;
285 			return;
286 		}
287 		if (qpr & QPR_SPEED)
288 			mii->mii_media_active |= IFM_100_TX;
289 		else
290 			mii->mii_media_active |= IFM_10_T;
291 		if (qpr & QPR_FDX)
292 			mii->mii_media_active |= IFM_FDX;
293 	} else
294 		mii->mii_media_active = mii_media_from_bmcr(bmcr);
295 }
296 
297 void
298 icsphy_reset(sc)
299 	struct mii_softc *sc;
300 {
301 
302 	mii_phy_reset(sc);
303 	PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_10TPROT|ECR2_Q10T);
304 }
305