blob: 3fa1ffce81a69587893e1af0f0547bc52ef51b4e [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass38d21b42017-05-18 20:08:59 -06002/*
3 * Taken from Linux v4.9 drivers/of/address.c
4 *
5 * Modified for U-Boot
6 * Copyright (c) 2017 Google, Inc
Simon Glass38d21b42017-05-18 20:08:59 -06007 */
8
9#ifndef _DM_OF_ADDR_H
10#define _DM_OF_ADDR_H
11
12/**
13 * of_translate_address() - translate a device-tree address to a CPU address
14 *
15 * Translate an address from the device-tree into a CPU physical address,
16 * this walks up the tree and applies the various bus mappings on the way.
17 *
18 * Note: We consider that crossing any level with #size-cells == 0 to mean
19 * that translation is impossible (that is we are not dealing with a value
20 * that can be mapped to a cpu physical address). This is not really specified
21 * that way, but this is traditionally the way IBM at least do things
22 *
23 * @np: node to check
24 * @in_addr: pointer to input address
25 * @return translated address or OF_BAD_ADDR on error
26 */
27u64 of_translate_address(const struct device_node *no, const __be32 *in_addr);
28
29/**
Fabien Dessenne641067f2019-05-31 15:11:30 +020030 * of_translate_dma_address() - translate a device-tree DMA address to a CPU
31 * address
32 *
33 * Translate a DMA address from the device-tree into a CPU physical address,
34 * this walks up the tree and applies the various bus mappings on the way.
35 *
36 * Note: We consider that crossing any level with #size-cells == 0 to mean
37 * that translation is impossible (that is we are not dealing with a value
38 * that can be mapped to a cpu physical address). This is not really specified
39 * that way, but this is traditionally the way IBM at least do things
40 *
41 * @np: node to check
42 * @in_addr: pointer to input DMA address
43 * @return translated DMA address or OF_BAD_ADDR on error
44 */
45u64 of_translate_dma_address(const struct device_node *no, const __be32 *in_addr);
46
47/**
Simon Glass38d21b42017-05-18 20:08:59 -060048 * of_get_address() - obtain an address from a node
49 *
50 * Extract an address from a node, returns the region size and the address
51 * space flags too. The PCI version uses a BAR number instead of an absolute
52 * index.
53 *
54 * @np: Node to check
55 * @index: Index of address to read (0 = first)
56 * @size: place to put size on success
57 * @flags: place to put flags on success
58 * @return pointer to address which can be read
59 */
60const __be32 *of_get_address(const struct device_node *no, int index,
61 u64 *size, unsigned int *flags);
62
63struct resource;
64
65/**
66 * of_address_to_resource() - translate device tree address to resource
67 *
68 * Note that if your address is a PIO address, the conversion will fail if
69 * the physical address can't be internally converted to an IO token with
70 * pci_address_to_pio(), that is because it's either called to early or it
71 * can't be matched to any host bridge IO space
72 *
73 * @np: node to check
74 * @index: index of address to read (0 = first)
75 * @r: place to put resource information
76 * @return 0 if OK, -ve on error
77 */
78int of_address_to_resource(const struct device_node *no, int index,
79 struct resource *r);
80
81#endif