kernel: Use NULL for DRIVER_MODULE()'s evh & arg (which are pointers).
[dragonfly.git] / sys / dev / netif / mii_layer / e1000phy.c
1 /* $FreeBSD: src/sys/dev/mii/e1000phy.c,v 1.18 2006/12/11 11:09:48 yongari Exp $ */
2 /*      $OpenBSD: eephy.c,v 1.26 2006/06/08 00:27:12 brad Exp $ */
3 /*
4  * Principal Author: Parag Patel
5  * Copyright (c) 2001
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * Additonal Copyright (c) 2001 by Traakan Software under same licence.
31  * Secondary Author: Matthew Jacob
32  */
33
34 /*
35  * driver for the Marvell 88E1000 series external 1000/100/10-BT PHY.
36  */
37
38 /*
39  * Support added for the Marvell 88E1011 (Alaska) 1000/100/10baseT and
40  * 1000baseSX PHY.
41  * Nathan Binkert <nate@openbsd.org>
42  * Jung-uk Kim <jkim@niksun.com>
43  */
44
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
48 #include <sys/socket.h>
49 #include <sys/bus.h>
50
51 #include <net/if.h>
52 #include <net/if_media.h>
53
54 #include "mii.h"
55 #include "miivar.h"
56 #include "miidevs.h"
57
58 #include "e1000phyreg.h"
59
60 #include "miibus_if.h"
61
62 static int      e1000phy_probe(device_t);
63 static int      e1000phy_attach(device_t);
64 static int      e1000phy_service(struct mii_softc *, struct mii_data *, int);
65 static void     e1000phy_status(struct mii_softc *);
66 static void     e1000phy_mii_phy_auto(struct mii_softc *);
67 static void     e1000phy_reset(struct mii_softc *);
68
69 static device_method_t e1000phy_methods[] = {
70         /* device interface */
71         DEVMETHOD(device_probe,         e1000phy_probe),
72         DEVMETHOD(device_attach,        e1000phy_attach),
73         DEVMETHOD(device_detach,        ukphy_detach),
74         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
75         { 0, 0 }
76 };
77
78 static const struct mii_phydesc e1000phys[] = {
79         MII_PHYDESC(xxMARVELL,  E1000_2),
80         MII_PHYDESC(xxMARVELL,  E1000_3),
81         MII_PHYDESC(xxMARVELL,  E1000_5),
82         MII_PHYDESC(xxMARVELL,  E1111),
83         MII_PHYDESC(MARVELL,    E1000),
84         MII_PHYDESC(MARVELL,    E1011),
85         MII_PHYDESC(MARVELL,    E1000_3),
86         MII_PHYDESC(MARVELL,    E1000_4),
87         MII_PHYDESC(MARVELL,    E1000_5),
88         MII_PHYDESC(MARVELL,    E1000_6),
89         MII_PHYDESC(MARVELL,    E3082),
90         MII_PHYDESC(MARVELL,    E1112),
91         MII_PHYDESC(MARVELL,    E1149),
92         MII_PHYDESC(MARVELL,    E1111),
93         MII_PHYDESC(MARVELL,    E1116),
94         MII_PHYDESC(MARVELL,    E1118),
95         MII_PHYDESC_NULL
96 };
97
98 static devclass_t e1000phy_devclass;
99
100 static driver_t e1000phy_driver = {
101         "e1000phy",
102         e1000phy_methods,
103         sizeof(struct mii_softc)
104 };
105 DRIVER_MODULE(e1000phy, miibus, e1000phy_driver, e1000phy_devclass, NULL, NULL);
106
107 static int
108 e1000phy_probe(device_t dev)
109 {
110         struct mii_attach_args *ma = device_get_ivars(dev);
111         const struct mii_phydesc *mpd;
112
113         mpd = mii_phy_match(ma, e1000phys);
114         if (mpd != NULL) {
115                 device_set_desc(dev, mpd->mpd_name);
116                 return 0;
117         }
118         return (ENXIO);
119 }
120
121 static int
122 e1000phy_attach(device_t dev)
123 {
124         struct mii_softc *sc;
125         struct mii_attach_args *ma;
126         struct mii_data *mii;
127         const char *sep = "";
128         int fast_ether = 0;
129
130         sc = device_get_softc(dev);
131         ma = device_get_ivars(dev);
132         mii_softc_init(sc, ma);
133         sc->mii_dev = device_get_parent(dev);
134         mii = device_get_softc(sc->mii_dev);
135         LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
136
137         sc->mii_inst = mii->mii_instance;
138         sc->mii_service = e1000phy_service;
139         sc->mii_reset = e1000phy_reset;
140         sc->mii_anegticks = MII_ANEGTICKS_GIGE;
141         sc->mii_pdata = mii;
142
143         sc->mii_flags |= MIIF_NOISOLATE;
144
145         switch (sc->mii_model) {
146         case MII_MODEL_MARVELL_E1011:
147         case MII_MODEL_MARVELL_E1112:
148                 if (PHY_READ(sc, E1000_ESSR) & E1000_ESSR_FIBER_LINK)
149                         sc->mii_flags |= MIIF_HAVEFIBER;
150                 break;
151         case MII_MODEL_MARVELL_E3082:
152                 /* 88E3082 10/100 Fast Ethernet PHY. */
153                 sc->mii_anegticks = MII_ANEGTICKS;
154                 fast_ether = 1;
155                 break;
156         }
157
158         mii->mii_instance++;
159
160         e1000phy_reset(sc);
161
162 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
163 #define PRINT(s)        kprintf("%s%s", sep, s); sep = ", "
164
165         device_printf(dev, "%s", "");
166
167         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
168             E1000_CR_ISOLATE);
169         if ((sc->mii_flags & MIIF_HAVEFIBER) == 0) {
170                 if (!fast_ether) {
171                         /*
172                          * 1000T-simplex not supported; driver must ignore
173                          * this entry, but it must be present in order to
174                          * manually set full-duplex.
175                          */
176                         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, 0,
177                             sc->mii_inst), E1000_CR_SPEED_1000);
178                         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, IFM_FDX,
179                             sc->mii_inst),
180                             E1000_CR_SPEED_1000 | E1000_CR_FULL_DUPLEX);
181                         PRINT("1000baseT-FDX");
182                 }
183                 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_FDX, sc->mii_inst),
184                     E1000_CR_SPEED_100 | E1000_CR_FULL_DUPLEX);
185                 PRINT("100baseTX-FDX");
186                 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, 0, sc->mii_inst),
187                     E1000_CR_SPEED_100);
188                 PRINT("100baseTX");
189                 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_FDX, sc->mii_inst),
190                     E1000_CR_SPEED_10 | E1000_CR_FULL_DUPLEX);
191                 PRINT("10baseTX-FDX");
192                 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, 0, sc->mii_inst),
193                     E1000_CR_SPEED_10);
194                 PRINT("10baseTX");
195         } else {
196                 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst),
197                     E1000_CR_SPEED_1000 | E1000_CR_FULL_DUPLEX);
198                 PRINT("1000baseSX-FDX");
199         }
200
201         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
202         PRINT("auto\n");
203
204 #undef ADD
205 #undef PRINT
206
207         MIIBUS_MEDIAINIT(sc->mii_dev);
208         return(0);
209 }
210
211 static void
212 e1000phy_reset(struct mii_softc *sc)
213 {
214         uint16_t reg;
215
216         reg = PHY_READ(sc, E1000_SCR);
217         if ((sc->mii_flags & MIIF_HAVEFIBER) != 0) {
218                 reg &= ~E1000_SCR_AUTO_X_MODE;
219                 PHY_WRITE(sc, E1000_SCR, reg);
220                 if (sc->mii_model == MII_MODEL_MARVELL_E1112) {
221                         /* Select 1000BASE-X only mode. */
222                         PHY_WRITE(sc, E1000_EADR, 2);
223                         reg = PHY_READ(sc, E1000_SCR);
224                         reg &= ~E1000_SCR_MODE_MASK;
225                         reg |= E1000_SCR_MODE_1000BX;
226                         PHY_WRITE(sc, E1000_SCR, reg);
227                         PHY_WRITE(sc, E1000_EADR, 1);
228                 }
229         } else {
230                 switch (sc->mii_model) {
231                 case MII_MODEL_MARVELL_E1111:
232                 case MII_MODEL_MARVELL_E1112:
233                 case MII_MODEL_MARVELL_E1116:
234                 case MII_MODEL_MARVELL_E1118:
235                 case MII_MODEL_MARVELL_E1149:
236                         /* Disable energy detect mode. */
237                         reg &= ~E1000_SCR_EN_DETECT_MASK;
238                         reg |= E1000_SCR_AUTO_X_MODE;
239                         break;
240                 case MII_MODEL_MARVELL_E3082:
241                         reg |= (E1000_SCR_AUTO_X_MODE >> 1);
242                         break;
243                 default:
244                         reg &= ~E1000_SCR_AUTO_X_MODE;
245                         break;
246                 }
247                 /* Enable CRS on TX. */
248                 reg |= E1000_SCR_ASSERT_CRS_ON_TX;
249                 /* Auto correction for reversed cable polarity. */
250                 reg &= ~E1000_SCR_POLARITY_REVERSAL;
251                 PHY_WRITE(sc, E1000_SCR, reg);
252         }
253
254         switch (MII_MODEL(sc->mii_model)) {
255         case MII_MODEL_MARVELL_E3082:
256         case MII_MODEL_MARVELL_E1112:
257         case MII_MODEL_MARVELL_E1116:
258         case MII_MODEL_MARVELL_E1118:
259         case MII_MODEL_MARVELL_E1149:
260                 break;
261         default:
262                 /* Force TX_CLK to 25MHz clock. */
263                 reg = PHY_READ(sc, E1000_ESCR);
264                 reg |= E1000_ESCR_TX_CLK_25;
265                 PHY_WRITE(sc, E1000_ESCR, reg);
266                 break;
267         }
268
269         /* Reset the PHY so all changes take effect. */
270         reg = PHY_READ(sc, E1000_CR);
271         reg |= E1000_CR_RESET;
272         PHY_WRITE(sc, E1000_CR, reg);
273 }
274
275 static int
276 e1000phy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
277 {
278         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
279         uint16_t speed, gig;
280         int reg;
281
282         switch (cmd) {
283         case MII_POLLSTAT:
284                 /*
285                  * If we're not polling our PHY instance, just return.
286                  */
287                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
288                         return (0);
289                 break;
290
291         case MII_MEDIACHG:
292                 /*
293                  * If the media indicates a different PHY instance,
294                  * isolate ourselves.
295                  */
296                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
297                         reg = PHY_READ(sc, E1000_CR);
298                         PHY_WRITE(sc, E1000_CR, reg | E1000_CR_ISOLATE);
299                         return (0);
300                 }
301
302                 /*
303                  * If the interface is not up, don't do anything.
304                  */
305                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
306                         break;
307
308                 if (IFM_SUBTYPE(ife->ifm_media) == IFM_AUTO) {
309                         e1000phy_mii_phy_auto(sc);
310                         break;
311                 }
312
313                 speed = 0;
314                 switch (IFM_SUBTYPE(ife->ifm_media)) {
315                 case IFM_1000_T:
316                         if (sc->mii_model == MII_MODEL_MARVELL_E3082)
317                                 return (EINVAL);
318                         speed = E1000_CR_SPEED_1000;
319                         break;
320                 case IFM_1000_SX:
321                         if (sc->mii_model == MII_MODEL_MARVELL_E3082)
322                                 return (EINVAL);
323                         speed = E1000_CR_SPEED_1000;
324                         break;
325                 case IFM_100_TX:
326                         speed = E1000_CR_SPEED_100;
327                         break;
328                 case IFM_10_T:
329                         speed = E1000_CR_SPEED_10;
330                         break;
331                 case IFM_NONE:
332                         reg = PHY_READ(sc, E1000_CR);
333                         PHY_WRITE(sc, E1000_CR,
334                             reg | E1000_CR_ISOLATE | E1000_CR_POWER_DOWN);
335                         goto done;
336                 default:
337                         return (EINVAL);
338                 }
339
340                 if (((ife->ifm_media & IFM_GMASK) & IFM_FDX) != 0) {
341                         speed |= E1000_CR_FULL_DUPLEX;
342                         gig = E1000_1GCR_1000T_FD;
343                 } else {
344                         gig = E1000_1GCR_1000T;
345                 }
346
347                 reg = PHY_READ(sc, E1000_CR);
348                 reg &= ~E1000_CR_AUTO_NEG_ENABLE;
349                 PHY_WRITE(sc, E1000_CR, reg | E1000_CR_RESET);
350
351                 /*
352                  * When setting the link manually, one side must
353                  * be the master and the other the slave. However
354                  * ifmedia doesn't give us a good way to specify
355                  * this, so we fake it by using one of the LINK
356                  * flags. If LINK0 is set, we program the PHY to
357                  * be a master, otherwise it's a slave.
358                  */
359                 if (IFM_SUBTYPE(ife->ifm_media) == IFM_1000_T ||
360                     IFM_SUBTYPE(ife->ifm_media) == IFM_1000_SX) {
361                         if (mii->mii_ifp->if_flags & IFF_LINK0) {
362                                 PHY_WRITE(sc, E1000_1GCR, gig |
363                                     E1000_1GCR_MS_ENABLE | E1000_1GCR_MS_VALUE);
364                         } else {
365                                 PHY_WRITE(sc, E1000_1GCR, gig |
366                                     E1000_1GCR_MS_ENABLE);
367                         }
368                 } else {
369                         if (sc->mii_model != MII_MODEL_MARVELL_E3082)
370                                 PHY_WRITE(sc, E1000_1GCR, 0);
371                 }
372                 PHY_WRITE(sc, E1000_AR, E1000_AR_SELECTOR_FIELD);
373                 PHY_WRITE(sc, E1000_CR, speed | E1000_CR_RESET);
374 done:
375                 break;
376
377         case MII_TICK:
378                 /*
379                  * If we're not currently selected, just return.
380                  */
381                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
382                         return (0);
383
384                 /*
385                  * Is the interface even up?
386                  */
387                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
388                         return (0);
389
390                 /*
391                  * Only used for autonegotiation.
392                  */
393                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
394                         break;
395
396                 /*
397                  * Check to see if we have link.  If we do, we don't
398                  * need to restart the autonegotiation process.  Read
399                  * the BMSR twice in case it's latched.
400                  */
401                 reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
402                 if (reg & BMSR_LINK) {
403                         sc->mii_ticks = 0;
404                         break;
405                 }
406
407                 /*
408                  * Only retry autonegotiation every mii_anegticks seconds.
409                  */
410                 if (++sc->mii_ticks <= sc->mii_anegticks)
411                         return (0);
412                 sc->mii_ticks = 0;
413
414                 e1000phy_reset(sc);
415                 e1000phy_mii_phy_auto(sc);
416                 break;
417         }
418
419         /* Update the media status. */
420         e1000phy_status(sc);
421
422         /* Callback if something changed. */
423         mii_phy_update(sc, cmd);
424         return (0);
425 }
426
427 static void
428 e1000phy_status(struct mii_softc *sc)
429 {
430         struct mii_data *mii = sc->mii_pdata;
431         int bmsr, bmcr, esr, gsr, ssr, isr, ar, lpar;
432
433         mii->mii_media_status = IFM_AVALID;
434         mii->mii_media_active = IFM_ETHER;
435
436         bmsr = PHY_READ(sc, E1000_SR) | PHY_READ(sc, E1000_SR);
437         esr = PHY_READ(sc, E1000_ESR);
438         bmcr = PHY_READ(sc, E1000_CR);
439         ssr = PHY_READ(sc, E1000_SSR);
440         isr = PHY_READ(sc, E1000_ISR);
441         ar = PHY_READ(sc, E1000_AR);
442         lpar = PHY_READ(sc, E1000_LPAR);
443
444         if (bmsr & E1000_SR_LINK_STATUS)
445                 mii->mii_media_status |= IFM_ACTIVE;
446
447         if (bmcr & E1000_CR_LOOPBACK)
448                 mii->mii_media_active |= IFM_LOOP;
449
450         if (((bmcr & E1000_CR_AUTO_NEG_ENABLE) != 0 &&
451              (bmsr & E1000_SR_AUTO_NEG_COMPLETE) == 0) ||
452             (ssr & E1000_SSR_LINK) == 0 ||
453             (ssr & E1000_SSR_SPD_DPLX_RESOLVED) == 0) {
454                 /* Erg, still trying, I guess... */
455                 mii->mii_media_active |= IFM_NONE;
456                 return;
457         }
458
459         if ((sc->mii_flags & MIIF_HAVEFIBER) == 0) {
460                 if (ssr & E1000_SSR_1000MBS)
461                         mii->mii_media_active |= IFM_1000_T;
462                 else if (ssr & E1000_SSR_100MBS)
463                         mii->mii_media_active |= IFM_100_TX;
464                 else
465                         mii->mii_media_active |= IFM_10_T;
466         } else {
467                 if (ssr & E1000_SSR_1000MBS)
468                         mii->mii_media_active |= IFM_1000_SX;
469         }
470
471         if (ssr & E1000_SSR_DUPLEX)
472                 mii->mii_media_active |= IFM_FDX;
473         else
474                 mii->mii_media_active |= IFM_HDX;
475
476         if ((sc->mii_flags & MIIF_HAVEFIBER) == 0) {
477                 /* FLAG0==rx-flow-control FLAG1==tx-flow-control */
478                 if ((ar & E1000_AR_PAUSE) && (lpar & E1000_LPAR_PAUSE)) {
479                         mii->mii_media_active |= IFM_FLAG0 | IFM_FLAG1;
480                 } else if (!(ar & E1000_AR_PAUSE) && (ar & E1000_AR_ASM_DIR) &&
481                     (lpar & E1000_LPAR_PAUSE) && (lpar & E1000_LPAR_ASM_DIR)) {
482                         mii->mii_media_active |= IFM_FLAG1;
483                 } else if ((ar & E1000_AR_PAUSE) && (ar & E1000_AR_ASM_DIR) &&
484                     !(lpar & E1000_LPAR_PAUSE) && (lpar & E1000_LPAR_ASM_DIR)) {
485                         mii->mii_media_active |= IFM_FLAG0;
486                 }
487         }
488
489         /* FLAG2 : local PHY resolved to MASTER */
490         if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T ||
491             IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_SX) {
492                 PHY_READ(sc, E1000_1GSR);
493                 gsr = PHY_READ(sc, E1000_1GSR);
494                 if ((gsr & E1000_1GSR_MS_CONFIG_RES) != 0)
495                         mii->mii_media_active |= IFM_FLAG2;
496         }
497 }
498
499 static void
500 e1000phy_mii_phy_auto(struct mii_softc *sc)
501 {
502         if ((sc->mii_flags & MIIF_HAVEFIBER) == 0) {
503                 PHY_WRITE(sc, E1000_AR, E1000_AR_10T | E1000_AR_10T_FD |
504                     E1000_AR_100TX | E1000_AR_100TX_FD |
505                     E1000_AR_PAUSE | E1000_AR_ASM_DIR);
506         } else {
507                 PHY_WRITE(sc, E1000_AR, E1000_FA_1000X_FD | E1000_FA_1000X |
508                     E1000_FA_SYM_PAUSE | E1000_FA_ASYM_PAUSE);
509         }
510         if (sc->mii_model != MII_MODEL_MARVELL_E3082) {
511                 PHY_WRITE(sc, E1000_1GCR,
512                     E1000_1GCR_1000T_FD | E1000_1GCR_1000T);
513         }
514         PHY_WRITE(sc, E1000_CR,
515             E1000_CR_AUTO_NEG_ENABLE | E1000_CR_RESTART_AUTO_NEG);
516 }