xref: /freebsd/sys/dev/mii/amphy.c (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
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$
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 "miidevs.h"
53 
54 #include <dev/mii/amphyreg.h>
55 
56 #include "miibus_if.h"
57 
58 #if !defined(lint)
59 static const char rcsid[] =
60   "$FreeBSD$";
61 #endif
62 
63 static int amphy_probe(device_t);
64 static int amphy_attach(device_t);
65 
66 static device_method_t amphy_methods[] = {
67 	/* device interface */
68 	DEVMETHOD(device_probe,		amphy_probe),
69 	DEVMETHOD(device_attach,	amphy_attach),
70 	DEVMETHOD(device_detach,	mii_phy_detach),
71 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
72 	{ 0, 0 }
73 };
74 
75 static devclass_t amphy_devclass;
76 
77 static driver_t amphy_driver = {
78 	"amphy",
79 	amphy_methods,
80 	sizeof(struct mii_softc)
81 };
82 
83 DRIVER_MODULE(amphy, miibus, amphy_driver, amphy_devclass, 0, 0);
84 
85 static int	amphy_service(struct mii_softc *, struct mii_data *, int);
86 static void	amphy_status(struct mii_softc *);
87 
88 static int
89 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 
110 static int
111 amphy_attach(dev)
112 	device_t		dev;
113 {
114 	struct mii_softc *sc;
115 	struct mii_attach_args *ma;
116 	struct mii_data *mii;
117 
118 	sc = device_get_softc(dev);
119 	ma = device_get_ivars(dev);
120 	sc->mii_dev = device_get_parent(dev);
121 	mii = device_get_softc(sc->mii_dev);
122 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
123 
124 	sc->mii_inst = mii->mii_instance;
125 	sc->mii_phy = ma->mii_phyno;
126 	sc->mii_service = amphy_service;
127 	sc->mii_pdata = mii;
128 
129 	sc->mii_flags |= MIIF_NOISOLATE;
130 	mii->mii_instance++;
131 
132 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
133 
134 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
135 	    BMCR_ISO);
136 #if 0
137 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
138 	    BMCR_LOOP|BMCR_S100);
139 #endif
140 
141 	mii_phy_reset(sc);
142 
143 	sc->mii_capabilities =
144 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
145 	device_printf(dev, " ");
146 	mii_add_media(sc);
147 	printf("\n");
148 #undef ADD
149 	MIIBUS_MEDIAINIT(sc->mii_dev);
150 	return(0);
151 }
152 
153 static int
154 amphy_service(sc, mii, cmd)
155 	struct mii_softc *sc;
156 	struct mii_data *mii;
157 	int cmd;
158 {
159 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
160 	int reg;
161 
162 	switch (cmd) {
163 	case MII_POLLSTAT:
164 		/*
165 		 * If we're not polling our PHY instance, just return.
166 		 */
167 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
168 			return (0);
169 		break;
170 
171 	case MII_MEDIACHG:
172 		/*
173 		 * If the media indicates a different PHY instance,
174 		 * isolate ourselves.
175 		 */
176 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
177 			reg = PHY_READ(sc, MII_BMCR);
178 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
179 			return (0);
180 		}
181 
182 		/*
183 		 * If the interface is not up, don't do anything.
184 		 */
185 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
186 			break;
187 
188 		switch (IFM_SUBTYPE(ife->ifm_media)) {
189 		case IFM_AUTO:
190 			/*
191 			 * If we're already in auto mode, just return.
192 			 */
193 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
194 				return (0);
195 			(void) mii_phy_auto(sc);
196 			break;
197 		case IFM_100_T4:
198 			/*
199 			 * XXX Not supported as a manual setting right now.
200 			 */
201 			return (EINVAL);
202 		default:
203 			/*
204 			 * BMCR data is stored in the ifmedia entry.
205 			 */
206 			PHY_WRITE(sc, MII_ANAR,
207 			    mii_anar(ife->ifm_media));
208 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
209 		}
210 		break;
211 
212 	case MII_TICK:
213 		/*
214 		 * If we're not currently selected, just return.
215 		 */
216 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
217 			return (0);
218 		if (mii_phy_tick(sc) == EJUSTRETURN)
219 			return (0);
220 		break;
221 	}
222 
223 	/* Update the media status. */
224 	amphy_status(sc);
225 
226 	/* Callback if something changed. */
227 	mii_phy_update(sc, cmd);
228 	return (0);
229 }
230 
231 static void
232 amphy_status(sc)
233 	struct mii_softc *sc;
234 {
235 	struct mii_data *mii = sc->mii_pdata;
236 	int bmsr, bmcr, par, anlpar;
237 
238 	mii->mii_media_status = IFM_AVALID;
239 	mii->mii_media_active = IFM_ETHER;
240 
241 	bmsr = PHY_READ(sc, MII_BMSR) |
242 	    PHY_READ(sc, MII_BMSR);
243 	if (bmsr & BMSR_LINK)
244 		mii->mii_media_status |= IFM_ACTIVE;
245 
246 	bmcr = PHY_READ(sc, MII_BMCR);
247 	if (bmcr & BMCR_ISO) {
248 		mii->mii_media_active |= IFM_NONE;
249 		mii->mii_media_status = 0;
250 		return;
251 	}
252 
253 	if (bmcr & BMCR_LOOP)
254 		mii->mii_media_active |= IFM_LOOP;
255 
256 	if (bmcr & BMCR_AUTOEN) {
257 		/*
258 		 * The PAR status bits are only valid of autonegotiation
259 		 * has completed (or it's disabled).
260 		 */
261 		if ((bmsr & BMSR_ACOMP) == 0) {
262 			/* Erg, still trying, I guess... */
263 			mii->mii_media_active |= IFM_NONE;
264 			return;
265 		}
266 
267 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
268 			anlpar = PHY_READ(sc, MII_ANAR) &
269 			    PHY_READ(sc, MII_ANLPAR);
270 			if (anlpar & ANLPAR_T4)
271 				mii->mii_media_active |= IFM_100_T4;
272 			else if (anlpar & ANLPAR_TX_FD)
273 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
274 			else if (anlpar & ANLPAR_TX)
275 				mii->mii_media_active |= IFM_100_TX;
276 			else if (anlpar & ANLPAR_10_FD)
277 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
278 			else if (anlpar & ANLPAR_10)
279 				mii->mii_media_active |= IFM_10_T;
280 			else
281 				mii->mii_media_active |= IFM_NONE;
282 			return;
283 		}
284 
285 		/*
286 		 * Link partner is not capable of autonegotiation.
287 		 */
288 		par = PHY_READ(sc, MII_AMPHY_DSCSR);
289 		if (par & DSCSR_100FDX)
290 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
291 		else if (par & DSCSR_100HDX)
292 			mii->mii_media_active |= IFM_100_TX;
293 		else if (par & DSCSR_10FDX)
294 			mii->mii_media_active |= IFM_10_T|IFM_HDX;
295 		else if (par & DSCSR_10HDX)
296 			mii->mii_media_active |= IFM_10_T;
297 	} else
298 		mii->mii_media_active = mii_media_from_bmcr(bmcr);
299 }
300