xref: /netbsd-src/sys/dev/mii/icsphy.c (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: icsphy.c,v 1.22 2001/06/02 21:39:39 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' 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, mii_phy_detach,
95 	    mii_phy_activate
96 };
97 
98 int	icsphy_service __P((struct mii_softc *, struct mii_data *, int));
99 void	icsphy_status __P((struct mii_softc *));
100 void	icsphy_reset __P((struct mii_softc *));
101 
102 const struct mii_phy_funcs icsphy_funcs = {
103 	icsphy_service, icsphy_status, icsphy_reset,
104 };
105 
106 const struct mii_phydesc icsphys[] = {
107 	{ MII_OUI_ICS,		MII_MODEL_ICS_1890,
108 	  MII_STR_ICS_1890 },
109 
110 	{ 0,			0,
111 	  NULL },
112 };
113 
114 int
115 icsphymatch(parent, match, aux)
116 	struct device *parent;
117 	struct cfdata *match;
118 	void *aux;
119 {
120 	struct mii_attach_args *ma = aux;
121 
122 	if (mii_phy_match(ma, icsphys) != NULL)
123 		return (10);
124 
125 	return (0);
126 }
127 
128 void
129 icsphyattach(parent, self, aux)
130 	struct device *parent, *self;
131 	void *aux;
132 {
133 	struct mii_softc *sc = (struct mii_softc *)self;
134 	struct mii_attach_args *ma = aux;
135 	struct mii_data *mii = ma->mii_data;
136 	const struct mii_phydesc *mpd;
137 
138 	mpd = mii_phy_match(ma, icsphys);
139 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
140 
141 	sc->mii_inst = mii->mii_instance;
142 	sc->mii_phy = ma->mii_phyno;
143 	sc->mii_funcs = &icsphy_funcs;
144 	sc->mii_pdata = mii;
145 	sc->mii_flags = mii->mii_flags;
146 	sc->mii_anegticks = 5;
147 
148 	PHY_RESET(sc);
149 
150 	sc->mii_capabilities =
151 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
152 	printf("%s: ", sc->mii_dev.dv_xname);
153 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
154 		printf("no media present");
155 	else
156 		mii_phy_add_media(sc);
157 	printf("\n");
158 }
159 
160 int
161 icsphy_service(sc, mii, cmd)
162 	struct mii_softc *sc;
163 	struct mii_data *mii;
164 	int cmd;
165 {
166 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
167 	int reg;
168 
169 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
170 		return (ENXIO);
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 void
226 icsphy_status(sc)
227 	struct mii_softc *sc;
228 {
229 	struct mii_data *mii = sc->mii_pdata;
230 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
231 	int bmcr, qpr;
232 
233 	mii->mii_media_status = IFM_AVALID;
234 	mii->mii_media_active = IFM_ETHER;
235 
236 	/*
237 	 * Don't get link from the BMSR.  It's available in the QPR,
238 	 * and we have to read it twice to unlatch it anyhow.  This
239 	 * gives us fewer register reads.
240 	 */
241 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
242 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
243 
244 	if (qpr & QPR_LINK)
245 		mii->mii_media_status |= IFM_ACTIVE;
246 
247 	bmcr = PHY_READ(sc, MII_BMCR);
248 	if (bmcr & BMCR_ISO) {
249 		mii->mii_media_active |= IFM_NONE;
250 		mii->mii_media_status = 0;
251 		return;
252 	}
253 
254 	if (bmcr & BMCR_LOOP)
255 		mii->mii_media_active |= IFM_LOOP;
256 
257 	if (bmcr & BMCR_AUTOEN) {
258 		if ((qpr & QPR_ACOMP) == 0) {
259 			/* Erg, still trying, I guess... */
260 			mii->mii_media_active |= IFM_NONE;
261 			return;
262 		}
263 		if (qpr & QPR_SPEED)
264 			mii->mii_media_active |= IFM_100_TX;
265 		else
266 			mii->mii_media_active |= IFM_10_T;
267 		if (qpr & QPR_FDX)
268 			mii->mii_media_active |= IFM_FDX;
269 	} else
270 		mii->mii_media_active = ife->ifm_media;
271 }
272 
273 void
274 icsphy_reset(sc)
275 	struct mii_softc *sc;
276 {
277 
278 	mii_phy_reset(sc);
279 	PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_10TPROT|ECR2_Q10T);
280 }
281