]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/of.h
of: Fix overflow bug in string property parsing functions
[mirror_ubuntu-zesty-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);
7aff0fe3
GL
270extern int of_property_match_string(struct device_node *np,
271 const char *propname,
272 const char *string);
a87fa1d8
GL
273extern int of_property_read_string_helper(struct device_node *np,
274 const char *propname,
275 const char **out_strs, size_t sz, int index);
76c1ce78
SR
276extern int of_device_is_compatible(const struct device_node *device,
277 const char *);
834d97d4 278extern int of_device_is_available(const struct device_node *device);
76c1ce78
SR
279extern const void *of_get_property(const struct device_node *node,
280 const char *name,
281 int *lenp);
183912d3 282extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
8af0da93
DA
283#define for_each_property_of_node(dn, pp) \
284 for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72 285
76c1ce78
SR
286extern int of_n_addr_cells(struct device_node *np);
287extern int of_n_size_cells(struct device_node *np);
283029d1
GL
288extern const struct of_device_id *of_match_node(
289 const struct of_device_id *matches, const struct device_node *node);
3f07af49 290extern int of_modalias_node(struct device_node *node, char *modalias, int len);
624cfca5 291extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
b8fbdc42 292extern struct device_node *of_parse_phandle(const struct device_node *np,
739649c5
GL
293 const char *phandle_name,
294 int index);
93c667ca 295extern int of_parse_phandle_with_args(const struct device_node *np,
64b60e09 296 const char *list_name, const char *cells_name, int index,
15c9a0ac 297 struct of_phandle_args *out_args);
035fd948
SW
298extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
299 const char *list_name, int cells_count, int index,
300 struct of_phandle_args *out_args);
bd69f73f
GL
301extern int of_count_phandle_with_args(const struct device_node *np,
302 const char *list_name, const char *cells_name);
76c1ce78 303
611cad72
SG
304extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
305extern int of_alias_get_id(struct device_node *np, const char *stem);
306
21b082ec
GL
307extern int of_machine_is_compatible(const char *compat);
308
79d1c712
NF
309extern int of_add_property(struct device_node *np, struct property *prop);
310extern int of_remove_property(struct device_node *np, struct property *prop);
311extern int of_update_property(struct device_node *np, struct property *newprop);
21b082ec 312
fcdeb7fe 313/* For updating the device tree at runtime */
1cf3d8b3
NF
314#define OF_RECONFIG_ATTACH_NODE 0x0001
315#define OF_RECONFIG_DETACH_NODE 0x0002
316#define OF_RECONFIG_ADD_PROPERTY 0x0003
317#define OF_RECONFIG_REMOVE_PROPERTY 0x0004
318#define OF_RECONFIG_UPDATE_PROPERTY 0x0005
319
320struct of_prop_reconfig {
321 struct device_node *dn;
322 struct property *prop;
259092a3 323 struct property *old_prop;
1cf3d8b3
NF
324};
325
326extern int of_reconfig_notifier_register(struct notifier_block *);
327extern int of_reconfig_notifier_unregister(struct notifier_block *);
328extern int of_reconfig_notify(unsigned long, void *);
329
330extern int of_attach_node(struct device_node *);
331extern int of_detach_node(struct device_node *);
fcdeb7fe 332
3a1e362e 333#define of_match_ptr(_ptr) (_ptr)
c541adc6
SW
334
335/*
336 * struct property *prop;
337 * const __be32 *p;
338 * u32 u;
339 *
340 * of_property_for_each_u32(np, "propname", prop, p, u)
341 * printk("U32 value: %x\n", u);
342 */
343const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
344 u32 *pu);
c541adc6
SW
345/*
346 * struct property *prop;
347 * const char *s;
348 *
349 * of_property_for_each_string(np, "propname", prop, s)
350 * printk("String value: %s\n", s);
351 */
352const char *of_prop_next_string(struct property *prop, const char *cur);
c541adc6 353
3482f2c5 354bool of_console_check(struct device_node *dn, char *name, int index);
5c19e952 355
b98c0239 356#else /* CONFIG_OF */
3bcbaf6e 357
4c358e15 358static inline const char* of_node_full_name(const struct device_node *np)
74a7f084
GL
359{
360 return "<no-node>";
361}
362
1cc44f43
PU
363static inline struct device_node *of_find_node_by_name(struct device_node *from,
364 const char *name)
365{
366 return NULL;
367}
368
662372e4
RH
369static inline struct device_node *of_find_node_by_type(struct device_node *from,
370 const char *type)
066ec1dd
AS
371{
372 return NULL;
373}
374
662372e4
RH
375static inline struct device_node *of_find_matching_node_and_match(
376 struct device_node *from,
377 const struct of_device_id *matches,
378 const struct of_device_id **match)
3bcbaf6e 379{
662372e4 380 return NULL;
3bcbaf6e
SAS
381}
382
20cd477c
AS
383static inline struct device_node *of_find_node_by_path(const char *path)
384{
385 return NULL;
386}
387
662372e4 388static inline struct device_node *of_get_parent(const struct device_node *node)
00b2c76a 389{
662372e4 390 return NULL;
00b2c76a
DH
391}
392
662372e4
RH
393static inline struct device_node *of_get_next_child(
394 const struct device_node *node, struct device_node *prev)
395{
396 return NULL;
397}
aba3dfff 398
662372e4
RH
399static inline struct device_node *of_get_next_available_child(
400 const struct device_node *node, struct device_node *prev)
401{
402 return NULL;
403}
f6f0747e 404
662372e4
RH
405static inline struct device_node *of_find_node_with_property(
406 struct device_node *from, const char *prop_name)
25c040c9
OJ
407{
408 return NULL;
409}
410
662372e4 411static inline bool of_have_populated_dt(void)
183f1d0c 412{
662372e4 413 return false;
183f1d0c
DA
414}
415
662372e4
RH
416static inline struct device_node *of_get_child_by_name(
417 const struct device_node *node,
418 const char *name)
954e04b9 419{
662372e4 420 return NULL;
954e04b9
BW
421}
422
36a0904e
RN
423static inline int of_device_is_compatible(const struct device_node *device,
424 const char *name)
425{
426 return 0;
427}
428
d7195696
RH
429static inline int of_device_is_available(const struct device_node *device)
430{
431 return 0;
432}
433
aba3dfff
SW
434static inline struct property *of_find_property(const struct device_node *np,
435 const char *name,
436 int *lenp)
437{
438 return NULL;
439}
440
2261cc62
SG
441static inline struct device_node *of_find_compatible_node(
442 struct device_node *from,
443 const char *type,
444 const char *compat)
445{
446 return NULL;
447}
448
ad54a0cf
HS
449static inline int of_property_count_elems_of_size(const struct device_node *np,
450 const char *propname, int elem_size)
451{
452 return -ENOSYS;
453}
454
3daf3726
TP
455static inline int of_property_read_u32_index(const struct device_node *np,
456 const char *propname, u32 index, u32 *out_value)
457{
458 return -ENOSYS;
459}
460
be193249
VK
461static inline int of_property_read_u8_array(const struct device_node *np,
462 const char *propname, u8 *out_values, size_t sz)
463{
464 return -ENOSYS;
465}
466
467static inline int of_property_read_u16_array(const struct device_node *np,
468 const char *propname, u16 *out_values, size_t sz)
469{
470 return -ENOSYS;
471}
472
b98c0239 473static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6
JI
474 const char *propname,
475 u32 *out_values, size_t sz)
b98c0239
SG
476{
477 return -ENOSYS;
478}
479
480static inline int of_property_read_string(struct device_node *np,
aac285c6
JI
481 const char *propname,
482 const char **out_string)
b98c0239
SG
483{
484 return -ENOSYS;
485}
486
a87fa1d8
GL
487static inline int of_property_read_string_helper(struct device_node *np,
488 const char *propname,
489 const char **out_strs, size_t sz, int index)
4fcd15a0
BC
490{
491 return -ENOSYS;
492}
493
89272b8c
SW
494static inline const void *of_get_property(const struct device_node *node,
495 const char *name,
496 int *lenp)
497{
498 return NULL;
499}
500
183912d3
SH
501static inline struct device_node *of_get_cpu_node(int cpu,
502 unsigned int *thread)
503{
504 return NULL;
505}
506
4cd7f7a3
JI
507static inline int of_property_read_u64(const struct device_node *np,
508 const char *propname, u64 *out_value)
509{
510 return -ENOSYS;
511}
512
bd3d5500
TR
513static inline int of_property_match_string(struct device_node *np,
514 const char *propname,
515 const char *string)
516{
517 return -ENOSYS;
518}
519
b8fbdc42 520static inline struct device_node *of_parse_phandle(const struct device_node *np,
36a0904e
RN
521 const char *phandle_name,
522 int index)
523{
524 return NULL;
525}
526
e05e5070
TR
527static inline int of_parse_phandle_with_args(struct device_node *np,
528 const char *list_name,
529 const char *cells_name,
530 int index,
531 struct of_phandle_args *out_args)
532{
533 return -ENOSYS;
534}
535
035fd948
SW
536static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
537 const char *list_name, int cells_count, int index,
538 struct of_phandle_args *out_args)
539{
540 return -ENOSYS;
541}
542
bd69f73f
GL
543static inline int of_count_phandle_with_args(struct device_node *np,
544 const char *list_name,
545 const char *cells_name)
546{
547 return -ENOSYS;
548}
549
ed5f886d
NF
550static inline int of_alias_get_id(struct device_node *np, const char *stem)
551{
552 return -ENOSYS;
553}
554
50e07f88
SW
555static inline int of_machine_is_compatible(const char *compat)
556{
557 return 0;
558}
559
3482f2c5 560static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
5c19e952 561{
3482f2c5 562 return false;
5c19e952
SH
563}
564
2adfffa2
SAS
565static inline const __be32 *of_prop_next_u32(struct property *prop,
566 const __be32 *cur, u32 *pu)
567{
568 return NULL;
569}
570
571static inline const char *of_prop_next_string(struct property *prop,
572 const char *cur)
573{
574 return NULL;
575}
576
3a1e362e 577#define of_match_ptr(_ptr) NULL
5762c205 578#define of_match_node(_matches, _node) NULL
9dfbf207 579#endif /* CONFIG_OF */
b98c0239 580
0c3f061c
RH
581#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
582extern int of_node_to_nid(struct device_node *np);
583#else
584static inline int of_node_to_nid(struct device_node *device) { return 0; }
5ca4db61
PM
585#endif
586
662372e4
RH
587static inline struct device_node *of_find_matching_node(
588 struct device_node *from,
589 const struct of_device_id *matches)
590{
591 return of_find_matching_node_and_match(from, matches, NULL);
592}
593
ad54a0cf
HS
594/**
595 * of_property_count_u8_elems - Count the number of u8 elements in a property
596 *
597 * @np: device node from which the property value is to be read.
598 * @propname: name of the property to be searched.
599 *
600 * Search for a property in a device node and count the number of u8 elements
601 * in it. Returns number of elements on sucess, -EINVAL if the property does
602 * not exist or its length does not match a multiple of u8 and -ENODATA if the
603 * property does not have a value.
604 */
605static inline int of_property_count_u8_elems(const struct device_node *np,
606 const char *propname)
607{
608 return of_property_count_elems_of_size(np, propname, sizeof(u8));
609}
610
611/**
612 * of_property_count_u16_elems - Count the number of u16 elements in a property
613 *
614 * @np: device node from which the property value is to be read.
615 * @propname: name of the property to be searched.
616 *
617 * Search for a property in a device node and count the number of u16 elements
618 * in it. Returns number of elements on sucess, -EINVAL if the property does
619 * not exist or its length does not match a multiple of u16 and -ENODATA if the
620 * property does not have a value.
621 */
622static inline int of_property_count_u16_elems(const struct device_node *np,
623 const char *propname)
624{
625 return of_property_count_elems_of_size(np, propname, sizeof(u16));
626}
627
628/**
629 * of_property_count_u32_elems - Count the number of u32 elements in a property
630 *
631 * @np: device node from which the property value is to be read.
632 * @propname: name of the property to be searched.
633 *
634 * Search for a property in a device node and count the number of u32 elements
635 * in it. Returns number of elements on sucess, -EINVAL if the property does
636 * not exist or its length does not match a multiple of u32 and -ENODATA if the
637 * property does not have a value.
638 */
639static inline int of_property_count_u32_elems(const struct device_node *np,
640 const char *propname)
641{
642 return of_property_count_elems_of_size(np, propname, sizeof(u32));
643}
644
645/**
646 * of_property_count_u64_elems - Count the number of u64 elements in a property
647 *
648 * @np: device node from which the property value is to be read.
649 * @propname: name of the property to be searched.
650 *
651 * Search for a property in a device node and count the number of u64 elements
652 * in it. Returns number of elements on sucess, -EINVAL if the property does
653 * not exist or its length does not match a multiple of u64 and -ENODATA if the
654 * property does not have a value.
655 */
656static inline int of_property_count_u64_elems(const struct device_node *np,
657 const char *propname)
658{
659 return of_property_count_elems_of_size(np, propname, sizeof(u64));
660}
661
a87fa1d8
GL
662/**
663 * of_property_read_string_array() - Read an array of strings from a multiple
664 * strings property.
665 * @np: device node from which the property value is to be read.
666 * @propname: name of the property to be searched.
667 * @out_strs: output array of string pointers.
668 * @sz: number of array elements to read.
669 *
670 * Search for a property in a device tree node and retrieve a list of
671 * terminated string values (pointer to data, not a copy) in that property.
672 *
673 * If @out_strs is NULL, the number of strings in the property is returned.
674 */
675static inline int of_property_read_string_array(struct device_node *np,
676 const char *propname, const char **out_strs,
677 size_t sz)
678{
679 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
680}
681
682/**
683 * of_property_count_strings() - Find and return the number of strings from a
684 * multiple strings property.
685 * @np: device node from which the property value is to be read.
686 * @propname: name of the property to be searched.
687 *
688 * Search for a property in a device tree node and retrieve the number of null
689 * terminated string contain in it. Returns the number of strings on
690 * success, -EINVAL if the property does not exist, -ENODATA if property
691 * does not have a value, and -EILSEQ if the string is not null-terminated
692 * within the length of the property data.
693 */
694static inline int of_property_count_strings(struct device_node *np,
695 const char *propname)
696{
697 return of_property_read_string_helper(np, propname, NULL, 0, 0);
698}
699
700/**
701 * of_property_read_string_index() - Find and read a string from a multiple
702 * strings property.
703 * @np: device node from which the property value is to be read.
704 * @propname: name of the property to be searched.
705 * @index: index of the string in the list of strings
706 * @out_string: pointer to null terminated return string, modified only if
707 * return value is 0.
708 *
709 * Search for a property in a device tree node and retrieve a null
710 * terminated string value (pointer to data, not a copy) in the list of strings
711 * contained in that property.
712 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
713 * property does not have a value, and -EILSEQ if the string is not
714 * null-terminated within the length of the property data.
715 *
716 * The out_string pointer is modified only if a valid string can be decoded.
717 */
718static inline int of_property_read_string_index(struct device_node *np,
719 const char *propname,
720 int index, const char **output)
721{
722 int rc = of_property_read_string_helper(np, propname, output, 1, index);
723 return rc < 0 ? rc : 0;
724}
725
fa4d34cc
JCPV
726/**
727 * of_property_read_bool - Findfrom a property
728 * @np: device node from which the property value is to be read.
729 * @propname: name of the property to be searched.
730 *
731 * Search for a property in a device node.
732 * Returns true if the property exist false otherwise.
733 */
734static inline bool of_property_read_bool(const struct device_node *np,
735 const char *propname)
736{
737 struct property *prop = of_find_property(np, propname, NULL);
738
739 return prop ? true : false;
740}
741
be193249
VK
742static inline int of_property_read_u8(const struct device_node *np,
743 const char *propname,
744 u8 *out_value)
745{
746 return of_property_read_u8_array(np, propname, out_value, 1);
747}
748
749static inline int of_property_read_u16(const struct device_node *np,
750 const char *propname,
751 u16 *out_value)
752{
753 return of_property_read_u16_array(np, propname, out_value, 1);
754}
755
b98c0239 756static inline int of_property_read_u32(const struct device_node *np,
aac285c6 757 const char *propname,
b98c0239
SG
758 u32 *out_value)
759{
760 return of_property_read_u32_array(np, propname, out_value, 1);
761}
762
2adfffa2
SAS
763#define of_property_for_each_u32(np, propname, prop, p, u) \
764 for (prop = of_find_property(np, propname, NULL), \
765 p = of_prop_next_u32(prop, NULL, &u); \
766 p; \
767 p = of_prop_next_u32(prop, p, &u))
768
769#define of_property_for_each_string(np, propname, prop, s) \
770 for (prop = of_find_property(np, propname, NULL), \
771 s = of_prop_next_string(prop, NULL); \
772 s; \
773 s = of_prop_next_string(prop, s))
774
662372e4
RH
775#define for_each_node_by_name(dn, name) \
776 for (dn = of_find_node_by_name(NULL, name); dn; \
777 dn = of_find_node_by_name(dn, name))
778#define for_each_node_by_type(dn, type) \
779 for (dn = of_find_node_by_type(NULL, type); dn; \
780 dn = of_find_node_by_type(dn, type))
781#define for_each_compatible_node(dn, type, compatible) \
782 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
783 dn = of_find_compatible_node(dn, type, compatible))
784#define for_each_matching_node(dn, matches) \
785 for (dn = of_find_matching_node(NULL, matches); dn; \
786 dn = of_find_matching_node(dn, matches))
787#define for_each_matching_node_and_match(dn, matches, match) \
788 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
789 dn; dn = of_find_matching_node_and_match(dn, matches, match))
790
791#define for_each_child_of_node(parent, child) \
792 for (child = of_get_next_child(parent, NULL); child != NULL; \
793 child = of_get_next_child(parent, child))
794#define for_each_available_child_of_node(parent, child) \
795 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
796 child = of_get_next_available_child(parent, child))
797
798#define for_each_node_with_property(dn, prop_name) \
799 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
800 dn = of_find_node_with_property(dn, prop_name))
801
802static inline int of_get_child_count(const struct device_node *np)
803{
804 struct device_node *child;
805 int num = 0;
806
807 for_each_child_of_node(np, child)
808 num++;
809
810 return num;
811}
812
813static inline int of_get_available_child_count(const struct device_node *np)
814{
815 struct device_node *child;
816 int num = 0;
817
818 for_each_available_child_of_node(np, child)
819 num++;
820
821 return num;
822}
823
54196ccb
RH
824#ifdef CONFIG_OF
825#define _OF_DECLARE(table, name, compat, fn, fn_type) \
826 static const struct of_device_id __of_table_##name \
827 __used __section(__##table##_of_table) \
828 = { .compatible = compat, \
829 .data = (fn == (fn_type)NULL) ? fn : fn }
830#else
831#define _OF_DECLARE(table, name, compat, fn, fn_type) \
832 static const struct of_device_id __of_table_##name \
833 __attribute__((unused)) \
834 = { .compatible = compat, \
835 .data = (fn == (fn_type)NULL) ? fn : fn }
836#endif
837
838typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
839typedef void (*of_init_fn_1)(struct device_node *);
840
841#define OF_DECLARE_1(table, name, compat, fn) \
842 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
843#define OF_DECLARE_2(table, name, compat, fn) \
844 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
845
201c910b
PA
846/**
847 * struct of_changeset_entry - Holds a changeset entry
848 *
849 * @node: list_head for the log list
850 * @action: notifier action
851 * @np: pointer to the device node affected
852 * @prop: pointer to the property affected
853 * @old_prop: hold a pointer to the original property
854 *
855 * Every modification of the device tree during a changeset
856 * is held in a list of of_changeset_entry structures.
857 * That way we can recover from a partial application, or we can
858 * revert the changeset
859 */
860struct of_changeset_entry {
861 struct list_head node;
862 unsigned long action;
863 struct device_node *np;
864 struct property *prop;
865 struct property *old_prop;
866};
867
868/**
869 * struct of_changeset - changeset tracker structure
870 *
871 * @entries: list_head for the changeset entries
872 *
873 * changesets are a convenient way to apply bulk changes to the
874 * live tree. In case of an error, changes are rolled-back.
875 * changesets live on after initial application, and if not
876 * destroyed after use, they can be reverted in one single call.
877 */
878struct of_changeset {
879 struct list_head entries;
880};
881
882#ifdef CONFIG_OF_DYNAMIC
883extern void of_changeset_init(struct of_changeset *ocs);
884extern void of_changeset_destroy(struct of_changeset *ocs);
885extern int of_changeset_apply(struct of_changeset *ocs);
886extern int of_changeset_revert(struct of_changeset *ocs);
887extern int of_changeset_action(struct of_changeset *ocs,
888 unsigned long action, struct device_node *np,
889 struct property *prop);
890
891static inline int of_changeset_attach_node(struct of_changeset *ocs,
892 struct device_node *np)
893{
894 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
895}
896
897static inline int of_changeset_detach_node(struct of_changeset *ocs,
898 struct device_node *np)
899{
900 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
901}
902
903static inline int of_changeset_add_property(struct of_changeset *ocs,
904 struct device_node *np, struct property *prop)
905{
906 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
907}
908
909static inline int of_changeset_remove_property(struct of_changeset *ocs,
910 struct device_node *np, struct property *prop)
911{
912 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
913}
914
915static inline int of_changeset_update_property(struct of_changeset *ocs,
916 struct device_node *np, struct property *prop)
917{
918 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
919}
920#endif
921
7941b27b
PA
922/* CONFIG_OF_RESOLVE api */
923extern int of_resolve_phandles(struct device_node *tree);
924
76c1ce78 925#endif /* _LINUX_OF_H */