]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/linux/of.h
devicetree: add helper inline for retrieving a node's full name
[mirror_ubuntu-focal-kernel.git] / include / linux / of.h
CommitLineData
76c1ce78
SR
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>
1977f032 19#include <linux/bitops.h>
e51130c0 20#include <linux/errno.h>
6f192492 21#include <linux/kref.h>
283029d1 22#include <linux/mod_devicetable.h>
0d351c3e 23#include <linux/spinlock.h>
76c1ce78 24
2e89e685 25#include <asm/byteorder.h>
d0a99402 26#include <asm/errno.h>
2e89e685 27
731581e6
GL
28typedef u32 phandle;
29typedef u32 ihandle;
30
31struct 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
6f192492
GL
40#if defined(CONFIG_SPARC)
41struct of_irq_controller;
42#endif
43
44struct device_node {
45 const char *name;
46 const char *type;
6016a363 47 phandle phandle;
6f192492
GL
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_SPARC)
62 char *path_component_name;
63 unsigned int unique_id;
64 struct of_irq_controller *irq_trans;
65#endif
66};
67
15c9a0ac
GL
68#define MAX_PHANDLE_ARGS 8
69struct of_phandle_args {
70 struct device_node *np;
71 int args_count;
72 uint32_t args[MAX_PHANDLE_ARGS];
73};
74
0f22dd39
GL
75#ifdef CONFIG_OF_DYNAMIC
76extern struct device_node *of_node_get(struct device_node *node);
77extern void of_node_put(struct device_node *node);
78#else /* CONFIG_OF_DYNAMIC */
3ecdd051
RH
79/* Dummy ref counting routines - to be implemented later */
80static inline struct device_node *of_node_get(struct device_node *node)
81{
82 return node;
83}
0f22dd39
GL
84static inline void of_node_put(struct device_node *node) { }
85#endif /* !CONFIG_OF_DYNAMIC */
3ecdd051 86
c9e358df
GL
87#ifdef CONFIG_OF
88
41f88009
GL
89/* Pointer for first entry in chain of all nodes. */
90extern struct device_node *allnodes;
fc0bdae4 91extern struct device_node *of_chosen;
611cad72 92extern struct device_node *of_aliases;
0d351c3e 93extern rwlock_t devtree_lock;
41f88009 94
3bcbaf6e
SAS
95static inline bool of_have_populated_dt(void)
96{
97 return allnodes != NULL;
98}
99
035ebefc
AS
100static inline bool of_node_is_root(const struct device_node *node)
101{
102 return node && (node->parent == NULL);
103}
104
50436312
GL
105static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
106{
107 return test_bit(flag, &n->_flags);
108}
109
110static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
111{
112 set_bit(flag, &n->_flags);
113}
114
e91edcf5
GL
115extern struct device_node *of_find_all_nodes(struct device_node *prev);
116
b6caf2ad 117/*
3d6b8828 118 * OF address retrieval & translation
b6caf2ad
GL
119 */
120
121/* Helper to read a big number; size is in cells (not bytes) */
2e89e685 122static inline u64 of_read_number(const __be32 *cell, int size)
b6caf2ad
GL
123{
124 u64 r = 0;
125 while (size--)
2e89e685 126 r = (r << 32) | be32_to_cpu(*(cell++));
b6caf2ad
GL
127 return r;
128}
129
130/* Like of_read_number, but we want an unsigned long result */
2e89e685 131static inline unsigned long of_read_ulong(const __be32 *cell, int size)
b6caf2ad 132{
2be09cb9
GL
133 /* toss away upper bits if unsigned long is smaller than u64 */
134 return of_read_number(cell, size);
b6caf2ad 135}
b6caf2ad 136
76c1ce78
SR
137#include <asm/prom.h>
138
7c7b60cb
GL
139/* Default #address and #size cells. Allow arch asm/prom.h to override */
140#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
141#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
142#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
143#endif
144
145/* Default string compare functions, Allow arch asm/prom.h to override */
146#if !defined(of_compat_cmp)
1976152f 147#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
7c7b60cb
GL
148#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
149#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
150#endif
151
76c1ce78
SR
152/* flag descriptions */
153#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
154#define OF_DETACHED 2 /* node has been detached from the device tree */
155
61e955db
GL
156#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
157#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
158
76c1ce78
SR
159#define OF_BAD_ADDR ((u64)-1)
160
559e2b7e
GL
161#ifndef of_node_to_nid
162static inline int of_node_to_nid(struct device_node *np) { return -1; }
163#define of_node_to_nid of_node_to_nid
164#endif
165
efd68e72
GL
166static inline const char* of_node_full_name(struct device_node *np)
167{
168 return np ? np->full_name : "<no-node>";
169}
170
76c1ce78
SR
171extern struct device_node *of_find_node_by_name(struct device_node *from,
172 const char *name);
173#define for_each_node_by_name(dn, name) \
174 for (dn = of_find_node_by_name(NULL, name); dn; \
175 dn = of_find_node_by_name(dn, name))
176extern struct device_node *of_find_node_by_type(struct device_node *from,
177 const char *type);
178#define for_each_node_by_type(dn, type) \
179 for (dn = of_find_node_by_type(NULL, type); dn; \
180 dn = of_find_node_by_type(dn, type))
181extern struct device_node *of_find_compatible_node(struct device_node *from,
182 const char *type, const char *compat);
183#define for_each_compatible_node(dn, type, compatible) \
184 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
185 dn = of_find_compatible_node(dn, type, compatible))
283029d1
GL
186extern struct device_node *of_find_matching_node(struct device_node *from,
187 const struct of_device_id *matches);
188#define for_each_matching_node(dn, matches) \
189 for (dn = of_find_matching_node(NULL, matches); dn; \
190 dn = of_find_matching_node(dn, matches))
76c1ce78
SR
191extern struct device_node *of_find_node_by_path(const char *path);
192extern struct device_node *of_find_node_by_phandle(phandle handle);
193extern struct device_node *of_get_parent(const struct device_node *node);
f4eb0107 194extern struct device_node *of_get_next_parent(struct device_node *node);
76c1ce78
SR
195extern struct device_node *of_get_next_child(const struct device_node *node,
196 struct device_node *prev);
aabc08dc
ME
197#define for_each_child_of_node(parent, child) \
198 for (child = of_get_next_child(parent, NULL); child != NULL; \
199 child = of_get_next_child(parent, child))
200
183f1d0c
DA
201static inline int of_get_child_count(const struct device_node *np)
202{
203 struct device_node *child;
204 int num = 0;
205
206 for_each_child_of_node(np, child)
207 num++;
208
209 return num;
210}
211
1e291b14
ME
212extern struct device_node *of_find_node_with_property(
213 struct device_node *from, const char *prop_name);
214#define for_each_node_with_property(dn, prop_name) \
215 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
216 dn = of_find_node_with_property(dn, prop_name))
217
76c1ce78
SR
218extern struct property *of_find_property(const struct device_node *np,
219 const char *name,
220 int *lenp);
0e373639 221extern int of_property_read_u32_array(const struct device_node *np,
aac285c6 222 const char *propname,
0e373639
RH
223 u32 *out_values,
224 size_t sz);
4cd7f7a3
JI
225extern int of_property_read_u64(const struct device_node *np,
226 const char *propname, u64 *out_value);
0e373639 227
aac285c6
JI
228extern int of_property_read_string(struct device_node *np,
229 const char *propname,
230 const char **out_string);
4fcd15a0
BC
231extern int of_property_read_string_index(struct device_node *np,
232 const char *propname,
233 int index, const char **output);
7aff0fe3
GL
234extern int of_property_match_string(struct device_node *np,
235 const char *propname,
236 const char *string);
4fcd15a0
BC
237extern int of_property_count_strings(struct device_node *np,
238 const char *propname);
76c1ce78
SR
239extern int of_device_is_compatible(const struct device_node *device,
240 const char *);
834d97d4 241extern int of_device_is_available(const struct device_node *device);
76c1ce78
SR
242extern const void *of_get_property(const struct device_node *node,
243 const char *name,
244 int *lenp);
8af0da93
DA
245#define for_each_property_of_node(dn, pp) \
246 for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72 247
76c1ce78
SR
248extern int of_n_addr_cells(struct device_node *np);
249extern int of_n_size_cells(struct device_node *np);
283029d1
GL
250extern const struct of_device_id *of_match_node(
251 const struct of_device_id *matches, const struct device_node *node);
3f07af49 252extern int of_modalias_node(struct device_node *node, char *modalias, int len);
739649c5
GL
253extern struct device_node *of_parse_phandle(struct device_node *np,
254 const char *phandle_name,
255 int index);
15c9a0ac 256extern int of_parse_phandle_with_args(struct device_node *np,
64b60e09 257 const char *list_name, const char *cells_name, int index,
15c9a0ac 258 struct of_phandle_args *out_args);
76c1ce78 259
611cad72
SG
260extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
261extern int of_alias_get_id(struct device_node *np, const char *stem);
262
21b082ec
GL
263extern int of_machine_is_compatible(const char *compat);
264
265extern int prom_add_property(struct device_node* np, struct property* prop);
266extern int prom_remove_property(struct device_node *np, struct property *prop);
267extern int prom_update_property(struct device_node *np,
268 struct property *newprop,
269 struct property *oldprop);
270
fcdeb7fe
GL
271#if defined(CONFIG_OF_DYNAMIC)
272/* For updating the device tree at runtime */
273extern void of_attach_node(struct device_node *);
274extern void of_detach_node(struct device_node *);
275#endif
276
3a1e362e 277#define of_match_ptr(_ptr) (_ptr)
c541adc6
SW
278
279/*
280 * struct property *prop;
281 * const __be32 *p;
282 * u32 u;
283 *
284 * of_property_for_each_u32(np, "propname", prop, p, u)
285 * printk("U32 value: %x\n", u);
286 */
287const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
288 u32 *pu);
289#define of_property_for_each_u32(np, propname, prop, p, u) \
290 for (prop = of_find_property(np, propname, NULL), \
291 p = of_prop_next_u32(prop, NULL, &u); \
292 p; \
293 p = of_prop_next_u32(prop, p, &u))
294
295/*
296 * struct property *prop;
297 * const char *s;
298 *
299 * of_property_for_each_string(np, "propname", prop, s)
300 * printk("String value: %s\n", s);
301 */
302const char *of_prop_next_string(struct property *prop, const char *cur);
303#define of_property_for_each_string(np, propname, prop, s) \
304 for (prop = of_find_property(np, propname, NULL), \
305 s = of_prop_next_string(prop, NULL); \
306 s; \
307 s = of_prop_next_string(prop, s))
308
b98c0239 309#else /* CONFIG_OF */
3bcbaf6e 310
efd68e72
GL
311static inline const char* of_node_full_name(struct device_node *np)
312{
313 return "<no-node>";
314}
315
3bcbaf6e
SAS
316static inline bool of_have_populated_dt(void)
317{
318 return false;
319}
320
aba3dfff
SW
321#define for_each_child_of_node(parent, child) \
322 while (0)
323
183f1d0c
DA
324static inline int of_get_child_count(const struct device_node *np)
325{
326 return 0;
327}
328
36a0904e
RN
329static inline int of_device_is_compatible(const struct device_node *device,
330 const char *name)
331{
332 return 0;
333}
334
aba3dfff
SW
335static inline struct property *of_find_property(const struct device_node *np,
336 const char *name,
337 int *lenp)
338{
339 return NULL;
340}
341
2261cc62
SG
342static inline struct device_node *of_find_compatible_node(
343 struct device_node *from,
344 const char *type,
345 const char *compat)
346{
347 return NULL;
348}
349
b98c0239 350static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6
JI
351 const char *propname,
352 u32 *out_values, size_t sz)
b98c0239
SG
353{
354 return -ENOSYS;
355}
356
357static inline int of_property_read_string(struct device_node *np,
aac285c6
JI
358 const char *propname,
359 const char **out_string)
b98c0239
SG
360{
361 return -ENOSYS;
362}
363
4fcd15a0
BC
364static inline int of_property_read_string_index(struct device_node *np,
365 const char *propname, int index,
366 const char **out_string)
367{
368 return -ENOSYS;
369}
370
371static inline int of_property_count_strings(struct device_node *np,
372 const char *propname)
373{
374 return -ENOSYS;
375}
376
89272b8c
SW
377static inline const void *of_get_property(const struct device_node *node,
378 const char *name,
379 int *lenp)
380{
381 return NULL;
382}
383
4cd7f7a3
JI
384static inline int of_property_read_u64(const struct device_node *np,
385 const char *propname, u64 *out_value)
386{
387 return -ENOSYS;
388}
389
36a0904e
RN
390static inline struct device_node *of_parse_phandle(struct device_node *np,
391 const char *phandle_name,
392 int index)
393{
394 return NULL;
395}
396
ed5f886d
NF
397static inline int of_alias_get_id(struct device_node *np, const char *stem)
398{
399 return -ENOSYS;
400}
401
50e07f88
SW
402static inline int of_machine_is_compatible(const char *compat)
403{
404 return 0;
405}
406
3a1e362e 407#define of_match_ptr(_ptr) NULL
5762c205 408#define of_match_node(_matches, _node) NULL
c541adc6
SW
409#define of_property_for_each_u32(np, propname, prop, p, u) \
410 while (0)
411#define of_property_for_each_string(np, propname, prop, s) \
412 while (0)
9dfbf207 413#endif /* CONFIG_OF */
b98c0239 414
fa4d34cc
JCPV
415/**
416 * of_property_read_bool - Findfrom a property
417 * @np: device node from which the property value is to be read.
418 * @propname: name of the property to be searched.
419 *
420 * Search for a property in a device node.
421 * Returns true if the property exist false otherwise.
422 */
423static inline bool of_property_read_bool(const struct device_node *np,
424 const char *propname)
425{
426 struct property *prop = of_find_property(np, propname, NULL);
427
428 return prop ? true : false;
429}
430
b98c0239 431static inline int of_property_read_u32(const struct device_node *np,
aac285c6 432 const char *propname,
b98c0239
SG
433 u32 *out_value)
434{
435 return of_property_read_u32_array(np, propname, out_value, 1);
436}
437
76c1ce78 438#endif /* _LINUX_OF_H */