xref: /linux-6.15/include/linux/of_address.h (revision db181ce0)
1 #ifndef __OF_ADDRESS_H
2 #define __OF_ADDRESS_H
3 #include <linux/ioport.h>
4 #include <linux/errno.h>
5 #include <linux/of.h>
6 
7 struct of_pci_range_parser {
8 	struct device_node *node;
9 	const __be32 *range;
10 	const __be32 *end;
11 	int np;
12 	int pna;
13 };
14 
15 struct of_pci_range {
16 	u32 pci_space;
17 	u64 pci_addr;
18 	u64 cpu_addr;
19 	u64 size;
20 	u32 flags;
21 };
22 
23 #define for_each_of_pci_range(parser, range) \
24 	for (; of_pci_range_parser_one(parser, range);)
25 
26 static inline void of_pci_range_to_resource(struct of_pci_range *range,
27 					    struct device_node *np,
28 					    struct resource *res)
29 {
30 	res->flags = range->flags;
31 	res->start = range->cpu_addr;
32 	res->end = range->cpu_addr + range->size - 1;
33 	res->parent = res->child = res->sibling = NULL;
34 	res->name = np->full_name;
35 }
36 
37 /* Translate a DMA address from device space to CPU space */
38 extern u64 of_translate_dma_address(struct device_node *dev,
39 				    const __be32 *in_addr);
40 
41 #ifdef CONFIG_OF_ADDRESS
42 extern u64 of_translate_address(struct device_node *np, const __be32 *addr);
43 extern int of_address_to_resource(struct device_node *dev, int index,
44 				  struct resource *r);
45 extern struct device_node *of_find_matching_node_by_address(
46 					struct device_node *from,
47 					const struct of_device_id *matches,
48 					u64 base_address);
49 extern void __iomem *of_iomap(struct device_node *device, int index);
50 
51 /* Extract an address from a device, returns the region size and
52  * the address space flags too. The PCI version uses a BAR number
53  * instead of an absolute index
54  */
55 extern const __be32 *of_get_address(struct device_node *dev, int index,
56 			   u64 *size, unsigned int *flags);
57 
58 extern unsigned long pci_address_to_pio(phys_addr_t addr);
59 
60 extern int of_pci_range_parser_init(struct of_pci_range_parser *parser,
61 			struct device_node *node);
62 extern struct of_pci_range *of_pci_range_parser_one(
63 					struct of_pci_range_parser *parser,
64 					struct of_pci_range *range);
65 extern int of_dma_get_range(struct device_node *np, u64 *dma_addr,
66 				u64 *paddr, u64 *size);
67 extern bool of_dma_is_coherent(struct device_node *np);
68 #else /* CONFIG_OF_ADDRESS */
69 static inline struct device_node *of_find_matching_node_by_address(
70 					struct device_node *from,
71 					const struct of_device_id *matches,
72 					u64 base_address)
73 {
74 	return NULL;
75 }
76 
77 static inline const __be32 *of_get_address(struct device_node *dev, int index,
78 					u64 *size, unsigned int *flags)
79 {
80 	return NULL;
81 }
82 
83 static inline int of_pci_range_parser_init(struct of_pci_range_parser *parser,
84 			struct device_node *node)
85 {
86 	return -1;
87 }
88 
89 static inline struct of_pci_range *of_pci_range_parser_one(
90 					struct of_pci_range_parser *parser,
91 					struct of_pci_range *range)
92 {
93 	return NULL;
94 }
95 
96 static inline int of_dma_get_range(struct device_node *np, u64 *dma_addr,
97 				u64 *paddr, u64 *size)
98 {
99 	return -ENODEV;
100 }
101 
102 static inline bool of_dma_is_coherent(struct device_node *np)
103 {
104 	return false;
105 }
106 #endif /* CONFIG_OF_ADDRESS */
107 
108 #ifdef CONFIG_OF
109 extern int of_address_to_resource(struct device_node *dev, int index,
110 				  struct resource *r);
111 void __iomem *of_iomap(struct device_node *node, int index);
112 #else
113 static inline int of_address_to_resource(struct device_node *dev, int index,
114 					 struct resource *r)
115 {
116 	return -EINVAL;
117 }
118 
119 static inline void __iomem *of_iomap(struct device_node *device, int index)
120 {
121 	return NULL;
122 }
123 #endif
124 
125 #if defined(CONFIG_OF_ADDRESS) && defined(CONFIG_PCI)
126 extern const __be32 *of_get_pci_address(struct device_node *dev, int bar_no,
127 			       u64 *size, unsigned int *flags);
128 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
129 				      struct resource *r);
130 #else /* CONFIG_OF_ADDRESS && CONFIG_PCI */
131 static inline int of_pci_address_to_resource(struct device_node *dev, int bar,
132 				             struct resource *r)
133 {
134 	return -ENOSYS;
135 }
136 
137 static inline const __be32 *of_get_pci_address(struct device_node *dev,
138 		int bar_no, u64 *size, unsigned int *flags)
139 {
140 	return NULL;
141 }
142 #endif /* CONFIG_OF_ADDRESS && CONFIG_PCI */
143 
144 #endif /* __OF_ADDRESS_H */
145 
146