xref: /dragonfly/sys/dev/netif/mii_layer/mii.c (revision 1847e88f)
1 /*	$NetBSD: mii.c,v 1.12 1999/08/03 19:41:49 drochner Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998 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.
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/mii.c,v 1.6.2.2 2002/08/19 16:56:33 ambrisko Exp $
40  * $DragonFly: src/sys/dev/netif/mii_layer/mii.c,v 1.8 2005/12/11 01:54:08 swildner Exp $
41  */
42 
43 /*
44  * MII bus layer, glues MII-capable network interface drivers to sharable
45  * PHY drivers.  This exports an interface compatible with BSD/OS 3.0's,
46  * plus some NetBSD extensions.
47  */
48 
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/socket.h>
52 #include <sys/malloc.h>
53 #include <sys/kernel.h>
54 #include <sys/module.h>
55 #include <sys/bus.h>
56 
57 #include <net/if.h>
58 #include <net/if_media.h>
59 
60 #include "mii.h"
61 #include "miivar.h"
62 
63 #include "miibus_if.h"
64 
65 static int miibus_readreg	(device_t, int, int);
66 static int miibus_writereg	(device_t, int, int, int);
67 static void miibus_statchg	(device_t);
68 static void miibus_mediainit	(device_t);
69 
70 static device_method_t miibus_methods[] = {
71 	/* device interface */
72 	DEVMETHOD(device_probe,		miibus_probe),
73 	DEVMETHOD(device_attach,	miibus_attach),
74 	DEVMETHOD(device_detach,	miibus_detach),
75 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
76 
77 	/* bus interface */
78 	DEVMETHOD(bus_print_child,	bus_generic_print_child),
79 	DEVMETHOD(bus_driver_added,	bus_generic_driver_added),
80 
81 	/* MII interface */
82 	DEVMETHOD(miibus_readreg,	miibus_readreg),
83 	DEVMETHOD(miibus_writereg,	miibus_writereg),
84 	DEVMETHOD(miibus_statchg,	miibus_statchg),
85 	DEVMETHOD(miibus_mediainit,	miibus_mediainit),
86 
87 	{ 0, 0 }
88 };
89 
90 devclass_t miibus_devclass;
91 
92 driver_t miibus_driver = {
93 	"miibus",
94 	miibus_methods,
95 	sizeof(struct mii_data)
96 };
97 
98 /*
99  * Helper function used by network interface drivers, attaches PHYs
100  * to the network interface driver parent.
101  */
102 
103 int
104 miibus_probe(device_t dev)
105 {
106 	struct mii_attach_args	ma, *args;
107 	struct mii_data		*mii;
108 	device_t		child = NULL, parent;
109 	int			bmsr, capmask = 0xFFFFFFFF;
110 
111 	mii = device_get_softc(dev);
112 	parent = device_get_parent(dev);
113 	LIST_INIT(&mii->mii_phys);
114 	bzero(&ma, sizeof(ma));
115 
116 	for (ma.mii_phyno = 0; ma.mii_phyno < MII_NPHY; ma.mii_phyno++) {
117 		/*
118 		 * Check to see if there is a PHY at this address.  Note,
119 		 * many braindead PHYs report 0/0 in their ID registers,
120 		 * so we test for media in the BMSR.
121 	 	 */
122 		bmsr = MIIBUS_READREG(parent, ma.mii_phyno, MII_BMSR);
123 		if (bmsr == 0 || bmsr == 0xffff ||
124 		    (bmsr & BMSR_MEDIAMASK) == 0) {
125 			/* Assume no PHY at this address. */
126 			continue;
127 		}
128 
129 		/*
130 		 * Extract the IDs. Braindead PHYs will be handled by
131 		 * the `ukphy' driver, as we have no ID information to
132 		 * match on.
133 	 	 */
134 		ma.mii_id1 = MIIBUS_READREG(parent, ma.mii_phyno,
135 		    MII_PHYIDR1);
136 		ma.mii_id2 = MIIBUS_READREG(parent, ma.mii_phyno,
137 		    MII_PHYIDR2);
138 
139 		ma.mii_data = mii;
140 		ma.mii_capmask = capmask;
141 
142 		args = malloc(sizeof(struct mii_attach_args),
143 			      M_DEVBUF, M_INTWAIT);
144 		*args = ma;
145 		child = device_add_child(dev, NULL, -1);
146 		device_set_ivars(child, args);
147 	}
148 
149 	if (child == NULL)
150 		return(ENXIO);
151 
152 	device_set_desc(dev, "MII bus");
153 
154 	return(0);
155 }
156 
157 int
158 miibus_attach(device_t dev)
159 {
160 	void			**v;
161 	ifm_change_cb_t		ifmedia_upd;
162 	ifm_stat_cb_t		ifmedia_sts;
163 	struct mii_data		*mii;
164 
165 	mii = device_get_softc(dev);
166 	mii->mii_ifp = device_get_softc(device_get_parent(dev));
167 	v = device_get_ivars(dev);
168 	ifmedia_upd = v[0];
169 	ifmedia_sts = v[1];
170 	ifmedia_init(&mii->mii_media, IFM_IMASK, ifmedia_upd, ifmedia_sts);
171 	bus_generic_attach(dev);
172 
173 	return(0);
174 }
175 
176 int
177 miibus_detach(device_t dev)
178 {
179 	struct mii_data		*mii;
180 
181 	bus_generic_detach(dev);
182 	mii = device_get_softc(dev);
183 	ifmedia_removeall(&mii->mii_media);
184 	mii->mii_ifp = NULL;
185 
186 	return(0);
187 }
188 
189 static int
190 miibus_readreg(device_t dev, int phy, int reg)
191 {
192 	device_t		parent;
193 
194 	parent = device_get_parent(dev);
195 	return(MIIBUS_READREG(parent, phy, reg));
196 }
197 
198 static int
199 miibus_writereg(device_t dev, int phy, int reg, int data)
200 {
201 	device_t		parent;
202 
203 	parent = device_get_parent(dev);
204 	return(MIIBUS_WRITEREG(parent, phy, reg, data));
205 }
206 
207 static void
208 miibus_statchg(device_t dev)
209 {
210 	device_t		parent;
211 
212 	parent = device_get_parent(dev);
213 	MIIBUS_STATCHG(parent);
214 	return;
215 }
216 
217 static void
218 miibus_mediainit(device_t dev)
219 {
220 	struct mii_data		*mii;
221 	struct ifmedia_entry	*m;
222 	int			media = 0;
223 
224 	/* Poke the parent in case it has any media of its own to add. */
225 	MIIBUS_MEDIAINIT(device_get_parent(dev));
226 
227 	mii = device_get_softc(dev);
228 	for (m = LIST_FIRST(&mii->mii_media.ifm_list); m != NULL;
229 	     m = LIST_NEXT(m, ifm_list)) {
230 		media = m->ifm_media;
231 		if (media == (IFM_ETHER|IFM_AUTO))
232 			break;
233 	}
234 
235 	ifmedia_set(&mii->mii_media, media);
236 
237 	return;
238 }
239 
240 int
241 mii_phy_probe(device_t dev, device_t *child, ifm_change_cb_t ifmedia_upd,
242 	      ifm_stat_cb_t ifmedia_sts)
243 {
244 	void			**v;
245 	int			bmsr, i;
246 
247 	v = malloc(sizeof(vm_offset_t) * 2, M_DEVBUF, M_INTWAIT);
248 	v[0] = ifmedia_upd;
249 	v[1] = ifmedia_sts;
250 	*child = device_add_child(dev, "miibus", -1);
251 	device_set_ivars(*child, v);
252 
253 	for (i = 0; i < MII_NPHY; i++) {
254 		bmsr = MIIBUS_READREG(dev, i, MII_BMSR);
255                 if (bmsr == 0 || bmsr == 0xffff ||
256                     (bmsr & BMSR_MEDIAMASK) == 0) {
257                         /* Assume no PHY at this address. */
258                         continue;
259                 } else
260 			break;
261 	}
262 
263 	if (i == MII_NPHY) {
264 		device_delete_child(dev, *child);
265 		*child = NULL;
266 		return(ENXIO);
267 	}
268 
269 	bus_generic_attach(dev);
270 
271 	return(0);
272 }
273 
274 /*
275  * Media changed; notify all PHYs.
276  */
277 int
278 mii_mediachg(struct mii_data *mii)
279 {
280 	struct mii_softc *child;
281 	int rv;
282 
283 	mii->mii_media_status = 0;
284 	mii->mii_media_active = IFM_NONE;
285 
286 	for (child = LIST_FIRST(&mii->mii_phys); child != NULL;
287 	     child = LIST_NEXT(child, mii_list)) {
288 		rv = (*child->mii_service)(child, mii, MII_MEDIACHG);
289 		if (rv)
290 			return (rv);
291 	}
292 	return (0);
293 }
294 
295 /*
296  * Call the PHY tick routines, used during autonegotiation.
297  */
298 void
299 mii_tick(struct mii_data *mii)
300 {
301 	struct mii_softc *child;
302 
303 	for (child = LIST_FIRST(&mii->mii_phys); child != NULL;
304 	     child = LIST_NEXT(child, mii_list))
305 		(void) (*child->mii_service)(child, mii, MII_TICK);
306 }
307 
308 /*
309  * Get media status from PHYs.
310  */
311 void
312 mii_pollstat(struct mii_data *mii)
313 {
314 	struct mii_softc *child;
315 
316 	mii->mii_media_status = 0;
317 	mii->mii_media_active = IFM_NONE;
318 
319 	for (child = LIST_FIRST(&mii->mii_phys); child != NULL;
320 	     child = LIST_NEXT(child, mii_list))
321 		(void) (*child->mii_service)(child, mii, MII_POLLSTAT);
322 }
323 
324 static moduledata_t miibus_mod = { "miibus" };
325 
326 DECLARE_MODULE(miibus, miibus_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
327 
328