brgphy.c revision 1.16 1 /* $NetBSD: brgphy.c,v 1.16 2003/01/16 20:02:05 jonathan 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.16 2003/01/16 20:02:05 jonathan 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/socket.h>
84 #include <sys/errno.h>
85
86 #include <net/if.h>
87 #include <net/if_media.h>
88
89 #include <dev/mii/mii.h>
90 #include <dev/mii/miivar.h>
91 #include <dev/mii/miidevs.h>
92
93 #include <dev/mii/brgphyreg.h>
94
95 int brgphymatch(struct device *, struct cfdata *, void *);
96 void brgphyattach(struct device *, struct device *, void *);
97
98 CFATTACH_DECL(brgphy, sizeof(struct mii_softc),
99 brgphymatch, brgphyattach, mii_phy_detach, mii_phy_activate);
100
101 int brgphy_service(struct mii_softc *, struct mii_data *, int);
102 void brgphy_status(struct mii_softc *);
103
104 void brgphy_5401_reset(struct mii_softc *);
105 void brgphy_5411_reset(struct mii_softc *);
106 void brgphy_5703_reset(struct mii_softc *);
107 void brgphy_5704_reset(struct mii_softc *);
108
109 const struct mii_phy_funcs brgphy_funcs = {
110 brgphy_service, brgphy_status, mii_phy_reset,
111 };
112
113 const struct mii_phy_funcs brgphy_5401_funcs = {
114 brgphy_service, brgphy_status, brgphy_5401_reset,
115 };
116
117 const struct mii_phy_funcs brgphy_5411_funcs = {
118 brgphy_service, brgphy_status, brgphy_5411_reset,
119 };
120
121 const struct mii_phy_funcs brgphy_5703_funcs = {
122 brgphy_service, brgphy_status, brgphy_5703_reset,
123 };
124
125 const struct mii_phy_funcs brgphy_5704_funcs = {
126 brgphy_service, brgphy_status, brgphy_5704_reset,
127 };
128
129
130 const struct mii_phydesc brgphys[] = {
131 { MII_OUI_BROADCOM, MII_MODEL_BROADCOM_BCM5400,
132 MII_STR_BROADCOM_BCM5400 },
133
134 { MII_OUI_BROADCOM, MII_MODEL_BROADCOM_BCM5401,
135 MII_STR_BROADCOM_BCM5401 },
136
137 { MII_OUI_BROADCOM, MII_MODEL_BROADCOM_BCM5411,
138 MII_STR_BROADCOM_BCM5411 },
139
140 { MII_OUI_BROADCOM, MII_MODEL_BROADCOM_BCM5421,
141 MII_STR_BROADCOM_BCM5421 },
142
143 { MII_OUI_BROADCOM, MII_MODEL_BROADCOM_BCM5701,
144 MII_STR_BROADCOM_BCM5701 },
145
146 { MII_OUI_BROADCOM, MII_MODEL_BROADCOM_BCM5703,
147 MII_STR_BROADCOM_BCM5703 },
148
149 { MII_OUI_BROADCOM, MII_MODEL_BROADCOM_BCM5704,
150 MII_STR_BROADCOM_BCM5704 },
151
152 { 0, 0,
153 NULL },
154 };
155
156 static void bcm5401_load_dspcode(struct mii_softc *);
157 static void bcm5411_load_dspcode(struct mii_softc *);
158 static void bcm5703_load_dspcode(struct mii_softc *);
159 static void bcm5704_load_dspcode(struct mii_softc *);
160
161 int
162 brgphymatch(struct device *parent, struct cfdata *match, void *aux)
163 {
164 struct mii_attach_args *ma = aux;
165
166 if (mii_phy_match(ma, brgphys) != NULL)
167 return (10);
168
169 return (0);
170 }
171
172 void
173 brgphyattach(struct device *parent, struct device *self, void *aux)
174 {
175 struct mii_softc *sc = (struct mii_softc *)self;
176 struct mii_attach_args *ma = aux;
177 struct mii_data *mii = ma->mii_data;
178 const struct mii_phydesc *mpd;
179
180 mpd = mii_phy_match(ma, brgphys);
181 printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
182
183 sc->mii_inst = mii->mii_instance;
184 sc->mii_phy = ma->mii_phyno;
185 sc->mii_pdata = mii;
186 sc->mii_flags = ma->mii_flags;
187 sc->mii_anegticks = 5;
188
189 switch (MII_MODEL(ma->mii_id2)) {
190 case MII_MODEL_BROADCOM_BCM5400:
191 sc->mii_funcs = &brgphy_5401_funcs;
192 printf("%s: using BCM5401 DSP patch\n", sc->mii_dev.dv_xname);
193 break;
194
195 case MII_MODEL_BROADCOM_BCM5401:
196 if (MII_REV(ma->mii_id2) == 1 || MII_REV(ma->mii_id2) == 3) {
197 sc->mii_funcs = &brgphy_5401_funcs;
198 printf("%s: using BCM5401 DSP patch\n",
199 sc->mii_dev.dv_xname);
200 } else
201 sc->mii_funcs = &brgphy_funcs;
202 break;
203
204 case MII_MODEL_BROADCOM_BCM5411:
205 sc->mii_funcs = &brgphy_5411_funcs;
206 printf("%s: using BCM5411 DSP patch\n", sc->mii_dev.dv_xname);
207 break;
208
209 #ifdef notyet /* unverified, untested */
210 case MII_MODEL_BROADCOM_BCM5703:
211 sc->mii_funcs = &brgphy_5703_funcs;
212 printf("%s: using BCM5703 DSP patch\n", sc->mii_dev.dv_xname);
213 break;
214 #endif
215
216 case MII_MODEL_BROADCOM_BCM5704:
217 sc->mii_funcs = &brgphy_5704_funcs;
218 printf("%s: using BCM5704 DSP patch\n", sc->mii_dev.dv_xname);
219 break;
220
221 default:
222 sc->mii_funcs = &brgphy_funcs;
223 break;
224 }
225
226 PHY_RESET(sc);
227
228 sc->mii_capabilities =
229 PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
230 if (sc->mii_capabilities & BMSR_EXTSTAT)
231 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
232
233 printf("%s: ", sc->mii_dev.dv_xname);
234 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
235 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
236 printf("no media present");
237 else
238 mii_phy_add_media(sc);
239 printf("\n");
240 }
241
242 int
243 brgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
244 {
245 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
246 int reg;
247
248 switch (cmd) {
249 case MII_POLLSTAT:
250 /*
251 * If we're not polling our PHY instance, just return.
252 */
253 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
254 return (0);
255 break;
256
257 case MII_MEDIACHG:
258 /*
259 * If the media indicates a different PHY instance,
260 * isolate ourselves.
261 */
262 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
263 reg = PHY_READ(sc, MII_BMCR);
264 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
265 return (0);
266 }
267
268 /*
269 * If the interface is not up, don't do anything.
270 */
271 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
272 break;
273
274 mii_phy_reset(sc); /* XXX hardware bug work-around */
275 mii_phy_setmedia(sc);
276 break;
277
278 case MII_TICK:
279 /*
280 * If we're not currently selected, just return.
281 */
282 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
283 return (0);
284
285 if (mii_phy_tick(sc) == EJUSTRETURN)
286 return (0);
287 break;
288
289 case MII_DOWN:
290 mii_phy_down(sc);
291 return (0);
292 }
293
294 /* Update the media status. */
295 mii_phy_status(sc);
296
297 /*
298 * Callback if something changed. Note that we need to poke
299 * the DSP on the Broadcom PHYs if the media changes.
300 */
301 if (sc->mii_media_active != mii->mii_media_active ||
302 sc->mii_media_status != mii->mii_media_status ||
303 cmd == MII_MEDIACHG) {
304 mii_phy_update(sc, cmd);
305 if (sc->mii_funcs == &brgphy_5401_funcs)
306 bcm5401_load_dspcode(sc);
307 else if (sc->mii_funcs == &brgphy_5411_funcs)
308 bcm5411_load_dspcode(sc);
309 }
310 return (0);
311 }
312
313 void
314 brgphy_status(struct mii_softc *sc)
315 {
316 struct mii_data *mii = sc->mii_pdata;
317 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
318 int bmcr, auxsts, gtsr;
319
320 mii->mii_media_status = IFM_AVALID;
321 mii->mii_media_active = IFM_ETHER;
322
323 auxsts = PHY_READ(sc, BRGPHY_MII_AUXSTS);
324
325 if (auxsts & BRGPHY_AUXSTS_LINK)
326 mii->mii_media_status |= IFM_ACTIVE;
327
328 bmcr = PHY_READ(sc, MII_BMCR);
329 if (bmcr & BMCR_ISO) {
330 mii->mii_media_active |= IFM_NONE;
331 mii->mii_media_status = 0;
332 return;
333 }
334
335 if (bmcr & BMCR_LOOP)
336 mii->mii_media_active |= IFM_LOOP;
337
338 if (bmcr & BMCR_AUTOEN) {
339 /*
340 * The media status bits are only valid of autonegotiation
341 * has completed (or it's disabled).
342 */
343 if ((auxsts & BRGPHY_AUXSTS_ACOMP) == 0) {
344 /* Erg, still trying, I guess... */
345 mii->mii_media_active |= IFM_NONE;
346 return;
347 }
348
349 switch (auxsts & BRGPHY_AUXSTS_AN_RES) {
350 case BRGPHY_RES_1000FD:
351 mii->mii_media_active |= IFM_1000_T|IFM_FDX;
352 gtsr = PHY_READ(sc, MII_100T2SR);
353 if (gtsr & GTSR_MS_RES)
354 mii->mii_media_active |= IFM_ETH_MASTER;
355 break;
356
357 case BRGPHY_RES_1000HD:
358 mii->mii_media_active |= IFM_1000_T;
359 gtsr = PHY_READ(sc, MII_100T2SR);
360 if (gtsr & GTSR_MS_RES)
361 mii->mii_media_active |= IFM_ETH_MASTER;
362 break;
363
364 case BRGPHY_RES_100FD:
365 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
366 break;
367
368 case BRGPHY_RES_100T4:
369 mii->mii_media_active |= IFM_100_T4;
370 break;
371
372 case BRGPHY_RES_100HD:
373 mii->mii_media_active |= IFM_100_TX;
374 break;
375
376 case BRGPHY_RES_10FD:
377 mii->mii_media_active |= IFM_10_T|IFM_FDX;
378 break;
379
380 case BRGPHY_RES_10HD:
381 mii->mii_media_active |= IFM_10_T;
382 break;
383
384 default:
385 mii->mii_media_active |= IFM_NONE;
386 mii->mii_media_status = 0;
387 }
388 } else
389 mii->mii_media_active = ife->ifm_media;
390 }
391
392 void
393 brgphy_5401_reset(struct mii_softc *sc)
394 {
395
396 mii_phy_reset(sc);
397 bcm5401_load_dspcode(sc);
398 }
399
400 void
401 brgphy_5411_reset(struct mii_softc *sc)
402 {
403
404 mii_phy_reset(sc);
405 bcm5411_load_dspcode(sc);
406 }
407
408
409 void
410 brgphy_5703_reset(struct mii_softc *sc)
411 {
412
413 mii_phy_reset(sc);
414 bcm5703_load_dspcode(sc);
415 }
416
417 void
418 brgphy_5704_reset(struct mii_softc *sc)
419 {
420
421 mii_phy_reset(sc);
422 bcm5704_load_dspcode(sc);
423 }
424
425 /* Turn off tap power management on 5401. */
426 static void
427 bcm5401_load_dspcode(struct mii_softc *sc)
428 {
429 static const struct {
430 int reg;
431 uint16_t val;
432 } dspcode[] = {
433 { BRGPHY_MII_AUXCTL, 0x0c20 },
434 { BRGPHY_MII_DSP_ADDR_REG, 0x0012 },
435 { BRGPHY_MII_DSP_RW_PORT, 0x1804 },
436 { BRGPHY_MII_DSP_ADDR_REG, 0x0013 },
437 { BRGPHY_MII_DSP_RW_PORT, 0x1204 },
438 { BRGPHY_MII_DSP_ADDR_REG, 0x8006 },
439 { BRGPHY_MII_DSP_RW_PORT, 0x0132 },
440 { BRGPHY_MII_DSP_ADDR_REG, 0x8006 },
441 { BRGPHY_MII_DSP_RW_PORT, 0x0232 },
442 { BRGPHY_MII_DSP_ADDR_REG, 0x201f },
443 { BRGPHY_MII_DSP_RW_PORT, 0x0a20 },
444 { 0, 0 },
445 };
446 int i;
447
448 for (i = 0; dspcode[i].reg != 0; i++)
449 PHY_WRITE(sc, dspcode[i].reg, dspcode[i].val);
450 delay(40);
451 }
452
453 static void
454 bcm5411_load_dspcode(struct mii_softc *sc)
455 {
456 static const struct {
457 int reg;
458 uint16_t val;
459 } dspcode[] = {
460 { 0x1c, 0x8c23 },
461 { 0x1c, 0x8ca3 },
462 { 0x1c, 0x8c23 },
463 { 0, 0 },
464 };
465 int i;
466
467 for (i = 0; dspcode[i].reg != 0; i++)
468 PHY_WRITE(sc, dspcode[i].reg, dspcode[i].val);
469 }
470
471 static void
472 bcm5703_load_dspcode(struct mii_softc *sc)
473 {
474 static const struct {
475 int reg;
476 uint16_t val;
477 } dspcode[] = {
478 { BRGPHY_MII_AUXCTL, 0x0c00 },
479 { BRGPHY_MII_DSP_ADDR_REG, 0x201f },
480 { BRGPHY_MII_DSP_RW_PORT, 0x2aaa },
481 { 0, 0 },
482 };
483 int i;
484
485 for (i = 0; dspcode[i].reg != 0; i++)
486 PHY_WRITE(sc, dspcode[i].reg, dspcode[i].val);
487 }
488
489 static void
490 bcm5704_load_dspcode(struct mii_softc *sc)
491 {
492 static const struct {
493 int reg;
494 uint16_t val;
495 } dspcode[] = {
496 { 0x1c, 0x8d68 },
497 { 0x1c, 0x8d68 },
498 { 0, 0 },
499 };
500 int i;
501
502 for (i = 0; dspcode[i].reg != 0; i++)
503 PHY_WRITE(sc, dspcode[i].reg, dspcode[i].val);
504 }
505