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
);
228 int of_pci_range_parser_init(struct of_pci_range_parser
*parser
,
229 struct device_node
*node
)
231 const int na
= 3, ns
= 2;
235 parser
->pna
= of_n_addr_cells(node
);
236 parser
->np
= parser
->pna
+ na
+ ns
;
238 parser
->range
= of_get_property(node
, "ranges", &rlen
);
239 if (parser
->range
== NULL
)
242 parser
->end
= parser
->range
+ rlen
/ sizeof(__be32
);
246 EXPORT_SYMBOL_GPL(of_pci_range_parser_init
);
248 struct of_pci_range
*of_pci_range_parser_one(struct of_pci_range_parser
*parser
,
249 struct of_pci_range
*range
)
251 const int na
= 3, ns
= 2;
256 if (!parser
->range
|| parser
->range
+ parser
->np
> parser
->end
)
259 range
->pci_space
= parser
->range
[0];
260 range
->flags
= of_bus_pci_get_flags(parser
->range
);
261 range
->pci_addr
= of_read_number(parser
->range
+ 1, ns
);
262 range
->cpu_addr
= of_translate_address(parser
->node
,
264 range
->size
= of_read_number(parser
->range
+ parser
->pna
+ na
, ns
);
266 parser
->range
+= parser
->np
;
268 /* Now consume following elements while they are contiguous */
269 while (parser
->range
+ parser
->np
<= parser
->end
) {
270 u32 flags
, pci_space
;
271 u64 pci_addr
, cpu_addr
, size
;
273 pci_space
= be32_to_cpup(parser
->range
);
274 flags
= of_bus_pci_get_flags(parser
->range
);
275 pci_addr
= of_read_number(parser
->range
+ 1, ns
);
276 cpu_addr
= of_translate_address(parser
->node
,
278 size
= of_read_number(parser
->range
+ parser
->pna
+ na
, ns
);
280 if (flags
!= range
->flags
)
282 if (pci_addr
!= range
->pci_addr
+ range
->size
||
283 cpu_addr
!= range
->cpu_addr
+ range
->size
)
287 parser
->range
+= parser
->np
;
292 EXPORT_SYMBOL_GPL(of_pci_range_parser_one
);
294 #endif /* CONFIG_PCI */
297 * ISA bus specific translator
300 static int of_bus_isa_match(struct device_node
*np
)
302 return !strcmp(np
->name
, "isa");
305 static void of_bus_isa_count_cells(struct device_node
*child
,
306 int *addrc
, int *sizec
)
314 static u64
of_bus_isa_map(__be32
*addr
, const __be32
*range
, int na
, int ns
,
319 /* Check address type match */
320 if ((addr
[0] ^ range
[0]) & cpu_to_be32(1))
323 /* Read address values, skipping high cell */
324 cp
= of_read_number(range
+ 1, na
- 1);
325 s
= of_read_number(range
+ na
+ pna
, ns
);
326 da
= of_read_number(addr
+ 1, na
- 1);
328 pr_debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n",
329 (unsigned long long)cp
, (unsigned long long)s
,
330 (unsigned long long)da
);
332 if (da
< cp
|| da
>= (cp
+ s
))
337 static int of_bus_isa_translate(__be32
*addr
, u64 offset
, int na
)
339 return of_bus_default_translate(addr
+ 1, offset
, na
- 1);
342 static unsigned int of_bus_isa_get_flags(const __be32
*addr
)
344 unsigned int flags
= 0;
345 u32 w
= be32_to_cpup(addr
);
348 flags
|= IORESOURCE_IO
;
350 flags
|= IORESOURCE_MEM
;
355 * Array of bus specific translators
358 static struct of_bus of_busses
[] = {
363 .addresses
= "assigned-addresses",
364 .match
= of_bus_pci_match
,
365 .count_cells
= of_bus_pci_count_cells
,
366 .map
= of_bus_pci_map
,
367 .translate
= of_bus_pci_translate
,
368 .get_flags
= of_bus_pci_get_flags
,
370 #endif /* CONFIG_PCI */
375 .match
= of_bus_isa_match
,
376 .count_cells
= of_bus_isa_count_cells
,
377 .map
= of_bus_isa_map
,
378 .translate
= of_bus_isa_translate
,
379 .get_flags
= of_bus_isa_get_flags
,
386 .count_cells
= of_bus_default_count_cells
,
387 .map
= of_bus_default_map
,
388 .translate
= of_bus_default_translate
,
389 .get_flags
= of_bus_default_get_flags
,
393 static struct of_bus
*of_match_bus(struct device_node
*np
)
397 for (i
= 0; i
< ARRAY_SIZE(of_busses
); i
++)
398 if (!of_busses
[i
].match
|| of_busses
[i
].match(np
))
399 return &of_busses
[i
];
404 static int of_empty_ranges_quirk(void)
406 if (IS_ENABLED(CONFIG_PPC
)) {
407 /* To save cycles, we cache the result */
408 static int quirk_state
= -1;
412 of_machine_is_compatible("Power Macintosh") ||
413 of_machine_is_compatible("MacRISC");
419 static int of_translate_one(struct device_node
*parent
, struct of_bus
*bus
,
420 struct of_bus
*pbus
, __be32
*addr
,
421 int na
, int ns
, int pna
, const char *rprop
)
423 const __be32
*ranges
;
426 u64 offset
= OF_BAD_ADDR
;
428 /* Normally, an absence of a "ranges" property means we are
429 * crossing a non-translatable boundary, and thus the addresses
430 * below the current not cannot be converted to CPU physical ones.
431 * Unfortunately, while this is very clear in the spec, it's not
432 * what Apple understood, and they do have things like /uni-n or
433 * /ht nodes with no "ranges" property and a lot of perfectly
434 * useable mapped devices below them. Thus we treat the absence of
435 * "ranges" as equivalent to an empty "ranges" property which means
436 * a 1:1 translation at that level. It's up to the caller not to try
437 * to translate addresses that aren't supposed to be translated in
438 * the first place. --BenH.
440 * As far as we know, this damage only exists on Apple machines, so
441 * This code is only enabled on powerpc. --gcl
443 ranges
= of_get_property(parent
, rprop
, &rlen
);
444 if (ranges
== NULL
&& !of_empty_ranges_quirk()) {
445 pr_err("OF: no ranges; cannot translate\n");
448 if (ranges
== NULL
|| rlen
== 0) {
449 offset
= of_read_number(addr
, na
);
450 memset(addr
, 0, pna
* 4);
451 pr_debug("OF: empty ranges; 1:1 translation\n");
455 pr_debug("OF: walking ranges...\n");
457 /* Now walk through the ranges */
459 rone
= na
+ pna
+ ns
;
460 for (; rlen
>= rone
; rlen
-= rone
, ranges
+= rone
) {
461 offset
= bus
->map(addr
, ranges
, na
, ns
, pna
);
462 if (offset
!= OF_BAD_ADDR
)
465 if (offset
== OF_BAD_ADDR
) {
466 pr_debug("OF: not found !\n");
469 memcpy(addr
, ranges
+ na
, 4 * pna
);
472 of_dump_addr("OF: parent translation for:", addr
, pna
);
473 pr_debug("OF: with offset: %llx\n", (unsigned long long)offset
);
475 /* Translate it into parent bus space */
476 return pbus
->translate(addr
, offset
, pna
);
480 * Translate an address from the device-tree into a CPU physical address,
481 * this walks up the tree and applies the various bus mappings on the
484 * Note: We consider that crossing any level with #size-cells == 0 to mean
485 * that translation is impossible (that is we are not dealing with a value
486 * that can be mapped to a cpu physical address). This is not really specified
487 * that way, but this is traditionally the way IBM at least do things
489 static u64
__of_translate_address(struct device_node
*dev
,
490 const __be32
*in_addr
, const char *rprop
)
492 struct device_node
*parent
= NULL
;
493 struct of_bus
*bus
, *pbus
;
494 __be32 addr
[OF_MAX_ADDR_CELLS
];
495 int na
, ns
, pna
, pns
;
496 u64 result
= OF_BAD_ADDR
;
498 pr_debug("OF: ** translation for device %s **\n", dev
->full_name
);
500 /* Increase refcount at current level */
503 /* Get parent & match bus type */
504 parent
= of_get_parent(dev
);
507 bus
= of_match_bus(parent
);
509 /* Count address cells & copy address locally */
510 bus
->count_cells(dev
, &na
, &ns
);
511 if (!OF_CHECK_COUNTS(na
, ns
)) {
512 printk(KERN_ERR
"prom_parse: Bad cell count for %s\n",
516 memcpy(addr
, in_addr
, na
* 4);
518 pr_debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
519 bus
->name
, na
, ns
, parent
->full_name
);
520 of_dump_addr("OF: translating address:", addr
, na
);
524 /* Switch to parent bus */
527 parent
= of_get_parent(dev
);
529 /* If root, we have finished */
530 if (parent
== NULL
) {
531 pr_debug("OF: reached root node\n");
532 result
= of_read_number(addr
, na
);
536 /* Get new parent bus and counts */
537 pbus
= of_match_bus(parent
);
538 pbus
->count_cells(dev
, &pna
, &pns
);
539 if (!OF_CHECK_COUNTS(pna
, pns
)) {
540 printk(KERN_ERR
"prom_parse: Bad cell count for %s\n",
545 pr_debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
546 pbus
->name
, pna
, pns
, parent
->full_name
);
548 /* Apply bus translation */
549 if (of_translate_one(dev
, bus
, pbus
, addr
, na
, ns
, pna
, rprop
))
552 /* Complete the move up one level */
557 of_dump_addr("OF: one level translation:", addr
, na
);
566 u64
of_translate_address(struct device_node
*dev
, const __be32
*in_addr
)
568 return __of_translate_address(dev
, in_addr
, "ranges");
570 EXPORT_SYMBOL(of_translate_address
);
572 u64
of_translate_dma_address(struct device_node
*dev
, const __be32
*in_addr
)
574 return __of_translate_address(dev
, in_addr
, "dma-ranges");
576 EXPORT_SYMBOL(of_translate_dma_address
);
578 bool of_can_translate_address(struct device_node
*dev
)
580 struct device_node
*parent
;
584 parent
= of_get_parent(dev
);
588 bus
= of_match_bus(parent
);
589 bus
->count_cells(dev
, &na
, &ns
);
593 return OF_CHECK_COUNTS(na
, ns
);
595 EXPORT_SYMBOL(of_can_translate_address
);
597 const __be32
*of_get_address(struct device_node
*dev
, int index
, u64
*size
,
602 struct device_node
*parent
;
604 int onesize
, i
, na
, ns
;
606 /* Get parent & match bus type */
607 parent
= of_get_parent(dev
);
610 bus
= of_match_bus(parent
);
611 bus
->count_cells(dev
, &na
, &ns
);
613 if (!OF_CHECK_ADDR_COUNT(na
))
616 /* Get "reg" or "assigned-addresses" property */
617 prop
= of_get_property(dev
, bus
->addresses
, &psize
);
623 for (i
= 0; psize
>= onesize
; psize
-= onesize
, prop
+= onesize
, i
++)
626 *size
= of_read_number(prop
+ na
, ns
);
628 *flags
= bus
->get_flags(prop
);
633 EXPORT_SYMBOL(of_get_address
);
635 static int __of_address_to_resource(struct device_node
*dev
,
636 const __be32
*addrp
, u64 size
, unsigned int flags
,
637 const char *name
, struct resource
*r
)
641 if ((flags
& (IORESOURCE_IO
| IORESOURCE_MEM
)) == 0)
643 taddr
= of_translate_address(dev
, addrp
);
644 if (taddr
== OF_BAD_ADDR
)
646 memset(r
, 0, sizeof(struct resource
));
647 if (flags
& IORESOURCE_IO
) {
649 port
= pci_address_to_pio(taddr
);
650 if (port
== (unsigned long)-1)
653 r
->end
= port
+ size
- 1;
656 r
->end
= taddr
+ size
- 1;
659 r
->name
= name
? name
: dev
->full_name
;
665 * of_address_to_resource - Translate device tree address and return as resource
667 * Note that if your address is a PIO address, the conversion will fail if
668 * the physical address can't be internally converted to an IO token with
669 * pci_address_to_pio(), that is because it's either called to early or it
670 * can't be matched to any host bridge IO space
672 int of_address_to_resource(struct device_node
*dev
, int index
,
678 const char *name
= NULL
;
680 addrp
= of_get_address(dev
, index
, &size
, &flags
);
684 /* Get optional "reg-names" property to add a name to a resource */
685 of_property_read_string_index(dev
, "reg-names", index
, &name
);
687 return __of_address_to_resource(dev
, addrp
, size
, flags
, name
, r
);
689 EXPORT_SYMBOL_GPL(of_address_to_resource
);
691 struct device_node
*of_find_matching_node_by_address(struct device_node
*from
,
692 const struct of_device_id
*matches
,
695 struct device_node
*dn
= of_find_matching_node(from
, matches
);
699 if (of_address_to_resource(dn
, 0, &res
))
701 if (res
.start
== base_address
)
703 dn
= of_find_matching_node(dn
, matches
);
711 * of_iomap - Maps the memory mapped IO for a given device_node
712 * @device: the device whose io range will be mapped
713 * @index: index of the io range
715 * Returns a pointer to the mapped memory
717 void __iomem
*of_iomap(struct device_node
*np
, int index
)
721 if (of_address_to_resource(np
, index
, &res
))
724 return ioremap(res
.start
, resource_size(&res
));
726 EXPORT_SYMBOL(of_iomap
);