3 #include <linux/ioport.h>
4 #include <linux/module.h>
5 #include <linux/of_address.h>
6 #include <linux/pci_regs.h>
7 #include <linux/string.h>
9 /* Max address size we deal with */
10 #define OF_MAX_ADDR_CELLS 4
11 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
14 static struct of_bus *of_match_bus(struct device_node *np);
15 static int __of_address_to_resource(struct device_node *dev,
16 const __be32 *addrp, u64 size, unsigned int flags,
21 static void of_dump_addr(const char *s, const __be32 *addr, int na)
23 printk(KERN_DEBUG "%s", s);
25 printk(" %08x", be32_to_cpu(*(addr++)));
29 static void of_dump_addr(const char *s, const __be32 *addr, int na) { }
32 /* Callbacks for bus specific translators */
35 const char *addresses;
36 int (*match)(struct device_node *parent);
37 void (*count_cells)(struct device_node *child,
38 int *addrc, int *sizec);
39 u64 (*map)(u32 *addr, const __be32 *range,
40 int na, int ns, int pna);
41 int (*translate)(u32 *addr, u64 offset, int na);
42 unsigned int (*get_flags)(const __be32 *addr);
46 * Default translator (generic bus)
49 static void of_bus_default_count_cells(struct device_node *dev,
50 int *addrc, int *sizec)
53 *addrc = of_n_addr_cells(dev);
55 *sizec = of_n_size_cells(dev);
58 static u64 of_bus_default_map(u32 *addr, const __be32 *range,
59 int na, int ns, int pna)
63 cp = of_read_number(range, na);
64 s = of_read_number(range + na + pna, ns);
65 da = of_read_number(addr, na);
67 pr_debug("OF: default map, cp=%llx, s=%llx, da=%llx\n",
68 (unsigned long long)cp, (unsigned long long)s,
69 (unsigned long long)da);
71 if (da < cp || da >= (cp + s))
76 static int of_bus_default_translate(u32 *addr, u64 offset, int na)
78 u64 a = of_read_number(addr, na);
79 memset(addr, 0, na * 4);
82 addr[na - 2] = cpu_to_be32(a >> 32);
83 addr[na - 1] = cpu_to_be32(a & 0xffffffffu);
88 static unsigned int of_bus_default_get_flags(const __be32 *addr)
90 return IORESOURCE_MEM;
95 * PCI bus specific translator
98 static int of_bus_pci_match(struct device_node *np)
101 * "pciex" is PCI Express
102 * "vci" is for the /chaos bridge on 1st-gen PCI powermacs
103 * "ht" is hypertransport
105 return !strcmp(np->type, "pci") || !strcmp(np->type, "pciex") ||
106 !strcmp(np->type, "vci") || !strcmp(np->type, "ht");
109 static void of_bus_pci_count_cells(struct device_node *np,
110 int *addrc, int *sizec)
118 static unsigned int of_bus_pci_get_flags(const __be32 *addr)
120 unsigned int flags = 0;
121 u32 w = be32_to_cpup(addr);
123 switch((w >> 24) & 0x03) {
125 flags |= IORESOURCE_IO;
127 case 0x02: /* 32 bits */
128 case 0x03: /* 64 bits */
129 flags |= IORESOURCE_MEM;
133 flags |= IORESOURCE_PREFETCH;
137 static u64 of_bus_pci_map(u32 *addr, const __be32 *range, int na, int ns,
143 af = of_bus_pci_get_flags(addr);
144 rf = of_bus_pci_get_flags(range);
146 /* Check address type match */
147 if ((af ^ rf) & (IORESOURCE_MEM | IORESOURCE_IO))
150 /* Read address values, skipping high cell */
151 cp = of_read_number(range + 1, na - 1);
152 s = of_read_number(range + na + pna, ns);
153 da = of_read_number(addr + 1, na - 1);
155 pr_debug("OF: PCI map, cp=%llx, s=%llx, da=%llx\n",
156 (unsigned long long)cp, (unsigned long long)s,
157 (unsigned long long)da);
159 if (da < cp || da >= (cp + s))
164 static int of_bus_pci_translate(u32 *addr, u64 offset, int na)
166 return of_bus_default_translate(addr + 1, offset, na - 1);
169 const __be32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
174 struct device_node *parent;
176 int onesize, i, na, ns;
178 /* Get parent & match bus type */
179 parent = of_get_parent(dev);
182 bus = of_match_bus(parent);
183 if (strcmp(bus->name, "pci")) {
187 bus->count_cells(dev, &na, &ns);
189 if (!OF_CHECK_COUNTS(na, ns))
192 /* Get "reg" or "assigned-addresses" property */
193 prop = of_get_property(dev, bus->addresses, &psize);
199 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++) {
200 u32 val = be32_to_cpu(prop[0]);
201 if ((val & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0)) {
203 *size = of_read_number(prop + na, ns);
205 *flags = bus->get_flags(prop);
211 EXPORT_SYMBOL(of_get_pci_address);
213 int of_pci_address_to_resource(struct device_node *dev, int bar,
220 addrp = of_get_pci_address(dev, bar, &size, &flags);
223 return __of_address_to_resource(dev, addrp, size, flags, r);
225 EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
226 #endif /* CONFIG_PCI */
229 * ISA bus specific translator
232 static int of_bus_isa_match(struct device_node *np)
234 return !strcmp(np->name, "isa");
237 static void of_bus_isa_count_cells(struct device_node *child,
238 int *addrc, int *sizec)
246 static u64 of_bus_isa_map(u32 *addr, const __be32 *range, int na, int ns,
251 /* Check address type match */
252 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
255 /* Read address values, skipping high cell */
256 cp = of_read_number(range + 1, na - 1);
257 s = of_read_number(range + na + pna, ns);
258 da = of_read_number(addr + 1, na - 1);
260 pr_debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n",
261 (unsigned long long)cp, (unsigned long long)s,
262 (unsigned long long)da);
264 if (da < cp || da >= (cp + s))
269 static int of_bus_isa_translate(u32 *addr, u64 offset, int na)
271 return of_bus_default_translate(addr + 1, offset, na - 1);
274 static unsigned int of_bus_isa_get_flags(const __be32 *addr)
276 unsigned int flags = 0;
277 u32 w = be32_to_cpup(addr);
280 flags |= IORESOURCE_IO;
282 flags |= IORESOURCE_MEM;
287 * Array of bus specific translators
290 static struct of_bus of_busses[] = {
295 .addresses = "assigned-addresses",
296 .match = of_bus_pci_match,
297 .count_cells = of_bus_pci_count_cells,
298 .map = of_bus_pci_map,
299 .translate = of_bus_pci_translate,
300 .get_flags = of_bus_pci_get_flags,
302 #endif /* CONFIG_PCI */
307 .match = of_bus_isa_match,
308 .count_cells = of_bus_isa_count_cells,
309 .map = of_bus_isa_map,
310 .translate = of_bus_isa_translate,
311 .get_flags = of_bus_isa_get_flags,
318 .count_cells = of_bus_default_count_cells,
319 .map = of_bus_default_map,
320 .translate = of_bus_default_translate,
321 .get_flags = of_bus_default_get_flags,
325 static struct of_bus *of_match_bus(struct device_node *np)
329 for (i = 0; i < ARRAY_SIZE(of_busses); i++)
330 if (!of_busses[i].match || of_busses[i].match(np))
331 return &of_busses[i];
336 static int of_empty_ranges_quirk(void)
339 /* To save cycles, we cache the result */
340 static int quirk_state = -1;
344 of_machine_is_compatible("Power Macintosh") ||
345 of_machine_is_compatible("MacRISC");
352 static int of_translate_one(struct device_node *parent, struct of_bus *bus,
353 struct of_bus *pbus, u32 *addr,
354 int na, int ns, int pna, const char *rprop)
356 const __be32 *ranges;
359 u64 offset = OF_BAD_ADDR;
361 /* Normally, an absence of a "ranges" property means we are
362 * crossing a non-translatable boundary, and thus the addresses
363 * below the current not cannot be converted to CPU physical ones.
364 * Unfortunately, while this is very clear in the spec, it's not
365 * what Apple understood, and they do have things like /uni-n or
366 * /ht nodes with no "ranges" property and a lot of perfectly
367 * useable mapped devices below them. Thus we treat the absence of
368 * "ranges" as equivalent to an empty "ranges" property which means
369 * a 1:1 translation at that level. It's up to the caller not to try
370 * to translate addresses that aren't supposed to be translated in
371 * the first place. --BenH.
373 * As far as we know, this damage only exists on Apple machines, so
374 * This code is only enabled on powerpc. --gcl
376 ranges = of_get_property(parent, rprop, &rlen);
377 if (ranges == NULL && !of_empty_ranges_quirk()) {
378 pr_err("OF: no ranges; cannot translate\n");
381 if (ranges == NULL || rlen == 0) {
382 offset = of_read_number(addr, na);
383 memset(addr, 0, pna * 4);
384 pr_debug("OF: empty ranges; 1:1 translation\n");
388 pr_debug("OF: walking ranges...\n");
390 /* Now walk through the ranges */
392 rone = na + pna + ns;
393 for (; rlen >= rone; rlen -= rone, ranges += rone) {
394 offset = bus->map(addr, ranges, na, ns, pna);
395 if (offset != OF_BAD_ADDR)
398 if (offset == OF_BAD_ADDR) {
399 pr_debug("OF: not found !\n");
402 memcpy(addr, ranges + na, 4 * pna);
405 of_dump_addr("OF: parent translation for:", addr, pna);
406 pr_debug("OF: with offset: %llx\n", (unsigned long long)offset);
408 /* Translate it into parent bus space */
409 return pbus->translate(addr, offset, pna);
413 * Translate an address from the device-tree into a CPU physical address,
414 * this walks up the tree and applies the various bus mappings on the
417 * Note: We consider that crossing any level with #size-cells == 0 to mean
418 * that translation is impossible (that is we are not dealing with a value
419 * that can be mapped to a cpu physical address). This is not really specified
420 * that way, but this is traditionally the way IBM at least do things
422 u64 __of_translate_address(struct device_node *dev, const __be32 *in_addr,
425 struct device_node *parent = NULL;
426 struct of_bus *bus, *pbus;
427 u32 addr[OF_MAX_ADDR_CELLS];
428 int na, ns, pna, pns;
429 u64 result = OF_BAD_ADDR;
431 pr_debug("OF: ** translation for device %s **\n", dev->full_name);
433 /* Increase refcount at current level */
436 /* Get parent & match bus type */
437 parent = of_get_parent(dev);
440 bus = of_match_bus(parent);
442 /* Cound address cells & copy address locally */
443 bus->count_cells(dev, &na, &ns);
444 if (!OF_CHECK_COUNTS(na, ns)) {
445 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
449 memcpy(addr, in_addr, na * 4);
451 pr_debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
452 bus->name, na, ns, parent->full_name);
453 of_dump_addr("OF: translating address:", addr, na);
457 /* Switch to parent bus */
460 parent = of_get_parent(dev);
462 /* If root, we have finished */
463 if (parent == NULL) {
464 pr_debug("OF: reached root node\n");
465 result = of_read_number(addr, na);
469 /* Get new parent bus and counts */
470 pbus = of_match_bus(parent);
471 pbus->count_cells(dev, &pna, &pns);
472 if (!OF_CHECK_COUNTS(pna, pns)) {
473 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
478 pr_debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
479 pbus->name, pna, pns, parent->full_name);
481 /* Apply bus translation */
482 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
485 /* Complete the move up one level */
490 of_dump_addr("OF: one level translation:", addr, na);
499 u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
501 return __of_translate_address(dev, in_addr, "ranges");
503 EXPORT_SYMBOL(of_translate_address);
505 u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
507 return __of_translate_address(dev, in_addr, "dma-ranges");
509 EXPORT_SYMBOL(of_translate_dma_address);
511 const __be32 *of_get_address(struct device_node *dev, int index, u64 *size,
516 struct device_node *parent;
518 int onesize, i, na, ns;
520 /* Get parent & match bus type */
521 parent = of_get_parent(dev);
524 bus = of_match_bus(parent);
525 bus->count_cells(dev, &na, &ns);
527 if (!OF_CHECK_COUNTS(na, ns))
530 /* Get "reg" or "assigned-addresses" property */
531 prop = of_get_property(dev, bus->addresses, &psize);
537 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
540 *size = of_read_number(prop + na, ns);
542 *flags = bus->get_flags(prop);
547 EXPORT_SYMBOL(of_get_address);
549 static int __of_address_to_resource(struct device_node *dev,
550 const __be32 *addrp, u64 size, unsigned int flags,
555 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
557 taddr = of_translate_address(dev, addrp);
558 if (taddr == OF_BAD_ADDR)
560 memset(r, 0, sizeof(struct resource));
561 if (flags & IORESOURCE_IO) {
563 port = pci_address_to_pio(taddr);
564 if (port == (unsigned long)-1)
567 r->end = port + size - 1;
570 r->end = taddr + size - 1;
573 r->name = dev->full_name;
578 * of_address_to_resource - Translate device tree address and return as resource
580 * Note that if your address is a PIO address, the conversion will fail if
581 * the physical address can't be internally converted to an IO token with
582 * pci_address_to_pio(), that is because it's either called to early or it
583 * can't be matched to any host bridge IO space
585 int of_address_to_resource(struct device_node *dev, int index,
592 addrp = of_get_address(dev, index, &size, &flags);
595 return __of_address_to_resource(dev, addrp, size, flags, r);
597 EXPORT_SYMBOL_GPL(of_address_to_resource);
599 struct device_node *of_find_matching_node_by_address(struct device_node *from,
600 const struct of_device_id *matches,
603 struct device_node *dn = of_find_matching_node(from, matches);
607 if (!of_address_to_resource(dn, 0, &res) &&
608 res.start == base_address)
611 dn = of_find_matching_node(dn, matches);
619 * of_iomap - Maps the memory mapped IO for a given device_node
620 * @device: the device whose io range will be mapped
621 * @index: index of the io range
623 * Returns a pointer to the mapped memory
625 void __iomem *of_iomap(struct device_node *np, int index)
629 if (of_address_to_resource(np, index, &res))
632 return ioremap(res.start, resource_size(&res));
634 EXPORT_SYMBOL(of_iomap);