2 * Copyright (c) 1997, 1998, 1999
3 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
32 * $FreeBSD: src/sys/dev/mii/mlphy.c,v 1.2.2.3 2001/02/09 09:50:15 asmodai Exp $
33 * $DragonFly: src/sys/dev/netif/mii_layer/mlphy.c,v 1.8 2005/12/11 01:54:08 swildner Exp $
37 * driver for Micro Linear 6692 PHYs
39 * The Micro Linear 6692 is a strange beast, and dealing with it using
40 * this code framework is tricky. The 6692 is actually a 100Mbps-only
41 * device, which means that a second PHY is required to support 10Mbps
42 * modes. However, even though the 6692 does not support 10Mbps modes,
43 * it can still advertise them when performing autonegotiation. If a
44 * 10Mbps mode is negotiated, we must program the registers of the
45 * companion PHY accordingly in addition to programming the registers
48 * This device also does not have vendor/device ID registers.
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/kernel.h>
54 #include <sys/malloc.h>
55 #include <sys/socket.h>
56 #include <sys/module.h>
59 #include <machine/clock.h>
62 #include <net/if_media.h>
67 #include "miibus_if.h"
69 #define ML_STATE_AUTO_SELF 1
70 #define ML_STATE_AUTO_OTHER 2
73 struct mii_softc ml_mii;
78 static int mlphy_probe (device_t);
79 static int mlphy_attach (device_t);
80 static int mlphy_detach (device_t);
82 static device_method_t mlphy_methods[] = {
83 /* device interface */
84 DEVMETHOD(device_probe, mlphy_probe),
85 DEVMETHOD(device_attach, mlphy_attach),
86 DEVMETHOD(device_detach, mlphy_detach),
87 DEVMETHOD(device_shutdown, bus_generic_shutdown),
91 static devclass_t mlphy_devclass;
93 static driver_t mlphy_driver = {
96 sizeof(struct mlphy_softc)
99 DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0);
101 static int mlphy_service (struct mii_softc *, struct mii_data *, int);
102 static void mlphy_reset (struct mii_softc *);
103 static void mlphy_status (struct mii_softc *);
106 mlphy_probe(device_t dev)
108 struct mii_attach_args *ma;
111 ma = device_get_ivars(dev);
112 parent = device_get_parent(device_get_parent(dev));
115 * Micro Linear PHY reports oui == 0 model == 0
117 if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
118 MII_MODEL(ma->mii_id2) != 0)
122 * Make sure the parent is a `tl'. So far, I have only
123 * encountered the 6692 on an Olicom card with a ThunderLAN
126 if (strcmp(device_get_name(parent), "tl") != 0)
129 device_set_desc(dev, "Micro Linear 6692 media interface");
135 mlphy_attach(device_t dev)
137 struct mlphy_softc *msc;
138 struct mii_softc *sc;
139 struct mii_attach_args *ma;
140 struct mii_data *mii;
142 msc = device_get_softc(dev);
144 ma = device_get_ivars(dev);
145 mii_softc_init(sc, ma);
146 sc->mii_dev = device_get_parent(dev);
147 mii = device_get_softc(sc->mii_dev);
148 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
150 sc->mii_inst = mii->mii_instance;
151 sc->mii_service = mlphy_service;
156 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL)
158 #if 0 /* See above. */
159 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
162 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
163 BMCR_LOOP|BMCR_S100);
165 sc->mii_flags &= ~MIIF_NOISOLATE;
167 sc->mii_flags |= MIIF_NOISOLATE;
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 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
174 printf("no media present");
176 mii_add_media(sc, sc->mii_capabilities);
179 MIIBUS_MEDIAINIT(sc->mii_dev);
184 mlphy_detach(device_t dev)
186 struct mlphy_softc *sc;
187 struct mii_data *mii;
189 sc = device_get_softc(dev);
190 mii = device_get_softc(device_get_parent(dev));
191 mii_phy_auto_stop(&sc->ml_mii);
192 sc->ml_mii.mii_dev = NULL;
193 LIST_REMOVE(&sc->ml_mii, mii_list);
199 mlphy_service(struct mii_softc *xsc, struct mii_data *mii, int cmd)
201 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
203 struct mii_softc *other = NULL;
204 struct mlphy_softc *msc = (struct mlphy_softc *)xsc;
205 struct mii_softc *sc = (struct mii_softc *)&msc->ml_mii;
210 * See if there's another PHY on this bus with us.
211 * If so, we may need it for 10Mbps modes.
213 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
214 for (i = 0; i < devs; i++) {
215 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
216 other = device_get_softc(devlist[i]);
220 free(devlist, M_TEMP);
225 * If we're not polling our PHY instance, just return.
227 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
233 * If the media indicates a different PHY instance,
236 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
237 reg = PHY_READ(sc, MII_BMCR);
238 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
243 * If the interface is not up, don't do anything.
245 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
248 switch (IFM_SUBTYPE(ife->ifm_media)) {
251 * For autonegotiation, reset and isolate the
252 * companion PHY (if any) and then do NWAY
253 * autonegotiation ourselves.
255 msc->ml_state = ML_STATE_AUTO_SELF;
257 mii_phy_reset(other);
258 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
260 (void) mii_phy_auto(sc, 1);
266 * For 10baseT modes, reset and program the
267 * companion PHY (of any), then program ourselves
268 * to match. This will put us in pass-through
269 * mode and let the companion PHY do all the
272 * BMCR data is stored in the ifmedia entry.
275 mii_phy_reset(other);
276 PHY_WRITE(other, MII_BMCR, ife->ifm_data);
278 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
279 PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
284 * For 100baseTX modes, reset and isolate the
285 * companion PHY (if any), then program ourselves
288 * BMCR data is stored in the ifmedia entry.
291 mii_phy_reset(other);
292 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
294 PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
295 PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
300 * XXX Not supported as a manual setting right now.
311 * If we're not currently selected, just return.
313 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
317 * Only used for autonegotiation.
319 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
323 * Is the interface even up?
325 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
329 * Only retry autonegotiation every 5 seconds.
331 if (++sc->mii_ticks != 5)
337 * Check to see if we have link. If we do, we don't
338 * need to restart the autonegotiation process. Read
339 * the BMSR twice in case it's latched.
340 * If we're in a 10Mbps mode, check the link of the
341 * 10Mbps PHY. Sometimes the Micro Linear PHY's
342 * linkstat bit will clear while the linkstat bit of
343 * the companion PHY will remain set.
345 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
346 reg = PHY_READ(other, MII_BMSR) |
347 PHY_READ(other, MII_BMSR);
349 reg = PHY_READ(sc, MII_BMSR) |
350 PHY_READ(sc, MII_BMSR);
353 if (reg & BMSR_LINK) {
354 if (!msc->ml_linked) {
363 mii->mii_media_active = IFM_NONE;
365 msc->ml_state = ML_STATE_AUTO_SELF;
367 mii_phy_reset(other);
368 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
370 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
375 /* Update the media status. */
377 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
379 other_inst = other->mii_inst;
380 other->mii_inst = sc->mii_inst;
381 (void) (*other->mii_service)(other, mii, MII_POLLSTAT);
382 other->mii_inst = other_inst;
383 sc->mii_active = other->mii_active;
387 /* Callback if something changed. */
388 if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
389 MIIBUS_STATCHG(sc->mii_dev);
390 sc->mii_active = mii->mii_media_active;
397 * The Micro Linear PHY comes out of reset with the 'autoneg
398 * enable' bit set, which we don't want.
401 mlphy_reset(struct mii_softc *sc)
406 reg = PHY_READ(sc, MII_BMCR);
408 PHY_WRITE(sc, MII_BMCR, reg);
414 * If we negotiate a 10Mbps mode, we need to check for an alternate
415 * PHY and make sure it's enabled and set correctly.
418 mlphy_status(struct mii_softc *sc)
420 struct mlphy_softc *msc = (struct mlphy_softc *)sc;
421 struct mii_data *mii = msc->ml_mii.mii_pdata;
422 struct mii_softc *other = NULL;
426 /* See if there's another PHY on the bus with us. */
427 device_get_children(msc->ml_mii.mii_dev, &devlist, &devs);
428 for (i = 0; i < devs; i++) {
429 if (strcmp(device_get_name(devlist[i]), "mlphy")) {
430 other = device_get_softc(devlist[i]);
434 free(devlist, M_TEMP);
441 if (IFM_SUBTYPE(mii->mii_media_active) != IFM_10_T) {
442 msc->ml_state = ML_STATE_AUTO_SELF;
443 mii_phy_reset(other);
444 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
447 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) {
448 msc->ml_state = ML_STATE_AUTO_OTHER;
449 mlphy_reset(&msc->ml_mii);
450 PHY_WRITE(&msc->ml_mii, MII_BMCR, BMCR_ISO);
451 mii_phy_reset(other);
452 mii_phy_auto(other, 1);