if_ie_obio.c revision 1.14 1 /* $NetBSD: if_ie_obio.c,v 1.14 2000/05/09 22:42:08 pk Exp $ */
2
3 /*-
4 * Copyright (c) 1997 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Paul Kranenburg.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 /*-
40 * Copyright (c) 1995 Charles D. Cranor
41 * 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 Charles D. Cranor.
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
71 /*
72 * Sparc OBIO front-end for the Intel 82586 Ethernet driver
73 *
74 * Converted to SUN ie driver by Charles D. Cranor,
75 * October 1994, January 1995.
76 */
77
78 /*
79 * The i82586 is a very painful chip, found in sun3's, sun-4/100's
80 * sun-4/200's, and VME based suns. The byte order is all wrong for a
81 * SUN, making life difficult. Programming this chip is mostly the same,
82 * but certain details differ from system to system. This driver is
83 * written so that different "ie" interfaces can be controled by the same
84 * driver.
85 */
86
87 #include <sys/param.h>
88 #include <sys/systm.h>
89 #include <sys/errno.h>
90 #include <sys/device.h>
91 #include <sys/malloc.h>
92 #include <sys/protosw.h>
93 #include <sys/socket.h>
94
95 #include <net/if.h>
96 #include <net/if_types.h>
97 #include <net/if_dl.h>
98 #include <net/if_media.h>
99 #include <net/if_ether.h>
100
101 #include <vm/vm.h>
102
103 #include <machine/autoconf.h>
104 #include <machine/cpu.h>
105 #include <machine/pmap.h>
106 #include <machine/bus.h>
107
108 #include <dev/ic/i82586reg.h>
109 #include <dev/ic/i82586var.h>
110
111 /*
112 * the on-board interface
113 */
114 struct ieob {
115 u_char obctrl;
116 };
117 #define IEOB_NORSET 0x80 /* don't reset the board */
118 #define IEOB_ONAIR 0x40 /* put us on the air */
119 #define IEOB_ATTEN 0x20 /* attention! */
120 #define IEOB_IENAB 0x10 /* interrupt enable */
121 #define IEOB_XXXXX 0x08 /* free bit */
122 #define IEOB_XCVRL2 0x04 /* level 2 transceiver? */
123 #define IEOB_BUSERR 0x02 /* bus error */
124 #define IEOB_INT 0x01 /* interrupt */
125
126 #define IEOB_ADBASE 0xff000000 /* KVA base addr of 24 bit address space */
127
128
129 static void ie_obreset __P((struct ie_softc *, int));
130 static void ie_obattend __P((struct ie_softc *));
131 static void ie_obrun __P((struct ie_softc *));
132
133 int ie_obio_match __P((struct device *, struct cfdata *, void *));
134 void ie_obio_attach __P((struct device *, struct device *, void *));
135
136 struct cfattach ie_obio_ca = {
137 sizeof(struct ie_softc), ie_obio_match, ie_obio_attach
138 };
139
140 /* Supported media */
141 static int media[] = {
142 IFM_ETHER | IFM_10_2,
143 };
144 #define NMEDIA (sizeof(media) / sizeof(media[0]))
145
146
147 /*
148 * OBIO ie support routines
149 */
150 void
151 ie_obreset(sc, what)
152 struct ie_softc *sc;
153 {
154 volatile struct ieob *ieo = (struct ieob *) sc->sc_reg;
155 ieo->obctrl = 0;
156 delay(100); /* XXX could be shorter? */
157 ieo->obctrl = IEOB_NORSET;
158 }
159 void
160 ie_obattend(sc)
161 struct ie_softc *sc;
162 {
163 volatile struct ieob *ieo = (struct ieob *) sc->sc_reg;
164
165 ieo->obctrl |= IEOB_ATTEN; /* flag! */
166 ieo->obctrl &= ~IEOB_ATTEN; /* down. */
167 }
168
169 void
170 ie_obrun(sc)
171 struct ie_softc *sc;
172 {
173 volatile struct ieob *ieo = (struct ieob *) sc->sc_reg;
174
175 ieo->obctrl |= (IEOB_ONAIR|IEOB_IENAB|IEOB_NORSET);
176 }
177
178 void ie_obio_memcopyin __P((struct ie_softc *, void *, int, size_t));
179 void ie_obio_memcopyout __P((struct ie_softc *, const void *, int, size_t));
180
181 /*
182 * Copy board memory to kernel.
183 */
184 void
185 ie_obio_memcopyin(sc, p, offset, size)
186 struct ie_softc *sc;
187 void *p;
188 int offset;
189 size_t size;
190 {
191 void *addr = (void *)((u_long)sc->bh + offset);/*XXX - not MI!*/
192 wcopy(addr, p, size);
193 }
194
195 /*
196 * Copy from kernel space to naord memory.
197 */
198 void
199 ie_obio_memcopyout(sc, p, offset, size)
200 struct ie_softc *sc;
201 const void *p;
202 int offset;
203 size_t size;
204 {
205 void *addr = (void *)((u_long)sc->bh + offset);/*XXX - not MI!*/
206 wcopy(p, addr, size);
207 }
208
209 /* read a 16-bit value at BH offset */
210 u_int16_t ie_obio_read16 __P((struct ie_softc *, int offset));
211 /* write a 16-bit value at BH offset */
212 void ie_obio_write16 __P((struct ie_softc *, int offset, u_int16_t value));
213 void ie_obio_write24 __P((struct ie_softc *, int offset, int addr));
214
215 u_int16_t
216 ie_obio_read16(sc, offset)
217 struct ie_softc *sc;
218 int offset;
219 {
220 u_int16_t v = bus_space_read_2(sc->bt, sc->bh, offset);
221 return (((v&0xff)<<8) | ((v>>8)&0xff));
222 }
223
224 void
225 ie_obio_write16(sc, offset, v)
226 struct ie_softc *sc;
227 int offset;
228 u_int16_t v;
229 {
230 v = (((v&0xff)<<8) | ((v>>8)&0xff));
231 bus_space_write_2(sc->bt, sc->bh, offset, v);
232 }
233
234 void
235 ie_obio_write24(sc, offset, addr)
236 struct ie_softc *sc;
237 int offset;
238 int addr;
239 {
240 u_char *f = (u_char *)&addr;
241 u_int16_t v0, v1;
242 u_char *t;
243
244 t = (u_char *)&v0;
245 t[0] = f[3]; t[1] = f[2];
246 bus_space_write_2(sc->bt, sc->bh, offset, v0);
247
248 t = (u_char *)&v1;
249 t[0] = f[1]; t[1] = 0;
250 bus_space_write_2(sc->bt, sc->bh, offset+2, v1);
251 }
252
253 int
254 ie_obio_match(parent, cf, aux)
255 struct device *parent;
256 struct cfdata *cf;
257 void *aux;
258 {
259 union obio_attach_args *uoba = aux;
260 struct obio4_attach_args *oba;
261
262 if (uoba->uoba_isobio4 == 0)
263 return (0);
264
265 oba = &uoba->uoba_oba4;
266 return (bus_space_probe(oba->oba_bustag, 0, oba->oba_paddr,
267 1, /* probe size */
268 0, /* offset */
269 0, /* flags */
270 NULL, NULL));
271 }
272
273 void
274 ie_obio_attach(parent, self, aux)
275 struct device *parent;
276 struct device *self;
277 void *aux;
278 {
279 union obio_attach_args *uoba = aux;
280 struct obio4_attach_args *oba = &uoba->uoba_oba4;
281 struct ie_softc *sc = (void *) self;
282 bus_dma_tag_t dmatag = oba->oba_dmatag;
283 bus_space_handle_t bh;
284 bus_dma_segment_t seg;
285 int rseg;
286 int error;
287 paddr_t pa;
288 struct intrhand *ih;
289 bus_size_t msize;
290 u_long iebase;
291 u_int8_t myaddr[ETHER_ADDR_LEN];
292 extern void myetheraddr(u_char *); /* should be elsewhere */
293
294 sc->bt = oba->oba_bustag;
295
296 sc->hwreset = ie_obreset;
297 sc->chan_attn = ie_obattend;
298 sc->hwinit = ie_obrun;
299 sc->memcopyout = ie_obio_memcopyout;
300 sc->memcopyin = ie_obio_memcopyin;
301 sc->ie_bus_read16 = ie_obio_read16;
302 sc->ie_bus_write16 = ie_obio_write16;
303 sc->ie_bus_write24 = ie_obio_write24;
304 sc->sc_msize = msize = 65536; /* XXX */
305
306 if (obio_bus_map(oba->oba_bustag, oba->oba_paddr,
307 0,
308 sizeof(struct ieob),
309 BUS_SPACE_MAP_LINEAR,
310 0, &bh) != 0) {
311 printf("%s: cannot map registers\n", self->dv_xname);
312 return;
313 }
314 sc->sc_reg = (void *)bh;
315
316 /*
317 * Allocate control & buffer memory.
318 */
319 if ((error = bus_dmamap_create(dmatag, msize, 1, msize, NBPG,
320 BUS_DMA_NOWAIT|BUS_DMA_24BIT,
321 &sc->sc_dmamap)) != 0) {
322 printf("%s: DMA map create error %d\n",
323 sc->sc_dev.dv_xname, error);
324 return;
325 }
326 if ((error = bus_dmamem_alloc(dmatag, msize, 64*1024, 0,
327 &seg, 1, &rseg,
328 BUS_DMA_NOWAIT | BUS_DMA_24BIT)) != 0) {
329 printf("%s: DMA memory allocation error %d\n",
330 self->dv_xname, error);
331 return;
332 }
333
334 /* Map DMA buffer in CPU addressable space */
335 if ((error = bus_dmamem_map(dmatag, &seg, rseg, msize,
336 (caddr_t *)&sc->sc_maddr,
337 BUS_DMA_NOWAIT|BUS_DMA_COHERENT)) != 0) {
338 printf("%s: DMA buffer map error %d\n",
339 sc->sc_dev.dv_xname, error);
340 bus_dmamem_free(dmatag, &seg, rseg);
341 return;
342 }
343
344 /* Load the segment */
345 if ((error = bus_dmamap_load_raw(dmatag, sc->sc_dmamap,
346 &seg, rseg, msize, BUS_DMA_NOWAIT)) != 0) {
347 printf("%s: DMA buffer map load error %d\n",
348 sc->sc_dev.dv_xname, error);
349 bus_dmamem_unmap(dmatag, sc->sc_maddr, msize);
350 bus_dmamem_free(dmatag, &seg, rseg);
351 return;
352 }
353
354 wzero(sc->sc_maddr, msize);
355 sc->bh = (bus_space_handle_t)(sc->sc_maddr);
356
357 /*
358 * The i82586's 24-bit address space maps to the last 16MB of
359 * KVA space (). In addition, the SCP must appear
360 * at IE_SCP_ADDR within the 24-bit address space,
361 * i.e. at KVA IEOB_ADBASE+IE_SCP_ADDR, at the very top of
362 * kernel space. We double-map this last page to the first
363 * page (starting at `maddr') of the memory we allocate to the chip.
364 * (a side-effect of this double-map is that the ISCP and SCB
365 * structures also get aliased there, but we ignore this). The
366 * first page at `maddr' is only used for ISCP, SCB and the aliased
367 * SCP; the actual buffers start at maddr+NBPG.
368 *
369 * In a picture:
370
371 |---//--- ISCP-SCB-----scp-|--//- buffers -//-|... |iscp-scb-----SCP-|
372 | | | | | | |
373 | |<----- NBPG --->| | |<----- NBPG -+-->|
374 | |<------------- msize ------------->| | ^ |
375 | | | |
376 | \@maddr (last page dbl mapped)
377 | |
378 \@IEOB_ADBASE @IEOB_ADBASE+IE_SCP_ADDR-+
379
380 *
381 */
382
383 /* Double map the SCP */
384 if (pmap_extract(pmap_kernel(), (vaddr_t)sc->sc_maddr, &pa) == FALSE)
385 panic("ie pmap_extract");
386
387 pmap_enter(pmap_kernel(), trunc_page(IEOB_ADBASE+IE_SCP_ADDR),
388 pa | PMAP_NC /*| PMAP_IOC*/,
389 VM_PROT_READ | VM_PROT_WRITE, PMAP_WIRED);
390
391 /* Map iscp at location 0 (relative to `maddr') */
392 sc->iscp = 0;
393
394 /* scb follows iscp */
395 sc->scb = IE_ISCP_SZ;
396
397 /* scp is at the fixed location IE_SCP_ADDR (modulo the page size) */
398 sc->scp = IE_SCP_ADDR & PGOFSET;
399
400 /* Calculate the 24-bit base of i82586 operations */
401 iebase = (u_long)sc->sc_dmamap->dm_segs[0].ds_addr -
402 (u_long)IEOB_ADBASE;
403 ie_obio_write16(sc, IE_ISCP_SCB(sc->iscp), sc->scb);
404 ie_obio_write24(sc, IE_ISCP_BASE(sc->iscp), iebase);
405 ie_obio_write24(sc, IE_SCP_ISCP(sc->scp), iebase + sc->iscp);
406
407 /*
408 * Rest of first page is unused (wasted!); the other pages
409 * are used for buffers.
410 */
411 sc->buf_area = NBPG;
412 sc->buf_area_sz = msize - NBPG;
413
414 if (i82586_proberam(sc) == 0) {
415 printf(": memory probe failed\n");
416 return;
417 }
418
419 myetheraddr(myaddr);
420 i82586_attach(sc, "onboard", myaddr, media, NMEDIA, media[0]);
421
422 /* Establish interrupt channel */
423 ih = bus_intr_establish(oba->oba_bustag,
424 oba->oba_pri, 0,
425 i82586_intr, sc);
426 }
427