Merge from vendor branch TCPDUMP:
[dragonfly.git] / sys / dev / netif / mii_layer / xmphy.c
1 /*
2  * Copyright (c) 2000
3  *      Bill Paul <wpaul@ee.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/xmphy.c,v 1.1.2.5 2002/11/08 21:53:49 semenu Exp $
33  * $DragonFly: src/sys/dev/netif/mii_layer/xmphy.c,v 1.10 2006/12/22 23:26:20 swildner Exp $
34  */
35
36 /*
37  * driver for the XaQti XMAC II's internal PHY. This is sort of
38  * like a 10/100 PHY, except the only thing we're really autoselecting
39  * here is full/half duplex. Speed is always 1000mbps.
40  */
41
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/socket.h>
46 #include <sys/bus.h>
47
48 #include <machine/clock.h>
49
50 #include <net/if.h>
51 #include <net/if_media.h>
52
53 #include "mii.h"
54 #include "miivar.h"
55 #include "miidevs.h"
56
57 #include "xmphyreg.h"
58
59 #include "miibus_if.h"
60
61 static int xmphy_probe          (device_t);
62 static int xmphy_attach         (device_t);
63
64 static device_method_t xmphy_methods[] = {
65         /* device interface */
66         DEVMETHOD(device_probe,         xmphy_probe),
67         DEVMETHOD(device_attach,        xmphy_attach),
68         DEVMETHOD(device_detach,        ukphy_detach),
69         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
70         { 0, 0 }
71 };
72
73 static const struct mii_phydesc xmphys[] = {
74         MII_PHYDESC(xxXAQTI,    XMACII),
75         MII_PHYDESC(JATO,       BASEX),
76         MII_PHYDESC_NULL
77 };
78
79 static devclass_t xmphy_devclass;
80
81 static driver_t xmphy_driver = {
82         "xmphy",
83         xmphy_methods,
84         sizeof(struct mii_softc)
85 };
86
87 DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
88
89 static int      xmphy_service(struct mii_softc *, struct mii_data *, int);
90 static void     xmphy_status(struct mii_softc *);
91
92 static int      xmphy_mii_phy_auto(struct mii_softc *, int);
93
94 static int
95 xmphy_probe(device_t dev)
96 {
97         struct mii_attach_args *ma = device_get_ivars(dev);
98         const struct mii_phydesc *mpd;
99
100         mpd = mii_phy_match(ma, xmphys);
101         if (mpd != NULL) {
102                 device_set_desc(dev, mpd->mpd_name);
103                 return (0);
104         }
105         return (ENXIO);
106 }
107
108 static int
109 xmphy_attach(device_t dev)
110 {
111         struct mii_softc *sc;
112         struct mii_attach_args *ma;
113         struct mii_data *mii;
114         const char *sep = "";
115
116         sc = device_get_softc(dev);
117         ma = device_get_ivars(dev);
118         mii_softc_init(sc, ma);
119         sc->mii_dev = device_get_parent(dev);
120         mii = device_get_softc(sc->mii_dev);
121         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
122
123         sc->mii_inst = mii->mii_instance;
124         sc->mii_service = xmphy_service;
125         sc->mii_reset = mii_phy_reset;
126         sc->mii_pdata = mii;
127
128         sc->mii_flags |= MIIF_NOISOLATE;
129         mii->mii_instance++;
130
131 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
132 #define PRINT(s)        kprintf("%s%s", sep, s); sep = ", "
133
134         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
135             BMCR_ISO);
136 #if 0
137         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
138             BMCR_LOOP|BMCR_S100);
139 #endif
140
141         mii_phy_reset(sc);
142
143         device_printf(dev, " ");
144         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
145             XMPHY_BMCR_FDX);
146         PRINT("1000baseSX");
147         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
148         PRINT("1000baseSX-FDX");
149         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
150         PRINT("auto");
151
152         kprintf("\n");
153 #undef ADD
154 #undef PRINT
155
156         MIIBUS_MEDIAINIT(sc->mii_dev);
157         return(0);
158 }
159
160 int
161 xmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
162 {
163         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
164         int reg;
165
166         switch (cmd) {
167         case MII_POLLSTAT:
168                 /*
169                  * If we're not polling our PHY instance, just return.
170                  */
171                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
172                         return (0);
173                 break;
174
175         case MII_MEDIACHG:
176                 /*
177                  * If the media indicates a different PHY instance,
178                  * isolate ourselves.
179                  */
180                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
181                         reg = PHY_READ(sc, MII_BMCR);
182                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
183                         return (0);
184                 }
185
186                 /*
187                  * If the interface is not up, don't do anything.
188                  */
189                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
190                         break;
191
192                 switch (IFM_SUBTYPE(ife->ifm_media)) {
193                 case IFM_AUTO:
194 #ifdef foo
195                         /*
196                          * If we're already in auto mode, just return.
197                          */
198                         if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
199                                 return (0);
200 #endif
201                         xmphy_mii_phy_auto(sc, 1);
202                         break;
203                 case IFM_1000_SX:
204                         mii_phy_reset(sc);
205                         if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
206                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
207                                 PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
208                         } else {
209                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
210                                 PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
211                         }
212                         break;
213                 case IFM_100_T4:
214                 case IFM_100_TX:
215                 case IFM_10_T:
216                 default:
217                         return (EINVAL);
218                 }
219                 break;
220
221         case MII_TICK:
222                 /*
223                  * If we're not currently selected, just return.
224                  */
225                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
226                         return (0);
227
228                 /*
229                  * Is the interface even up?
230                  */
231                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
232                         return (0);
233
234                 /*
235                  * Only used for autonegotiation.
236                  */
237                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
238                         break;
239
240                 /*
241                  * Check to see if we have link.  If we do, we don't
242                  * need to restart the autonegotiation process.  Read
243                  * the BMSR twice in case it's latched.
244                  */
245                 reg = PHY_READ(sc, XMPHY_MII_BMSR) |
246                     PHY_READ(sc, XMPHY_MII_BMSR);
247                 if (reg & XMPHY_BMSR_LINK)
248                         break;
249
250                 /*
251                  * Only retry autonegotiation every mii_anegticks seconds.
252                  */
253                 if (++sc->mii_ticks <= sc->mii_anegticks)
254                         return (0);
255                 
256                 sc->mii_ticks = 0;
257
258                 mii_phy_reset(sc);
259                 if (xmphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
260                         return(0);
261                 break;
262         }
263
264         /* Update the media status. */
265         xmphy_status(sc);
266
267         /* Callback if something changed. */
268         mii_phy_update(sc, cmd);
269         return (0);
270 }
271
272 void
273 xmphy_status(struct mii_softc *sc)
274 {
275         struct mii_data *mii = sc->mii_pdata;
276         int bmsr, bmcr, anlpar;
277
278         mii->mii_media_status = IFM_AVALID;
279         mii->mii_media_active = IFM_ETHER;
280
281         bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
282             PHY_READ(sc, XMPHY_MII_BMSR);
283         if (bmsr & XMPHY_BMSR_LINK)
284                 mii->mii_media_status |= IFM_ACTIVE;
285
286         /* Do dummy read of extended status register. */
287         bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
288
289         bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
290
291         if (bmcr & XMPHY_BMCR_LOOP)
292                 mii->mii_media_active |= IFM_LOOP;
293
294         if (bmcr & XMPHY_BMCR_AUTOEN) {
295                 if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
296                         if (bmsr & XMPHY_BMSR_LINK) {
297                                 mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
298                                 return;
299                         }
300                         /* Erg, still trying, I guess... */
301                         mii->mii_media_active |= IFM_NONE;
302                         return;
303                 }
304
305                 mii->mii_media_active |= IFM_1000_SX;
306                 anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
307                     PHY_READ(sc, XMPHY_MII_ANLPAR);
308                 if (anlpar & XMPHY_ANLPAR_FDX)
309                         mii->mii_media_active |= IFM_FDX;
310                 else
311                         mii->mii_media_active |= IFM_HDX;
312                 return;
313         }
314
315         mii->mii_media_active |= IFM_1000_SX;
316         if (bmcr & XMPHY_BMCR_FDX)
317                 mii->mii_media_active |= IFM_FDX;
318         else
319                 mii->mii_media_active |= IFM_HDX;
320 }
321
322 static int
323 xmphy_mii_phy_auto(struct mii_softc *sc, int waitfor)
324 {
325         int bmsr, anar = 0, i;
326
327         if ((sc->mii_flags & MIIF_DOINGAUTO) == 0) {
328                 anar = PHY_READ(sc, XMPHY_MII_ANAR);
329                 anar |= XMPHY_ANAR_FDX | XMPHY_ANAR_HDX;
330                 PHY_WRITE(sc, XMPHY_MII_ANAR, anar);
331                 DELAY(1000);
332                 PHY_WRITE(sc, XMPHY_MII_BMCR,
333                     XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
334         }
335
336         if (waitfor) {
337                 /* Wait 500ms for it to complete. */
338                 for (i = 0; i < 500; i++) {
339                         bmsr = PHY_READ(sc, XMPHY_MII_BMSR);
340                         if (bmsr & XMPHY_BMSR_ACOMP)
341                                 return (0);
342                         DELAY(1000);
343                 }
344
345                 /*
346                  * Don't need to worry about clearing MIIF_DOINGAUTO.
347                  * If that's set, a timeout is pending, and it will
348                  * clear the flag.
349                  */
350                 return (EIO);
351         }
352
353         /*
354          * Just let it finish asynchronously.  This is for the benefit of
355          * the tick handler driving autonegotiation.  Don't want 500ms
356          * delays all the time while the system is running!
357          */
358         if ((sc->mii_flags & MIIF_DOINGAUTO) == 0) {
359                 sc->mii_flags |= MIIF_DOINGAUTO;
360                 callout_reset(&sc->mii_auto_ch, hz >> 1, 
361                               mii_phy_auto_timeout, sc);
362         }
363         return (EJUSTRETURN);
364 }