xref: /openbsd-src/sys/dev/mii/icsphy.c (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1 /*	$OpenBSD: icsphy.c,v 1.20 2010/07/23 07:47:13 jsg 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  *
46  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
47  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
48  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
49  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
50  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
51  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
52  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
53  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
54  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
55  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56  */
57 
58 /*
59  * driver for Integrated Circuit Systems' ICS1890 ethernet 10/100 PHY
60  * and its successor ICS1892
61  * datasheet from www.icst.com
62  */
63 
64 #include <sys/param.h>
65 #include <sys/systm.h>
66 #include <sys/kernel.h>
67 #include <sys/device.h>
68 #include <sys/socket.h>
69 
70 #include <net/if.h>
71 #include <net/if_media.h>
72 
73 #include <dev/mii/mii.h>
74 #include <dev/mii/miivar.h>
75 #include <dev/mii/miidevs.h>
76 
77 #include <dev/mii/icsphyreg.h>
78 
79 int	icsphymatch(struct device *, void *, void *);
80 void	icsphyattach(struct device *, struct device *, void *);
81 
82 struct cfattach icsphy_ca = {
83 	sizeof(struct mii_softc), icsphymatch, icsphyattach, mii_phy_detach,
84 	    mii_phy_activate
85 };
86 
87 struct cfdriver icsphy_cd = {
88 	NULL, "icsphy", DV_DULL
89 };
90 
91 int	icsphy_service(struct mii_softc *, struct mii_data *, int);
92 void	icsphy_reset(struct mii_softc *);
93 void	icsphy_status(struct mii_softc *);
94 
95 const struct mii_phy_funcs icsphy_funcs = {
96 	icsphy_service, icsphy_status, icsphy_reset,
97 };
98 
99 static const struct mii_phydesc icsphys[] = {
100 	{ MII_OUI_xxICS,		MII_MODEL_xxICS_1890,
101 	  MII_STR_xxICS_1890 },
102 	{ MII_OUI_xxICS,		MII_MODEL_xxICS_1892,
103 	  MII_STR_xxICS_1892 },
104 	{ MII_OUI_xxICS,		MII_MODEL_xxICS_1893,
105 	  MII_STR_xxICS_1893 },
106 
107 	{ 0,			0,
108 	  NULL },
109 
110 };
111 
112 int
113 icsphymatch(struct device *parent, void *match, void *aux)
114 {
115 	struct mii_attach_args *ma = aux;
116 
117 	if (mii_phy_match(ma, icsphys) != NULL)
118 		return (10);
119 
120 	return (0);
121 }
122 
123 void
124 icsphyattach(struct device *parent, struct device *self, void *aux)
125 {
126 	struct mii_softc *sc = (struct mii_softc *)self;
127 	struct mii_attach_args *ma = aux;
128 	struct mii_data *mii = ma->mii_data;
129 	const struct mii_phydesc *mpd;
130 
131 	mpd = mii_phy_match(ma, icsphys);
132 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
133 
134 	sc->mii_inst = mii->mii_instance;
135 	sc->mii_phy = ma->mii_phyno;
136 	sc->mii_funcs = &icsphy_funcs;
137 	sc->mii_pdata = mii;
138 	sc->mii_flags = ma->mii_flags;
139 
140 	PHY_RESET(sc);
141 
142 	sc->mii_capabilities =
143 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
144 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
145 		mii_phy_add_media(sc);
146 }
147 
148 int
149 icsphy_service(sc, mii, cmd)
150 	struct mii_softc *sc;
151 	struct mii_data *mii;
152 	int cmd;
153 {
154 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
155 	int reg;
156 
157 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
158 		return (ENXIO);
159 
160 	switch (cmd) {
161 	case MII_POLLSTAT:
162 		/*
163 		 * If we're not polling our PHY instance, just return.
164 		 */
165 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
166 			return (0);
167 		break;
168 
169 	case MII_MEDIACHG:
170 		/*
171 		 * If the media indicates a different PHY instance,
172 		 * isolate ourselves.
173 		 */
174 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
175 			reg = PHY_READ(sc, MII_BMCR);
176 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
177 			return (0);
178 		}
179 
180 		/*
181 		 * If the interface is not up, don't do anything.
182 		 */
183 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
184 			break;
185 
186 		mii_phy_setmedia(sc);
187 		break;
188 
189 	case MII_TICK:
190 		/*
191 		 * If we're not currently selected, just return.
192 		 */
193 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
194 			return (0);
195 
196 		if (mii_phy_tick(sc) == EJUSTRETURN)
197 			return (0);
198 		break;
199 
200 	case MII_DOWN:
201 		mii_phy_down(sc);
202 		return (0);
203 	}
204 
205 	/* Update the media status. */
206 	mii_phy_status(sc);
207 
208 	/* Callback if something changed. */
209 	mii_phy_update(sc, cmd);
210 	return (0);
211 }
212 
213 void
214 icsphy_status(sc)
215 	struct mii_softc *sc;
216 {
217 	struct mii_data *mii = sc->mii_pdata;
218 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
219 	int bmcr, qpr;
220 
221 	mii->mii_media_status = IFM_AVALID;
222 	mii->mii_media_active = IFM_ETHER;
223 
224 	/*
225 	 * Don't get link from the BMSR.  It's available in the QPR,
226 	 * and we have to read it twice to unlatch it anyhow.  This
227 	 * gives us fewer register reads.
228 	 */
229 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
230 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
231 
232 	if (qpr & QPR_LINK)
233 		mii->mii_media_status |= IFM_ACTIVE;
234 
235 	bmcr = PHY_READ(sc, MII_BMCR);
236 	if (bmcr & BMCR_ISO) {
237 		mii->mii_media_active |= IFM_NONE;
238 		mii->mii_media_status = 0;
239 		return;
240 	}
241 
242 	if (bmcr & BMCR_LOOP)
243 		mii->mii_media_active |= IFM_LOOP;
244 
245 	if (bmcr & BMCR_AUTOEN) {
246 		if ((qpr & QPR_ACOMP) == 0) {
247 			/* Erg, still trying, I guess... */
248 			mii->mii_media_active |= IFM_NONE;
249 			return;
250 		}
251 
252 		if (qpr & QPR_SPEED)
253 			mii->mii_media_active |= IFM_100_TX;
254 		else
255 			mii->mii_media_active |= IFM_10_T;
256 
257 		if (qpr & QPR_FDX)
258 			mii->mii_media_active |= IFM_FDX;
259 		else
260 			mii->mii_media_active |= IFM_HDX;
261 	} else
262 		mii->mii_media_active = ife->ifm_media;
263 }
264 
265 void
266 icsphy_reset(sc)
267 	struct mii_softc *sc;
268 {
269 
270 	mii_phy_reset(sc);
271 	PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_10TPROT|ECR2_Q10T);
272 
273 	/*
274 	 * XXX the ICS1892 doesn't set the BMCR properly after
275 	 * XXX reset, which breaks autonegotiation.
276 	 */
277 	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_AUTOEN|BMCR_FDX);
278 
279 }
280