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