2 #include <linux/device.h>
4 #include <linux/ioport.h>
5 #include <linux/module.h>
6 #include <linux/of_address.h>
7 #include <linux/pci_regs.h>
8 #include <linux/string.h>
10 /* Max address size we deal with */
11 #define OF_MAX_ADDR_CELLS 4
12 #define OF_CHECK_ADDR_COUNT(na) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS)
13 #define OF_CHECK_COUNTS(na, ns) (OF_CHECK_ADDR_COUNT(na) && (ns) > 0)
15 static struct of_bus *of_match_bus(struct device_node *np);
16 static int __of_address_to_resource(struct device_node *dev,
17 const __be32 *addrp, u64 size, unsigned int flags,
18 const char *name, struct resource *r);
22 static void of_dump_addr(const char *s, const __be32 *addr, int na)
24 printk(KERN_DEBUG "%s", s);
26 printk(" %08x", be32_to_cpu(*(addr++)));
30 static void of_dump_addr(const char *s, const __be32 *addr, int na) { }
33 /* Callbacks for bus specific translators */
36 const char *addresses;
37 int (*match)(struct device_node *parent);
38 void (*count_cells)(struct device_node *child,
39 int *addrc, int *sizec);
40 u64 (*map)(__be32 *addr, const __be32 *range,
41 int na, int ns, int pna);
42 int (*translate)(__be32 *addr, u64 offset, int na);
43 unsigned int (*get_flags)(const __be32 *addr);
47 * Default translator (generic bus)
50 static void of_bus_default_count_cells(struct device_node *dev,
51 int *addrc, int *sizec)
54 *addrc = of_n_addr_cells(dev);
56 *sizec = of_n_size_cells(dev);
59 static u64 of_bus_default_map(__be32 *addr, const __be32 *range,
60 int na, int ns, int pna)
64 cp = of_read_number(range, na);
65 s = of_read_number(range + na + pna, ns);
66 da = of_read_number(addr, na);
68 pr_debug("OF: default map, cp=%llx, s=%llx, da=%llx\n",
69 (unsigned long long)cp, (unsigned long long)s,
70 (unsigned long long)da);
72 if (da < cp || da >= (cp + s))
77 static int of_bus_default_translate(__be32 *addr, u64 offset, int na)
79 u64 a = of_read_number(addr, na);
80 memset(addr, 0, na * 4);
83 addr[na - 2] = cpu_to_be32(a >> 32);
84 addr[na - 1] = cpu_to_be32(a & 0xffffffffu);
89 static unsigned int of_bus_default_get_flags(const __be32 *addr)
91 return IORESOURCE_MEM;
94 #ifdef CONFIG_OF_ADDRESS_PCI
96 * PCI bus specific translator
99 static int of_bus_pci_match(struct device_node *np)
102 * "pciex" is PCI Express
103 * "vci" is for the /chaos bridge on 1st-gen PCI powermacs
104 * "ht" is hypertransport
106 return !strcmp(np->type, "pci") || !strcmp(np->type, "pciex") ||
107 !strcmp(np->type, "vci") || !strcmp(np->type, "ht");
110 static void of_bus_pci_count_cells(struct device_node *np,
111 int *addrc, int *sizec)
119 static unsigned int of_bus_pci_get_flags(const __be32 *addr)
121 unsigned int flags = 0;
122 u32 w = be32_to_cpup(addr);
124 switch((w >> 24) & 0x03) {
126 flags |= IORESOURCE_IO;
128 case 0x02: /* 32 bits */
129 case 0x03: /* 64 bits */
130 flags |= IORESOURCE_MEM;
134 flags |= IORESOURCE_PREFETCH;
138 static u64 of_bus_pci_map(__be32 *addr, const __be32 *range, int na, int ns,
144 af = of_bus_pci_get_flags(addr);
145 rf = of_bus_pci_get_flags(range);
147 /* Check address type match */
148 if ((af ^ rf) & (IORESOURCE_MEM | IORESOURCE_IO))
151 /* Read address values, skipping high cell */
152 cp = of_read_number(range + 1, na - 1);
153 s = of_read_number(range + na + pna, ns);
154 da = of_read_number(addr + 1, na - 1);
156 pr_debug("OF: PCI map, cp=%llx, s=%llx, da=%llx\n",
157 (unsigned long long)cp, (unsigned long long)s,
158 (unsigned long long)da);
160 if (da < cp || da >= (cp + s))
165 static int of_bus_pci_translate(__be32 *addr, u64 offset, int na)
167 return of_bus_default_translate(addr + 1, offset, na - 1);
169 #endif /* CONFIG_OF_ADDRESS_PCI */
172 const __be32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
177 struct device_node *parent;
179 int onesize, i, na, ns;
181 /* Get parent & match bus type */
182 parent = of_get_parent(dev);
185 bus = of_match_bus(parent);
186 if (strcmp(bus->name, "pci")) {
190 bus->count_cells(dev, &na, &ns);
192 if (!OF_CHECK_ADDR_COUNT(na))
195 /* Get "reg" or "assigned-addresses" property */
196 prop = of_get_property(dev, bus->addresses, &psize);
202 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++) {
203 u32 val = be32_to_cpu(prop[0]);
204 if ((val & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0)) {
206 *size = of_read_number(prop + na, ns);
208 *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, NULL, r);
228 EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
230 int of_pci_range_parser_init(struct of_pci_range_parser *parser,
231 struct device_node *node)
233 const int na = 3, ns = 2;
237 parser->pna = of_n_addr_cells(node);
238 parser->np = parser->pna + na + ns;
240 parser->range = of_get_property(node, "ranges", &rlen);
241 if (parser->range == NULL)
244 parser->end = parser->range + rlen / sizeof(__be32);
248 EXPORT_SYMBOL_GPL(of_pci_range_parser_init);
250 struct of_pci_range *of_pci_range_parser_one(struct of_pci_range_parser *parser,
251 struct of_pci_range *range)
253 const int na = 3, ns = 2;
258 if (!parser->range || parser->range + parser->np > parser->end)
261 range->pci_space = parser->range[0];
262 range->flags = of_bus_pci_get_flags(parser->range);
263 range->pci_addr = of_read_number(parser->range + 1, ns);
264 range->cpu_addr = of_translate_address(parser->node,
266 range->size = of_read_number(parser->range + parser->pna + na, ns);
268 parser->range += parser->np;
270 /* Now consume following elements while they are contiguous */
271 while (parser->range + parser->np <= parser->end) {
272 u32 flags, pci_space;
273 u64 pci_addr, cpu_addr, size;
275 pci_space = be32_to_cpup(parser->range);
276 flags = of_bus_pci_get_flags(parser->range);
277 pci_addr = of_read_number(parser->range + 1, ns);
278 cpu_addr = of_translate_address(parser->node,
280 size = of_read_number(parser->range + parser->pna + na, ns);
282 if (flags != range->flags)
284 if (pci_addr != range->pci_addr + range->size ||
285 cpu_addr != range->cpu_addr + range->size)
289 parser->range += parser->np;
294 EXPORT_SYMBOL_GPL(of_pci_range_parser_one);
296 #endif /* CONFIG_PCI */
299 * ISA bus specific translator
302 static int of_bus_isa_match(struct device_node *np)
304 return !strcmp(np->name, "isa");
307 static void of_bus_isa_count_cells(struct device_node *child,
308 int *addrc, int *sizec)
316 static u64 of_bus_isa_map(__be32 *addr, const __be32 *range, int na, int ns,
321 /* Check address type match */
322 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
325 /* Read address values, skipping high cell */
326 cp = of_read_number(range + 1, na - 1);
327 s = of_read_number(range + na + pna, ns);
328 da = of_read_number(addr + 1, na - 1);
330 pr_debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n",
331 (unsigned long long)cp, (unsigned long long)s,
332 (unsigned long long)da);
334 if (da < cp || da >= (cp + s))
339 static int of_bus_isa_translate(__be32 *addr, u64 offset, int na)
341 return of_bus_default_translate(addr + 1, offset, na - 1);
344 static unsigned int of_bus_isa_get_flags(const __be32 *addr)
346 unsigned int flags = 0;
347 u32 w = be32_to_cpup(addr);
350 flags |= IORESOURCE_IO;
352 flags |= IORESOURCE_MEM;
357 * Array of bus specific translators
360 static struct of_bus of_busses[] = {
361 #ifdef CONFIG_OF_ADDRESS_PCI
365 .addresses = "assigned-addresses",
366 .match = of_bus_pci_match,
367 .count_cells = of_bus_pci_count_cells,
368 .map = of_bus_pci_map,
369 .translate = of_bus_pci_translate,
370 .get_flags = of_bus_pci_get_flags,
372 #endif /* CONFIG_OF_ADDRESS_PCI */
377 .match = of_bus_isa_match,
378 .count_cells = of_bus_isa_count_cells,
379 .map = of_bus_isa_map,
380 .translate = of_bus_isa_translate,
381 .get_flags = of_bus_isa_get_flags,
388 .count_cells = of_bus_default_count_cells,
389 .map = of_bus_default_map,
390 .translate = of_bus_default_translate,
391 .get_flags = of_bus_default_get_flags,
395 static struct of_bus *of_match_bus(struct device_node *np)
399 for (i = 0; i < ARRAY_SIZE(of_busses); i++)
400 if (!of_busses[i].match || of_busses[i].match(np))
401 return &of_busses[i];
406 static int of_translate_one(struct device_node *parent, struct of_bus *bus,
407 struct of_bus *pbus, __be32 *addr,
408 int na, int ns, int pna, const char *rprop)
410 const __be32 *ranges;
413 u64 offset = OF_BAD_ADDR;
415 /* Normally, an absence of a "ranges" property means we are
416 * crossing a non-translatable boundary, and thus the addresses
417 * below the current not cannot be converted to CPU physical ones.
418 * Unfortunately, while this is very clear in the spec, it's not
419 * what Apple understood, and they do have things like /uni-n or
420 * /ht nodes with no "ranges" property and a lot of perfectly
421 * useable mapped devices below them. Thus we treat the absence of
422 * "ranges" as equivalent to an empty "ranges" property which means
423 * a 1:1 translation at that level. It's up to the caller not to try
424 * to translate addresses that aren't supposed to be translated in
425 * the first place. --BenH.
427 * As far as we know, this damage only exists on Apple machines, so
428 * This code is only enabled on powerpc. --gcl
430 ranges = of_get_property(parent, rprop, &rlen);
431 #if !defined(CONFIG_PPC)
432 if (ranges == NULL) {
433 pr_err("OF: no ranges; cannot translate\n");
436 #endif /* !defined(CONFIG_PPC) */
437 if (ranges == NULL || rlen == 0) {
438 offset = of_read_number(addr, na);
439 memset(addr, 0, pna * 4);
440 pr_debug("OF: empty ranges; 1:1 translation\n");
444 pr_debug("OF: walking ranges...\n");
446 /* Now walk through the ranges */
448 rone = na + pna + ns;
449 for (; rlen >= rone; rlen -= rone, ranges += rone) {
450 offset = bus->map(addr, ranges, na, ns, pna);
451 if (offset != OF_BAD_ADDR)
454 if (offset == OF_BAD_ADDR) {
455 pr_debug("OF: not found !\n");
458 memcpy(addr, ranges + na, 4 * pna);
461 of_dump_addr("OF: parent translation for:", addr, pna);
462 pr_debug("OF: with offset: %llx\n", (unsigned long long)offset);
464 /* Translate it into parent bus space */
465 return pbus->translate(addr, offset, pna);
469 * Translate an address from the device-tree into a CPU physical address,
470 * this walks up the tree and applies the various bus mappings on the
473 * Note: We consider that crossing any level with #size-cells == 0 to mean
474 * that translation is impossible (that is we are not dealing with a value
475 * that can be mapped to a cpu physical address). This is not really specified
476 * that way, but this is traditionally the way IBM at least do things
478 static u64 __of_translate_address(struct device_node *dev,
479 const __be32 *in_addr, const char *rprop)
481 struct device_node *parent = NULL;
482 struct of_bus *bus, *pbus;
483 __be32 addr[OF_MAX_ADDR_CELLS];
484 int na, ns, pna, pns;
485 u64 result = OF_BAD_ADDR;
487 pr_debug("OF: ** translation for device %s **\n", of_node_full_name(dev));
489 /* Increase refcount at current level */
492 /* Get parent & match bus type */
493 parent = of_get_parent(dev);
496 bus = of_match_bus(parent);
498 /* Count address cells & copy address locally */
499 bus->count_cells(dev, &na, &ns);
500 if (!OF_CHECK_COUNTS(na, ns)) {
501 pr_debug("OF: Bad cell count for %s\n", of_node_full_name(dev));
504 memcpy(addr, in_addr, na * 4);
506 pr_debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
507 bus->name, na, ns, of_node_full_name(parent));
508 of_dump_addr("OF: translating address:", addr, na);
512 /* Switch to parent bus */
515 parent = of_get_parent(dev);
517 /* If root, we have finished */
518 if (parent == NULL) {
519 pr_debug("OF: reached root node\n");
520 result = of_read_number(addr, na);
524 /* Get new parent bus and counts */
525 pbus = of_match_bus(parent);
526 pbus->count_cells(dev, &pna, &pns);
527 if (!OF_CHECK_COUNTS(pna, pns)) {
528 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
529 of_node_full_name(dev));
533 pr_debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
534 pbus->name, pna, pns, of_node_full_name(parent));
536 /* Apply bus translation */
537 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
540 /* Complete the move up one level */
545 of_dump_addr("OF: one level translation:", addr, na);
554 u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
556 return __of_translate_address(dev, in_addr, "ranges");
558 EXPORT_SYMBOL(of_translate_address);
560 u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
562 return __of_translate_address(dev, in_addr, "dma-ranges");
564 EXPORT_SYMBOL(of_translate_dma_address);
566 const __be32 *of_get_address(struct device_node *dev, int index, u64 *size,
571 struct device_node *parent;
573 int onesize, i, na, ns;
575 /* Get parent & match bus type */
576 parent = of_get_parent(dev);
579 bus = of_match_bus(parent);
580 bus->count_cells(dev, &na, &ns);
582 if (!OF_CHECK_ADDR_COUNT(na))
585 /* Get "reg" or "assigned-addresses" property */
586 prop = of_get_property(dev, bus->addresses, &psize);
592 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
595 *size = of_read_number(prop + na, ns);
597 *flags = bus->get_flags(prop);
602 EXPORT_SYMBOL(of_get_address);
604 unsigned long __weak pci_address_to_pio(phys_addr_t address)
606 if (address > IO_SPACE_LIMIT)
607 return (unsigned long)-1;
609 return (unsigned long) address;
612 static int __of_address_to_resource(struct device_node *dev,
613 const __be32 *addrp, u64 size, unsigned int flags,
614 const char *name, struct resource *r)
618 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
620 taddr = of_translate_address(dev, addrp);
621 if (taddr == OF_BAD_ADDR)
623 memset(r, 0, sizeof(struct resource));
624 if (flags & IORESOURCE_IO) {
626 port = pci_address_to_pio(taddr);
627 if (port == (unsigned long)-1)
630 r->end = port + size - 1;
633 r->end = taddr + size - 1;
636 r->name = name ? name : dev->full_name;
642 * of_address_to_resource - Translate device tree address and return as resource
644 * Note that if your address is a PIO address, the conversion will fail if
645 * the physical address can't be internally converted to an IO token with
646 * pci_address_to_pio(), that is because it's either called to early or it
647 * can't be matched to any host bridge IO space
649 int of_address_to_resource(struct device_node *dev, int index,
655 const char *name = NULL;
657 addrp = of_get_address(dev, index, &size, &flags);
661 /* Get optional "reg-names" property to add a name to a resource */
662 of_property_read_string_index(dev, "reg-names", index, &name);
664 return __of_address_to_resource(dev, addrp, size, flags, name, r);
666 EXPORT_SYMBOL_GPL(of_address_to_resource);
668 struct device_node *of_find_matching_node_by_address(struct device_node *from,
669 const struct of_device_id *matches,
672 struct device_node *dn = of_find_matching_node(from, matches);
676 if (of_address_to_resource(dn, 0, &res))
678 if (res.start == base_address)
680 dn = of_find_matching_node(dn, matches);
688 * of_iomap - Maps the memory mapped IO for a given device_node
689 * @device: the device whose io range will be mapped
690 * @index: index of the io range
692 * Returns a pointer to the mapped memory
694 void __iomem *of_iomap(struct device_node *np, int index)
698 if (of_address_to_resource(np, index, &res))
701 return ioremap(res.start, resource_size(&res));
703 EXPORT_SYMBOL(of_iomap);
706 * of_dma_get_range - Get DMA range info
707 * @np: device node to get DMA range info
708 * @dma_addr: pointer to store initial DMA address of DMA range
709 * @paddr: pointer to store initial CPU address of DMA range
710 * @size: pointer to store size of DMA range
712 * Look in bottom up direction for the first "dma-ranges" property
715 * DMA addr (dma_addr) : naddr cells
716 * CPU addr (phys_addr_t) : pna cells
719 * It returns -ENODEV if "dma-ranges" property was not found
720 * for this device in DT.
722 int of_dma_get_range(struct device_node *np, u64 *dma_addr, u64 *paddr, u64 *size)
724 struct device_node *node = of_node_get(np);
725 const __be32 *ranges = NULL;
726 int len, naddr, nsize, pna;
734 naddr = of_n_addr_cells(node);
735 nsize = of_n_size_cells(node);
736 node = of_get_next_parent(node);
740 ranges = of_get_property(node, "dma-ranges", &len);
742 /* Ignore empty ranges, they imply no translation required */
743 if (ranges && len > 0)
747 * At least empty ranges has to be defined for parent node if
755 pr_debug("%s: no dma-ranges found for node(%s)\n",
756 __func__, np->full_name);
763 pna = of_n_addr_cells(node);
765 /* dma-ranges format:
766 * DMA addr : naddr cells
767 * CPU addr : pna cells
770 dmaaddr = of_read_number(ranges, naddr);
771 *paddr = of_translate_dma_address(np, ranges);
772 if (*paddr == OF_BAD_ADDR) {
773 pr_err("%s: translation of DMA address(%pad) to CPU address failed node(%s)\n",
774 __func__, dma_addr, np->full_name);
780 *size = of_read_number(ranges + naddr + pna, nsize);
782 pr_debug("dma_addr(%llx) cpu_addr(%llx) size(%llx)\n",
783 *dma_addr, *paddr, *size);
790 EXPORT_SYMBOL_GPL(of_dma_get_range);
793 * of_dma_is_coherent - Check if device is coherent
796 * It returns true if "dma-coherent" property was found
797 * for this device in DT.
799 bool of_dma_is_coherent(struct device_node *np)
801 struct device_node *node = of_node_get(np);
804 if (of_property_read_bool(node, "dma-coherent")) {
808 node = of_get_next_parent(node);
813 EXPORT_SYMBOL_GPL(of_dma_is_coherent);