3 #include <linux/kernel.h>
4 #include <linux/string.h>
5 #include <linux/pci_regs.h>
6 #include <linux/module.h>
7 #include <linux/ioport.h>
9 #include <asm/pci-bridge.h>
12 #define DBG(fmt...) do { printk(fmt); } while(0)
14 #define DBG(fmt...) do { } while(0)
23 /* Max address size we deal with */
24 #define OF_MAX_ADDR_CELLS 4
25 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
28 static struct of_bus *of_match_bus(struct device_node *np);
29 static int __of_address_to_resource(struct device_node *dev,
30 const u32 *addrp, u64 size, unsigned int flags,
36 static void of_dump_addr(const char *s, const u32 *addr, int na)
40 printk(" %08x", *(addr++));
44 static void of_dump_addr(const char *s, const u32 *addr, int na) { }
48 /* Callbacks for bus specific translators */
51 const char *addresses;
52 int (*match)(struct device_node *parent);
53 void (*count_cells)(struct device_node *child,
54 int *addrc, int *sizec);
55 u64 (*map)(u32 *addr, const u32 *range,
56 int na, int ns, int pna);
57 int (*translate)(u32 *addr, u64 offset, int na);
58 unsigned int (*get_flags)(const u32 *addr);
63 * Default translator (generic bus)
66 static void of_bus_default_count_cells(struct device_node *dev,
67 int *addrc, int *sizec)
70 *addrc = prom_n_addr_cells(dev);
72 *sizec = prom_n_size_cells(dev);
75 static u64 of_bus_default_map(u32 *addr, const u32 *range,
76 int na, int ns, int pna)
80 cp = of_read_number(range, na);
81 s = of_read_number(range + na + pna, ns);
82 da = of_read_number(addr, na);
84 DBG("OF: default map, cp="PRu64", s="PRu64", da="PRu64"\n",
87 if (da < cp || da >= (cp + s))
92 static int of_bus_default_translate(u32 *addr, u64 offset, int na)
94 u64 a = of_read_number(addr, na);
95 memset(addr, 0, na * 4);
98 addr[na - 2] = a >> 32;
99 addr[na - 1] = a & 0xffffffffu;
104 static unsigned int of_bus_default_get_flags(const u32 *addr)
106 return IORESOURCE_MEM;
112 * PCI bus specific translator
115 static int of_bus_pci_match(struct device_node *np)
117 /* "vci" is for the /chaos bridge on 1st-gen PCI powermacs */
118 return !strcmp(np->type, "pci") || !strcmp(np->type, "vci");
121 static void of_bus_pci_count_cells(struct device_node *np,
122 int *addrc, int *sizec)
130 static u64 of_bus_pci_map(u32 *addr, const u32 *range, int na, int ns, int pna)
134 /* Check address type match */
135 if ((addr[0] ^ range[0]) & 0x03000000)
138 /* Read address values, skipping high cell */
139 cp = of_read_number(range + 1, na - 1);
140 s = of_read_number(range + na + pna, ns);
141 da = of_read_number(addr + 1, na - 1);
143 DBG("OF: PCI map, cp="PRu64", s="PRu64", da="PRu64"\n", cp, s, da);
145 if (da < cp || da >= (cp + s))
150 static int of_bus_pci_translate(u32 *addr, u64 offset, int na)
152 return of_bus_default_translate(addr + 1, offset, na - 1);
155 static unsigned int of_bus_pci_get_flags(const u32 *addr)
157 unsigned int flags = 0;
160 switch((w >> 24) & 0x03) {
162 flags |= IORESOURCE_IO;
164 case 0x02: /* 32 bits */
165 case 0x03: /* 64 bits */
166 flags |= IORESOURCE_MEM;
170 flags |= IORESOURCE_PREFETCH;
174 const u32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
179 struct device_node *parent;
181 int onesize, i, na, ns;
183 /* Get parent & match bus type */
184 parent = of_get_parent(dev);
187 bus = of_match_bus(parent);
188 if (strcmp(bus->name, "pci")) {
192 bus->count_cells(dev, &na, &ns);
194 if (!OF_CHECK_COUNTS(na, ns))
197 /* Get "reg" or "assigned-addresses" property */
198 prop = get_property(dev, bus->addresses, &psize);
204 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
205 if ((prop[0] & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0)) {
207 *size = of_read_number(prop + na, ns);
209 *flags = bus->get_flags(prop);
214 EXPORT_SYMBOL(of_get_pci_address);
216 int of_pci_address_to_resource(struct device_node *dev, int bar,
223 addrp = of_get_pci_address(dev, bar, &size, &flags);
226 return __of_address_to_resource(dev, addrp, size, flags, r);
228 EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
230 static u8 of_irq_pci_swizzle(u8 slot, u8 pin)
232 return (((pin - 1) + slot) % 4) + 1;
235 int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq)
237 struct device_node *dn, *ppnode;
238 struct pci_dev *ppdev;
244 /* Check if we have a device node, if yes, fallback to standard OF
247 dn = pci_device_to_OF_node(pdev);
249 return of_irq_map_one(dn, 0, out_irq);
251 /* Ok, we don't, time to have fun. Let's start by building up an
252 * interrupt spec. we assume #interrupt-cells is 1, which is standard
253 * for PCI. If you do different, then don't use that routine.
255 rc = pci_read_config_byte(pdev, PCI_INTERRUPT_PIN, &pin);
262 /* Now we walk up the PCI tree */
265 /* Get the pci_dev of our parent */
266 ppdev = pdev->bus->self;
268 /* Ouch, it's a host bridge... */
271 ppnode = pci_bus_to_OF_node(pdev->bus);
273 struct pci_controller *host;
274 host = pci_bus_to_host(pdev->bus);
275 ppnode = host ? host->arch_data : NULL;
277 /* No node for host bridge ? give up */
281 /* We found a P2P bridge, check if it has a node */
282 ppnode = pci_device_to_OF_node(ppdev);
284 /* Ok, we have found a parent with a device-node, hand over to
285 * the OF parsing code.
286 * We build a unit address from the linux device to be used for
287 * resolution. Note that we use the linux bus number which may
288 * not match your firmware bus numbering.
289 * Fortunately, in most cases, interrupt-map-mask doesn't include
290 * the bus number as part of the matching.
291 * You should still be careful about that though if you intend
292 * to rely on this function (you ship a firmware that doesn't
293 * create device nodes for all PCI devices).
298 /* We can only get here if we hit a P2P bridge with no node,
299 * let's do standard swizzling and try again
301 lspec = of_irq_pci_swizzle(PCI_SLOT(pdev->devfn), lspec);
305 laddr[0] = (pdev->bus->number << 16)
306 | (pdev->devfn << 8);
307 laddr[1] = laddr[2] = 0;
308 return of_irq_map_raw(ppnode, &lspec, 1, laddr, out_irq);
310 EXPORT_SYMBOL_GPL(of_irq_map_pci);
311 #endif /* CONFIG_PCI */
314 * ISA bus specific translator
317 static int of_bus_isa_match(struct device_node *np)
319 return !strcmp(np->name, "isa");
322 static void of_bus_isa_count_cells(struct device_node *child,
323 int *addrc, int *sizec)
331 static u64 of_bus_isa_map(u32 *addr, const u32 *range, int na, int ns, int pna)
335 /* Check address type match */
336 if ((addr[0] ^ range[0]) & 0x00000001)
339 /* Read address values, skipping high cell */
340 cp = of_read_number(range + 1, na - 1);
341 s = of_read_number(range + na + pna, ns);
342 da = of_read_number(addr + 1, na - 1);
344 DBG("OF: ISA map, cp="PRu64", s="PRu64", da="PRu64"\n", cp, s, da);
346 if (da < cp || da >= (cp + s))
351 static int of_bus_isa_translate(u32 *addr, u64 offset, int na)
353 return of_bus_default_translate(addr + 1, offset, na - 1);
356 static unsigned int of_bus_isa_get_flags(const u32 *addr)
358 unsigned int flags = 0;
362 flags |= IORESOURCE_IO;
364 flags |= IORESOURCE_MEM;
370 * Array of bus specific translators
373 static struct of_bus of_busses[] = {
378 .addresses = "assigned-addresses",
379 .match = of_bus_pci_match,
380 .count_cells = of_bus_pci_count_cells,
381 .map = of_bus_pci_map,
382 .translate = of_bus_pci_translate,
383 .get_flags = of_bus_pci_get_flags,
385 #endif /* CONFIG_PCI */
390 .match = of_bus_isa_match,
391 .count_cells = of_bus_isa_count_cells,
392 .map = of_bus_isa_map,
393 .translate = of_bus_isa_translate,
394 .get_flags = of_bus_isa_get_flags,
401 .count_cells = of_bus_default_count_cells,
402 .map = of_bus_default_map,
403 .translate = of_bus_default_translate,
404 .get_flags = of_bus_default_get_flags,
408 static struct of_bus *of_match_bus(struct device_node *np)
412 for (i = 0; i < ARRAY_SIZE(of_busses); i ++)
413 if (!of_busses[i].match || of_busses[i].match(np))
414 return &of_busses[i];
419 static int of_translate_one(struct device_node *parent, struct of_bus *bus,
420 struct of_bus *pbus, u32 *addr,
421 int na, int ns, int pna)
426 u64 offset = OF_BAD_ADDR;
428 /* Normally, an absence of a "ranges" property means we are
429 * crossing a non-translatable boundary, and thus the addresses
430 * below the current not cannot be converted to CPU physical ones.
431 * Unfortunately, while this is very clear in the spec, it's not
432 * what Apple understood, and they do have things like /uni-n or
433 * /ht nodes with no "ranges" property and a lot of perfectly
434 * useable mapped devices below them. Thus we treat the absence of
435 * "ranges" as equivalent to an empty "ranges" property which means
436 * a 1:1 translation at that level. It's up to the caller not to try
437 * to translate addresses that aren't supposed to be translated in
438 * the first place. --BenH.
440 ranges = get_property(parent, "ranges", &rlen);
441 if (ranges == NULL || rlen == 0) {
442 offset = of_read_number(addr, na);
443 memset(addr, 0, pna * 4);
444 DBG("OF: no ranges, 1:1 translation\n");
448 DBG("OF: walking ranges...\n");
450 /* Now walk through the ranges */
452 rone = na + pna + ns;
453 for (; rlen >= rone; rlen -= rone, ranges += rone) {
454 offset = bus->map(addr, ranges, na, ns, pna);
455 if (offset != OF_BAD_ADDR)
458 if (offset == OF_BAD_ADDR) {
459 DBG("OF: not found !\n");
462 memcpy(addr, ranges + na, 4 * pna);
465 of_dump_addr("OF: parent translation for:", addr, pna);
466 DBG("OF: with offset: "PRu64"\n", offset);
468 /* Translate it into parent bus space */
469 return pbus->translate(addr, offset, pna);
474 * Translate an address from the device-tree into a CPU physical address,
475 * this walks up the tree and applies the various bus mappings on the
478 * Note: We consider that crossing any level with #size-cells == 0 to mean
479 * that translation is impossible (that is we are not dealing with a value
480 * that can be mapped to a cpu physical address). This is not really specified
481 * that way, but this is traditionally the way IBM at least do things
483 u64 of_translate_address(struct device_node *dev, const u32 *in_addr)
485 struct device_node *parent = NULL;
486 struct of_bus *bus, *pbus;
487 u32 addr[OF_MAX_ADDR_CELLS];
488 int na, ns, pna, pns;
489 u64 result = OF_BAD_ADDR;
491 DBG("OF: ** translation for device %s **\n", dev->full_name);
493 /* Increase refcount at current level */
496 /* Get parent & match bus type */
497 parent = of_get_parent(dev);
500 bus = of_match_bus(parent);
502 /* Cound address cells & copy address locally */
503 bus->count_cells(dev, &na, &ns);
504 if (!OF_CHECK_COUNTS(na, ns)) {
505 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
509 memcpy(addr, in_addr, na * 4);
511 DBG("OF: bus is %s (na=%d, ns=%d) on %s\n",
512 bus->name, na, ns, parent->full_name);
513 of_dump_addr("OF: translating address:", addr, na);
517 /* Switch to parent bus */
520 parent = of_get_parent(dev);
522 /* If root, we have finished */
523 if (parent == NULL) {
524 DBG("OF: reached root node\n");
525 result = of_read_number(addr, na);
529 /* Get new parent bus and counts */
530 pbus = of_match_bus(parent);
531 pbus->count_cells(dev, &pna, &pns);
532 if (!OF_CHECK_COUNTS(pna, pns)) {
533 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
538 DBG("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
539 pbus->name, pna, pns, parent->full_name);
541 /* Apply bus translation */
542 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna))
545 /* Complete the move up one level */
550 of_dump_addr("OF: one level translation:", addr, na);
558 EXPORT_SYMBOL(of_translate_address);
560 const u32 *of_get_address(struct device_node *dev, int index, u64 *size,
565 struct device_node *parent;
567 int onesize, i, na, ns;
569 /* Get parent & match bus type */
570 parent = of_get_parent(dev);
573 bus = of_match_bus(parent);
574 bus->count_cells(dev, &na, &ns);
576 if (!OF_CHECK_COUNTS(na, ns))
579 /* Get "reg" or "assigned-addresses" property */
580 prop = get_property(dev, bus->addresses, &psize);
586 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
589 *size = of_read_number(prop + na, ns);
591 *flags = bus->get_flags(prop);
596 EXPORT_SYMBOL(of_get_address);
598 static int __of_address_to_resource(struct device_node *dev, const u32 *addrp,
599 u64 size, unsigned int flags,
604 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
606 taddr = of_translate_address(dev, addrp);
607 if (taddr == OF_BAD_ADDR)
609 memset(r, 0, sizeof(struct resource));
610 if (flags & IORESOURCE_IO) {
612 port = pci_address_to_pio(taddr);
613 if (port == (unsigned long)-1)
616 r->end = port + size - 1;
619 r->end = taddr + size - 1;
626 int of_address_to_resource(struct device_node *dev, int index,
633 addrp = of_get_address(dev, index, &size, &flags);
636 return __of_address_to_resource(dev, addrp, size, flags, r);
638 EXPORT_SYMBOL_GPL(of_address_to_resource);
640 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
641 unsigned long *busno, unsigned long *phys, unsigned long *size)
643 const u32 *dma_window;
645 const unsigned char *prop;
647 dma_window = dma_window_prop;
649 /* busno is always one cell */
650 *busno = *(dma_window++);
652 prop = get_property(dn, "ibm,#dma-address-cells", NULL);
654 prop = get_property(dn, "#address-cells", NULL);
656 cells = prop ? *(u32 *)prop : prom_n_addr_cells(dn);
657 *phys = of_read_number(dma_window, cells);
661 prop = get_property(dn, "ibm,#dma-size-cells", NULL);
662 cells = prop ? *(u32 *)prop : prom_n_size_cells(dn);
663 *size = of_read_number(dma_window, cells);
670 static unsigned int of_irq_workarounds;
671 static struct device_node *of_irq_dflt_pic;
673 static struct device_node *of_irq_find_parent(struct device_node *child)
675 struct device_node *p;
678 if (!of_node_get(child))
682 parp = get_property(child, "interrupt-parent", NULL);
684 p = of_get_parent(child);
686 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
687 p = of_node_get(of_irq_dflt_pic);
689 p = of_find_node_by_phandle(*parp);
693 } while (p && get_property(p, "#interrupt-cells", NULL) == NULL);
698 /* This doesn't need to be called if you don't have any special workaround
701 void of_irq_map_init(unsigned int flags)
703 of_irq_workarounds = flags;
705 /* OldWorld, don't bother looking at other things */
706 if (flags & OF_IMAP_OLDWORLD_MAC)
709 /* If we don't have phandles, let's try to locate a default interrupt
710 * controller (happens when booting with BootX). We do a first match
711 * here, hopefully, that only ever happens on machines with one
714 if (flags & OF_IMAP_NO_PHANDLE) {
715 struct device_node *np;
717 for(np = NULL; (np = of_find_all_nodes(np)) != NULL;) {
718 if (get_property(np, "interrupt-controller", NULL)
721 /* Skip /chosen/interrupt-controller */
722 if (strcmp(np->name, "chosen") == 0)
724 /* It seems like at least one person on this planet wants
725 * to use BootX on a machine with an AppleKiwi controller
726 * which happens to pretend to be an interrupt
729 if (strcmp(np->name, "AppleKiwi") == 0)
731 /* I think we found one ! */
732 of_irq_dflt_pic = np;
739 int of_irq_map_raw(struct device_node *parent, const u32 *intspec, u32 ointsize,
740 const u32 *addr, struct of_irq *out_irq)
742 struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL;
743 const u32 *tmp, *imap, *imask;
744 u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0;
745 int imaplen, match, i;
747 DBG("of_irq_map_raw: par=%s,intspec=[0x%08x 0x%08x...],ointsize=%d\n",
748 parent->full_name, intspec[0], intspec[1], ointsize);
750 ipar = of_node_get(parent);
752 /* First get the #interrupt-cells property of the current cursor
753 * that tells us how to interpret the passed-in intspec. If there
754 * is none, we are nice and just walk up the tree
757 tmp = get_property(ipar, "#interrupt-cells", NULL);
763 ipar = of_irq_find_parent(ipar);
767 DBG(" -> no parent found !\n");
771 DBG("of_irq_map_raw: ipar=%s, size=%d\n", ipar->full_name, intsize);
773 if (ointsize != intsize)
776 /* Look for this #address-cells. We have to implement the old linux
777 * trick of looking for the parent here as some device-trees rely on it
779 old = of_node_get(ipar);
781 tmp = get_property(old, "#address-cells", NULL);
782 tnode = of_get_parent(old);
785 } while(old && tmp == NULL);
788 addrsize = (tmp == NULL) ? 2 : *tmp;
790 DBG(" -> addrsize=%d\n", addrsize);
792 /* Now start the actual "proper" walk of the interrupt tree */
793 while (ipar != NULL) {
794 /* Now check if cursor is an interrupt-controller and if it is
797 if (get_property(ipar, "interrupt-controller", NULL) != NULL) {
798 DBG(" -> got it !\n");
799 memcpy(out_irq->specifier, intspec,
800 intsize * sizeof(u32));
801 out_irq->size = intsize;
802 out_irq->controller = ipar;
807 /* Now look for an interrupt-map */
808 imap = get_property(ipar, "interrupt-map", &imaplen);
809 /* No interrupt map, check for an interrupt parent */
811 DBG(" -> no map, getting parent\n");
812 newpar = of_irq_find_parent(ipar);
815 imaplen /= sizeof(u32);
817 /* Look for a mask */
818 imask = get_property(ipar, "interrupt-map-mask", NULL);
820 /* If we were passed no "reg" property and we attempt to parse
821 * an interrupt-map, then #address-cells must be 0.
824 if (addr == NULL && addrsize != 0) {
825 DBG(" -> no reg passed in when needed !\n");
829 /* Parse interrupt-map */
831 while (imaplen > (addrsize + intsize + 1) && !match) {
832 /* Compare specifiers */
834 for (i = 0; i < addrsize && match; ++i) {
835 u32 mask = imask ? imask[i] : 0xffffffffu;
836 match = ((addr[i] ^ imap[i]) & mask) == 0;
838 for (; i < (addrsize + intsize) && match; ++i) {
839 u32 mask = imask ? imask[i] : 0xffffffffu;
841 ((intspec[i-addrsize] ^ imap[i]) & mask) == 0;
843 imap += addrsize + intsize;
844 imaplen -= addrsize + intsize;
846 DBG(" -> match=%d (imaplen=%d)\n", match, imaplen);
848 /* Get the interrupt parent */
849 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
850 newpar = of_node_get(of_irq_dflt_pic);
852 newpar = of_find_node_by_phandle((phandle)*imap);
856 /* Check if not found */
857 if (newpar == NULL) {
858 DBG(" -> imap parent not found !\n");
862 /* Get #interrupt-cells and #address-cells of new
865 tmp = get_property(newpar, "#interrupt-cells",
868 DBG(" -> parent lacks #interrupt-cells !\n");
872 tmp = get_property(newpar, "#address-cells",
874 newaddrsize = (tmp == NULL) ? 0 : *tmp;
876 DBG(" -> newintsize=%d, newaddrsize=%d\n",
877 newintsize, newaddrsize);
879 /* Check for malformed properties */
880 if (imaplen < (newaddrsize + newintsize))
883 imap += newaddrsize + newintsize;
884 imaplen -= newaddrsize + newintsize;
886 DBG(" -> imaplen=%d\n", imaplen);
892 old = of_node_get(newpar);
893 addrsize = newaddrsize;
894 intsize = newintsize;
895 intspec = imap - intsize;
896 addr = intspec - addrsize;
899 /* Iterate again with new parent */
900 DBG(" -> new parent: %s\n", newpar ? newpar->full_name : "<>");
912 EXPORT_SYMBOL_GPL(of_irq_map_raw);
914 #if defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32)
915 static int of_irq_map_oldworld(struct device_node *device, int index,
916 struct of_irq *out_irq)
922 * Old machines just have a list of interrupt numbers
923 * and no interrupt-controller nodes.
925 ints = get_property(device, "AAPL,interrupts", &intlen);
928 intlen /= sizeof(u32);
933 out_irq->controller = NULL;
934 out_irq->specifier[0] = ints[index];
939 #else /* defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32) */
940 static int of_irq_map_oldworld(struct device_node *device, int index,
941 struct of_irq *out_irq)
945 #endif /* !(defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32)) */
947 int of_irq_map_one(struct device_node *device, int index, struct of_irq *out_irq)
949 struct device_node *p;
950 const u32 *intspec, *tmp, *addr;
954 DBG("of_irq_map_one: dev=%s, index=%d\n", device->full_name, index);
956 /* OldWorld mac stuff is "special", handle out of line */
957 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
958 return of_irq_map_oldworld(device, index, out_irq);
960 /* Get the interrupts property */
961 intspec = get_property(device, "interrupts", &intlen);
964 intlen /= sizeof(u32);
966 /* Get the reg property (if any) */
967 addr = get_property(device, "reg", NULL);
969 /* Look for the interrupt parent. */
970 p = of_irq_find_parent(device);
974 /* Get size of interrupt specifier */
975 tmp = get_property(p, "#interrupt-cells", NULL);
982 DBG(" intsize=%d intlen=%d\n", intsize, intlen);
985 if ((index + 1) * intsize > intlen)
988 /* Get new specifier and map it */
989 res = of_irq_map_raw(p, intspec + index * intsize, intsize,
994 EXPORT_SYMBOL_GPL(of_irq_map_one);