1 /* $NetBSD: if_ie_obio.c,v 1.2 2001/10/01 01:53:31 fredette 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 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, why) 161 struct ie_softc *sc; 162 int why; 163 { 164 volatile struct ieob *ieo = (struct ieob *) sc->sc_reg; 165 166 ieo->obctrl |= IEOB_ATTEN; /* flag! */ 167 ieo->obctrl &= ~IEOB_ATTEN; /* down. */ 168 } 169 170 void 171 ie_obrun(sc) 172 struct ie_softc *sc; 173 { 174 volatile struct ieob *ieo = (struct ieob *) sc->sc_reg; 175 176 ieo->obctrl |= (IEOB_ONAIR|IEOB_IENAB|IEOB_NORSET); 177 } 178 179 void ie_obio_memcopyin __P((struct ie_softc *, void *, int, size_t)); 180 void ie_obio_memcopyout __P((struct ie_softc *, const void *, int, size_t)); 181 182 /* 183 * Copy board memory to kernel. 184 */ 185 void 186 ie_obio_memcopyin(sc, p, offset, size) 187 struct ie_softc *sc; 188 void *p; 189 int offset; 190 size_t size; 191 { 192 bus_space_copyin(sc->bt, sc->bh, offset, 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 bus_space_copyout(sc->bt, sc->bh, offset, p, 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 struct obio_attach_args *oba = aux; 259 bus_space_handle_t bh; 260 int matched; 261 u_int8_t ctrl; 262 263 /* No default obio address. */ 264 if (oba->oba_paddr == -1) 265 return(0); 266 267 /* Make sure there is something there... */ 268 if (bus_space_map(oba->oba_bustag, oba->oba_paddr, sizeof(struct ieob), 269 0, &bh)) 270 return (0); 271 matched = (!bus_space_poke_1(oba->oba_bustag, bh, 0, IEOB_NORSET) && 272 !bus_space_peek_1(oba->oba_bustag, bh, 0, &ctrl) && 273 (ctrl & (IEOB_ONAIR|IEOB_IENAB)) == 0); 274 bus_space_unmap(oba->oba_bustag, bh, sizeof(struct ieob)); 275 if (!matched) 276 return (0); 277 278 /* Default interrupt priority. */ 279 if (oba->oba_pri == -1) 280 oba->oba_pri = 3; 281 282 return (1); 283 } 284 285 void 286 ie_obio_attach(parent, self, aux) 287 struct device *parent; 288 struct device *self; 289 void *aux; 290 { 291 struct obio_attach_args *oba = aux; 292 struct ie_softc *sc = (void *) self; 293 bus_dma_tag_t dmatag = oba->oba_dmatag; 294 bus_space_handle_t bh; 295 bus_dma_segment_t seg; 296 int rseg; 297 int error; 298 paddr_t pa; 299 struct intrhand *ih; 300 bus_size_t msize; 301 u_long iebase; 302 u_int8_t myaddr[ETHER_ADDR_LEN]; 303 304 sc->bt = oba->oba_bustag; 305 306 sc->hwreset = ie_obreset; 307 sc->chan_attn = ie_obattend; 308 sc->hwinit = ie_obrun; 309 sc->memcopyout = ie_obio_memcopyout; 310 sc->memcopyin = ie_obio_memcopyin; 311 312 sc->ie_bus_barrier = NULL; 313 sc->ie_bus_read16 = ie_obio_read16; 314 sc->ie_bus_write16 = ie_obio_write16; 315 sc->ie_bus_write24 = ie_obio_write24; 316 sc->sc_msize = msize = 65536; /* XXX */ 317 318 if (bus_space_map(oba->oba_bustag, oba->oba_paddr, sizeof(struct ieob), 319 0, &bh)) 320 panic("ie_obio_attach: can't map regs"); 321 sc->sc_reg = (void *)bh; 322 323 /* 324 * Allocate control & buffer memory. 325 */ 326 if ((error = bus_dmamap_create(dmatag, msize, 1, msize, 0, 327 BUS_DMA_NOWAIT|BUS_DMA_24BIT, 328 &sc->sc_dmamap)) != 0) { 329 printf("%s: DMA map create error %d\n", 330 sc->sc_dev.dv_xname, error); 331 return; 332 } 333 if ((error = bus_dmamem_alloc(dmatag, msize, 64*1024, 0, 334 &seg, 1, &rseg, 335 BUS_DMA_NOWAIT | BUS_DMA_24BIT)) != 0) { 336 printf("%s: DMA memory allocation error %d\n", 337 self->dv_xname, error); 338 return; 339 } 340 341 /* Map DMA buffer in CPU addressable space */ 342 if ((error = bus_dmamem_map(dmatag, &seg, rseg, msize, 343 (caddr_t *)&sc->sc_maddr, 344 BUS_DMA_NOWAIT|BUS_DMA_COHERENT)) != 0) { 345 printf("%s: DMA buffer map error %d\n", 346 sc->sc_dev.dv_xname, error); 347 bus_dmamem_free(dmatag, &seg, rseg); 348 return; 349 } 350 351 /* Load the segment */ 352 if ((error = bus_dmamap_load(dmatag, sc->sc_dmamap, 353 sc->sc_maddr, msize, NULL, 354 BUS_DMA_NOWAIT)) != 0) { 355 printf("%s: DMA buffer map load error %d\n", 356 sc->sc_dev.dv_xname, error); 357 bus_dmamem_unmap(dmatag, sc->sc_maddr, msize); 358 bus_dmamem_free(dmatag, &seg, rseg); 359 return; 360 } 361 362 w16zero(sc->sc_maddr, msize); 363 sc->bh = (bus_space_handle_t)(sc->sc_maddr); 364 365 /* 366 * The i82586's 24-bit address space maps to all of 367 * KVA space (). In addition, the SCP must appear 368 * at IE_SCP_ADDR within the 24-bit address space, 369 * i.e. at KVA IEOB_ADBASE+IE_SCP_ADDR, at the very top of 370 * kernel space. We double-map this last page to the first 371 * page (starting at `maddr') of the memory we allocate to the chip. 372 * (a side-effect of this double-map is that the ISCP and SCB 373 * structures also get aliased there, but we ignore this). The 374 * first page at `maddr' is only used for ISCP, SCB and the aliased 375 * SCP; the actual buffers start at maddr+NBPG. 376 * 377 * In a picture: 378 379 |---//--- ISCP-SCB-----scp-|--//- buffers -//-|... |iscp-scb-----SCP-| 380 | | | | | | | 381 | |<----- NBPG --->| | |<----- NBPG -+-->| 382 | |<------------- msize ------------->| | ^ | 383 | | | | 384 | \@maddr (last page dbl mapped) 385 | | 386 \@IEOB_ADBASE @IEOB_ADBASE+IE_SCP_ADDR-+ 387 388 * 389 */ 390 391 /* Double map the SCP */ 392 if (pmap_extract(pmap_kernel(), (vaddr_t)sc->sc_maddr, &pa) == FALSE) 393 panic("ie pmap_extract"); 394 395 pmap_enter(pmap_kernel(), m68k_trunc_page(IEOB_ADBASE+IE_SCP_ADDR), 396 pa | PMAP_NC /*| PMAP_IOC*/, 397 VM_PROT_READ | VM_PROT_WRITE, PMAP_WIRED); 398 399 /* Map iscp at location 0 (relative to `maddr') */ 400 sc->iscp = 0; 401 402 /* scb follows iscp */ 403 sc->scb = IE_ISCP_SZ; 404 405 /* scp is at the fixed location IE_SCP_ADDR (modulo the page size) */ 406 sc->scp = IE_SCP_ADDR & PGOFSET; 407 408 /* Calculate the 24-bit base of i82586 operations */ 409 iebase = (u_long)sc->sc_dmamap->dm_segs[0].ds_addr - 410 (u_long)IEOB_ADBASE; 411 ie_obio_write16(sc, IE_ISCP_SCB(sc->iscp), sc->scb); 412 ie_obio_write24(sc, IE_ISCP_BASE(sc->iscp), iebase); 413 ie_obio_write24(sc, IE_SCP_ISCP(sc->scp), iebase + sc->iscp); 414 415 /* 416 * Rest of first page is unused (wasted!); the other pages 417 * are used for buffers. 418 */ 419 sc->buf_area = NBPG; 420 sc->buf_area_sz = msize - NBPG; 421 422 if (i82586_proberam(sc) == 0) { 423 printf(": memory probe failed\n"); 424 return; 425 } 426 427 idprom_etheraddr(myaddr); 428 i82586_attach(sc, "onboard", myaddr, media, NMEDIA, media[0]); 429 430 /* Establish interrupt channel */ 431 ih = bus_intr_establish(oba->oba_bustag, 432 oba->oba_pri, IPL_NET, 0, 433 i82586_intr, sc); 434 } 435