xref: /netbsd-src/sys/dev/mii/dmphy.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: dmphy.c,v 1.28 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.
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 Davicom's DM9101 ethernet 10/100 PHY
71  * Data Sheet available from www.davicom8.com
72  */
73 
74 #include <sys/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: dmphy.c,v 1.28 2007/12/09 20:28:02 jmcneill Exp $");
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/kernel.h>
80 #include <sys/device.h>
81 #include <sys/socket.h>
82 #include <sys/errno.h>
83 
84 #include <net/if.h>
85 #include <net/if_media.h>
86 
87 #include <dev/mii/mii.h>
88 #include <dev/mii/miivar.h>
89 #include <dev/mii/miidevs.h>
90 
91 #include <dev/mii/dmphyreg.h>
92 
93 static int	dmphymatch(struct device *, struct cfdata *, void *);
94 static void	dmphyattach(struct device *, struct device *, void *);
95 
96 CFATTACH_DECL(dmphy, sizeof(struct mii_softc),
97     dmphymatch, dmphyattach, mii_phy_detach, mii_phy_activate);
98 
99 static int	dmphy_service(struct mii_softc *, struct mii_data *, int);
100 static void	dmphy_status(struct mii_softc *);
101 
102 static const struct mii_phy_funcs dmphy_funcs = {
103 	dmphy_service, dmphy_status, mii_phy_reset,
104 };
105 
106 static const struct mii_phydesc dmphys[] = {
107 	{ MII_OUI_xxDAVICOM,		MII_MODEL_xxDAVICOM_DM9101,
108 	  MII_STR_xxDAVICOM_DM9101 },
109 
110 	{ MII_OUI_xxDAVICOM,		MII_MODEL_xxDAVICOM_DM9102,
111 	  MII_STR_xxDAVICOM_DM9102 },
112 
113 	{ MII_OUI_DAVICOM,		MII_MODEL_xxDAVICOM_DM9101,
114 	  MII_STR_xxDAVICOM_DM9101 },
115 
116 	{ 0,				0,
117 	  NULL },
118 };
119 
120 static int
121 dmphymatch(struct device *parent, struct cfdata *match,
122     void *aux)
123 {
124 	struct mii_attach_args *ma = aux;
125 
126 	if (mii_phy_match(ma, dmphys) != NULL)
127 		return (10);
128 
129 	return (0);
130 }
131 
132 static void
133 dmphyattach(struct device *parent, struct device *self, void *aux)
134 {
135 	struct mii_softc *sc = device_private(self);
136 	struct mii_attach_args *ma = aux;
137 	struct mii_data *mii = ma->mii_data;
138 	const struct mii_phydesc *mpd;
139 
140 	mpd = mii_phy_match(ma, dmphys);
141 	aprint_naive(": Media interface\n");
142 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
143 
144 	sc->mii_inst = mii->mii_instance;
145 	sc->mii_phy = ma->mii_phyno;
146 	sc->mii_funcs = &dmphy_funcs;
147 	sc->mii_pdata = mii;
148 	sc->mii_flags = ma->mii_flags;
149 	sc->mii_anegticks = MII_ANEGTICKS;
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 dmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
168 {
169 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
170 	int reg;
171 
172 	if (!device_is_active(&sc->mii_dev))
173 		return (ENXIO);
174 
175 	switch (cmd) {
176 	case MII_POLLSTAT:
177 		/*
178 		 * If we're not polling our PHY instance, just return.
179 		 */
180 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
181 			return (0);
182 		break;
183 
184 	case MII_MEDIACHG:
185 		/*
186 		 * If the media indicates a different PHY instance,
187 		 * isolate ourselves.
188 		 */
189 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
190 			reg = PHY_READ(sc, MII_BMCR);
191 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
192 			return (0);
193 		}
194 
195 		/*
196 		 * If the interface is not up, don't do anything.
197 		 */
198 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
199 			break;
200 
201 		mii_phy_setmedia(sc);
202 		break;
203 
204 	case MII_TICK:
205 		/*
206 		 * If we're not currently selected, just return.
207 		 */
208 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
209 			return (0);
210 
211 		if (mii_phy_tick(sc) == EJUSTRETURN)
212 			return (0);
213 		break;
214 
215 	case MII_DOWN:
216 		mii_phy_down(sc);
217 		return (0);
218 	}
219 
220 	/* Update the media status. */
221 	mii_phy_status(sc);
222 
223 	/* Callback if something changed. */
224 	mii_phy_update(sc, cmd);
225 	return (0);
226 }
227 
228 static void
229 dmphy_status(struct mii_softc *sc)
230 {
231 	struct mii_data *mii = sc->mii_pdata;
232 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
233 	int bmsr, bmcr, dscsr;
234 
235 	mii->mii_media_status = IFM_AVALID;
236 	mii->mii_media_active = IFM_ETHER;
237 
238 	bmsr = PHY_READ(sc, MII_BMSR) |
239 	    PHY_READ(sc, MII_BMSR);
240 	if (bmsr & BMSR_LINK)
241 		mii->mii_media_status |= IFM_ACTIVE;
242 
243 	bmcr = PHY_READ(sc, MII_BMCR);
244 	if (bmcr & BMCR_ISO) {
245 		mii->mii_media_active |= IFM_NONE;
246 		mii->mii_media_status = 0;
247 		return;
248 	}
249 
250 	if (bmcr & BMCR_LOOP)
251 		mii->mii_media_active |= IFM_LOOP;
252 
253 	if (bmcr & BMCR_AUTOEN) {
254 		/*
255 		 * The PAR status bits are only valid of autonegotiation
256 		 * has completed (or it's disabled).
257 		 */
258 		if ((bmsr & BMSR_ACOMP) == 0) {
259 			/* Erg, still trying, I guess... */
260 			mii->mii_media_active |= IFM_NONE;
261 			return;
262 		}
263 
264 		dscsr = PHY_READ(sc, MII_DMPHY_DSCSR);
265 		if (dscsr & DSCSR_100FDX)
266 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
267 		else if (dscsr & DSCSR_100HDX)
268 			mii->mii_media_active |= IFM_100_TX;
269 		else if (dscsr & DSCSR_10FDX)
270 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
271 		else if (dscsr & DSCSR_10HDX)
272 			mii->mii_media_active |= IFM_10_T;
273 		else
274 			mii->mii_media_active |= IFM_NONE;
275 	} else
276 		mii->mii_media_active = ife->ifm_media;
277 }
278