xref: /netbsd-src/sys/dev/mii/icsphy.c (revision 08c81a9c2dc8c7300e893321eb65c0925d60871c)
1 /*	$NetBSD: icsphy.c,v 1.27 2002/07/03 06:25:51 simonb 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/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: icsphy.c,v 1.27 2002/07/03 06:25:51 simonb 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 int	icsphymatch(struct device *, struct cfdata *, void *);
93 void	icsphyattach(struct device *, struct device *, void *);
94 
95 struct cfattach icsphy_ca = {
96 	sizeof(struct mii_softc), icsphymatch, icsphyattach, mii_phy_detach,
97 	    mii_phy_activate
98 };
99 
100 int	icsphy_service(struct mii_softc *, struct mii_data *, int);
101 void	icsphy_status(struct mii_softc *);
102 void	icsphy_reset(struct mii_softc *);
103 
104 const struct mii_phy_funcs icsphy_funcs = {
105 	icsphy_service, icsphy_status, icsphy_reset,
106 };
107 
108 const struct mii_phydesc icsphys[] = {
109 	{ MII_OUI_ICS,		MII_MODEL_ICS_1890,
110 	  MII_STR_ICS_1890 },
111 
112 	{ MII_OUI_ICS,		MII_MODEL_ICS_1893,
113 	  MII_STR_ICS_1893 },
114 
115 	{ 0,			0,
116 	  NULL },
117 };
118 
119 int
120 icsphymatch(struct device *parent, struct cfdata *match, void *aux)
121 {
122 	struct mii_attach_args *ma = aux;
123 
124 	if (mii_phy_match(ma, icsphys) != NULL)
125 		return (10);
126 
127 	return (0);
128 }
129 
130 void
131 icsphyattach(struct device *parent, struct device *self, 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 = ma->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(struct mii_softc *sc, struct mii_data *mii, int cmd)
162 {
163 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
164 	int reg;
165 
166 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
167 		return (ENXIO);
168 
169 	switch (cmd) {
170 	case MII_POLLSTAT:
171 		/*
172 		 * If we're not polling our PHY instance, just return.
173 		 */
174 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
175 			return (0);
176 		break;
177 
178 	case MII_MEDIACHG:
179 		/*
180 		 * If the media indicates a different PHY instance,
181 		 * isolate ourselves.
182 		 */
183 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
184 			reg = PHY_READ(sc, MII_BMCR);
185 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
186 			return (0);
187 		}
188 
189 		/*
190 		 * If the interface is not up, don't do anything.
191 		 */
192 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
193 			break;
194 
195 		mii_phy_setmedia(sc);
196 		break;
197 
198 	case MII_TICK:
199 		/*
200 		 * If we're not currently selected, just return.
201 		 */
202 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
203 			return (0);
204 
205 		if (mii_phy_tick(sc) == EJUSTRETURN)
206 			return (0);
207 		break;
208 
209 	case MII_DOWN:
210 		mii_phy_down(sc);
211 		return (0);
212 	}
213 
214 	/* Update the media status. */
215 	mii_phy_status(sc);
216 
217 	/* Callback if something changed. */
218 	mii_phy_update(sc, cmd);
219 	return (0);
220 }
221 
222 void
223 icsphy_status(struct mii_softc *sc)
224 {
225 	struct mii_data *mii = sc->mii_pdata;
226 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
227 	int bmcr, qpr;
228 
229 	mii->mii_media_status = IFM_AVALID;
230 	mii->mii_media_active = IFM_ETHER;
231 
232 	/*
233 	 * Don't get link from the BMSR.  It's available in the QPR,
234 	 * and we have to read it twice to unlatch it anyhow.  This
235 	 * gives us fewer register reads.
236 	 */
237 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
238 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
239 
240 	if (qpr & QPR_LINK)
241 		mii->mii_media_status |= IFM_ACTIVE;
242 
243 	bmcr = PHY_READ(sc, MII_BMCR);
244 	if (bmcr & BMCR_ISO) {
245 		mii->mii_media_active |= IFM_NONE;
246 		mii->mii_media_status = 0;
247 		return;
248 	}
249 
250 	if (bmcr & BMCR_LOOP)
251 		mii->mii_media_active |= IFM_LOOP;
252 
253 	if (bmcr & BMCR_AUTOEN) {
254 		if ((qpr & QPR_ACOMP) == 0) {
255 			/* Erg, still trying, I guess... */
256 			mii->mii_media_active |= IFM_NONE;
257 			return;
258 		}
259 		if (qpr & QPR_SPEED)
260 			mii->mii_media_active |= IFM_100_TX;
261 		else
262 			mii->mii_media_active |= IFM_10_T;
263 		if (qpr & QPR_FDX)
264 			mii->mii_media_active |= IFM_FDX;
265 	} else
266 		mii->mii_media_active = ife->ifm_media;
267 }
268 
269 void
270 icsphy_reset(sc)
271 	struct mii_softc *sc;
272 {
273 
274 	mii_phy_reset(sc);
275 	PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_10TPROT|ECR2_Q10T);
276 }
277