FreeBSD/Linux Kernel Cross Reference
sys/dev/mii/mlphy.c
1 /*-
2 * Copyright (c) 1997, 1998, 1999
3 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD: releng/6.0/sys/dev/mii/mlphy.c 139749 2005-01-06 01:43:34Z imp $");
36
37 /*
38 * driver for Micro Linear 6692 PHYs
39 *
40 * The Micro Linear 6692 is a strange beast, and dealing with it using
41 * this code framework is tricky. The 6692 is actually a 100Mbps-only
42 * device, which means that a second PHY is required to support 10Mbps
43 * modes. However, even though the 6692 does not support 10Mbps modes,
44 * it can still advertise them when performing autonegotiation. If a
45 * 10Mbps mode is negotiated, we must program the registers of the
46 * companion PHY accordingly in addition to programming the registers
47 * of the 6692.
48 *
49 * This device also does not have vendor/device ID registers.
50 */
51
52 #include <sys/param.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
55 #include <sys/socket.h>
56 #include <sys/module.h>
57 #include <sys/bus.h>
58 #include <sys/malloc.h>
59
60 #include <net/if.h>
61 #include <net/if_media.h>
62
63 #include <dev/mii/mii.h>
64 #include <dev/mii/miivar.h>
65
66 #include "miibus_if.h"
67
68 #define ML_STATE_AUTO_SELF 1
69 #define ML_STATE_AUTO_OTHER 2
70
71 struct mlphy_softc {
72 struct mii_softc ml_mii;
73 int ml_state;
74 int ml_linked;
75 };
76
77 static int mlphy_probe(device_t);
78 static int mlphy_attach(device_t);
79
80 static device_method_t mlphy_methods[] = {
81 /* device interface */
82 DEVMETHOD(device_probe, mlphy_probe),
83 DEVMETHOD(device_attach, mlphy_attach),
84 DEVMETHOD(device_detach, mii_phy_detach),
85 DEVMETHOD(device_shutdown, bus_generic_shutdown),
86 { 0, 0 }
87 };
88
89 static devclass_t mlphy_devclass;
90
91 static driver_t mlphy_driver = {
92 "mlphy",
93 mlphy_methods,
94 sizeof(struct mlphy_softc)
95 };
96
97 DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0);
98
99 static int mlphy_service(struct mii_softc *, struct mii_data *, int);
100 static void mlphy_reset(struct mii_softc *);
101 static void mlphy_status(struct mii_softc *);
102
103 static int
104 mlphy_probe(dev)
105 device_t dev;
106 {
107 struct mii_attach_args *ma;
108 device_t parent;
109
110 ma = device_get_ivars(dev);
111 parent = device_get_parent(device_get_parent(dev));
112
113 /*
114 * Micro Linear PHY reports oui == 0 model == 0
115 */
116 if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
117 MII_MODEL(ma->mii_id2) != 0)
118 return (ENXIO);
119
120 /*
121 * Make sure the parent is a `tl'. So far, I have only
122 * encountered the 6692 on an Olicom card with a ThunderLAN
123 * controller chip.
124 */
125 if (strcmp(device_get_name(parent), "tl") != 0)
126 return (ENXIO);
127
128 device_set_desc(dev, "Micro Linear 6692 media interface");
129
130 return (0);
131 }
132
133 static int
134 mlphy_attach(dev)
135 device_t dev;
136 {
137 struct mlphy_softc *msc;
138 struct mii_softc *sc;
139 struct mii_attach_args *ma;
140 struct mii_data *mii;
141
142 msc = device_get_softc(dev);
143 sc = &msc->ml_mii;
144 ma = device_get_ivars(dev);
145 sc->mii_dev = device_get_parent(dev);
146 mii = device_get_softc(sc->mii_dev);
147 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
148
149 sc->mii_inst = mii->mii_instance;
150 sc->mii_phy = ma->mii_phyno;
151 sc->mii_service = mlphy_service;
152 sc->mii_pdata = mii;
153
154 mii->mii_instance++;
155
156 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL)
157
158 #if 0 /* See above. */
159 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
160 BMCR_ISO);
161 #endif
162 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
163 BMCR_LOOP|BMCR_S100);
164
165 sc->mii_flags &= ~MIIF_NOISOLATE;
166 mii_phy_reset(sc);
167 sc->mii_flags |= MIIF_NOISOLATE;
168
169 sc->mii_capabilities =
170 PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
171 ma->mii_capmask = ~sc->mii_capabilities;
172 device_printf(dev, " ");
173 mii_add_media(sc);
174 printf("\n");
175 #undef ADD
176 MIIBUS_MEDIAINIT(sc->mii_dev);
177 return(0);
178 }
179
180 static int
181 mlphy_service(xsc, mii, cmd)
182 struct mii_softc *xsc;
183 struct mii_data *mii;
184 int cmd;
185 {
186 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
187 int reg;
188 struct mii_softc *other = NULL;
189 struct mlphy_softc *msc = (struct mlphy_softc *)xsc;
190 struct mii_softc *sc = (struct mii_softc *)&msc->ml_mii;
191 device_t *devlist;
192 int devs, i;
193
194 /*
195 * See if there's another PHY on this bus with us.
196 * If so, we may need it for 10Mbps modes.
197 */
198 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
199 for (i = 0; i < devs; i++) {
200 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
201 other = device_get_softc(devlist[i]);
202 break;
203 }
204 }
205 free(devlist, M_TEMP);
206
207 switch (cmd) {
208 case MII_POLLSTAT:
209 /*
210 * If we're not polling our PHY instance, just return.
211 */
212 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
213 return (0);
214 break;
215
216 case MII_MEDIACHG:
217 /*
218 * If the media indicates a different PHY instance,
219 * isolate ourselves.
220 */
221 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
222 reg = PHY_READ(sc, MII_BMCR);
223 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
224 return (0);
225 }
226
227 /*
228 * If the interface is not up, don't do anything.
229 */
230 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
231 break;
232
233 switch (IFM_SUBTYPE(ife->ifm_media)) {
234 case IFM_AUTO:
235 /*
236 * For autonegotiation, reset and isolate the
237 * companion PHY (if any) and then do NWAY
238 * autonegotiation ourselves.
239 */
240 msc->ml_state = ML_STATE_AUTO_SELF;
241 if (other != NULL) {
242 mii_phy_reset(other);
243 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
244 }
245 (void) mii_phy_auto(sc);
246 msc->ml_linked = 0;
247 return(0);
248 case IFM_10_T:
249 /*
250 * For 10baseT modes, reset and program the
251 * companion PHY (of any), then program ourselves
252 * to match. This will put us in pass-through
253 * mode and let the companion PHY do all the
254 * work.
255 *
256 * BMCR data is stored in the ifmedia entry.
257 */
258 if (other != NULL) {
259 mii_phy_reset(other);
260 PHY_WRITE(other, MII_BMCR, ife->ifm_data);
261 }
262 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
263 PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
264 msc->ml_state = 0;
265 break;
266 case IFM_100_TX:
267 /*
268 * For 100baseTX modes, reset and isolate the
269 * companion PHY (if any), then program ourselves
270 * accordingly.
271 *
272 * BMCR data is stored in the ifmedia entry.
273 */
274 if (other != NULL) {
275 mii_phy_reset(other);
276 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
277 }
278 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
279 PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
280 msc->ml_state = 0;
281 break;
282 case IFM_100_T4:
283 /*
284 * XXX Not supported as a manual setting right now.
285 */
286 return (EINVAL);
287 default:
288 break;
289
290 }
291 break;
292
293 case MII_TICK:
294 /*
295 * If we're not currently selected, just return.
296 */
297 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
298 return (0);
299
300 /*
301 * Is the interface even up?
302 */
303 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
304 return (0);
305
306 /*
307 * Only used for autonegotiation.
308 */
309 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
310 break;
311
312 /*
313 * Check to see if we have link. If we do, we don't
314 * need to restart the autonegotiation process. Read
315 * the BMSR twice in case it's latched.
316 * If we're in a 10Mbps mode, check the link of the
317 * 10Mbps PHY. Sometimes the Micro Linear PHY's
318 * linkstat bit will clear while the linkstat bit of
319 * the companion PHY will remain set.
320 */
321 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
322 reg = PHY_READ(other, MII_BMSR) |
323 PHY_READ(other, MII_BMSR);
324 } else {
325 reg = PHY_READ(sc, MII_BMSR) |
326 PHY_READ(sc, MII_BMSR);
327 }
328
329 if (reg & BMSR_LINK) {
330 if (!msc->ml_linked) {
331 msc->ml_linked = 1;
332 mlphy_status(sc);
333 }
334 break;
335 }
336
337 /*
338 * Only retry autonegotiation every 5 seconds.
339 */
340 if (++sc->mii_ticks <= 5)
341 break;
342
343 sc->mii_ticks = 0;
344 msc->ml_linked = 0;
345 mii->mii_media_active = IFM_NONE;
346 mii_phy_reset(sc);
347 msc->ml_state = ML_STATE_AUTO_SELF;
348 if (other != NULL) {
349 mii_phy_reset(other);
350 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
351 }
352 mii_phy_auto(sc);
353 return(0);
354 }
355
356 /* Update the media status. */
357
358 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
359 int other_inst;
360 other_inst = other->mii_inst;
361 other->mii_inst = sc->mii_inst;
362 (void) (*other->mii_service)(other, mii, MII_POLLSTAT);
363 other->mii_inst = other_inst;
364 sc->mii_media_active = other->mii_media_active;
365 sc->mii_media_status = other->mii_media_status;
366 } else
367 ukphy_status(sc);
368
369 /* Callback if something changed. */
370 mii_phy_update(sc, cmd);
371 return (0);
372 }
373
374 /*
375 * The Micro Linear PHY comes out of reset with the 'autoneg
376 * enable' bit set, which we don't want.
377 */
378 static void
379 mlphy_reset(sc)
380 struct mii_softc *sc;
381 {
382 int reg;
383
384 mii_phy_reset(sc);
385 reg = PHY_READ(sc, MII_BMCR);
386 reg &= ~BMCR_AUTOEN;
387 PHY_WRITE(sc, MII_BMCR, reg);
388
389 return;
390 }
391
392 /*
393 * If we negotiate a 10Mbps mode, we need to check for an alternate
394 * PHY and make sure it's enabled and set correctly.
395 */
396 static void
397 mlphy_status(sc)
398 struct mii_softc *sc;
399 {
400 struct mlphy_softc *msc = (struct mlphy_softc *)sc;
401 struct mii_data *mii = msc->ml_mii.mii_pdata;
402 struct mii_softc *other = NULL;
403 device_t *devlist;
404 int devs, i;
405
406 /* See if there's another PHY on the bus with us. */
407 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
408 for (i = 0; i < devs; i++) {
409 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
410 other = device_get_softc(devlist[i]);
411 break;
412 }
413 }
414 free(devlist, M_TEMP);
415
416 if (other == NULL)
417 return;
418
419 ukphy_status(sc);
420
421 if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) {
422 msc->ml_state = ML_STATE_AUTO_SELF;
423 mii_phy_reset(other);
424 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
425 }
426
427 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) {
428 msc->ml_state = ML_STATE_AUTO_OTHER;
429 mlphy_reset(&msc->ml_mii);
430 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO);
431 mii_phy_reset(other);
432 mii_phy_auto(other);
433 }
434
435 return;
436 }
Cache object: aea6d22a1bcdb07128496fe81bb6674d
|