xref: /netbsd-src/sys/dev/mii/exphy.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: exphy.c,v 1.45 2007/12/09 20:28:02 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 3Com internal PHYs
71  */
72 
73 #include <sys/cdefs.h>
74 __KERNEL_RCSID(0, "$NetBSD: exphy.c,v 1.45 2007/12/09 20:28:02 jmcneill Exp $");
75 
76 #include <sys/param.h>
77 #include <sys/systm.h>
78 #include <sys/kernel.h>
79 #include <sys/device.h>
80 #include <sys/socket.h>
81 
82 #include <net/if.h>
83 #include <net/if_media.h>
84 
85 #include <dev/mii/mii.h>
86 #include <dev/mii/miivar.h>
87 #include <dev/mii/miidevs.h>
88 
89 static int	exphymatch(struct device *, struct cfdata *, void *);
90 static void	exphyattach(struct device *, struct device *, void *);
91 
92 CFATTACH_DECL(exphy, sizeof(struct mii_softc),
93     exphymatch, exphyattach, mii_phy_detach, mii_phy_activate);
94 
95 static int	exphy_service(struct mii_softc *, struct mii_data *, int);
96 static void	exphy_reset(struct mii_softc *);
97 
98 static const struct mii_phy_funcs exphy_funcs = {
99 	exphy_service, ukphy_status, exphy_reset,
100 };
101 
102 static int
103 exphymatch(struct device *parent, struct cfdata *match, void *aux)
104 {
105 	struct mii_attach_args *ma = aux;
106 
107 	/*
108 	 * Argh, 3Com PHY reports oui == 0 model == 0!
109 	 */
110 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 &&
111 	    MII_MODEL(ma->mii_id2) != 0)
112 		return (0);
113 
114 	/*
115 	 * Make sure the parent is an `ex'.
116 	 */
117 	if (!device_is_a(parent, "ex"))
118 		return (0);
119 
120 	return (10);
121 }
122 
123 static void
124 exphyattach(struct device *parent, struct device *self, void *aux)
125 {
126 	struct mii_softc *sc = device_private(self);
127 	struct mii_attach_args *ma = aux;
128 	struct mii_data *mii = ma->mii_data;
129 
130 	aprint_naive(": Media interface\n");
131 	aprint_normal(": 3Com internal media interface\n");
132 
133 	sc->mii_inst = mii->mii_instance;
134 	sc->mii_phy = ma->mii_phyno;
135 	sc->mii_funcs = &exphy_funcs;
136 	sc->mii_pdata = mii;
137 	sc->mii_flags = ma->mii_flags;
138 	sc->mii_anegticks = MII_ANEGTICKS;
139 
140 	/*
141 	 * The 3Com PHY can never be isolated, so never allow non-zero
142 	 * instances!
143 	 */
144 	if (mii->mii_instance != 0) {
145 		aprint_error("%s: ignoring this PHY, non-zero instance\n",
146 		    sc->mii_dev.dv_xname);
147 		return;
148 	}
149 	sc->mii_flags |= MIIF_NOISOLATE;
150 
151 	PHY_RESET(sc);
152 
153 	sc->mii_capabilities =
154 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
155 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
156 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
157 		aprint_error("no media present");
158 	else
159 		mii_phy_add_media(sc);
160 	aprint_normal("\n");
161 
162 	if (!pmf_device_register(self, NULL, mii_phy_resume))
163 		aprint_error_dev(self, "couldn't establish power handler\n");
164 }
165 
166 static int
167 exphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
168 {
169 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
170 
171 	if (!device_is_active(&sc->mii_dev))
172 		return (ENXIO);
173 
174 	/*
175 	 * We can't isolate the 3Com PHY, so it has to be the only one!
176 	 */
177 	if (IFM_INST(ife->ifm_media) != sc->mii_inst)
178 		panic("exphy_service: can't isolate 3Com PHY");
179 
180 	switch (cmd) {
181 	case MII_POLLSTAT:
182 		break;
183 
184 	case MII_MEDIACHG:
185 		/*
186 		 * If the interface is not up, don't do anything.
187 		 */
188 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
189 			break;
190 
191 		mii_phy_setmedia(sc);
192 		break;
193 
194 	case MII_TICK:
195 		/*
196 		 * Only used for autonegotiation.
197 		 */
198 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
199 			return (0);
200 
201 		if (mii_phy_tick(sc) == EJUSTRETURN)
202 			return (0);
203 		break;
204 
205 	case MII_DOWN:
206 		mii_phy_down(sc);
207 		return (0);
208 	}
209 
210 	/* Update the media status. */
211 	mii_phy_status(sc);
212 
213 	/* Callback if something changed. */
214 	mii_phy_update(sc, cmd);
215 	return (0);
216 }
217 
218 static void
219 exphy_reset(struct mii_softc *sc)
220 {
221 
222 	mii_phy_reset(sc);
223 
224 	/*
225 	 * XXX 3Com PHY doesn't set the BMCR properly after
226 	 * XXX reset, which breaks autonegotiation.
227 	 */
228 	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_AUTOEN|BMCR_FDX);
229 }
230