xref: /netbsd-src/sys/dev/mii/brgphy.c (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: brgphy.c,v 1.3 2001/06/30 17:53:58 bjh21 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/param.h>
77 #include <sys/systm.h>
78 #include <sys/kernel.h>
79 #include <sys/device.h>
80 #include <sys/malloc.h>
81 #include <sys/socket.h>
82 #include <sys/errno.h>
83 
84 #include <net/if.h>
85 #include <net/if_media.h>
86 
87 #include <dev/mii/mii.h>
88 #include <dev/mii/miivar.h>
89 #include <dev/mii/miidevs.h>
90 
91 #include <dev/mii/brgphyreg.h>
92 
93 int	brgphymatch __P((struct device *, struct cfdata *, void *));
94 void	brgphyattach __P((struct device *, struct device *, void *));
95 
96 struct cfattach brgphy_ca = {
97 	sizeof(struct mii_softc), brgphymatch, brgphyattach,
98 	    mii_phy_detach, mii_phy_activate
99 };
100 
101 int	brgphy_service __P((struct mii_softc *, struct mii_data *, int));
102 void	brgphy_status __P((struct mii_softc *));
103 
104 const struct mii_phy_funcs brgphy_funcs = {
105 	brgphy_service, brgphy_status, mii_phy_reset,
106 };
107 
108 const struct mii_phydesc brgphys[] = {
109 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5400,
110 	  MII_STR_BROADCOM_BCM5400 },
111 
112 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5401,
113 	  MII_STR_BROADCOM_BCM5401 },
114 
115 	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5411,
116 	  MII_STR_BROADCOM_BCM5411 },
117 
118 	{ 0,				0,
119 	  NULL },
120 };
121 
122 int
123 brgphymatch(parent, match, aux)
124 	struct device *parent;
125 	struct cfdata *match;
126 	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(parent, self, aux)
138 	struct device *parent, *self;
139 	void *aux;
140 {
141 	struct mii_softc *sc = (struct mii_softc *)self;
142 	struct mii_attach_args *ma = aux;
143 	struct mii_data *mii = ma->mii_data;
144 	const struct mii_phydesc *mpd;
145 
146 	mpd = mii_phy_match(ma, brgphys);
147 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
148 
149 	sc->mii_inst = mii->mii_instance;
150 	sc->mii_phy = ma->mii_phyno;
151 	sc->mii_funcs = &brgphy_funcs;
152 	sc->mii_pdata = mii;
153 	sc->mii_flags = mii->mii_flags;
154 	sc->mii_anegticks = 5;
155 
156 	PHY_RESET(sc);
157 
158 	sc->mii_capabilities =
159 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
160 	if (sc->mii_capabilities & BMSR_EXTSTAT)
161 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
162 
163 	printf("%s: ", sc->mii_dev.dv_xname);
164 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
165 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
166 		printf("no media present");
167 	else
168 		mii_phy_add_media(sc);
169 	printf("\n");
170 }
171 
172 int
173 brgphy_service(sc, mii, cmd)
174 	struct mii_softc *sc;
175 	struct mii_data *mii;
176 	int cmd;
177 {
178 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
179 	int reg;
180 
181 	switch (cmd) {
182 	case MII_POLLSTAT:
183 		/*
184 		 * If we're not polling our PHY instance, just return.
185 		 */
186 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
187 			return (0);
188 		break;
189 
190 	case MII_MEDIACHG:
191 		/*
192 		 * If the media indicates a different PHY instance,
193 		 * isolate ourselves.
194 		 */
195 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
196 			reg = PHY_READ(sc, MII_BMCR);
197 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
198 			return (0);
199 		}
200 
201 		/*
202 		 * If the interface is not up, don't do anything.
203 		 */
204 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
205 			break;
206 
207 		mii_phy_setmedia(sc);
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 
217 		if (mii_phy_tick(sc) == EJUSTRETURN)
218 			return (0);
219 		break;
220 
221 	case MII_DOWN:
222 		mii_phy_down(sc);
223 		return (0);
224 	}
225 
226 	/* Update the media status. */
227 	mii_phy_status(sc);
228 
229 	/* Callback if something changed. */
230 	mii_phy_update(sc, cmd);
231 	return (0);
232 }
233 
234 void
235 brgphy_status(sc)
236 	struct mii_softc *sc;
237 {
238 	struct mii_data *mii = sc->mii_pdata;
239 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
240 	int bmcr, auxsts, gtsr;
241 
242 	mii->mii_media_status = IFM_AVALID;
243 	mii->mii_media_active = IFM_ETHER;
244 
245 	auxsts = PHY_READ(sc, BRGPHY_MII_AUXSTS);
246 
247 	if (auxsts & BRGPHY_AUXSTS_LINK)
248 		mii->mii_media_status |= IFM_ACTIVE;
249 
250 	bmcr = PHY_READ(sc, MII_BMCR);
251 	if (bmcr & BMCR_ISO) {
252 		mii->mii_media_active |= IFM_NONE;
253 		mii->mii_media_status = 0;
254 		return;
255 	}
256 
257 	if (bmcr & BMCR_LOOP)
258 		mii->mii_media_active |= IFM_LOOP;
259 
260 	if (bmcr & BMCR_AUTOEN) {
261 		/*
262 		 * The media status bits are only valid of autonegotiation
263 		 * has completed (or it's disabled).
264 		 */
265 		if ((auxsts & BRGPHY_AUXSTS_ACOMP) == 0) {
266 			/* Erg, still trying, I guess... */
267 			mii->mii_media_active |= IFM_NONE;
268 			return;
269 		}
270 
271 		switch (auxsts & BRGPHY_AUXSTS_AN_RES) {
272 		case BRGPHY_RES_1000FD:
273 			mii->mii_media_active |= IFM_1000_T|IFM_FDX;
274 			gtsr = PHY_READ(sc, MII_100T2SR);
275 			if (gtsr & GTSR_MS_RES)
276 				mii->mii_media_active |= IFM_ETH_MASTER;
277 			break;
278 
279 		case BRGPHY_RES_1000HD:
280 			mii->mii_media_active |= IFM_1000_T;
281 			gtsr = PHY_READ(sc, MII_100T2SR);
282 			if (gtsr & GTSR_MS_RES)
283 				mii->mii_media_active |= IFM_ETH_MASTER;
284 			break;
285 
286 		case BRGPHY_RES_100FD:
287 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
288 			break;
289 
290 		case BRGPHY_RES_100T4:
291 			mii->mii_media_active |= IFM_100_T4;
292 			break;
293 
294 		case BRGPHY_RES_100HD:
295 			mii->mii_media_active |= IFM_100_TX;
296 			break;
297 
298 		case BRGPHY_RES_10FD:
299 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
300 			break;
301 
302 		case BRGPHY_RES_10HD:
303 			mii->mii_media_active |= IFM_10_T;
304 			break;
305 
306 		default:
307 			mii->mii_media_active |= IFM_NONE;
308 			mii->mii_media_status = 0;
309 		}
310 	} else
311 		mii->mii_media_active = ife->ifm_media;
312 }
313