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