xref: /linux-6.15/include/linux/of.h (revision 44b24b74) 
1 #ifndef _LINUX_OF_H
2 #define _LINUX_OF_H
3 /*
4  * Definitions for talking to the Open Firmware PROM on
5  * Power Macintosh and other computers.
6  *
7  * Copyright (C) 1996-2005 Paul Mackerras.
8  *
9  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
10  * Updates for SPARC64 by David S. Miller
11  * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version
16  * 2 of the License, or (at your option) any later version.
17  */
18 #include <linux/types.h>
19 #include <linux/bitops.h>
20 #include <linux/errno.h>
21 #include <linux/kref.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/spinlock.h>
24 
25 #include <asm/byteorder.h>
26 #include <asm/errno.h>
27 
28 typedef u32 phandle;
29 typedef u32 ihandle;
30 
31 struct property {
32 	char	*name;
33 	int	length;
34 	void	*value;
35 	struct property *next;
36 	unsigned long _flags;
37 	unsigned int unique_id;
38 };
39 
40 #if defined(CONFIG_SPARC)
41 struct of_irq_controller;
42 #endif
43 
44 struct device_node {
45 	const char *name;
46 	const char *type;
47 	phandle phandle;
48 	char	*full_name;
49 
50 	struct	property *properties;
51 	struct	property *deadprops;	/* removed properties */
52 	struct	device_node *parent;
53 	struct	device_node *child;
54 	struct	device_node *sibling;
55 	struct	device_node *next;	/* next device of same type */
56 	struct	device_node *allnext;	/* next in list of all nodes */
57 	struct	proc_dir_entry *pde;	/* this node's proc directory */
58 	struct	kref kref;
59 	unsigned long _flags;
60 	void	*data;
61 #if defined(CONFIG_EEH)
62 	struct eeh_dev *edev;
63 #endif
64 #if defined(CONFIG_SPARC)
65 	char	*path_component_name;
66 	unsigned int unique_id;
67 	struct of_irq_controller *irq_trans;
68 #endif
69 };
70 
71 #define MAX_PHANDLE_ARGS 8
72 struct of_phandle_args {
73 	struct device_node *np;
74 	int args_count;
75 	uint32_t args[MAX_PHANDLE_ARGS];
76 };
77 
78 #if defined(CONFIG_EEH)
79 static inline struct eeh_dev *of_node_to_eeh_dev(struct device_node *dn)
80 {
81 	return dn->edev;
82 }
83 #endif
84 
85 #if defined(CONFIG_SPARC) || !defined(CONFIG_OF)
86 /* Dummy ref counting routines - to be implemented later */
87 static inline struct device_node *of_node_get(struct device_node *node)
88 {
89 	return node;
90 }
91 static inline void of_node_put(struct device_node *node)
92 {
93 }
94 #else
95 extern struct device_node *of_node_get(struct device_node *node);
96 extern void of_node_put(struct device_node *node);
97 #endif
98 
99 #ifdef CONFIG_OF
100 
101 /* Pointer for first entry in chain of all nodes. */
102 extern struct device_node *allnodes;
103 extern struct device_node *of_chosen;
104 extern struct device_node *of_aliases;
105 extern rwlock_t devtree_lock;
106 
107 static inline bool of_have_populated_dt(void)
108 {
109 	return allnodes != NULL;
110 }
111 
112 static inline bool of_node_is_root(const struct device_node *node)
113 {
114 	return node && (node->parent == NULL);
115 }
116 
117 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
118 {
119 	return test_bit(flag, &n->_flags);
120 }
121 
122 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
123 {
124 	set_bit(flag, &n->_flags);
125 }
126 
127 extern struct device_node *of_find_all_nodes(struct device_node *prev);
128 
129 /*
130  * OF address retrieval & translation
131  */
132 
133 /* Helper to read a big number; size is in cells (not bytes) */
134 static inline u64 of_read_number(const __be32 *cell, int size)
135 {
136 	u64 r = 0;
137 	while (size--)
138 		r = (r << 32) | be32_to_cpu(*(cell++));
139 	return r;
140 }
141 
142 /* Like of_read_number, but we want an unsigned long result */
143 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
144 {
145 	/* toss away upper bits if unsigned long is smaller than u64 */
146 	return of_read_number(cell, size);
147 }
148 
149 #include <asm/prom.h>
150 
151 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
152 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
153 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
154 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
155 #endif
156 
157 /* Default string compare functions, Allow arch asm/prom.h to override */
158 #if !defined(of_compat_cmp)
159 #define of_compat_cmp(s1, s2, l)	strcasecmp((s1), (s2))
160 #define of_prop_cmp(s1, s2)		strcmp((s1), (s2))
161 #define of_node_cmp(s1, s2)		strcasecmp((s1), (s2))
162 #endif
163 
164 /* flag descriptions */
165 #define OF_DYNAMIC	1 /* node and properties were allocated via kmalloc */
166 #define OF_DETACHED	2 /* node has been detached from the device tree */
167 
168 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
169 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
170 
171 #define OF_BAD_ADDR	((u64)-1)
172 
173 #ifndef of_node_to_nid
174 static inline int of_node_to_nid(struct device_node *np) { return -1; }
175 #define of_node_to_nid of_node_to_nid
176 #endif
177 
178 extern struct device_node *of_find_node_by_name(struct device_node *from,
179 	const char *name);
180 #define for_each_node_by_name(dn, name) \
181 	for (dn = of_find_node_by_name(NULL, name); dn; \
182 	     dn = of_find_node_by_name(dn, name))
183 extern struct device_node *of_find_node_by_type(struct device_node *from,
184 	const char *type);
185 #define for_each_node_by_type(dn, type) \
186 	for (dn = of_find_node_by_type(NULL, type); dn; \
187 	     dn = of_find_node_by_type(dn, type))
188 extern struct device_node *of_find_compatible_node(struct device_node *from,
189 	const char *type, const char *compat);
190 #define for_each_compatible_node(dn, type, compatible) \
191 	for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
192 	     dn = of_find_compatible_node(dn, type, compatible))
193 extern struct device_node *of_find_matching_node(struct device_node *from,
194 	const struct of_device_id *matches);
195 #define for_each_matching_node(dn, matches) \
196 	for (dn = of_find_matching_node(NULL, matches); dn; \
197 	     dn = of_find_matching_node(dn, matches))
198 extern struct device_node *of_find_node_by_path(const char *path);
199 extern struct device_node *of_find_node_by_phandle(phandle handle);
200 extern struct device_node *of_get_parent(const struct device_node *node);
201 extern struct device_node *of_get_next_parent(struct device_node *node);
202 extern struct device_node *of_get_next_child(const struct device_node *node,
203 					     struct device_node *prev);
204 #define for_each_child_of_node(parent, child) \
205 	for (child = of_get_next_child(parent, NULL); child != NULL; \
206 	     child = of_get_next_child(parent, child))
207 
208 extern struct device_node *of_find_node_with_property(
209 	struct device_node *from, const char *prop_name);
210 #define for_each_node_with_property(dn, prop_name) \
211 	for (dn = of_find_node_with_property(NULL, prop_name); dn; \
212 	     dn = of_find_node_with_property(dn, prop_name))
213 
214 extern struct property *of_find_property(const struct device_node *np,
215 					 const char *name,
216 					 int *lenp);
217 extern int of_property_read_u32_array(const struct device_node *np,
218 				      const char *propname,
219 				      u32 *out_values,
220 				      size_t sz);
221 extern int of_property_read_u64(const struct device_node *np,
222 				const char *propname, u64 *out_value);
223 
224 extern int of_property_read_string(struct device_node *np,
225 				   const char *propname,
226 				   const char **out_string);
227 extern int of_property_read_string_index(struct device_node *np,
228 					 const char *propname,
229 					 int index, const char **output);
230 extern int of_property_count_strings(struct device_node *np,
231 				     const char *propname);
232 extern int of_device_is_compatible(const struct device_node *device,
233 				   const char *);
234 extern int of_device_is_available(const struct device_node *device);
235 extern const void *of_get_property(const struct device_node *node,
236 				const char *name,
237 				int *lenp);
238 #define for_each_property_of_node(dn, pp) \
239 	for (pp = dn->properties; pp != NULL; pp = pp->next)
240 
241 extern int of_n_addr_cells(struct device_node *np);
242 extern int of_n_size_cells(struct device_node *np);
243 extern const struct of_device_id *of_match_node(
244 	const struct of_device_id *matches, const struct device_node *node);
245 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
246 extern struct device_node *of_parse_phandle(struct device_node *np,
247 					    const char *phandle_name,
248 					    int index);
249 extern int of_parse_phandle_with_args(struct device_node *np,
250 	const char *list_name, const char *cells_name, int index,
251 	struct of_phandle_args *out_args);
252 
253 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
254 extern int of_alias_get_id(struct device_node *np, const char *stem);
255 
256 extern int of_machine_is_compatible(const char *compat);
257 
258 extern int prom_add_property(struct device_node* np, struct property* prop);
259 extern int prom_remove_property(struct device_node *np, struct property *prop);
260 extern int prom_update_property(struct device_node *np,
261 				struct property *newprop,
262 				struct property *oldprop);
263 
264 #if defined(CONFIG_OF_DYNAMIC)
265 /* For updating the device tree at runtime */
266 extern void of_attach_node(struct device_node *);
267 extern void of_detach_node(struct device_node *);
268 #endif
269 
270 #define of_match_ptr(_ptr)	(_ptr)
271 #else /* CONFIG_OF */
272 
273 static inline bool of_have_populated_dt(void)
274 {
275 	return false;
276 }
277 
278 #define for_each_child_of_node(parent, child) \
279 	while (0)
280 
281 static inline int of_device_is_compatible(const struct device_node *device,
282 					  const char *name)
283 {
284 	return 0;
285 }
286 
287 static inline struct property *of_find_property(const struct device_node *np,
288 						const char *name,
289 						int *lenp)
290 {
291 	return NULL;
292 }
293 
294 static inline int of_property_read_u32_array(const struct device_node *np,
295 					     const char *propname,
296 					     u32 *out_values, size_t sz)
297 {
298 	return -ENOSYS;
299 }
300 
301 static inline int of_property_read_string(struct device_node *np,
302 					  const char *propname,
303 					  const char **out_string)
304 {
305 	return -ENOSYS;
306 }
307 
308 static inline int of_property_read_string_index(struct device_node *np,
309 						const char *propname, int index,
310 						const char **out_string)
311 {
312 	return -ENOSYS;
313 }
314 
315 static inline int of_property_count_strings(struct device_node *np,
316 					    const char *propname)
317 {
318 	return -ENOSYS;
319 }
320 
321 static inline const void *of_get_property(const struct device_node *node,
322 				const char *name,
323 				int *lenp)
324 {
325 	return NULL;
326 }
327 
328 static inline int of_property_read_u64(const struct device_node *np,
329 				       const char *propname, u64 *out_value)
330 {
331 	return -ENOSYS;
332 }
333 
334 static inline struct device_node *of_parse_phandle(struct device_node *np,
335 						   const char *phandle_name,
336 						   int index)
337 {
338 	return NULL;
339 }
340 
341 static inline int of_alias_get_id(struct device_node *np, const char *stem)
342 {
343 	return -ENOSYS;
344 }
345 
346 static inline int of_machine_is_compatible(const char *compat)
347 {
348 	return 0;
349 }
350 
351 #define of_match_ptr(_ptr)	NULL
352 #define of_match_node(_matches, _node)	NULL
353 #endif /* CONFIG_OF */
354 
355 static inline int of_property_read_u32(const struct device_node *np,
356 				       const char *propname,
357 				       u32 *out_value)
358 {
359 	return of_property_read_u32_array(np, propname, out_value, 1);
360 }
361 
362 #endif /* _LINUX_OF_H */
363