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