xref: /freebsd/sys/dev/mii/ukphy.c (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
1 /*	$NetBSD: ukphy.c,v 1.2 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 
40 /*
41  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by Manuel Bouyer.
54  * 4. The name of the author may not be used to endorse or promote products
55  *    derived from this software without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  */
68 
69 /*
70  * driver for generic unknown PHYs
71  */
72 
73 #include <sys/param.h>
74 #include <sys/systm.h>
75 #include <sys/kernel.h>
76 #include <sys/socket.h>
77 #include <sys/errno.h>
78 #include <sys/module.h>
79 #include <sys/bus.h>
80 
81 #include <net/if.h>
82 #include <net/if_media.h>
83 
84 #include <machine/clock.h>
85 
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 
89 #include "miibus_if.h"
90 
91 #if !defined(lint)
92 static const char rcsid[] =
93   "$FreeBSD$";
94 #endif
95 
96 static int ukphy_probe		__P((device_t));
97 static int ukphy_attach		__P((device_t));
98 static int ukphy_detach		__P((device_t));
99 
100 static device_method_t ukphy_methods[] = {
101 	/* device interface */
102 	DEVMETHOD(device_probe,		ukphy_probe),
103 	DEVMETHOD(device_attach,	ukphy_attach),
104 	DEVMETHOD(device_detach,	ukphy_detach),
105 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
106 	{ 0, 0 }
107 };
108 
109 static devclass_t ukphy_devclass;
110 
111 static driver_t ukphy_driver = {
112 	"ukphy",
113 	ukphy_methods,
114 	sizeof(struct mii_softc)
115 };
116 
117 DRIVER_MODULE(ukphy, miibus, ukphy_driver, ukphy_devclass, 0, 0);
118 
119 int	ukphy_service __P((struct mii_softc *, struct mii_data *, int));
120 
121 static int
122 ukphy_probe(dev)
123 	device_t		dev;
124 {
125 
126 	/*
127 	 * We know something is here, so always match at a low priority.
128 	 */
129 	device_set_desc(dev, "Generic IEEE 802.3u media interface");
130 	return (-100);
131 }
132 
133 static int
134 ukphy_attach(dev)
135 	device_t		dev;
136 {
137 	struct mii_softc *sc;
138 	struct mii_attach_args *ma;
139 	struct mii_data *mii;
140 
141 	sc = device_get_softc(dev);
142 	ma = device_get_ivars(dev);
143 	sc->mii_dev = device_get_parent(dev);
144 	mii = device_get_softc(sc->mii_dev);
145 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
146 
147 	if (bootverbose)
148 		device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
149 		    MII_OUI(ma->mii_id1, ma->mii_id2),
150 		    MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
151 
152 	sc->mii_inst = mii->mii_instance;
153 	sc->mii_phy = ma->mii_phyno;
154 	sc->mii_service = ukphy_service;
155 	sc->mii_pdata = mii;
156 
157 	mii->mii_instance++;
158 
159 	sc->mii_flags |= MIIF_NOISOLATE;
160 
161 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
162 
163 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
164 	    BMCR_ISO);
165 #if 0
166 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
167 	    BMCR_LOOP|BMCR_S100);
168 #endif
169 
170 	mii_phy_reset(sc);
171 
172 	sc->mii_capabilities =
173 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
174 	device_printf(dev, " ");
175 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
176 		printf("no media present");
177 	else
178 		mii_add_media(mii, sc->mii_capabilities,
179 		    sc->mii_inst);
180 	printf("\n");
181 #undef ADD
182 
183 	MIIBUS_MEDIAINIT(sc->mii_dev);
184 
185 	return(0);
186 }
187 
188 static int ukphy_detach(dev)
189 	device_t		dev;
190 {
191 	struct mii_softc *sc;
192 	struct mii_data *mii;
193 
194 	sc = device_get_softc(dev);
195 	mii = device_get_softc(device_get_parent(dev));
196 	sc->mii_dev = NULL;
197 	LIST_REMOVE(sc, mii_list);
198 
199 	return(0);
200 }
201 
202 int
203 ukphy_service(sc, mii, cmd)
204 	struct mii_softc *sc;
205 	struct mii_data *mii;
206 	int cmd;
207 {
208 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
209 	int reg;
210 
211 	switch (cmd) {
212 	case MII_POLLSTAT:
213 		/*
214 		 * If we're not polling our PHY instance, just return.
215 		 */
216 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
217 			return (0);
218 		break;
219 
220 	case MII_MEDIACHG:
221 		/*
222 		 * If the media indicates a different PHY instance,
223 		 * isolate ourselves.
224 		 */
225 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
226 			reg = PHY_READ(sc, MII_BMCR);
227 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
228 			return (0);
229 		}
230 
231 		/*
232 		 * If the interface is not up, don't do anything.
233 		 */
234 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
235 			break;
236 
237 		switch (IFM_SUBTYPE(ife->ifm_media)) {
238 		case IFM_AUTO:
239 			/*
240 			 * If we're already in auto mode, just return.
241 			 */
242 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
243 				return (0);
244 			(void) mii_phy_auto(sc, 1);
245 			break;
246 		case IFM_100_T4:
247 			/*
248 			 * XXX Not supported as a manual setting right now.
249 			 */
250 			return (EINVAL);
251 		default:
252 			/*
253 			 * BMCR data is stored in the ifmedia entry.
254 			 */
255 			PHY_WRITE(sc, MII_ANAR,
256 			    mii_anar(ife->ifm_media));
257 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
258 		}
259 		break;
260 
261 	case MII_TICK:
262 		/*
263 		 * If we're not currently selected, just return.
264 		 */
265 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
266 			return (0);
267 
268 		/*
269 		 * Only used for autonegotiation.
270 		 */
271 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
272 			return (0);
273 
274 		/*
275 		 * Is the interface even up?
276 		 */
277 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
278 			return (0);
279 
280 		/*
281 		 * Check to see if we have link.  If we do, we don't
282 		 * need to restart the autonegotiation process.  Read
283 		 * the BMSR twice in case it's latched.
284 		 */
285 		reg = PHY_READ(sc, MII_BMSR) |
286 		    PHY_READ(sc, MII_BMSR);
287 		if (reg & BMSR_LINK)
288 			return (0);
289 
290 		/*
291 		 * Only retry autonegotiation every 5 seconds.
292 		 */
293 		if (++sc->mii_ticks != 5)
294 			return (0);
295 
296 		sc->mii_ticks = 0;
297 		mii_phy_reset(sc);
298 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
299 			return (0);
300 		break;
301 	}
302 
303 	/* Update the media status. */
304 	ukphy_status(sc);
305 
306 	/* Callback if something changed. */
307 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
308 		MIIBUS_STATCHG(sc->mii_dev);
309 		sc->mii_active = mii->mii_media_active;
310 	}
311 	return (0);
312 }
313