1 /* $Id: ebus.c,v 1.64 2001/11/08 04:41:33 davem Exp $
2 * ebus.c: PCI to EBus bridge device.
4 * Copyright (C) 1997 Eddie C. Dost (ecd@skynet.be)
5 * Copyright (C) 1999 David S. Miller (davem@redhat.com)
8 #include <linux/config.h>
9 #include <linux/module.h>
10 #include <linux/kernel.h>
11 #include <linux/types.h>
12 #include <linux/init.h>
13 #include <linux/slab.h>
14 #include <linux/string.h>
15 #include <linux/interrupt.h>
16 #include <linux/delay.h>
18 #include <asm/system.h>
22 #include <asm/oplib.h>
26 /* EBUS dma library. */
28 #define EBDMA_CSR 0x00UL /* Control/Status */
29 #define EBDMA_ADDR 0x04UL /* DMA Address */
30 #define EBDMA_COUNT 0x08UL /* DMA Count */
32 #define EBDMA_CSR_INT_PEND 0x00000001
33 #define EBDMA_CSR_ERR_PEND 0x00000002
34 #define EBDMA_CSR_DRAIN 0x00000004
35 #define EBDMA_CSR_INT_EN 0x00000010
36 #define EBDMA_CSR_RESET 0x00000080
37 #define EBDMA_CSR_WRITE 0x00000100
38 #define EBDMA_CSR_EN_DMA 0x00000200
39 #define EBDMA_CSR_CYC_PEND 0x00000400
40 #define EBDMA_CSR_DIAG_RD_DONE 0x00000800
41 #define EBDMA_CSR_DIAG_WR_DONE 0x00001000
42 #define EBDMA_CSR_EN_CNT 0x00002000
43 #define EBDMA_CSR_TC 0x00004000
44 #define EBDMA_CSR_DIS_CSR_DRN 0x00010000
45 #define EBDMA_CSR_BURST_SZ_MASK 0x000c0000
46 #define EBDMA_CSR_BURST_SZ_1 0x00080000
47 #define EBDMA_CSR_BURST_SZ_4 0x00000000
48 #define EBDMA_CSR_BURST_SZ_8 0x00040000
49 #define EBDMA_CSR_BURST_SZ_16 0x000c0000
50 #define EBDMA_CSR_DIAG_EN 0x00100000
51 #define EBDMA_CSR_DIS_ERR_PEND 0x00400000
52 #define EBDMA_CSR_TCI_DIS 0x00800000
53 #define EBDMA_CSR_EN_NEXT 0x01000000
54 #define EBDMA_CSR_DMA_ON 0x02000000
55 #define EBDMA_CSR_A_LOADED 0x04000000
56 #define EBDMA_CSR_NA_LOADED 0x08000000
57 #define EBDMA_CSR_DEV_ID_MASK 0xf0000000
59 #define EBUS_DMA_RESET_TIMEOUT 10000
61 static void __ebus_dma_reset(struct ebus_dma_info *p, int no_drain)
66 writel(EBDMA_CSR_RESET, p->regs + EBDMA_CSR);
72 for (i = EBUS_DMA_RESET_TIMEOUT; i > 0; i--) {
73 val = readl(p->regs + EBDMA_CSR);
75 if (!(val & (EBDMA_CSR_DRAIN | EBDMA_CSR_CYC_PEND)))
81 static irqreturn_t ebus_dma_irq(int irq, void *dev_id, struct pt_regs *regs)
83 struct ebus_dma_info *p = dev_id;
87 spin_lock_irqsave(&p->lock, flags);
88 csr = readl(p->regs + EBDMA_CSR);
89 writel(csr, p->regs + EBDMA_CSR);
90 spin_unlock_irqrestore(&p->lock, flags);
92 if (csr & EBDMA_CSR_ERR_PEND) {
93 printk(KERN_CRIT "ebus_dma(%s): DMA error!\n", p->name);
94 p->callback(p, EBUS_DMA_EVENT_ERROR, p->client_cookie);
96 } else if (csr & EBDMA_CSR_INT_PEND) {
98 (csr & EBDMA_CSR_TC) ?
99 EBUS_DMA_EVENT_DMA : EBUS_DMA_EVENT_DEVICE,
108 int ebus_dma_register(struct ebus_dma_info *p)
114 if (p->flags & ~(EBUS_DMA_FLAG_USE_EBDMA_HANDLER |
115 EBUS_DMA_FLAG_TCI_DISABLE))
117 if ((p->flags & EBUS_DMA_FLAG_USE_EBDMA_HANDLER) && !p->callback)
119 if (!strlen(p->name))
122 __ebus_dma_reset(p, 1);
124 csr = EBDMA_CSR_BURST_SZ_16 | EBDMA_CSR_EN_CNT;
126 if (p->flags & EBUS_DMA_FLAG_TCI_DISABLE)
127 csr |= EBDMA_CSR_TCI_DIS;
129 writel(csr, p->regs + EBDMA_CSR);
133 EXPORT_SYMBOL(ebus_dma_register);
135 int ebus_dma_irq_enable(struct ebus_dma_info *p, int on)
141 if (p->flags & EBUS_DMA_FLAG_USE_EBDMA_HANDLER) {
142 if (request_irq(p->irq, ebus_dma_irq, SA_SHIRQ, p->name, p))
146 spin_lock_irqsave(&p->lock, flags);
147 csr = readl(p->regs + EBDMA_CSR);
148 csr |= EBDMA_CSR_INT_EN;
149 writel(csr, p->regs + EBDMA_CSR);
150 spin_unlock_irqrestore(&p->lock, flags);
152 spin_lock_irqsave(&p->lock, flags);
153 csr = readl(p->regs + EBDMA_CSR);
154 csr &= ~EBDMA_CSR_INT_EN;
155 writel(csr, p->regs + EBDMA_CSR);
156 spin_unlock_irqrestore(&p->lock, flags);
158 if (p->flags & EBUS_DMA_FLAG_USE_EBDMA_HANDLER) {
165 EXPORT_SYMBOL(ebus_dma_irq_enable);
167 void ebus_dma_unregister(struct ebus_dma_info *p)
173 spin_lock_irqsave(&p->lock, flags);
174 csr = readl(p->regs + EBDMA_CSR);
175 if (csr & EBDMA_CSR_INT_EN) {
176 csr &= ~EBDMA_CSR_INT_EN;
177 writel(csr, p->regs + EBDMA_CSR);
180 spin_unlock_irqrestore(&p->lock, flags);
185 EXPORT_SYMBOL(ebus_dma_unregister);
187 int ebus_dma_request(struct ebus_dma_info *p, dma_addr_t bus_addr, size_t len)
193 if (len >= (1 << 24))
196 spin_lock_irqsave(&p->lock, flags);
197 csr = readl(p->regs + EBDMA_CSR);
199 if (!(csr & EBDMA_CSR_EN_DMA))
202 if (csr & EBDMA_CSR_NA_LOADED)
205 writel(len, p->regs + EBDMA_COUNT);
206 writel(bus_addr, p->regs + EBDMA_ADDR);
210 spin_unlock_irqrestore(&p->lock, flags);
214 EXPORT_SYMBOL(ebus_dma_request);
216 void ebus_dma_prepare(struct ebus_dma_info *p, int write)
221 spin_lock_irqsave(&p->lock, flags);
222 __ebus_dma_reset(p, 0);
224 csr = (EBDMA_CSR_INT_EN |
226 EBDMA_CSR_BURST_SZ_16 |
230 csr |= EBDMA_CSR_WRITE;
231 if (p->flags & EBUS_DMA_FLAG_TCI_DISABLE)
232 csr |= EBDMA_CSR_TCI_DIS;
234 writel(csr, p->regs + EBDMA_CSR);
236 spin_unlock_irqrestore(&p->lock, flags);
238 EXPORT_SYMBOL(ebus_dma_prepare);
240 unsigned int ebus_dma_residue(struct ebus_dma_info *p)
242 return readl(p->regs + EBDMA_COUNT);
244 EXPORT_SYMBOL(ebus_dma_residue);
246 unsigned int ebus_dma_addr(struct ebus_dma_info *p)
248 return readl(p->regs + EBDMA_ADDR);
250 EXPORT_SYMBOL(ebus_dma_addr);
252 void ebus_dma_enable(struct ebus_dma_info *p, int on)
257 spin_lock_irqsave(&p->lock, flags);
258 orig_csr = csr = readl(p->regs + EBDMA_CSR);
260 csr |= EBDMA_CSR_EN_DMA;
262 csr &= ~EBDMA_CSR_EN_DMA;
263 if ((orig_csr & EBDMA_CSR_EN_DMA) !=
264 (csr & EBDMA_CSR_EN_DMA))
265 writel(csr, p->regs + EBDMA_CSR);
266 spin_unlock_irqrestore(&p->lock, flags);
268 EXPORT_SYMBOL(ebus_dma_enable);
270 struct linux_ebus *ebus_chain = NULL;
272 #ifdef CONFIG_SUN_AUXIO
273 extern void auxio_probe(void);
276 static inline void *ebus_alloc(size_t size)
280 mem = kzalloc(size, GFP_ATOMIC);
282 panic("ebus_alloc: out of memory");
286 int __init ebus_intmap_match(struct linux_ebus *ebus,
287 struct linux_prom_registers *reg,
290 struct linux_prom_ebus_intmap *imap;
291 struct linux_prom_ebus_intmask *imask;
292 unsigned int hi, lo, irq;
295 imap = of_get_property(ebus->prom_node, "interrupt-map", &len);
298 n_imap = len / sizeof(imap[0]);
300 imask = of_get_property(ebus->prom_node, "interrupt-map-mask", NULL);
304 hi = reg->which_io & imask->phys_hi;
305 lo = reg->phys_addr & imask->phys_lo;
306 irq = *interrupt & imask->interrupt;
307 for (i = 0; i < n_imap; i++) {
308 if ((imap[i].phys_hi == hi) &&
309 (imap[i].phys_lo == lo) &&
310 (imap[i].interrupt == irq)) {
311 *interrupt = imap[i].cinterrupt;
318 void __init fill_ebus_child(struct device_node *dp,
319 struct linux_prom_registers *preg,
320 struct linux_ebus_child *dev,
321 int non_standard_regs)
328 printk(" (%s)", dp->name);
330 regs = of_get_property(dp, "reg", &len);
334 dev->num_addrs = len / sizeof(regs[0]);
336 if (non_standard_regs) {
337 /* This is to handle reg properties which are not
338 * in the parent relative format. One example are
339 * children of the i2c device on CompactPCI systems.
341 * So, for such devices we just record the property
342 * raw in the child resources.
344 for (i = 0; i < dev->num_addrs; i++)
345 dev->resource[i].start = regs[i];
347 for (i = 0; i < dev->num_addrs; i++) {
349 if (rnum >= dev->parent->num_addrs) {
350 prom_printf("UGH: property for %s was %d, need < %d\n",
351 dp->name, len, dev->parent->num_addrs);
354 dev->resource[i].start = dev->parent->resource[i].start;
355 dev->resource[i].end = dev->parent->resource[i].end;
356 dev->resource[i].flags = IORESOURCE_MEM;
357 dev->resource[i].name = dp->name;
361 for (i = 0; i < PROMINTR_MAX; i++)
362 dev->irqs[i] = PCI_IRQ_NONE;
364 irqs = of_get_property(dp, "interrupts", &len);
368 * Oh, well, some PROMs don't export interrupts
369 * property to children of EBus devices...
371 * Be smart about PS/2 keyboard and mouse.
373 if (!strcmp(dev->parent->prom_node->name, "8042")) {
374 if (!strcmp(dev->prom_node->name, "kb_ps2")) {
376 dev->irqs[0] = dev->parent->irqs[0];
379 dev->irqs[0] = dev->parent->irqs[1];
383 dev->num_irqs = len / sizeof(irqs[0]);
384 for (i = 0; i < dev->num_irqs; i++) {
385 struct pci_pbm_info *pbm = dev->bus->parent;
386 struct pci_controller_info *p = pbm->parent;
388 if (ebus_intmap_match(dev->bus, preg, &irqs[i]) != -1) {
389 dev->irqs[i] = p->irq_build(pbm,
393 /* If we get a bogus interrupt property, just
394 * record the raw value instead of punting.
396 dev->irqs[i] = irqs[i];
402 static int __init child_regs_nonstandard(struct linux_ebus_device *dev)
404 if (!strcmp(dev->prom_node->name, "i2c") ||
405 !strcmp(dev->prom_node->name, "SUNW,lombus"))
410 void __init fill_ebus_device(struct device_node *dp, struct linux_ebus_device *dev)
412 struct linux_prom_registers *regs;
413 struct linux_ebus_child *child;
419 printk(" [%s", dp->name);
421 regs = of_get_property(dp, "reg", &len);
424 goto probe_interrupts;
427 if (len % sizeof(struct linux_prom_registers)) {
428 prom_printf("UGH: proplen for %s was %d, need multiple of %d\n",
429 dev->prom_node->name, len,
430 (int)sizeof(struct linux_prom_registers));
433 dev->num_addrs = len / sizeof(struct linux_prom_registers);
435 for (i = 0; i < dev->num_addrs; i++) {
436 /* XXX Learn how to interpret ebus ranges... -DaveM */
437 if (regs[i].which_io >= 0x10)
438 n = (regs[i].which_io - 0x10) >> 2;
440 n = regs[i].which_io;
442 dev->resource[i].start = dev->bus->self->resource[n].start;
443 dev->resource[i].start += (unsigned long)regs[i].phys_addr;
444 dev->resource[i].end =
445 (dev->resource[i].start + (unsigned long)regs[i].reg_size - 1UL);
446 dev->resource[i].flags = IORESOURCE_MEM;
447 dev->resource[i].name = dev->prom_node->name;
448 request_resource(&dev->bus->self->resource[n],
453 for (i = 0; i < PROMINTR_MAX; i++)
454 dev->irqs[i] = PCI_IRQ_NONE;
456 irqs = of_get_property(dp, "interrupts", &len);
460 dev->num_irqs = len / sizeof(irqs[0]);
461 for (i = 0; i < dev->num_irqs; i++) {
462 struct pci_pbm_info *pbm = dev->bus->parent;
463 struct pci_controller_info *p = pbm->parent;
465 if (ebus_intmap_match(dev->bus, ®s[0], &irqs[i]) != -1) {
466 dev->irqs[i] = p->irq_build(pbm,
470 /* If we get a bogus interrupt property, just
471 * record the raw value instead of punting.
473 dev->irqs[i] = irqs[i];
478 dev->ofdev.node = dp;
479 dev->ofdev.dev.parent = &dev->bus->ofdev.dev;
480 dev->ofdev.dev.bus = &ebus_bus_type;
481 strcpy(dev->ofdev.dev.bus_id, dp->path_component_name);
483 /* Register with core */
484 if (of_device_register(&dev->ofdev) != 0)
485 printk(KERN_DEBUG "ebus: device registration error for %s!\n",
486 dev->ofdev.dev.bus_id);
491 dev->children = ebus_alloc(sizeof(struct linux_ebus_child));
493 child = dev->children;
496 child->bus = dev->bus;
497 fill_ebus_child(dp, regs, child,
498 child_regs_nonstandard(dev));
500 while ((dp = dp->sibling) != NULL) {
501 child->next = ebus_alloc(sizeof(struct linux_ebus_child));
506 child->bus = dev->bus;
507 fill_ebus_child(dp, regs, child,
508 child_regs_nonstandard(dev));
514 static struct pci_dev *find_next_ebus(struct pci_dev *start, int *is_rio_p)
516 struct pci_dev *pdev = start;
518 while ((pdev = pci_get_device(PCI_VENDOR_ID_SUN, PCI_ANY_ID, pdev)))
519 if (pdev->device == PCI_DEVICE_ID_SUN_EBUS ||
520 pdev->device == PCI_DEVICE_ID_SUN_RIO_EBUS)
523 *is_rio_p = !!(pdev && (pdev->device == PCI_DEVICE_ID_SUN_RIO_EBUS));
528 void __init ebus_init(void)
530 struct pci_pbm_info *pbm;
531 struct linux_ebus_device *dev;
532 struct linux_ebus *ebus;
533 struct pci_dev *pdev;
534 struct pcidev_cookie *cookie;
535 struct device_node *dp;
539 pdev = find_next_ebus(NULL, &is_rio);
541 printk("ebus: No EBus's found.\n");
545 cookie = pdev->sysdata;
546 dp = cookie->prom_node;
548 ebus_chain = ebus = ebus_alloc(sizeof(struct linux_ebus));
550 ebus->is_rio = is_rio;
553 struct device_node *child;
555 /* SUNW,pci-qfe uses four empty ebuses on it.
556 I think we should not consider them here,
557 as they have half of the properties this
558 code expects and once we do PCI hot-plug,
559 we'd have to tweak with the ebus_chain
560 in the runtime after initialization. -jj */
562 pdev = find_next_ebus(pdev, &is_rio);
564 if (ebus == ebus_chain) {
566 printk("ebus: No EBus's found.\n");
571 ebus->is_rio = is_rio;
572 cookie = pdev->sysdata;
573 dp = cookie->prom_node;
576 printk("ebus%d:", num_ebus);
578 ebus->index = num_ebus;
579 ebus->prom_node = dp;
581 ebus->parent = pbm = cookie->pbm;
583 ebus->ofdev.node = dp;
584 ebus->ofdev.dev.parent = &pdev->dev;
585 ebus->ofdev.dev.bus = &ebus_bus_type;
586 strcpy(ebus->ofdev.dev.bus_id, dp->path_component_name);
588 /* Register with core */
589 if (of_device_register(&ebus->ofdev) != 0)
590 printk(KERN_DEBUG "ebus: device registration error for %s!\n",
591 ebus->ofdev.dev.bus_id);
598 ebus->devices = ebus_alloc(sizeof(struct linux_ebus_device));
602 dev->children = NULL;
604 fill_ebus_device(child, dev);
606 while ((child = child->sibling) != NULL) {
607 dev->next = ebus_alloc(sizeof(struct linux_ebus_device));
611 dev->children = NULL;
613 fill_ebus_device(child, dev);
619 pdev = find_next_ebus(pdev, &is_rio);
623 cookie = pdev->sysdata;
624 dp = cookie->prom_node;
626 ebus->next = ebus_alloc(sizeof(struct linux_ebus));
629 ebus->is_rio = is_rio;
632 pci_dev_put(pdev); /* XXX for the case, when ebusnd is 0, is it OK? */
634 #ifdef CONFIG_SUN_AUXIO