nsphy.c revision 1.13
1/*	$OpenBSD: nsphy.c,v 1.13 2004/09/20 06:05:27 brad Exp $	*/
2/*	$NetBSD: nsphy.c,v 1.25 2000/02/02 23:34:57 thorpej Exp $	*/
3
4/*-
5 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10 * NASA Ames Research Center.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 *    notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 *    notice, this list of conditions and the following disclaimer in the
19 *    documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 *    must display the following acknowledgement:
22 *	This product includes software developed by the NetBSD
23 *	Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 *    contributors may be used to endorse or promote products derived
26 *    from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
39 */
40
41/*
42 * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
43 *
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
46 * are met:
47 * 1. Redistributions of source code must retain the above copyright
48 *    notice, this list of conditions and the following disclaimer.
49 * 2. Redistributions in binary form must reproduce the above copyright
50 *    notice, this list of conditions and the following disclaimer in the
51 *    documentation and/or other materials provided with the distribution.
52 * 3. All advertising materials mentioning features or use of this software
53 *    must display the following acknowledgement:
54 *	This product includes software developed by Manuel Bouyer.
55 * 4. The name of the author may not be used to endorse or promote products
56 *    derived from this software without specific prior written permission.
57 *
58 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
59 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
60 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
61 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
62 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
63 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
64 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
65 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
66 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
67 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
68 */
69
70/*
71 * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
72 * Data Sheet available from www.national.com
73 */
74
75#include <sys/param.h>
76#include <sys/systm.h>
77#include <sys/kernel.h>
78#include <sys/device.h>
79#include <sys/socket.h>
80#include <sys/errno.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#include <dev/mii/nsphyreg.h>
90
91int	nsphymatch(struct device *, void *, void *);
92void	nsphyattach(struct device *, struct device *, void *);
93
94struct cfattach nsphy_ca = {
95	sizeof(struct mii_softc), nsphymatch, nsphyattach, mii_phy_detach,
96	    mii_phy_activate
97};
98
99struct cfdriver nsphy_cd = {
100	NULL, "nsphy", DV_DULL
101};
102
103int	nsphy_service(struct mii_softc *, struct mii_data *, int);
104void	nsphy_status(struct mii_softc *);
105void	nsphy_reset(struct mii_softc *);
106
107int
108nsphymatch(parent, match, aux)
109	struct device *parent;
110	void *match;
111	void *aux;
112{
113	struct mii_attach_args *ma = aux;
114
115	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI &&
116	    MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83840)
117		return (10);
118
119	return (0);
120}
121
122void
123nsphyattach(parent, self, aux)
124	struct device *parent;
125	struct device *self;
126	void *aux;
127{
128	struct mii_softc *sc = (struct mii_softc *)self;
129	struct mii_attach_args *ma = aux;
130	struct mii_data *mii = ma->mii_data;
131
132	printf(": %s, rev. %d\n", MII_STR_NATSEMI_DP83840,
133	    MII_REV(ma->mii_id2));
134
135	sc->mii_inst = mii->mii_instance;
136	sc->mii_phy = ma->mii_phyno;
137	sc->mii_service = nsphy_service;
138	sc->mii_status = nsphy_status;
139	sc->mii_pdata = mii;
140	sc->mii_flags = mii->mii_flags;
141	sc->mii_anegticks = 5;
142
143	nsphy_reset(sc);
144
145	sc->mii_capabilities =
146	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
147	if (sc->mii_capabilities & BMSR_MEDIAMASK)
148		mii_phy_add_media(sc);
149}
150
151int
152nsphy_service(sc, mii, cmd)
153	struct mii_softc *sc;
154	struct mii_data *mii;
155	int cmd;
156{
157	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
158	int reg;
159
160	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
161		return (ENXIO);
162
163	switch (cmd) {
164	case MII_POLLSTAT:
165		/*
166		 * If we're not polling our PHY instance, just return.
167		 */
168		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
169			return (0);
170		break;
171
172	case MII_MEDIACHG:
173		/*
174		 * If the media indicates a different PHY instance,
175		 * isolate ourselves.
176		 */
177		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
178			reg = PHY_READ(sc, MII_BMCR);
179			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
180			return (0);
181		}
182
183		/*
184		 * If the interface is not up, don't do anything.
185		 */
186		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
187			break;
188
189		reg = PHY_READ(sc, MII_NSPHY_PCR);
190
191		/*
192		 * Set up the PCR to use LED4 to indicate full-duplex
193		 * in both 10baseT and 100baseTX modes.
194		 */
195		reg |= PCR_LED4MODE;
196
197		/*
198		 * Make sure Carrier Integrity Monitor function is
199		 * disabled (normal for Node operation, but sometimes
200		 * it's not set?!)
201		 */
202		reg |= PCR_CIMDIS;
203
204		/*
205		 * Make sure "force link good" is set to normal mode.
206		 * It's only intended for debugging.
207		 */
208		reg |= PCR_FLINK100;
209
210		/*
211		 * Mystery bits which are supposedly `reserved',
212		 * but we seem to need to set them when the PHY
213		 * is connected to some interfaces!
214		 */
215		reg |= PCR_CONGCTRL | PCR_TXREADYSEL;
216
217		PHY_WRITE(sc, MII_NSPHY_PCR, reg);
218
219		mii_phy_setmedia(sc);
220		break;
221
222	case MII_TICK:
223		/*
224		 * If we're not currently selected, just return.
225		 */
226		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
227			return (0);
228
229		/*
230		 * Only used for autonegotiation.
231		 */
232		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
233			return (0);
234
235		/*
236		 * Is the interface even up?
237		 */
238		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
239			return (0);
240
241		/*
242		 * Check to see if we have link.  If we do, we don't
243		 * need to restart the autonegotiation process.  Read
244		 * the BMSR twice in case it's latched.
245		 */
246		reg = PHY_READ(sc, MII_BMSR) |
247		    PHY_READ(sc, MII_BMSR);
248		if (reg & BMSR_LINK)
249			return (0);
250
251		/*
252		 * Only retry autonegotiation every 5 seconds.
253		 */
254		if (++sc->mii_ticks != sc->mii_anegticks)
255			return (0);
256
257		sc->mii_ticks = 0;
258		nsphy_reset(sc);
259		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
260			return (0);
261		break;
262
263	case MII_DOWN:
264		mii_phy_down(sc);
265		return (0);
266	}
267
268	/* Update the media status. */
269	mii_phy_status(sc);
270
271	/* Callback if something changed. */
272	mii_phy_update(sc, cmd);
273	return (0);
274}
275
276void
277nsphy_status(sc)
278	struct mii_softc *sc;
279{
280	struct mii_data *mii = sc->mii_pdata;
281	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
282	int bmsr, bmcr, par, anlpar;
283
284	mii->mii_media_status = IFM_AVALID;
285	mii->mii_media_active = IFM_ETHER;
286
287	bmsr = PHY_READ(sc, MII_BMSR) |
288	    PHY_READ(sc, MII_BMSR);
289	if (bmsr & BMSR_LINK)
290		mii->mii_media_status |= IFM_ACTIVE;
291
292	bmcr = PHY_READ(sc, MII_BMCR);
293	if (bmcr & BMCR_ISO) {
294		mii->mii_media_active |= IFM_NONE;
295		mii->mii_media_status = 0;
296		return;
297	}
298
299	if (bmcr & BMCR_LOOP)
300		mii->mii_media_active |= IFM_LOOP;
301
302	if (bmcr & BMCR_AUTOEN) {
303		/*
304		 * The PAR status bits are only valid of autonegotiation
305		 * has completed (or it's disabled).
306		 */
307		if ((bmsr & BMSR_ACOMP) == 0) {
308			/* Erg, still trying, I guess... */
309			mii->mii_media_active |= IFM_NONE;
310			return;
311		}
312
313		/*
314		 * Argh.  The PAR doesn't seem to indicate duplex mode
315		 * properly!  Determine media based on link partner's
316		 * advertised capabilities.
317		 */
318		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
319			anlpar = PHY_READ(sc, MII_ANAR) &
320			    PHY_READ(sc, MII_ANLPAR);
321			if (anlpar & ANLPAR_T4)
322				mii->mii_media_active |= IFM_100_T4;
323			else if (anlpar & ANLPAR_TX_FD)
324				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
325			else if (anlpar & ANLPAR_TX)
326				mii->mii_media_active |= IFM_100_TX;
327			else if (anlpar & ANLPAR_10_FD)
328				mii->mii_media_active |= IFM_10_T|IFM_FDX;
329			else if (anlpar & ANLPAR_10)
330				mii->mii_media_active |= IFM_10_T;
331			else
332				mii->mii_media_active |= IFM_NONE;
333			return;
334		}
335
336		/*
337		 * Link partner is not capable of autonegotiation.
338		 * We will never be in full-duplex mode if this is
339		 * the case, so reading the PAR is OK.
340		 */
341		par = PHY_READ(sc, MII_NSPHY_PAR);
342		if (par & PAR_10)
343			mii->mii_media_active |= IFM_10_T;
344		else
345			mii->mii_media_active |= IFM_100_TX;
346#if 0
347		if (par & PAR_FDX)
348			mii->mii_media_active |= IFM_FDX;
349#endif
350	} else
351		mii->mii_media_active = ife->ifm_media;
352}
353
354void
355nsphy_reset(sc)
356	struct mii_softc *sc;
357{
358	int anar;
359
360	mii_phy_reset(sc);
361	anar = PHY_READ(sc, MII_ANAR);
362	anar |= BMSR_MEDIA_TO_ANAR(PHY_READ(sc, MII_BMSR));
363	PHY_WRITE(sc, MII_ANAR, anar);
364}
365