xref: /freebsd/sys/dev/mii/ukphy.c (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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/malloc.h>
77 #include <sys/socket.h>
78 #include <sys/errno.h>
79 #include <sys/module.h>
80 #include <sys/bus.h>
81 
82 #include <net/if.h>
83 #include <net/if_media.h>
84 
85 #include <machine/clock.h>
86 
87 #include <dev/mii/mii.h>
88 #include <dev/mii/miivar.h>
89 
90 #include "miibus_if.h"
91 
92 #if !defined(lint)
93 static const char rcsid[] =
94   "$FreeBSD$";
95 #endif
96 
97 static int ukphy_probe		__P((device_t));
98 static int ukphy_attach		__P((device_t));
99 static int ukphy_detach		__P((device_t));
100 
101 static device_method_t ukphy_methods[] = {
102 	/* device interface */
103 	DEVMETHOD(device_probe,		ukphy_probe),
104 	DEVMETHOD(device_attach,	ukphy_attach),
105 	DEVMETHOD(device_detach,	ukphy_detach),
106 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
107 	{ 0, 0 }
108 };
109 
110 static devclass_t ukphy_devclass;
111 
112 static driver_t ukphy_driver = {
113 	"ukphy",
114 	ukphy_methods,
115 	sizeof(struct mii_softc)
116 };
117 
118 DRIVER_MODULE(ukphy, miibus, ukphy_driver, ukphy_devclass, 0, 0);
119 
120 int	ukphy_service __P((struct mii_softc *, struct mii_data *, int));
121 
122 static int
123 ukphy_probe(dev)
124 	device_t		dev;
125 {
126 
127 	/*
128 	 * We know something is here, so always match at a low priority.
129 	 */
130 	device_set_desc(dev, "Generic IEEE 802.3u media interface");
131 	return (-100);
132 }
133 
134 static int
135 ukphy_attach(dev)
136 	device_t		dev;
137 {
138 	struct mii_softc *sc;
139 	struct mii_attach_args *ma;
140 	struct mii_data *mii;
141 
142 	sc = device_get_softc(dev);
143 	ma = device_get_ivars(dev);
144 	sc->mii_dev = device_get_parent(dev);
145 	mii = device_get_softc(sc->mii_dev);
146 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
147 
148 	if (bootverbose)
149 		device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
150 		    MII_OUI(ma->mii_id1, ma->mii_id2),
151 		    MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
152 
153 	sc->mii_inst = mii->mii_instance;
154 	sc->mii_phy = ma->mii_phyno;
155 	sc->mii_service = ukphy_service;
156 	sc->mii_pdata = mii;
157 
158 	mii->mii_instance++;
159 
160 	sc->mii_flags |= MIIF_NOISOLATE;
161 
162 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
163 
164 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
165 	    BMCR_ISO);
166 #if 0
167 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
168 	    BMCR_LOOP|BMCR_S100);
169 #endif
170 
171 	mii_phy_reset(sc);
172 
173 	sc->mii_capabilities =
174 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
175 	device_printf(dev, " ");
176 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
177 		printf("no media present");
178 	else
179 		mii_add_media(mii, sc->mii_capabilities,
180 		    sc->mii_inst);
181 	printf("\n");
182 #undef ADD
183 
184 	MIIBUS_MEDIAINIT(sc->mii_dev);
185 
186 	return(0);
187 }
188 
189 static int ukphy_detach(dev)
190 	device_t		dev;
191 {
192 	struct mii_softc *sc;
193 	struct mii_data *mii;
194 
195 	sc = device_get_softc(dev);
196 	mii = device_get_softc(device_get_parent(dev));
197 	sc->mii_dev = NULL;
198 	LIST_REMOVE(sc, mii_list);
199 
200 	return(0);
201 }
202 
203 int
204 ukphy_service(sc, mii, cmd)
205 	struct mii_softc *sc;
206 	struct mii_data *mii;
207 	int cmd;
208 {
209 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
210 	int reg;
211 
212 	switch (cmd) {
213 	case MII_POLLSTAT:
214 		/*
215 		 * If we're not polling our PHY instance, just return.
216 		 */
217 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
218 			return (0);
219 		break;
220 
221 	case MII_MEDIACHG:
222 		/*
223 		 * If the media indicates a different PHY instance,
224 		 * isolate ourselves.
225 		 */
226 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
227 			reg = PHY_READ(sc, MII_BMCR);
228 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
229 			return (0);
230 		}
231 
232 		/*
233 		 * If the interface is not up, don't do anything.
234 		 */
235 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
236 			break;
237 
238 		switch (IFM_SUBTYPE(ife->ifm_media)) {
239 		case IFM_AUTO:
240 			/*
241 			 * If we're already in auto mode, just return.
242 			 */
243 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
244 				return (0);
245 			(void) mii_phy_auto(sc, 1);
246 			break;
247 		case IFM_100_T4:
248 			/*
249 			 * XXX Not supported as a manual setting right now.
250 			 */
251 			return (EINVAL);
252 		default:
253 			/*
254 			 * BMCR data is stored in the ifmedia entry.
255 			 */
256 			PHY_WRITE(sc, MII_ANAR,
257 			    mii_anar(ife->ifm_media));
258 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
259 		}
260 		break;
261 
262 	case MII_TICK:
263 		/*
264 		 * If we're not currently selected, just return.
265 		 */
266 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
267 			return (0);
268 
269 		/*
270 		 * Only used for autonegotiation.
271 		 */
272 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
273 			return (0);
274 
275 		/*
276 		 * Is the interface even up?
277 		 */
278 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
279 			return (0);
280 
281 		/*
282 		 * Check to see if we have link.  If we do, we don't
283 		 * need to restart the autonegotiation process.  Read
284 		 * the BMSR twice in case it's latched.
285 		 */
286 		reg = PHY_READ(sc, MII_BMSR) |
287 		    PHY_READ(sc, MII_BMSR);
288 		if (reg & BMSR_LINK)
289 			return (0);
290 
291 		/*
292 		 * Only retry autonegotiation every 5 seconds.
293 		 */
294 		if (++sc->mii_ticks != 5)
295 			return (0);
296 
297 		sc->mii_ticks = 0;
298 		mii_phy_reset(sc);
299 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
300 			return (0);
301 		break;
302 	}
303 
304 	/* Update the media status. */
305 	ukphy_status(sc);
306 
307 	/* Callback if something changed. */
308 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
309 		MIIBUS_STATCHG(sc->mii_dev);
310 		sc->mii_active = mii->mii_media_active;
311 	}
312 	return (0);
313 }
314