nsgphy.c revision 216623
1/*-
2 * Copyright (c) 2001 Wind River Systems
3 * Copyright (c) 2001
4 *	Bill Paul <wpaul@bsdi.com>.  All rights reserved.
5 * Copyright (c) 1998, 1999, 2000, 2001 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 Bill Paul.
23 * 4. Neither the name of the author nor the names of any co-contributors
24 *    may be used to endorse or promote products derived from this software
25 *    without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
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
37 * THE POSSIBILITY OF SUCH DAMAGE.
38 */
39
40#include <sys/cdefs.h>
41__FBSDID("$FreeBSD: head/sys/dev/mii/nsgphy.c 216623 2010-12-21 21:12:18Z marius $");
42
43/*
44 * Driver for the National Semiconductor DP83861, DP83865 and DP83891
45 * 10/100/1000 PHYs.
46 * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf
47 * and at: http://www.national.com/ds/DP/DP83865.pdf
48 *
49 * The DP83891 is the older NS GigE PHY which isn't being sold
50 * anymore.  The DP83861 is its replacement, which is an 'enhanced'
51 * firmware driven component.  The major difference between the
52 * two is that the DP83891 can't generate interrupts, while the
53 * 83861 can (probably it wasn't originally designed to do this, but
54 * it can now thanks to firmware updates).  The DP83861 also allows
55 * access to its internal RAM via indirect register access.  The
56 * DP83865 is an ultra low power version of the DP83861 and DP83891.
57 */
58
59#include <sys/param.h>
60#include <sys/systm.h>
61#include <sys/kernel.h>
62#include <sys/module.h>
63#include <sys/socket.h>
64#include <sys/bus.h>
65
66#include <net/if.h>
67#include <net/if_media.h>
68
69#include <dev/mii/mii.h>
70#include <dev/mii/miivar.h>
71#include "miidevs.h"
72
73#include <dev/mii/nsgphyreg.h>
74
75#include "miibus_if.h"
76
77static int nsgphy_probe(device_t);
78static int nsgphy_attach(device_t);
79
80static device_method_t nsgphy_methods[] = {
81	/* device interface */
82	DEVMETHOD(device_probe,		nsgphy_probe),
83	DEVMETHOD(device_attach,	nsgphy_attach),
84	DEVMETHOD(device_detach,	mii_phy_detach),
85	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
86	{ 0, 0 }
87};
88
89static devclass_t nsgphy_devclass;
90
91static driver_t nsgphy_driver = {
92	"nsgphy",
93	nsgphy_methods,
94	sizeof(struct mii_softc)
95};
96
97DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, nsgphy_devclass, 0, 0);
98
99static int	nsgphy_service(struct mii_softc *, struct mii_data *,int);
100static void	nsgphy_status(struct mii_softc *);
101
102static const struct mii_phydesc nsgphys[] = {
103	MII_PHY_DESC(NATSEMI, DP83861),
104	MII_PHY_DESC(NATSEMI, DP83865),
105	MII_PHY_DESC(NATSEMI, DP83891),
106	MII_PHY_END
107};
108
109static int
110nsgphy_probe(device_t dev)
111{
112
113	return (mii_phy_dev_probe(dev, nsgphys, BUS_PROBE_DEFAULT));
114}
115
116static int
117nsgphy_attach(device_t dev)
118{
119	struct mii_softc *sc;
120	struct mii_attach_args *ma;
121	struct mii_data *mii;
122
123	sc = device_get_softc(dev);
124	ma = device_get_ivars(dev);
125	if (bootverbose)
126		device_printf(dev, "<rev. %d>\n", MII_REV(ma->mii_id2));
127	device_printf(dev, " ");
128	sc->mii_dev = device_get_parent(dev);
129	mii = ma->mii_data;
130	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
131
132	sc->mii_flags = miibus_get_flags(dev);
133	sc->mii_inst = mii->mii_instance++;
134	sc->mii_phy = ma->mii_phyno;
135	sc->mii_service = nsgphy_service;
136	sc->mii_pdata = mii;
137
138	sc->mii_flags |= MIIF_NOMANPAUSE;
139
140	mii_phy_reset(sc);
141
142	/*
143	 * NB: the PHY has the 10BASE-T BMSR bits hard-wired to 0,
144	 * even though it supports 10BASE-T.
145	 */
146	sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
147	    BMSR_10TFDX | BMSR_10THDX) & ma->mii_capmask;
148	/*
149	 * Note that as documented manual 1000BASE-T modes of DP83865 only
150	 * work together with other National Semiconductor PHYs.
151	 */
152	if (sc->mii_capabilities & BMSR_EXTSTAT)
153		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
154
155	mii_phy_add_media(sc);
156	printf("\n");
157
158	MIIBUS_MEDIAINIT(sc->mii_dev);
159	return (0);
160}
161
162static int
163nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
164{
165
166	switch (cmd) {
167	case MII_POLLSTAT:
168		break;
169
170	case MII_MEDIACHG:
171		/*
172		 * If the interface is not up, don't do anything.
173		 */
174		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
175			break;
176
177		mii_phy_setmedia(sc);
178		break;
179
180	case MII_TICK:
181		if (mii_phy_tick(sc) == EJUSTRETURN)
182			return (0);
183		break;
184	}
185
186	/* Update the media status. */
187	nsgphy_status(sc);
188
189	/* Callback if something changed. */
190	mii_phy_update(sc, cmd);
191	return (0);
192}
193
194static void
195nsgphy_status(struct mii_softc *sc)
196{
197	struct mii_data *mii = sc->mii_pdata;
198	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
199	int bmsr, bmcr, physup, gtsr;
200
201	mii->mii_media_status = IFM_AVALID;
202	mii->mii_media_active = IFM_ETHER;
203
204	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
205
206	physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
207
208	if (physup & PHY_SUP_LINK)
209		mii->mii_media_status |= IFM_ACTIVE;
210
211	bmcr = PHY_READ(sc, MII_BMCR);
212	if (bmcr & BMCR_ISO) {
213		mii->mii_media_active |= IFM_NONE;
214		mii->mii_media_status = 0;
215		return;
216	}
217
218	if (bmcr & BMCR_LOOP)
219		mii->mii_media_active |= IFM_LOOP;
220
221	if (bmcr & BMCR_AUTOEN) {
222		/*
223		 * The media status bits are only valid if autonegotiation
224		 * has completed (or it's disabled).
225		 */
226		if ((bmsr & BMSR_ACOMP) == 0) {
227			/* Erg, still trying, I guess... */
228			mii->mii_media_active |= IFM_NONE;
229			return;
230		}
231
232		switch (physup & (PHY_SUP_SPEED1 | PHY_SUP_SPEED0)) {
233		case PHY_SUP_SPEED1:
234			mii->mii_media_active |= IFM_1000_T;
235			gtsr = PHY_READ(sc, MII_100T2SR);
236			if (gtsr & GTSR_MS_RES)
237				mii->mii_media_active |= IFM_ETH_MASTER;
238			break;
239
240		case PHY_SUP_SPEED0:
241			mii->mii_media_active |= IFM_100_TX;
242			break;
243
244		case 0:
245			mii->mii_media_active |= IFM_10_T;
246			break;
247
248		default:
249			mii->mii_media_active |= IFM_NONE;
250			mii->mii_media_status = 0;
251			return;
252		}
253
254		if (physup & PHY_SUP_DUPLEX)
255			mii->mii_media_active |=
256			    IFM_FDX | mii_phy_flowstatus(sc);
257		else
258			mii->mii_media_active |= IFM_HDX;
259	} else
260		mii->mii_media_active = ife->ifm_media;
261}
262