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_empty_ranges_quirk(void)
339 if (IS_ENABLED(CONFIG_PPC
)) {
340 /* To save cycles, we cache the result */
341 static int quirk_state
= -1;
345 of_machine_is_compatible("Power Macintosh") ||
346 of_machine_is_compatible("MacRISC");
352 static int of_translate_one(struct device_node
*parent
, struct of_bus
*bus
,
353 struct of_bus
*pbus
, __be32
*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 static u64
__of_translate_address(struct device_node
*dev
,
423 const __be32
*in_addr
, const char *rprop
)
425 struct device_node
*parent
= NULL
;
426 struct of_bus
*bus
, *pbus
;
427 __be32 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 /* Count 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 bool of_can_translate_address(struct device_node
*dev
)
513 struct device_node
*parent
;
517 parent
= of_get_parent(dev
);
521 bus
= of_match_bus(parent
);
522 bus
->count_cells(dev
, &na
, &ns
);
526 return OF_CHECK_COUNTS(na
, ns
);
528 EXPORT_SYMBOL(of_can_translate_address
);
530 const __be32
*of_get_address(struct device_node
*dev
, int index
, u64
*size
,
535 struct device_node
*parent
;
537 int onesize
, i
, na
, ns
;
539 /* Get parent & match bus type */
540 parent
= of_get_parent(dev
);
543 bus
= of_match_bus(parent
);
544 bus
->count_cells(dev
, &na
, &ns
);
546 if (!OF_CHECK_ADDR_COUNT(na
))
549 /* Get "reg" or "assigned-addresses" property */
550 prop
= of_get_property(dev
, bus
->addresses
, &psize
);
556 for (i
= 0; psize
>= onesize
; psize
-= onesize
, prop
+= onesize
, i
++)
559 *size
= of_read_number(prop
+ na
, ns
);
561 *flags
= bus
->get_flags(prop
);
566 EXPORT_SYMBOL(of_get_address
);
568 static int __of_address_to_resource(struct device_node
*dev
,
569 const __be32
*addrp
, u64 size
, unsigned int flags
,
570 const char *name
, struct resource
*r
)
574 if ((flags
& (IORESOURCE_IO
| IORESOURCE_MEM
)) == 0)
576 taddr
= of_translate_address(dev
, addrp
);
577 if (taddr
== OF_BAD_ADDR
)
579 memset(r
, 0, sizeof(struct resource
));
580 if (flags
& IORESOURCE_IO
) {
582 port
= pci_address_to_pio(taddr
);
583 if (port
== (unsigned long)-1)
586 r
->end
= port
+ size
- 1;
589 r
->end
= taddr
+ size
- 1;
592 r
->name
= name
? name
: dev
->full_name
;
598 * of_address_to_resource - Translate device tree address and return as resource
600 * Note that if your address is a PIO address, the conversion will fail if
601 * the physical address can't be internally converted to an IO token with
602 * pci_address_to_pio(), that is because it's either called to early or it
603 * can't be matched to any host bridge IO space
605 int of_address_to_resource(struct device_node
*dev
, int index
,
611 const char *name
= NULL
;
613 addrp
= of_get_address(dev
, index
, &size
, &flags
);
617 /* Get optional "reg-names" property to add a name to a resource */
618 of_property_read_string_index(dev
, "reg-names", index
, &name
);
620 return __of_address_to_resource(dev
, addrp
, size
, flags
, name
, r
);
622 EXPORT_SYMBOL_GPL(of_address_to_resource
);
624 struct device_node
*of_find_matching_node_by_address(struct device_node
*from
,
625 const struct of_device_id
*matches
,
628 struct device_node
*dn
= of_find_matching_node(from
, matches
);
632 if (!of_address_to_resource(dn
, 0, &res
) &&
633 res
.start
== base_address
)
636 dn
= of_find_matching_node(dn
, matches
);
644 * of_iomap - Maps the memory mapped IO for a given device_node
645 * @device: the device whose io range will be mapped
646 * @index: index of the io range
648 * Returns a pointer to the mapped memory
650 void __iomem
*of_iomap(struct device_node
*np
, int index
)
654 if (of_address_to_resource(np
, index
, &res
))
657 return ioremap(res
.start
, resource_size(&res
));
659 EXPORT_SYMBOL(of_iomap
);