1 /* $NetBSD: if_ie_obio.c,v 1.5 2002/10/02 16:02:22 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 * 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 * Sun2 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 sun[23]'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 #include <machine/idprom.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 0x000000 /* 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 *, int)); 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 CFATTACH_DECL(ie_obio, sizeof(struct ie_softc), 137 ie_obio_match, ie_obio_attach, NULL, NULL); 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, why) 160 struct ie_softc *sc; 161 int why; 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 bus_space_copyin(sc->bt, sc->bh, offset, 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 bus_space_copyout(sc->bt, sc->bh, offset, p, size); 205 } 206 207 /* read a 16-bit value at BH offset */ 208 u_int16_t ie_obio_read16 __P((struct ie_softc *, int offset)); 209 /* write a 16-bit value at BH offset */ 210 void ie_obio_write16 __P((struct ie_softc *, int offset, u_int16_t value)); 211 void ie_obio_write24 __P((struct ie_softc *, int offset, int addr)); 212 213 u_int16_t 214 ie_obio_read16(sc, offset) 215 struct ie_softc *sc; 216 int offset; 217 { 218 u_int16_t v = bus_space_read_2(sc->bt, sc->bh, offset); 219 return (((v&0xff)<<8) | ((v>>8)&0xff)); 220 } 221 222 void 223 ie_obio_write16(sc, offset, v) 224 struct ie_softc *sc; 225 int offset; 226 u_int16_t v; 227 { 228 v = (((v&0xff)<<8) | ((v>>8)&0xff)); 229 bus_space_write_2(sc->bt, sc->bh, offset, v); 230 } 231 232 void 233 ie_obio_write24(sc, offset, addr) 234 struct ie_softc *sc; 235 int offset; 236 int addr; 237 { 238 u_char *f = (u_char *)&addr; 239 u_int16_t v0, v1; 240 u_char *t; 241 242 t = (u_char *)&v0; 243 t[0] = f[3]; t[1] = f[2]; 244 bus_space_write_2(sc->bt, sc->bh, offset, v0); 245 246 t = (u_char *)&v1; 247 t[0] = f[1]; t[1] = 0; 248 bus_space_write_2(sc->bt, sc->bh, offset+2, v1); 249 } 250 251 int 252 ie_obio_match(parent, cf, aux) 253 struct device *parent; 254 struct cfdata *cf; 255 void *aux; 256 { 257 struct obio_attach_args *oba = aux; 258 bus_space_handle_t bh; 259 int matched; 260 u_int8_t ctrl; 261 262 /* No default obio address. */ 263 if (oba->oba_paddr == -1) 264 return(0); 265 266 /* Make sure there is something there... */ 267 if (bus_space_map(oba->oba_bustag, oba->oba_paddr, sizeof(struct ieob), 268 0, &bh)) 269 return (0); 270 matched = (!bus_space_poke_1(oba->oba_bustag, bh, 0, IEOB_NORSET) && 271 !bus_space_peek_1(oba->oba_bustag, bh, 0, &ctrl) && 272 (ctrl & (IEOB_ONAIR|IEOB_IENAB)) == 0); 273 bus_space_unmap(oba->oba_bustag, bh, sizeof(struct ieob)); 274 if (!matched) 275 return (0); 276 277 /* Default interrupt priority. */ 278 if (oba->oba_pri == -1) 279 oba->oba_pri = 3; 280 281 return (1); 282 } 283 284 void 285 ie_obio_attach(parent, self, aux) 286 struct device *parent; 287 struct device *self; 288 void *aux; 289 { 290 struct obio_attach_args *oba = aux; 291 struct ie_softc *sc = (void *) self; 292 bus_dma_tag_t dmatag = oba->oba_dmatag; 293 bus_space_handle_t bh; 294 bus_dma_segment_t seg; 295 int rseg; 296 int error; 297 paddr_t pa; 298 struct intrhand *ih; 299 bus_size_t msize; 300 u_long iebase; 301 u_int8_t myaddr[ETHER_ADDR_LEN]; 302 303 sc->bt = oba->oba_bustag; 304 305 sc->hwreset = ie_obreset; 306 sc->chan_attn = ie_obattend; 307 sc->hwinit = ie_obrun; 308 sc->memcopyout = ie_obio_memcopyout; 309 sc->memcopyin = ie_obio_memcopyin; 310 311 sc->ie_bus_barrier = NULL; 312 sc->ie_bus_read16 = ie_obio_read16; 313 sc->ie_bus_write16 = ie_obio_write16; 314 sc->ie_bus_write24 = ie_obio_write24; 315 sc->sc_msize = msize = 65536; /* XXX */ 316 317 if (bus_space_map(oba->oba_bustag, oba->oba_paddr, sizeof(struct ieob), 318 0, &bh)) 319 panic("ie_obio_attach: can't map regs"); 320 sc->sc_reg = (void *)bh; 321 322 /* 323 * Allocate control & buffer memory. 324 */ 325 if ((error = bus_dmamap_create(dmatag, msize, 1, msize, 0, 326 BUS_DMA_NOWAIT|BUS_DMA_24BIT, 327 &sc->sc_dmamap)) != 0) { 328 printf("%s: DMA map create error %d\n", 329 sc->sc_dev.dv_xname, error); 330 return; 331 } 332 if ((error = bus_dmamem_alloc(dmatag, msize, 64*1024, 0, 333 &seg, 1, &rseg, 334 BUS_DMA_NOWAIT | BUS_DMA_24BIT)) != 0) { 335 printf("%s: DMA memory allocation error %d\n", 336 self->dv_xname, error); 337 return; 338 } 339 340 /* Map DMA buffer in CPU addressable space */ 341 if ((error = bus_dmamem_map(dmatag, &seg, rseg, msize, 342 (caddr_t *)&sc->sc_maddr, 343 BUS_DMA_NOWAIT|BUS_DMA_COHERENT)) != 0) { 344 printf("%s: DMA buffer map error %d\n", 345 sc->sc_dev.dv_xname, error); 346 bus_dmamem_free(dmatag, &seg, rseg); 347 return; 348 } 349 350 /* Load the segment */ 351 if ((error = bus_dmamap_load(dmatag, sc->sc_dmamap, 352 sc->sc_maddr, msize, NULL, 353 BUS_DMA_NOWAIT)) != 0) { 354 printf("%s: DMA buffer map load error %d\n", 355 sc->sc_dev.dv_xname, error); 356 bus_dmamem_unmap(dmatag, sc->sc_maddr, msize); 357 bus_dmamem_free(dmatag, &seg, rseg); 358 return; 359 } 360 361 w16zero(sc->sc_maddr, msize); 362 sc->bh = (bus_space_handle_t)(sc->sc_maddr); 363 364 /* 365 * The i82586's 24-bit address space maps to all of 366 * KVA space (). In addition, the SCP must appear 367 * at IE_SCP_ADDR within the 24-bit address space, 368 * i.e. at KVA IEOB_ADBASE+IE_SCP_ADDR, at the very top of 369 * kernel space. We double-map this last page to the first 370 * page (starting at `maddr') of the memory we allocate to the chip. 371 * (a side-effect of this double-map is that the ISCP and SCB 372 * structures also get aliased there, but we ignore this). The 373 * first page at `maddr' is only used for ISCP, SCB and the aliased 374 * SCP; the actual buffers start at maddr+NBPG. 375 * 376 * In a picture: 377 378 |---//--- ISCP-SCB-----scp-|--//- buffers -//-|... |iscp-scb-----SCP-| 379 | | | | | | | 380 | |<----- NBPG --->| | |<----- NBPG -+-->| 381 | |<------------- msize ------------->| | ^ | 382 | | | | 383 | \@maddr (last page dbl mapped) 384 | | 385 \@IEOB_ADBASE @IEOB_ADBASE+IE_SCP_ADDR-+ 386 387 * 388 */ 389 390 /* Double map the SCP */ 391 if (pmap_extract(pmap_kernel(), (vaddr_t)sc->sc_maddr, &pa) == FALSE) 392 panic("ie pmap_extract"); 393 394 pmap_enter(pmap_kernel(), m68k_trunc_page(IEOB_ADBASE+IE_SCP_ADDR), 395 pa | PMAP_NC /*| PMAP_IOC*/, 396 VM_PROT_READ | VM_PROT_WRITE, PMAP_WIRED); 397 398 /* Map iscp at location 0 (relative to `maddr') */ 399 sc->iscp = 0; 400 401 /* scb follows iscp */ 402 sc->scb = IE_ISCP_SZ; 403 404 /* scp is at the fixed location IE_SCP_ADDR (modulo the page size) */ 405 sc->scp = IE_SCP_ADDR & PGOFSET; 406 407 /* Calculate the 24-bit base of i82586 operations */ 408 iebase = (u_long)sc->sc_dmamap->dm_segs[0].ds_addr - 409 (u_long)IEOB_ADBASE; 410 ie_obio_write16(sc, IE_ISCP_SCB(sc->iscp), sc->scb); 411 ie_obio_write24(sc, IE_ISCP_BASE(sc->iscp), iebase); 412 ie_obio_write24(sc, IE_SCP_ISCP(sc->scp), iebase + sc->iscp); 413 414 /* 415 * Rest of first page is unused (wasted!); the other pages 416 * are used for buffers. 417 */ 418 sc->buf_area = NBPG; 419 sc->buf_area_sz = msize - NBPG; 420 421 if (i82586_proberam(sc) == 0) { 422 printf(": memory probe failed\n"); 423 return; 424 } 425 426 idprom_etheraddr(myaddr); 427 i82586_attach(sc, "onboard", myaddr, media, NMEDIA, media[0]); 428 429 /* Establish interrupt channel */ 430 ih = bus_intr_establish(oba->oba_bustag, 431 oba->oba_pri, IPL_NET, 0, 432 i82586_intr, sc); 433 } 434