Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / dev / netif / mii_layer / pnaphy.c
1 /*
2  * Copyright (c) 2000 Berkeley Software Design, Inc.
3  * Copyright (c) 1997, 1998, 1999, 2000
4  *      Bill Paul <wpaul@osd.bsdi.com>.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *      This product includes software developed by Bill Paul.
17  * 4. Neither the name of the author nor the names of any co-contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31  * THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * $FreeBSD: src/sys/dev/mii/pnaphy.c,v 1.1.2.3 2002/11/08 21:53:49 semenu Exp $
34  */
35
36 /*
37  * driver for homePNA PHYs
38  * This is really just a stub that allows us to identify homePNA-based
39  * transceicers and display the link status. MII-based homePNA PHYs
40  * only support one media type and no autonegotiation. If we were
41  * really clever, we could tweak some of the vendor-specific registers
42  * to optimize the link.
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/errno.h>
50 #include <sys/module.h>
51 #include <sys/bus.h>
52
53 #include <net/if.h>
54 #include <net/if_media.h>
55
56 #include <machine/clock.h>
57
58 #include <dev/mii/mii.h>
59 #include <dev/mii/miivar.h>
60 #include <dev/mii/miidevs.h>
61
62 #include "miibus_if.h"
63
64 #if !defined(lint)
65 static const char rcsid[] =
66   "$FreeBSD: src/sys/dev/mii/pnaphy.c,v 1.1.2.3 2002/11/08 21:53:49 semenu Exp $";
67 #endif
68
69 static int pnaphy_probe         __P((device_t));
70 static int pnaphy_attach        __P((device_t));
71 static int pnaphy_detach        __P((device_t));
72
73 static device_method_t pnaphy_methods[] = {
74         /* device interface */
75         DEVMETHOD(device_probe,         pnaphy_probe),
76         DEVMETHOD(device_attach,        pnaphy_attach),
77         DEVMETHOD(device_detach,        pnaphy_detach),
78         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
79         { 0, 0 }
80 };
81
82 static devclass_t pnaphy_devclass;
83
84 static driver_t pnaphy_driver = {
85         "pnaphy",
86         pnaphy_methods,
87         sizeof(struct mii_softc)
88 };
89
90 DRIVER_MODULE(pnaphy, miibus, pnaphy_driver, pnaphy_devclass, 0, 0);
91
92 int     pnaphy_service __P((struct mii_softc *, struct mii_data *, int));
93
94 static int
95 pnaphy_probe(dev)
96         device_t                dev;
97 {
98
99         struct mii_attach_args  *ma;
100
101         ma = device_get_ivars(dev);
102
103         if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_AMD &&
104             MII_MODEL(ma->mii_id2) == MII_MODEL_AMD_79c978) {
105                 device_set_desc(dev, MII_STR_AMD_79c978);
106                 return(0);
107         }
108
109         return(ENXIO);
110 }
111
112 static int
113 pnaphy_attach(dev)
114         device_t                dev;
115 {
116         struct mii_softc *sc;
117         struct mii_attach_args *ma;
118         struct mii_data *mii;
119         const char *sep = "";
120
121         sc = device_get_softc(dev);
122         ma = device_get_ivars(dev);
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 = pnaphy_service;
130         sc->mii_pdata = mii;
131
132         mii->mii_instance++;
133
134         sc->mii_flags |= MIIF_NOISOLATE;
135
136 #define ADD(m, c)       ifmedia_add(&mii->mii_media, (m), (c), NULL)
137 #define PRINT(s)        printf("%s%s", sep, s); sep = ", "
138
139         mii_phy_reset(sc);
140
141         sc->mii_capabilities =
142             PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
143         device_printf(dev, " ");
144         if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
145                 printf("no media present");
146         else {
147                 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_homePNA, 0, sc->mii_inst), 0);
148                 PRINT("HomePNA");
149         }
150         ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
151             BMCR_ISO);
152
153         printf("\n");
154
155 #undef ADD
156 #undef PRINT
157
158         MIIBUS_MEDIAINIT(sc->mii_dev);
159
160         return(0);
161 }
162
163 static int pnaphy_detach(dev)
164         device_t                dev;
165 {
166         struct mii_softc *sc;
167         struct mii_data *mii;
168
169         sc = device_get_softc(dev);
170         mii = device_get_softc(device_get_parent(dev));
171         mii_phy_auto_stop(sc);
172         sc->mii_dev = NULL;
173         LIST_REMOVE(sc, mii_list);
174
175         return(0);
176 }
177
178 int
179 pnaphy_service(sc, mii, cmd)
180         struct mii_softc *sc;
181         struct mii_data *mii;
182         int cmd;
183 {
184         struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
185         int reg;
186
187         switch (cmd) {
188         case MII_POLLSTAT:
189                 /*
190                  * If we're not polling our PHY instance, just return.
191                  */
192                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
193                         return (0);
194                 break;
195
196         case MII_MEDIACHG:
197                 /*
198                  * If the media indicates a different PHY instance,
199                  * isolate ourselves.
200                  */
201                 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
202                         reg = PHY_READ(sc, MII_BMCR);
203                         PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
204                         return (0);
205                 }
206
207                 /*
208                  * If the interface is not up, don't do anything.
209                  */
210                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
211                         break;
212
213                 switch (IFM_SUBTYPE(ife->ifm_media)) {
214                 case IFM_AUTO:
215                 case IFM_10_T:
216                 case IFM_100_TX:
217                 case IFM_100_T4:
218                         return (EINVAL);
219                 default:
220                         /*
221                          * BMCR data is stored in the ifmedia entry.
222                          */
223                         PHY_WRITE(sc, MII_ANAR,
224                             mii_anar(ife->ifm_media));
225                         PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
226                 }
227                 break;
228
229         case MII_TICK:
230                 /*
231                  * If we're not currently selected, just return.
232                  */
233                 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
234                         return (0);
235
236                 /*
237                  * Only used for autonegotiation.
238                  */
239                 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
240                         return (0);
241
242                 /*
243                  * Is the interface even up?
244                  */
245                 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
246                         return (0);
247
248                 /*
249                  * Check to see if we have link.  If we do, we don't
250                  * need to restart the autonegotiation process.  Read
251                  * the BMSR twice in case it's latched.
252                  */
253                 reg = PHY_READ(sc, MII_BMSR) |
254                     PHY_READ(sc, MII_BMSR);
255                 if (reg & BMSR_LINK)
256                         return (0);
257
258                 /*
259                  * Only retry autonegotiation every 5 seconds.
260                  */
261                 if (++sc->mii_ticks != 5)
262                         return (0);
263
264                 sc->mii_ticks = 0;
265                 mii_phy_reset(sc);
266                 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
267                         return (0);
268                 break;
269         }
270
271         /* Update the media status. */
272         ukphy_status(sc);
273         if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T)
274                 mii->mii_media_active = IFM_ETHER|IFM_homePNA;
275
276         /* Callback if something changed. */
277         if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
278                 MIIBUS_STATCHG(sc->mii_dev);
279                 sc->mii_active = mii->mii_media_active;
280         }
281         return (0);
282 }