1 /* $NetBSD: ebus.c,v 1.24 2005/11/24 13:33:33 he Exp $ */ 2 3 /* 4 * Copyright (c) 1999, 2000 Matthew R. Green 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 23 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 25 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31 /* 32 * EBus support for PCI based SPARC systems (ms-IIep, Ultra). 33 * EBus is documented in PCIO manual (Sun Part#: 802-7837-01). 34 */ 35 36 #include <sys/cdefs.h> 37 __KERNEL_RCSID(0, "$NetBSD: ebus.c,v 1.24 2005/11/24 13:33:33 he Exp $"); 38 39 #if defined(DEBUG) && !defined(EBUS_DEBUG) 40 #define EBUS_DEBUG 41 #endif 42 43 #ifdef EBUS_DEBUG 44 #define EDB_PROM 0x01 45 #define EDB_CHILD 0x02 46 #define EDB_INTRMAP 0x04 47 #define EDB_BUSMAP 0x08 48 #define EDB_BUSDMA 0x10 49 #define EDB_INTR 0x20 50 int ebus_debug = 0; 51 #define DPRINTF(l, s) do { if (ebus_debug & l) printf s; } while (0) 52 #else 53 #define DPRINTF(l, s) 54 #endif 55 56 #include <sys/param.h> 57 #include <sys/systm.h> 58 #include <sys/device.h> 59 #include <sys/errno.h> 60 #include <sys/malloc.h> 61 #include <sys/callout.h> 62 #include <sys/kernel.h> 63 64 #define _SPARC_BUS_DMA_PRIVATE 65 #include <machine/bus.h> 66 #include <machine/autoconf.h> 67 68 #include <dev/pci/pcivar.h> 69 #include <dev/pci/pcireg.h> 70 #include <dev/pci/pcidevs.h> 71 72 #include <dev/ofw/ofw_pci.h> 73 74 #include <dev/ebus/ebusreg.h> 75 #include <dev/ebus/ebusvar.h> 76 77 #include "opt_blink.h" 78 79 volatile uint32_t *ebus_LED = NULL; 80 81 #ifdef BLINK 82 static struct callout ebus_blink_ch = CALLOUT_INITIALIZER; 83 84 static void ebus_blink(void *); 85 #endif 86 87 struct ebus_softc { 88 struct device sc_dev; 89 struct device *sc_parent; /* PCI bus */ 90 91 int sc_node; /* PROM node */ 92 93 bus_space_tag_t sc_bustag; /* mem tag from pci */ 94 95 /* 96 * "reg" contains exactly the info we'd get by processing 97 * "ranges", so don't bother with "ranges" and use "reg" directly. 98 */ 99 struct ofw_pci_register *sc_reg; 100 int sc_nreg; 101 }; 102 103 static int ebus_match(struct device *, struct cfdata *, void *); 104 static void ebus_attach(struct device *, struct device *, void *); 105 106 CFATTACH_DECL(ebus, sizeof(struct ebus_softc), 107 ebus_match, ebus_attach, NULL, NULL); 108 109 static int ebus_setup_attach_args(struct ebus_softc *, bus_space_tag_t, 110 bus_dma_tag_t, int, struct ebus_attach_args *); 111 static void ebus_destroy_attach_args(struct ebus_attach_args *); 112 static int ebus_print(void *, const char *); 113 114 /* 115 * here are our bus space and bus DMA routines. 116 */ 117 static paddr_t ebus_bus_mmap(bus_space_tag_t, bus_addr_t, off_t, int, int); 118 static int _ebus_bus_map(bus_space_tag_t, bus_addr_t, bus_size_t, int, 119 vaddr_t, bus_space_handle_t *); 120 static void *ebus_intr_establish(bus_space_tag_t, int, int, 121 int (*)(void *), void *, void (*)(void)); 122 123 static bus_dma_tag_t ebus_alloc_dma_tag(struct ebus_softc *, bus_dma_tag_t); 124 125 126 /* 127 * Working around PROM bogosity. 128 * 129 * EBus doesn't have official OFW binding. sparc64 has a de-facto 130 * standard but patching it in in prompatch.c and then decoding it 131 * here would be an overkill for ms-IIep. 132 * 133 * So we assume that all ms-IIep based systems use PCIO chip only in 134 * "motherboard mode" with interrupt lines wired directly to ms-IIep 135 * interrupt inputs. 136 * 137 * Note that this is ineligible for prompatch.c, as we are not 138 * correcting PROM to conform to some established standard, this hack 139 * is tied to this version of ebus driver and as such it's better stay 140 * private to the driver. 141 */ 142 143 struct msiiep_ebus_intr_wiring { 144 const char *name; /* PROM node */ 145 int line; /* ms-IIep interrupt input */ 146 }; 147 148 static const struct msiiep_ebus_intr_wiring krups_ebus_intr_wiring[] = { 149 { "su", 0 }, { "8042", 0 }, { "sound", 3 } 150 }; 151 152 153 struct msiiep_known_ebus_wiring { 154 const char *model; 155 const struct msiiep_ebus_intr_wiring *map; 156 int mapsize; 157 }; 158 159 #define MSIIEP_MODEL_WIRING(name, map) \ 160 { name, map, sizeof(map)/sizeof(map[0]) } 161 162 static const struct msiiep_known_ebus_wiring known_models[] = { 163 MSIIEP_MODEL_WIRING("SUNW,501-4267", krups_ebus_intr_wiring), 164 { NULL, NULL, 0} 165 }; 166 167 168 /* 169 * XXX: This assumes single EBus. However I don't think any ms-IIep 170 * system ever used more than one. In any case, without looking at a 171 * system with multiple PCIO chips I don't know how to correctly 172 * program the driver to handle PROM glitches in them, so for the time 173 * being just use globals. 174 */ 175 static const struct msiiep_ebus_intr_wiring *wiring_map; 176 static int wiring_map_size; 177 178 static int ebus_init_wiring_table(struct ebus_softc *); 179 180 181 static int 182 ebus_match(struct device *parent, struct cfdata *match, void *aux) 183 { 184 struct pci_attach_args *pa = aux; 185 char name[10]; 186 int node; 187 188 /* Only attach if there's a PROM node. */ 189 node = PCITAG_NODE(pa->pa_tag); 190 if (node == -1) 191 return (0); 192 193 prom_getpropstringA(node, "name", name, sizeof name); 194 if (PCI_CLASS(pa->pa_class) == PCI_CLASS_BRIDGE 195 && PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN 196 && PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_EBUS 197 && strcmp(name, "ebus") == 0) 198 return (1); 199 200 return (0); 201 } 202 203 204 static int 205 ebus_init_wiring_table(struct ebus_softc *sc) 206 { 207 const struct msiiep_known_ebus_wiring *p; 208 char buf[32]; 209 char *model; 210 211 if (wiring_map != NULL) { 212 printf("%s: global ebus wiring map already initalized\n", 213 sc->sc_dev.dv_xname); 214 return (0); 215 } 216 217 model = prom_getpropstringA(prom_findroot(), "model", 218 buf, sizeof(buf)); 219 if (model == NULL) 220 panic("ebus_init_wiring_table: no \"model\" property"); 221 222 for (p = known_models; p->model != NULL; ++p) 223 if (strcmp(model, p->model) == 0) { 224 wiring_map = p->map; 225 wiring_map_size = p->mapsize; 226 return (1); 227 } 228 229 /* not found? we should have failed in pci_attach_hook then. */ 230 panic("ebus_init_wiring_table: unknown model %s", model); 231 } 232 233 234 /* 235 * attach an ebus and all it's children. this code is modeled 236 * after the sbus code which does similar things. 237 */ 238 static void 239 ebus_attach(struct device *parent, struct device *self, void *aux) 240 { 241 struct ebus_softc *sc = (struct ebus_softc *)self; 242 struct pci_attach_args *pa = aux; 243 struct ebus_attach_args ea; 244 bus_space_tag_t sbt; 245 bus_dma_tag_t dmatag; 246 bus_space_handle_t hLED; 247 pcireg_t base14; 248 int node, error; 249 char devinfo[256]; 250 251 pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo)); 252 printf(": %s, revision 0x%02x\n", 253 devinfo, PCI_REVISION(pa->pa_class)); 254 255 node = PCITAG_NODE(pa->pa_tag); 256 if (node == -1) 257 panic("%s: unable to find ebus node", self->dv_xname); 258 259 if (ebus_init_wiring_table(sc) == 0) 260 return; 261 262 /* map the LED register */ 263 base14 = pci_conf_read(pa->pa_pc, pa->pa_tag, 0x14); 264 printf("base14: %08x\n", (uint32_t)base14); 265 if (bus_space_map(pa->pa_memt, base14 + 0x726000, 4, 0, &hLED) == 0) { 266 ebus_LED = bus_space_vaddr(pa->pa_memt, hLED); 267 #ifdef BLINK 268 ebus_blink((caddr_t)0); 269 #endif 270 } else { 271 printf("unable to map the LED register\n"); 272 } 273 274 sc->sc_node = node; 275 sc->sc_parent = parent; /* XXX: unused so far */ 276 sc->sc_bustag = pa->pa_memt; /* EBus only does PCI MEM32 space */ 277 278 if ((sbt = bus_space_tag_alloc(sc->sc_bustag, sc)) == NULL) 279 panic("unable to allocate ebus bus tag"); 280 281 sbt->sparc_bus_map = _ebus_bus_map; 282 sbt->sparc_bus_mmap = ebus_bus_mmap; 283 sbt->sparc_intr_establish = ebus_intr_establish; 284 285 dmatag = ebus_alloc_dma_tag(sc, pa->pa_dmat); 286 287 /* 288 * Setup ranges. The interesting thing is that we use "reg" 289 * not "ranges", since "reg" on ebus has exactly the data we'd 290 * get by processing "ranges". 291 */ 292 error = prom_getprop(node, "reg", sizeof(struct ofw_pci_register), 293 &sc->sc_nreg, &sc->sc_reg); 294 if (error) 295 panic("%s: unable to read ebus registers (error %d)", 296 self->dv_xname, error); 297 298 /* 299 * now attach all our children 300 */ 301 DPRINTF(EDB_CHILD, ("ebus node %08x, searching children...\n", node)); 302 for (node = firstchild(node); node; node = nextsibling(node)) { 303 char *name = prom_getpropstring(node, "name"); 304 305 if (ebus_setup_attach_args(sc, sbt, dmatag, node, &ea) != 0) { 306 printf("ebus_attach: %s: incomplete\n", name); 307 continue; 308 } 309 DPRINTF(EDB_CHILD, 310 ("- found child `%s', attaching\n", ea.ea_name)); 311 (void)config_found(self, &ea, ebus_print); 312 ebus_destroy_attach_args(&ea); 313 } 314 } 315 316 static int 317 ebus_setup_attach_args(struct ebus_softc *sc, 318 bus_space_tag_t bustag, bus_dma_tag_t dmatag, int node, 319 struct ebus_attach_args *ea) 320 { 321 int n, err; 322 323 memset(ea, 0, sizeof(struct ebus_attach_args)); 324 325 err = prom_getprop(node, "name", 1, &n, &ea->ea_name); 326 if (err != 0) 327 return (err); 328 ea->ea_name[n] = '\0'; 329 330 ea->ea_node = node; 331 ea->ea_bustag = bustag; 332 ea->ea_dmatag = dmatag; 333 334 err = prom_getprop(node, "reg", sizeof(struct ebus_regs), 335 &ea->ea_nreg, &ea->ea_reg); 336 if (err != 0) 337 return (err); 338 339 /* 340 * On Ultra the bar is the _offset_ of the BAR in PCI config 341 * space but in (some?) ms-IIep systems (e.g. Krups) it's the 342 * _number_ of the BAR - e.g. BAR1 is represented by 1 in 343 * Krups PROM, while on Ultra it's 0x14. Fix it here. 344 */ 345 for (n = 0; n < ea->ea_nreg; ++n) 346 if (ea->ea_reg[n].hi < PCI_MAPREG_START) { 347 ea->ea_reg[n].hi = PCI_MAPREG_START 348 + ea->ea_reg[n].hi * sizeof(pcireg_t); 349 } 350 351 err = prom_getprop(node, "address", sizeof(uint32_t), 352 &ea->ea_nvaddr, &ea->ea_vaddr); 353 if (err != ENOENT) { 354 if (err != 0) 355 return (err); 356 357 if (ea->ea_nreg != ea->ea_nvaddr) 358 printf("ebus loses: device %s: %d regs and %d addrs\n", 359 ea->ea_name, ea->ea_nreg, ea->ea_nvaddr); 360 } else 361 ea->ea_nvaddr = 0; 362 363 /* XXX: "interrupts" hack */ 364 for (n = 0; n < wiring_map_size; ++n) { 365 const struct msiiep_ebus_intr_wiring *w = &wiring_map[n]; 366 if (strcmp(w->name, ea->ea_name) == 0) { 367 ea->ea_intr = malloc(sizeof(uint32_t), 368 M_DEVBUF, M_NOWAIT); 369 ea->ea_intr[0] = w->line; 370 ea->ea_nintr = 1; 371 break; 372 } 373 } 374 375 return (0); 376 } 377 378 static void 379 ebus_destroy_attach_args(struct ebus_attach_args *ea) 380 { 381 382 if (ea->ea_name) 383 free((void *)ea->ea_name, M_DEVBUF); 384 if (ea->ea_reg) 385 free((void *)ea->ea_reg, M_DEVBUF); 386 if (ea->ea_intr) 387 free((void *)ea->ea_intr, M_DEVBUF); 388 if (ea->ea_vaddr) 389 free((void *)ea->ea_vaddr, M_DEVBUF); 390 } 391 392 static int 393 ebus_print(void *aux, const char *p) 394 { 395 struct ebus_attach_args *ea = aux; 396 int i; 397 398 if (p) 399 aprint_normal("%s at %s", ea->ea_name, p); 400 for (i = 0; i < ea->ea_nreg; ++i) 401 aprint_normal("%s bar %x offset 0x%x", i == 0 ? "" : ",", 402 ea->ea_reg[i].hi, ea->ea_reg[i].lo); 403 for (i = 0; i < ea->ea_nintr; ++i) 404 aprint_normal(" line %d", ea->ea_intr[i]); 405 return (UNCONF); 406 } 407 408 409 /* 410 * bus space and bus DMA methods below here 411 */ 412 static bus_dma_tag_t 413 ebus_alloc_dma_tag(struct ebus_softc *sc, bus_dma_tag_t pdt) 414 { 415 bus_dma_tag_t dt; 416 417 dt = (bus_dma_tag_t) 418 malloc(sizeof(struct sparc_bus_dma_tag), M_DEVBUF, M_NOWAIT); 419 if (dt == NULL) 420 panic("unable to allocate ebus DMA tag"); 421 422 memset(dt, 0, sizeof *dt); 423 dt->_cookie = sc; 424 #define PCOPY(x) dt->x = pdt->x 425 PCOPY(_dmamap_create); 426 PCOPY(_dmamap_destroy); 427 PCOPY(_dmamap_load); 428 PCOPY(_dmamap_load_mbuf); 429 PCOPY(_dmamap_load_uio); 430 PCOPY(_dmamap_load_raw); 431 PCOPY(_dmamap_unload); 432 PCOPY(_dmamap_sync); 433 PCOPY(_dmamem_alloc); 434 PCOPY(_dmamem_free); 435 PCOPY(_dmamem_map); 436 PCOPY(_dmamem_unmap); 437 PCOPY(_dmamem_mmap); 438 #undef PCOPY 439 return (dt); 440 } 441 442 /* 443 * bus space support. <sparc64/dev/psychoreg.h> has a discussion 444 * about PCI physical addresses, which also applies to ebus. 445 */ 446 static int 447 _ebus_bus_map(bus_space_tag_t t, bus_addr_t ba, bus_size_t size, int flags, 448 vaddr_t va, bus_space_handle_t *hp) 449 { 450 struct ebus_softc *sc = t->cookie; 451 u_int bar; 452 paddr_t offset; 453 int i; 454 455 bar = BUS_ADDR_IOSPACE(ba); 456 offset = BUS_ADDR_PADDR(ba); 457 458 DPRINTF(EDB_BUSMAP, 459 ("\n_ebus_bus_map: bar %d offset %08x sz %x flags %x va %p\n", 460 (int)bar, (uint32_t)offset, (uint32_t)size, 461 flags, (void *)va)); 462 463 /* EBus has only two BARs */ 464 if (PCI_MAPREG_NUM(bar) > 1) { 465 DPRINTF(EDB_BUSMAP, 466 ("\n_ebus_bus_map: impossible bar\n")); 467 return (EINVAL); 468 } 469 470 /* 471 * Almost all of the interesting ebus children are mapped by 472 * BAR1, the last entry in sc_reg[], so work our way backwards. 473 */ 474 for (i = sc->sc_nreg - 1; i >= 0; --i) { 475 bus_addr_t pciaddr; 476 uint32_t ss; 477 478 /* EBus only does MEM32 */ 479 ss = sc->sc_reg[i].phys_hi & OFW_PCI_PHYS_HI_SPACEMASK; 480 if (ss != OFW_PCI_PHYS_HI_SPACE_MEM32) 481 continue; 482 483 if (bar != (sc->sc_reg[i].phys_hi 484 & OFW_PCI_PHYS_HI_REGISTERMASK)) 485 continue; 486 487 pciaddr = (bus_addr_t)sc->sc_reg[i].phys_lo + offset; 488 489 if (pciaddr + size > sc->sc_reg[i].phys_lo 490 + sc->sc_reg[i].size_lo) 491 continue; 492 493 DPRINTF(EDB_BUSMAP, 494 ("_ebus_bus_map: mapping to PCI addr %x\n", 495 (uint32_t)pciaddr)); 496 497 /* pass it onto the pci controller */ 498 return (bus_space_map2(t->parent, pciaddr, size, 499 flags, va, hp)); 500 } 501 502 DPRINTF(EDB_BUSMAP, (": FAILED\n")); 503 return (EINVAL); 504 } 505 506 static paddr_t 507 ebus_bus_mmap(bus_space_tag_t t, bus_addr_t ba, off_t off, int prot, int flags) 508 { 509 510 /* XXX: not implemented yet */ 511 return (-1); 512 } 513 514 /* 515 * Install an interrupt handler for a EBus device. 516 */ 517 static void * 518 ebus_intr_establish(bus_space_tag_t t, int pri, int level, 519 int (*handler)(void *), void *arg, 520 void (*fastvec)(void)) 521 { 522 523 return (bus_intr_establish(t->parent, pri, level, handler, arg)); 524 } 525 526 #ifdef BLINK 527 528 static void 529 ebus_blink(void *zero) 530 { 531 register int s; 532 533 s = splhigh(); 534 *ebus_LED = ~*ebus_LED; 535 splx(s); 536 /* 537 * Blink rate is: 538 * full cycle every second if completely idle (loadav = 0) 539 * full cycle every 2 seconds if loadav = 1 540 * full cycle every 3 seconds if loadav = 2 541 * etc. 542 */ 543 s = (((averunnable.ldavg[0] + FSCALE) * hz) >> (FSHIFT + 1)); 544 callout_reset(&ebus_blink_ch, s, ebus_blink, NULL); 545 } 546 #endif 547