]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/of.h
of/selftest: Add a test for duplicate phandles
[mirror_ubuntu-artful-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>
76c1ce78 26
2e89e685 27#include <asm/byteorder.h>
d0a99402 28#include <asm/errno.h>
2e89e685 29
731581e6
GL
30typedef u32 phandle;
31typedef u32 ihandle;
32
33struct property {
34 char *name;
35 int length;
36 void *value;
37 struct property *next;
38 unsigned long _flags;
39 unsigned int unique_id;
75b57ecf 40 struct bin_attribute attr;
731581e6
GL
41};
42
6f192492
GL
43#if defined(CONFIG_SPARC)
44struct of_irq_controller;
45#endif
46
47struct device_node {
48 const char *name;
49 const char *type;
6016a363 50 phandle phandle;
c22618a1 51 const char *full_name;
6f192492
GL
52
53 struct property *properties;
54 struct property *deadprops; /* removed properties */
55 struct device_node *parent;
56 struct device_node *child;
57 struct device_node *sibling;
58 struct device_node *next; /* next device of same type */
59 struct device_node *allnext; /* next in list of all nodes */
75b57ecf 60 struct kobject kobj;
6f192492
GL
61 unsigned long _flags;
62 void *data;
63#if defined(CONFIG_SPARC)
c22618a1 64 const char *path_component_name;
6f192492
GL
65 unsigned int unique_id;
66 struct of_irq_controller *irq_trans;
67#endif
68};
69
b66548e2 70#define MAX_PHANDLE_ARGS 16
15c9a0ac
GL
71struct of_phandle_args {
72 struct device_node *np;
73 int args_count;
74 uint32_t args[MAX_PHANDLE_ARGS];
75};
76
0829f6d1
PA
77/* initialize a node */
78extern struct kobj_type of_node_ktype;
79static inline void of_node_init(struct device_node *node)
80{
81 kobject_init(&node->kobj, &of_node_ktype);
82}
83
84/* true when node is initialized */
85static inline int of_node_is_initialized(struct device_node *node)
86{
87 return node && node->kobj.state_initialized;
88}
89
90/* true when node is attached (i.e. present on sysfs) */
91static inline int of_node_is_attached(struct device_node *node)
92{
93 return node && node->kobj.state_in_sysfs;
94}
95
0f22dd39
GL
96#ifdef CONFIG_OF_DYNAMIC
97extern struct device_node *of_node_get(struct device_node *node);
98extern void of_node_put(struct device_node *node);
99#else /* CONFIG_OF_DYNAMIC */
3ecdd051
RH
100/* Dummy ref counting routines - to be implemented later */
101static inline struct device_node *of_node_get(struct device_node *node)
102{
103 return node;
104}
0f22dd39
GL
105static inline void of_node_put(struct device_node *node) { }
106#endif /* !CONFIG_OF_DYNAMIC */
3ecdd051 107
c9e358df
GL
108#ifdef CONFIG_OF
109
41f88009 110/* Pointer for first entry in chain of all nodes. */
465aac6d 111extern struct device_node *of_allnodes;
fc0bdae4 112extern struct device_node *of_chosen;
611cad72 113extern struct device_node *of_aliases;
a752ee56 114extern struct device_node *of_stdout;
d6d3c4e6 115extern raw_spinlock_t devtree_lock;
41f88009 116
3bcbaf6e
SAS
117static inline bool of_have_populated_dt(void)
118{
465aac6d 119 return of_allnodes != NULL;
3bcbaf6e
SAS
120}
121
035ebefc
AS
122static inline bool of_node_is_root(const struct device_node *node)
123{
124 return node && (node->parent == NULL);
125}
126
50436312
GL
127static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
128{
129 return test_bit(flag, &n->_flags);
130}
131
c6e126de
PM
132static inline int of_node_test_and_set_flag(struct device_node *n,
133 unsigned long flag)
134{
135 return test_and_set_bit(flag, &n->_flags);
136}
137
50436312
GL
138static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
139{
140 set_bit(flag, &n->_flags);
141}
142
588453c6
PA
143static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
144{
145 clear_bit(flag, &n->_flags);
146}
147
148static inline int of_property_check_flag(struct property *p, unsigned long flag)
149{
150 return test_bit(flag, &p->_flags);
151}
152
153static inline void of_property_set_flag(struct property *p, unsigned long flag)
154{
155 set_bit(flag, &p->_flags);
156}
157
158static inline void of_property_clear_flag(struct property *p, unsigned long flag)
159{
160 clear_bit(flag, &p->_flags);
161}
162
e91edcf5
GL
163extern struct device_node *of_find_all_nodes(struct device_node *prev);
164
b6caf2ad 165/*
3d6b8828 166 * OF address retrieval & translation
b6caf2ad
GL
167 */
168
169/* Helper to read a big number; size is in cells (not bytes) */
2e89e685 170static inline u64 of_read_number(const __be32 *cell, int size)
b6caf2ad
GL
171{
172 u64 r = 0;
173 while (size--)
2e89e685 174 r = (r << 32) | be32_to_cpu(*(cell++));
b6caf2ad
GL
175 return r;
176}
177
178/* Like of_read_number, but we want an unsigned long result */
2e89e685 179static inline unsigned long of_read_ulong(const __be32 *cell, int size)
b6caf2ad 180{
2be09cb9
GL
181 /* toss away upper bits if unsigned long is smaller than u64 */
182 return of_read_number(cell, size);
b6caf2ad 183}
b6caf2ad 184
b5b4bb3f 185#if defined(CONFIG_SPARC)
76c1ce78 186#include <asm/prom.h>
b5b4bb3f 187#endif
76c1ce78 188
7c7b60cb
GL
189/* Default #address and #size cells. Allow arch asm/prom.h to override */
190#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
191#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
192#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
193#endif
194
195/* Default string compare functions, Allow arch asm/prom.h to override */
196#if !defined(of_compat_cmp)
1976152f 197#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
7c7b60cb
GL
198#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
199#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
200#endif
201
76c1ce78
SR
202/* flag descriptions */
203#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
204#define OF_DETACHED 2 /* node has been detached from the device tree */
c6e126de 205#define OF_POPULATED 3 /* device already created for the node */
75f353b6 206#define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
76c1ce78 207
61e955db
GL
208#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
209#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
210
76c1ce78
SR
211#define OF_BAD_ADDR ((u64)-1)
212
c0a05bf0 213static inline const char *of_node_full_name(const struct device_node *np)
74a7f084
GL
214{
215 return np ? np->full_name : "<no-node>";
216}
217
75b57ecf
GL
218#define for_each_of_allnodes(dn) \
219 for (dn = of_allnodes; dn; dn = dn->allnext)
76c1ce78
SR
220extern struct device_node *of_find_node_by_name(struct device_node *from,
221 const char *name);
76c1ce78
SR
222extern struct device_node *of_find_node_by_type(struct device_node *from,
223 const char *type);
76c1ce78
SR
224extern struct device_node *of_find_compatible_node(struct device_node *from,
225 const char *type, const char *compat);
50c8af4c
SW
226extern struct device_node *of_find_matching_node_and_match(
227 struct device_node *from,
228 const struct of_device_id *matches,
229 const struct of_device_id **match);
662372e4 230
76c1ce78
SR
231extern struct device_node *of_find_node_by_path(const char *path);
232extern struct device_node *of_find_node_by_phandle(phandle handle);
233extern struct device_node *of_get_parent(const struct device_node *node);
f4eb0107 234extern struct device_node *of_get_next_parent(struct device_node *node);
76c1ce78
SR
235extern struct device_node *of_get_next_child(const struct device_node *node,
236 struct device_node *prev);
3296193d
TT
237extern struct device_node *of_get_next_available_child(
238 const struct device_node *node, struct device_node *prev);
239
9c19761a
SK
240extern struct device_node *of_get_child_by_name(const struct device_node *node,
241 const char *name);
954e04b9 242
a3e31b45
SH
243/* cache lookup */
244extern struct device_node *of_find_next_cache_node(const struct device_node *);
1e291b14
ME
245extern struct device_node *of_find_node_with_property(
246 struct device_node *from, const char *prop_name);
1e291b14 247
76c1ce78
SR
248extern struct property *of_find_property(const struct device_node *np,
249 const char *name,
250 int *lenp);
ad54a0cf
HS
251extern int of_property_count_elems_of_size(const struct device_node *np,
252 const char *propname, int elem_size);
3daf3726
TP
253extern int of_property_read_u32_index(const struct device_node *np,
254 const char *propname,
255 u32 index, u32 *out_value);
be193249
VK
256extern int of_property_read_u8_array(const struct device_node *np,
257 const char *propname, u8 *out_values, size_t sz);
258extern int of_property_read_u16_array(const struct device_node *np,
259 const char *propname, u16 *out_values, size_t sz);
0e373639 260extern int of_property_read_u32_array(const struct device_node *np,
aac285c6 261 const char *propname,
0e373639
RH
262 u32 *out_values,
263 size_t sz);
4cd7f7a3
JI
264extern int of_property_read_u64(const struct device_node *np,
265 const char *propname, u64 *out_value);
0e373639 266
aac285c6
JI
267extern int of_property_read_string(struct device_node *np,
268 const char *propname,
269 const char **out_string);
4fcd15a0
BC
270extern int of_property_read_string_index(struct device_node *np,
271 const char *propname,
272 int index, const char **output);
7aff0fe3
GL
273extern int of_property_match_string(struct device_node *np,
274 const char *propname,
275 const char *string);
4fcd15a0
BC
276extern int of_property_count_strings(struct device_node *np,
277 const char *propname);
76c1ce78
SR
278extern int of_device_is_compatible(const struct device_node *device,
279 const char *);
834d97d4 280extern int of_device_is_available(const struct device_node *device);
76c1ce78
SR
281extern const void *of_get_property(const struct device_node *node,
282 const char *name,
283 int *lenp);
183912d3 284extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
8af0da93
DA
285#define for_each_property_of_node(dn, pp) \
286 for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72 287
76c1ce78
SR
288extern int of_n_addr_cells(struct device_node *np);
289extern int of_n_size_cells(struct device_node *np);
283029d1
GL
290extern const struct of_device_id *of_match_node(
291 const struct of_device_id *matches, const struct device_node *node);
3f07af49 292extern int of_modalias_node(struct device_node *node, char *modalias, int len);
624cfca5 293extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
b8fbdc42 294extern struct device_node *of_parse_phandle(const struct device_node *np,
739649c5
GL
295 const char *phandle_name,
296 int index);
93c667ca 297extern int of_parse_phandle_with_args(const struct device_node *np,
64b60e09 298 const char *list_name, const char *cells_name, int index,
15c9a0ac 299 struct of_phandle_args *out_args);
035fd948
SW
300extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
301 const char *list_name, int cells_count, int index,
302 struct of_phandle_args *out_args);
bd69f73f
GL
303extern int of_count_phandle_with_args(const struct device_node *np,
304 const char *list_name, const char *cells_name);
76c1ce78 305
611cad72
SG
306extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
307extern int of_alias_get_id(struct device_node *np, const char *stem);
308
21b082ec
GL
309extern int of_machine_is_compatible(const char *compat);
310
79d1c712
NF
311extern int of_add_property(struct device_node *np, struct property *prop);
312extern int of_remove_property(struct device_node *np, struct property *prop);
313extern int of_update_property(struct device_node *np, struct property *newprop);
21b082ec 314
fcdeb7fe 315/* For updating the device tree at runtime */
1cf3d8b3
NF
316#define OF_RECONFIG_ATTACH_NODE 0x0001
317#define OF_RECONFIG_DETACH_NODE 0x0002
318#define OF_RECONFIG_ADD_PROPERTY 0x0003
319#define OF_RECONFIG_REMOVE_PROPERTY 0x0004
320#define OF_RECONFIG_UPDATE_PROPERTY 0x0005
321
322struct of_prop_reconfig {
323 struct device_node *dn;
324 struct property *prop;
259092a3 325 struct property *old_prop;
1cf3d8b3
NF
326};
327
328extern int of_reconfig_notifier_register(struct notifier_block *);
329extern int of_reconfig_notifier_unregister(struct notifier_block *);
330extern int of_reconfig_notify(unsigned long, void *);
331
332extern int of_attach_node(struct device_node *);
333extern int of_detach_node(struct device_node *);
fcdeb7fe 334
3a1e362e 335#define of_match_ptr(_ptr) (_ptr)
c541adc6
SW
336
337/*
338 * struct property *prop;
339 * const __be32 *p;
340 * u32 u;
341 *
342 * of_property_for_each_u32(np, "propname", prop, p, u)
343 * printk("U32 value: %x\n", u);
344 */
345const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
346 u32 *pu);
c541adc6
SW
347/*
348 * struct property *prop;
349 * const char *s;
350 *
351 * of_property_for_each_string(np, "propname", prop, s)
352 * printk("String value: %s\n", s);
353 */
354const char *of_prop_next_string(struct property *prop, const char *cur);
c541adc6 355
3482f2c5 356bool of_console_check(struct device_node *dn, char *name, int index);
5c19e952 357
b98c0239 358#else /* CONFIG_OF */
3bcbaf6e 359
4c358e15 360static inline const char* of_node_full_name(const struct device_node *np)
74a7f084
GL
361{
362 return "<no-node>";
363}
364
1cc44f43
PU
365static inline struct device_node *of_find_node_by_name(struct device_node *from,
366 const char *name)
367{
368 return NULL;
369}
370
662372e4
RH
371static inline struct device_node *of_find_node_by_type(struct device_node *from,
372 const char *type)
066ec1dd
AS
373{
374 return NULL;
375}
376
662372e4
RH
377static inline struct device_node *of_find_matching_node_and_match(
378 struct device_node *from,
379 const struct of_device_id *matches,
380 const struct of_device_id **match)
3bcbaf6e 381{
662372e4 382 return NULL;
3bcbaf6e
SAS
383}
384
20cd477c
AS
385static inline struct device_node *of_find_node_by_path(const char *path)
386{
387 return NULL;
388}
389
662372e4 390static inline struct device_node *of_get_parent(const struct device_node *node)
00b2c76a 391{
662372e4 392 return NULL;
00b2c76a
DH
393}
394
662372e4
RH
395static inline struct device_node *of_get_next_child(
396 const struct device_node *node, struct device_node *prev)
397{
398 return NULL;
399}
aba3dfff 400
662372e4
RH
401static inline struct device_node *of_get_next_available_child(
402 const struct device_node *node, struct device_node *prev)
403{
404 return NULL;
405}
f6f0747e 406
662372e4
RH
407static inline struct device_node *of_find_node_with_property(
408 struct device_node *from, const char *prop_name)
25c040c9
OJ
409{
410 return NULL;
411}
412
662372e4 413static inline bool of_have_populated_dt(void)
183f1d0c 414{
662372e4 415 return false;
183f1d0c
DA
416}
417
662372e4
RH
418static inline struct device_node *of_get_child_by_name(
419 const struct device_node *node,
420 const char *name)
954e04b9 421{
662372e4 422 return NULL;
954e04b9
BW
423}
424
36a0904e
RN
425static inline int of_device_is_compatible(const struct device_node *device,
426 const char *name)
427{
428 return 0;
429}
430
d7195696
RH
431static inline int of_device_is_available(const struct device_node *device)
432{
433 return 0;
434}
435
aba3dfff
SW
436static inline struct property *of_find_property(const struct device_node *np,
437 const char *name,
438 int *lenp)
439{
440 return NULL;
441}
442
2261cc62
SG
443static inline struct device_node *of_find_compatible_node(
444 struct device_node *from,
445 const char *type,
446 const char *compat)
447{
448 return NULL;
449}
450
ad54a0cf
HS
451static inline int of_property_count_elems_of_size(const struct device_node *np,
452 const char *propname, int elem_size)
453{
454 return -ENOSYS;
455}
456
3daf3726
TP
457static inline int of_property_read_u32_index(const struct device_node *np,
458 const char *propname, u32 index, u32 *out_value)
459{
460 return -ENOSYS;
461}
462
be193249
VK
463static inline int of_property_read_u8_array(const struct device_node *np,
464 const char *propname, u8 *out_values, size_t sz)
465{
466 return -ENOSYS;
467}
468
469static inline int of_property_read_u16_array(const struct device_node *np,
470 const char *propname, u16 *out_values, size_t sz)
471{
472 return -ENOSYS;
473}
474
b98c0239 475static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6
JI
476 const char *propname,
477 u32 *out_values, size_t sz)
b98c0239
SG
478{
479 return -ENOSYS;
480}
481
482static inline int of_property_read_string(struct device_node *np,
aac285c6
JI
483 const char *propname,
484 const char **out_string)
b98c0239
SG
485{
486 return -ENOSYS;
487}
488
4fcd15a0
BC
489static inline int of_property_read_string_index(struct device_node *np,
490 const char *propname, int index,
491 const char **out_string)
492{
493 return -ENOSYS;
494}
495
496static inline int of_property_count_strings(struct device_node *np,
497 const char *propname)
498{
499 return -ENOSYS;
500}
501
89272b8c
SW
502static inline const void *of_get_property(const struct device_node *node,
503 const char *name,
504 int *lenp)
505{
506 return NULL;
507}
508
183912d3
SH
509static inline struct device_node *of_get_cpu_node(int cpu,
510 unsigned int *thread)
511{
512 return NULL;
513}
514
4cd7f7a3
JI
515static inline int of_property_read_u64(const struct device_node *np,
516 const char *propname, u64 *out_value)
517{
518 return -ENOSYS;
519}
520
bd3d5500
TR
521static inline int of_property_match_string(struct device_node *np,
522 const char *propname,
523 const char *string)
524{
525 return -ENOSYS;
526}
527
b8fbdc42 528static inline struct device_node *of_parse_phandle(const struct device_node *np,
36a0904e
RN
529 const char *phandle_name,
530 int index)
531{
532 return NULL;
533}
534
e05e5070
TR
535static inline int of_parse_phandle_with_args(struct device_node *np,
536 const char *list_name,
537 const char *cells_name,
538 int index,
539 struct of_phandle_args *out_args)
540{
541 return -ENOSYS;
542}
543
035fd948
SW
544static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
545 const char *list_name, int cells_count, int index,
546 struct of_phandle_args *out_args)
547{
548 return -ENOSYS;
549}
550
bd69f73f
GL
551static inline int of_count_phandle_with_args(struct device_node *np,
552 const char *list_name,
553 const char *cells_name)
554{
555 return -ENOSYS;
556}
557
ed5f886d
NF
558static inline int of_alias_get_id(struct device_node *np, const char *stem)
559{
560 return -ENOSYS;
561}
562
50e07f88
SW
563static inline int of_machine_is_compatible(const char *compat)
564{
565 return 0;
566}
567
3482f2c5 568static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
5c19e952 569{
3482f2c5 570 return false;
5c19e952
SH
571}
572
2adfffa2
SAS
573static inline const __be32 *of_prop_next_u32(struct property *prop,
574 const __be32 *cur, u32 *pu)
575{
576 return NULL;
577}
578
579static inline const char *of_prop_next_string(struct property *prop,
580 const char *cur)
581{
582 return NULL;
583}
584
3a1e362e 585#define of_match_ptr(_ptr) NULL
5762c205 586#define of_match_node(_matches, _node) NULL
9dfbf207 587#endif /* CONFIG_OF */
b98c0239 588
0c3f061c
RH
589#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
590extern int of_node_to_nid(struct device_node *np);
591#else
592static inline int of_node_to_nid(struct device_node *device) { return 0; }
5ca4db61
PM
593#endif
594
662372e4
RH
595static inline struct device_node *of_find_matching_node(
596 struct device_node *from,
597 const struct of_device_id *matches)
598{
599 return of_find_matching_node_and_match(from, matches, NULL);
600}
601
ad54a0cf
HS
602/**
603 * of_property_count_u8_elems - Count the number of u8 elements in a property
604 *
605 * @np: device node from which the property value is to be read.
606 * @propname: name of the property to be searched.
607 *
608 * Search for a property in a device node and count the number of u8 elements
609 * in it. Returns number of elements on sucess, -EINVAL if the property does
610 * not exist or its length does not match a multiple of u8 and -ENODATA if the
611 * property does not have a value.
612 */
613static inline int of_property_count_u8_elems(const struct device_node *np,
614 const char *propname)
615{
616 return of_property_count_elems_of_size(np, propname, sizeof(u8));
617}
618
619/**
620 * of_property_count_u16_elems - Count the number of u16 elements in a property
621 *
622 * @np: device node from which the property value is to be read.
623 * @propname: name of the property to be searched.
624 *
625 * Search for a property in a device node and count the number of u16 elements
626 * in it. Returns number of elements on sucess, -EINVAL if the property does
627 * not exist or its length does not match a multiple of u16 and -ENODATA if the
628 * property does not have a value.
629 */
630static inline int of_property_count_u16_elems(const struct device_node *np,
631 const char *propname)
632{
633 return of_property_count_elems_of_size(np, propname, sizeof(u16));
634}
635
636/**
637 * of_property_count_u32_elems - Count the number of u32 elements in a property
638 *
639 * @np: device node from which the property value is to be read.
640 * @propname: name of the property to be searched.
641 *
642 * Search for a property in a device node and count the number of u32 elements
643 * in it. Returns number of elements on sucess, -EINVAL if the property does
644 * not exist or its length does not match a multiple of u32 and -ENODATA if the
645 * property does not have a value.
646 */
647static inline int of_property_count_u32_elems(const struct device_node *np,
648 const char *propname)
649{
650 return of_property_count_elems_of_size(np, propname, sizeof(u32));
651}
652
653/**
654 * of_property_count_u64_elems - Count the number of u64 elements in a property
655 *
656 * @np: device node from which the property value is to be read.
657 * @propname: name of the property to be searched.
658 *
659 * Search for a property in a device node and count the number of u64 elements
660 * in it. Returns number of elements on sucess, -EINVAL if the property does
661 * not exist or its length does not match a multiple of u64 and -ENODATA if the
662 * property does not have a value.
663 */
664static inline int of_property_count_u64_elems(const struct device_node *np,
665 const char *propname)
666{
667 return of_property_count_elems_of_size(np, propname, sizeof(u64));
668}
669
fa4d34cc
JCPV
670/**
671 * of_property_read_bool - Findfrom a property
672 * @np: device node from which the property value is to be read.
673 * @propname: name of the property to be searched.
674 *
675 * Search for a property in a device node.
676 * Returns true if the property exist false otherwise.
677 */
678static inline bool of_property_read_bool(const struct device_node *np,
679 const char *propname)
680{
681 struct property *prop = of_find_property(np, propname, NULL);
682
683 return prop ? true : false;
684}
685
be193249
VK
686static inline int of_property_read_u8(const struct device_node *np,
687 const char *propname,
688 u8 *out_value)
689{
690 return of_property_read_u8_array(np, propname, out_value, 1);
691}
692
693static inline int of_property_read_u16(const struct device_node *np,
694 const char *propname,
695 u16 *out_value)
696{
697 return of_property_read_u16_array(np, propname, out_value, 1);
698}
699
b98c0239 700static inline int of_property_read_u32(const struct device_node *np,
aac285c6 701 const char *propname,
b98c0239
SG
702 u32 *out_value)
703{
704 return of_property_read_u32_array(np, propname, out_value, 1);
705}
706
2adfffa2
SAS
707#define of_property_for_each_u32(np, propname, prop, p, u) \
708 for (prop = of_find_property(np, propname, NULL), \
709 p = of_prop_next_u32(prop, NULL, &u); \
710 p; \
711 p = of_prop_next_u32(prop, p, &u))
712
713#define of_property_for_each_string(np, propname, prop, s) \
714 for (prop = of_find_property(np, propname, NULL), \
715 s = of_prop_next_string(prop, NULL); \
716 s; \
717 s = of_prop_next_string(prop, s))
718
662372e4
RH
719#define for_each_node_by_name(dn, name) \
720 for (dn = of_find_node_by_name(NULL, name); dn; \
721 dn = of_find_node_by_name(dn, name))
722#define for_each_node_by_type(dn, type) \
723 for (dn = of_find_node_by_type(NULL, type); dn; \
724 dn = of_find_node_by_type(dn, type))
725#define for_each_compatible_node(dn, type, compatible) \
726 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
727 dn = of_find_compatible_node(dn, type, compatible))
728#define for_each_matching_node(dn, matches) \
729 for (dn = of_find_matching_node(NULL, matches); dn; \
730 dn = of_find_matching_node(dn, matches))
731#define for_each_matching_node_and_match(dn, matches, match) \
732 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
733 dn; dn = of_find_matching_node_and_match(dn, matches, match))
734
735#define for_each_child_of_node(parent, child) \
736 for (child = of_get_next_child(parent, NULL); child != NULL; \
737 child = of_get_next_child(parent, child))
738#define for_each_available_child_of_node(parent, child) \
739 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
740 child = of_get_next_available_child(parent, child))
741
742#define for_each_node_with_property(dn, prop_name) \
743 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
744 dn = of_find_node_with_property(dn, prop_name))
745
746static inline int of_get_child_count(const struct device_node *np)
747{
748 struct device_node *child;
749 int num = 0;
750
751 for_each_child_of_node(np, child)
752 num++;
753
754 return num;
755}
756
757static inline int of_get_available_child_count(const struct device_node *np)
758{
759 struct device_node *child;
760 int num = 0;
761
762 for_each_available_child_of_node(np, child)
763 num++;
764
765 return num;
766}
767
54196ccb
RH
768#ifdef CONFIG_OF
769#define _OF_DECLARE(table, name, compat, fn, fn_type) \
770 static const struct of_device_id __of_table_##name \
771 __used __section(__##table##_of_table) \
772 = { .compatible = compat, \
773 .data = (fn == (fn_type)NULL) ? fn : fn }
774#else
775#define _OF_DECLARE(table, name, compat, fn, fn_type) \
776 static const struct of_device_id __of_table_##name \
777 __attribute__((unused)) \
778 = { .compatible = compat, \
779 .data = (fn == (fn_type)NULL) ? fn : fn }
780#endif
781
782typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
783typedef void (*of_init_fn_1)(struct device_node *);
784
785#define OF_DECLARE_1(table, name, compat, fn) \
786 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
787#define OF_DECLARE_2(table, name, compat, fn) \
788 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
789
201c910b
PA
790/**
791 * struct of_changeset_entry - Holds a changeset entry
792 *
793 * @node: list_head for the log list
794 * @action: notifier action
795 * @np: pointer to the device node affected
796 * @prop: pointer to the property affected
797 * @old_prop: hold a pointer to the original property
798 *
799 * Every modification of the device tree during a changeset
800 * is held in a list of of_changeset_entry structures.
801 * That way we can recover from a partial application, or we can
802 * revert the changeset
803 */
804struct of_changeset_entry {
805 struct list_head node;
806 unsigned long action;
807 struct device_node *np;
808 struct property *prop;
809 struct property *old_prop;
810};
811
812/**
813 * struct of_changeset - changeset tracker structure
814 *
815 * @entries: list_head for the changeset entries
816 *
817 * changesets are a convenient way to apply bulk changes to the
818 * live tree. In case of an error, changes are rolled-back.
819 * changesets live on after initial application, and if not
820 * destroyed after use, they can be reverted in one single call.
821 */
822struct of_changeset {
823 struct list_head entries;
824};
825
826#ifdef CONFIG_OF_DYNAMIC
827extern void of_changeset_init(struct of_changeset *ocs);
828extern void of_changeset_destroy(struct of_changeset *ocs);
829extern int of_changeset_apply(struct of_changeset *ocs);
830extern int of_changeset_revert(struct of_changeset *ocs);
831extern int of_changeset_action(struct of_changeset *ocs,
832 unsigned long action, struct device_node *np,
833 struct property *prop);
834
835static inline int of_changeset_attach_node(struct of_changeset *ocs,
836 struct device_node *np)
837{
838 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
839}
840
841static inline int of_changeset_detach_node(struct of_changeset *ocs,
842 struct device_node *np)
843{
844 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
845}
846
847static inline int of_changeset_add_property(struct of_changeset *ocs,
848 struct device_node *np, struct property *prop)
849{
850 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
851}
852
853static inline int of_changeset_remove_property(struct of_changeset *ocs,
854 struct device_node *np, struct property *prop)
855{
856 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
857}
858
859static inline int of_changeset_update_property(struct of_changeset *ocs,
860 struct device_node *np, struct property *prop)
861{
862 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
863}
864#endif
865
76c1ce78 866#endif /* _LINUX_OF_H */