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