amphy.c revision 69925 
1/*
2 * Copyright (c) 1997, 1998, 1999
3 *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 * $FreeBSD: head/sys/dev/mii/amphy.c 69925 2000-12-12 19:31:14Z wpaul $
33 */
34
35/*
36 * driver for AMD AM79c873 PHYs
37 * This driver also works for the Davicom DM9101 PHY, which appears to
38 * be an AM79c873 workalike.
39 */
40
41#include <sys/param.h>
42#include <sys/systm.h>
43#include <sys/kernel.h>
44#include <sys/socket.h>
45#include <sys/bus.h>
46
47#include <net/if.h>
48#include <net/if_media.h>
49
50#include <dev/mii/mii.h>
51#include <dev/mii/miivar.h>
52#include <dev/mii/miidevs.h>
53
54#include <dev/mii/amphyreg.h>
55
56#include "miibus_if.h"
57
58#if !defined(lint)
59static const char rcsid[] =
60  "$FreeBSD: head/sys/dev/mii/amphy.c 69925 2000-12-12 19:31:14Z wpaul $";
61#endif
62
63static int amphy_probe		__P((device_t));
64static int amphy_attach		__P((device_t));
65static int amphy_detach		__P((device_t));
66
67static device_method_t amphy_methods[] = {
68	/* device interface */
69	DEVMETHOD(device_probe,		amphy_probe),
70	DEVMETHOD(device_attach,	amphy_attach),
71	DEVMETHOD(device_detach,	amphy_detach),
72	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
73	{ 0, 0 }
74};
75
76static devclass_t amphy_devclass;
77
78static driver_t amphy_driver = {
79	"amphy",
80	amphy_methods,
81	sizeof(struct mii_softc)
82};
83
84DRIVER_MODULE(amphy, miibus, amphy_driver, amphy_devclass, 0, 0);
85
86int	amphy_service __P((struct mii_softc *, struct mii_data *, int));
87void	amphy_status __P((struct mii_softc *));
88
89static int amphy_probe(dev)
90	device_t		dev;
91{
92	struct mii_attach_args *ma;
93
94	ma = device_get_ivars(dev);
95
96	if ((MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxAMD ||
97	    MII_MODEL(ma->mii_id2) != MII_MODEL_xxAMD_79C873) &&
98	    (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxDAVICOM ||
99	    MII_MODEL(ma->mii_id2) != MII_MODEL_xxDAVICOM_DM9101))
100		return(ENXIO);
101
102	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxAMD)
103		device_set_desc(dev, MII_STR_xxAMD_79C873);
104	else if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxDAVICOM)
105		device_set_desc(dev, MII_STR_xxDAVICOM_DM9101);
106
107	return(0);
108}
109
110static int amphy_attach(dev)
111	device_t		dev;
112{
113	struct mii_softc *sc;
114	struct mii_attach_args *ma;
115	struct mii_data *mii;
116
117	sc = device_get_softc(dev);
118	ma = device_get_ivars(dev);
119	sc->mii_dev = device_get_parent(dev);
120	mii = device_get_softc(sc->mii_dev);
121	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
122
123	sc->mii_inst = mii->mii_instance;
124	sc->mii_phy = ma->mii_phyno;
125	sc->mii_service = amphy_service;
126	sc->mii_pdata = mii;
127
128	sc->mii_flags |= MIIF_NOISOLATE;
129	mii->mii_instance++;
130
131#define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
132
133	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
134	    BMCR_ISO);
135#if 0
136	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
137	    BMCR_LOOP|BMCR_S100);
138#endif
139
140	mii_phy_reset(sc);
141
142	sc->mii_capabilities =
143	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
144	device_printf(dev, " ");
145	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
146		printf("no media present");
147	else
148		mii_add_media(mii, sc->mii_capabilities,
149		    sc->mii_inst);
150	printf("\n");
151#undef ADD
152	MIIBUS_MEDIAINIT(sc->mii_dev);
153	return(0);
154}
155
156static int amphy_detach(dev)
157	device_t		dev;
158{
159	struct mii_softc *sc;
160	struct mii_data *mii;
161
162	sc = device_get_softc(dev);
163	mii = device_get_softc(device_get_parent(dev));
164	mii_phy_auto_stop(sc);
165	sc->mii_dev = NULL;
166	LIST_REMOVE(sc, mii_list);
167
168	return(0);
169}
170int
171amphy_service(sc, mii, cmd)
172	struct mii_softc *sc;
173	struct mii_data *mii;
174	int cmd;
175{
176	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
177	int reg;
178
179	switch (cmd) {
180	case MII_POLLSTAT:
181		/*
182		 * If we're not polling our PHY instance, just return.
183		 */
184		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
185			return (0);
186		break;
187
188	case MII_MEDIACHG:
189		/*
190		 * If the media indicates a different PHY instance,
191		 * isolate ourselves.
192		 */
193		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
194			reg = PHY_READ(sc, MII_BMCR);
195			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
196			return (0);
197		}
198
199		/*
200		 * If the interface is not up, don't do anything.
201		 */
202		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
203			break;
204
205		switch (IFM_SUBTYPE(ife->ifm_media)) {
206		case IFM_AUTO:
207			/*
208			 * If we're already in auto mode, just return.
209			 */
210			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
211				return (0);
212			(void) mii_phy_auto(sc, 1);
213			break;
214		case IFM_100_T4:
215			/*
216			 * XXX Not supported as a manual setting right now.
217			 */
218			return (EINVAL);
219		default:
220			/*
221			 * BMCR data is stored in the ifmedia entry.
222			 */
223			PHY_WRITE(sc, MII_ANAR,
224			    mii_anar(ife->ifm_media));
225			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
226		}
227		break;
228
229	case MII_TICK:
230		/*
231		 * If we're not currently selected, just return.
232		 */
233		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
234			return (0);
235
236		/*
237		 * Only used for autonegotiation.
238		 */
239		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
240			return (0);
241
242		/*
243		 * Is the interface even up?
244		 */
245		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
246			return (0);
247
248		/*
249		 * Only retry autonegotiation every 5 seconds.
250		 */
251		if (++sc->mii_ticks != 5)
252			return (0);
253
254		sc->mii_ticks = 0;
255
256		/*
257		 * Check to see if we have link.  If we do, we don't
258		 * need to restart the autonegotiation process.  Read
259		 * the BMSR twice in case it's latched.
260		 */
261		reg = PHY_READ(sc, MII_BMSR) |
262		    PHY_READ(sc, MII_BMSR);
263		if (reg & BMSR_LINK)
264			break;
265
266		mii_phy_reset(sc);
267		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
268			return(0);
269		break;
270	}
271
272	/* Update the media status. */
273	amphy_status(sc);
274
275	/* Callback if something changed. */
276	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
277		MIIBUS_STATCHG(sc->mii_dev);
278		sc->mii_active = mii->mii_media_active;
279	}
280	return (0);
281}
282
283void
284amphy_status(sc)
285	struct mii_softc *sc;
286{
287	struct mii_data *mii = sc->mii_pdata;
288	int bmsr, bmcr, par, anlpar;
289
290	mii->mii_media_status = IFM_AVALID;
291	mii->mii_media_active = IFM_ETHER;
292
293	bmsr = PHY_READ(sc, MII_BMSR) |
294	    PHY_READ(sc, MII_BMSR);
295	if (bmsr & BMSR_LINK)
296		mii->mii_media_status |= IFM_ACTIVE;
297
298	bmcr = PHY_READ(sc, MII_BMCR);
299	if (bmcr & BMCR_ISO) {
300		mii->mii_media_active |= IFM_NONE;
301		mii->mii_media_status = 0;
302		return;
303	}
304
305	if (bmcr & BMCR_LOOP)
306		mii->mii_media_active |= IFM_LOOP;
307
308	if (bmcr & BMCR_AUTOEN) {
309		/*
310		 * The PAR status bits are only valid of autonegotiation
311		 * has completed (or it's disabled).
312		 */
313		if ((bmsr & BMSR_ACOMP) == 0) {
314			/* Erg, still trying, I guess... */
315			mii->mii_media_active |= IFM_NONE;
316			return;
317		}
318
319		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
320			anlpar = PHY_READ(sc, MII_ANAR) &
321			    PHY_READ(sc, MII_ANLPAR);
322			if (anlpar & ANLPAR_T4)
323				mii->mii_media_active |= IFM_100_T4;
324			else if (anlpar & ANLPAR_TX_FD)
325				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
326			else if (anlpar & ANLPAR_TX)
327				mii->mii_media_active |= IFM_100_TX;
328			else if (anlpar & ANLPAR_10_FD)
329				mii->mii_media_active |= IFM_10_T|IFM_FDX;
330			else if (anlpar & ANLPAR_10)
331				mii->mii_media_active |= IFM_10_T;
332			else
333				mii->mii_media_active |= IFM_NONE;
334			return;
335		}
336
337		/*
338		 * Link partner is not capable of autonegotiation.
339		 */
340		par = PHY_READ(sc, MII_AMPHY_DSCSR);
341		if (par & DSCSR_100FDX)
342			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
343		else if (par & DSCSR_100HDX)
344			mii->mii_media_active |= IFM_100_TX;
345		else if (par & DSCSR_10FDX)
346			mii->mii_media_active |= IFM_10_T|IFM_HDX;
347		else if (par & DSCSR_10HDX)
348			mii->mii_media_active |= IFM_10_T;
349	} else
350		mii->mii_media_active = mii_media_from_bmcr(bmcr);
351}
352