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