if_ate.c revision 1.28 1 /* $NetBSD: if_ate.c,v 1.28 2001/11/13 08:01:16 lukem Exp $ */
2
3 /*
4 * All Rights Reserved, Copyright (C) Fujitsu Limited 1995
5 *
6 * This software may be used, modified, copied, distributed, and sold, in
7 * both source and binary form provided that the above copyright, these
8 * terms and the following disclaimer are retained. The name of the author
9 * and/or the contributor may not be used to endorse or promote products
10 * derived from this software without specific prior written permission.
11 *
12 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND THE CONTRIBUTOR ``AS IS'' AND
13 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTOR BE LIABLE
16 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION.
19 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22 * SUCH DAMAGE.
23 */
24
25 /*
26 * Portions copyright (C) 1993, David Greenman. This software may be used,
27 * modified, copied, distributed, and sold, in both source and binary form
28 * provided that the above copyright and these terms are retained. Under no
29 * circumstances is the author responsible for the proper functioning of this
30 * software, nor does the author assume any responsibility for damages
31 * incurred with its use.
32 */
33
34 #include <sys/cdefs.h>
35 __KERNEL_RCSID(0, "$NetBSD: if_ate.c,v 1.28 2001/11/13 08:01:16 lukem Exp $");
36
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/device.h>
40 #include <sys/socket.h>
41 #include <sys/syslog.h>
42
43 #include <net/if.h>
44 #include <net/if_ether.h>
45 #include <net/if_media.h>
46
47 #include <machine/bus.h>
48 #include <machine/intr.h>
49
50 #include <dev/ic/mb86960reg.h>
51 #include <dev/ic/mb86960var.h>
52 #include <dev/ic/ate_subr.h>
53
54 #include <dev/isa/isavar.h>
55 #include <dev/isa/if_fereg.h> /* XXX */
56
57 int ate_match __P((struct device *, struct cfdata *, void *));
58 void ate_attach __P((struct device *, struct device *, void *));
59
60 struct ate_softc {
61 struct mb86960_softc sc_mb86960; /* real "mb86960" softc */
62
63 /* ISA-specific goo. */
64 void *sc_ih; /* interrupt cookie */
65 };
66
67 struct cfattach ate_isa_ca = {
68 sizeof(struct ate_softc), ate_match, ate_attach
69 };
70
71 #if NetBSD <= 199712
72 struct cfdriver ate_isa_cd = {
73 NULL, "ate", DV_IFNET
74 };
75 #endif
76
77 struct fe_simple_probe_struct {
78 u_char port; /* Offset from the base I/O address. */
79 u_char mask; /* Bits to be checked. */
80 u_char bits; /* Values to be compared against. */
81 };
82
83 static __inline__ int fe_simple_probe __P((bus_space_tag_t,
84 bus_space_handle_t, struct fe_simple_probe_struct const *));
85 static int ate_find __P((bus_space_tag_t, bus_space_handle_t, int *,
86 int *));
87 static int ate_detect __P((bus_space_tag_t, bus_space_handle_t,
88 u_int8_t enaddr[ETHER_ADDR_LEN]));
89
90 static int const ate_iomap[8] = {
91 0x260, 0x280, 0x2A0, 0x240, 0x340, 0x320, 0x380, 0x300
92 };
93 #define NATE_IOMAP (sizeof (ate_iomap) / sizeof (ate_iomap[0]))
94 #define ATE_NPORTS 0x20
95
96 /*
97 * Hardware probe routines.
98 */
99
100 /*
101 * Determine if the device is present.
102 */
103 int
104 ate_match(parent, match, aux)
105 struct device *parent;
106 struct cfdata *match;
107 void *aux;
108 {
109 struct isa_attach_args *ia = aux;
110 bus_space_tag_t iot = ia->ia_iot;
111 bus_space_handle_t ioh;
112 int i, iobase, irq, rv = 0;
113 u_int8_t myea[ETHER_ADDR_LEN];
114
115 /* Disallow wildcarded values. */
116 if (ia->ia_iobase == ISACF_PORT_DEFAULT)
117 return (0);
118
119 /*
120 * See if the sepcified address is valid for MB86965A JLI mode.
121 */
122 for (i = 0; i < NATE_IOMAP; i++)
123 if (ate_iomap[i] == ia->ia_iobase)
124 break;
125 if (i == NATE_IOMAP) {
126 #ifdef ATE_DEBUG
127 printf("ate_match: unknown iobase 0x%x\n", ia->ia_iobase);
128 #endif
129 return (0);
130 }
131
132 /* Map i/o space. */
133 if (bus_space_map(iot, ia->ia_iobase, ATE_NPORTS, 0, &ioh)) {
134 #ifdef ATE_DEBUG
135 printf("ate_match: couldn't map iospace 0x%x\n",
136 ia->ia_iobase);
137 #endif
138 return (0);
139 }
140
141 if (ate_find(iot, ioh, &iobase, &irq) == 0) {
142 #ifdef ATE_DEBUG
143 printf("ate_match: ate_find failed\n");
144 #endif
145 goto out;
146 }
147
148 if (iobase != ia->ia_iobase) {
149 #ifdef ATE_DEBUG
150 printf("ate_match: unexpected iobase in board: 0x%x\n",
151 ia->ia_iobase);
152 #endif
153 goto out;
154 }
155
156 if (ate_detect(iot, ioh, myea) == 0) { /* XXX necessary? */
157 #ifdef ATE_DEBUG
158 printf("ate_match: ate_detect failed\n");
159 #endif
160 goto out;
161 }
162
163 if (ia->ia_irq != ISACF_IRQ_DEFAULT) {
164 if (ia->ia_irq != irq) {
165 printf("ate_match: irq mismatch; "
166 "kernel configured %d != board configured %d\n",
167 ia->ia_irq, irq);
168 goto out;
169 }
170 } else
171 ia->ia_irq = irq;
172
173 ia->ia_iosize = ATE_NPORTS;
174 ia->ia_msize = 0;
175 rv = 1;
176
177 out:
178 bus_space_unmap(iot, ioh, ATE_NPORTS);
179 return (rv);
180 }
181
182 /*
183 * Check for specific bits in specific registers have specific values.
184 */
185 static __inline__ int
186 fe_simple_probe (iot, ioh, sp)
187 bus_space_tag_t iot;
188 bus_space_handle_t ioh;
189 struct fe_simple_probe_struct const *sp;
190 {
191 u_int8_t val;
192 struct fe_simple_probe_struct const *p;
193
194 for (p = sp; p->mask != 0; p++) {
195 val = bus_space_read_1(iot, ioh, p->port);
196 if ((val & p->mask) != p->bits) {
197 #ifdef ATE_DEBUG
198 printf("fe_simple_probe: %x & %x != %x\n",
199 val, p->mask, p->bits);
200 #endif
201 return (0);
202 }
203 }
204
205 return (1);
206 }
207
208 /*
209 * Hardware (vendor) specific probe routines.
210 */
211
212 /*
213 * Probe and initialization for Allied-Telesis AT1700/RE2000 series.
214 */
215 static int
216 ate_find(iot, ioh, iobase, irq)
217 bus_space_tag_t iot;
218 bus_space_handle_t ioh;
219 int *iobase, *irq;
220 {
221 u_char eeprom[FE_EEPROM_SIZE];
222 int n;
223
224 static int const irqmap[4][4] = {
225 { 3, 4, 5, 9 },
226 { 10, 11, 12, 15 },
227 { 3, 11, 5, 15 },
228 { 10, 11, 14, 15 },
229 };
230 static struct fe_simple_probe_struct const probe_table[] = {
231 { FE_DLCR2, 0x70, 0x00 },
232 { FE_DLCR4, 0x08, 0x00 },
233 { FE_DLCR5, 0x80, 0x00 },
234 #if 0
235 { FE_BMPR16, 0x1B, 0x00 },
236 { FE_BMPR17, 0x7F, 0x00 },
237 #endif
238 { 0 }
239 };
240
241 #if ATE_DEBUG >= 4
242 log(LOG_INFO, "ate_find: probe (0x%x) for ATI\n", iobase);
243 #if 0
244 fe_dump(LOG_INFO, sc);
245 #endif
246 #endif
247
248 /*
249 * We should test if MB86965A is on the base address now.
250 * Unfortunately, it is very hard to probe it reliably, since
251 * we have no way to reset the chip under software control.
252 * On cold boot, we could check the "signature" bit patterns
253 * described in the Fujitsu document. On warm boot, however,
254 * we can predict almost nothing about register values.
255 */
256 if (!fe_simple_probe(iot, ioh, probe_table))
257 return (0);
258
259 /* Check if our I/O address matches config info on 86965. */
260 n = (bus_space_read_1(iot, ioh, FE_BMPR19) & FE_B19_ADDR)
261 >> FE_B19_ADDR_SHIFT;
262 *iobase = ate_iomap[n];
263
264 /*
265 * We are now almost sure we have an AT1700 at the given
266 * address. So, read EEPROM through 86965. We have to write
267 * into LSI registers to read from EEPROM. I want to avoid it
268 * at this stage, but I cannot test the presense of the chip
269 * any further without reading EEPROM. FIXME.
270 */
271 ate_read_eeprom(iot, ioh, eeprom);
272
273 /* Make sure that config info in EEPROM and 86965 agree. */
274 if (eeprom[FE_EEPROM_CONF] != bus_space_read_1(iot, ioh, FE_BMPR19)) {
275 #ifdef DIAGNOSTIC
276 printf("ate_find: "
277 "incorrect configration in eeprom and chip\n");
278 #endif
279 return (0);
280 }
281
282 /*
283 * Try to determine IRQ settings.
284 * Different models use different ranges of IRQs.
285 */
286 n = (bus_space_read_1(iot, ioh, FE_BMPR19) & FE_B19_IRQ)
287 >> FE_B19_IRQ_SHIFT;
288 switch (eeprom[FE_ATI_EEP_REVISION] & 0xf0) {
289 case 0x30:
290 *irq = irqmap[3][n];
291 break;
292 case 0x10:
293 case 0x50:
294 *irq = irqmap[2][n];
295 break;
296 case 0x40:
297 case 0x60:
298 if (eeprom[FE_ATI_EEP_MAGIC] & 0x04) {
299 *irq = irqmap[1][n];
300 break;
301 }
302 default:
303 *irq = irqmap[0][n];
304 break;
305 }
306
307 return (1);
308 }
309
310 /*
311 * Determine type and ethernet address.
312 */
313 static int
314 ate_detect(iot, ioh, enaddr)
315 bus_space_tag_t iot;
316 bus_space_handle_t ioh;
317 u_int8_t enaddr[ETHER_ADDR_LEN];
318 {
319 u_char eeprom[FE_EEPROM_SIZE];
320 int type;
321
322 /* Get our station address from EEPROM. */
323 ate_read_eeprom(iot, ioh, eeprom);
324 memcpy(enaddr, eeprom + FE_ATI_EEP_ADDR, ETHER_ADDR_LEN);
325
326 /* Make sure we got a valid station address. */
327 if ((enaddr[0] & 0x03) != 0x00 ||
328 (enaddr[0] == 0x00 && enaddr[1] == 0x00 && enaddr[2] == 0x00)) {
329 #ifdef ATE_DEBUG
330 printf("fmv_detect: invalid ethernet address\n");
331 #endif
332 return (0);
333 }
334
335 /*
336 * Determine the card type.
337 */
338 switch (eeprom[FE_ATI_EEP_MODEL]) {
339 case FE_ATI_MODEL_AT1700T:
340 type = FE_TYPE_AT1700T;
341 break;
342 case FE_ATI_MODEL_AT1700BT:
343 type = FE_TYPE_AT1700BT;
344 break;
345 case FE_ATI_MODEL_AT1700FT:
346 type = FE_TYPE_AT1700FT;
347 break;
348 case FE_ATI_MODEL_AT1700AT:
349 type = FE_TYPE_AT1700AT;
350 break;
351 default:
352 type = FE_TYPE_RE2000;
353 break;
354 }
355
356 return (type);
357 }
358
359 void
360 ate_attach(parent, self, aux)
361 struct device *parent, *self;
362 void *aux;
363 {
364 struct ate_softc *isc = (struct ate_softc *)self;
365 struct mb86960_softc *sc = &isc->sc_mb86960;
366 struct isa_attach_args *ia = aux;
367 bus_space_tag_t iot = ia->ia_iot;
368 bus_space_handle_t ioh;
369 u_int8_t myea[ETHER_ADDR_LEN];
370 const char *typestr;
371 int type;
372
373 printf("\n");
374
375 /* Map i/o space. */
376 if (bus_space_map(iot, ia->ia_iobase, ATE_NPORTS, 0, &ioh)) {
377 printf("%s: can't map i/o space\n", sc->sc_dev.dv_xname);
378 return;
379 }
380
381 sc->sc_bst = iot;
382 sc->sc_bsh = ioh;
383
384 /* Determine the card type and get ethernet address. */
385 type = ate_detect(iot, ioh, myea);
386 switch (type) {
387 case FE_TYPE_AT1700T:
388 typestr = "AT-1700T";
389 break;
390 case FE_TYPE_AT1700BT:
391 typestr = "AT-1700BT";
392 break;
393 case FE_TYPE_AT1700FT:
394 typestr = "AT-1700FT";
395 break;
396 case FE_TYPE_AT1700AT:
397 typestr = "AT-1700AT";
398 break;
399 case FE_TYPE_RE2000:
400 typestr = "unknown (RE-2000?)";
401 break;
402
403 default:
404 /* Unknown card type: maybe a new model, but... */
405 printf("%s: where did the card go?!\n", sc->sc_dev.dv_xname);
406 panic("unknown card");
407 }
408
409 printf("%s: %s Ethernet\n", sc->sc_dev.dv_xname, typestr);
410
411 /* This interface is always enabled. */
412 sc->sc_flags |= FE_FLAGS_ENABLED;
413
414 /*
415 * Do generic MB86960 attach.
416 */
417 mb86960_attach(sc, MB86960_TYPE_86965, myea);
418
419 mb86960_config(sc, NULL, 0, 0);
420
421 /* Establish the interrupt handler. */
422 isc->sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq, IST_EDGE,
423 IPL_NET, mb86960_intr, sc);
424 if (isc->sc_ih == NULL)
425 printf("%s: couldn't establish interrupt handler\n",
426 sc->sc_dev.dv_xname);
427 }
428