xref: /dragonfly/sys/dev/netif/mii_layer/exphy.c (revision 71126e33)
1 /*	$NetBSD: exphy.c,v 1.16 1999/04/23 04:24:32 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center, and by Frank van der Linden.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  *
39  * $FreeBSD: src/sys/dev/mii/exphy.c,v 1.4.2.2 2002/11/08 21:53:49 semenu Exp $
40  * $DragonFly: src/sys/dev/netif/mii_layer/exphy.c,v 1.5 2004/09/18 19:32:59 dillon Exp $
41  */
42 
43 /*
44  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
45  *
46  * Redistribution and use in source and binary forms, with or without
47  * modification, are permitted provided that the following conditions
48  * are met:
49  * 1. Redistributions of source code must retain the above copyright
50  *    notice, this list of conditions and the following disclaimer.
51  * 2. Redistributions in binary form must reproduce the above copyright
52  *    notice, this list of conditions and the following disclaimer in the
53  *    documentation and/or other materials provided with the distribution.
54  * 3. All advertising materials mentioning features or use of this software
55  *    must display the following acknowledgement:
56  *	This product includes software developed by Manuel Bouyer.
57  * 4. The name of the author may not be used to endorse or promote products
58  *    derived from this software without specific prior written permission.
59  *
60  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
61  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
62  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
63  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
64  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
65  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
66  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
67  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
68  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
69  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
70  */
71 
72 /*
73  * driver for 3Com internal PHYs
74  */
75 
76 #include <sys/param.h>
77 #include <sys/systm.h>
78 #include <sys/kernel.h>
79 #include <sys/socket.h>
80 #include <sys/module.h>
81 #include <sys/bus.h>
82 
83 #include <net/if.h>
84 #include <net/if_media.h>
85 
86 #include "mii.h"
87 #include "miivar.h"
88 #include "miidevs.h"
89 
90 #include "miibus_if.h"
91 
92 static int exphy_probe		(device_t);
93 static int exphy_attach		(device_t);
94 static int exphy_detach		(device_t);
95 
96 static device_method_t exphy_methods[] = {
97 	/* device interface */
98 	DEVMETHOD(device_probe,		exphy_probe),
99 	DEVMETHOD(device_attach,	exphy_attach),
100 	DEVMETHOD(device_detach,	exphy_detach),
101 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
102 	{ 0, 0 }
103 };
104 
105 static devclass_t exphy_devclass;
106 
107 static driver_t exphy_driver = {
108 	"xlphy",
109 	exphy_methods,
110 	sizeof(struct mii_softc)
111 };
112 
113 DRIVER_MODULE(xlphy, miibus, exphy_driver, exphy_devclass, 0, 0);
114 
115 int	exphy_service (struct mii_softc *, struct mii_data *, int);
116 void	exphy_reset (struct mii_softc *);
117 
118 static int exphy_probe(dev)
119 	device_t		dev;
120 {
121 	struct mii_attach_args *ma;
122 	device_t		parent;
123 
124 	ma = device_get_ivars(dev);
125 	parent = device_get_parent(device_get_parent(dev));
126 
127 	/*
128 	 * Argh, 3Com PHY reports oui == 0 model == 0!
129 	 */
130 	if ((MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
131 	    MII_MODEL(ma->mii_id2) != 0) &&
132 	    (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_BROADCOM ||
133 	    MII_MODEL(ma->mii_id2) != MII_MODEL_BROADCOM_3c905Cphy))
134 		return (ENXIO);
135 
136 	/*
137 	 * Make sure the parent is an `ex'.
138 	 */
139 	if (strcmp(device_get_name(parent), "xl") != 0)
140 		return (ENXIO);
141 
142 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == 0)
143 		device_set_desc(dev, "3Com internal media interface");
144 	else
145 		device_set_desc(dev, MII_STR_BROADCOM_3c905Cphy);
146 
147 	return (0);
148 }
149 
150 static int exphy_attach(dev)
151 	device_t		dev;
152 {
153 	struct mii_softc *sc;
154 	struct mii_attach_args *ma;
155 	struct mii_data *mii;
156 
157 	sc = device_get_softc(dev);
158 	ma = device_get_ivars(dev);
159 	mii_softc_init(sc);
160 	sc->mii_dev = device_get_parent(dev);
161 	mii = device_get_softc(sc->mii_dev);
162 
163 	/*
164 	 * The 3Com PHY can never be isolated, so never allow non-zero
165 	 * instances!
166 	 */
167 	if (mii->mii_instance != 0) {
168 		device_printf(dev, "ignoring this PHY, non-zero instance\n");
169 		return(ENXIO);
170 	}
171 
172 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
173 
174 	sc->mii_inst = mii->mii_instance;
175 	sc->mii_phy = ma->mii_phyno;
176 	sc->mii_service = exphy_service;
177 	sc->mii_pdata = mii;
178 	mii->mii_instance++;
179 
180 	sc->mii_flags |= MIIF_NOISOLATE;
181 
182 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
183 
184 #if 0 /* See above. */
185 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
186 	    BMCR_ISO);
187 #endif
188 
189 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
190 	    BMCR_LOOP|BMCR_S100);
191 
192 	exphy_reset(sc);
193 
194 	sc->mii_capabilities =
195 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
196 	device_printf(dev, " ");
197 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
198 		printf("no media present");
199 	else
200 		mii_add_media(mii, sc->mii_capabilities,
201 		    sc->mii_inst);
202 	printf("\n");
203 #undef ADD
204 	MIIBUS_MEDIAINIT(sc->mii_dev);
205 	return(0);
206 }
207 
208 static int exphy_detach(dev)
209 	device_t		dev;
210 {
211 	struct mii_softc *sc;
212 	struct mii_data *mii;
213 
214 	sc = device_get_softc(dev);
215 	mii = device_get_softc(device_get_parent(dev));
216 	mii_phy_auto_stop(sc);
217 	sc->mii_dev = NULL;
218 	LIST_REMOVE(sc, mii_list);
219 
220 	return(0);
221 }
222 
223 int
224 exphy_service(sc, mii, cmd)
225 	struct mii_softc *sc;
226 	struct mii_data *mii;
227 	int cmd;
228 {
229 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
230 
231 	/*
232 	 * We can't isolate the 3Com PHY, so it has to be the only one!
233 	 */
234 	if (IFM_INST(ife->ifm_media) != sc->mii_inst)
235 		panic("exphy_service: can't isolate 3Com PHY");
236 
237 	switch (cmd) {
238 	case MII_POLLSTAT:
239 		break;
240 
241 	case MII_MEDIACHG:
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 			 * If we're already in auto mode, just return.
252 			 */
253 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
254 				return (0);
255 			(void) mii_phy_auto(sc, 1);
256 			break;
257 		case IFM_100_T4:
258 			/*
259 			 * XXX Not supported as a manual setting right now.
260 			 */
261 			return (EINVAL);
262 		default:
263 			/*
264 			 * BMCR data is stored in the ifmedia entry.
265 			 */
266 			PHY_WRITE(sc, MII_ANAR,
267 			    mii_anar(ife->ifm_media));
268 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
269 		}
270 		break;
271 
272 	case MII_TICK:
273 		/*
274 		 * Only used for autonegotiation.
275 		 */
276 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
277 			return (0);
278 
279 		/*
280 		 * Is the interface even up?
281 		 */
282 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
283 			return (0);
284 
285 		/*
286 		 * The 3Com PHY's autonegotiation doesn't need to be
287 		 * kicked; it continues in the background.
288 		 */
289 		break;
290 	}
291 
292 	/* Update the media status. */
293 	ukphy_status(sc);
294 
295 	/* Callback if something changed. */
296 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
297 		MIIBUS_STATCHG(sc->mii_dev);
298 		sc->mii_active = mii->mii_media_active;
299 	}
300 	return (0);
301 }
302 
303 void
304 exphy_reset(sc)
305 	struct mii_softc *sc;
306 {
307 
308 	mii_phy_reset(sc);
309 
310 	/*
311 	 * XXX 3Com PHY doesn't set the BMCR properly after
312 	 * XXX reset, which breaks autonegotiation.
313 	 */
314 	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_AUTOEN|BMCR_FDX);
315 }
316