Remove some duplicate FreeBSD CVS IDs, move some IDs to better places.
[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.6 2005/02/21 18:40:36 joerg 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 static int xmphy_detach         (device_t);
64
65 static device_method_t xmphy_methods[] = {
66         /* device interface */
67         DEVMETHOD(device_probe,         xmphy_probe),
68         DEVMETHOD(device_attach,        xmphy_attach),
69         DEVMETHOD(device_detach,        xmphy_detach),
70         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
71         { 0, 0 }
72 };
73
74 static devclass_t xmphy_devclass;
75
76 static driver_t xmphy_driver = {
77         "xmphy",
78         xmphy_methods,
79         sizeof(struct mii_softc)
80 };
81
82 DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
83
84 int     xmphy_service (struct mii_softc *, struct mii_data *, int);
85 void    xmphy_status (struct mii_softc *);
86
87 static int      xmphy_mii_phy_auto (struct mii_softc *, int);
88 extern void     mii_phy_auto_timeout (void *);
89
90 static int xmphy_probe(dev)
91         device_t                dev;
92 {
93         struct mii_attach_args *ma;
94
95         ma = device_get_ivars(dev);
96
97         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxXAQTI &&
98             MII_MODEL(ma->mii_id2) == MII_MODEL_XAQTI_XMACII) {
99                 device_set_desc(dev, MII_STR_XAQTI_XMACII);
100                 return(0);
101         }
102
103         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_JATO &&
104             MII_MODEL(ma->mii_id2) == MII_MODEL_JATO_BASEX) {
105                 device_set_desc(dev, MII_STR_JATO_BASEX);
106                 return(0);
107         }
108
109         return(ENXIO);
110 }
111
112 static int xmphy_attach(dev)
113         device_t                dev;
114 {
115         struct mii_softc *sc;
116         struct mii_attach_args *ma;
117         struct mii_data *mii;
118         const char *sep = "";
119
120         sc = device_get_softc(dev);
121         ma = device_get_ivars(dev);
122         mii_softc_init(sc);
123         sc->mii_dev = device_get_parent(dev);
124         mii = device_get_softc(sc->mii_dev);
125         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
126
127         sc->mii_inst = mii->mii_instance;
128         sc->mii_phy = ma->mii_phyno;
129         sc->mii_service = xmphy_service;
130         sc->mii_pdata = mii;
131
132         sc->mii_flags |= MIIF_NOISOLATE;
133         mii->mii_instance++;
134
135 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
136 #define PRINT(s)        printf("%s%s", sep, s); sep = ", "
137
138         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
139             BMCR_ISO);
140 #if 0
141         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
142             BMCR_LOOP|BMCR_S100);
143 #endif
144
145         mii_phy_reset(sc);
146
147         device_printf(dev, " ");
148         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
149             XMPHY_BMCR_FDX);
150         PRINT("1000baseSX");
151         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
152         PRINT("1000baseSX-FDX");
153         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
154         PRINT("auto");
155
156         printf("\n");
157 #undef ADD
158 #undef PRINT
159
160         MIIBUS_MEDIAINIT(sc->mii_dev);
161         return(0);
162 }
163
164 static int xmphy_detach(dev)
165         device_t                dev;
166 {
167         struct mii_softc *sc;
168         struct mii_data *mii;
169
170         sc = device_get_softc(dev);
171         mii = device_get_softc(device_get_parent(dev));
172         if (sc->mii_flags & MIIF_DOINGAUTO)
173                 callout_stop(&sc->mii_auto_ch);
174         sc->mii_dev = NULL;
175         LIST_REMOVE(sc, mii_list);
176
177         return(0);
178 }
179 int
180 xmphy_service(sc, mii, cmd)
181         struct mii_softc *sc;
182         struct mii_data *mii;
183         int cmd;
184 {
185         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
186         int reg;
187
188         switch (cmd) {
189         case MII_POLLSTAT:
190                 /*
191                  * If we're not polling our PHY instance, just return.
192                  */
193                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
194                         return (0);
195                 break;
196
197         case MII_MEDIACHG:
198                 /*
199                  * If the media indicates a different PHY instance,
200                  * isolate ourselves.
201                  */
202                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
203                         reg = PHY_READ(sc, MII_BMCR);
204                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
205                         return (0);
206                 }
207
208                 /*
209                  * If the interface is not up, don't do anything.
210                  */
211                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
212                         break;
213
214                 switch (IFM_SUBTYPE(ife->ifm_media)) {
215                 case IFM_AUTO:
216 #ifdef foo
217                         /*
218                          * If we're already in auto mode, just return.
219                          */
220                         if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
221                                 return (0);
222 #endif
223                         (void) xmphy_mii_phy_auto(sc, 1);
224                         break;
225                 case IFM_1000_SX:
226                         mii_phy_reset(sc);
227                         if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
228                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
229                                 PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
230                         } else {
231                                 PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
232                                 PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
233                         }
234                         break;
235                 case IFM_100_T4:
236                 case IFM_100_TX:
237                 case IFM_10_T:
238                 default:
239                         return (EINVAL);
240                 }
241                 break;
242
243         case MII_TICK:
244                 /*
245                  * If we're not currently selected, just return.
246                  */
247                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
248                         return (0);
249
250                 /*
251                  * Only used for autonegotiation.
252                  */
253                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
254                         return (0);
255
256                 /*
257                  * Is the interface even up?
258                  */
259                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
260                         return (0);
261
262                 /*
263                  * Only retry autonegotiation every 5 seconds.
264                  */
265                 if (++sc->mii_ticks != 5)
266                         return (0);
267                 
268                 sc->mii_ticks = 0;
269
270                 /*
271                  * Check to see if we have link.  If we do, we don't
272                  * need to restart the autonegotiation process.  Read
273                  * the BMSR twice in case it's latched.
274                  */
275                 reg = PHY_READ(sc, XMPHY_MII_BMSR) |
276                     PHY_READ(sc, XMPHY_MII_BMSR);
277                 if (reg & XMPHY_BMSR_LINK)
278                         break;
279
280                 mii_phy_reset(sc);
281                 if (xmphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
282                         return(0);
283                 break;
284         }
285
286         /* Update the media status. */
287         xmphy_status(sc);
288
289         /* Callback if something changed. */
290         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
291                 MIIBUS_STATCHG(sc->mii_dev);
292                 sc->mii_active = mii->mii_media_active;
293         }
294         return (0);
295 }
296
297 void
298 xmphy_status(sc)
299         struct mii_softc *sc;
300 {
301         struct mii_data *mii = sc->mii_pdata;
302         int bmsr, bmcr, anlpar;
303
304         mii->mii_media_status = IFM_AVALID;
305         mii->mii_media_active = IFM_ETHER;
306
307         bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
308             PHY_READ(sc, XMPHY_MII_BMSR);
309         if (bmsr & XMPHY_BMSR_LINK)
310                 mii->mii_media_status |= IFM_ACTIVE;
311
312         /* Do dummy read of extended status register. */
313         bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
314
315         bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
316
317         if (bmcr & XMPHY_BMCR_LOOP)
318                 mii->mii_media_active |= IFM_LOOP;
319
320
321         if (bmcr & XMPHY_BMCR_AUTOEN) {
322                 if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
323                         if (bmsr & XMPHY_BMSR_LINK) {
324                                 mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
325                                 return;
326                         }
327                         /* Erg, still trying, I guess... */
328                         mii->mii_media_active |= IFM_NONE;
329                         return;
330                 }
331
332                 mii->mii_media_active |= IFM_1000_SX;
333                 anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
334                     PHY_READ(sc, XMPHY_MII_ANLPAR);
335                 if (anlpar & XMPHY_ANLPAR_FDX)
336                         mii->mii_media_active |= IFM_FDX;
337                 else
338                         mii->mii_media_active |= IFM_HDX;
339                 return;
340         }
341
342         mii->mii_media_active |= IFM_1000_SX;
343         if (bmcr & XMPHY_BMCR_FDX)
344                 mii->mii_media_active |= IFM_FDX;
345         else
346                 mii->mii_media_active |= IFM_HDX;
347
348         return;
349 }
350
351
352 static int
353 xmphy_mii_phy_auto(mii, waitfor)
354         struct mii_softc *mii;
355         int waitfor;
356 {
357         int bmsr, anar = 0, i;
358
359         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
360                 anar = PHY_READ(mii, XMPHY_MII_ANAR);
361                 anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
362                 PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
363                 DELAY(1000);
364                 PHY_WRITE(mii, XMPHY_MII_BMCR,
365                     XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
366         }
367
368         if (waitfor) {
369                 /* Wait 500ms for it to complete. */
370                 for (i = 0; i < 500; i++) {
371                         if ((bmsr = PHY_READ(mii, XMPHY_MII_BMSR)) &
372                             XMPHY_BMSR_ACOMP)
373                                 return (0);
374                         DELAY(1000);
375 #if 0
376                 if ((bmsr & BMSR_ACOMP) == 0)
377                         printf("%s: autonegotiation failed to complete\n",
378                             mii->mii_dev.dv_xname);
379 #endif
380                 }
381
382                 /*
383                  * Don't need to worry about clearing MIIF_DOINGAUTO.
384                  * If that's set, a timeout is pending, and it will
385                  * clear the flag.
386                  */
387                 return (EIO);
388         }
389
390         /*
391          * Just let it finish asynchronously.  This is for the benefit of
392          * the tick handler driving autonegotiation.  Don't want 500ms
393          * delays all the time while the system is running!
394          */
395         if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
396                 mii->mii_flags |= MIIF_DOINGAUTO;
397                 callout_reset(&mii->mii_auto_ch, hz >> 1, 
398                                 mii_phy_auto_timeout, mii);
399         }
400         return (EJUSTRETURN);
401 }