blob: 792722e7d45884add844d9931ddef7dc5e816f0f [file] [log] [blame]
Grant Likely6b884a82010-06-08 07:48:09 -06001
Rob Herring606ad422016-06-15 08:32:18 -05002#define pr_fmt(fmt) "OF: " fmt
3
Arnd Bergmann5019f0b2012-04-11 17:30:11 +00004#include <linux/device.h>
Grant Likely6b884a82010-06-08 07:48:09 -06005#include <linux/io.h>
6#include <linux/ioport.h>
Grant Likelydbbdee92010-06-08 07:48:10 -06007#include <linux/module.h>
Grant Likely6b884a82010-06-08 07:48:09 -06008#include <linux/of_address.h>
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05009#include <linux/pci.h>
Grant Likelydbbdee92010-06-08 07:48:10 -060010#include <linux/pci_regs.h>
Liviu Dudau41f8bba2014-09-29 15:29:21 +010011#include <linux/sizes.h>
12#include <linux/slab.h>
Grant Likelydbbdee92010-06-08 07:48:10 -060013#include <linux/string.h>
Grant Likely6b884a82010-06-08 07:48:09 -060014
Grant Likelydbbdee92010-06-08 07:48:10 -060015/* Max address size we deal with */
16#define OF_MAX_ADDR_CELLS 4
Stephen Warren5d61b162012-07-25 17:34:37 -060017#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)
Grant Likelydbbdee92010-06-08 07:48:10 -060019
20static struct of_bus *of_match_bus(struct device_node *np);
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +010021static int __of_address_to_resource(struct device_node *dev,
22 const __be32 *addrp, u64 size, unsigned int flags,
Benoit Cousson35f3da32011-12-05 15:23:55 +010023 const char *name, struct resource *r);
Grant Likelydbbdee92010-06-08 07:48:10 -060024
25/* Debug utility */
26#ifdef DEBUG
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +010027static void of_dump_addr(const char *s, const __be32 *addr, int na)
Grant Likelydbbdee92010-06-08 07:48:10 -060028{
Rob Herring606ad422016-06-15 08:32:18 -050029 pr_debug("%s", s);
Grant Likelydbbdee92010-06-08 07:48:10 -060030 while (na--)
Rob Herring606ad422016-06-15 08:32:18 -050031 pr_cont(" %08x", be32_to_cpu(*(addr++)));
32 pr_cont("\n");
Grant Likelydbbdee92010-06-08 07:48:10 -060033}
34#else
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +010035static void of_dump_addr(const char *s, const __be32 *addr, int na) { }
Grant Likelydbbdee92010-06-08 07:48:10 -060036#endif
37
38/* Callbacks for bus specific translators */
39struct of_bus {
40 const char *name;
41 const char *addresses;
42 int (*match)(struct device_node *parent);
43 void (*count_cells)(struct device_node *child,
44 int *addrc, int *sizec);
Kim Phillips47b1e682012-10-08 19:41:58 -050045 u64 (*map)(__be32 *addr, const __be32 *range,
Grant Likelydbbdee92010-06-08 07:48:10 -060046 int na, int ns, int pna);
Kim Phillips47b1e682012-10-08 19:41:58 -050047 int (*translate)(__be32 *addr, u64 offset, int na);
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +010048 unsigned int (*get_flags)(const __be32 *addr);
Grant Likelydbbdee92010-06-08 07:48:10 -060049};
50
51/*
52 * Default translator (generic bus)
53 */
54
55static void of_bus_default_count_cells(struct device_node *dev,
56 int *addrc, int *sizec)
57{
58 if (addrc)
59 *addrc = of_n_addr_cells(dev);
60 if (sizec)
61 *sizec = of_n_size_cells(dev);
62}
63
Kim Phillips47b1e682012-10-08 19:41:58 -050064static u64 of_bus_default_map(__be32 *addr, const __be32 *range,
Grant Likelydbbdee92010-06-08 07:48:10 -060065 int na, int ns, int pna)
66{
67 u64 cp, s, da;
68
69 cp = of_read_number(range, na);
70 s = of_read_number(range + na + pna, ns);
71 da = of_read_number(addr, na);
72
Rob Herring606ad422016-06-15 08:32:18 -050073 pr_debug("default map, cp=%llx, s=%llx, da=%llx\n",
Grant Likelydbbdee92010-06-08 07:48:10 -060074 (unsigned long long)cp, (unsigned long long)s,
75 (unsigned long long)da);
76
77 if (da < cp || da >= (cp + s))
78 return OF_BAD_ADDR;
79 return da - cp;
80}
81
Kim Phillips47b1e682012-10-08 19:41:58 -050082static int of_bus_default_translate(__be32 *addr, u64 offset, int na)
Grant Likelydbbdee92010-06-08 07:48:10 -060083{
84 u64 a = of_read_number(addr, na);
85 memset(addr, 0, na * 4);
86 a += offset;
87 if (na > 1)
Grant Likely154063a92010-06-08 07:48:11 -060088 addr[na - 2] = cpu_to_be32(a >> 32);
89 addr[na - 1] = cpu_to_be32(a & 0xffffffffu);
Grant Likelydbbdee92010-06-08 07:48:10 -060090
91 return 0;
92}
93
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +010094static unsigned int of_bus_default_get_flags(const __be32 *addr)
Grant Likelydbbdee92010-06-08 07:48:10 -060095{
96 return IORESOURCE_MEM;
97}
98
Gregory CLEMENT25a31572014-02-19 23:14:55 +010099#ifdef CONFIG_OF_ADDRESS_PCI
Grant Likelydbbdee92010-06-08 07:48:10 -0600100/*
101 * PCI bus specific translator
102 */
103
104static int of_bus_pci_match(struct device_node *np)
105{
Benjamin Herrenschmidt6dd18e42013-07-03 16:01:10 +1000106 /*
Kleber Sacilotto de Souza14e2abb2014-02-03 13:31:03 -0200107 * "pciex" is PCI Express
Benjamin Herrenschmidt6dd18e42013-07-03 16:01:10 +1000108 * "vci" is for the /chaos bridge on 1st-gen PCI powermacs
109 * "ht" is hypertransport
110 */
Kleber Sacilotto de Souza14e2abb2014-02-03 13:31:03 -0200111 return !strcmp(np->type, "pci") || !strcmp(np->type, "pciex") ||
112 !strcmp(np->type, "vci") || !strcmp(np->type, "ht");
Grant Likelydbbdee92010-06-08 07:48:10 -0600113}
114
115static void of_bus_pci_count_cells(struct device_node *np,
116 int *addrc, int *sizec)
117{
118 if (addrc)
119 *addrc = 3;
120 if (sizec)
121 *sizec = 2;
122}
123
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100124static unsigned int of_bus_pci_get_flags(const __be32 *addr)
Grant Likelydbbdee92010-06-08 07:48:10 -0600125{
126 unsigned int flags = 0;
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100127 u32 w = be32_to_cpup(addr);
Grant Likelydbbdee92010-06-08 07:48:10 -0600128
129 switch((w >> 24) & 0x03) {
130 case 0x01:
131 flags |= IORESOURCE_IO;
132 break;
133 case 0x02: /* 32 bits */
134 case 0x03: /* 64 bits */
135 flags |= IORESOURCE_MEM;
136 break;
137 }
138 if (w & 0x40000000)
139 flags |= IORESOURCE_PREFETCH;
140 return flags;
141}
142
Kim Phillips47b1e682012-10-08 19:41:58 -0500143static u64 of_bus_pci_map(__be32 *addr, const __be32 *range, int na, int ns,
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100144 int pna)
Grant Likelydbbdee92010-06-08 07:48:10 -0600145{
146 u64 cp, s, da;
147 unsigned int af, rf;
148
149 af = of_bus_pci_get_flags(addr);
150 rf = of_bus_pci_get_flags(range);
151
152 /* Check address type match */
153 if ((af ^ rf) & (IORESOURCE_MEM | IORESOURCE_IO))
154 return OF_BAD_ADDR;
155
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);
160
Rob Herring606ad422016-06-15 08:32:18 -0500161 pr_debug("PCI map, cp=%llx, s=%llx, da=%llx\n",
Grant Likelydbbdee92010-06-08 07:48:10 -0600162 (unsigned long long)cp, (unsigned long long)s,
163 (unsigned long long)da);
164
165 if (da < cp || da >= (cp + s))
166 return OF_BAD_ADDR;
167 return da - cp;
168}
169
Kim Phillips47b1e682012-10-08 19:41:58 -0500170static int of_bus_pci_translate(__be32 *addr, u64 offset, int na)
Grant Likelydbbdee92010-06-08 07:48:10 -0600171{
172 return of_bus_default_translate(addr + 1, offset, na - 1);
173}
Gregory CLEMENT25a31572014-02-19 23:14:55 +0100174#endif /* CONFIG_OF_ADDRESS_PCI */
Grant Likelydbbdee92010-06-08 07:48:10 -0600175
Gregory CLEMENT25a31572014-02-19 23:14:55 +0100176#ifdef CONFIG_PCI
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100177const __be32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
Grant Likelydbbdee92010-06-08 07:48:10 -0600178 unsigned int *flags)
179{
Jeremy Kerra9fadee2010-10-10 21:24:10 -0600180 const __be32 *prop;
Grant Likelydbbdee92010-06-08 07:48:10 -0600181 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);
Stephen Warren5d61b162012-07-25 17:34:37 -0600197 if (!OF_CHECK_ADDR_COUNT(na))
Grant Likelydbbdee92010-06-08 07:48:10 -0600198 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;
Grant Likely154063a92010-06-08 07:48:11 -0600207 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)) {
Grant Likelydbbdee92010-06-08 07:48:10 -0600210 if (size)
211 *size = of_read_number(prop + na, ns);
212 if (flags)
213 *flags = bus->get_flags(prop);
214 return prop;
215 }
Grant Likely154063a92010-06-08 07:48:11 -0600216 }
Grant Likelydbbdee92010-06-08 07:48:10 -0600217 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{
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100224 const __be32 *addrp;
Grant Likelydbbdee92010-06-08 07:48:10 -0600225 u64 size;
226 unsigned int flags;
227
228 addrp = of_get_pci_address(dev, bar, &size, &flags);
229 if (addrp == NULL)
230 return -EINVAL;
Benoit Cousson35f3da32011-12-05 15:23:55 +0100231 return __of_address_to_resource(dev, addrp, size, flags, NULL, r);
Grant Likelydbbdee92010-06-08 07:48:10 -0600232}
233EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
Andrew Murray29b635c2013-05-16 17:55:17 +0200234
235int of_pci_range_parser_init(struct of_pci_range_parser *parser,
236 struct device_node *node)
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, "ranges", &rlen);
246 if (parser->range == NULL)
247 return -ENOENT;
248
249 parser->end = parser->range + rlen / sizeof(__be32);
250
251 return 0;
252}
253EXPORT_SYMBOL_GPL(of_pci_range_parser_init);
254
255struct of_pci_range *of_pci_range_parser_one(struct of_pci_range_parser *parser,
256 struct of_pci_range *range)
257{
258 const int na = 3, ns = 2;
259
260 if (!range)
261 return NULL;
262
263 if (!parser->range || parser->range + parser->np > parser->end)
264 return NULL;
265
Rob Herringeb310032017-05-04 12:34:30 -0500266 range->pci_space = be32_to_cpup(parser->range);
Andrew Murray29b635c2013-05-16 17:55:17 +0200267 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,
270 parser->range + na);
271 range->size = of_read_number(parser->range + parser->pna + na, ns);
272
273 parser->range += parser->np;
274
275 /* Now consume following elements while they are contiguous */
276 while (parser->range + parser->np <= parser->end) {
Shawn Linfda9f5d2017-07-12 17:59:06 +0800277 u32 flags;
Andrew Murray29b635c2013-05-16 17:55:17 +0200278 u64 pci_addr, cpu_addr, size;
279
Andrew Murray29b635c2013-05-16 17:55:17 +0200280 flags = of_bus_pci_get_flags(parser->range);
281 pci_addr = of_read_number(parser->range + 1, ns);
282 cpu_addr = of_translate_address(parser->node,
283 parser->range + na);
284 size = of_read_number(parser->range + parser->pna + na, ns);
285
286 if (flags != range->flags)
287 break;
288 if (pci_addr != range->pci_addr + range->size ||
289 cpu_addr != range->cpu_addr + range->size)
290 break;
291
292 range->size += size;
293 parser->range += parser->np;
294 }
295
296 return range;
297}
298EXPORT_SYMBOL_GPL(of_pci_range_parser_one);
299
Liviu Dudau0b0b0892014-09-29 15:29:25 +0100300/*
301 * of_pci_range_to_resource - Create a resource from an of_pci_range
302 * @range: the PCI range that describes the resource
303 * @np: device node where the range belongs to
304 * @res: pointer to a valid resource that will be updated to
305 * reflect the values contained in the range.
306 *
307 * Returns EINVAL if the range cannot be converted to resource.
308 *
309 * Note that if the range is an IO range, the resource will be converted
310 * using pci_address_to_pio() which can fail if it is called too early or
311 * if the range cannot be matched to any host bridge IO space (our case here).
312 * To guard against that we try to register the IO range first.
313 * If that fails we know that pci_address_to_pio() will do too.
314 */
315int of_pci_range_to_resource(struct of_pci_range *range,
316 struct device_node *np, struct resource *res)
Liviu Dudau83bbde12014-09-29 15:29:24 +0100317{
Liviu Dudau0b0b0892014-09-29 15:29:25 +0100318 int err;
Liviu Dudau83bbde12014-09-29 15:29:24 +0100319 res->flags = range->flags;
Liviu Dudau83bbde12014-09-29 15:29:24 +0100320 res->parent = res->child = res->sibling = NULL;
321 res->name = np->full_name;
Liviu Dudau0b0b0892014-09-29 15:29:25 +0100322
323 if (res->flags & IORESOURCE_IO) {
324 unsigned long port;
325 err = pci_register_io_range(range->cpu_addr, range->size);
326 if (err)
327 goto invalid_range;
328 port = pci_address_to_pio(range->cpu_addr);
329 if (port == (unsigned long)-1) {
330 err = -EINVAL;
331 goto invalid_range;
332 }
333 res->start = port;
334 } else {
Pavel Fedin4af97102015-10-08 10:24:25 +0300335 if ((sizeof(resource_size_t) < 8) &&
336 upper_32_bits(range->cpu_addr)) {
337 err = -EINVAL;
338 goto invalid_range;
339 }
340
Liviu Dudau0b0b0892014-09-29 15:29:25 +0100341 res->start = range->cpu_addr;
342 }
343 res->end = res->start + range->size - 1;
344 return 0;
345
346invalid_range:
347 res->start = (resource_size_t)OF_BAD_ADDR;
348 res->end = (resource_size_t)OF_BAD_ADDR;
349 return err;
Liviu Dudau83bbde12014-09-29 15:29:24 +0100350}
Grant Likelydbbdee92010-06-08 07:48:10 -0600351#endif /* CONFIG_PCI */
352
353/*
354 * ISA bus specific translator
355 */
356
357static int of_bus_isa_match(struct device_node *np)
358{
359 return !strcmp(np->name, "isa");
360}
361
362static void of_bus_isa_count_cells(struct device_node *child,
363 int *addrc, int *sizec)
364{
365 if (addrc)
366 *addrc = 2;
367 if (sizec)
368 *sizec = 1;
369}
370
Kim Phillips47b1e682012-10-08 19:41:58 -0500371static u64 of_bus_isa_map(__be32 *addr, const __be32 *range, int na, int ns,
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100372 int pna)
Grant Likelydbbdee92010-06-08 07:48:10 -0600373{
374 u64 cp, s, da;
375
376 /* Check address type match */
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100377 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
Grant Likelydbbdee92010-06-08 07:48:10 -0600378 return OF_BAD_ADDR;
379
380 /* Read address values, skipping high cell */
381 cp = of_read_number(range + 1, na - 1);
382 s = of_read_number(range + na + pna, ns);
383 da = of_read_number(addr + 1, na - 1);
384
Rob Herring606ad422016-06-15 08:32:18 -0500385 pr_debug("ISA map, cp=%llx, s=%llx, da=%llx\n",
Grant Likelydbbdee92010-06-08 07:48:10 -0600386 (unsigned long long)cp, (unsigned long long)s,
387 (unsigned long long)da);
388
389 if (da < cp || da >= (cp + s))
390 return OF_BAD_ADDR;
391 return da - cp;
392}
393
Kim Phillips47b1e682012-10-08 19:41:58 -0500394static int of_bus_isa_translate(__be32 *addr, u64 offset, int na)
Grant Likelydbbdee92010-06-08 07:48:10 -0600395{
396 return of_bus_default_translate(addr + 1, offset, na - 1);
397}
398
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100399static unsigned int of_bus_isa_get_flags(const __be32 *addr)
Grant Likelydbbdee92010-06-08 07:48:10 -0600400{
401 unsigned int flags = 0;
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100402 u32 w = be32_to_cpup(addr);
Grant Likelydbbdee92010-06-08 07:48:10 -0600403
404 if (w & 1)
405 flags |= IORESOURCE_IO;
406 else
407 flags |= IORESOURCE_MEM;
408 return flags;
409}
410
411/*
412 * Array of bus specific translators
413 */
414
415static struct of_bus of_busses[] = {
Gregory CLEMENT25a31572014-02-19 23:14:55 +0100416#ifdef CONFIG_OF_ADDRESS_PCI
Grant Likelydbbdee92010-06-08 07:48:10 -0600417 /* PCI */
418 {
419 .name = "pci",
420 .addresses = "assigned-addresses",
421 .match = of_bus_pci_match,
422 .count_cells = of_bus_pci_count_cells,
423 .map = of_bus_pci_map,
424 .translate = of_bus_pci_translate,
425 .get_flags = of_bus_pci_get_flags,
426 },
Gregory CLEMENT25a31572014-02-19 23:14:55 +0100427#endif /* CONFIG_OF_ADDRESS_PCI */
Grant Likelydbbdee92010-06-08 07:48:10 -0600428 /* ISA */
429 {
430 .name = "isa",
431 .addresses = "reg",
432 .match = of_bus_isa_match,
433 .count_cells = of_bus_isa_count_cells,
434 .map = of_bus_isa_map,
435 .translate = of_bus_isa_translate,
436 .get_flags = of_bus_isa_get_flags,
437 },
438 /* Default */
439 {
440 .name = "default",
441 .addresses = "reg",
442 .match = NULL,
443 .count_cells = of_bus_default_count_cells,
444 .map = of_bus_default_map,
445 .translate = of_bus_default_translate,
446 .get_flags = of_bus_default_get_flags,
447 },
448};
449
450static struct of_bus *of_match_bus(struct device_node *np)
451{
452 int i;
453
454 for (i = 0; i < ARRAY_SIZE(of_busses); i++)
455 if (!of_busses[i].match || of_busses[i].match(np))
456 return &of_busses[i];
457 BUG();
458 return NULL;
459}
460
Benjamin Herrenschmidt41d94892015-03-23 14:16:38 +1100461static int of_empty_ranges_quirk(struct device_node *np)
Benjamin Herrenschmidt746c9e92014-11-14 17:55:03 +1100462{
463 if (IS_ENABLED(CONFIG_PPC)) {
Benjamin Herrenschmidt41d94892015-03-23 14:16:38 +1100464 /* To save cycles, we cache the result for global "Mac" setting */
Benjamin Herrenschmidt746c9e92014-11-14 17:55:03 +1100465 static int quirk_state = -1;
466
Benjamin Herrenschmidt41d94892015-03-23 14:16:38 +1100467 /* PA-SEMI sdc DT bug */
468 if (of_device_is_compatible(np, "1682m-sdc"))
469 return true;
470
471 /* Make quirk cached */
Benjamin Herrenschmidt746c9e92014-11-14 17:55:03 +1100472 if (quirk_state < 0)
473 quirk_state =
474 of_machine_is_compatible("Power Macintosh") ||
475 of_machine_is_compatible("MacRISC");
476 return quirk_state;
477 }
478 return false;
479}
480
Grant Likelydbbdee92010-06-08 07:48:10 -0600481static int of_translate_one(struct device_node *parent, struct of_bus *bus,
Kim Phillips47b1e682012-10-08 19:41:58 -0500482 struct of_bus *pbus, __be32 *addr,
Grant Likelydbbdee92010-06-08 07:48:10 -0600483 int na, int ns, int pna, const char *rprop)
484{
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100485 const __be32 *ranges;
Grant Likelydbbdee92010-06-08 07:48:10 -0600486 unsigned int rlen;
487 int rone;
488 u64 offset = OF_BAD_ADDR;
489
Masahiro Yamadaba85edb2015-11-30 15:22:37 +0900490 /*
491 * Normally, an absence of a "ranges" property means we are
Grant Likelydbbdee92010-06-08 07:48:10 -0600492 * crossing a non-translatable boundary, and thus the addresses
Masahiro Yamadaba85edb2015-11-30 15:22:37 +0900493 * below the current cannot be converted to CPU physical ones.
Grant Likelydbbdee92010-06-08 07:48:10 -0600494 * Unfortunately, while this is very clear in the spec, it's not
495 * what Apple understood, and they do have things like /uni-n or
496 * /ht nodes with no "ranges" property and a lot of perfectly
497 * useable mapped devices below them. Thus we treat the absence of
498 * "ranges" as equivalent to an empty "ranges" property which means
499 * a 1:1 translation at that level. It's up to the caller not to try
500 * to translate addresses that aren't supposed to be translated in
501 * the first place. --BenH.
Grant Likely3930f292010-06-08 07:48:11 -0600502 *
503 * As far as we know, this damage only exists on Apple machines, so
504 * This code is only enabled on powerpc. --gcl
Grant Likelydbbdee92010-06-08 07:48:10 -0600505 */
506 ranges = of_get_property(parent, rprop, &rlen);
Benjamin Herrenschmidt41d94892015-03-23 14:16:38 +1100507 if (ranges == NULL && !of_empty_ranges_quirk(parent)) {
Rob Herring606ad422016-06-15 08:32:18 -0500508 pr_debug("no ranges; cannot translate\n");
Grant Likely3930f292010-06-08 07:48:11 -0600509 return 1;
510 }
Grant Likelydbbdee92010-06-08 07:48:10 -0600511 if (ranges == NULL || rlen == 0) {
512 offset = of_read_number(addr, na);
513 memset(addr, 0, pna * 4);
Rob Herring606ad422016-06-15 08:32:18 -0500514 pr_debug("empty ranges; 1:1 translation\n");
Grant Likelydbbdee92010-06-08 07:48:10 -0600515 goto finish;
516 }
517
Rob Herring606ad422016-06-15 08:32:18 -0500518 pr_debug("walking ranges...\n");
Grant Likelydbbdee92010-06-08 07:48:10 -0600519
520 /* Now walk through the ranges */
521 rlen /= 4;
522 rone = na + pna + ns;
523 for (; rlen >= rone; rlen -= rone, ranges += rone) {
524 offset = bus->map(addr, ranges, na, ns, pna);
525 if (offset != OF_BAD_ADDR)
526 break;
527 }
528 if (offset == OF_BAD_ADDR) {
Rob Herring606ad422016-06-15 08:32:18 -0500529 pr_debug("not found !\n");
Grant Likelydbbdee92010-06-08 07:48:10 -0600530 return 1;
531 }
532 memcpy(addr, ranges + na, 4 * pna);
533
534 finish:
Rob Herring606ad422016-06-15 08:32:18 -0500535 of_dump_addr("parent translation for:", addr, pna);
536 pr_debug("with offset: %llx\n", (unsigned long long)offset);
Grant Likelydbbdee92010-06-08 07:48:10 -0600537
538 /* Translate it into parent bus space */
539 return pbus->translate(addr, offset, pna);
540}
541
542/*
543 * Translate an address from the device-tree into a CPU physical address,
544 * this walks up the tree and applies the various bus mappings on the
545 * way.
546 *
547 * Note: We consider that crossing any level with #size-cells == 0 to mean
548 * that translation is impossible (that is we are not dealing with a value
549 * that can be mapped to a cpu physical address). This is not really specified
550 * that way, but this is traditionally the way IBM at least do things
551 */
Kim Phillips47b1e682012-10-08 19:41:58 -0500552static u64 __of_translate_address(struct device_node *dev,
553 const __be32 *in_addr, const char *rprop)
Grant Likelydbbdee92010-06-08 07:48:10 -0600554{
555 struct device_node *parent = NULL;
556 struct of_bus *bus, *pbus;
Kim Phillips47b1e682012-10-08 19:41:58 -0500557 __be32 addr[OF_MAX_ADDR_CELLS];
Grant Likelydbbdee92010-06-08 07:48:10 -0600558 int na, ns, pna, pns;
559 u64 result = OF_BAD_ADDR;
560
Rob Herring0d638a02017-06-01 15:50:55 -0500561 pr_debug("** translation for device %pOF **\n", dev);
Grant Likelydbbdee92010-06-08 07:48:10 -0600562
563 /* Increase refcount at current level */
564 of_node_get(dev);
565
566 /* Get parent & match bus type */
567 parent = of_get_parent(dev);
568 if (parent == NULL)
569 goto bail;
570 bus = of_match_bus(parent);
571
Andrew Murray59f5ca42012-12-13 10:11:23 +0000572 /* Count address cells & copy address locally */
Grant Likelydbbdee92010-06-08 07:48:10 -0600573 bus->count_cells(dev, &na, &ns);
574 if (!OF_CHECK_COUNTS(na, ns)) {
Rob Herring0d638a02017-06-01 15:50:55 -0500575 pr_debug("Bad cell count for %pOF\n", dev);
Grant Likelydbbdee92010-06-08 07:48:10 -0600576 goto bail;
577 }
578 memcpy(addr, in_addr, na * 4);
579
Rob Herring0d638a02017-06-01 15:50:55 -0500580 pr_debug("bus is %s (na=%d, ns=%d) on %pOF\n",
581 bus->name, na, ns, parent);
Rob Herring606ad422016-06-15 08:32:18 -0500582 of_dump_addr("translating address:", addr, na);
Grant Likelydbbdee92010-06-08 07:48:10 -0600583
584 /* Translate */
585 for (;;) {
586 /* Switch to parent bus */
587 of_node_put(dev);
588 dev = parent;
589 parent = of_get_parent(dev);
590
591 /* If root, we have finished */
592 if (parent == NULL) {
Rob Herring606ad422016-06-15 08:32:18 -0500593 pr_debug("reached root node\n");
Grant Likelydbbdee92010-06-08 07:48:10 -0600594 result = of_read_number(addr, na);
595 break;
596 }
597
598 /* Get new parent bus and counts */
599 pbus = of_match_bus(parent);
600 pbus->count_cells(dev, &pna, &pns);
601 if (!OF_CHECK_COUNTS(pna, pns)) {
Rob Herring0d638a02017-06-01 15:50:55 -0500602 pr_err("Bad cell count for %pOF\n", dev);
Grant Likelydbbdee92010-06-08 07:48:10 -0600603 break;
604 }
605
Rob Herring0d638a02017-06-01 15:50:55 -0500606 pr_debug("parent bus is %s (na=%d, ns=%d) on %pOF\n",
607 pbus->name, pna, pns, parent);
Grant Likelydbbdee92010-06-08 07:48:10 -0600608
609 /* Apply bus translation */
610 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
611 break;
612
613 /* Complete the move up one level */
614 na = pna;
615 ns = pns;
616 bus = pbus;
617
Rob Herring606ad422016-06-15 08:32:18 -0500618 of_dump_addr("one level translation:", addr, na);
Grant Likelydbbdee92010-06-08 07:48:10 -0600619 }
620 bail:
621 of_node_put(parent);
622 of_node_put(dev);
623
624 return result;
625}
626
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100627u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
Grant Likelydbbdee92010-06-08 07:48:10 -0600628{
629 return __of_translate_address(dev, in_addr, "ranges");
630}
631EXPORT_SYMBOL(of_translate_address);
632
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100633u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
Grant Likelydbbdee92010-06-08 07:48:10 -0600634{
635 return __of_translate_address(dev, in_addr, "dma-ranges");
636}
637EXPORT_SYMBOL(of_translate_dma_address);
638
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100639const __be32 *of_get_address(struct device_node *dev, int index, u64 *size,
Grant Likelydbbdee92010-06-08 07:48:10 -0600640 unsigned int *flags)
641{
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100642 const __be32 *prop;
Grant Likelydbbdee92010-06-08 07:48:10 -0600643 unsigned int psize;
644 struct device_node *parent;
645 struct of_bus *bus;
646 int onesize, i, na, ns;
647
648 /* Get parent & match bus type */
649 parent = of_get_parent(dev);
650 if (parent == NULL)
651 return NULL;
652 bus = of_match_bus(parent);
653 bus->count_cells(dev, &na, &ns);
654 of_node_put(parent);
Stephen Warren5d61b162012-07-25 17:34:37 -0600655 if (!OF_CHECK_ADDR_COUNT(na))
Grant Likelydbbdee92010-06-08 07:48:10 -0600656 return NULL;
657
658 /* Get "reg" or "assigned-addresses" property */
659 prop = of_get_property(dev, bus->addresses, &psize);
660 if (prop == NULL)
661 return NULL;
662 psize /= 4;
663
664 onesize = na + ns;
665 for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
666 if (i == index) {
667 if (size)
668 *size = of_read_number(prop + na, ns);
669 if (flags)
670 *flags = bus->get_flags(prop);
671 return prop;
672 }
673 return NULL;
674}
675EXPORT_SYMBOL(of_get_address);
676
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100677static int __of_address_to_resource(struct device_node *dev,
678 const __be32 *addrp, u64 size, unsigned int flags,
Benoit Cousson35f3da32011-12-05 15:23:55 +0100679 const char *name, struct resource *r)
Grant Likely1f5bef32010-06-08 07:48:09 -0600680{
681 u64 taddr;
682
683 if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
684 return -EINVAL;
685 taddr = of_translate_address(dev, addrp);
686 if (taddr == OF_BAD_ADDR)
687 return -EINVAL;
688 memset(r, 0, sizeof(struct resource));
689 if (flags & IORESOURCE_IO) {
690 unsigned long port;
691 port = pci_address_to_pio(taddr);
692 if (port == (unsigned long)-1)
693 return -EINVAL;
694 r->start = port;
695 r->end = port + size - 1;
696 } else {
697 r->start = taddr;
698 r->end = taddr + size - 1;
699 }
700 r->flags = flags;
Benoit Cousson35f3da32011-12-05 15:23:55 +0100701 r->name = name ? name : dev->full_name;
702
Grant Likely1f5bef32010-06-08 07:48:09 -0600703 return 0;
704}
705
706/**
707 * of_address_to_resource - Translate device tree address and return as resource
708 *
709 * Note that if your address is a PIO address, the conversion will fail if
710 * the physical address can't be internally converted to an IO token with
Frank Rowand7602f422017-06-20 16:50:11 -0700711 * pci_address_to_pio(), that is because it's either called too early or it
Grant Likely1f5bef32010-06-08 07:48:09 -0600712 * can't be matched to any host bridge IO space
713 */
714int of_address_to_resource(struct device_node *dev, int index,
715 struct resource *r)
716{
Sebastian Andrzej Siewior0131d892010-12-01 10:54:46 +0100717 const __be32 *addrp;
Grant Likely1f5bef32010-06-08 07:48:09 -0600718 u64 size;
719 unsigned int flags;
Benoit Cousson35f3da32011-12-05 15:23:55 +0100720 const char *name = NULL;
Grant Likely1f5bef32010-06-08 07:48:09 -0600721
722 addrp = of_get_address(dev, index, &size, &flags);
723 if (addrp == NULL)
724 return -EINVAL;
Benoit Cousson35f3da32011-12-05 15:23:55 +0100725
726 /* Get optional "reg-names" property to add a name to a resource */
727 of_property_read_string_index(dev, "reg-names", index, &name);
728
729 return __of_address_to_resource(dev, addrp, size, flags, name, r);
Grant Likely1f5bef32010-06-08 07:48:09 -0600730}
731EXPORT_SYMBOL_GPL(of_address_to_resource);
732
Grant Likely90e33f62011-07-05 23:42:28 -0600733struct device_node *of_find_matching_node_by_address(struct device_node *from,
734 const struct of_device_id *matches,
735 u64 base_address)
736{
737 struct device_node *dn = of_find_matching_node(from, matches);
738 struct resource res;
739
740 while (dn) {
David Daney3a496b02015-08-19 13:17:47 -0700741 if (!of_address_to_resource(dn, 0, &res) &&
742 res.start == base_address)
Grant Likely90e33f62011-07-05 23:42:28 -0600743 return dn;
David Daney3a496b02015-08-19 13:17:47 -0700744
Grant Likely90e33f62011-07-05 23:42:28 -0600745 dn = of_find_matching_node(dn, matches);
746 }
747
748 return NULL;
749}
750
Grant Likely1f5bef32010-06-08 07:48:09 -0600751
Grant Likely6b884a82010-06-08 07:48:09 -0600752/**
753 * of_iomap - Maps the memory mapped IO for a given device_node
754 * @device: the device whose io range will be mapped
755 * @index: index of the io range
756 *
757 * Returns a pointer to the mapped memory
758 */
759void __iomem *of_iomap(struct device_node *np, int index)
760{
761 struct resource res;
762
763 if (of_address_to_resource(np, index, &res))
764 return NULL;
765
Felipe Balbi28c1b6d2011-07-22 22:47:21 +0300766 return ioremap(res.start, resource_size(&res));
Grant Likely6b884a82010-06-08 07:48:09 -0600767}
768EXPORT_SYMBOL(of_iomap);
Grygorii Strashko18308c92014-04-24 11:30:02 -0400769
Matthias Bruggerefd342f2014-07-18 11:36:39 +0200770/*
771 * of_io_request_and_map - Requests a resource and maps the memory mapped IO
772 * for a given device_node
773 * @device: the device whose io range will be mapped
774 * @index: index of the io range
775 * @name: name of the resource
776 *
777 * Returns a pointer to the requested and mapped memory or an ERR_PTR() encoded
778 * error code on failure. Usage example:
779 *
780 * base = of_io_request_and_map(node, 0, "foo");
781 * if (IS_ERR(base))
782 * return PTR_ERR(base);
783 */
784void __iomem *of_io_request_and_map(struct device_node *np, int index,
Matthias Bruggerb75b2762014-10-21 18:27:25 +0200785 const char *name)
Matthias Bruggerefd342f2014-07-18 11:36:39 +0200786{
787 struct resource res;
788 void __iomem *mem;
789
790 if (of_address_to_resource(np, index, &res))
791 return IOMEM_ERR_PTR(-EINVAL);
792
793 if (!request_mem_region(res.start, resource_size(&res), name))
794 return IOMEM_ERR_PTR(-EBUSY);
795
796 mem = ioremap(res.start, resource_size(&res));
797 if (!mem) {
798 release_mem_region(res.start, resource_size(&res));
799 return IOMEM_ERR_PTR(-ENOMEM);
800 }
801
802 return mem;
803}
804EXPORT_SYMBOL(of_io_request_and_map);
805
Grygorii Strashko18308c92014-04-24 11:30:02 -0400806/**
807 * of_dma_get_range - Get DMA range info
808 * @np: device node to get DMA range info
809 * @dma_addr: pointer to store initial DMA address of DMA range
810 * @paddr: pointer to store initial CPU address of DMA range
811 * @size: pointer to store size of DMA range
812 *
813 * Look in bottom up direction for the first "dma-ranges" property
814 * and parse it.
815 * dma-ranges format:
816 * DMA addr (dma_addr) : naddr cells
817 * CPU addr (phys_addr_t) : pna cells
818 * size : nsize cells
819 *
820 * It returns -ENODEV if "dma-ranges" property was not found
821 * for this device in DT.
822 */
823int of_dma_get_range(struct device_node *np, u64 *dma_addr, u64 *paddr, u64 *size)
824{
825 struct device_node *node = of_node_get(np);
826 const __be32 *ranges = NULL;
827 int len, naddr, nsize, pna;
828 int ret = 0;
829 u64 dmaaddr;
830
831 if (!node)
832 return -EINVAL;
833
834 while (1) {
835 naddr = of_n_addr_cells(node);
836 nsize = of_n_size_cells(node);
837 node = of_get_next_parent(node);
838 if (!node)
839 break;
840
841 ranges = of_get_property(node, "dma-ranges", &len);
842
843 /* Ignore empty ranges, they imply no translation required */
844 if (ranges && len > 0)
845 break;
846
847 /*
848 * At least empty ranges has to be defined for parent node if
849 * DMA is supported
850 */
851 if (!ranges)
852 break;
853 }
854
855 if (!ranges) {
Rob Herring0d638a02017-06-01 15:50:55 -0500856 pr_debug("no dma-ranges found for node(%pOF)\n", np);
Grygorii Strashko18308c92014-04-24 11:30:02 -0400857 ret = -ENODEV;
858 goto out;
859 }
860
861 len /= sizeof(u32);
862
863 pna = of_n_addr_cells(node);
864
865 /* dma-ranges format:
866 * DMA addr : naddr cells
867 * CPU addr : pna cells
868 * size : nsize cells
869 */
870 dmaaddr = of_read_number(ranges, naddr);
871 *paddr = of_translate_dma_address(np, ranges);
872 if (*paddr == OF_BAD_ADDR) {
Rob Herring0d638a02017-06-01 15:50:55 -0500873 pr_err("translation of DMA address(%pad) to CPU address failed node(%pOF)\n",
874 dma_addr, np);
Grygorii Strashko18308c92014-04-24 11:30:02 -0400875 ret = -EINVAL;
876 goto out;
877 }
878 *dma_addr = dmaaddr;
879
880 *size = of_read_number(ranges + naddr + pna, nsize);
881
882 pr_debug("dma_addr(%llx) cpu_addr(%llx) size(%llx)\n",
883 *dma_addr, *paddr, *size);
884
885out:
886 of_node_put(node);
887
888 return ret;
889}
890EXPORT_SYMBOL_GPL(of_dma_get_range);
Santosh Shilimkar92ea6372014-04-24 11:30:03 -0400891
892/**
893 * of_dma_is_coherent - Check if device is coherent
894 * @np: device node
895 *
896 * It returns true if "dma-coherent" property was found
897 * for this device in DT.
898 */
899bool of_dma_is_coherent(struct device_node *np)
900{
901 struct device_node *node = of_node_get(np);
902
903 while (node) {
904 if (of_property_read_bool(node, "dma-coherent")) {
905 of_node_put(node);
906 return true;
907 }
908 node = of_get_next_parent(node);
909 }
910 of_node_put(node);
911 return false;
912}
Linus Torvaldseb3d3ec2014-06-05 15:57:04 -0700913EXPORT_SYMBOL_GPL(of_dma_is_coherent);