2 #define pr_fmt(fmt) "OF: " fmt
4 #include <linux/device.h>
6 #include <linux/ioport.h>
7 #include <linux/module.h>
8 #include <linux/of_address.h>
10 #include <linux/pci_regs.h>
11 #include <linux/sizes.h>
12 #include <linux/slab.h>
13 #include <linux/string.h>
15 /* Max address size we deal with */
16 #define OF_MAX_ADDR_CELLS 4
17 #define OF_CHECK_ADDR_COUNT(na) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS)
18 #define OF_CHECK_COUNTS(na, ns) (OF_CHECK_ADDR_COUNT(na) && (ns) > 0)
20 static struct of_bus
*of_match_bus(struct device_node
*np
);
21 static int __of_address_to_resource(struct device_node
*dev
,
22 const __be32
*addrp
, u64 size
, unsigned int flags
,
23 const char *name
, struct resource
*r
);
27 static void of_dump_addr(const char *s
, const __be32
*addr
, int na
)
31 pr_cont(" %08x", be32_to_cpu(*(addr
++)));
35 static void of_dump_addr(const char *s
, const __be32
*addr
, int na
) { }
38 /* Callbacks for bus specific translators */
41 const char *addresses
;
42 int (*match
)(struct device_node
*parent
);
43 void (*count_cells
)(struct device_node
*child
,
44 int *addrc
, int *sizec
);
45 u64 (*map
)(__be32
*addr
, const __be32
*range
,
46 int na
, int ns
, int pna
);
47 int (*translate
)(__be32
*addr
, u64 offset
, int na
);
48 unsigned int (*get_flags
)(const __be32
*addr
);
52 * Default translator (generic bus)
55 static void of_bus_default_count_cells(struct device_node
*dev
,
56 int *addrc
, int *sizec
)
59 *addrc
= of_n_addr_cells(dev
);
61 *sizec
= of_n_size_cells(dev
);
64 static u64
of_bus_default_map(__be32
*addr
, const __be32
*range
,
65 int na
, int ns
, int pna
)
69 cp
= of_read_number(range
, na
);
70 s
= of_read_number(range
+ na
+ pna
, ns
);
71 da
= of_read_number(addr
, na
);
73 pr_debug("default map, cp=%llx, s=%llx, da=%llx\n",
74 (unsigned long long)cp
, (unsigned long long)s
,
75 (unsigned long long)da
);
77 if (da
< cp
|| da
>= (cp
+ s
))
82 static int of_bus_default_translate(__be32
*addr
, u64 offset
, int na
)
84 u64 a
= of_read_number(addr
, na
);
85 memset(addr
, 0, na
* 4);
88 addr
[na
- 2] = cpu_to_be32(a
>> 32);
89 addr
[na
- 1] = cpu_to_be32(a
& 0xffffffffu
);
94 static unsigned int of_bus_default_get_flags(const __be32
*addr
)
96 return IORESOURCE_MEM
;
99 #ifdef CONFIG_OF_ADDRESS_PCI
101 * PCI bus specific translator
104 static int of_bus_pci_match(struct device_node
*np
)
107 * "pciex" is PCI Express
108 * "vci" is for the /chaos bridge on 1st-gen PCI powermacs
109 * "ht" is hypertransport
111 return !strcmp(np
->type
, "pci") || !strcmp(np
->type
, "pciex") ||
112 !strcmp(np
->type
, "vci") || !strcmp(np
->type
, "ht");
115 static void of_bus_pci_count_cells(struct device_node
*np
,
116 int *addrc
, int *sizec
)
124 static unsigned int of_bus_pci_get_flags(const __be32
*addr
)
126 unsigned int flags
= 0;
127 u32 w
= be32_to_cpup(addr
);
129 switch((w
>> 24) & 0x03) {
131 flags
|= IORESOURCE_IO
;
133 case 0x02: /* 32 bits */
134 case 0x03: /* 64 bits */
135 flags
|= IORESOURCE_MEM
;
139 flags
|= IORESOURCE_PREFETCH
;
143 static u64
of_bus_pci_map(__be32
*addr
, const __be32
*range
, int na
, int ns
,
149 af
= of_bus_pci_get_flags(addr
);
150 rf
= of_bus_pci_get_flags(range
);
152 /* Check address type match */
153 if ((af
^ rf
) & (IORESOURCE_MEM
| IORESOURCE_IO
))
156 /* Read address values, skipping high cell */
157 cp
= of_read_number(range
+ 1, na
- 1);
158 s
= of_read_number(range
+ na
+ pna
, ns
);
159 da
= of_read_number(addr
+ 1, na
- 1);
161 pr_debug("PCI map, cp=%llx, s=%llx, da=%llx\n",
162 (unsigned long long)cp
, (unsigned long long)s
,
163 (unsigned long long)da
);
165 if (da
< cp
|| da
>= (cp
+ s
))
170 static int of_bus_pci_translate(__be32
*addr
, u64 offset
, int na
)
172 return of_bus_default_translate(addr
+ 1, offset
, na
- 1);
174 #endif /* CONFIG_OF_ADDRESS_PCI */
177 const __be32
*of_get_pci_address(struct device_node
*dev
, int bar_no
, u64
*size
,
182 struct device_node
*parent
;
184 int onesize
, i
, na
, ns
;
186 /* Get parent & match bus type */
187 parent
= of_get_parent(dev
);
190 bus
= of_match_bus(parent
);
191 if (strcmp(bus
->name
, "pci")) {
195 bus
->count_cells(dev
, &na
, &ns
);
197 if (!OF_CHECK_ADDR_COUNT(na
))
200 /* Get "reg" or "assigned-addresses" property */
201 prop
= of_get_property(dev
, bus
->addresses
, &psize
);
207 for (i
= 0; psize
>= onesize
; psize
-= onesize
, prop
+= onesize
, i
++) {
208 u32 val
= be32_to_cpu(prop
[0]);
209 if ((val
& 0xff) == ((bar_no
* 4) + PCI_BASE_ADDRESS_0
)) {
211 *size
= of_read_number(prop
+ na
, ns
);
213 *flags
= bus
->get_flags(prop
);
219 EXPORT_SYMBOL(of_get_pci_address
);
221 int of_pci_address_to_resource(struct device_node
*dev
, int bar
,
228 addrp
= of_get_pci_address(dev
, bar
, &size
, &flags
);
231 return __of_address_to_resource(dev
, addrp
, size
, flags
, NULL
, r
);
233 EXPORT_SYMBOL_GPL(of_pci_address_to_resource
);
235 int of_pci_range_parser_init(struct of_pci_range_parser
*parser
,
236 struct device_node
*node
)
238 const int na
= 3, ns
= 2;
242 parser
->pna
= of_n_addr_cells(node
);
243 parser
->np
= parser
->pna
+ na
+ ns
;
245 parser
->range
= of_get_property(node
, "ranges", &rlen
);
246 if (parser
->range
== NULL
)
249 parser
->end
= parser
->range
+ rlen
/ sizeof(__be32
);
253 EXPORT_SYMBOL_GPL(of_pci_range_parser_init
);
255 struct of_pci_range
*of_pci_range_parser_one(struct of_pci_range_parser
*parser
,
256 struct of_pci_range
*range
)
258 const int na
= 3, ns
= 2;
263 if (!parser
->range
|| parser
->range
+ parser
->np
> parser
->end
)
266 range
->pci_space
= be32_to_cpup(parser
->range
);
267 range
->flags
= of_bus_pci_get_flags(parser
->range
);
268 range
->pci_addr
= of_read_number(parser
->range
+ 1, ns
);
269 range
->cpu_addr
= of_translate_address(parser
->node
,
271 range
->size
= of_read_number(parser
->range
+ parser
->pna
+ na
, ns
);
273 parser
->range
+= parser
->np
;
275 /* Now consume following elements while they are contiguous */
276 while (parser
->range
+ parser
->np
<= parser
->end
) {
277 u32 flags
, pci_space
;
278 u64 pci_addr
, cpu_addr
, size
;
280 pci_space
= be32_to_cpup(parser
->range
);
281 flags
= of_bus_pci_get_flags(parser
->range
);
282 pci_addr
= of_read_number(parser
->range
+ 1, ns
);
283 cpu_addr
= of_translate_address(parser
->node
,
285 size
= of_read_number(parser
->range
+ parser
->pna
+ na
, ns
);
287 if (flags
!= range
->flags
)
289 if (pci_addr
!= range
->pci_addr
+ range
->size
||
290 cpu_addr
!= range
->cpu_addr
+ range
->size
)
294 parser
->range
+= parser
->np
;
299 EXPORT_SYMBOL_GPL(of_pci_range_parser_one
);
302 * of_pci_range_to_resource - Create a resource from an of_pci_range
303 * @range: the PCI range that describes the resource
304 * @np: device node where the range belongs to
305 * @res: pointer to a valid resource that will be updated to
306 * reflect the values contained in the range.
308 * Returns EINVAL if the range cannot be converted to resource.
310 * Note that if the range is an IO range, the resource will be converted
311 * using pci_address_to_pio() which can fail if it is called too early or
312 * if the range cannot be matched to any host bridge IO space (our case here).
313 * To guard against that we try to register the IO range first.
314 * If that fails we know that pci_address_to_pio() will do too.
316 int of_pci_range_to_resource(struct of_pci_range
*range
,
317 struct device_node
*np
, struct resource
*res
)
320 res
->flags
= range
->flags
;
321 res
->parent
= res
->child
= res
->sibling
= NULL
;
322 res
->name
= np
->full_name
;
324 if (res
->flags
& IORESOURCE_IO
) {
326 err
= pci_register_io_range(range
->cpu_addr
, range
->size
);
329 port
= pci_address_to_pio(range
->cpu_addr
);
330 if (port
== (unsigned long)-1) {
336 if ((sizeof(resource_size_t
) < 8) &&
337 upper_32_bits(range
->cpu_addr
)) {
342 res
->start
= range
->cpu_addr
;
344 res
->end
= res
->start
+ range
->size
- 1;
348 res
->start
= (resource_size_t
)OF_BAD_ADDR
;
349 res
->end
= (resource_size_t
)OF_BAD_ADDR
;
352 #endif /* CONFIG_PCI */
355 * ISA bus specific translator
358 static int of_bus_isa_match(struct device_node
*np
)
360 return !strcmp(np
->name
, "isa");
363 static void of_bus_isa_count_cells(struct device_node
*child
,
364 int *addrc
, int *sizec
)
372 static u64
of_bus_isa_map(__be32
*addr
, const __be32
*range
, int na
, int ns
,
377 /* Check address type match */
378 if ((addr
[0] ^ range
[0]) & cpu_to_be32(1))
381 /* Read address values, skipping high cell */
382 cp
= of_read_number(range
+ 1, na
- 1);
383 s
= of_read_number(range
+ na
+ pna
, ns
);
384 da
= of_read_number(addr
+ 1, na
- 1);
386 pr_debug("ISA map, cp=%llx, s=%llx, da=%llx\n",
387 (unsigned long long)cp
, (unsigned long long)s
,
388 (unsigned long long)da
);
390 if (da
< cp
|| da
>= (cp
+ s
))
395 static int of_bus_isa_translate(__be32
*addr
, u64 offset
, int na
)
397 return of_bus_default_translate(addr
+ 1, offset
, na
- 1);
400 static unsigned int of_bus_isa_get_flags(const __be32
*addr
)
402 unsigned int flags
= 0;
403 u32 w
= be32_to_cpup(addr
);
406 flags
|= IORESOURCE_IO
;
408 flags
|= IORESOURCE_MEM
;
413 * Array of bus specific translators
416 static struct of_bus of_busses
[] = {
417 #ifdef CONFIG_OF_ADDRESS_PCI
421 .addresses
= "assigned-addresses",
422 .match
= of_bus_pci_match
,
423 .count_cells
= of_bus_pci_count_cells
,
424 .map
= of_bus_pci_map
,
425 .translate
= of_bus_pci_translate
,
426 .get_flags
= of_bus_pci_get_flags
,
428 #endif /* CONFIG_OF_ADDRESS_PCI */
433 .match
= of_bus_isa_match
,
434 .count_cells
= of_bus_isa_count_cells
,
435 .map
= of_bus_isa_map
,
436 .translate
= of_bus_isa_translate
,
437 .get_flags
= of_bus_isa_get_flags
,
444 .count_cells
= of_bus_default_count_cells
,
445 .map
= of_bus_default_map
,
446 .translate
= of_bus_default_translate
,
447 .get_flags
= of_bus_default_get_flags
,
451 static struct of_bus
*of_match_bus(struct device_node
*np
)
455 for (i
= 0; i
< ARRAY_SIZE(of_busses
); i
++)
456 if (!of_busses
[i
].match
|| of_busses
[i
].match(np
))
457 return &of_busses
[i
];
462 static int of_empty_ranges_quirk(struct device_node
*np
)
464 if (IS_ENABLED(CONFIG_PPC
)) {
465 /* To save cycles, we cache the result for global "Mac" setting */
466 static int quirk_state
= -1;
468 /* PA-SEMI sdc DT bug */
469 if (of_device_is_compatible(np
, "1682m-sdc"))
472 /* Make quirk cached */
475 of_machine_is_compatible("Power Macintosh") ||
476 of_machine_is_compatible("MacRISC");
482 static int of_translate_one(struct device_node
*parent
, struct of_bus
*bus
,
483 struct of_bus
*pbus
, __be32
*addr
,
484 int na
, int ns
, int pna
, const char *rprop
)
486 const __be32
*ranges
;
489 u64 offset
= OF_BAD_ADDR
;
492 * Normally, an absence of a "ranges" property means we are
493 * crossing a non-translatable boundary, and thus the addresses
494 * below the current cannot be converted to CPU physical ones.
495 * Unfortunately, while this is very clear in the spec, it's not
496 * what Apple understood, and they do have things like /uni-n or
497 * /ht nodes with no "ranges" property and a lot of perfectly
498 * useable mapped devices below them. Thus we treat the absence of
499 * "ranges" as equivalent to an empty "ranges" property which means
500 * a 1:1 translation at that level. It's up to the caller not to try
501 * to translate addresses that aren't supposed to be translated in
502 * the first place. --BenH.
504 * As far as we know, this damage only exists on Apple machines, so
505 * This code is only enabled on powerpc. --gcl
507 ranges
= of_get_property(parent
, rprop
, &rlen
);
508 if (ranges
== NULL
&& !of_empty_ranges_quirk(parent
)) {
509 pr_debug("no ranges; cannot translate\n");
512 if (ranges
== NULL
|| rlen
== 0) {
513 offset
= of_read_number(addr
, na
);
514 memset(addr
, 0, pna
* 4);
515 pr_debug("empty ranges; 1:1 translation\n");
519 pr_debug("walking ranges...\n");
521 /* Now walk through the ranges */
523 rone
= na
+ pna
+ ns
;
524 for (; rlen
>= rone
; rlen
-= rone
, ranges
+= rone
) {
525 offset
= bus
->map(addr
, ranges
, na
, ns
, pna
);
526 if (offset
!= OF_BAD_ADDR
)
529 if (offset
== OF_BAD_ADDR
) {
530 pr_debug("not found !\n");
533 memcpy(addr
, ranges
+ na
, 4 * pna
);
536 of_dump_addr("parent translation for:", addr
, pna
);
537 pr_debug("with offset: %llx\n", (unsigned long long)offset
);
539 /* Translate it into parent bus space */
540 return pbus
->translate(addr
, offset
, pna
);
544 * Translate an address from the device-tree into a CPU physical address,
545 * this walks up the tree and applies the various bus mappings on the
548 * Note: We consider that crossing any level with #size-cells == 0 to mean
549 * that translation is impossible (that is we are not dealing with a value
550 * that can be mapped to a cpu physical address). This is not really specified
551 * that way, but this is traditionally the way IBM at least do things
553 static u64
__of_translate_address(struct device_node
*dev
,
554 const __be32
*in_addr
, const char *rprop
)
556 struct device_node
*parent
= NULL
;
557 struct of_bus
*bus
, *pbus
;
558 __be32 addr
[OF_MAX_ADDR_CELLS
];
559 int na
, ns
, pna
, pns
;
560 u64 result
= OF_BAD_ADDR
;
562 pr_debug("** translation for device %s **\n", of_node_full_name(dev
));
564 /* Increase refcount at current level */
567 /* Get parent & match bus type */
568 parent
= of_get_parent(dev
);
571 bus
= of_match_bus(parent
);
573 /* Count address cells & copy address locally */
574 bus
->count_cells(dev
, &na
, &ns
);
575 if (!OF_CHECK_COUNTS(na
, ns
)) {
576 pr_debug("Bad cell count for %s\n", of_node_full_name(dev
));
579 memcpy(addr
, in_addr
, na
* 4);
581 pr_debug("bus is %s (na=%d, ns=%d) on %s\n",
582 bus
->name
, na
, ns
, of_node_full_name(parent
));
583 of_dump_addr("translating address:", addr
, na
);
587 /* Switch to parent bus */
590 parent
= of_get_parent(dev
);
592 /* If root, we have finished */
593 if (parent
== NULL
) {
594 pr_debug("reached root node\n");
595 result
= of_read_number(addr
, na
);
599 /* Get new parent bus and counts */
600 pbus
= of_match_bus(parent
);
601 pbus
->count_cells(dev
, &pna
, &pns
);
602 if (!OF_CHECK_COUNTS(pna
, pns
)) {
603 pr_err("Bad cell count for %s\n",
604 of_node_full_name(dev
));
608 pr_debug("parent bus is %s (na=%d, ns=%d) on %s\n",
609 pbus
->name
, pna
, pns
, of_node_full_name(parent
));
611 /* Apply bus translation */
612 if (of_translate_one(dev
, bus
, pbus
, addr
, na
, ns
, pna
, rprop
))
615 /* Complete the move up one level */
620 of_dump_addr("one level translation:", addr
, na
);
629 u64
of_translate_address(struct device_node
*dev
, const __be32
*in_addr
)
631 return __of_translate_address(dev
, in_addr
, "ranges");
633 EXPORT_SYMBOL(of_translate_address
);
635 u64
of_translate_dma_address(struct device_node
*dev
, const __be32
*in_addr
)
637 return __of_translate_address(dev
, in_addr
, "dma-ranges");
639 EXPORT_SYMBOL(of_translate_dma_address
);
641 const __be32
*of_get_address(struct device_node
*dev
, int index
, u64
*size
,
646 struct device_node
*parent
;
648 int onesize
, i
, na
, ns
;
650 /* Get parent & match bus type */
651 parent
= of_get_parent(dev
);
654 bus
= of_match_bus(parent
);
655 bus
->count_cells(dev
, &na
, &ns
);
657 if (!OF_CHECK_ADDR_COUNT(na
))
660 /* Get "reg" or "assigned-addresses" property */
661 prop
= of_get_property(dev
, bus
->addresses
, &psize
);
667 for (i
= 0; psize
>= onesize
; psize
-= onesize
, prop
+= onesize
, i
++)
670 *size
= of_read_number(prop
+ na
, ns
);
672 *flags
= bus
->get_flags(prop
);
677 EXPORT_SYMBOL(of_get_address
);
679 static int __of_address_to_resource(struct device_node
*dev
,
680 const __be32
*addrp
, u64 size
, unsigned int flags
,
681 const char *name
, struct resource
*r
)
685 if ((flags
& (IORESOURCE_IO
| IORESOURCE_MEM
)) == 0)
687 taddr
= of_translate_address(dev
, addrp
);
688 if (taddr
== OF_BAD_ADDR
)
690 memset(r
, 0, sizeof(struct resource
));
691 if (flags
& IORESOURCE_IO
) {
693 port
= pci_address_to_pio(taddr
);
694 if (port
== (unsigned long)-1)
697 r
->end
= port
+ size
- 1;
700 r
->end
= taddr
+ size
- 1;
703 r
->name
= name
? name
: dev
->full_name
;
709 * of_address_to_resource - Translate device tree address and return as resource
711 * Note that if your address is a PIO address, the conversion will fail if
712 * the physical address can't be internally converted to an IO token with
713 * pci_address_to_pio(), that is because it's either called to early or it
714 * can't be matched to any host bridge IO space
716 int of_address_to_resource(struct device_node
*dev
, int index
,
722 const char *name
= NULL
;
724 addrp
= of_get_address(dev
, index
, &size
, &flags
);
728 /* Get optional "reg-names" property to add a name to a resource */
729 of_property_read_string_index(dev
, "reg-names", index
, &name
);
731 return __of_address_to_resource(dev
, addrp
, size
, flags
, name
, r
);
733 EXPORT_SYMBOL_GPL(of_address_to_resource
);
735 struct device_node
*of_find_matching_node_by_address(struct device_node
*from
,
736 const struct of_device_id
*matches
,
739 struct device_node
*dn
= of_find_matching_node(from
, matches
);
743 if (!of_address_to_resource(dn
, 0, &res
) &&
744 res
.start
== base_address
)
747 dn
= of_find_matching_node(dn
, matches
);
755 * of_iomap - Maps the memory mapped IO for a given device_node
756 * @device: the device whose io range will be mapped
757 * @index: index of the io range
759 * Returns a pointer to the mapped memory
761 void __iomem
*of_iomap(struct device_node
*np
, int index
)
765 if (of_address_to_resource(np
, index
, &res
))
768 return ioremap(res
.start
, resource_size(&res
));
770 EXPORT_SYMBOL(of_iomap
);
773 * of_io_request_and_map - Requests a resource and maps the memory mapped IO
774 * for a given device_node
775 * @device: the device whose io range will be mapped
776 * @index: index of the io range
777 * @name: name of the resource
779 * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
780 * error code on failure. Usage example:
782 * base = of_io_request_and_map(node, 0, "foo");
784 * return PTR_ERR(base);
786 void __iomem
*of_io_request_and_map(struct device_node
*np
, int index
,
792 if (of_address_to_resource(np
, index
, &res
))
793 return IOMEM_ERR_PTR(-EINVAL
);
795 if (!request_mem_region(res
.start
, resource_size(&res
), name
))
796 return IOMEM_ERR_PTR(-EBUSY
);
798 mem
= ioremap(res
.start
, resource_size(&res
));
800 release_mem_region(res
.start
, resource_size(&res
));
801 return IOMEM_ERR_PTR(-ENOMEM
);
806 EXPORT_SYMBOL(of_io_request_and_map
);
809 * of_dma_get_range - Get DMA range info
810 * @np: device node to get DMA range info
811 * @dma_addr: pointer to store initial DMA address of DMA range
812 * @paddr: pointer to store initial CPU address of DMA range
813 * @size: pointer to store size of DMA range
815 * Look in bottom up direction for the first "dma-ranges" property
818 * DMA addr (dma_addr) : naddr cells
819 * CPU addr (phys_addr_t) : pna cells
822 * It returns -ENODEV if "dma-ranges" property was not found
823 * for this device in DT.
825 int of_dma_get_range(struct device_node
*np
, u64
*dma_addr
, u64
*paddr
, u64
*size
)
827 struct device_node
*node
= of_node_get(np
);
828 const __be32
*ranges
= NULL
;
829 int len
, naddr
, nsize
, pna
;
837 naddr
= of_n_addr_cells(node
);
838 nsize
= of_n_size_cells(node
);
839 node
= of_get_next_parent(node
);
843 ranges
= of_get_property(node
, "dma-ranges", &len
);
845 /* Ignore empty ranges, they imply no translation required */
846 if (ranges
&& len
> 0)
850 * At least empty ranges has to be defined for parent node if
858 pr_debug("no dma-ranges found for node(%s)\n", np
->full_name
);
865 pna
= of_n_addr_cells(node
);
867 /* dma-ranges format:
868 * DMA addr : naddr cells
869 * CPU addr : pna cells
872 dmaaddr
= of_read_number(ranges
, naddr
);
873 *paddr
= of_translate_dma_address(np
, ranges
);
874 if (*paddr
== OF_BAD_ADDR
) {
875 pr_err("translation of DMA address(%pad) to CPU address failed node(%s)\n",
876 dma_addr
, np
->full_name
);
882 *size
= of_read_number(ranges
+ naddr
+ pna
, nsize
);
884 pr_debug("dma_addr(%llx) cpu_addr(%llx) size(%llx)\n",
885 *dma_addr
, *paddr
, *size
);
892 EXPORT_SYMBOL_GPL(of_dma_get_range
);
895 * of_dma_is_coherent - Check if device is coherent
898 * It returns true if "dma-coherent" property was found
899 * for this device in DT.
901 bool of_dma_is_coherent(struct device_node
*np
)
903 struct device_node
*node
= of_node_get(np
);
906 if (of_property_read_bool(node
, "dma-coherent")) {
910 node
= of_get_next_parent(node
);
915 EXPORT_SYMBOL_GPL(of_dma_is_coherent
);