xref: /netbsd/sys/dev/mii/brgphy.c (revision bf9ec67e)
1 /*	$NetBSD: brgphy.c,v 1.6 2002/03/25 20:51:24 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 /*
41  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by Manuel Bouyer.
54  * 4. The name of the author may not be used to endorse or promote products
55  *    derived from this software without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  */
68 
69 /*
70  * driver for the Broadcom BCM5400 Gig-E PHY.
71  *
72  * Programming information for this PHY was gleaned from FreeBSD
73  * (they were apparently able to get a datasheet from Broadcom).
74  */
75 
76 #include <sys/cdefs.h>
77 __KERNEL_RCSID(0, "$NetBSD: brgphy.c,v 1.6 2002/03/25 20:51:24 thorpej Exp $");
78 
79 #include <sys/param.h>
80 #include <sys/systm.h>
81 #include <sys/kernel.h>
82 #include <sys/device.h>
83 #include <sys/malloc.h>
84 #include <sys/socket.h>
85 #include <sys/errno.h>
86 
87 #include <net/if.h>
88 #include <net/if_media.h>
89 
90 #include <dev/mii/mii.h>
91 #include <dev/mii/miivar.h>
92 #include <dev/mii/miidevs.h>
93 
94 #include <dev/mii/brgphyreg.h>
95 
96 int	brgphymatch(struct device *, struct cfdata *, void *);
97 void	brgphyattach(struct device *, struct device *, void *);
98 
99 struct cfattach brgphy_ca = {
100 	sizeof(struct mii_softc), brgphymatch, brgphyattach,
101 	    mii_phy_detach, mii_phy_activate
102 };
103 
104 int	brgphy_service(struct mii_softc *, struct mii_data *, int);
105 void	brgphy_status(struct mii_softc *);
106 
107 const struct mii_phy_funcs brgphy_funcs = {
108 	brgphy_service, brgphy_status, mii_phy_reset,
109 };
110 
111 const struct mii_phydesc brgphys[] = {
112 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5400,
113 	  MII_STR_BROADCOM_BCM5400 },
114 
115 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5401,
116 	  MII_STR_BROADCOM_BCM5401 },
117 
118 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5411,
119 	  MII_STR_BROADCOM_BCM5411 },
120 
121 	{ 0,				0,
122 	  NULL },
123 };
124 
125 int
126 brgphymatch(struct device *parent, struct cfdata *match, void *aux)
127 {
128 	struct mii_attach_args *ma = aux;
129 
130 	if (mii_phy_match(ma, brgphys) != NULL)
131 		return (10);
132 
133 	return (0);
134 }
135 
136 void
137 brgphyattach(struct device *parent, struct device *self, void *aux)
138 {
139 	struct mii_softc *sc = (struct mii_softc *)self;
140 	struct mii_attach_args *ma = aux;
141 	struct mii_data *mii = ma->mii_data;
142 	const struct mii_phydesc *mpd;
143 
144 	mpd = mii_phy_match(ma, brgphys);
145 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
146 
147 	sc->mii_inst = mii->mii_instance;
148 	sc->mii_phy = ma->mii_phyno;
149 	sc->mii_funcs = &brgphy_funcs;
150 	sc->mii_pdata = mii;
151 	sc->mii_flags = ma->mii_flags;
152 	sc->mii_anegticks = 5;
153 
154 	PHY_RESET(sc);
155 
156 	sc->mii_capabilities =
157 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
158 	if (sc->mii_capabilities & BMSR_EXTSTAT)
159 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
160 
161 	printf("%s: ", sc->mii_dev.dv_xname);
162 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
163 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
164 		printf("no media present");
165 	else
166 		mii_phy_add_media(sc);
167 	printf("\n");
168 }
169 
170 int
171 brgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
172 {
173 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
174 	int reg;
175 
176 	switch (cmd) {
177 	case MII_POLLSTAT:
178 		/*
179 		 * If we're not polling our PHY instance, just return.
180 		 */
181 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
182 			return (0);
183 		break;
184 
185 	case MII_MEDIACHG:
186 		/*
187 		 * If the media indicates a different PHY instance,
188 		 * isolate ourselves.
189 		 */
190 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
191 			reg = PHY_READ(sc, MII_BMCR);
192 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
193 			return (0);
194 		}
195 
196 		/*
197 		 * If the interface is not up, don't do anything.
198 		 */
199 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
200 			break;
201 
202 		mii_phy_setmedia(sc);
203 		break;
204 
205 	case MII_TICK:
206 		/*
207 		 * If we're not currently selected, just return.
208 		 */
209 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
210 			return (0);
211 
212 		if (mii_phy_tick(sc) == EJUSTRETURN)
213 			return (0);
214 		break;
215 
216 	case MII_DOWN:
217 		mii_phy_down(sc);
218 		return (0);
219 	}
220 
221 	/* Update the media status. */
222 	mii_phy_status(sc);
223 
224 	/* Callback if something changed. */
225 	mii_phy_update(sc, cmd);
226 	return (0);
227 }
228 
229 void
230 brgphy_status(struct mii_softc *sc)
231 {
232 	struct mii_data *mii = sc->mii_pdata;
233 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
234 	int bmcr, auxsts, gtsr;
235 
236 	mii->mii_media_status = IFM_AVALID;
237 	mii->mii_media_active = IFM_ETHER;
238 
239 	auxsts = PHY_READ(sc, BRGPHY_MII_AUXSTS);
240 
241 	if (auxsts & BRGPHY_AUXSTS_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 media status bits are only valid of autonegotiation
257 		 * has completed (or it's disabled).
258 		 */
259 		if ((auxsts & BRGPHY_AUXSTS_ACOMP) == 0) {
260 			/* Erg, still trying, I guess... */
261 			mii->mii_media_active |= IFM_NONE;
262 			return;
263 		}
264 
265 		switch (auxsts & BRGPHY_AUXSTS_AN_RES) {
266 		case BRGPHY_RES_1000FD:
267 			mii->mii_media_active |= IFM_1000_T|IFM_FDX;
268 			gtsr = PHY_READ(sc, MII_100T2SR);
269 			if (gtsr & GTSR_MS_RES)
270 				mii->mii_media_active |= IFM_ETH_MASTER;
271 			break;
272 
273 		case BRGPHY_RES_1000HD:
274 			mii->mii_media_active |= IFM_1000_T;
275 			gtsr = PHY_READ(sc, MII_100T2SR);
276 			if (gtsr & GTSR_MS_RES)
277 				mii->mii_media_active |= IFM_ETH_MASTER;
278 			break;
279 
280 		case BRGPHY_RES_100FD:
281 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
282 			break;
283 
284 		case BRGPHY_RES_100T4:
285 			mii->mii_media_active |= IFM_100_T4;
286 			break;
287 
288 		case BRGPHY_RES_100HD:
289 			mii->mii_media_active |= IFM_100_TX;
290 			break;
291 
292 		case BRGPHY_RES_10FD:
293 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
294 			break;
295 
296 		case BRGPHY_RES_10HD:
297 			mii->mii_media_active |= IFM_10_T;
298 			break;
299 
300 		default:
301 			mii->mii_media_active |= IFM_NONE;
302 			mii->mii_media_status = 0;
303 		}
304 	} else
305 		mii->mii_media_active = ife->ifm_media;
306 }
307