xref: /freebsd/sys/dev/mii/nsgphy.c (revision fb2971ccd2bab42f5406f919812ceb8e014773ea)
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 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 
77 static int nsgphy_probe(device_t);
78 static int nsgphy_attach(device_t);
79 
80 static 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 
89 static devclass_t nsgphy_devclass;
90 
91 static driver_t nsgphy_driver = {
92 	"nsgphy",
93 	nsgphy_methods,
94 	sizeof(struct mii_softc)
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 static 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 
109 static int
110 nsgphy_probe(device_t dev)
111 {
112 
113 	return (mii_phy_dev_probe(dev, nsgphys, BUS_PROBE_DEFAULT));
114 }
115 
116 static int
117 nsgphy_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 	mii_phy_reset(sc);
139 
140 	/*
141 	 * NB: the PHY has the 10baseT BMSR bits hard-wired to 0,
142 	 * even though it supports 10baseT.
143 	 */
144 	sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
145 	    (BMSR_10TFDX | BMSR_10THDX)) & ma->mii_capmask;
146 	if (sc->mii_capabilities & BMSR_EXTSTAT)
147 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
148 
149 	mii_phy_add_media(sc);
150 	printf("\n");
151 
152 	MIIBUS_MEDIAINIT(sc->mii_dev);
153 	return (0);
154 }
155 
156 static int
157 nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
158 {
159 
160 	switch (cmd) {
161 	case MII_POLLSTAT:
162 		break;
163 
164 	case MII_MEDIACHG:
165 		/*
166 		 * If the interface is not up, don't do anything.
167 		 */
168 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
169 			break;
170 
171 		mii_phy_setmedia(sc);
172 		break;
173 
174 	case MII_TICK:
175 		if (mii_phy_tick(sc) == EJUSTRETURN)
176 			return (0);
177 		break;
178 	}
179 
180 	/* Update the media status. */
181 	nsgphy_status(sc);
182 
183 	/* Callback if something changed. */
184 	mii_phy_update(sc, cmd);
185 	return (0);
186 }
187 
188 static void
189 nsgphy_status(struct mii_softc *sc)
190 {
191 	struct mii_data *mii = sc->mii_pdata;
192 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
193 	int bmsr, bmcr, physup, gtsr;
194 
195 	mii->mii_media_status = IFM_AVALID;
196 	mii->mii_media_active = IFM_ETHER;
197 
198 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
199 
200 	physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
201 
202 	if (physup & PHY_SUP_LINK)
203 		mii->mii_media_status |= IFM_ACTIVE;
204 
205 	bmcr = PHY_READ(sc, MII_BMCR);
206 	if (bmcr & BMCR_ISO) {
207 		mii->mii_media_active |= IFM_NONE;
208 		mii->mii_media_status = 0;
209 		return;
210 	}
211 
212 	if (bmcr & BMCR_LOOP)
213 		mii->mii_media_active |= IFM_LOOP;
214 
215 	if (bmcr & BMCR_AUTOEN) {
216 		/*
217 		 * The media status bits are only valid if autonegotiation
218 		 * has completed (or it's disabled).
219 		 */
220 		if ((bmsr & BMSR_ACOMP) == 0) {
221 			/* Erg, still trying, I guess... */
222 			mii->mii_media_active |= IFM_NONE;
223 			return;
224 		}
225 
226 		switch (physup & (PHY_SUP_SPEED1 | PHY_SUP_SPEED0)) {
227 		case PHY_SUP_SPEED1:
228 			mii->mii_media_active |= IFM_1000_T;
229 			gtsr = PHY_READ(sc, MII_100T2SR);
230 			if (gtsr & GTSR_MS_RES)
231 				mii->mii_media_active |= IFM_ETH_MASTER;
232 			break;
233 
234 		case PHY_SUP_SPEED0:
235 			mii->mii_media_active |= IFM_100_TX;
236 			break;
237 
238 		case 0:
239 			mii->mii_media_active |= IFM_10_T;
240 			break;
241 
242 		default:
243 			mii->mii_media_active |= IFM_NONE;
244 			mii->mii_media_status = 0;
245 			return;
246 		}
247 
248 		if (physup & PHY_SUP_DUPLEX)
249 			mii->mii_media_active |= IFM_FDX;
250 		else
251 			mii->mii_media_active |= IFM_HDX;
252 	} else
253 		mii->mii_media_active = ife->ifm_media;
254 }
255