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;
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);
170 const __be32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
175 struct device_node *parent;
177 int onesize, i, na, ns;
179 /* Get parent & match bus type */
180 parent = of_get_parent(dev);
183 bus = of_match_bus(parent);
184 if (strcmp(bus->name, "pci")) {
188 bus->count_cells(dev, &na, &ns);
190 if (!OF_CHECK_ADDR_COUNT(na))
193 /* Get "reg" or "assigned-addresses" property */
194 prop = of_get_property(dev, bus->addresses, &psize);
200 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++) {
201 u32 val = be32_to_cpu(prop[0]);
202 if ((val & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0)) {
204 *size = of_read_number(prop + na, ns);
206 *flags = bus->get_flags(prop);
212 EXPORT_SYMBOL(of_get_pci_address);
214 int of_pci_address_to_resource(struct device_node *dev, int bar,
221 addrp = of_get_pci_address(dev, bar, &size, &flags);
224 return __of_address_to_resource(dev, addrp, size, flags, NULL, r);
226 EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
227 #endif /* CONFIG_PCI */
230 * ISA bus specific translator
233 static int of_bus_isa_match(struct device_node *np)
235 return !strcmp(np->name, "isa");
238 static void of_bus_isa_count_cells(struct device_node *child,
239 int *addrc, int *sizec)
247 static u64 of_bus_isa_map(__be32 *addr, const __be32 *range, int na, int ns,
252 /* Check address type match */
253 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
256 /* Read address values, skipping high cell */
257 cp = of_read_number(range + 1, na - 1);
258 s = of_read_number(range + na + pna, ns);
259 da = of_read_number(addr + 1, na - 1);
261 pr_debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n",
262 (unsigned long long)cp, (unsigned long long)s,
263 (unsigned long long)da);
265 if (da < cp || da >= (cp + s))
270 static int of_bus_isa_translate(__be32 *addr, u64 offset, int na)
272 return of_bus_default_translate(addr + 1, offset, na - 1);
275 static unsigned int of_bus_isa_get_flags(const __be32 *addr)
277 unsigned int flags = 0;
278 u32 w = be32_to_cpup(addr);
281 flags |= IORESOURCE_IO;
283 flags |= IORESOURCE_MEM;
288 * Array of bus specific translators
291 static struct of_bus of_busses[] = {
296 .addresses = "assigned-addresses",
297 .match = of_bus_pci_match,
298 .count_cells = of_bus_pci_count_cells,
299 .map = of_bus_pci_map,
300 .translate = of_bus_pci_translate,
301 .get_flags = of_bus_pci_get_flags,
303 #endif /* CONFIG_PCI */
308 .match = of_bus_isa_match,
309 .count_cells = of_bus_isa_count_cells,
310 .map = of_bus_isa_map,
311 .translate = of_bus_isa_translate,
312 .get_flags = of_bus_isa_get_flags,
319 .count_cells = of_bus_default_count_cells,
320 .map = of_bus_default_map,
321 .translate = of_bus_default_translate,
322 .get_flags = of_bus_default_get_flags,
326 static struct of_bus *of_match_bus(struct device_node *np)
330 for (i = 0; i < ARRAY_SIZE(of_busses); i++)
331 if (!of_busses[i].match || of_busses[i].match(np))
332 return &of_busses[i];
337 static int of_translate_one(struct device_node *parent, struct of_bus *bus,
338 struct of_bus *pbus, __be32 *addr,
339 int na, int ns, int pna, const char *rprop)
341 const __be32 *ranges;
344 u64 offset = OF_BAD_ADDR;
346 /* Normally, an absence of a "ranges" property means we are
347 * crossing a non-translatable boundary, and thus the addresses
348 * below the current not cannot be converted to CPU physical ones.
349 * Unfortunately, while this is very clear in the spec, it's not
350 * what Apple understood, and they do have things like /uni-n or
351 * /ht nodes with no "ranges" property and a lot of perfectly
352 * useable mapped devices below them. Thus we treat the absence of
353 * "ranges" as equivalent to an empty "ranges" property which means
354 * a 1:1 translation at that level. It's up to the caller not to try
355 * to translate addresses that aren't supposed to be translated in
356 * the first place. --BenH.
358 * As far as we know, this damage only exists on Apple machines, so
359 * This code is only enabled on powerpc. --gcl
361 ranges = of_get_property(parent, rprop, &rlen);
362 #if !defined(CONFIG_PPC)
363 if (ranges == NULL) {
364 pr_err("OF: no ranges; cannot translate\n");
367 #endif /* !defined(CONFIG_PPC) */
368 if (ranges == NULL || rlen == 0) {
369 offset = of_read_number(addr, na);
370 memset(addr, 0, pna * 4);
371 pr_debug("OF: empty ranges; 1:1 translation\n");
375 pr_debug("OF: walking ranges...\n");
377 /* Now walk through the ranges */
379 rone = na + pna + ns;
380 for (; rlen >= rone; rlen -= rone, ranges += rone) {
381 offset = bus->map(addr, ranges, na, ns, pna);
382 if (offset != OF_BAD_ADDR)
385 if (offset == OF_BAD_ADDR) {
386 pr_debug("OF: not found !\n");
389 memcpy(addr, ranges + na, 4 * pna);
392 of_dump_addr("OF: parent translation for:", addr, pna);
393 pr_debug("OF: with offset: %llx\n", (unsigned long long)offset);
395 /* Translate it into parent bus space */
396 return pbus->translate(addr, offset, pna);
400 * Translate an address from the device-tree into a CPU physical address,
401 * this walks up the tree and applies the various bus mappings on the
404 * Note: We consider that crossing any level with #size-cells == 0 to mean
405 * that translation is impossible (that is we are not dealing with a value
406 * that can be mapped to a cpu physical address). This is not really specified
407 * that way, but this is traditionally the way IBM at least do things
409 static u64 __of_translate_address(struct device_node *dev,
410 const __be32 *in_addr, const char *rprop)
412 struct device_node *parent = NULL;
413 struct of_bus *bus, *pbus;
414 __be32 addr[OF_MAX_ADDR_CELLS];
415 int na, ns, pna, pns;
416 u64 result = OF_BAD_ADDR;
418 pr_debug("OF: ** translation for device %s **\n", dev->full_name);
420 /* Increase refcount at current level */
423 /* Get parent & match bus type */
424 parent = of_get_parent(dev);
427 bus = of_match_bus(parent);
429 /* Count address cells & copy address locally */
430 bus->count_cells(dev, &na, &ns);
431 if (!OF_CHECK_COUNTS(na, ns)) {
432 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
436 memcpy(addr, in_addr, na * 4);
438 pr_debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
439 bus->name, na, ns, parent->full_name);
440 of_dump_addr("OF: translating address:", addr, na);
444 /* Switch to parent bus */
447 parent = of_get_parent(dev);
449 /* If root, we have finished */
450 if (parent == NULL) {
451 pr_debug("OF: reached root node\n");
452 result = of_read_number(addr, na);
456 /* Get new parent bus and counts */
457 pbus = of_match_bus(parent);
458 pbus->count_cells(dev, &pna, &pns);
459 if (!OF_CHECK_COUNTS(pna, pns)) {
460 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
465 pr_debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
466 pbus->name, pna, pns, parent->full_name);
468 /* Apply bus translation */
469 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
472 /* Complete the move up one level */
477 of_dump_addr("OF: one level translation:", addr, na);
486 u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
488 return __of_translate_address(dev, in_addr, "ranges");
490 EXPORT_SYMBOL(of_translate_address);
492 u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
494 return __of_translate_address(dev, in_addr, "dma-ranges");
496 EXPORT_SYMBOL(of_translate_dma_address);
498 bool of_can_translate_address(struct device_node *dev)
500 struct device_node *parent;
504 parent = of_get_parent(dev);
508 bus = of_match_bus(parent);
509 bus->count_cells(dev, &na, &ns);
513 return OF_CHECK_COUNTS(na, ns);
515 EXPORT_SYMBOL(of_can_translate_address);
517 const __be32 *of_get_address(struct device_node *dev, int index, u64 *size,
522 struct device_node *parent;
524 int onesize, i, na, ns;
526 /* Get parent & match bus type */
527 parent = of_get_parent(dev);
530 bus = of_match_bus(parent);
531 bus->count_cells(dev, &na, &ns);
533 if (!OF_CHECK_ADDR_COUNT(na))
536 /* Get "reg" or "assigned-addresses" property */
537 prop = of_get_property(dev, bus->addresses, &psize);
543 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
546 *size = of_read_number(prop + na, ns);
548 *flags = bus->get_flags(prop);
553 EXPORT_SYMBOL(of_get_address);
555 static int __of_address_to_resource(struct device_node *dev,
556 const __be32 *addrp, u64 size, unsigned int flags,
557 const char *name, struct resource *r)
561 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
563 taddr = of_translate_address(dev, addrp);
564 if (taddr == OF_BAD_ADDR)
566 memset(r, 0, sizeof(struct resource));
567 if (flags & IORESOURCE_IO) {
569 port = pci_address_to_pio(taddr);
570 if (port == (unsigned long)-1)
573 r->end = port + size - 1;
576 r->end = taddr + size - 1;
579 r->name = name ? name : dev->full_name;
585 * of_address_to_resource - Translate device tree address and return as resource
587 * Note that if your address is a PIO address, the conversion will fail if
588 * the physical address can't be internally converted to an IO token with
589 * pci_address_to_pio(), that is because it's either called to early or it
590 * can't be matched to any host bridge IO space
592 int of_address_to_resource(struct device_node *dev, int index,
598 const char *name = NULL;
600 addrp = of_get_address(dev, index, &size, &flags);
604 /* Get optional "reg-names" property to add a name to a resource */
605 of_property_read_string_index(dev, "reg-names", index, &name);
607 return __of_address_to_resource(dev, addrp, size, flags, name, r);
609 EXPORT_SYMBOL_GPL(of_address_to_resource);
611 struct device_node *of_find_matching_node_by_address(struct device_node *from,
612 const struct of_device_id *matches,
615 struct device_node *dn = of_find_matching_node(from, matches);
619 if (of_address_to_resource(dn, 0, &res))
621 if (res.start == base_address)
623 dn = of_find_matching_node(dn, matches);
631 * of_iomap - Maps the memory mapped IO for a given device_node
632 * @device: the device whose io range will be mapped
633 * @index: index of the io range
635 * Returns a pointer to the mapped memory
637 void __iomem *of_iomap(struct device_node *np, int index)
641 if (of_address_to_resource(np, index, &res))
644 return ioremap(res.start, resource_size(&res));
646 EXPORT_SYMBOL(of_iomap);