]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/linux/of.h
Merge remote-tracking branches 'asoc/topic/tas571x', 'asoc/topic/tlv320aic31xx',...
[mirror_ubuntu-eoan-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>
75b57ecf 21#include <linux/kobject.h>
283029d1 22#include <linux/mod_devicetable.h>
0d351c3e 23#include <linux/spinlock.h>
5ca4db61 24#include <linux/topology.h>
1cf3d8b3 25#include <linux/notifier.h>
b31384fa 26#include <linux/property.h>
7518b589 27#include <linux/list.h>
76c1ce78 28
2e89e685 29#include <asm/byteorder.h>
d0a99402 30#include <asm/errno.h>
2e89e685 31
731581e6
GL
32typedef u32 phandle;
33typedef u32 ihandle;
34
35struct property {
36 char *name;
37 int length;
38 void *value;
39 struct property *next;
40 unsigned long _flags;
41 unsigned int unique_id;
75b57ecf 42 struct bin_attribute attr;
731581e6
GL
43};
44
6f192492
GL
45#if defined(CONFIG_SPARC)
46struct of_irq_controller;
47#endif
48
49struct device_node {
50 const char *name;
51 const char *type;
6016a363 52 phandle phandle;
c22618a1 53 const char *full_name;
8a0662d9 54 struct fwnode_handle fwnode;
6f192492
GL
55
56 struct property *properties;
57 struct property *deadprops; /* removed properties */
58 struct device_node *parent;
59 struct device_node *child;
60 struct device_node *sibling;
75b57ecf 61 struct kobject kobj;
6f192492
GL
62 unsigned long _flags;
63 void *data;
64#if defined(CONFIG_SPARC)
c22618a1 65 const char *path_component_name;
6f192492
GL
66 unsigned int unique_id;
67 struct of_irq_controller *irq_trans;
68#endif
69};
70
b66548e2 71#define MAX_PHANDLE_ARGS 16
15c9a0ac
GL
72struct of_phandle_args {
73 struct device_node *np;
74 int args_count;
75 uint32_t args[MAX_PHANDLE_ARGS];
76};
77
74e1fbb1
JR
78struct of_phandle_iterator {
79 /* Common iterator information */
80 const char *cells_name;
81 int cell_count;
82 const struct device_node *parent;
83
84 /* List size information */
85 const __be32 *list_end;
86 const __be32 *phandle_end;
87
88 /* Current position state */
89 const __be32 *cur;
90 uint32_t cur_count;
91 phandle phandle;
92 struct device_node *node;
93};
94
f5242e5a
GL
95struct of_reconfig_data {
96 struct device_node *dn;
97 struct property *prop;
98 struct property *old_prop;
99};
100
0829f6d1
PA
101/* initialize a node */
102extern struct kobj_type of_node_ktype;
103static inline void of_node_init(struct device_node *node)
104{
105 kobject_init(&node->kobj, &of_node_ktype);
8a0662d9 106 node->fwnode.type = FWNODE_OF;
0829f6d1
PA
107}
108
109/* true when node is initialized */
110static inline int of_node_is_initialized(struct device_node *node)
111{
112 return node && node->kobj.state_initialized;
113}
114
115/* true when node is attached (i.e. present on sysfs) */
116static inline int of_node_is_attached(struct device_node *node)
117{
118 return node && node->kobj.state_in_sysfs;
119}
120
0f22dd39
GL
121#ifdef CONFIG_OF_DYNAMIC
122extern struct device_node *of_node_get(struct device_node *node);
123extern void of_node_put(struct device_node *node);
124#else /* CONFIG_OF_DYNAMIC */
3ecdd051
RH
125/* Dummy ref counting routines - to be implemented later */
126static inline struct device_node *of_node_get(struct device_node *node)
127{
128 return node;
129}
0f22dd39
GL
130static inline void of_node_put(struct device_node *node) { }
131#endif /* !CONFIG_OF_DYNAMIC */
3ecdd051 132
41f88009 133/* Pointer for first entry in chain of all nodes. */
5063e25a 134extern struct device_node *of_root;
fc0bdae4 135extern struct device_node *of_chosen;
611cad72 136extern struct device_node *of_aliases;
a752ee56 137extern struct device_node *of_stdout;
d6d3c4e6 138extern raw_spinlock_t devtree_lock;
41f88009 139
391b459d
PA
140/* flag descriptions (need to be visible even when !CONFIG_OF) */
141#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
142#define OF_DETACHED 2 /* node has been detached from the device tree */
143#define OF_POPULATED 3 /* device already created for the node */
144#define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
145
b1d06b60
GR
146#define OF_BAD_ADDR ((u64)-1)
147
6d09dc6b 148#ifdef CONFIG_OF
194ec936
SH
149void of_core_init(void);
150
8a0662d9
RW
151static inline bool is_of_node(struct fwnode_handle *fwnode)
152{
0224a4a3 153 return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_OF;
8a0662d9
RW
154}
155
c181fb3e 156static inline struct device_node *to_of_node(struct fwnode_handle *fwnode)
8a0662d9 157{
4bf01181
AS
158 return is_of_node(fwnode) ?
159 container_of(fwnode, struct device_node, fwnode) : NULL;
8a0662d9
RW
160}
161
3bcbaf6e
SAS
162static inline bool of_have_populated_dt(void)
163{
5063e25a 164 return of_root != NULL;
3bcbaf6e
SAS
165}
166
035ebefc
AS
167static inline bool of_node_is_root(const struct device_node *node)
168{
169 return node && (node->parent == NULL);
170}
171
50436312
GL
172static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
173{
174 return test_bit(flag, &n->_flags);
175}
176
c6e126de
PM
177static inline int of_node_test_and_set_flag(struct device_node *n,
178 unsigned long flag)
179{
180 return test_and_set_bit(flag, &n->_flags);
181}
182
50436312
GL
183static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
184{
185 set_bit(flag, &n->_flags);
186}
187
588453c6
PA
188static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
189{
190 clear_bit(flag, &n->_flags);
191}
192
193static inline int of_property_check_flag(struct property *p, unsigned long flag)
194{
195 return test_bit(flag, &p->_flags);
196}
197
198static inline void of_property_set_flag(struct property *p, unsigned long flag)
199{
200 set_bit(flag, &p->_flags);
201}
202
203static inline void of_property_clear_flag(struct property *p, unsigned long flag)
204{
205 clear_bit(flag, &p->_flags);
206}
207
5063e25a 208extern struct device_node *__of_find_all_nodes(struct device_node *prev);
e91edcf5
GL
209extern struct device_node *of_find_all_nodes(struct device_node *prev);
210
b6caf2ad 211/*
3d6b8828 212 * OF address retrieval & translation
b6caf2ad
GL
213 */
214
215/* Helper to read a big number; size is in cells (not bytes) */
2e89e685 216static inline u64 of_read_number(const __be32 *cell, int size)
b6caf2ad
GL
217{
218 u64 r = 0;
219 while (size--)
2e89e685 220 r = (r << 32) | be32_to_cpu(*(cell++));
b6caf2ad
GL
221 return r;
222}
223
224/* Like of_read_number, but we want an unsigned long result */
2e89e685 225static inline unsigned long of_read_ulong(const __be32 *cell, int size)
b6caf2ad 226{
2be09cb9
GL
227 /* toss away upper bits if unsigned long is smaller than u64 */
228 return of_read_number(cell, size);
b6caf2ad 229}
b6caf2ad 230
b5b4bb3f 231#if defined(CONFIG_SPARC)
76c1ce78 232#include <asm/prom.h>
b5b4bb3f 233#endif
76c1ce78 234
7c7b60cb
GL
235/* Default #address and #size cells. Allow arch asm/prom.h to override */
236#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
237#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
238#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
239#endif
240
61e955db
GL
241#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
242#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
243
c0a05bf0 244static inline const char *of_node_full_name(const struct device_node *np)
74a7f084
GL
245{
246 return np ? np->full_name : "<no-node>";
247}
248
5063e25a
GL
249#define for_each_of_allnodes_from(from, dn) \
250 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
251#define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
76c1ce78
SR
252extern struct device_node *of_find_node_by_name(struct device_node *from,
253 const char *name);
76c1ce78
SR
254extern struct device_node *of_find_node_by_type(struct device_node *from,
255 const char *type);
76c1ce78
SR
256extern struct device_node *of_find_compatible_node(struct device_node *from,
257 const char *type, const char *compat);
50c8af4c
SW
258extern struct device_node *of_find_matching_node_and_match(
259 struct device_node *from,
260 const struct of_device_id *matches,
261 const struct of_device_id **match);
662372e4 262
75c28c09
LL
263extern struct device_node *of_find_node_opts_by_path(const char *path,
264 const char **opts);
265static inline struct device_node *of_find_node_by_path(const char *path)
266{
267 return of_find_node_opts_by_path(path, NULL);
268}
269
76c1ce78
SR
270extern struct device_node *of_find_node_by_phandle(phandle handle);
271extern struct device_node *of_get_parent(const struct device_node *node);
f4eb0107 272extern struct device_node *of_get_next_parent(struct device_node *node);
76c1ce78
SR
273extern struct device_node *of_get_next_child(const struct device_node *node,
274 struct device_node *prev);
3296193d
TT
275extern struct device_node *of_get_next_available_child(
276 const struct device_node *node, struct device_node *prev);
277
9c19761a
SK
278extern struct device_node *of_get_child_by_name(const struct device_node *node,
279 const char *name);
954e04b9 280
a3e31b45
SH
281/* cache lookup */
282extern struct device_node *of_find_next_cache_node(const struct device_node *);
1e291b14
ME
283extern struct device_node *of_find_node_with_property(
284 struct device_node *from, const char *prop_name);
1e291b14 285
76c1ce78
SR
286extern struct property *of_find_property(const struct device_node *np,
287 const char *name,
288 int *lenp);
ad54a0cf
HS
289extern int of_property_count_elems_of_size(const struct device_node *np,
290 const char *propname, int elem_size);
3daf3726
TP
291extern int of_property_read_u32_index(const struct device_node *np,
292 const char *propname,
293 u32 index, u32 *out_value);
be193249
VK
294extern int of_property_read_u8_array(const struct device_node *np,
295 const char *propname, u8 *out_values, size_t sz);
296extern int of_property_read_u16_array(const struct device_node *np,
297 const char *propname, u16 *out_values, size_t sz);
0e373639 298extern int of_property_read_u32_array(const struct device_node *np,
aac285c6 299 const char *propname,
0e373639
RH
300 u32 *out_values,
301 size_t sz);
4cd7f7a3
JI
302extern int of_property_read_u64(const struct device_node *np,
303 const char *propname, u64 *out_value);
b31384fa
RW
304extern int of_property_read_u64_array(const struct device_node *np,
305 const char *propname,
306 u64 *out_values,
307 size_t sz);
0e373639 308
fe99c707 309extern int of_property_read_string(const struct device_node *np,
aac285c6
JI
310 const char *propname,
311 const char **out_string);
fe99c707 312extern int of_property_match_string(const struct device_node *np,
7aff0fe3
GL
313 const char *propname,
314 const char *string);
fe99c707 315extern int of_property_read_string_helper(const struct device_node *np,
a87fa1d8
GL
316 const char *propname,
317 const char **out_strs, size_t sz, int index);
76c1ce78
SR
318extern int of_device_is_compatible(const struct device_node *device,
319 const char *);
53a4ab96 320extern bool of_device_is_available(const struct device_node *device);
37786c7f 321extern bool of_device_is_big_endian(const struct device_node *device);
76c1ce78
SR
322extern const void *of_get_property(const struct device_node *node,
323 const char *name,
324 int *lenp);
183912d3 325extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
8af0da93
DA
326#define for_each_property_of_node(dn, pp) \
327 for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72 328
76c1ce78
SR
329extern int of_n_addr_cells(struct device_node *np);
330extern int of_n_size_cells(struct device_node *np);
283029d1
GL
331extern const struct of_device_id *of_match_node(
332 const struct of_device_id *matches, const struct device_node *node);
3f07af49 333extern int of_modalias_node(struct device_node *node, char *modalias, int len);
624cfca5 334extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
b8fbdc42 335extern struct device_node *of_parse_phandle(const struct device_node *np,
739649c5
GL
336 const char *phandle_name,
337 int index);
93c667ca 338extern int of_parse_phandle_with_args(const struct device_node *np,
64b60e09 339 const char *list_name, const char *cells_name, int index,
15c9a0ac 340 struct of_phandle_args *out_args);
035fd948
SW
341extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
342 const char *list_name, int cells_count, int index,
343 struct of_phandle_args *out_args);
bd69f73f
GL
344extern int of_count_phandle_with_args(const struct device_node *np,
345 const char *list_name, const char *cells_name);
76c1ce78 346
74e1fbb1
JR
347/* phandle iterator functions */
348extern int of_phandle_iterator_init(struct of_phandle_iterator *it,
349 const struct device_node *np,
350 const char *list_name,
351 const char *cells_name,
352 int cell_count);
353
cd209b41 354extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
abdaa77b
JR
355extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
356 uint32_t *args,
357 int size);
cd209b41 358
611cad72
SG
359extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
360extern int of_alias_get_id(struct device_node *np, const char *stem);
351d224f 361extern int of_alias_get_highest_id(const char *stem);
611cad72 362
21b082ec
GL
363extern int of_machine_is_compatible(const char *compat);
364
79d1c712
NF
365extern int of_add_property(struct device_node *np, struct property *prop);
366extern int of_remove_property(struct device_node *np, struct property *prop);
367extern int of_update_property(struct device_node *np, struct property *newprop);
21b082ec 368
fcdeb7fe 369/* For updating the device tree at runtime */
1cf3d8b3
NF
370#define OF_RECONFIG_ATTACH_NODE 0x0001
371#define OF_RECONFIG_DETACH_NODE 0x0002
372#define OF_RECONFIG_ADD_PROPERTY 0x0003
373#define OF_RECONFIG_REMOVE_PROPERTY 0x0004
374#define OF_RECONFIG_UPDATE_PROPERTY 0x0005
375
1cf3d8b3
NF
376extern int of_attach_node(struct device_node *);
377extern int of_detach_node(struct device_node *);
fcdeb7fe 378
3a1e362e 379#define of_match_ptr(_ptr) (_ptr)
c541adc6
SW
380
381/*
382 * struct property *prop;
383 * const __be32 *p;
384 * u32 u;
385 *
386 * of_property_for_each_u32(np, "propname", prop, p, u)
387 * printk("U32 value: %x\n", u);
388 */
389const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
390 u32 *pu);
c541adc6
SW
391/*
392 * struct property *prop;
393 * const char *s;
394 *
395 * of_property_for_each_string(np, "propname", prop, s)
396 * printk("String value: %s\n", s);
397 */
398const char *of_prop_next_string(struct property *prop, const char *cur);
c541adc6 399
3482f2c5 400bool of_console_check(struct device_node *dn, char *name, int index);
5c19e952 401
b98c0239 402#else /* CONFIG_OF */
3bcbaf6e 403
194ec936
SH
404static inline void of_core_init(void)
405{
406}
407
8a0662d9
RW
408static inline bool is_of_node(struct fwnode_handle *fwnode)
409{
410 return false;
411}
412
c181fb3e 413static inline struct device_node *to_of_node(struct fwnode_handle *fwnode)
8a0662d9
RW
414{
415 return NULL;
416}
417
4c358e15 418static inline const char* of_node_full_name(const struct device_node *np)
74a7f084
GL
419{
420 return "<no-node>";
421}
422
1cc44f43
PU
423static inline struct device_node *of_find_node_by_name(struct device_node *from,
424 const char *name)
425{
426 return NULL;
427}
428
662372e4
RH
429static inline struct device_node *of_find_node_by_type(struct device_node *from,
430 const char *type)
066ec1dd
AS
431{
432 return NULL;
433}
434
662372e4
RH
435static inline struct device_node *of_find_matching_node_and_match(
436 struct device_node *from,
437 const struct of_device_id *matches,
438 const struct of_device_id **match)
3bcbaf6e 439{
662372e4 440 return NULL;
3bcbaf6e
SAS
441}
442
20cd477c
AS
443static inline struct device_node *of_find_node_by_path(const char *path)
444{
445 return NULL;
446}
447
75c28c09
LL
448static inline struct device_node *of_find_node_opts_by_path(const char *path,
449 const char **opts)
450{
451 return NULL;
452}
453
ce16b9d2
SA
454static inline struct device_node *of_find_node_by_phandle(phandle handle)
455{
456 return NULL;
457}
458
662372e4 459static inline struct device_node *of_get_parent(const struct device_node *node)
00b2c76a 460{
662372e4 461 return NULL;
00b2c76a
DH
462}
463
662372e4
RH
464static inline struct device_node *of_get_next_child(
465 const struct device_node *node, struct device_node *prev)
466{
467 return NULL;
468}
aba3dfff 469
662372e4
RH
470static inline struct device_node *of_get_next_available_child(
471 const struct device_node *node, struct device_node *prev)
472{
473 return NULL;
474}
f6f0747e 475
662372e4
RH
476static inline struct device_node *of_find_node_with_property(
477 struct device_node *from, const char *prop_name)
25c040c9
OJ
478{
479 return NULL;
480}
481
662372e4 482static inline bool of_have_populated_dt(void)
183f1d0c 483{
662372e4 484 return false;
183f1d0c
DA
485}
486
662372e4
RH
487static inline struct device_node *of_get_child_by_name(
488 const struct device_node *node,
489 const char *name)
954e04b9 490{
662372e4 491 return NULL;
954e04b9
BW
492}
493
36a0904e
RN
494static inline int of_device_is_compatible(const struct device_node *device,
495 const char *name)
496{
497 return 0;
498}
499
53a4ab96 500static inline bool of_device_is_available(const struct device_node *device)
d7195696 501{
53a4ab96 502 return false;
d7195696
RH
503}
504
37786c7f
KC
505static inline bool of_device_is_big_endian(const struct device_node *device)
506{
507 return false;
d7195696
RH
508}
509
aba3dfff
SW
510static inline struct property *of_find_property(const struct device_node *np,
511 const char *name,
512 int *lenp)
513{
514 return NULL;
515}
516
2261cc62
SG
517static inline struct device_node *of_find_compatible_node(
518 struct device_node *from,
519 const char *type,
520 const char *compat)
521{
522 return NULL;
523}
524
ad54a0cf
HS
525static inline int of_property_count_elems_of_size(const struct device_node *np,
526 const char *propname, int elem_size)
527{
528 return -ENOSYS;
529}
530
3daf3726
TP
531static inline int of_property_read_u32_index(const struct device_node *np,
532 const char *propname, u32 index, u32 *out_value)
533{
534 return -ENOSYS;
535}
536
be193249
VK
537static inline int of_property_read_u8_array(const struct device_node *np,
538 const char *propname, u8 *out_values, size_t sz)
539{
540 return -ENOSYS;
541}
542
543static inline int of_property_read_u16_array(const struct device_node *np,
544 const char *propname, u16 *out_values, size_t sz)
545{
546 return -ENOSYS;
547}
548
b98c0239 549static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6
JI
550 const char *propname,
551 u32 *out_values, size_t sz)
b98c0239
SG
552{
553 return -ENOSYS;
554}
555
b31384fa
RW
556static inline int of_property_read_u64_array(const struct device_node *np,
557 const char *propname,
558 u64 *out_values, size_t sz)
559{
560 return -ENOSYS;
561}
562
fe99c707 563static inline int of_property_read_string(const struct device_node *np,
aac285c6
JI
564 const char *propname,
565 const char **out_string)
b98c0239
SG
566{
567 return -ENOSYS;
568}
569
fe99c707 570static inline int of_property_read_string_helper(const struct device_node *np,
a87fa1d8
GL
571 const char *propname,
572 const char **out_strs, size_t sz, int index)
4fcd15a0
BC
573{
574 return -ENOSYS;
575}
576
89272b8c
SW
577static inline const void *of_get_property(const struct device_node *node,
578 const char *name,
579 int *lenp)
580{
581 return NULL;
582}
583
183912d3
SH
584static inline struct device_node *of_get_cpu_node(int cpu,
585 unsigned int *thread)
586{
587 return NULL;
588}
589
4cd7f7a3
JI
590static inline int of_property_read_u64(const struct device_node *np,
591 const char *propname, u64 *out_value)
592{
593 return -ENOSYS;
594}
595
fe99c707 596static inline int of_property_match_string(const struct device_node *np,
bd3d5500
TR
597 const char *propname,
598 const char *string)
599{
600 return -ENOSYS;
601}
602
b8fbdc42 603static inline struct device_node *of_parse_phandle(const struct device_node *np,
36a0904e
RN
604 const char *phandle_name,
605 int index)
606{
607 return NULL;
608}
609
e93aeeae 610static inline int of_parse_phandle_with_args(const struct device_node *np,
e05e5070
TR
611 const char *list_name,
612 const char *cells_name,
613 int index,
614 struct of_phandle_args *out_args)
615{
616 return -ENOSYS;
617}
618
035fd948
SW
619static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
620 const char *list_name, int cells_count, int index,
621 struct of_phandle_args *out_args)
622{
623 return -ENOSYS;
624}
625
bd69f73f
GL
626static inline int of_count_phandle_with_args(struct device_node *np,
627 const char *list_name,
628 const char *cells_name)
629{
630 return -ENOSYS;
631}
632
74e1fbb1
JR
633static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
634 const struct device_node *np,
635 const char *list_name,
636 const char *cells_name,
637 int cell_count)
638{
639 return -ENOSYS;
640}
641
cd209b41
JR
642static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
643{
644 return -ENOSYS;
645}
646
abdaa77b
JR
647static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
648 uint32_t *args,
649 int size)
650{
651 return 0;
652}
653
ed5f886d
NF
654static inline int of_alias_get_id(struct device_node *np, const char *stem)
655{
656 return -ENOSYS;
657}
658
351d224f
WS
659static inline int of_alias_get_highest_id(const char *stem)
660{
661 return -ENOSYS;
662}
663
50e07f88
SW
664static inline int of_machine_is_compatible(const char *compat)
665{
666 return 0;
667}
668
3482f2c5 669static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
5c19e952 670{
3482f2c5 671 return false;
5c19e952
SH
672}
673
2adfffa2
SAS
674static inline const __be32 *of_prop_next_u32(struct property *prop,
675 const __be32 *cur, u32 *pu)
676{
677 return NULL;
678}
679
680static inline const char *of_prop_next_string(struct property *prop,
681 const char *cur)
682{
683 return NULL;
684}
685
0384e8c6
PA
686static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
687{
688 return 0;
689}
690
691static inline int of_node_test_and_set_flag(struct device_node *n,
692 unsigned long flag)
693{
694 return 0;
695}
696
697static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
698{
699}
700
701static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
702{
703}
704
705static inline int of_property_check_flag(struct property *p, unsigned long flag)
706{
707 return 0;
708}
709
710static inline void of_property_set_flag(struct property *p, unsigned long flag)
711{
712}
713
714static inline void of_property_clear_flag(struct property *p, unsigned long flag)
715{
716}
717
3a1e362e 718#define of_match_ptr(_ptr) NULL
5762c205 719#define of_match_node(_matches, _node) NULL
9dfbf207 720#endif /* CONFIG_OF */
b98c0239 721
613e9721
AT
722/* Default string compare functions, Allow arch asm/prom.h to override */
723#if !defined(of_compat_cmp)
724#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
725#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
726#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
727#endif
728
0c3f061c
RH
729#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
730extern int of_node_to_nid(struct device_node *np);
731#else
c8fff7bc
KK
732static inline int of_node_to_nid(struct device_node *device)
733{
734 return NUMA_NO_NODE;
735}
5ca4db61
PM
736#endif
737
298535c0
DD
738#ifdef CONFIG_OF_NUMA
739extern int of_numa_init(void);
740#else
741static inline int of_numa_init(void)
742{
743 return -ENOSYS;
744}
745#endif
746
662372e4
RH
747static inline struct device_node *of_find_matching_node(
748 struct device_node *from,
749 const struct of_device_id *matches)
750{
751 return of_find_matching_node_and_match(from, matches, NULL);
752}
753
ad54a0cf
HS
754/**
755 * of_property_count_u8_elems - Count the number of u8 elements in a property
756 *
757 * @np: device node from which the property value is to be read.
758 * @propname: name of the property to be searched.
759 *
760 * Search for a property in a device node and count the number of u8 elements
761 * in it. Returns number of elements on sucess, -EINVAL if the property does
762 * not exist or its length does not match a multiple of u8 and -ENODATA if the
763 * property does not have a value.
764 */
765static inline int of_property_count_u8_elems(const struct device_node *np,
766 const char *propname)
767{
768 return of_property_count_elems_of_size(np, propname, sizeof(u8));
769}
770
771/**
772 * of_property_count_u16_elems - Count the number of u16 elements in a property
773 *
774 * @np: device node from which the property value is to be read.
775 * @propname: name of the property to be searched.
776 *
777 * Search for a property in a device node and count the number of u16 elements
778 * in it. Returns number of elements on sucess, -EINVAL if the property does
779 * not exist or its length does not match a multiple of u16 and -ENODATA if the
780 * property does not have a value.
781 */
782static inline int of_property_count_u16_elems(const struct device_node *np,
783 const char *propname)
784{
785 return of_property_count_elems_of_size(np, propname, sizeof(u16));
786}
787
788/**
789 * of_property_count_u32_elems - Count the number of u32 elements in a property
790 *
791 * @np: device node from which the property value is to be read.
792 * @propname: name of the property to be searched.
793 *
794 * Search for a property in a device node and count the number of u32 elements
795 * in it. Returns number of elements on sucess, -EINVAL if the property does
796 * not exist or its length does not match a multiple of u32 and -ENODATA if the
797 * property does not have a value.
798 */
799static inline int of_property_count_u32_elems(const struct device_node *np,
800 const char *propname)
801{
802 return of_property_count_elems_of_size(np, propname, sizeof(u32));
803}
804
805/**
806 * of_property_count_u64_elems - Count the number of u64 elements in a property
807 *
808 * @np: device node from which the property value is to be read.
809 * @propname: name of the property to be searched.
810 *
811 * Search for a property in a device node and count the number of u64 elements
812 * in it. Returns number of elements on sucess, -EINVAL if the property does
813 * not exist or its length does not match a multiple of u64 and -ENODATA if the
814 * property does not have a value.
815 */
816static inline int of_property_count_u64_elems(const struct device_node *np,
817 const char *propname)
818{
819 return of_property_count_elems_of_size(np, propname, sizeof(u64));
820}
821
a87fa1d8
GL
822/**
823 * of_property_read_string_array() - Read an array of strings from a multiple
824 * strings property.
825 * @np: device node from which the property value is to be read.
826 * @propname: name of the property to be searched.
827 * @out_strs: output array of string pointers.
828 * @sz: number of array elements to read.
829 *
830 * Search for a property in a device tree node and retrieve a list of
831 * terminated string values (pointer to data, not a copy) in that property.
832 *
833 * If @out_strs is NULL, the number of strings in the property is returned.
834 */
fe99c707 835static inline int of_property_read_string_array(const struct device_node *np,
a87fa1d8
GL
836 const char *propname, const char **out_strs,
837 size_t sz)
838{
839 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
840}
841
842/**
843 * of_property_count_strings() - Find and return the number of strings from a
844 * multiple strings property.
845 * @np: device node from which the property value is to be read.
846 * @propname: name of the property to be searched.
847 *
848 * Search for a property in a device tree node and retrieve the number of null
849 * terminated string contain in it. Returns the number of strings on
850 * success, -EINVAL if the property does not exist, -ENODATA if property
851 * does not have a value, and -EILSEQ if the string is not null-terminated
852 * within the length of the property data.
853 */
fe99c707 854static inline int of_property_count_strings(const struct device_node *np,
a87fa1d8
GL
855 const char *propname)
856{
857 return of_property_read_string_helper(np, propname, NULL, 0, 0);
858}
859
860/**
861 * of_property_read_string_index() - Find and read a string from a multiple
862 * strings property.
863 * @np: device node from which the property value is to be read.
864 * @propname: name of the property to be searched.
865 * @index: index of the string in the list of strings
866 * @out_string: pointer to null terminated return string, modified only if
867 * return value is 0.
868 *
869 * Search for a property in a device tree node and retrieve a null
870 * terminated string value (pointer to data, not a copy) in the list of strings
871 * contained in that property.
872 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
873 * property does not have a value, and -EILSEQ if the string is not
874 * null-terminated within the length of the property data.
875 *
876 * The out_string pointer is modified only if a valid string can be decoded.
877 */
fe99c707 878static inline int of_property_read_string_index(const struct device_node *np,
a87fa1d8
GL
879 const char *propname,
880 int index, const char **output)
881{
882 int rc = of_property_read_string_helper(np, propname, output, 1, index);
883 return rc < 0 ? rc : 0;
884}
885
fa4d34cc
JCPV
886/**
887 * of_property_read_bool - Findfrom a property
888 * @np: device node from which the property value is to be read.
889 * @propname: name of the property to be searched.
890 *
891 * Search for a property in a device node.
31712c98 892 * Returns true if the property exists false otherwise.
fa4d34cc
JCPV
893 */
894static inline bool of_property_read_bool(const struct device_node *np,
895 const char *propname)
896{
897 struct property *prop = of_find_property(np, propname, NULL);
898
899 return prop ? true : false;
900}
901
be193249
VK
902static inline int of_property_read_u8(const struct device_node *np,
903 const char *propname,
904 u8 *out_value)
905{
906 return of_property_read_u8_array(np, propname, out_value, 1);
907}
908
909static inline int of_property_read_u16(const struct device_node *np,
910 const char *propname,
911 u16 *out_value)
912{
913 return of_property_read_u16_array(np, propname, out_value, 1);
914}
915
b98c0239 916static inline int of_property_read_u32(const struct device_node *np,
aac285c6 917 const char *propname,
b98c0239
SG
918 u32 *out_value)
919{
920 return of_property_read_u32_array(np, propname, out_value, 1);
921}
922
e7a00e42
SR
923static inline int of_property_read_s32(const struct device_node *np,
924 const char *propname,
925 s32 *out_value)
926{
927 return of_property_read_u32(np, propname, (u32*) out_value);
928}
929
f623ce95
JR
930#define of_for_each_phandle(it, err, np, ln, cn, cc) \
931 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
932 err = of_phandle_iterator_next(it); \
933 err == 0; \
934 err = of_phandle_iterator_next(it))
935
2adfffa2
SAS
936#define of_property_for_each_u32(np, propname, prop, p, u) \
937 for (prop = of_find_property(np, propname, NULL), \
938 p = of_prop_next_u32(prop, NULL, &u); \
939 p; \
940 p = of_prop_next_u32(prop, p, &u))
941
942#define of_property_for_each_string(np, propname, prop, s) \
943 for (prop = of_find_property(np, propname, NULL), \
944 s = of_prop_next_string(prop, NULL); \
945 s; \
946 s = of_prop_next_string(prop, s))
947
662372e4
RH
948#define for_each_node_by_name(dn, name) \
949 for (dn = of_find_node_by_name(NULL, name); dn; \
950 dn = of_find_node_by_name(dn, name))
951#define for_each_node_by_type(dn, type) \
952 for (dn = of_find_node_by_type(NULL, type); dn; \
953 dn = of_find_node_by_type(dn, type))
954#define for_each_compatible_node(dn, type, compatible) \
955 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
956 dn = of_find_compatible_node(dn, type, compatible))
957#define for_each_matching_node(dn, matches) \
958 for (dn = of_find_matching_node(NULL, matches); dn; \
959 dn = of_find_matching_node(dn, matches))
960#define for_each_matching_node_and_match(dn, matches, match) \
961 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
962 dn; dn = of_find_matching_node_and_match(dn, matches, match))
963
964#define for_each_child_of_node(parent, child) \
965 for (child = of_get_next_child(parent, NULL); child != NULL; \
966 child = of_get_next_child(parent, child))
967#define for_each_available_child_of_node(parent, child) \
968 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
969 child = of_get_next_available_child(parent, child))
970
971#define for_each_node_with_property(dn, prop_name) \
972 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
973 dn = of_find_node_with_property(dn, prop_name))
974
975static inline int of_get_child_count(const struct device_node *np)
976{
977 struct device_node *child;
978 int num = 0;
979
980 for_each_child_of_node(np, child)
981 num++;
982
983 return num;
984}
985
986static inline int of_get_available_child_count(const struct device_node *np)
987{
988 struct device_node *child;
989 int num = 0;
990
991 for_each_available_child_of_node(np, child)
992 num++;
993
994 return num;
995}
996
71f50c6d 997#if defined(CONFIG_OF) && !defined(MODULE)
54196ccb
RH
998#define _OF_DECLARE(table, name, compat, fn, fn_type) \
999 static const struct of_device_id __of_table_##name \
1000 __used __section(__##table##_of_table) \
1001 = { .compatible = compat, \
1002 .data = (fn == (fn_type)NULL) ? fn : fn }
1003#else
5f563585 1004#define _OF_DECLARE(table, name, compat, fn, fn_type) \
54196ccb
RH
1005 static const struct of_device_id __of_table_##name \
1006 __attribute__((unused)) \
1007 = { .compatible = compat, \
1008 .data = (fn == (fn_type)NULL) ? fn : fn }
1009#endif
1010
1011typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1012typedef void (*of_init_fn_1)(struct device_node *);
1013
1014#define OF_DECLARE_1(table, name, compat, fn) \
1015 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1016#define OF_DECLARE_2(table, name, compat, fn) \
1017 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1018
201c910b
PA
1019/**
1020 * struct of_changeset_entry - Holds a changeset entry
1021 *
1022 * @node: list_head for the log list
1023 * @action: notifier action
1024 * @np: pointer to the device node affected
1025 * @prop: pointer to the property affected
1026 * @old_prop: hold a pointer to the original property
1027 *
1028 * Every modification of the device tree during a changeset
1029 * is held in a list of of_changeset_entry structures.
1030 * That way we can recover from a partial application, or we can
1031 * revert the changeset
1032 */
1033struct of_changeset_entry {
1034 struct list_head node;
1035 unsigned long action;
1036 struct device_node *np;
1037 struct property *prop;
1038 struct property *old_prop;
1039};
1040
1041/**
1042 * struct of_changeset - changeset tracker structure
1043 *
1044 * @entries: list_head for the changeset entries
1045 *
1046 * changesets are a convenient way to apply bulk changes to the
1047 * live tree. In case of an error, changes are rolled-back.
1048 * changesets live on after initial application, and if not
1049 * destroyed after use, they can be reverted in one single call.
1050 */
1051struct of_changeset {
1052 struct list_head entries;
1053};
1054
b53a2340
PA
1055enum of_reconfig_change {
1056 OF_RECONFIG_NO_CHANGE = 0,
1057 OF_RECONFIG_CHANGE_ADD,
1058 OF_RECONFIG_CHANGE_REMOVE,
1059};
1060
201c910b 1061#ifdef CONFIG_OF_DYNAMIC
f6892d19
GL
1062extern int of_reconfig_notifier_register(struct notifier_block *);
1063extern int of_reconfig_notifier_unregister(struct notifier_block *);
f5242e5a
GL
1064extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1065extern int of_reconfig_get_state_change(unsigned long action,
1066 struct of_reconfig_data *arg);
f6892d19 1067
201c910b
PA
1068extern void of_changeset_init(struct of_changeset *ocs);
1069extern void of_changeset_destroy(struct of_changeset *ocs);
1070extern int of_changeset_apply(struct of_changeset *ocs);
1071extern int of_changeset_revert(struct of_changeset *ocs);
1072extern int of_changeset_action(struct of_changeset *ocs,
1073 unsigned long action, struct device_node *np,
1074 struct property *prop);
1075
1076static inline int of_changeset_attach_node(struct of_changeset *ocs,
1077 struct device_node *np)
1078{
1079 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1080}
1081
1082static inline int of_changeset_detach_node(struct of_changeset *ocs,
1083 struct device_node *np)
1084{
1085 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1086}
1087
1088static inline int of_changeset_add_property(struct of_changeset *ocs,
1089 struct device_node *np, struct property *prop)
1090{
1091 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1092}
1093
1094static inline int of_changeset_remove_property(struct of_changeset *ocs,
1095 struct device_node *np, struct property *prop)
1096{
1097 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1098}
1099
1100static inline int of_changeset_update_property(struct of_changeset *ocs,
1101 struct device_node *np, struct property *prop)
1102{
1103 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1104}
f6892d19
GL
1105#else /* CONFIG_OF_DYNAMIC */
1106static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1107{
1108 return -EINVAL;
1109}
1110static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1111{
1112 return -EINVAL;
1113}
f5242e5a
GL
1114static inline int of_reconfig_notify(unsigned long action,
1115 struct of_reconfig_data *arg)
f6892d19
GL
1116{
1117 return -EINVAL;
1118}
f5242e5a
GL
1119static inline int of_reconfig_get_state_change(unsigned long action,
1120 struct of_reconfig_data *arg)
f6892d19
GL
1121{
1122 return -EINVAL;
1123}
1124#endif /* CONFIG_OF_DYNAMIC */
201c910b 1125
7941b27b
PA
1126/* CONFIG_OF_RESOLVE api */
1127extern int of_resolve_phandles(struct device_node *tree);
1128
a4b4e046 1129/**
8f73110f 1130 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
a4b4e046
RP
1131 * @np: Pointer to the given device_node
1132 *
1133 * return true if present false otherwise
1134 */
8f73110f 1135static inline bool of_device_is_system_power_controller(const struct device_node *np)
a4b4e046 1136{
8f73110f 1137 return of_property_read_bool(np, "system-power-controller");
a4b4e046
RP
1138}
1139
7518b589
PA
1140/**
1141 * Overlay support
1142 */
1143
1144#ifdef CONFIG_OF_OVERLAY
1145
1146/* ID based overlays; the API for external users */
1147int of_overlay_create(struct device_node *tree);
1148int of_overlay_destroy(int id);
1149int of_overlay_destroy_all(void);
1150
1151#else
1152
1153static inline int of_overlay_create(struct device_node *tree)
1154{
1155 return -ENOTSUPP;
1156}
1157
1158static inline int of_overlay_destroy(int id)
1159{
1160 return -ENOTSUPP;
1161}
1162
1163static inline int of_overlay_destroy_all(void)
1164{
1165 return -ENOTSUPP;
1166}
1167
1168#endif
1169
76c1ce78 1170#endif /* _LINUX_OF_H */