1 /* $NetBSD: if_elmc_mca.c,v 1.21 2006/10/12 01:31:25 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Rafal K. Boni and Jaromir Dolecek. 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 * 3Com 3c523 EtherLink/MC Ethernet card driver (uses i82586 Ethernet chip). 41 * 42 * The 3c523-specific hooks were derived from Linux driver (file 43 * drivers/net/3c523.[ch]). 44 * 45 * This driver uses generic i82586 stuff. See also ai(4), ef(4), ix(4). 46 */ 47 48 #include <sys/cdefs.h> 49 __KERNEL_RCSID(0, "$NetBSD: if_elmc_mca.c,v 1.21 2006/10/12 01:31:25 christos Exp $"); 50 51 #include <sys/param.h> 52 #include <sys/systm.h> 53 #include <sys/mbuf.h> 54 #include <sys/errno.h> 55 #include <sys/device.h> 56 #include <sys/protosw.h> 57 #include <sys/socket.h> 58 59 #include <net/if.h> 60 #include <net/if_types.h> 61 #include <net/if_media.h> 62 #include <net/if_ether.h> 63 64 #include <machine/bus.h> 65 66 #include <dev/ic/i82586reg.h> 67 #include <dev/ic/i82586var.h> 68 #include <dev/mca/mcadevs.h> 69 #include <dev/mca/mcavar.h> 70 71 #include <dev/mca/3c523reg.h> 72 73 struct elmc_mca_softc { 74 struct ie_softc sc_ie; 75 76 bus_space_tag_t sc_regt; /* space tag for registers */ 77 bus_space_handle_t sc_regh; /* space handle for registers */ 78 79 void *sc_ih; /* interrupt handle */ 80 }; 81 82 int elmc_mca_match(struct device *, struct cfdata *, void *); 83 void elmc_mca_attach(struct device *, struct device *, void *); 84 85 static void elmc_mca_copyin(struct ie_softc *, void *, int, size_t); 86 static void elmc_mca_copyout(struct ie_softc *, const void *, int, size_t); 87 static u_int16_t elmc_mca_read_16(struct ie_softc *, int); 88 static void elmc_mca_write_16(struct ie_softc *, int, u_int16_t); 89 static void elmc_mca_write_24(struct ie_softc *, int, int); 90 static void elmc_mca_attn(struct ie_softc *, int); 91 static void elmc_mca_hwreset(struct ie_softc *, int); 92 static int elmc_mca_intrhook(struct ie_softc *, int); 93 94 int 95 elmc_mca_match(struct device *parent __unused, struct cfdata *cf __unused, 96 void *aux) 97 { 98 struct mca_attach_args *ma = aux; 99 100 switch (ma->ma_id) { 101 case MCA_PRODUCT_3C523: 102 return 1; 103 } 104 105 return 0; 106 } 107 108 void 109 elmc_mca_attach(struct device *parent __unused, struct device *self, void *aux) 110 { 111 struct elmc_mca_softc *asc = device_private(self); 112 struct ie_softc *sc = &asc->sc_ie; 113 struct mca_attach_args *ma = aux; 114 int pos2, pos3, i, revision; 115 int iobase, irq, pbram_addr; 116 bus_space_handle_t ioh, memh; 117 u_int8_t myaddr[ETHER_ADDR_LEN]; 118 119 pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2); 120 pos3 = mca_conf_read(ma->ma_mc, ma->ma_slot, 3); 121 122 /* 123 * POS register 2: (adf pos0) 124 * 125 * 7 6 5 4 3 2 1 0 126 * \ \_/ \_/ \__ enable: 0=adapter disabled, 1=adapter enabled 127 * \ \ \____ I/O Address Range: 00=300-307, 01=1300-1307, 128 * \ \ 10=2300-2307, 11=3300-3307 129 * \ \______ Packet Buffer RAM Address Range: 130 * \ 00=0x0c0000-0x0c5fff 01=0x0c8000-0x0cdfff 131 * \ 10=0x0d0000-0x0d5fff 11=0x0d8000-0x0ddfff 132 * \______ Transceiver Type: 0=onboard(BNC) 1=ext(DIX) 133 * 134 * POS register 3: (adf pos1) 135 * 136 * 7 6 5 4 3 2 1 0 137 * \____/ 138 * \__ Interrupt level: 0100=3, 0010=7, 1000=9, 0001=12 139 */ 140 141 iobase = ELMC_IOADDR_BASE + (0x1000 * ((pos2 & 0x6) >> 1)); 142 143 /* get irq */ 144 switch (pos3 & 0x1f) { 145 case 4: irq = 3; break; 146 case 2: irq = 7; break; 147 case 8: irq = 9; break; 148 case 1: irq = 12; break; 149 default: 150 printf(": cannot determine irq\n"); 151 return; 152 } 153 154 pbram_addr = ELMC_MADDR_BASE + (((pos2 & 0x18) >> 3) * 0x8000); 155 156 printf(" slot %d irq %d: 3Com EtherLink/MC Ethernet Adapter (3C523)\n", 157 ma->ma_slot + 1, irq); 158 159 /* map the pio registers */ 160 if (bus_space_map(ma->ma_iot, iobase, ELMC_IOADDR_SIZE, 0, &ioh)) { 161 printf("%s: unable to map i/o space\n", sc->sc_dev.dv_xname); 162 return; 163 } 164 165 /* 166 * 3c523 has a 24K memory. The first 16K is the shared memory, while 167 * the last 8K is for the EtherStart BIOS ROM, which we don't care 168 * about. Just use the first 16K. 169 */ 170 if (bus_space_map(ma->ma_memt, pbram_addr, ELMC_MADDR_SIZE, 0, &memh)) { 171 printf("%s: unable to map memory space\n", sc->sc_dev.dv_xname); 172 if (pbram_addr == 0xc0000) { 173 printf("%s: memory space 0xc0000 may conflict with vga\n", 174 sc->sc_dev.dv_xname); 175 } 176 177 bus_space_unmap(ma->ma_iot, ioh, ELMC_IOADDR_SIZE); 178 return; 179 } 180 181 asc->sc_regt = ma->ma_iot; 182 asc->sc_regh = ioh; 183 184 sc->hwinit = NULL; 185 sc->intrhook = elmc_mca_intrhook; 186 sc->hwreset = elmc_mca_hwreset; 187 sc->chan_attn = elmc_mca_attn; 188 189 sc->ie_bus_barrier = NULL; 190 191 sc->memcopyin = elmc_mca_copyin; 192 sc->memcopyout = elmc_mca_copyout; 193 sc->ie_bus_read16 = elmc_mca_read_16; 194 sc->ie_bus_write16 = elmc_mca_write_16; 195 sc->ie_bus_write24 = elmc_mca_write_24; 196 197 sc->do_xmitnopchain = 0; 198 199 sc->sc_mediachange = NULL; 200 sc->sc_mediastatus = NULL; 201 202 sc->bt = ma->ma_memt; 203 sc->bh = memh; 204 205 /* Map i/o space. */ 206 sc->sc_msize = ELMC_MADDR_SIZE; 207 sc->sc_maddr = (void *)memh; 208 sc->sc_iobase = (char *)sc->sc_maddr + sc->sc_msize - (1 << 24); 209 210 /* set up pointers to important on-card control structures */ 211 sc->iscp = 0; 212 sc->scb = IE_ISCP_SZ; 213 sc->scp = sc->sc_msize + IE_SCP_ADDR - (1 << 24); 214 215 sc->buf_area = sc->scb + IE_SCB_SZ; 216 sc->buf_area_sz = sc->sc_msize - IE_ISCP_SZ - IE_SCB_SZ - IE_SCP_SZ; 217 218 /* 219 * According to docs, we might need to read the interrupt number and 220 * write it back to the IRQ select register, since the POST might not 221 * configure the IRQ properly. 222 */ 223 (void) mca_conf_write(ma->ma_mc, ma->ma_slot, 3, pos3 & 0x1f); 224 225 /* reset the card first */ 226 elmc_mca_hwreset(sc, CARD_RESET); 227 delay(1000000 / ( 1<< 5)); 228 229 /* zero card memory */ 230 bus_space_set_region_1(sc->bt, sc->bh, 0, 0, sc->sc_msize); 231 232 /* set card to 16-bit bus mode */ 233 bus_space_write_1(sc->bt, sc->bh, IE_SCP_BUS_USE((u_long)sc->scp), 234 IE_SYSBUS_16BIT); 235 236 /* set up pointers to key structures */ 237 elmc_mca_write_24(sc, IE_SCP_ISCP((u_long)sc->scp), (u_long) sc->iscp); 238 elmc_mca_write_16(sc, IE_ISCP_SCB((u_long)sc->iscp), (u_long) sc->scb); 239 elmc_mca_write_24(sc, IE_ISCP_BASE((u_long)sc->iscp), (u_long) sc->iscp); 240 241 /* flush setup of pointers, check if chip answers */ 242 bus_space_barrier(sc->bt, sc->bh, 0, sc->sc_msize, 243 BUS_SPACE_BARRIER_WRITE); 244 if (!i82586_proberam(sc)) { 245 printf("%s: can't talk to i82586!\n", sc->sc_dev.dv_xname); 246 247 bus_space_unmap(asc->sc_regt, asc->sc_regh, ELMC_IOADDR_SIZE); 248 bus_space_unmap(sc->bt, sc->bh, ELMC_MADDR_SIZE); 249 return; 250 } 251 252 /* revision is stored in the first 4 bits of the revision register */ 253 revision = (int) bus_space_read_1(asc->sc_regt, asc->sc_regh, 254 ELMC_REVISION) & ELMC_REVISION_MASK; 255 256 /* dump known info */ 257 printf("%s: rev %d, i/o %#04x-%#04x, mem %#06x-%#06x, %sternal xcvr\n", 258 sc->sc_dev.dv_xname, revision, 259 iobase, iobase + ELMC_IOADDR_SIZE - 1, 260 pbram_addr, pbram_addr + ELMC_MADDR_SIZE - 1, 261 (pos2 & 0x20) ? "ex" : "in"); 262 263 /* 264 * Hardware ethernet address is stored in the first six bytes 265 * of the IO space. 266 */ 267 for(i=0; i < MIN(6, ETHER_ADDR_LEN); i++) 268 myaddr[i] = bus_space_read_1(asc->sc_regt, asc->sc_regh, i); 269 270 printf("%s:", sc->sc_dev.dv_xname); 271 i82586_attach((void *)sc, "3C523", myaddr, NULL, 0, 0); 272 273 /* establish interrupt handler */ 274 asc->sc_ih = mca_intr_establish(ma->ma_mc, irq, IPL_NET, i82586_intr, 275 sc); 276 if (asc->sc_ih == NULL) { 277 printf("%s: couldn't establish interrupt handler\n", 278 sc->sc_dev.dv_xname); 279 return; 280 } 281 } 282 283 static void 284 elmc_mca_copyin (sc, dst, offset, size) 285 struct ie_softc *sc; 286 void *dst; 287 int offset; 288 size_t size; 289 { 290 int dribble; 291 u_int8_t* bptr = dst; 292 293 bus_space_barrier(sc->bt, sc->bh, offset, size, 294 BUS_SPACE_BARRIER_READ); 295 296 if (offset % 2) { 297 *bptr = bus_space_read_1(sc->bt, sc->bh, offset); 298 offset++; bptr++; size--; 299 } 300 301 dribble = size % 2; 302 bus_space_read_region_2(sc->bt, sc->bh, offset, (u_int16_t *) bptr, 303 size >> 1); 304 305 if (dribble) { 306 bptr += size - 1; 307 offset += size - 1; 308 *bptr = bus_space_read_1(sc->bt, sc->bh, offset); 309 } 310 } 311 312 static void 313 elmc_mca_copyout (sc, src, offset, size) 314 struct ie_softc *sc; 315 const void *src; 316 int offset; 317 size_t size; 318 { 319 int dribble; 320 int osize = size; 321 int ooffset = offset; 322 const u_int8_t* bptr = src; 323 324 if (offset % 2) { 325 bus_space_write_1(sc->bt, sc->bh, offset, *bptr); 326 offset++; bptr++; size--; 327 } 328 329 dribble = size % 2; 330 bus_space_write_region_2(sc->bt, sc->bh, offset, 331 (const u_int16_t *)bptr, size >> 1); 332 if (dribble) { 333 bptr += size - 1; 334 offset += size - 1; 335 bus_space_write_1(sc->bt, sc->bh, offset, *bptr); 336 } 337 338 bus_space_barrier(sc->bt, sc->bh, ooffset, osize, 339 BUS_SPACE_BARRIER_WRITE); 340 } 341 342 static u_int16_t 343 elmc_mca_read_16 (sc, offset) 344 struct ie_softc *sc; 345 int offset; 346 { 347 bus_space_barrier(sc->bt, sc->bh, offset, 2, BUS_SPACE_BARRIER_READ); 348 return bus_space_read_2(sc->bt, sc->bh, offset); 349 } 350 351 static void 352 elmc_mca_write_16 (sc, offset, value) 353 struct ie_softc *sc; 354 int offset; 355 u_int16_t value; 356 { 357 bus_space_write_2(sc->bt, sc->bh, offset, value); 358 bus_space_barrier(sc->bt, sc->bh, offset, 2, BUS_SPACE_BARRIER_WRITE); 359 } 360 361 static void 362 elmc_mca_write_24 (sc, offset, addr) 363 struct ie_softc *sc; 364 int offset, addr; 365 { 366 bus_space_write_4(sc->bt, sc->bh, offset, addr + 367 (u_long) sc->sc_maddr - (u_long) sc->sc_iobase); 368 bus_space_barrier(sc->bt, sc->bh, offset, 4, BUS_SPACE_BARRIER_WRITE); 369 } 370 371 /* 372 * Channel attention hook. 373 */ 374 static void 375 elmc_mca_attn(sc, why) 376 struct ie_softc *sc; 377 int why; 378 { 379 struct elmc_mca_softc* asc = (struct elmc_mca_softc *) sc; 380 int intr = 0; 381 382 switch (why) { 383 case CHIP_PROBE: 384 intr = 0; 385 break; 386 case CARD_RESET: 387 intr = ELMC_CTRL_INT; 388 break; 389 } 390 391 bus_space_write_1(asc->sc_regt, asc->sc_regh, ELMC_CTRL, 392 ELMC_CTRL_RST | ELMC_CTRL_BS3 | ELMC_CTRL_CHA | intr); 393 delay(1); /* should be > 500 ns */ 394 bus_space_write_1(asc->sc_regt, asc->sc_regh, ELMC_CTRL, 395 ELMC_CTRL_RST | ELMC_CTRL_BS3 | intr); 396 } 397 398 /* 399 * Do full card hardware reset. 400 */ 401 static void 402 elmc_mca_hwreset(sc, why) 403 struct ie_softc *sc; 404 int why; 405 { 406 struct elmc_mca_softc* asc = (struct elmc_mca_softc *) sc; 407 408 /* toggle the RST bit low then high */ 409 bus_space_write_1(asc->sc_regt, asc->sc_regh, ELMC_CTRL, 410 ELMC_CTRL_BS3 | ELMC_CTRL_LOOP); 411 delay(1); /* should be > 500 ns */ 412 bus_space_write_1(asc->sc_regt, asc->sc_regh, ELMC_CTRL, 413 ELMC_CTRL_BS3 | ELMC_CTRL_LOOP | ELMC_CTRL_RST); 414 415 elmc_mca_attn(sc, why); 416 } 417 418 /* 419 * Interrupt hook. 420 */ 421 static int 422 elmc_mca_intrhook(sc, why) 423 struct ie_softc *sc; 424 int why; 425 { 426 switch (why) { 427 case INTR_ACK: 428 elmc_mca_attn(sc, CHIP_PROBE); 429 break; 430 default: 431 /* do nothing */ 432 break; 433 } 434 435 return (0); 436 } 437 438 CFATTACH_DECL(elmc_mca, sizeof(struct elmc_mca_softc), 439 elmc_mca_match, elmc_mca_attach, NULL, NULL); 440