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