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);
73 * If the number of address cells is larger than 2 we assume the
74 * mapping doesn't specify a physical address. Rather, the address
75 * specifies an identifier that must match exactly.
77 if (na > 2 && memcmp(range, addr, na * 4) != 0)
80 if (da < cp || da >= (cp + s))
85 static int of_bus_default_translate(__be32 *addr, u64 offset, int na)
87 u64 a = of_read_number(addr, na);
88 memset(addr, 0, na * 4);
91 addr[na - 2] = cpu_to_be32(a >> 32);
92 addr[na - 1] = cpu_to_be32(a & 0xffffffffu);
97 static unsigned int of_bus_default_get_flags(const __be32 *addr)
99 return IORESOURCE_MEM;
104 * PCI bus specific translator
107 static int of_bus_pci_match(struct device_node *np)
109 /* "vci" is for the /chaos bridge on 1st-gen PCI powermacs */
110 return !strcmp(np->type, "pci") || !strcmp(np->type, "vci");
113 static void of_bus_pci_count_cells(struct device_node *np,
114 int *addrc, int *sizec)
122 static unsigned int of_bus_pci_get_flags(const __be32 *addr)
124 unsigned int flags = 0;
125 u32 w = be32_to_cpup(addr);
127 switch((w >> 24) & 0x03) {
129 flags |= IORESOURCE_IO;
131 case 0x02: /* 32 bits */
132 case 0x03: /* 64 bits */
133 flags |= IORESOURCE_MEM;
137 flags |= IORESOURCE_PREFETCH;
141 static u64 of_bus_pci_map(__be32 *addr, const __be32 *range, int na, int ns,
147 af = of_bus_pci_get_flags(addr);
148 rf = of_bus_pci_get_flags(range);
150 /* Check address type match */
151 if ((af ^ rf) & (IORESOURCE_MEM | IORESOURCE_IO))
154 /* Read address values, skipping high cell */
155 cp = of_read_number(range + 1, na - 1);
156 s = of_read_number(range + na + pna, ns);
157 da = of_read_number(addr + 1, na - 1);
159 pr_debug("OF: PCI map, cp=%llx, s=%llx, da=%llx\n",
160 (unsigned long long)cp, (unsigned long long)s,
161 (unsigned long long)da);
163 if (da < cp || da >= (cp + s))
168 static int of_bus_pci_translate(__be32 *addr, u64 offset, int na)
170 return of_bus_default_translate(addr + 1, offset, na - 1);
173 const __be32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
178 struct device_node *parent;
180 int onesize, i, na, ns;
182 /* Get parent & match bus type */
183 parent = of_get_parent(dev);
186 bus = of_match_bus(parent);
187 if (strcmp(bus->name, "pci")) {
191 bus->count_cells(dev, &na, &ns);
193 if (!OF_CHECK_ADDR_COUNT(na))
196 /* Get "reg" or "assigned-addresses" property */
197 prop = of_get_property(dev, bus->addresses, &psize);
203 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++) {
204 u32 val = be32_to_cpu(prop[0]);
205 if ((val & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0)) {
207 *size = of_read_number(prop + na, ns);
209 *flags = bus->get_flags(prop);
215 EXPORT_SYMBOL(of_get_pci_address);
217 int of_pci_address_to_resource(struct device_node *dev, int bar,
224 addrp = of_get_pci_address(dev, bar, &size, &flags);
227 return __of_address_to_resource(dev, addrp, size, flags, NULL, r);
229 EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
231 int of_pci_range_parser_init(struct of_pci_range_parser *parser,
232 struct device_node *node)
234 const int na = 3, ns = 2;
238 parser->pna = of_n_addr_cells(node);
239 parser->np = parser->pna + na + ns;
241 parser->range = of_get_property(node, "ranges", &rlen);
242 if (parser->range == NULL)
245 parser->end = parser->range + rlen / sizeof(__be32);
249 EXPORT_SYMBOL_GPL(of_pci_range_parser_init);
251 struct of_pci_range *of_pci_range_parser_one(struct of_pci_range_parser *parser,
252 struct of_pci_range *range)
254 const int na = 3, ns = 2;
259 if (!parser->range || parser->range + parser->np > parser->end)
262 range->pci_space = parser->range[0];
263 range->flags = of_bus_pci_get_flags(parser->range);
264 range->pci_addr = of_read_number(parser->range + 1, ns);
265 range->cpu_addr = of_translate_address(parser->node,
267 range->size = of_read_number(parser->range + parser->pna + na, ns);
269 parser->range += parser->np;
271 /* Now consume following elements while they are contiguous */
272 while (parser->range + parser->np <= parser->end) {
273 u32 flags, pci_space;
274 u64 pci_addr, cpu_addr, size;
276 pci_space = be32_to_cpup(parser->range);
277 flags = of_bus_pci_get_flags(parser->range);
278 pci_addr = of_read_number(parser->range + 1, ns);
279 cpu_addr = of_translate_address(parser->node,
281 size = of_read_number(parser->range + parser->pna + na, ns);
283 if (flags != range->flags)
285 if (pci_addr != range->pci_addr + range->size ||
286 cpu_addr != range->cpu_addr + range->size)
290 parser->range += parser->np;
295 EXPORT_SYMBOL_GPL(of_pci_range_parser_one);
297 #endif /* CONFIG_PCI */
300 * ISA bus specific translator
303 static int of_bus_isa_match(struct device_node *np)
305 return !strcmp(np->name, "isa");
308 static void of_bus_isa_count_cells(struct device_node *child,
309 int *addrc, int *sizec)
317 static u64 of_bus_isa_map(__be32 *addr, const __be32 *range, int na, int ns,
322 /* Check address type match */
323 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
326 /* Read address values, skipping high cell */
327 cp = of_read_number(range + 1, na - 1);
328 s = of_read_number(range + na + pna, ns);
329 da = of_read_number(addr + 1, na - 1);
331 pr_debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n",
332 (unsigned long long)cp, (unsigned long long)s,
333 (unsigned long long)da);
335 if (da < cp || da >= (cp + s))
340 static int of_bus_isa_translate(__be32 *addr, u64 offset, int na)
342 return of_bus_default_translate(addr + 1, offset, na - 1);
345 static unsigned int of_bus_isa_get_flags(const __be32 *addr)
347 unsigned int flags = 0;
348 u32 w = be32_to_cpup(addr);
351 flags |= IORESOURCE_IO;
353 flags |= IORESOURCE_MEM;
358 * Array of bus specific translators
361 static struct of_bus of_busses[] = {
366 .addresses = "assigned-addresses",
367 .match = of_bus_pci_match,
368 .count_cells = of_bus_pci_count_cells,
369 .map = of_bus_pci_map,
370 .translate = of_bus_pci_translate,
371 .get_flags = of_bus_pci_get_flags,
373 #endif /* CONFIG_PCI */
378 .match = of_bus_isa_match,
379 .count_cells = of_bus_isa_count_cells,
380 .map = of_bus_isa_map,
381 .translate = of_bus_isa_translate,
382 .get_flags = of_bus_isa_get_flags,
389 .count_cells = of_bus_default_count_cells,
390 .map = of_bus_default_map,
391 .translate = of_bus_default_translate,
392 .get_flags = of_bus_default_get_flags,
396 static struct of_bus *of_match_bus(struct device_node *np)
400 for (i = 0; i < ARRAY_SIZE(of_busses); i++)
401 if (!of_busses[i].match || of_busses[i].match(np))
402 return &of_busses[i];
407 static int of_translate_one(struct device_node *parent, struct of_bus *bus,
408 struct of_bus *pbus, __be32 *addr,
409 int na, int ns, int pna, const char *rprop)
411 const __be32 *ranges;
414 u64 offset = OF_BAD_ADDR;
416 /* Normally, an absence of a "ranges" property means we are
417 * crossing a non-translatable boundary, and thus the addresses
418 * below the current not cannot be converted to CPU physical ones.
419 * Unfortunately, while this is very clear in the spec, it's not
420 * what Apple understood, and they do have things like /uni-n or
421 * /ht nodes with no "ranges" property and a lot of perfectly
422 * useable mapped devices below them. Thus we treat the absence of
423 * "ranges" as equivalent to an empty "ranges" property which means
424 * a 1:1 translation at that level. It's up to the caller not to try
425 * to translate addresses that aren't supposed to be translated in
426 * the first place. --BenH.
428 * As far as we know, this damage only exists on Apple machines, so
429 * This code is only enabled on powerpc. --gcl
431 ranges = of_get_property(parent, rprop, &rlen);
432 #if !defined(CONFIG_PPC)
433 if (ranges == NULL) {
434 pr_err("OF: no ranges; cannot translate\n");
437 #endif /* !defined(CONFIG_PPC) */
438 if (ranges == NULL || rlen == 0) {
439 offset = of_read_number(addr, na);
440 memset(addr, 0, pna * 4);
441 pr_debug("OF: empty ranges; 1:1 translation\n");
445 pr_debug("OF: walking ranges...\n");
447 /* Now walk through the ranges */
449 rone = na + pna + ns;
450 for (; rlen >= rone; rlen -= rone, ranges += rone) {
451 offset = bus->map(addr, ranges, na, ns, pna);
452 if (offset != OF_BAD_ADDR)
455 if (offset == OF_BAD_ADDR) {
456 pr_debug("OF: not found !\n");
459 memcpy(addr, ranges + na, 4 * pna);
462 of_dump_addr("OF: parent translation for:", addr, pna);
463 pr_debug("OF: with offset: %llx\n", (unsigned long long)offset);
465 /* Translate it into parent bus space */
466 return pbus->translate(addr, offset, pna);
470 * Translate an address from the device-tree into a CPU physical address,
471 * this walks up the tree and applies the various bus mappings on the
474 * Note: We consider that crossing any level with #size-cells == 0 to mean
475 * that translation is impossible (that is we are not dealing with a value
476 * that can be mapped to a cpu physical address). This is not really specified
477 * that way, but this is traditionally the way IBM at least do things
479 static u64 __of_translate_address(struct device_node *dev,
480 const __be32 *in_addr, const char *rprop)
482 struct device_node *parent = NULL;
483 struct of_bus *bus, *pbus;
484 __be32 addr[OF_MAX_ADDR_CELLS];
485 int na, ns, pna, pns;
486 u64 result = OF_BAD_ADDR;
488 pr_debug("OF: ** translation for device %s **\n", dev->full_name);
490 /* Increase refcount at current level */
493 /* Get parent & match bus type */
494 parent = of_get_parent(dev);
497 bus = of_match_bus(parent);
499 /* Count address cells & copy address locally */
500 bus->count_cells(dev, &na, &ns);
501 if (!OF_CHECK_COUNTS(na, ns)) {
502 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
506 memcpy(addr, in_addr, na * 4);
508 pr_debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
509 bus->name, na, ns, parent->full_name);
510 of_dump_addr("OF: translating address:", addr, na);
514 /* Switch to parent bus */
517 parent = of_get_parent(dev);
519 /* If root, we have finished */
520 if (parent == NULL) {
521 pr_debug("OF: reached root node\n");
522 result = of_read_number(addr, na);
526 /* Get new parent bus and counts */
527 pbus = of_match_bus(parent);
528 pbus->count_cells(dev, &pna, &pns);
529 if (!OF_CHECK_COUNTS(pna, pns)) {
530 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
535 pr_debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
536 pbus->name, pna, pns, parent->full_name);
538 /* Apply bus translation */
539 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
542 /* Complete the move up one level */
547 of_dump_addr("OF: one level translation:", addr, na);
556 u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
558 return __of_translate_address(dev, in_addr, "ranges");
560 EXPORT_SYMBOL(of_translate_address);
562 u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
564 return __of_translate_address(dev, in_addr, "dma-ranges");
566 EXPORT_SYMBOL(of_translate_dma_address);
568 bool of_can_translate_address(struct device_node *dev)
570 struct device_node *parent;
574 parent = of_get_parent(dev);
578 bus = of_match_bus(parent);
579 bus->count_cells(dev, &na, &ns);
583 return OF_CHECK_COUNTS(na, ns);
585 EXPORT_SYMBOL(of_can_translate_address);
587 const __be32 *of_get_address(struct device_node *dev, int index, u64 *size,
592 struct device_node *parent;
594 int onesize, i, na, ns;
596 /* Get parent & match bus type */
597 parent = of_get_parent(dev);
600 bus = of_match_bus(parent);
601 bus->count_cells(dev, &na, &ns);
603 if (!OF_CHECK_ADDR_COUNT(na))
606 /* Get "reg" or "assigned-addresses" property */
607 prop = of_get_property(dev, bus->addresses, &psize);
613 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
616 *size = of_read_number(prop + na, ns);
618 *flags = bus->get_flags(prop);
623 EXPORT_SYMBOL(of_get_address);
625 static int __of_address_to_resource(struct device_node *dev,
626 const __be32 *addrp, u64 size, unsigned int flags,
627 const char *name, struct resource *r)
631 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
633 taddr = of_translate_address(dev, addrp);
634 if (taddr == OF_BAD_ADDR)
636 memset(r, 0, sizeof(struct resource));
637 if (flags & IORESOURCE_IO) {
639 port = pci_address_to_pio(taddr);
640 if (port == (unsigned long)-1)
643 r->end = port + size - 1;
646 r->end = taddr + size - 1;
649 r->name = name ? name : dev->full_name;
655 * of_address_to_resource - Translate device tree address and return as resource
657 * Note that if your address is a PIO address, the conversion will fail if
658 * the physical address can't be internally converted to an IO token with
659 * pci_address_to_pio(), that is because it's either called to early or it
660 * can't be matched to any host bridge IO space
662 int of_address_to_resource(struct device_node *dev, int index,
668 const char *name = NULL;
670 addrp = of_get_address(dev, index, &size, &flags);
674 /* Get optional "reg-names" property to add a name to a resource */
675 of_property_read_string_index(dev, "reg-names", index, &name);
677 return __of_address_to_resource(dev, addrp, size, flags, name, r);
679 EXPORT_SYMBOL_GPL(of_address_to_resource);
681 struct device_node *of_find_matching_node_by_address(struct device_node *from,
682 const struct of_device_id *matches,
685 struct device_node *dn = of_find_matching_node(from, matches);
689 if (of_address_to_resource(dn, 0, &res))
691 if (res.start == base_address)
693 dn = of_find_matching_node(dn, matches);
701 * of_iomap - Maps the memory mapped IO for a given device_node
702 * @device: the device whose io range will be mapped
703 * @index: index of the io range
705 * Returns a pointer to the mapped memory
707 void __iomem *of_iomap(struct device_node *np, int index)
711 if (of_address_to_resource(np, index, &res))
714 return ioremap(res.start, resource_size(&res));
716 EXPORT_SYMBOL(of_iomap);