xref: /netbsd-src/sys/dev/mii/ukphy.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: ukphy.c,v 1.31 2007/12/09 20:28:04 jmcneill Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000 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/cdefs.h>
74 __KERNEL_RCSID(0, "$NetBSD: ukphy.c,v 1.31 2007/12/09 20:28:04 jmcneill Exp $");
75 
76 #include "opt_mii.h"
77 
78 #include <sys/param.h>
79 #include <sys/systm.h>
80 #include <sys/kernel.h>
81 #include <sys/device.h>
82 #include <sys/socket.h>
83 #include <sys/errno.h>
84 
85 #include <net/if.h>
86 #include <net/if_media.h>
87 
88 #include <dev/mii/mii.h>
89 #include <dev/mii/miivar.h>
90 
91 #ifdef MIIVERBOSE
92 struct mii_knowndev {
93 	int oui;
94 	int model;
95 	const char *descr;
96 };
97 #include <dev/mii/miidevs.h>
98 #include <dev/mii/miidevs_data.h>
99 #endif
100 
101 static int	ukphymatch(struct device *, struct cfdata *, void *);
102 static void	ukphyattach(struct device *, struct device *, void *);
103 
104 CFATTACH_DECL(ukphy, sizeof(struct mii_softc),
105     ukphymatch, ukphyattach, mii_phy_detach, mii_phy_activate);
106 
107 static int	ukphy_service(struct mii_softc *, struct mii_data *, int);
108 
109 static const struct mii_phy_funcs ukphy_funcs = {
110 	ukphy_service, ukphy_status, mii_phy_reset,
111 };
112 
113 static int
114 ukphymatch(struct device *parent, struct cfdata *match,
115     void *aux)
116 {
117 
118 	/*
119 	 * We know something is here, so always match at a low priority.
120 	 */
121 	return (1);
122 }
123 
124 static void
125 ukphyattach(struct device *parent, struct device *self, void *aux)
126 {
127 	struct mii_softc *sc = device_private(self);
128 	struct mii_attach_args *ma = aux;
129 	struct mii_data *mii = ma->mii_data;
130 	int oui = MII_OUI(ma->mii_id1, ma->mii_id2);
131 	int model = MII_MODEL(ma->mii_id2);
132 	int rev = MII_REV(ma->mii_id2);
133 #ifdef MIIVERBOSE
134 	int i;
135 #endif
136 
137 	aprint_naive(": Media interface\n");
138 	aprint_normal(": Generic IEEE 802.3u media interface\n");
139 #ifdef MIIVERBOSE
140 	for (i = 0; mii_knowndevs[i].descr != NULL; i++)
141 		if (mii_knowndevs[i].oui == oui &&
142 		    mii_knowndevs[i].model == model)
143 			break;
144 	if (mii_knowndevs[i].descr != NULL)
145 		aprint_normal("%s: %s (OUI 0x%06x, model 0x%04x), rev. %d\n",
146 		       sc->mii_dev.dv_xname, mii_knowndevs[i].descr,
147 		       oui, model, rev);
148 	else
149 #endif
150 		aprint_normal("%s: OUI 0x%06x, model 0x%04x, rev. %d\n",
151 		       sc->mii_dev.dv_xname, oui, model, rev);
152 
153 	sc->mii_inst = mii->mii_instance;
154 	sc->mii_phy = ma->mii_phyno;
155 	sc->mii_funcs = &ukphy_funcs;
156 	sc->mii_pdata = mii;
157 	sc->mii_flags = ma->mii_flags;
158 	sc->mii_anegticks = MII_ANEGTICKS;
159 
160 	/*
161 	 * Don't do loopback on unknown PHYs.  It might confuse some of them.
162 	 */
163 	sc->mii_flags |= MIIF_NOLOOP;
164 
165 	PHY_RESET(sc);
166 
167 	sc->mii_capabilities =
168 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
169 	if (sc->mii_capabilities & BMSR_EXTSTAT)
170 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
171 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
172 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
173 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
174 		aprint_error("no media present");
175 	else
176 		mii_phy_add_media(sc);
177 	aprint_normal("\n");
178 
179 	if (!pmf_device_register(self, NULL, mii_phy_resume))
180 		aprint_error_dev(self, "couldn't establish power handler\n");
181 }
182 
183 static int
184 ukphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
185 {
186 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
187 	int reg;
188 
189 	if (!device_is_active(&sc->mii_dev))
190 		return (ENXIO);
191 
192 	switch (cmd) {
193 	case MII_POLLSTAT:
194 		/*
195 		 * If we're not polling our PHY instance, just return.
196 		 */
197 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
198 			return (0);
199 		break;
200 
201 	case MII_MEDIACHG:
202 		/*
203 		 * If the media indicates a different PHY instance,
204 		 * isolate ourselves.
205 		 */
206 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
207 			reg = PHY_READ(sc, MII_BMCR);
208 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
209 			return (0);
210 		}
211 
212 		/*
213 		 * If the interface is not up, don't do anything.
214 		 */
215 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
216 			break;
217 
218 		mii_phy_setmedia(sc);
219 		break;
220 
221 	case MII_TICK:
222 		/*
223 		 * If we're not currently selected, just return.
224 		 */
225 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
226 			return (0);
227 
228 		/*
229 		 * Only used for autonegotiation.
230 		 */
231 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
232 			return (0);
233 
234 		if (mii_phy_tick(sc) == EJUSTRETURN)
235 			return (0);
236 		break;
237 
238 	case MII_DOWN:
239 		mii_phy_down(sc);
240 		return (0);
241 	}
242 
243 	/* Update the media status. */
244 	mii_phy_status(sc);
245 
246 	/* Callback if something changed. */
247 	mii_phy_update(sc, cmd);
248 	return (0);
249 }
250