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