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