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