Merge from vendor branch ATHEROS:
[dragonfly.git] / sys / dev / netif / mii_layer / 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  * $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 $
34  */
35
36 /*
37  * driver for Micro Linear 6692 PHYs
38  *
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
46  * of the 6692.
47  *
48  * This device also does not have vendor/device ID registers.
49  */
50
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>
57 #include <sys/bus.h>
58
59 #include <machine/clock.h>
60
61 #include <net/if.h>
62 #include <net/if_media.h>
63
64 #include "mii.h"
65 #include "miivar.h"
66
67 #include "miibus_if.h"
68
69 #define ML_STATE_AUTO_SELF      1
70 #define ML_STATE_AUTO_OTHER     2
71
72 struct mlphy_softc      {
73         struct mii_softc        ml_mii;
74         int                     ml_state;
75         int                     ml_linked;
76 };
77
78 static int mlphy_probe          (device_t);
79 static int mlphy_attach         (device_t);
80 static int mlphy_detach         (device_t);
81
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),
88         { 0, 0 }
89 };
90
91 static devclass_t mlphy_devclass;
92
93 static driver_t mlphy_driver = {
94         "mlphy",
95         mlphy_methods,
96         sizeof(struct mlphy_softc)
97 };
98
99 DRIVER_MODULE(mlphy, miibus, mlphy_driver, mlphy_devclass, 0, 0);
100
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 *);
104
105 static int
106 mlphy_probe(device_t dev)
107 {
108         struct mii_attach_args  *ma;
109         device_t                parent;
110
111         ma = device_get_ivars(dev);
112         parent = device_get_parent(device_get_parent(dev));
113
114         /*
115          * Micro Linear PHY reports oui == 0 model == 0
116          */
117         if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
118             MII_MODEL(ma->mii_id2) != 0)
119                 return (ENXIO);
120
121         /*
122          * Make sure the parent is a `tl'. So far, I have only
123          * encountered the 6692 on an Olicom card with a ThunderLAN
124          * controller chip.
125          */
126         if (strcmp(device_get_name(parent), "tl") != 0)
127                 return (ENXIO);
128
129         device_set_desc(dev, "Micro Linear 6692 media interface");
130
131         return (0);
132 }
133
134 static int
135 mlphy_attach(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         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);
149
150         sc->mii_inst = mii->mii_instance;
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         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
174                 printf("no media present");
175         else
176                 mii_add_media(sc, sc->mii_capabilities);
177         printf("\n");
178 #undef ADD
179         MIIBUS_MEDIAINIT(sc->mii_dev);
180         return(0);
181 }
182
183 static int
184 mlphy_detach(device_t dev)
185 {
186         struct mlphy_softc      *sc;
187         struct mii_data         *mii;
188
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);
194
195         return(0);
196 }
197
198 static int
199 mlphy_service(struct mii_softc *xsc, struct mii_data *mii, int cmd)
200 {
201         struct ifmedia_entry    *ife = mii->mii_media.ifm_cur;
202         int                     reg;
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;
206         device_t                *devlist;
207         int                     devs, i;
208
209         /*
210          * See if there's another PHY on this bus with us.
211          * If so, we may need it for 10Mbps modes.
212          */
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]);
217                         break;
218                 }
219         }
220         free(devlist, M_TEMP);
221
222         switch (cmd) {
223         case MII_POLLSTAT:
224                 /*
225                  * If we're not polling our PHY instance, just return.
226                  */
227                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
228                         return (0);
229                 break;
230
231         case MII_MEDIACHG:
232                 /*
233                  * If the media indicates a different PHY instance,
234                  * isolate ourselves.
235                  */
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);
239                         return (0);
240                 }
241
242                 /*
243                  * If the interface is not up, don't do anything.
244                  */
245                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
246                         break;
247
248                 switch (IFM_SUBTYPE(ife->ifm_media)) {
249                 case IFM_AUTO:
250                         /*
251                          * For autonegotiation, reset and isolate the
252                          * companion PHY (if any) and then do NWAY
253                          * autonegotiation ourselves.
254                          */
255                         msc->ml_state = ML_STATE_AUTO_SELF;
256                         if (other != NULL) {
257                                 mii_phy_reset(other);
258                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
259                         }
260                         (void) mii_phy_auto(sc, 1);
261                         msc->ml_linked = 0;
262                         return(0);
263                         break;
264                 case IFM_10_T:
265                         /*
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
270                          * work.
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, ife->ifm_data);
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_TX:
283                         /*
284                          * For 100baseTX modes, reset and isolate the
285                          * companion PHY (if any), then program ourselves
286                          * accordingly.
287                          *
288                          * BMCR data is stored in the ifmedia entry.
289                          */
290                         if (other != NULL) {
291                                 mii_phy_reset(other);
292                                 PHY_WRITE(other, MII_BMCR, BMCR_ISO);
293                         }
294                         PHY_WRITE(sc, MII_ANAR, mii_anar(ife->ifm_media));
295                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
296                         msc->ml_state = 0;
297                         break;
298                 case IFM_100_T4:
299                         /*
300                          * XXX Not supported as a manual setting right now.
301                          */
302                         return (EINVAL);
303                 default:
304                         break;
305
306                 }
307                 break;
308
309         case MII_TICK:
310                 /*
311                  * If we're not currently selected, just return.
312                  */
313                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
314                         return (0);
315
316                 /*
317                  * Only used for autonegotiation.
318                  */
319                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
320                         return (0);
321
322                 /*
323                  * Is the interface even up?
324                  */
325                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
326                         return (0);
327
328                 /*
329                  * Only retry autonegotiation every 5 seconds.
330                  */
331                 if (++sc->mii_ticks != 5)
332                         return (0);
333                 
334                 sc->mii_ticks = 0;
335
336                 /*
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.
344                  */
345                 if (msc->ml_state == ML_STATE_AUTO_OTHER) {
346                         reg = PHY_READ(other, MII_BMSR) |
347                             PHY_READ(other, MII_BMSR);
348                 } else {
349                         reg = PHY_READ(sc, MII_BMSR) |
350                             PHY_READ(sc, MII_BMSR);
351                 }
352
353                 if (reg & BMSR_LINK) {
354                         if (!msc->ml_linked) {
355                                 msc->ml_linked = 1;
356                                 mlphy_status(sc);
357                                 break;
358                         }
359                         return(0);
360                 }
361
362                 msc->ml_linked = 0;
363                 mii->mii_media_active = IFM_NONE;
364                 mii_phy_reset(sc);
365                 msc->ml_state = ML_STATE_AUTO_SELF;
366                 if (other != NULL) {
367                         mii_phy_reset(other);
368                         PHY_WRITE(other, MII_BMCR, BMCR_ISO);
369                 }
370                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
371                         return(0);
372                 break;
373         }
374
375         /* Update the media status. */
376
377         if (msc->ml_state == ML_STATE_AUTO_OTHER) {
378                 int                     other_inst;
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;
384         } else
385                 ukphy_status(sc);
386
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;
391         }
392
393         return (0);
394 }
395
396 /*
397  * The Micro Linear PHY comes out of reset with the 'autoneg
398  * enable' bit set, which we don't want.
399  */
400 static void
401 mlphy_reset(struct mii_softc *sc)
402 {
403         int                     reg;
404
405         mii_phy_reset(sc);
406         reg = PHY_READ(sc, MII_BMCR);
407         reg &= ~BMCR_AUTOEN;
408         PHY_WRITE(sc, MII_BMCR, reg);
409
410         return;
411 }
412
413 /*
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.
416  */
417 static void
418 mlphy_status(struct mii_softc *sc)
419 {
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;
423         device_t                *devlist;
424         int                     devs, i;
425
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]);
431                         break;
432                 }
433         }
434         free(devlist, M_TEMP);
435
436         if (other == NULL)
437                 return;
438
439         ukphy_status(sc);
440
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);
445         }
446
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);
453         }
454
455         return;
456 }