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 && \
30 static void of_dump_addr(const char *s, u32 *addr, int na)
34 printk(" %08x", *(addr++));
38 static void of_dump_addr(const char *s, u32 *addr, int na) { }
42 /* Callbacks for bus specific translators */
45 const char *addresses;
46 int (*match)(struct device_node *parent);
47 void (*count_cells)(struct device_node *child,
48 int *addrc, int *sizec);
49 u64 (*map)(u32 *addr, u32 *range, int na, int ns, int pna);
50 int (*translate)(u32 *addr, u64 offset, int na);
51 unsigned int (*get_flags)(u32 *addr);
56 * Default translator (generic bus)
59 static void of_bus_default_count_cells(struct device_node *dev,
60 int *addrc, int *sizec)
63 *addrc = prom_n_addr_cells(dev);
65 *sizec = prom_n_size_cells(dev);
68 static u64 of_bus_default_map(u32 *addr, u32 *range, int na, int ns, int pna)
72 cp = of_read_number(range, na);
73 s = of_read_number(range + na + pna, ns);
74 da = of_read_number(addr, na);
76 DBG("OF: default map, cp="PRu64", s="PRu64", da="PRu64"\n",
79 if (da < cp || da >= (cp + s))
84 static int of_bus_default_translate(u32 *addr, u64 offset, int na)
86 u64 a = of_read_number(addr, na);
87 memset(addr, 0, na * 4);
90 addr[na - 2] = a >> 32;
91 addr[na - 1] = a & 0xffffffffu;
96 static unsigned int of_bus_default_get_flags(u32 *addr)
98 return IORESOURCE_MEM;
103 * PCI bus specific translator
106 static int of_bus_pci_match(struct device_node *np)
108 /* "vci" is for the /chaos bridge on 1st-gen PCI powermacs */
109 return !strcmp(np->type, "pci") || !strcmp(np->type, "vci");
112 static void of_bus_pci_count_cells(struct device_node *np,
113 int *addrc, int *sizec)
121 static u64 of_bus_pci_map(u32 *addr, u32 *range, int na, int ns, int pna)
125 /* Check address type match */
126 if ((addr[0] ^ range[0]) & 0x03000000)
129 /* Read address values, skipping high cell */
130 cp = of_read_number(range + 1, na - 1);
131 s = of_read_number(range + na + pna, ns);
132 da = of_read_number(addr + 1, na - 1);
134 DBG("OF: PCI map, cp="PRu64", s="PRu64", da="PRu64"\n", cp, s, da);
136 if (da < cp || da >= (cp + s))
141 static int of_bus_pci_translate(u32 *addr, u64 offset, int na)
143 return of_bus_default_translate(addr + 1, offset, na - 1);
146 static unsigned int of_bus_pci_get_flags(u32 *addr)
148 unsigned int flags = 0;
151 switch((w >> 24) & 0x03) {
153 flags |= IORESOURCE_IO;
154 case 0x02: /* 32 bits */
155 case 0x03: /* 64 bits */
156 flags |= IORESOURCE_MEM;
159 flags |= IORESOURCE_PREFETCH;
164 * ISA bus specific translator
167 static int of_bus_isa_match(struct device_node *np)
169 return !strcmp(np->name, "isa");
172 static void of_bus_isa_count_cells(struct device_node *child,
173 int *addrc, int *sizec)
181 static u64 of_bus_isa_map(u32 *addr, u32 *range, int na, int ns, int pna)
185 /* Check address type match */
186 if ((addr[0] ^ range[0]) & 0x00000001)
189 /* Read address values, skipping high cell */
190 cp = of_read_number(range + 1, na - 1);
191 s = of_read_number(range + na + pna, ns);
192 da = of_read_number(addr + 1, na - 1);
194 DBG("OF: ISA map, cp="PRu64", s="PRu64", da="PRu64"\n", cp, s, da);
196 if (da < cp || da >= (cp + s))
201 static int of_bus_isa_translate(u32 *addr, u64 offset, int na)
203 return of_bus_default_translate(addr + 1, offset, na - 1);
206 static unsigned int of_bus_isa_get_flags(u32 *addr)
208 unsigned int flags = 0;
212 flags |= IORESOURCE_IO;
214 flags |= IORESOURCE_MEM;
220 * Array of bus specific translators
223 static struct of_bus of_busses[] = {
227 .addresses = "assigned-addresses",
228 .match = of_bus_pci_match,
229 .count_cells = of_bus_pci_count_cells,
230 .map = of_bus_pci_map,
231 .translate = of_bus_pci_translate,
232 .get_flags = of_bus_pci_get_flags,
238 .match = of_bus_isa_match,
239 .count_cells = of_bus_isa_count_cells,
240 .map = of_bus_isa_map,
241 .translate = of_bus_isa_translate,
242 .get_flags = of_bus_isa_get_flags,
249 .count_cells = of_bus_default_count_cells,
250 .map = of_bus_default_map,
251 .translate = of_bus_default_translate,
252 .get_flags = of_bus_default_get_flags,
256 static struct of_bus *of_match_bus(struct device_node *np)
260 for (i = 0; i < ARRAY_SIZE(of_busses); i ++)
261 if (!of_busses[i].match || of_busses[i].match(np))
262 return &of_busses[i];
267 static int of_translate_one(struct device_node *parent, struct of_bus *bus,
268 struct of_bus *pbus, u32 *addr,
269 int na, int ns, int pna)
274 u64 offset = OF_BAD_ADDR;
276 /* Normally, an absence of a "ranges" property means we are
277 * crossing a non-translatable boundary, and thus the addresses
278 * below the current not cannot be converted to CPU physical ones.
279 * Unfortunately, while this is very clear in the spec, it's not
280 * what Apple understood, and they do have things like /uni-n or
281 * /ht nodes with no "ranges" property and a lot of perfectly
282 * useable mapped devices below them. Thus we treat the absence of
283 * "ranges" as equivalent to an empty "ranges" property which means
284 * a 1:1 translation at that level. It's up to the caller not to try
285 * to translate addresses that aren't supposed to be translated in
286 * the first place. --BenH.
288 ranges = (u32 *)get_property(parent, "ranges", &rlen);
289 if (ranges == NULL || rlen == 0) {
290 offset = of_read_number(addr, na);
291 memset(addr, 0, pna * 4);
292 DBG("OF: no ranges, 1:1 translation\n");
296 DBG("OF: walking ranges...\n");
298 /* Now walk through the ranges */
300 rone = na + pna + ns;
301 for (; rlen >= rone; rlen -= rone, ranges += rone) {
302 offset = bus->map(addr, ranges, na, ns, pna);
303 if (offset != OF_BAD_ADDR)
306 if (offset == OF_BAD_ADDR) {
307 DBG("OF: not found !\n");
310 memcpy(addr, ranges + na, 4 * pna);
313 of_dump_addr("OF: parent translation for:", addr, pna);
314 DBG("OF: with offset: "PRu64"\n", offset);
316 /* Translate it into parent bus space */
317 return pbus->translate(addr, offset, pna);
322 * Translate an address from the device-tree into a CPU physical address,
323 * this walks up the tree and applies the various bus mappings on the
326 * Note: We consider that crossing any level with #size-cells == 0 to mean
327 * that translation is impossible (that is we are not dealing with a value
328 * that can be mapped to a cpu physical address). This is not really specified
329 * that way, but this is traditionally the way IBM at least do things
331 u64 of_translate_address(struct device_node *dev, u32 *in_addr)
333 struct device_node *parent = NULL;
334 struct of_bus *bus, *pbus;
335 u32 addr[OF_MAX_ADDR_CELLS];
336 int na, ns, pna, pns;
337 u64 result = OF_BAD_ADDR;
339 DBG("OF: ** translation for device %s **\n", dev->full_name);
341 /* Increase refcount at current level */
344 /* Get parent & match bus type */
345 parent = of_get_parent(dev);
348 bus = of_match_bus(parent);
350 /* Cound address cells & copy address locally */
351 bus->count_cells(dev, &na, &ns);
352 if (!OF_CHECK_COUNTS(na, ns)) {
353 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
357 memcpy(addr, in_addr, na * 4);
359 DBG("OF: bus is %s (na=%d, ns=%d) on %s\n",
360 bus->name, na, ns, parent->full_name);
361 of_dump_addr("OF: translating address:", addr, na);
365 /* Switch to parent bus */
368 parent = of_get_parent(dev);
370 /* If root, we have finished */
371 if (parent == NULL) {
372 DBG("OF: reached root node\n");
373 result = of_read_number(addr, na);
377 /* Get new parent bus and counts */
378 pbus = of_match_bus(parent);
379 pbus->count_cells(dev, &pna, &pns);
380 if (!OF_CHECK_COUNTS(pna, pns)) {
381 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
386 DBG("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
387 pbus->name, pna, pns, parent->full_name);
389 /* Apply bus translation */
390 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna))
393 /* Complete the move up one level */
398 of_dump_addr("OF: one level translation:", addr, na);
406 EXPORT_SYMBOL(of_translate_address);
408 u32 *of_get_address(struct device_node *dev, int index, u64 *size,
413 struct device_node *parent;
415 int onesize, i, na, ns;
417 /* Get parent & match bus type */
418 parent = of_get_parent(dev);
421 bus = of_match_bus(parent);
422 bus->count_cells(dev, &na, &ns);
424 if (!OF_CHECK_COUNTS(na, ns))
427 /* Get "reg" or "assigned-addresses" property */
428 prop = (u32 *)get_property(dev, bus->addresses, &psize);
434 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
437 *size = of_read_number(prop + na, ns);
439 *flags = bus->get_flags(prop);
444 EXPORT_SYMBOL(of_get_address);
446 u32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
451 struct device_node *parent;
453 int onesize, i, na, ns;
455 /* Get parent & match bus type */
456 parent = of_get_parent(dev);
459 bus = of_match_bus(parent);
460 if (strcmp(bus->name, "pci")) {
464 bus->count_cells(dev, &na, &ns);
466 if (!OF_CHECK_COUNTS(na, ns))
469 /* Get "reg" or "assigned-addresses" property */
470 prop = (u32 *)get_property(dev, bus->addresses, &psize);
476 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
477 if ((prop[0] & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0)) {
479 *size = of_read_number(prop + na, ns);
481 *flags = bus->get_flags(prop);
486 EXPORT_SYMBOL(of_get_pci_address);
488 static int __of_address_to_resource(struct device_node *dev, u32 *addrp,
489 u64 size, unsigned int flags,
494 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
496 taddr = of_translate_address(dev, addrp);
497 if (taddr == OF_BAD_ADDR)
499 memset(r, 0, sizeof(struct resource));
500 if (flags & IORESOURCE_IO) {
502 port = pci_address_to_pio(taddr);
503 if (port == (unsigned long)-1)
506 r->end = port + size - 1;
509 r->end = taddr + size - 1;
516 int of_address_to_resource(struct device_node *dev, int index,
523 addrp = of_get_address(dev, index, &size, &flags);
526 return __of_address_to_resource(dev, addrp, size, flags, r);
528 EXPORT_SYMBOL_GPL(of_address_to_resource);
530 int of_pci_address_to_resource(struct device_node *dev, int bar,
537 addrp = of_get_pci_address(dev, bar, &size, &flags);
540 return __of_address_to_resource(dev, addrp, size, flags, r);
542 EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
544 void of_parse_dma_window(struct device_node *dn, unsigned char *dma_window_prop,
545 unsigned long *busno, unsigned long *phys, unsigned long *size)
547 u32 *dma_window, cells;
550 dma_window = (u32 *)dma_window_prop;
552 /* busno is always one cell */
553 *busno = *(dma_window++);
555 prop = get_property(dn, "ibm,#dma-address-cells", NULL);
557 prop = get_property(dn, "#address-cells", NULL);
559 cells = prop ? *(u32 *)prop : prom_n_addr_cells(dn);
560 *phys = of_read_number(dma_window, cells);
564 prop = get_property(dn, "ibm,#dma-size-cells", NULL);
565 cells = prop ? *(u32 *)prop : prom_n_size_cells(dn);
566 *size = of_read_number(dma_window, cells);
573 static unsigned int of_irq_workarounds;
574 static struct device_node *of_irq_dflt_pic;
576 static struct device_node *of_irq_find_parent(struct device_node *child)
578 struct device_node *p;
581 if (!of_node_get(child))
585 parp = (phandle *)get_property(child, "interrupt-parent", NULL);
587 p = of_get_parent(child);
589 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
590 p = of_node_get(of_irq_dflt_pic);
592 p = of_find_node_by_phandle(*parp);
596 } while (p && get_property(p, "#interrupt-cells", NULL) == NULL);
601 static u8 of_irq_pci_swizzle(u8 slot, u8 pin)
603 return (((pin - 1) + slot) % 4) + 1;
606 /* This doesn't need to be called if you don't have any special workaround
609 void of_irq_map_init(unsigned int flags)
611 of_irq_workarounds = flags;
613 /* OldWorld, don't bother looking at other things */
614 if (flags & OF_IMAP_OLDWORLD_MAC)
617 /* If we don't have phandles, let's try to locate a default interrupt
618 * controller (happens when booting with BootX). We do a first match
619 * here, hopefully, that only ever happens on machines with one
622 if (flags & OF_IMAP_NO_PHANDLE) {
623 struct device_node *np;
625 for(np = NULL; (np = of_find_all_nodes(np)) != NULL;) {
626 if (get_property(np, "interrupt-controller", NULL)
629 /* Skip /chosen/interrupt-controller */
630 if (strcmp(np->name, "chosen") == 0)
632 /* It seems like at least one person on this planet wants
633 * to use BootX on a machine with an AppleKiwi controller
634 * which happens to pretend to be an interrupt
637 if (strcmp(np->name, "AppleKiwi") == 0)
639 /* I think we found one ! */
640 of_irq_dflt_pic = np;
647 int of_irq_map_raw(struct device_node *parent, u32 *intspec, u32 *addr,
648 struct of_irq *out_irq)
650 struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL;
651 u32 *tmp, *imap, *imask;
652 u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0;
653 int imaplen, match, i;
655 ipar = of_node_get(parent);
657 /* First get the #interrupt-cells property of the current cursor
658 * that tells us how to interpret the passed-in intspec. If there
659 * is none, we are nice and just walk up the tree
662 tmp = (u32 *)get_property(ipar, "#interrupt-cells", NULL);
668 ipar = of_irq_find_parent(ipar);
672 DBG(" -> no parent found !\n");
676 DBG("of_irq_map_raw: ipar=%s, size=%d\n", ipar->full_name, intsize);
678 /* Look for this #address-cells. We have to implement the old linux
679 * trick of looking for the parent here as some device-trees rely on it
681 old = of_node_get(ipar);
683 tmp = (u32 *)get_property(old, "#address-cells", NULL);
684 tnode = of_get_parent(old);
687 } while(old && tmp == NULL);
690 addrsize = (tmp == NULL) ? 2 : *tmp;
692 DBG(" -> addrsize=%d\n", addrsize);
694 /* Now start the actual "proper" walk of the interrupt tree */
695 while (ipar != NULL) {
696 /* Now check if cursor is an interrupt-controller and if it is
699 if (get_property(ipar, "interrupt-controller", NULL) != NULL) {
700 DBG(" -> got it !\n");
701 memcpy(out_irq->specifier, intspec,
702 intsize * sizeof(u32));
703 out_irq->size = intsize;
704 out_irq->controller = ipar;
709 /* Now look for an interrupt-map */
710 imap = (u32 *)get_property(ipar, "interrupt-map", &imaplen);
711 /* No interrupt map, check for an interrupt parent */
713 DBG(" -> no map, getting parent\n");
714 newpar = of_irq_find_parent(ipar);
717 imaplen /= sizeof(u32);
719 /* Look for a mask */
720 imask = (u32 *)get_property(ipar, "interrupt-map-mask", NULL);
722 /* If we were passed no "reg" property and we attempt to parse
723 * an interrupt-map, then #address-cells must be 0.
726 if (addr == NULL && addrsize != 0) {
727 DBG(" -> no reg passed in when needed !\n");
731 /* Parse interrupt-map */
733 while (imaplen > (addrsize + intsize + 1) && !match) {
734 /* Compare specifiers */
736 for (i = 0; i < addrsize && match; ++i) {
737 u32 mask = imask ? imask[i] : 0xffffffffu;
738 match = ((addr[i] ^ imap[i]) & mask) == 0;
740 for (; i < (addrsize + intsize) && match; ++i) {
741 u32 mask = imask ? imask[i] : 0xffffffffu;
743 ((intspec[i-addrsize] ^ imap[i]) & mask) == 0;
745 imap += addrsize + intsize;
746 imaplen -= addrsize + intsize;
748 DBG(" -> match=%d (imaplen=%d)\n", match, imaplen);
750 /* Get the interrupt parent */
751 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
752 newpar = of_node_get(of_irq_dflt_pic);
754 newpar = of_find_node_by_phandle((phandle)*imap);
758 /* Check if not found */
759 if (newpar == NULL) {
760 DBG(" -> imap parent not found !\n");
764 /* Get #interrupt-cells and #address-cells of new
767 tmp = (u32 *)get_property(newpar, "#interrupt-cells",
770 DBG(" -> parent lacks #interrupt-cells !\n");
774 tmp = (u32 *)get_property(newpar, "#address-cells",
776 newaddrsize = (tmp == NULL) ? 0 : *tmp;
778 DBG(" -> newintsize=%d, newaddrsize=%d\n",
779 newintsize, newaddrsize);
781 /* Check for malformed properties */
782 if (imaplen < (newaddrsize + newintsize))
785 imap += newaddrsize + newintsize;
786 imaplen -= newaddrsize + newintsize;
788 DBG(" -> imaplen=%d\n", imaplen);
794 old = of_node_get(newpar);
795 addrsize = newaddrsize;
796 intsize = newintsize;
797 intspec = imap - intsize;
798 addr = intspec - addrsize;
801 /* Iterate again with new parent */
802 DBG(" -> new parent: %s\n", newpar ? newpar->full_name : "<>");
814 EXPORT_SYMBOL_GPL(of_irq_map_raw);
816 #if defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32)
817 static int of_irq_map_oldworld(struct device_node *device, int index,
818 struct of_irq *out_irq)
824 * Old machines just have a list of interrupt numbers
825 * and no interrupt-controller nodes.
827 ints = (u32 *) get_property(device, "AAPL,interrupts", &intlen);
830 intlen /= sizeof(u32);
835 out_irq->controller = NULL;
836 out_irq->specifier[0] = ints[index];
841 #else /* defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32) */
842 static int of_irq_map_oldworld(struct device_node *device, int index,
843 struct of_irq *out_irq)
847 #endif /* !(defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32)) */
849 int of_irq_map_one(struct device_node *device, int index, struct of_irq *out_irq)
851 struct device_node *p;
852 u32 *intspec, *tmp, intsize, intlen, *addr;
855 DBG("of_irq_map_one: dev=%s, index=%d\n", device->full_name, index);
857 /* OldWorld mac stuff is "special", handle out of line */
858 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
859 return of_irq_map_oldworld(device, index, out_irq);
861 /* Get the interrupts property */
862 intspec = (u32 *)get_property(device, "interrupts", &intlen);
865 intlen /= sizeof(u32);
867 /* Get the reg property (if any) */
868 addr = (u32 *)get_property(device, "reg", NULL);
870 /* Look for the interrupt parent. */
871 p = of_irq_find_parent(device);
875 /* Get size of interrupt specifier */
876 tmp = (u32 *)get_property(p, "#interrupt-cells", NULL);
884 if (index * intsize >= intlen)
887 /* Get new specifier and map it */
888 res = of_irq_map_raw(p, intspec + index * intsize, addr, out_irq);
892 EXPORT_SYMBOL_GPL(of_irq_map_one);
894 int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq)
896 struct device_node *dn, *ppnode;
897 struct pci_dev *ppdev;
903 /* Check if we have a device node, if yes, fallback to standard OF
906 dn = pci_device_to_OF_node(pdev);
908 return of_irq_map_one(dn, 0, out_irq);
910 /* Ok, we don't, time to have fun. Let's start by building up an
911 * interrupt spec. we assume #interrupt-cells is 1, which is standard
912 * for PCI. If you do different, then don't use that routine.
914 rc = pci_read_config_byte(pdev, PCI_INTERRUPT_PIN, &pin);
921 /* Now we walk up the PCI tree */
924 /* Get the pci_dev of our parent */
925 ppdev = pdev->bus->self;
927 /* Ouch, it's a host bridge... */
930 ppnode = pci_bus_to_OF_node(pdev->bus);
932 struct pci_controller *host;
933 host = pci_bus_to_host(pdev->bus);
934 ppnode = host ? host->arch_data : NULL;
936 /* No node for host bridge ? give up */
940 /* We found a P2P bridge, check if it has a node */
941 ppnode = pci_device_to_OF_node(ppdev);
943 /* Ok, we have found a parent with a device-node, hand over to
944 * the OF parsing code.
945 * We build a unit address from the linux device to be used for
946 * resolution. Note that we use the linux bus number which may
947 * not match your firmware bus numbering.
948 * Fortunately, in most cases, interrupt-map-mask doesn't include
949 * the bus number as part of the matching.
950 * You should still be careful about that though if you intend
951 * to rely on this function (you ship a firmware that doesn't
952 * create device nodes for all PCI devices).
957 /* We can only get here if we hit a P2P bridge with no node,
958 * let's do standard swizzling and try again
960 lspec = of_irq_pci_swizzle(PCI_SLOT(pdev->devfn), lspec);
964 laddr[0] = (pdev->bus->number << 16)
965 | (pdev->devfn << 8);
966 laddr[1] = laddr[2] = 0;
967 return of_irq_map_raw(ppnode, &lspec, laddr, out_irq);
969 EXPORT_SYMBOL_GPL(of_irq_map_pci);