Loading...
1// SPDX-License-Identifier: GPL-2.0
2#define pr_fmt(fmt) "OF: " fmt
3
4#include <linux/device.h>
5#include <linux/fwnode.h>
6#include <linux/io.h>
7#include <linux/ioport.h>
8#include <linux/logic_pio.h>
9#include <linux/module.h>
10#include <linux/of_address.h>
11#include <linux/overflow.h>
12#include <linux/pci.h>
13#include <linux/pci_regs.h>
14#include <linux/sizes.h>
15#include <linux/slab.h>
16#include <linux/string.h>
17#include <linux/dma-direct.h> /* for bus_dma_region */
18
19#include "of_private.h"
20
21/* Max address size we deal with */
22#define OF_MAX_ADDR_CELLS 4
23#define OF_CHECK_ADDR_COUNT(na) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS)
24#define OF_CHECK_COUNTS(na, ns) (OF_CHECK_ADDR_COUNT(na) && (ns) > 0)
25
26/* Debug utility */
27#ifdef DEBUG
28static void of_dump_addr(const char *s, const __be32 *addr, int na)
29{
30 pr_debug("%s", s);
31 while (na--)
32 pr_cont(" %08x", be32_to_cpu(*(addr++)));
33 pr_cont("\n");
34}
35#else
36static void of_dump_addr(const char *s, const __be32 *addr, int na) { }
37#endif
38
39/* Callbacks for bus specific translators */
40struct of_bus {
41 const char *name;
42 const char *addresses;
43 int (*match)(struct device_node *parent);
44 void (*count_cells)(struct device_node *child,
45 int *addrc, int *sizec);
46 u64 (*map)(__be32 *addr, const __be32 *range,
47 int na, int ns, int pna, int fna);
48 int (*translate)(__be32 *addr, u64 offset, int na);
49 int flag_cells;
50 unsigned int (*get_flags)(const __be32 *addr);
51};
52
53/*
54 * Default translator (generic bus)
55 */
56
57static void of_bus_default_count_cells(struct device_node *dev,
58 int *addrc, int *sizec)
59{
60 if (addrc)
61 *addrc = of_n_addr_cells(dev);
62 if (sizec)
63 *sizec = of_n_size_cells(dev);
64}
65
66static u64 of_bus_default_map(__be32 *addr, const __be32 *range,
67 int na, int ns, int pna, int fna)
68{
69 u64 cp, s, da;
70
71 cp = of_read_number(range + fna, na - fna);
72 s = of_read_number(range + na + pna, ns);
73 da = of_read_number(addr + fna, na - fna);
74
75 pr_debug("default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
76
77 if (da < cp || da >= (cp + s))
78 return OF_BAD_ADDR;
79 return da - cp;
80}
81
82static int of_bus_default_translate(__be32 *addr, u64 offset, int na)
83{
84 u64 a = of_read_number(addr, na);
85 memset(addr, 0, na * 4);
86 a += offset;
87 if (na > 1)
88 addr[na - 2] = cpu_to_be32(a >> 32);
89 addr[na - 1] = cpu_to_be32(a & 0xffffffffu);
90
91 return 0;
92}
93
94static unsigned int of_bus_default_flags_get_flags(const __be32 *addr)
95{
96 return of_read_number(addr, 1);
97}
98
99static unsigned int of_bus_default_get_flags(const __be32 *addr)
100{
101 return IORESOURCE_MEM;
102}
103
104static u64 of_bus_default_flags_map(__be32 *addr, const __be32 *range, int na,
105 int ns, int pna, int fna)
106{
107 /* Check that flags match */
108 if (*addr != *range)
109 return OF_BAD_ADDR;
110
111 return of_bus_default_map(addr, range, na, ns, pna, fna);
112}
113
114static int of_bus_default_flags_translate(__be32 *addr, u64 offset, int na)
115{
116 /* Keep "flags" part (high cell) in translated address */
117 return of_bus_default_translate(addr + 1, offset, na - 1);
118}
119
120#ifdef CONFIG_PCI
121static unsigned int of_bus_pci_get_flags(const __be32 *addr)
122{
123 unsigned int flags = 0;
124 u32 w = be32_to_cpup(addr);
125
126 if (!IS_ENABLED(CONFIG_PCI))
127 return 0;
128
129 switch((w >> 24) & 0x03) {
130 case 0x01:
131 flags |= IORESOURCE_IO;
132 break;
133 case 0x02: /* 32 bits */
134 flags |= IORESOURCE_MEM;
135 break;
136
137 case 0x03: /* 64 bits */
138 flags |= IORESOURCE_MEM | IORESOURCE_MEM_64;
139 break;
140 }
141 if (w & 0x40000000)
142 flags |= IORESOURCE_PREFETCH;
143 return flags;
144}
145
146/*
147 * PCI bus specific translator
148 */
149
150static bool of_node_is_pcie(const struct device_node *np)
151{
152 bool is_pcie = of_node_name_eq(np, "pcie");
153
154 if (is_pcie)
155 pr_warn_once("%pOF: Missing device_type\n", np);
156
157 return is_pcie;
158}
159
160static int of_bus_pci_match(struct device_node *np)
161{
162 /*
163 * "pciex" is PCI Express
164 * "vci" is for the /chaos bridge on 1st-gen PCI powermacs
165 * "ht" is hypertransport
166 *
167 * If none of the device_type match, and that the node name is
168 * "pcie", accept the device as PCI (with a warning).
169 */
170 return of_node_is_type(np, "pci") || of_node_is_type(np, "pciex") ||
171 of_node_is_type(np, "vci") || of_node_is_type(np, "ht") ||
172 of_node_is_pcie(np);
173}
174
175static void of_bus_pci_count_cells(struct device_node *np,
176 int *addrc, int *sizec)
177{
178 if (addrc)
179 *addrc = 3;
180 if (sizec)
181 *sizec = 2;
182}
183
184static u64 of_bus_pci_map(__be32 *addr, const __be32 *range, int na, int ns,
185 int pna, int fna)
186{
187 unsigned int af, rf;
188
189 af = of_bus_pci_get_flags(addr);
190 rf = of_bus_pci_get_flags(range);
191
192 /* Check address type match */
193 if ((af ^ rf) & (IORESOURCE_MEM | IORESOURCE_IO))
194 return OF_BAD_ADDR;
195
196 return of_bus_default_map(addr, range, na, ns, pna, fna);
197}
198
199#endif /* CONFIG_PCI */
200
201static int __of_address_resource_bounds(struct resource *r, u64 start, u64 size)
202{
203 if (overflows_type(start, r->start))
204 return -EOVERFLOW;
205
206 r->start = start;
207
208 if (!size)
209 r->end = wrapping_sub(typeof(r->end), r->start, 1);
210 else if (size && check_add_overflow(r->start, size - 1, &r->end))
211 return -EOVERFLOW;
212
213 return 0;
214}
215
216/*
217 * of_pci_range_to_resource - Create a resource from an of_pci_range
218 * @range: the PCI range that describes the resource
219 * @np: device node where the range belongs to
220 * @res: pointer to a valid resource that will be updated to
221 * reflect the values contained in the range.
222 *
223 * Returns -EINVAL if the range cannot be converted to resource.
224 *
225 * Note that if the range is an IO range, the resource will be converted
226 * using pci_address_to_pio() which can fail if it is called too early or
227 * if the range cannot be matched to any host bridge IO space (our case here).
228 * To guard against that we try to register the IO range first.
229 * If that fails we know that pci_address_to_pio() will do too.
230 */
231int of_pci_range_to_resource(const struct of_pci_range *range,
232 const struct device_node *np, struct resource *res)
233{
234 u64 start;
235 int err;
236 res->flags = range->flags;
237 res->parent = res->child = res->sibling = NULL;
238 res->name = np->full_name;
239
240 if (res->flags & IORESOURCE_IO) {
241 unsigned long port;
242 err = pci_register_io_range(&np->fwnode, range->cpu_addr,
243 range->size);
244 if (err)
245 goto invalid_range;
246 port = pci_address_to_pio(range->cpu_addr);
247 if (port == (unsigned long)-1) {
248 err = -EINVAL;
249 goto invalid_range;
250 }
251 start = port;
252 } else {
253 start = range->cpu_addr;
254 }
255 return __of_address_resource_bounds(res, start, range->size);
256
257invalid_range:
258 res->start = (resource_size_t)OF_BAD_ADDR;
259 res->end = (resource_size_t)OF_BAD_ADDR;
260 return err;
261}
262EXPORT_SYMBOL(of_pci_range_to_resource);
263
264/*
265 * of_range_to_resource - Create a resource from a ranges entry
266 * @np: device node where the range belongs to
267 * @index: the 'ranges' index to convert to a resource
268 * @res: pointer to a valid resource that will be updated to
269 * reflect the values contained in the range.
270 *
271 * Returns -ENOENT if the entry is not found or -EOVERFLOW if the range
272 * cannot be converted to resource.
273 */
274int of_range_to_resource(struct device_node *np, int index, struct resource *res)
275{
276 int ret, i = 0;
277 struct of_range_parser parser;
278 struct of_range range;
279
280 ret = of_range_parser_init(&parser, np);
281 if (ret)
282 return ret;
283
284 for_each_of_range(&parser, &range)
285 if (i++ == index)
286 return of_pci_range_to_resource(&range, np, res);
287
288 return -ENOENT;
289}
290EXPORT_SYMBOL(of_range_to_resource);
291
292/*
293 * ISA bus specific translator
294 */
295
296static int of_bus_isa_match(struct device_node *np)
297{
298 return of_node_name_eq(np, "isa");
299}
300
301static void of_bus_isa_count_cells(struct device_node *child,
302 int *addrc, int *sizec)
303{
304 if (addrc)
305 *addrc = 2;
306 if (sizec)
307 *sizec = 1;
308}
309
310static u64 of_bus_isa_map(__be32 *addr, const __be32 *range, int na, int ns,
311 int pna, int fna)
312{
313 /* Check address type match */
314 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
315 return OF_BAD_ADDR;
316
317 return of_bus_default_map(addr, range, na, ns, pna, fna);
318}
319
320static unsigned int of_bus_isa_get_flags(const __be32 *addr)
321{
322 unsigned int flags = 0;
323 u32 w = be32_to_cpup(addr);
324
325 if (w & 1)
326 flags |= IORESOURCE_IO;
327 else
328 flags |= IORESOURCE_MEM;
329 return flags;
330}
331
332static int of_bus_default_flags_match(struct device_node *np)
333{
334 /*
335 * Check for presence first since of_bus_n_addr_cells() will warn when
336 * walking parent nodes.
337 */
338 return of_property_present(np, "#address-cells") && (of_bus_n_addr_cells(np) == 3);
339}
340
341static int of_bus_default_match(struct device_node *np)
342{
343 /*
344 * Check for presence first since of_bus_n_addr_cells() will warn when
345 * walking parent nodes.
346 */
347 return of_property_present(np, "#address-cells");
348}
349
350/*
351 * Array of bus specific translators
352 */
353
354static const struct of_bus of_busses[] = {
355#ifdef CONFIG_PCI
356 /* PCI */
357 {
358 .name = "pci",
359 .addresses = "assigned-addresses",
360 .match = of_bus_pci_match,
361 .count_cells = of_bus_pci_count_cells,
362 .map = of_bus_pci_map,
363 .translate = of_bus_default_flags_translate,
364 .flag_cells = 1,
365 .get_flags = of_bus_pci_get_flags,
366 },
367#endif /* CONFIG_PCI */
368 /* ISA */
369 {
370 .name = "isa",
371 .addresses = "reg",
372 .match = of_bus_isa_match,
373 .count_cells = of_bus_isa_count_cells,
374 .map = of_bus_isa_map,
375 .translate = of_bus_default_flags_translate,
376 .flag_cells = 1,
377 .get_flags = of_bus_isa_get_flags,
378 },
379 /* Default with flags cell */
380 {
381 .name = "default-flags",
382 .addresses = "reg",
383 .match = of_bus_default_flags_match,
384 .count_cells = of_bus_default_count_cells,
385 .map = of_bus_default_flags_map,
386 .translate = of_bus_default_flags_translate,
387 .flag_cells = 1,
388 .get_flags = of_bus_default_flags_get_flags,
389 },
390 /* Default */
391 {
392 .name = "default",
393 .addresses = "reg",
394 .match = of_bus_default_match,
395 .count_cells = of_bus_default_count_cells,
396 .map = of_bus_default_map,
397 .translate = of_bus_default_translate,
398 .get_flags = of_bus_default_get_flags,
399 },
400};
401
402static const struct of_bus *of_match_bus(struct device_node *np)
403{
404 int i;
405
406 for (i = 0; i < ARRAY_SIZE(of_busses); i++)
407 if (!of_busses[i].match || of_busses[i].match(np))
408 return &of_busses[i];
409 return NULL;
410}
411
412static int of_empty_ranges_quirk(const struct device_node *np)
413{
414 if (IS_ENABLED(CONFIG_PPC)) {
415 /* To save cycles, we cache the result for global "Mac" setting */
416 static int quirk_state = -1;
417
418 /* PA-SEMI sdc DT bug */
419 if (of_device_is_compatible(np, "1682m-sdc"))
420 return true;
421
422 /* Make quirk cached */
423 if (quirk_state < 0)
424 quirk_state =
425 of_machine_is_compatible("Power Macintosh") ||
426 of_machine_is_compatible("MacRISC");
427 return quirk_state;
428 }
429 return false;
430}
431
432static int of_translate_one(const struct device_node *parent, const struct of_bus *bus,
433 const struct of_bus *pbus, __be32 *addr,
434 int na, int ns, int pna, const char *rprop)
435{
436 const __be32 *ranges;
437 unsigned int rlen;
438 int rone;
439 u64 offset = OF_BAD_ADDR;
440
441 /*
442 * Normally, an absence of a "ranges" property means we are
443 * crossing a non-translatable boundary, and thus the addresses
444 * below the current cannot be converted to CPU physical ones.
445 * Unfortunately, while this is very clear in the spec, it's not
446 * what Apple understood, and they do have things like /uni-n or
447 * /ht nodes with no "ranges" property and a lot of perfectly
448 * useable mapped devices below them. Thus we treat the absence of
449 * "ranges" as equivalent to an empty "ranges" property which means
450 * a 1:1 translation at that level. It's up to the caller not to try
451 * to translate addresses that aren't supposed to be translated in
452 * the first place. --BenH.
453 *
454 * As far as we know, this damage only exists on Apple machines, so
455 * This code is only enabled on powerpc. --gcl
456 *
457 * This quirk also applies for 'dma-ranges' which frequently exist in
458 * child nodes without 'dma-ranges' in the parent nodes. --RobH
459 */
460 ranges = of_get_property(parent, rprop, &rlen);
461 if (ranges == NULL && !of_empty_ranges_quirk(parent) &&
462 strcmp(rprop, "dma-ranges")) {
463 pr_debug("no ranges; cannot translate\n");
464 return 1;
465 }
466 if (ranges == NULL || rlen == 0) {
467 offset = of_read_number(addr, na);
468 /* set address to zero, pass flags through */
469 memset(addr + pbus->flag_cells, 0, (pna - pbus->flag_cells) * 4);
470 pr_debug("empty ranges; 1:1 translation\n");
471 goto finish;
472 }
473
474 pr_debug("walking ranges...\n");
475
476 /* Now walk through the ranges */
477 rlen /= 4;
478 rone = na + pna + ns;
479 for (; rlen >= rone; rlen -= rone, ranges += rone) {
480 offset = bus->map(addr, ranges, na, ns, pna, bus->flag_cells);
481 if (offset != OF_BAD_ADDR)
482 break;
483 }
484 if (offset == OF_BAD_ADDR) {
485 pr_debug("not found !\n");
486 return 1;
487 }
488 memcpy(addr, ranges + na, 4 * pna);
489
490 finish:
491 of_dump_addr("parent translation for:", addr, pna);
492 pr_debug("with offset: %llx\n", offset);
493
494 /* Translate it into parent bus space */
495 return pbus->translate(addr, offset, pna);
496}
497
498/*
499 * Translate an address from the device-tree into a CPU physical address,
500 * this walks up the tree and applies the various bus mappings on the
501 * way.
502 *
503 * Note: We consider that crossing any level with #size-cells == 0 to mean
504 * that translation is impossible (that is we are not dealing with a value
505 * that can be mapped to a cpu physical address). This is not really specified
506 * that way, but this is traditionally the way IBM at least do things
507 *
508 * Whenever the translation fails, the *host pointer will be set to the
509 * device that had registered logical PIO mapping, and the return code is
510 * relative to that node.
511 */
512static u64 __of_translate_address(struct device_node *node,
513 struct device_node *(*get_parent)(const struct device_node *),
514 const __be32 *in_addr, const char *rprop,
515 struct device_node **host)
516{
517 struct device_node *dev __free(device_node) = of_node_get(node);
518 struct device_node *parent __free(device_node) = get_parent(dev);
519 const struct of_bus *bus, *pbus;
520 __be32 addr[OF_MAX_ADDR_CELLS];
521 int na, ns, pna, pns;
522
523 pr_debug("** translation for device %pOF **\n", dev);
524
525 *host = NULL;
526
527 if (parent == NULL)
528 return OF_BAD_ADDR;
529 bus = of_match_bus(parent);
530 if (!bus)
531 return OF_BAD_ADDR;
532
533 /* Count address cells & copy address locally */
534 bus->count_cells(dev, &na, &ns);
535 if (!OF_CHECK_COUNTS(na, ns)) {
536 pr_debug("Bad cell count for %pOF\n", dev);
537 return OF_BAD_ADDR;
538 }
539 memcpy(addr, in_addr, na * 4);
540
541 pr_debug("bus is %s (na=%d, ns=%d) on %pOF\n",
542 bus->name, na, ns, parent);
543 of_dump_addr("translating address:", addr, na);
544
545 /* Translate */
546 for (;;) {
547 struct logic_pio_hwaddr *iorange;
548
549 /* Switch to parent bus */
550 of_node_put(dev);
551 dev = parent;
552 parent = get_parent(dev);
553
554 /* If root, we have finished */
555 if (parent == NULL) {
556 pr_debug("reached root node\n");
557 return of_read_number(addr, na);
558 }
559
560 /*
561 * For indirectIO device which has no ranges property, get
562 * the address from reg directly.
563 */
564 iorange = find_io_range_by_fwnode(&dev->fwnode);
565 if (iorange && (iorange->flags != LOGIC_PIO_CPU_MMIO)) {
566 u64 result = of_read_number(addr + 1, na - 1);
567 pr_debug("indirectIO matched(%pOF) 0x%llx\n",
568 dev, result);
569 *host = no_free_ptr(dev);
570 return result;
571 }
572
573 /* Get new parent bus and counts */
574 pbus = of_match_bus(parent);
575 if (!pbus)
576 return OF_BAD_ADDR;
577 pbus->count_cells(dev, &pna, &pns);
578 if (!OF_CHECK_COUNTS(pna, pns)) {
579 pr_err("Bad cell count for %pOF\n", dev);
580 return OF_BAD_ADDR;
581 }
582
583 pr_debug("parent bus is %s (na=%d, ns=%d) on %pOF\n",
584 pbus->name, pna, pns, parent);
585
586 /* Apply bus translation */
587 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
588 return OF_BAD_ADDR;
589
590 /* Complete the move up one level */
591 na = pna;
592 ns = pns;
593 bus = pbus;
594
595 of_dump_addr("one level translation:", addr, na);
596 }
597
598 unreachable();
599}
600
601u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
602{
603 struct device_node *host;
604 u64 ret;
605
606 ret = __of_translate_address(dev, of_get_parent,
607 in_addr, "ranges", &host);
608 if (host) {
609 of_node_put(host);
610 return OF_BAD_ADDR;
611 }
612
613 return ret;
614}
615EXPORT_SYMBOL(of_translate_address);
616
617#ifdef CONFIG_HAS_DMA
618struct device_node *__of_get_dma_parent(const struct device_node *np)
619{
620 struct of_phandle_args args;
621 int ret, index;
622
623 index = of_property_match_string(np, "interconnect-names", "dma-mem");
624 if (index < 0)
625 return of_get_parent(np);
626
627 ret = of_parse_phandle_with_args(np, "interconnects",
628 "#interconnect-cells",
629 index, &args);
630 if (ret < 0)
631 return of_get_parent(np);
632
633 return args.np;
634}
635#endif
636
637static struct device_node *of_get_next_dma_parent(struct device_node *np)
638{
639 struct device_node *parent;
640
641 parent = __of_get_dma_parent(np);
642 of_node_put(np);
643
644 return parent;
645}
646
647u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
648{
649 struct device_node *host;
650 u64 ret;
651
652 ret = __of_translate_address(dev, __of_get_dma_parent,
653 in_addr, "dma-ranges", &host);
654
655 if (host) {
656 of_node_put(host);
657 return OF_BAD_ADDR;
658 }
659
660 return ret;
661}
662EXPORT_SYMBOL(of_translate_dma_address);
663
664/**
665 * of_translate_dma_region - Translate device tree address and size tuple
666 * @dev: device tree node for which to translate
667 * @prop: pointer into array of cells
668 * @start: return value for the start of the DMA range
669 * @length: return value for the length of the DMA range
670 *
671 * Returns a pointer to the cell immediately following the translated DMA region.
672 */
673const __be32 *of_translate_dma_region(struct device_node *dev, const __be32 *prop,
674 phys_addr_t *start, size_t *length)
675{
676 struct device_node *parent __free(device_node) = __of_get_dma_parent(dev);
677 u64 address, size;
678 int na, ns;
679
680 if (!parent)
681 return NULL;
682
683 na = of_bus_n_addr_cells(parent);
684 ns = of_bus_n_size_cells(parent);
685
686 address = of_translate_dma_address(dev, prop);
687 if (address == OF_BAD_ADDR)
688 return NULL;
689
690 size = of_read_number(prop + na, ns);
691
692 if (start)
693 *start = address;
694
695 if (length)
696 *length = size;
697
698 return prop + na + ns;
699}
700EXPORT_SYMBOL(of_translate_dma_region);
701
702const __be32 *__of_get_address(struct device_node *dev, int index, int bar_no,
703 u64 *size, unsigned int *flags)
704{
705 const __be32 *prop;
706 unsigned int psize;
707 struct device_node *parent __free(device_node) = of_get_parent(dev);
708 const struct of_bus *bus;
709 int onesize, i, na, ns;
710
711 if (parent == NULL)
712 return NULL;
713
714 /* match the parent's bus type */
715 bus = of_match_bus(parent);
716 if (!bus || (strcmp(bus->name, "pci") && (bar_no >= 0)))
717 return NULL;
718
719 /* Get "reg" or "assigned-addresses" property */
720 prop = of_get_property(dev, bus->addresses, &psize);
721 if (prop == NULL)
722 return NULL;
723 psize /= 4;
724
725 bus->count_cells(dev, &na, &ns);
726 if (!OF_CHECK_ADDR_COUNT(na))
727 return NULL;
728
729 onesize = na + ns;
730 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++) {
731 u32 val = be32_to_cpu(prop[0]);
732 /* PCI bus matches on BAR number instead of index */
733 if (((bar_no >= 0) && ((val & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0))) ||
734 ((index >= 0) && (i == index))) {
735 if (size)
736 *size = of_read_number(prop + na, ns);
737 if (flags)
738 *flags = bus->get_flags(prop);
739 return prop;
740 }
741 }
742 return NULL;
743}
744EXPORT_SYMBOL(__of_get_address);
745
746/**
747 * of_property_read_reg - Retrieve the specified "reg" entry index without translating
748 * @np: device tree node for which to retrieve "reg" from
749 * @idx: "reg" entry index to read
750 * @addr: return value for the untranslated address
751 * @size: return value for the entry size
752 *
753 * Returns -EINVAL if "reg" is not found. Returns 0 on success with addr and
754 * size values filled in.
755 */
756int of_property_read_reg(struct device_node *np, int idx, u64 *addr, u64 *size)
757{
758 const __be32 *prop = of_get_address(np, idx, size, NULL);
759
760 if (!prop)
761 return -EINVAL;
762
763 *addr = of_read_number(prop, of_n_addr_cells(np));
764
765 return 0;
766}
767EXPORT_SYMBOL(of_property_read_reg);
768
769static int parser_init(struct of_pci_range_parser *parser,
770 struct device_node *node, const char *name)
771{
772 int rlen;
773
774 parser->node = node;
775 parser->pna = of_n_addr_cells(node);
776 parser->na = of_bus_n_addr_cells(node);
777 parser->ns = of_bus_n_size_cells(node);
778 parser->dma = !strcmp(name, "dma-ranges");
779 parser->bus = of_match_bus(node);
780
781 parser->range = of_get_property(node, name, &rlen);
782 if (parser->range == NULL)
783 return -ENOENT;
784
785 parser->end = parser->range + rlen / sizeof(__be32);
786
787 return 0;
788}
789
790int of_pci_range_parser_init(struct of_pci_range_parser *parser,
791 struct device_node *node)
792{
793 return parser_init(parser, node, "ranges");
794}
795EXPORT_SYMBOL_GPL(of_pci_range_parser_init);
796
797int of_pci_dma_range_parser_init(struct of_pci_range_parser *parser,
798 struct device_node *node)
799{
800 return parser_init(parser, node, "dma-ranges");
801}
802EXPORT_SYMBOL_GPL(of_pci_dma_range_parser_init);
803#define of_dma_range_parser_init of_pci_dma_range_parser_init
804
805struct of_pci_range *of_pci_range_parser_one(struct of_pci_range_parser *parser,
806 struct of_pci_range *range)
807{
808 int na = parser->na;
809 int ns = parser->ns;
810 int np = parser->pna + na + ns;
811 int busflag_na = parser->bus->flag_cells;
812
813 if (!range)
814 return NULL;
815
816 if (!parser->range || parser->range + np > parser->end)
817 return NULL;
818
819 range->flags = parser->bus->get_flags(parser->range);
820
821 range->bus_addr = of_read_number(parser->range + busflag_na, na - busflag_na);
822
823 if (parser->dma)
824 range->cpu_addr = of_translate_dma_address(parser->node,
825 parser->range + na);
826 else
827 range->cpu_addr = of_translate_address(parser->node,
828 parser->range + na);
829 range->size = of_read_number(parser->range + parser->pna + na, ns);
830
831 parser->range += np;
832
833 /* Now consume following elements while they are contiguous */
834 while (parser->range + np <= parser->end) {
835 u32 flags = 0;
836 u64 bus_addr, cpu_addr, size;
837
838 flags = parser->bus->get_flags(parser->range);
839 bus_addr = of_read_number(parser->range + busflag_na, na - busflag_na);
840 if (parser->dma)
841 cpu_addr = of_translate_dma_address(parser->node,
842 parser->range + na);
843 else
844 cpu_addr = of_translate_address(parser->node,
845 parser->range + na);
846 size = of_read_number(parser->range + parser->pna + na, ns);
847
848 if (flags != range->flags)
849 break;
850 if (bus_addr != range->bus_addr + range->size ||
851 cpu_addr != range->cpu_addr + range->size)
852 break;
853
854 range->size += size;
855 parser->range += np;
856 }
857
858 return range;
859}
860EXPORT_SYMBOL_GPL(of_pci_range_parser_one);
861
862static u64 of_translate_ioport(struct device_node *dev, const __be32 *in_addr,
863 u64 size)
864{
865 u64 taddr;
866 unsigned long port;
867 struct device_node *host;
868
869 taddr = __of_translate_address(dev, of_get_parent,
870 in_addr, "ranges", &host);
871 if (host) {
872 /* host-specific port access */
873 port = logic_pio_trans_hwaddr(&host->fwnode, taddr, size);
874 of_node_put(host);
875 } else {
876 /* memory-mapped I/O range */
877 port = pci_address_to_pio(taddr);
878 }
879
880 if (port == (unsigned long)-1)
881 return OF_BAD_ADDR;
882
883 return port;
884}
885
886#ifdef CONFIG_HAS_DMA
887/**
888 * of_dma_get_range - Get DMA range info and put it into a map array
889 * @np: device node to get DMA range info
890 * @map: dma range structure to return
891 *
892 * Look in bottom up direction for the first "dma-ranges" property
893 * and parse it. Put the information into a DMA offset map array.
894 *
895 * dma-ranges format:
896 * DMA addr (dma_addr) : naddr cells
897 * CPU addr (phys_addr_t) : pna cells
898 * size : nsize cells
899 *
900 * It returns -ENODEV if "dma-ranges" property was not found for this
901 * device in the DT.
902 */
903int of_dma_get_range(struct device_node *np, const struct bus_dma_region **map)
904{
905 struct device_node *node __free(device_node) = of_node_get(np);
906 const __be32 *ranges = NULL;
907 bool found_dma_ranges = false;
908 struct of_range_parser parser;
909 struct of_range range;
910 struct bus_dma_region *r;
911 int len, num_ranges = 0;
912
913 while (node) {
914 ranges = of_get_property(node, "dma-ranges", &len);
915
916 /* Ignore empty ranges, they imply no translation required */
917 if (ranges && len > 0)
918 break;
919
920 /* Once we find 'dma-ranges', then a missing one is an error */
921 if (found_dma_ranges && !ranges)
922 return -ENODEV;
923
924 found_dma_ranges = true;
925
926 node = of_get_next_dma_parent(node);
927 }
928
929 if (!node || !ranges) {
930 pr_debug("no dma-ranges found for node(%pOF)\n", np);
931 return -ENODEV;
932 }
933 of_dma_range_parser_init(&parser, node);
934 for_each_of_range(&parser, &range) {
935 if (range.cpu_addr == OF_BAD_ADDR) {
936 pr_err("translation of DMA address(%llx) to CPU address failed node(%pOF)\n",
937 range.bus_addr, node);
938 continue;
939 }
940 num_ranges++;
941 }
942
943 if (!num_ranges)
944 return -EINVAL;
945
946 r = kcalloc(num_ranges + 1, sizeof(*r), GFP_KERNEL);
947 if (!r)
948 return -ENOMEM;
949
950 /*
951 * Record all info in the generic DMA ranges array for struct device,
952 * returning an error if we don't find any parsable ranges.
953 */
954 *map = r;
955 of_dma_range_parser_init(&parser, node);
956 for_each_of_range(&parser, &range) {
957 pr_debug("dma_addr(%llx) cpu_addr(%llx) size(%llx)\n",
958 range.bus_addr, range.cpu_addr, range.size);
959 if (range.cpu_addr == OF_BAD_ADDR)
960 continue;
961 r->cpu_start = range.cpu_addr;
962 r->dma_start = range.bus_addr;
963 r->size = range.size;
964 r++;
965 }
966 return 0;
967}
968#endif /* CONFIG_HAS_DMA */
969
970/**
971 * of_dma_get_max_cpu_address - Gets highest CPU address suitable for DMA
972 * @np: The node to start searching from or NULL to start from the root
973 *
974 * Gets the highest CPU physical address that is addressable by all DMA masters
975 * in the sub-tree pointed by np, or the whole tree if NULL is passed. If no
976 * DMA constrained device is found, it returns PHYS_ADDR_MAX.
977 */
978phys_addr_t __init of_dma_get_max_cpu_address(struct device_node *np)
979{
980 phys_addr_t max_cpu_addr = PHYS_ADDR_MAX;
981 struct of_range_parser parser;
982 phys_addr_t subtree_max_addr;
983 struct device_node *child;
984 struct of_range range;
985 const __be32 *ranges;
986 u64 cpu_end = 0;
987 int len;
988
989 if (!np)
990 np = of_root;
991
992 ranges = of_get_property(np, "dma-ranges", &len);
993 if (ranges && len) {
994 of_dma_range_parser_init(&parser, np);
995 for_each_of_range(&parser, &range)
996 if (range.cpu_addr + range.size > cpu_end)
997 cpu_end = range.cpu_addr + range.size - 1;
998
999 if (max_cpu_addr > cpu_end)
1000 max_cpu_addr = cpu_end;
1001 }
1002
1003 for_each_available_child_of_node(np, child) {
1004 subtree_max_addr = of_dma_get_max_cpu_address(child);
1005 if (max_cpu_addr > subtree_max_addr)
1006 max_cpu_addr = subtree_max_addr;
1007 }
1008
1009 return max_cpu_addr;
1010}
1011
1012/**
1013 * of_dma_is_coherent - Check if device is coherent
1014 * @np: device node
1015 *
1016 * It returns true if "dma-coherent" property was found
1017 * for this device in the DT, or if DMA is coherent by
1018 * default for OF devices on the current platform and no
1019 * "dma-noncoherent" property was found for this device.
1020 */
1021bool of_dma_is_coherent(struct device_node *np)
1022{
1023 struct device_node *node __free(device_node) = of_node_get(np);
1024
1025 while (node) {
1026 if (of_property_read_bool(node, "dma-coherent"))
1027 return true;
1028
1029 if (of_property_read_bool(node, "dma-noncoherent"))
1030 return false;
1031
1032 node = of_get_next_dma_parent(node);
1033 }
1034 return dma_default_coherent;
1035}
1036EXPORT_SYMBOL_GPL(of_dma_is_coherent);
1037
1038/**
1039 * of_mmio_is_nonposted - Check if device uses non-posted MMIO
1040 * @np: device node
1041 *
1042 * Returns true if the "nonposted-mmio" property was found for
1043 * the device's bus.
1044 *
1045 * This is currently only enabled on builds that support Apple ARM devices, as
1046 * an optimization.
1047 */
1048static bool of_mmio_is_nonposted(const struct device_node *np)
1049{
1050 if (!IS_ENABLED(CONFIG_ARCH_APPLE))
1051 return false;
1052
1053 struct device_node *parent __free(device_node) = of_get_parent(np);
1054 if (!parent)
1055 return false;
1056
1057 return of_property_read_bool(parent, "nonposted-mmio");
1058}
1059
1060static int __of_address_to_resource(struct device_node *dev, int index, int bar_no,
1061 struct resource *r)
1062{
1063 u64 taddr;
1064 const __be32 *addrp;
1065 u64 size;
1066 unsigned int flags;
1067 const char *name = NULL;
1068
1069 addrp = __of_get_address(dev, index, bar_no, &size, &flags);
1070 if (addrp == NULL)
1071 return -EINVAL;
1072
1073 /* Get optional "reg-names" property to add a name to a resource */
1074 if (index >= 0)
1075 of_property_read_string_index(dev, "reg-names", index, &name);
1076
1077 if (flags & IORESOURCE_MEM)
1078 taddr = of_translate_address(dev, addrp);
1079 else if (flags & IORESOURCE_IO)
1080 taddr = of_translate_ioport(dev, addrp, size);
1081 else
1082 return -EINVAL;
1083
1084 if (taddr == OF_BAD_ADDR)
1085 return -EINVAL;
1086 memset(r, 0, sizeof(struct resource));
1087
1088 if (of_mmio_is_nonposted(dev))
1089 flags |= IORESOURCE_MEM_NONPOSTED;
1090
1091 r->flags = flags;
1092 r->name = name ? name : dev->full_name;
1093
1094 return __of_address_resource_bounds(r, taddr, size);
1095}
1096
1097/**
1098 * of_address_to_resource - Translate device tree address and return as resource
1099 * @dev: Caller's Device Node
1100 * @index: Index into the array
1101 * @r: Pointer to resource array
1102 *
1103 * Returns -EINVAL if the range cannot be converted to resource.
1104 *
1105 * Note that if your address is a PIO address, the conversion will fail if
1106 * the physical address can't be internally converted to an IO token with
1107 * pci_address_to_pio(), that is because it's either called too early or it
1108 * can't be matched to any host bridge IO space
1109 */
1110int of_address_to_resource(struct device_node *dev, int index,
1111 struct resource *r)
1112{
1113 return __of_address_to_resource(dev, index, -1, r);
1114}
1115EXPORT_SYMBOL_GPL(of_address_to_resource);
1116
1117int of_pci_address_to_resource(struct device_node *dev, int bar,
1118 struct resource *r)
1119{
1120
1121 if (!IS_ENABLED(CONFIG_PCI))
1122 return -ENOSYS;
1123
1124 return __of_address_to_resource(dev, -1, bar, r);
1125}
1126EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
1127
1128/**
1129 * of_iomap - Maps the memory mapped IO for a given device_node
1130 * @np: the device whose io range will be mapped
1131 * @index: index of the io range
1132 *
1133 * Returns a pointer to the mapped memory
1134 */
1135void __iomem *of_iomap(struct device_node *np, int index)
1136{
1137 struct resource res;
1138
1139 if (of_address_to_resource(np, index, &res))
1140 return NULL;
1141
1142 if (res.flags & IORESOURCE_MEM_NONPOSTED)
1143 return ioremap_np(res.start, resource_size(&res));
1144 else
1145 return ioremap(res.start, resource_size(&res));
1146}
1147EXPORT_SYMBOL(of_iomap);
1148
1149/*
1150 * of_io_request_and_map - Requests a resource and maps the memory mapped IO
1151 * for a given device_node
1152 * @device: the device whose io range will be mapped
1153 * @index: index of the io range
1154 * @name: name "override" for the memory region request or NULL
1155 *
1156 * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
1157 * error code on failure. Usage example:
1158 *
1159 * base = of_io_request_and_map(node, 0, "foo");
1160 * if (IS_ERR(base))
1161 * return PTR_ERR(base);
1162 */
1163void __iomem *of_io_request_and_map(struct device_node *np, int index,
1164 const char *name)
1165{
1166 struct resource res;
1167 void __iomem *mem;
1168
1169 if (of_address_to_resource(np, index, &res))
1170 return IOMEM_ERR_PTR(-EINVAL);
1171
1172 if (!name)
1173 name = res.name;
1174 if (!request_mem_region(res.start, resource_size(&res), name))
1175 return IOMEM_ERR_PTR(-EBUSY);
1176
1177 if (res.flags & IORESOURCE_MEM_NONPOSTED)
1178 mem = ioremap_np(res.start, resource_size(&res));
1179 else
1180 mem = ioremap(res.start, resource_size(&res));
1181
1182 if (!mem) {
1183 release_mem_region(res.start, resource_size(&res));
1184 return IOMEM_ERR_PTR(-ENOMEM);
1185 }
1186
1187 return mem;
1188}
1189EXPORT_SYMBOL(of_io_request_and_map);
1// SPDX-License-Identifier: GPL-2.0
2#define pr_fmt(fmt) "OF: " fmt
3
4#include <linux/device.h>
5#include <linux/fwnode.h>
6#include <linux/io.h>
7#include <linux/ioport.h>
8#include <linux/logic_pio.h>
9#include <linux/module.h>
10#include <linux/of_address.h>
11#include <linux/pci.h>
12#include <linux/pci_regs.h>
13#include <linux/sizes.h>
14#include <linux/slab.h>
15#include <linux/string.h>
16
17/* Max address size we deal with */
18#define OF_MAX_ADDR_CELLS 4
19#define OF_CHECK_ADDR_COUNT(na) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS)
20#define OF_CHECK_COUNTS(na, ns) (OF_CHECK_ADDR_COUNT(na) && (ns) > 0)
21
22static struct of_bus *of_match_bus(struct device_node *np);
23static int __of_address_to_resource(struct device_node *dev,
24 const __be32 *addrp, u64 size, unsigned int flags,
25 const char *name, struct resource *r);
26
27/* Debug utility */
28#ifdef DEBUG
29static void of_dump_addr(const char *s, const __be32 *addr, int na)
30{
31 pr_debug("%s", s);
32 while (na--)
33 pr_cont(" %08x", be32_to_cpu(*(addr++)));
34 pr_cont("\n");
35}
36#else
37static void of_dump_addr(const char *s, const __be32 *addr, int na) { }
38#endif
39
40/* Callbacks for bus specific translators */
41struct of_bus {
42 const char *name;
43 const char *addresses;
44 int (*match)(struct device_node *parent);
45 void (*count_cells)(struct device_node *child,
46 int *addrc, int *sizec);
47 u64 (*map)(__be32 *addr, const __be32 *range,
48 int na, int ns, int pna);
49 int (*translate)(__be32 *addr, u64 offset, int na);
50 unsigned int (*get_flags)(const __be32 *addr);
51};
52
53/*
54 * Default translator (generic bus)
55 */
56
57static void of_bus_default_count_cells(struct device_node *dev,
58 int *addrc, int *sizec)
59{
60 if (addrc)
61 *addrc = of_n_addr_cells(dev);
62 if (sizec)
63 *sizec = of_n_size_cells(dev);
64}
65
66static u64 of_bus_default_map(__be32 *addr, const __be32 *range,
67 int na, int ns, int pna)
68{
69 u64 cp, s, da;
70
71 cp = of_read_number(range, na);
72 s = of_read_number(range + na + pna, ns);
73 da = of_read_number(addr, na);
74
75 pr_debug("default map, cp=%llx, s=%llx, da=%llx\n",
76 (unsigned long long)cp, (unsigned long long)s,
77 (unsigned long long)da);
78
79 if (da < cp || da >= (cp + s))
80 return OF_BAD_ADDR;
81 return da - cp;
82}
83
84static int of_bus_default_translate(__be32 *addr, u64 offset, int na)
85{
86 u64 a = of_read_number(addr, na);
87 memset(addr, 0, na * 4);
88 a += offset;
89 if (na > 1)
90 addr[na - 2] = cpu_to_be32(a >> 32);
91 addr[na - 1] = cpu_to_be32(a & 0xffffffffu);
92
93 return 0;
94}
95
96static unsigned int of_bus_default_get_flags(const __be32 *addr)
97{
98 return IORESOURCE_MEM;
99}
100
101#ifdef CONFIG_PCI
102/*
103 * PCI bus specific translator
104 */
105
106static int of_bus_pci_match(struct device_node *np)
107{
108 /*
109 * "pciex" is PCI Express
110 * "vci" is for the /chaos bridge on 1st-gen PCI powermacs
111 * "ht" is hypertransport
112 */
113 return !strcmp(np->type, "pci") || !strcmp(np->type, "pciex") ||
114 !strcmp(np->type, "vci") || !strcmp(np->type, "ht");
115}
116
117static void of_bus_pci_count_cells(struct device_node *np,
118 int *addrc, int *sizec)
119{
120 if (addrc)
121 *addrc = 3;
122 if (sizec)
123 *sizec = 2;
124}
125
126static unsigned int of_bus_pci_get_flags(const __be32 *addr)
127{
128 unsigned int flags = 0;
129 u32 w = be32_to_cpup(addr);
130
131 switch((w >> 24) & 0x03) {
132 case 0x01:
133 flags |= IORESOURCE_IO;
134 break;
135 case 0x02: /* 32 bits */
136 case 0x03: /* 64 bits */
137 flags |= IORESOURCE_MEM;
138 break;
139 }
140 if (w & 0x40000000)
141 flags |= IORESOURCE_PREFETCH;
142 return flags;
143}
144
145static u64 of_bus_pci_map(__be32 *addr, const __be32 *range, int na, int ns,
146 int pna)
147{
148 u64 cp, s, da;
149 unsigned int af, rf;
150
151 af = of_bus_pci_get_flags(addr);
152 rf = of_bus_pci_get_flags(range);
153
154 /* Check address type match */
155 if ((af ^ rf) & (IORESOURCE_MEM | IORESOURCE_IO))
156 return OF_BAD_ADDR;
157
158 /* Read address values, skipping high cell */
159 cp = of_read_number(range + 1, na - 1);
160 s = of_read_number(range + na + pna, ns);
161 da = of_read_number(addr + 1, na - 1);
162
163 pr_debug("PCI map, cp=%llx, s=%llx, da=%llx\n",
164 (unsigned long long)cp, (unsigned long long)s,
165 (unsigned long long)da);
166
167 if (da < cp || da >= (cp + s))
168 return OF_BAD_ADDR;
169 return da - cp;
170}
171
172static int of_bus_pci_translate(__be32 *addr, u64 offset, int na)
173{
174 return of_bus_default_translate(addr + 1, offset, na - 1);
175}
176
177const __be32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
178 unsigned int *flags)
179{
180 const __be32 *prop;
181 unsigned int psize;
182 struct device_node *parent;
183 struct of_bus *bus;
184 int onesize, i, na, ns;
185
186 /* Get parent & match bus type */
187 parent = of_get_parent(dev);
188 if (parent == NULL)
189 return NULL;
190 bus = of_match_bus(parent);
191 if (strcmp(bus->name, "pci")) {
192 of_node_put(parent);
193 return NULL;
194 }
195 bus->count_cells(dev, &na, &ns);
196 of_node_put(parent);
197 if (!OF_CHECK_ADDR_COUNT(na))
198 return NULL;
199
200 /* Get "reg" or "assigned-addresses" property */
201 prop = of_get_property(dev, bus->addresses, &psize);
202 if (prop == NULL)
203 return NULL;
204 psize /= 4;
205
206 onesize = na + ns;
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)) {
210 if (size)
211 *size = of_read_number(prop + na, ns);
212 if (flags)
213 *flags = bus->get_flags(prop);
214 return prop;
215 }
216 }
217 return NULL;
218}
219EXPORT_SYMBOL(of_get_pci_address);
220
221int of_pci_address_to_resource(struct device_node *dev, int bar,
222 struct resource *r)
223{
224 const __be32 *addrp;
225 u64 size;
226 unsigned int flags;
227
228 addrp = of_get_pci_address(dev, bar, &size, &flags);
229 if (addrp == NULL)
230 return -EINVAL;
231 return __of_address_to_resource(dev, addrp, size, flags, NULL, r);
232}
233EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
234
235static int parser_init(struct of_pci_range_parser *parser,
236 struct device_node *node, const char *name)
237{
238 const int na = 3, ns = 2;
239 int rlen;
240
241 parser->node = node;
242 parser->pna = of_n_addr_cells(node);
243 parser->np = parser->pna + na + ns;
244
245 parser->range = of_get_property(node, name, &rlen);
246 if (parser->range == NULL)
247 return -ENOENT;
248
249 parser->end = parser->range + rlen / sizeof(__be32);
250
251 return 0;
252}
253
254int of_pci_range_parser_init(struct of_pci_range_parser *parser,
255 struct device_node *node)
256{
257 return parser_init(parser, node, "ranges");
258}
259EXPORT_SYMBOL_GPL(of_pci_range_parser_init);
260
261int of_pci_dma_range_parser_init(struct of_pci_range_parser *parser,
262 struct device_node *node)
263{
264 return parser_init(parser, node, "dma-ranges");
265}
266EXPORT_SYMBOL_GPL(of_pci_dma_range_parser_init);
267
268struct of_pci_range *of_pci_range_parser_one(struct of_pci_range_parser *parser,
269 struct of_pci_range *range)
270{
271 const int na = 3, ns = 2;
272
273 if (!range)
274 return NULL;
275
276 if (!parser->range || parser->range + parser->np > parser->end)
277 return NULL;
278
279 range->pci_space = be32_to_cpup(parser->range);
280 range->flags = of_bus_pci_get_flags(parser->range);
281 range->pci_addr = of_read_number(parser->range + 1, ns);
282 range->cpu_addr = of_translate_address(parser->node,
283 parser->range + na);
284 range->size = of_read_number(parser->range + parser->pna + na, ns);
285
286 parser->range += parser->np;
287
288 /* Now consume following elements while they are contiguous */
289 while (parser->range + parser->np <= parser->end) {
290 u32 flags;
291 u64 pci_addr, cpu_addr, size;
292
293 flags = of_bus_pci_get_flags(parser->range);
294 pci_addr = of_read_number(parser->range + 1, ns);
295 cpu_addr = of_translate_address(parser->node,
296 parser->range + na);
297 size = of_read_number(parser->range + parser->pna + na, ns);
298
299 if (flags != range->flags)
300 break;
301 if (pci_addr != range->pci_addr + range->size ||
302 cpu_addr != range->cpu_addr + range->size)
303 break;
304
305 range->size += size;
306 parser->range += parser->np;
307 }
308
309 return range;
310}
311EXPORT_SYMBOL_GPL(of_pci_range_parser_one);
312
313/*
314 * of_pci_range_to_resource - Create a resource from an of_pci_range
315 * @range: the PCI range that describes the resource
316 * @np: device node where the range belongs to
317 * @res: pointer to a valid resource that will be updated to
318 * reflect the values contained in the range.
319 *
320 * Returns EINVAL if the range cannot be converted to resource.
321 *
322 * Note that if the range is an IO range, the resource will be converted
323 * using pci_address_to_pio() which can fail if it is called too early or
324 * if the range cannot be matched to any host bridge IO space (our case here).
325 * To guard against that we try to register the IO range first.
326 * If that fails we know that pci_address_to_pio() will do too.
327 */
328int of_pci_range_to_resource(struct of_pci_range *range,
329 struct device_node *np, struct resource *res)
330{
331 int err;
332 res->flags = range->flags;
333 res->parent = res->child = res->sibling = NULL;
334 res->name = np->full_name;
335
336 if (res->flags & IORESOURCE_IO) {
337 unsigned long port;
338 err = pci_register_io_range(&np->fwnode, range->cpu_addr,
339 range->size);
340 if (err)
341 goto invalid_range;
342 port = pci_address_to_pio(range->cpu_addr);
343 if (port == (unsigned long)-1) {
344 err = -EINVAL;
345 goto invalid_range;
346 }
347 res->start = port;
348 } else {
349 if ((sizeof(resource_size_t) < 8) &&
350 upper_32_bits(range->cpu_addr)) {
351 err = -EINVAL;
352 goto invalid_range;
353 }
354
355 res->start = range->cpu_addr;
356 }
357 res->end = res->start + range->size - 1;
358 return 0;
359
360invalid_range:
361 res->start = (resource_size_t)OF_BAD_ADDR;
362 res->end = (resource_size_t)OF_BAD_ADDR;
363 return err;
364}
365EXPORT_SYMBOL(of_pci_range_to_resource);
366#endif /* CONFIG_PCI */
367
368/*
369 * ISA bus specific translator
370 */
371
372static int of_bus_isa_match(struct device_node *np)
373{
374 return !strcmp(np->name, "isa");
375}
376
377static void of_bus_isa_count_cells(struct device_node *child,
378 int *addrc, int *sizec)
379{
380 if (addrc)
381 *addrc = 2;
382 if (sizec)
383 *sizec = 1;
384}
385
386static u64 of_bus_isa_map(__be32 *addr, const __be32 *range, int na, int ns,
387 int pna)
388{
389 u64 cp, s, da;
390
391 /* Check address type match */
392 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
393 return OF_BAD_ADDR;
394
395 /* Read address values, skipping high cell */
396 cp = of_read_number(range + 1, na - 1);
397 s = of_read_number(range + na + pna, ns);
398 da = of_read_number(addr + 1, na - 1);
399
400 pr_debug("ISA map, cp=%llx, s=%llx, da=%llx\n",
401 (unsigned long long)cp, (unsigned long long)s,
402 (unsigned long long)da);
403
404 if (da < cp || da >= (cp + s))
405 return OF_BAD_ADDR;
406 return da - cp;
407}
408
409static int of_bus_isa_translate(__be32 *addr, u64 offset, int na)
410{
411 return of_bus_default_translate(addr + 1, offset, na - 1);
412}
413
414static unsigned int of_bus_isa_get_flags(const __be32 *addr)
415{
416 unsigned int flags = 0;
417 u32 w = be32_to_cpup(addr);
418
419 if (w & 1)
420 flags |= IORESOURCE_IO;
421 else
422 flags |= IORESOURCE_MEM;
423 return flags;
424}
425
426/*
427 * Array of bus specific translators
428 */
429
430static struct of_bus of_busses[] = {
431#ifdef CONFIG_PCI
432 /* PCI */
433 {
434 .name = "pci",
435 .addresses = "assigned-addresses",
436 .match = of_bus_pci_match,
437 .count_cells = of_bus_pci_count_cells,
438 .map = of_bus_pci_map,
439 .translate = of_bus_pci_translate,
440 .get_flags = of_bus_pci_get_flags,
441 },
442#endif /* CONFIG_PCI */
443 /* ISA */
444 {
445 .name = "isa",
446 .addresses = "reg",
447 .match = of_bus_isa_match,
448 .count_cells = of_bus_isa_count_cells,
449 .map = of_bus_isa_map,
450 .translate = of_bus_isa_translate,
451 .get_flags = of_bus_isa_get_flags,
452 },
453 /* Default */
454 {
455 .name = "default",
456 .addresses = "reg",
457 .match = NULL,
458 .count_cells = of_bus_default_count_cells,
459 .map = of_bus_default_map,
460 .translate = of_bus_default_translate,
461 .get_flags = of_bus_default_get_flags,
462 },
463};
464
465static struct of_bus *of_match_bus(struct device_node *np)
466{
467 int i;
468
469 for (i = 0; i < ARRAY_SIZE(of_busses); i++)
470 if (!of_busses[i].match || of_busses[i].match(np))
471 return &of_busses[i];
472 BUG();
473 return NULL;
474}
475
476static int of_empty_ranges_quirk(struct device_node *np)
477{
478 if (IS_ENABLED(CONFIG_PPC)) {
479 /* To save cycles, we cache the result for global "Mac" setting */
480 static int quirk_state = -1;
481
482 /* PA-SEMI sdc DT bug */
483 if (of_device_is_compatible(np, "1682m-sdc"))
484 return true;
485
486 /* Make quirk cached */
487 if (quirk_state < 0)
488 quirk_state =
489 of_machine_is_compatible("Power Macintosh") ||
490 of_machine_is_compatible("MacRISC");
491 return quirk_state;
492 }
493 return false;
494}
495
496static int of_translate_one(struct device_node *parent, struct of_bus *bus,
497 struct of_bus *pbus, __be32 *addr,
498 int na, int ns, int pna, const char *rprop)
499{
500 const __be32 *ranges;
501 unsigned int rlen;
502 int rone;
503 u64 offset = OF_BAD_ADDR;
504
505 /*
506 * Normally, an absence of a "ranges" property means we are
507 * crossing a non-translatable boundary, and thus the addresses
508 * below the current cannot be converted to CPU physical ones.
509 * Unfortunately, while this is very clear in the spec, it's not
510 * what Apple understood, and they do have things like /uni-n or
511 * /ht nodes with no "ranges" property and a lot of perfectly
512 * useable mapped devices below them. Thus we treat the absence of
513 * "ranges" as equivalent to an empty "ranges" property which means
514 * a 1:1 translation at that level. It's up to the caller not to try
515 * to translate addresses that aren't supposed to be translated in
516 * the first place. --BenH.
517 *
518 * As far as we know, this damage only exists on Apple machines, so
519 * This code is only enabled on powerpc. --gcl
520 */
521 ranges = of_get_property(parent, rprop, &rlen);
522 if (ranges == NULL && !of_empty_ranges_quirk(parent)) {
523 pr_debug("no ranges; cannot translate\n");
524 return 1;
525 }
526 if (ranges == NULL || rlen == 0) {
527 offset = of_read_number(addr, na);
528 memset(addr, 0, pna * 4);
529 pr_debug("empty ranges; 1:1 translation\n");
530 goto finish;
531 }
532
533 pr_debug("walking ranges...\n");
534
535 /* Now walk through the ranges */
536 rlen /= 4;
537 rone = na + pna + ns;
538 for (; rlen >= rone; rlen -= rone, ranges += rone) {
539 offset = bus->map(addr, ranges, na, ns, pna);
540 if (offset != OF_BAD_ADDR)
541 break;
542 }
543 if (offset == OF_BAD_ADDR) {
544 pr_debug("not found !\n");
545 return 1;
546 }
547 memcpy(addr, ranges + na, 4 * pna);
548
549 finish:
550 of_dump_addr("parent translation for:", addr, pna);
551 pr_debug("with offset: %llx\n", (unsigned long long)offset);
552
553 /* Translate it into parent bus space */
554 return pbus->translate(addr, offset, pna);
555}
556
557/*
558 * Translate an address from the device-tree into a CPU physical address,
559 * this walks up the tree and applies the various bus mappings on the
560 * way.
561 *
562 * Note: We consider that crossing any level with #size-cells == 0 to mean
563 * that translation is impossible (that is we are not dealing with a value
564 * that can be mapped to a cpu physical address). This is not really specified
565 * that way, but this is traditionally the way IBM at least do things
566 *
567 * Whenever the translation fails, the *host pointer will be set to the
568 * device that had registered logical PIO mapping, and the return code is
569 * relative to that node.
570 */
571static u64 __of_translate_address(struct device_node *dev,
572 const __be32 *in_addr, const char *rprop,
573 struct device_node **host)
574{
575 struct device_node *parent = NULL;
576 struct of_bus *bus, *pbus;
577 __be32 addr[OF_MAX_ADDR_CELLS];
578 int na, ns, pna, pns;
579 u64 result = OF_BAD_ADDR;
580
581 pr_debug("** translation for device %pOF **\n", dev);
582
583 /* Increase refcount at current level */
584 of_node_get(dev);
585
586 *host = NULL;
587 /* Get parent & match bus type */
588 parent = of_get_parent(dev);
589 if (parent == NULL)
590 goto bail;
591 bus = of_match_bus(parent);
592
593 /* Count address cells & copy address locally */
594 bus->count_cells(dev, &na, &ns);
595 if (!OF_CHECK_COUNTS(na, ns)) {
596 pr_debug("Bad cell count for %pOF\n", dev);
597 goto bail;
598 }
599 memcpy(addr, in_addr, na * 4);
600
601 pr_debug("bus is %s (na=%d, ns=%d) on %pOF\n",
602 bus->name, na, ns, parent);
603 of_dump_addr("translating address:", addr, na);
604
605 /* Translate */
606 for (;;) {
607 struct logic_pio_hwaddr *iorange;
608
609 /* Switch to parent bus */
610 of_node_put(dev);
611 dev = parent;
612 parent = of_get_parent(dev);
613
614 /* If root, we have finished */
615 if (parent == NULL) {
616 pr_debug("reached root node\n");
617 result = of_read_number(addr, na);
618 break;
619 }
620
621 /*
622 * For indirectIO device which has no ranges property, get
623 * the address from reg directly.
624 */
625 iorange = find_io_range_by_fwnode(&dev->fwnode);
626 if (iorange && (iorange->flags != LOGIC_PIO_CPU_MMIO)) {
627 result = of_read_number(addr + 1, na - 1);
628 pr_debug("indirectIO matched(%pOF) 0x%llx\n",
629 dev, result);
630 *host = of_node_get(dev);
631 break;
632 }
633
634 /* Get new parent bus and counts */
635 pbus = of_match_bus(parent);
636 pbus->count_cells(dev, &pna, &pns);
637 if (!OF_CHECK_COUNTS(pna, pns)) {
638 pr_err("Bad cell count for %pOF\n", dev);
639 break;
640 }
641
642 pr_debug("parent bus is %s (na=%d, ns=%d) on %pOF\n",
643 pbus->name, pna, pns, parent);
644
645 /* Apply bus translation */
646 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
647 break;
648
649 /* Complete the move up one level */
650 na = pna;
651 ns = pns;
652 bus = pbus;
653
654 of_dump_addr("one level translation:", addr, na);
655 }
656 bail:
657 of_node_put(parent);
658 of_node_put(dev);
659
660 return result;
661}
662
663u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
664{
665 struct device_node *host;
666 u64 ret;
667
668 ret = __of_translate_address(dev, in_addr, "ranges", &host);
669 if (host) {
670 of_node_put(host);
671 return OF_BAD_ADDR;
672 }
673
674 return ret;
675}
676EXPORT_SYMBOL(of_translate_address);
677
678u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
679{
680 struct device_node *host;
681 u64 ret;
682
683 ret = __of_translate_address(dev, in_addr, "dma-ranges", &host);
684
685 if (host) {
686 of_node_put(host);
687 return OF_BAD_ADDR;
688 }
689
690 return ret;
691}
692EXPORT_SYMBOL(of_translate_dma_address);
693
694const __be32 *of_get_address(struct device_node *dev, int index, u64 *size,
695 unsigned int *flags)
696{
697 const __be32 *prop;
698 unsigned int psize;
699 struct device_node *parent;
700 struct of_bus *bus;
701 int onesize, i, na, ns;
702
703 /* Get parent & match bus type */
704 parent = of_get_parent(dev);
705 if (parent == NULL)
706 return NULL;
707 bus = of_match_bus(parent);
708 bus->count_cells(dev, &na, &ns);
709 of_node_put(parent);
710 if (!OF_CHECK_ADDR_COUNT(na))
711 return NULL;
712
713 /* Get "reg" or "assigned-addresses" property */
714 prop = of_get_property(dev, bus->addresses, &psize);
715 if (prop == NULL)
716 return NULL;
717 psize /= 4;
718
719 onesize = na + ns;
720 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
721 if (i == index) {
722 if (size)
723 *size = of_read_number(prop + na, ns);
724 if (flags)
725 *flags = bus->get_flags(prop);
726 return prop;
727 }
728 return NULL;
729}
730EXPORT_SYMBOL(of_get_address);
731
732static u64 of_translate_ioport(struct device_node *dev, const __be32 *in_addr,
733 u64 size)
734{
735 u64 taddr;
736 unsigned long port;
737 struct device_node *host;
738
739 taddr = __of_translate_address(dev, in_addr, "ranges", &host);
740 if (host) {
741 /* host-specific port access */
742 port = logic_pio_trans_hwaddr(&host->fwnode, taddr, size);
743 of_node_put(host);
744 } else {
745 /* memory-mapped I/O range */
746 port = pci_address_to_pio(taddr);
747 }
748
749 if (port == (unsigned long)-1)
750 return OF_BAD_ADDR;
751
752 return port;
753}
754
755static int __of_address_to_resource(struct device_node *dev,
756 const __be32 *addrp, u64 size, unsigned int flags,
757 const char *name, struct resource *r)
758{
759 u64 taddr;
760
761 if (flags & IORESOURCE_MEM)
762 taddr = of_translate_address(dev, addrp);
763 else if (flags & IORESOURCE_IO)
764 taddr = of_translate_ioport(dev, addrp, size);
765 else
766 return -EINVAL;
767
768 if (taddr == OF_BAD_ADDR)
769 return -EINVAL;
770 memset(r, 0, sizeof(struct resource));
771
772 r->start = taddr;
773 r->end = taddr + size - 1;
774 r->flags = flags;
775 r->name = name ? name : dev->full_name;
776
777 return 0;
778}
779
780/**
781 * of_address_to_resource - Translate device tree address and return as resource
782 *
783 * Note that if your address is a PIO address, the conversion will fail if
784 * the physical address can't be internally converted to an IO token with
785 * pci_address_to_pio(), that is because it's either called too early or it
786 * can't be matched to any host bridge IO space
787 */
788int of_address_to_resource(struct device_node *dev, int index,
789 struct resource *r)
790{
791 const __be32 *addrp;
792 u64 size;
793 unsigned int flags;
794 const char *name = NULL;
795
796 addrp = of_get_address(dev, index, &size, &flags);
797 if (addrp == NULL)
798 return -EINVAL;
799
800 /* Get optional "reg-names" property to add a name to a resource */
801 of_property_read_string_index(dev, "reg-names", index, &name);
802
803 return __of_address_to_resource(dev, addrp, size, flags, name, r);
804}
805EXPORT_SYMBOL_GPL(of_address_to_resource);
806
807struct device_node *of_find_matching_node_by_address(struct device_node *from,
808 const struct of_device_id *matches,
809 u64 base_address)
810{
811 struct device_node *dn = of_find_matching_node(from, matches);
812 struct resource res;
813
814 while (dn) {
815 if (!of_address_to_resource(dn, 0, &res) &&
816 res.start == base_address)
817 return dn;
818
819 dn = of_find_matching_node(dn, matches);
820 }
821
822 return NULL;
823}
824
825
826/**
827 * of_iomap - Maps the memory mapped IO for a given device_node
828 * @device: the device whose io range will be mapped
829 * @index: index of the io range
830 *
831 * Returns a pointer to the mapped memory
832 */
833void __iomem *of_iomap(struct device_node *np, int index)
834{
835 struct resource res;
836
837 if (of_address_to_resource(np, index, &res))
838 return NULL;
839
840 return ioremap(res.start, resource_size(&res));
841}
842EXPORT_SYMBOL(of_iomap);
843
844/*
845 * of_io_request_and_map - Requests a resource and maps the memory mapped IO
846 * for a given device_node
847 * @device: the device whose io range will be mapped
848 * @index: index of the io range
849 * @name: name of the resource
850 *
851 * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
852 * error code on failure. Usage example:
853 *
854 * base = of_io_request_and_map(node, 0, "foo");
855 * if (IS_ERR(base))
856 * return PTR_ERR(base);
857 */
858void __iomem *of_io_request_and_map(struct device_node *np, int index,
859 const char *name)
860{
861 struct resource res;
862 void __iomem *mem;
863
864 if (of_address_to_resource(np, index, &res))
865 return IOMEM_ERR_PTR(-EINVAL);
866
867 if (!request_mem_region(res.start, resource_size(&res), name))
868 return IOMEM_ERR_PTR(-EBUSY);
869
870 mem = ioremap(res.start, resource_size(&res));
871 if (!mem) {
872 release_mem_region(res.start, resource_size(&res));
873 return IOMEM_ERR_PTR(-ENOMEM);
874 }
875
876 return mem;
877}
878EXPORT_SYMBOL(of_io_request_and_map);
879
880/**
881 * of_dma_get_range - Get DMA range info
882 * @np: device node to get DMA range info
883 * @dma_addr: pointer to store initial DMA address of DMA range
884 * @paddr: pointer to store initial CPU address of DMA range
885 * @size: pointer to store size of DMA range
886 *
887 * Look in bottom up direction for the first "dma-ranges" property
888 * and parse it.
889 * dma-ranges format:
890 * DMA addr (dma_addr) : naddr cells
891 * CPU addr (phys_addr_t) : pna cells
892 * size : nsize cells
893 *
894 * It returns -ENODEV if "dma-ranges" property was not found
895 * for this device in DT.
896 */
897int of_dma_get_range(struct device_node *np, u64 *dma_addr, u64 *paddr, u64 *size)
898{
899 struct device_node *node = of_node_get(np);
900 const __be32 *ranges = NULL;
901 int len, naddr, nsize, pna;
902 int ret = 0;
903 u64 dmaaddr;
904
905 if (!node)
906 return -EINVAL;
907
908 while (1) {
909 naddr = of_n_addr_cells(node);
910 nsize = of_n_size_cells(node);
911 node = of_get_next_parent(node);
912 if (!node)
913 break;
914
915 ranges = of_get_property(node, "dma-ranges", &len);
916
917 /* Ignore empty ranges, they imply no translation required */
918 if (ranges && len > 0)
919 break;
920
921 /*
922 * At least empty ranges has to be defined for parent node if
923 * DMA is supported
924 */
925 if (!ranges)
926 break;
927 }
928
929 if (!ranges) {
930 pr_debug("no dma-ranges found for node(%pOF)\n", np);
931 ret = -ENODEV;
932 goto out;
933 }
934
935 len /= sizeof(u32);
936
937 pna = of_n_addr_cells(node);
938
939 /* dma-ranges format:
940 * DMA addr : naddr cells
941 * CPU addr : pna cells
942 * size : nsize cells
943 */
944 dmaaddr = of_read_number(ranges, naddr);
945 *paddr = of_translate_dma_address(np, ranges);
946 if (*paddr == OF_BAD_ADDR) {
947 pr_err("translation of DMA address(%pad) to CPU address failed node(%pOF)\n",
948 dma_addr, np);
949 ret = -EINVAL;
950 goto out;
951 }
952 *dma_addr = dmaaddr;
953
954 *size = of_read_number(ranges + naddr + pna, nsize);
955
956 pr_debug("dma_addr(%llx) cpu_addr(%llx) size(%llx)\n",
957 *dma_addr, *paddr, *size);
958
959out:
960 of_node_put(node);
961
962 return ret;
963}
964EXPORT_SYMBOL_GPL(of_dma_get_range);
965
966/**
967 * of_dma_is_coherent - Check if device is coherent
968 * @np: device node
969 *
970 * It returns true if "dma-coherent" property was found
971 * for this device in DT.
972 */
973bool of_dma_is_coherent(struct device_node *np)
974{
975 struct device_node *node = of_node_get(np);
976
977 while (node) {
978 if (of_property_read_bool(node, "dma-coherent")) {
979 of_node_put(node);
980 return true;
981 }
982 node = of_get_next_parent(node);
983 }
984 of_node_put(node);
985 return false;
986}
987EXPORT_SYMBOL_GPL(of_dma_is_coherent);