xref: /netbsd-src/sys/arch/sparc/dev/if_ie_obio.c (revision 481fca6e59249d8ffcf24fef7cfbe7b131bfb080)
1 /*	$NetBSD: if_ie_obio.c,v 1.17 2000/07/09 20:57:47 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 <uvm/uvm_extern.h>
102 
103 #include <machine/bus.h>
104 #include <machine/intr.h>
105 #include <machine/autoconf.h>
106 
107 #include <dev/ic/i82586reg.h>
108 #include <dev/ic/i82586var.h>
109 
110 /*
111  * the on-board interface
112  */
113 struct ieob {
114 	u_char  obctrl;
115 };
116 #define IEOB_NORSET 0x80	/* don't reset the board */
117 #define IEOB_ONAIR  0x40	/* put us on the air */
118 #define IEOB_ATTEN  0x20	/* attention! */
119 #define IEOB_IENAB  0x10	/* interrupt enable */
120 #define IEOB_XXXXX  0x08	/* free bit */
121 #define IEOB_XCVRL2 0x04	/* level 2 transceiver? */
122 #define IEOB_BUSERR 0x02	/* bus error */
123 #define IEOB_INT    0x01	/* interrupt */
124 
125 #define IEOB_ADBASE 0xff000000  /* KVA base addr of 24 bit address space */
126 
127 
128 static void ie_obreset __P((struct ie_softc *, int));
129 static void ie_obattend __P((struct ie_softc *));
130 static void ie_obrun __P((struct ie_softc *));
131 
132 int ie_obio_match __P((struct device *, struct cfdata *, void *));
133 void ie_obio_attach __P((struct device *, struct device *, void *));
134 
135 struct cfattach ie_obio_ca = {
136 	sizeof(struct ie_softc), ie_obio_match, ie_obio_attach
137 };
138 
139 /* Supported media */
140 static int media[] = {
141 	IFM_ETHER | IFM_10_2,
142 };
143 #define NMEDIA	(sizeof(media) / sizeof(media[0]))
144 
145 
146 /*
147  * OBIO ie support routines
148  */
149 void
150 ie_obreset(sc, what)
151 	struct ie_softc *sc;
152 {
153 	volatile struct ieob *ieo = (struct ieob *) sc->sc_reg;
154 	ieo->obctrl = 0;
155 	delay(100);			/* XXX could be shorter? */
156 	ieo->obctrl = IEOB_NORSET;
157 }
158 void
159 ie_obattend(sc)
160 	struct ie_softc *sc;
161 {
162 	volatile struct ieob *ieo = (struct ieob *) sc->sc_reg;
163 
164 	ieo->obctrl |= IEOB_ATTEN;	/* flag! */
165 	ieo->obctrl &= ~IEOB_ATTEN;	/* down. */
166 }
167 
168 void
169 ie_obrun(sc)
170 	struct ie_softc *sc;
171 {
172 	volatile struct ieob *ieo = (struct ieob *) sc->sc_reg;
173 
174 	ieo->obctrl |= (IEOB_ONAIR|IEOB_IENAB|IEOB_NORSET);
175 }
176 
177 void ie_obio_memcopyin __P((struct ie_softc *, void *, int, size_t));
178 void ie_obio_memcopyout __P((struct ie_softc *, const void *, int, size_t));
179 
180 /*
181  * Copy board memory to kernel.
182  */
183 void
184 ie_obio_memcopyin(sc, p, offset, size)
185 	struct ie_softc	*sc;
186 	void *p;
187 	int offset;
188 	size_t size;
189 {
190 	void *addr = (void *)((u_long)sc->bh + offset);/*XXX - not MI!*/
191 	wcopy(addr, p, size);
192 }
193 
194 /*
195  * Copy from kernel space to naord memory.
196  */
197 void
198 ie_obio_memcopyout(sc, p, offset, size)
199 	struct ie_softc	*sc;
200 	const void *p;
201 	int offset;
202 	size_t size;
203 {
204 	void *addr = (void *)((u_long)sc->bh + offset);/*XXX - not MI!*/
205 	wcopy(p, addr, size);
206 }
207 
208 /* read a 16-bit value at BH offset */
209 u_int16_t ie_obio_read16 __P((struct ie_softc *, int offset));
210 /* write a 16-bit value at BH offset */
211 void ie_obio_write16 __P((struct ie_softc *, int offset, u_int16_t value));
212 void ie_obio_write24 __P((struct ie_softc *, int offset, int addr));
213 
214 u_int16_t
215 ie_obio_read16(sc, offset)
216 	struct ie_softc *sc;
217 	int offset;
218 {
219 	u_int16_t v = bus_space_read_2(sc->bt, sc->bh, offset);
220 	return (((v&0xff)<<8) | ((v>>8)&0xff));
221 }
222 
223 void
224 ie_obio_write16(sc, offset, v)
225 	struct ie_softc *sc;
226 	int offset;
227 	u_int16_t v;
228 {
229 	v = (((v&0xff)<<8) | ((v>>8)&0xff));
230 	bus_space_write_2(sc->bt, sc->bh, offset, v);
231 }
232 
233 void
234 ie_obio_write24(sc, offset, addr)
235 	struct ie_softc *sc;
236 	int offset;
237 	int addr;
238 {
239 	u_char *f = (u_char *)&addr;
240 	u_int16_t v0, v1;
241 	u_char *t;
242 
243 	t = (u_char *)&v0;
244 	t[0] = f[3]; t[1] = f[2];
245 	bus_space_write_2(sc->bt, sc->bh, offset, v0);
246 
247 	t = (u_char *)&v1;
248 	t[0] = f[1]; t[1] = 0;
249 	bus_space_write_2(sc->bt, sc->bh, offset+2, v1);
250 }
251 
252 int
253 ie_obio_match(parent, cf, aux)
254 	struct device *parent;
255 	struct cfdata *cf;
256 	void *aux;
257 {
258 	union obio_attach_args *uoba = aux;
259 	struct obio4_attach_args *oba;
260 
261 	if (uoba->uoba_isobio4 == 0)
262 		return (0);
263 
264 	oba = &uoba->uoba_oba4;
265 	return (bus_space_probe(oba->oba_bustag, 0, oba->oba_paddr,
266 				1,	/* probe size */
267 				0,	/* offset */
268 				0,	/* flags */
269 				NULL, NULL));
270 }
271 
272 void
273 ie_obio_attach(parent, self, aux)
274 	struct device *parent;
275 	struct device *self;
276 	void   *aux;
277 {
278 	union obio_attach_args *uoba = aux;
279 	struct obio4_attach_args *oba = &uoba->uoba_oba4;
280 	struct ie_softc *sc = (void *) self;
281 	bus_dma_tag_t dmatag = oba->oba_dmatag;
282 	bus_space_handle_t bh;
283 	bus_dma_segment_t seg;
284 	int rseg;
285 	int error;
286 	paddr_t pa;
287 	struct intrhand *ih;
288 	bus_size_t msize;
289 	u_long iebase;
290 	u_int8_t myaddr[ETHER_ADDR_LEN];
291 extern	void myetheraddr(u_char *);	/* should be elsewhere */
292 
293 	sc->bt = oba->oba_bustag;
294 
295 	sc->hwreset = ie_obreset;
296 	sc->chan_attn = ie_obattend;
297 	sc->hwinit = ie_obrun;
298 	sc->memcopyout = ie_obio_memcopyout;
299 	sc->memcopyin = ie_obio_memcopyin;
300 	sc->ie_bus_read16 = ie_obio_read16;
301 	sc->ie_bus_write16 = ie_obio_write16;
302 	sc->ie_bus_write24 = ie_obio_write24;
303 	sc->sc_msize = msize = 65536; /* XXX */
304 
305 	if (obio_bus_map(oba->oba_bustag, oba->oba_paddr,
306 			 0,
307 			 sizeof(struct ieob),
308 			 BUS_SPACE_MAP_LINEAR,
309 			 0, &bh) != 0) {
310 		printf("%s: cannot map registers\n", self->dv_xname);
311 		return;
312 	}
313 	sc->sc_reg = (void *)bh;
314 
315 	/*
316 	 * Allocate control & buffer memory.
317 	 */
318 	if ((error = bus_dmamap_create(dmatag, msize, 1, msize, 0,
319 					BUS_DMA_NOWAIT|BUS_DMA_24BIT,
320 					&sc->sc_dmamap)) != 0) {
321 		printf("%s: DMA map create error %d\n",
322 			sc->sc_dev.dv_xname, error);
323 		return;
324 	}
325 	if ((error = bus_dmamem_alloc(dmatag, msize, 64*1024, 0,
326 			     &seg, 1, &rseg,
327 			     BUS_DMA_NOWAIT | BUS_DMA_24BIT)) != 0) {
328 		printf("%s: DMA memory allocation error %d\n",
329 			self->dv_xname, error);
330 		return;
331 	}
332 
333 	/* Map DMA buffer in CPU addressable space */
334 	if ((error = bus_dmamem_map(dmatag, &seg, rseg, msize,
335 				    (caddr_t *)&sc->sc_maddr,
336 				    BUS_DMA_NOWAIT|BUS_DMA_COHERENT)) != 0) {
337 		printf("%s: DMA buffer map error %d\n",
338 			sc->sc_dev.dv_xname, error);
339 		bus_dmamem_free(dmatag, &seg, rseg);
340 		return;
341 	}
342 
343 	/* Load the segment */
344 	if ((error = bus_dmamap_load_raw(dmatag, sc->sc_dmamap,
345 				&seg, rseg, msize, BUS_DMA_NOWAIT)) != 0) {
346 		printf("%s: DMA buffer map load error %d\n",
347 			sc->sc_dev.dv_xname, error);
348 		bus_dmamem_unmap(dmatag, sc->sc_maddr, msize);
349 		bus_dmamem_free(dmatag, &seg, rseg);
350 		return;
351 	}
352 
353 	wzero(sc->sc_maddr, msize);
354 	sc->bh = (bus_space_handle_t)(sc->sc_maddr);
355 
356 	/*
357 	 * The i82586's 24-bit address space maps to the last 16MB of
358 	 * KVA space ().  In addition, the SCP must appear
359 	 * at IE_SCP_ADDR within the 24-bit address space,
360 	 * i.e. at KVA  IEOB_ADBASE+IE_SCP_ADDR, at the very top of
361 	 * kernel space.  We double-map this last page to the first
362 	 * page (starting at `maddr') of the memory we allocate to the chip.
363 	 * (a side-effect of this double-map is that the ISCP and SCB
364 	 * structures also get aliased there, but we ignore this). The
365 	 * first page at `maddr' is only used for ISCP, SCB and the aliased
366 	 * SCP; the actual buffers start at maddr+NBPG.
367 	 *
368 	 * In a picture:
369 
370 	|---//--- ISCP-SCB-----scp-|--//- buffers -//-|... |iscp-scb-----SCP-|
371 	|         |                |                  |    |             |   |
372 	|         |<----- NBPG --->|                  |    |<----- NBPG -+-->|
373 	|         |<------------- msize ------------->|    |       ^     |
374 	|         |                                                |     |
375 	|         \@maddr                                 (last page dbl mapped)
376 	|                                                                |
377 	\@IEOB_ADBASE                           @IEOB_ADBASE+IE_SCP_ADDR-+
378 
379 	 *
380 	 */
381 
382 	/* Double map the SCP */
383 	if (pmap_extract(pmap_kernel(), (vaddr_t)sc->sc_maddr, &pa) == FALSE)
384 		panic("ie pmap_extract");
385 
386 	pmap_enter(pmap_kernel(), trunc_page(IEOB_ADBASE+IE_SCP_ADDR),
387 	    pa | PMAP_NC /*| PMAP_IOC*/,
388 	    VM_PROT_READ | VM_PROT_WRITE, PMAP_WIRED);
389 
390 	/* Map iscp at location 0 (relative to `maddr') */
391 	sc->iscp = 0;
392 
393 	/* scb follows iscp */
394 	sc->scb = IE_ISCP_SZ;
395 
396 	/* scp is at the fixed location IE_SCP_ADDR (modulo the page size) */
397 	sc->scp = IE_SCP_ADDR & PGOFSET;
398 
399 	/* Calculate the 24-bit base of i82586 operations */
400 	iebase = (u_long)sc->sc_dmamap->dm_segs[0].ds_addr -
401 			(u_long)IEOB_ADBASE;
402 	ie_obio_write16(sc, IE_ISCP_SCB(sc->iscp), sc->scb);
403 	ie_obio_write24(sc, IE_ISCP_BASE(sc->iscp), iebase);
404 	ie_obio_write24(sc, IE_SCP_ISCP(sc->scp), iebase + sc->iscp);
405 
406 	/*
407 	 * Rest of first page is unused (wasted!); the other pages
408 	 * are used for buffers.
409 	 */
410 	sc->buf_area = NBPG;
411 	sc->buf_area_sz = msize - NBPG;
412 
413 	if (i82586_proberam(sc) == 0) {
414 		printf(": memory probe failed\n");
415 		return;
416 	}
417 
418 	myetheraddr(myaddr);
419 	i82586_attach(sc, "onboard", myaddr, media, NMEDIA, media[0]);
420 
421 	/* Establish interrupt channel */
422 	ih = bus_intr_establish(oba->oba_bustag,
423 				oba->oba_pri, IPL_NET, 0,
424 				i82586_intr, sc);
425 }
426