xref: /openbsd-src/sys/dev/mii/icsphy.c (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /*	$OpenBSD: icsphy.c,v 1.19 2008/06/26 05:42:16 ray Exp $	*/
2 /*	$NetBSD: icsphy.c,v 1.17 2000/02/02 23:34:56 thorpej Exp $	*/
3 
4 /*-
5  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10  * NASA Ames Research Center.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *	This product includes software developed by Manuel Bouyer.
48  * 4. The name of the author may not be used to endorse or promote products
49  *    derived from this software without specific prior written permission.
50  *
51  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
52  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
53  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
54  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
55  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
56  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
60  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61  */
62 
63 /*
64  * driver for Integrated Circuit Systems' ICS1890 ethernet 10/100 PHY
65  * and its successor ICS1892
66  * datasheet from www.icst.com
67  */
68 
69 #include <sys/param.h>
70 #include <sys/systm.h>
71 #include <sys/kernel.h>
72 #include <sys/device.h>
73 #include <sys/socket.h>
74 
75 #include <net/if.h>
76 #include <net/if_media.h>
77 
78 #include <dev/mii/mii.h>
79 #include <dev/mii/miivar.h>
80 #include <dev/mii/miidevs.h>
81 
82 #include <dev/mii/icsphyreg.h>
83 
84 int	icsphymatch(struct device *, void *, void *);
85 void	icsphyattach(struct device *, struct device *, void *);
86 
87 struct cfattach icsphy_ca = {
88 	sizeof(struct mii_softc), icsphymatch, icsphyattach, mii_phy_detach,
89 	    mii_phy_activate
90 };
91 
92 struct cfdriver icsphy_cd = {
93 	NULL, "icsphy", DV_DULL
94 };
95 
96 int	icsphy_service(struct mii_softc *, struct mii_data *, int);
97 void	icsphy_reset(struct mii_softc *);
98 void	icsphy_status(struct mii_softc *);
99 
100 const struct mii_phy_funcs icsphy_funcs = {
101 	icsphy_service, icsphy_status, icsphy_reset,
102 };
103 
104 static const struct mii_phydesc icsphys[] = {
105 	{ MII_OUI_xxICS,		MII_MODEL_xxICS_1890,
106 	  MII_STR_xxICS_1890 },
107 	{ MII_OUI_xxICS,		MII_MODEL_xxICS_1892,
108 	  MII_STR_xxICS_1892 },
109 	{ MII_OUI_xxICS,		MII_MODEL_xxICS_1893,
110 	  MII_STR_xxICS_1893 },
111 
112 	{ 0,			0,
113 	  NULL },
114 
115 };
116 
117 int
118 icsphymatch(struct device *parent, void *match, 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(struct device *parent, struct device *self, void *aux)
130 {
131 	struct mii_softc *sc = (struct mii_softc *)self;
132 	struct mii_attach_args *ma = aux;
133 	struct mii_data *mii = ma->mii_data;
134 	const struct mii_phydesc *mpd;
135 
136 	mpd = mii_phy_match(ma, icsphys);
137 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
138 
139 	sc->mii_inst = mii->mii_instance;
140 	sc->mii_phy = ma->mii_phyno;
141 	sc->mii_funcs = &icsphy_funcs;
142 	sc->mii_pdata = mii;
143 	sc->mii_flags = ma->mii_flags;
144 
145 	PHY_RESET(sc);
146 
147 	sc->mii_capabilities =
148 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
149 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
150 		mii_phy_add_media(sc);
151 }
152 
153 int
154 icsphy_service(sc, mii, cmd)
155 	struct mii_softc *sc;
156 	struct mii_data *mii;
157 	int cmd;
158 {
159 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
160 	int reg;
161 
162 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
163 		return (ENXIO);
164 
165 	switch (cmd) {
166 	case MII_POLLSTAT:
167 		/*
168 		 * If we're not polling our PHY instance, just return.
169 		 */
170 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
171 			return (0);
172 		break;
173 
174 	case MII_MEDIACHG:
175 		/*
176 		 * If the media indicates a different PHY instance,
177 		 * isolate ourselves.
178 		 */
179 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
180 			reg = PHY_READ(sc, MII_BMCR);
181 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
182 			return (0);
183 		}
184 
185 		/*
186 		 * If the interface is not up, don't do anything.
187 		 */
188 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
189 			break;
190 
191 		mii_phy_setmedia(sc);
192 		break;
193 
194 	case MII_TICK:
195 		/*
196 		 * If we're not currently selected, just return.
197 		 */
198 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
199 			return (0);
200 
201 		if (mii_phy_tick(sc) == EJUSTRETURN)
202 			return (0);
203 		break;
204 
205 	case MII_DOWN:
206 		mii_phy_down(sc);
207 		return (0);
208 	}
209 
210 	/* Update the media status. */
211 	mii_phy_status(sc);
212 
213 	/* Callback if something changed. */
214 	mii_phy_update(sc, cmd);
215 	return (0);
216 }
217 
218 void
219 icsphy_status(sc)
220 	struct mii_softc *sc;
221 {
222 	struct mii_data *mii = sc->mii_pdata;
223 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
224 	int bmcr, qpr;
225 
226 	mii->mii_media_status = IFM_AVALID;
227 	mii->mii_media_active = IFM_ETHER;
228 
229 	/*
230 	 * Don't get link from the BMSR.  It's available in the QPR,
231 	 * and we have to read it twice to unlatch it anyhow.  This
232 	 * gives us fewer register reads.
233 	 */
234 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
235 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
236 
237 	if (qpr & QPR_LINK)
238 		mii->mii_media_status |= IFM_ACTIVE;
239 
240 	bmcr = PHY_READ(sc, MII_BMCR);
241 	if (bmcr & BMCR_ISO) {
242 		mii->mii_media_active |= IFM_NONE;
243 		mii->mii_media_status = 0;
244 		return;
245 	}
246 
247 	if (bmcr & BMCR_LOOP)
248 		mii->mii_media_active |= IFM_LOOP;
249 
250 	if (bmcr & BMCR_AUTOEN) {
251 		if ((qpr & QPR_ACOMP) == 0) {
252 			/* Erg, still trying, I guess... */
253 			mii->mii_media_active |= IFM_NONE;
254 			return;
255 		}
256 
257 		if (qpr & QPR_SPEED)
258 			mii->mii_media_active |= IFM_100_TX;
259 		else
260 			mii->mii_media_active |= IFM_10_T;
261 
262 		if (qpr & QPR_FDX)
263 			mii->mii_media_active |= IFM_FDX;
264 		else
265 			mii->mii_media_active |= IFM_HDX;
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 	/*
279 	 * XXX the ICS1892 doesn't set the BMCR properly after
280 	 * XXX reset, which breaks autonegotiation.
281 	 */
282 	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_AUTOEN|BMCR_FDX);
283 
284 }
285