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