xref: /netbsd-src/sys/dev/mii/nsphyter.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: nsphyter.c,v 1.27 2007/12/09 20:28:04 jmcneill Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2001 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 National Semiconductor's DP83843 `PHYTER' ethernet 10/100 PHY
71  * Data Sheet available from www.national.com
72  *
73  * We also support the DP83815 MacPHYER internal PHY since, for our
74  * purposes, they are compatible.
75  */
76 
77 #include <sys/cdefs.h>
78 __KERNEL_RCSID(0, "$NetBSD: nsphyter.c,v 1.27 2007/12/09 20:28:04 jmcneill Exp $");
79 
80 #include <sys/param.h>
81 #include <sys/systm.h>
82 #include <sys/kernel.h>
83 #include <sys/device.h>
84 #include <sys/socket.h>
85 #include <sys/errno.h>
86 
87 #include <net/if.h>
88 #include <net/if_media.h>
89 
90 #include <dev/mii/mii.h>
91 #include <dev/mii/miivar.h>
92 #include <dev/mii/miidevs.h>
93 
94 #include <dev/mii/nsphyterreg.h>
95 
96 static int	nsphytermatch(struct device *, struct cfdata *, void *);
97 static void	nsphyterattach(struct device *, struct device *, void *);
98 
99 CFATTACH_DECL(nsphyter, sizeof(struct mii_softc),
100     nsphytermatch, nsphyterattach, mii_phy_detach, mii_phy_activate);
101 
102 static int	nsphyter_service(struct mii_softc *, struct mii_data *, int);
103 static void	nsphyter_status(struct mii_softc *);
104 
105 static const struct mii_phy_funcs nsphyter_funcs = {
106 	nsphyter_service, nsphyter_status, mii_phy_reset,
107 };
108 
109 static const struct mii_phydesc nsphyters[] = {
110 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83843,
111 	  MII_STR_xxNATSEMI_DP83843 },
112 
113 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83847,
114 	  MII_STR_xxNATSEMI_DP83847 },
115 
116 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83815,
117 	  MII_STR_xxNATSEMI_DP83815 },
118 
119 	{ 0,				0,
120 	  NULL },
121 };
122 
123 static int
124 nsphytermatch(struct device *parent, struct cfdata *match,
125     void *aux)
126 {
127 	struct mii_attach_args *ma = aux;
128 
129 	if (mii_phy_match(ma, nsphyters) != NULL)
130 		return (10);
131 
132 	return (0);
133 }
134 
135 static void
136 nsphyterattach(struct device *parent, struct device *self, void *aux)
137 {
138 	struct mii_softc *sc = (struct mii_softc *)self;
139 	struct mii_attach_args *ma = aux;
140 	struct mii_data *mii = ma->mii_data;
141 	const struct mii_phydesc *mpd;
142 
143 	mpd = mii_phy_match(ma, nsphyters);
144 	aprint_naive(": Media interface\n");
145 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
146 
147 	sc->mii_inst = mii->mii_instance;
148 	sc->mii_phy = ma->mii_phyno;
149 	sc->mii_funcs = &nsphyter_funcs;
150 	sc->mii_pdata = mii;
151 	sc->mii_flags = ma->mii_flags;
152 	sc->mii_anegticks = MII_ANEGTICKS;
153 
154 	PHY_RESET(sc);
155 
156 	sc->mii_capabilities =
157 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
158 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
159 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
160 		aprint_error("no media present");
161 	else
162 		mii_phy_add_media(sc);
163 	aprint_normal("\n");
164 
165 	if (!pmf_device_register(self, NULL, mii_phy_resume))
166 		aprint_error_dev(self, "couldn't establish power handler\n");
167 }
168 
169 static int
170 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
171 {
172 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
173 	int reg;
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 nsphyter_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, physts;
234 
235 	mii->mii_media_status = IFM_AVALID;
236 	mii->mii_media_active = IFM_ETHER;
237 
238 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
239 	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
240 
241 	if (physts & PHYSTS_LINK)
242 		mii->mii_media_status |= IFM_ACTIVE;
243 
244 	bmcr = PHY_READ(sc, MII_BMCR);
245 	if (bmcr & BMCR_ISO) {
246 		mii->mii_media_active |= IFM_NONE;
247 		mii->mii_media_status = 0;
248 		return;
249 	}
250 
251 	if (bmcr & BMCR_LOOP)
252 		mii->mii_media_active |= IFM_LOOP;
253 
254 	if (bmcr & BMCR_AUTOEN) {
255 		/*
256 		 * The media status bits are only valid of autonegotiation
257 		 * has completed (or it's disabled).
258 		 */
259 		if ((bmsr & BMSR_ACOMP) == 0) {
260 			/* Erg, still trying, I guess... */
261 			mii->mii_media_active |= IFM_NONE;
262 			return;
263 		}
264 
265 		if (physts & PHYSTS_SPEED10)
266 			mii->mii_media_active |= IFM_10_T;
267 		else
268 			mii->mii_media_active |= IFM_100_TX;
269 		if (physts & PHYSTS_DUPLEX)
270 			mii->mii_media_active |=
271 			    IFM_FDX | mii_phy_flowstatus(sc);
272 	} else
273 		mii->mii_media_active = ife->ifm_media;
274 }
275