xref: /freebsd/sys/dev/mii/nsgphy.c (revision d056fa046c6a91b90cd98165face0e42a33a5173)
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$");
42 
43 /*
44  * Driver for the National Semiconductor DP83891 and DP83861
45  * 10/100/1000 PHYs.
46  * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf
47  *
48  * The DP83891 is the older NatSemi gigE PHY which isn't being sold
49  * anymore. The DP83861 is its replacement, which is an 'enhanced'
50  * firmware driven component. The major difference between the
51  * two is that the 83891 can't generate interrupts, while the
52  * 83861 can. (I think it wasn't originally designed to do this, but
53  * it can now thanks to firmware updates.) The 83861 also allows
54  * access to its internal RAM via indirect register access.
55  */
56 
57 #include <sys/param.h>
58 #include <sys/systm.h>
59 #include <sys/kernel.h>
60 #include <sys/module.h>
61 #include <sys/socket.h>
62 #include <sys/bus.h>
63 
64 
65 #include <net/if.h>
66 #include <net/if_media.h>
67 
68 #include <dev/mii/mii.h>
69 #include <dev/mii/miivar.h>
70 #include "miidevs.h"
71 
72 #include <dev/mii/nsgphyreg.h>
73 
74 #include "miibus_if.h"
75 
76 static int nsgphy_probe(device_t);
77 static int nsgphy_attach(device_t);
78 
79 static device_method_t nsgphy_methods[] = {
80 	/* device interface */
81 	DEVMETHOD(device_probe,		nsgphy_probe),
82 	DEVMETHOD(device_attach,	nsgphy_attach),
83 	DEVMETHOD(device_detach,	mii_phy_detach),
84 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
85 	{ 0, 0 }
86 };
87 
88 static devclass_t nsgphy_devclass;
89 
90 static driver_t nsgphy_driver = {
91 	"nsgphy",
92 	nsgphy_methods,
93 	sizeof(struct mii_softc)
94 };
95 
96 
97 DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, nsgphy_devclass, 0, 0);
98 
99 static int	nsgphy_service(struct mii_softc *, struct mii_data *,int);
100 static void	nsgphy_status(struct mii_softc *);
101 
102 const struct mii_phydesc gphyters[] = {
103 	MII_PHY_DESC(NATSEMI, DP83861),
104 	MII_PHY_DESC(NATSEMI, DP83891),
105 	MII_PHY_END
106 };
107 
108 static int
109 nsgphy_probe(device_t dev)
110 {
111 	struct mii_attach_args *ma;
112 	const struct mii_phydesc *mpd;
113 
114 	ma = device_get_ivars(dev);
115 	mpd = mii_phy_match(ma, gphyters);
116 	if (mpd != NULL) {
117 		device_set_desc(dev, mpd->mpd_name);
118 		return(BUS_PROBE_DEFAULT);
119 	}
120 
121 	return(ENXIO);
122 }
123 
124 static int
125 nsgphy_attach(device_t dev)
126 {
127 	struct mii_softc *sc;
128 	struct mii_attach_args *ma;
129 	struct mii_data *mii;
130 
131 	sc = device_get_softc(dev);
132 	ma = device_get_ivars(dev);
133 	if (bootverbose)
134 		device_printf(dev, "<rev. %d>\n", MII_REV(ma->mii_id2));
135 	device_printf(dev, " ");
136 	sc->mii_dev = device_get_parent(dev);
137 	mii = device_get_softc(sc->mii_dev);
138 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
139 
140 	sc->mii_inst = mii->mii_instance;
141 	sc->mii_phy = ma->mii_phyno;
142 	sc->mii_service = nsgphy_service;
143 	sc->mii_pdata = mii;
144 	sc->mii_anegticks = 5;
145 
146 	mii->mii_instance++;
147 
148 	sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
149 	    (BMSR_10TFDX|BMSR_10THDX)) & ma->mii_capmask;
150 	if (sc->mii_capabilities & BMSR_EXTSTAT)
151 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
152 
153 	mii_phy_add_media(sc);
154 	printf("\n");
155 
156 	MIIBUS_MEDIAINIT(sc->mii_dev);
157 	return(0);
158 }
159 
160 static int
161 nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
162 {
163 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
164 	int reg;
165 
166 	switch (cmd) {
167 	case MII_POLLSTAT:
168 		/*
169 		 * If we're not polling our PHY instance, just return.
170 		 */
171 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
172 			return (0);
173 		break;
174 
175 	case MII_MEDIACHG:
176 		/*
177 		 * If the media indicates a different PHY instance,
178 		 * isolate ourselves.
179 		 */
180 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
181 			reg = PHY_READ(sc, MII_BMCR);
182 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
183 			return (0);
184 		}
185 
186 		/*
187 		 * If the interface is not up, don't do anything.
188 		 */
189 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
190 			break;
191 
192 		mii_phy_setmedia(sc);
193 		break;
194 
195 	case MII_TICK:
196 		/*
197 		 * If we're not currently selected, just return.
198 		 */
199 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
200 			return (0);
201 
202 		if (mii_phy_tick(sc) == EJUSTRETURN)
203 			return (0);
204 		break;
205 	}
206 
207 	/* Update the media status. */
208 	nsgphy_status(sc);
209 
210 	/* Callback if something changed. */
211 	mii_phy_update(sc, cmd);
212 	return (0);
213 }
214 
215 static void
216 nsgphy_status(struct mii_softc *sc)
217 {
218 	struct mii_data *mii = sc->mii_pdata;
219 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
220 	int bmsr, bmcr, physup, gtsr;
221 
222 	mii->mii_media_status = IFM_AVALID;
223 	mii->mii_media_active = IFM_ETHER;
224 
225 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
226 
227 	physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
228 
229 	if (physup & PHY_SUP_LINK)
230 		mii->mii_media_status |= IFM_ACTIVE;
231 
232 	bmcr = PHY_READ(sc, MII_BMCR);
233 	if (bmcr & BMCR_ISO) {
234 		mii->mii_media_active |= IFM_NONE;
235 		mii->mii_media_status = 0;
236 		return;
237 	}
238 
239 	if (bmcr & BMCR_LOOP)
240 		mii->mii_media_active |= IFM_LOOP;
241 
242 	if (bmcr & BMCR_AUTOEN) {
243 		/*
244 		 * The media status bits are only valid if autonegotiation
245 		 * has completed (or it's disabled).
246 		 */
247 		if ((bmsr & BMSR_ACOMP) == 0) {
248 			/* Erg, still trying, I guess... */
249 			mii->mii_media_active |= IFM_NONE;
250 			return;
251 		}
252 
253 		switch (physup & (PHY_SUP_SPEED1|PHY_SUP_SPEED0)) {
254 		case PHY_SUP_SPEED1:
255 			mii->mii_media_active |= IFM_1000_T;
256 			gtsr = PHY_READ(sc, MII_100T2SR);
257 			if (gtsr & GTSR_MS_RES)
258 				mii->mii_media_active |= IFM_ETH_MASTER;
259 			break;
260 
261 		case PHY_SUP_SPEED0:
262 			mii->mii_media_active |= IFM_100_TX;
263 			break;
264 
265 		case 0:
266 			mii->mii_media_active |= IFM_10_T;
267 			break;
268 
269 		default:
270 			mii->mii_media_active |= IFM_NONE;
271 			mii->mii_media_status = 0;
272 		}
273 		if (physup & PHY_SUP_DUPLEX)
274 			mii->mii_media_active |= IFM_FDX;
275 	} else
276 		mii->mii_media_active = ife->ifm_media;
277 }
278