of.h 28.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
#ifndef _LINUX_OF_H
#define _LINUX_OF_H
/*
 * Definitions for talking to the Open Firmware PROM on
 * Power Macintosh and other computers.
 *
 * Copyright (C) 1996-2005 Paul Mackerras.
 *
 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
 * Updates for SPARC64 by David S. Miller
 * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */
#include <linux/types.h>
J
Jiri Slaby 已提交
19
#include <linux/bitops.h>
K
Kalle Valo 已提交
20
#include <linux/errno.h>
21
#include <linux/kobject.h>
22
#include <linux/mod_devicetable.h>
23
#include <linux/spinlock.h>
P
Paul Mundt 已提交
24
#include <linux/topology.h>
25
#include <linux/notifier.h>
26

27
#include <asm/byteorder.h>
28
#include <asm/errno.h>
29

30 31 32 33 34 35 36 37 38 39
typedef u32 phandle;
typedef u32 ihandle;

struct property {
	char	*name;
	int	length;
	void	*value;
	struct property *next;
	unsigned long _flags;
	unsigned int unique_id;
40
	struct bin_attribute attr;
41 42
};

G
Grant Likely 已提交
43 44 45 46 47 48 49
#if defined(CONFIG_SPARC)
struct of_irq_controller;
#endif

struct device_node {
	const char *name;
	const char *type;
50
	phandle phandle;
51
	const char *full_name;
G
Grant Likely 已提交
52 53 54 55 56 57 58

	struct	property *properties;
	struct	property *deadprops;	/* removed properties */
	struct	device_node *parent;
	struct	device_node *child;
	struct	device_node *sibling;
	struct	device_node *next;	/* next device of same type */
59
	struct	kobject kobj;
G
Grant Likely 已提交
60 61 62
	unsigned long _flags;
	void	*data;
#if defined(CONFIG_SPARC)
63
	const char *path_component_name;
G
Grant Likely 已提交
64 65 66 67 68
	unsigned int unique_id;
	struct of_irq_controller *irq_trans;
#endif
};

A
Andreas Herrmann 已提交
69
#define MAX_PHANDLE_ARGS 16
70 71 72 73 74 75
struct of_phandle_args {
	struct device_node *np;
	int args_count;
	uint32_t args[MAX_PHANDLE_ARGS];
};

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
/* initialize a node */
extern struct kobj_type of_node_ktype;
static inline void of_node_init(struct device_node *node)
{
	kobject_init(&node->kobj, &of_node_ktype);
}

/* true when node is initialized */
static inline int of_node_is_initialized(struct device_node *node)
{
	return node && node->kobj.state_initialized;
}

/* true when node is attached (i.e. present on sysfs) */
static inline int of_node_is_attached(struct device_node *node)
{
	return node && node->kobj.state_in_sysfs;
}

95 96 97 98
#ifdef CONFIG_OF_DYNAMIC
extern struct device_node *of_node_get(struct device_node *node);
extern void of_node_put(struct device_node *node);
#else /* CONFIG_OF_DYNAMIC */
99 100 101 102 103
/* Dummy ref counting routines - to be implemented later */
static inline struct device_node *of_node_get(struct device_node *node)
{
	return node;
}
104 105
static inline void of_node_put(struct device_node *node) { }
#endif /* !CONFIG_OF_DYNAMIC */
106

107 108
#ifdef CONFIG_OF

109
/* Pointer for first entry in chain of all nodes. */
G
Grant Likely 已提交
110
extern struct device_node *of_root;
111
extern struct device_node *of_chosen;
112
extern struct device_node *of_aliases;
113
extern struct device_node *of_stdout;
114
extern raw_spinlock_t devtree_lock;
115

116 117
static inline bool of_have_populated_dt(void)
{
G
Grant Likely 已提交
118
	return of_root != NULL;
119 120
}

121 122 123 124 125
static inline bool of_node_is_root(const struct device_node *node)
{
	return node && (node->parent == NULL);
}

126 127 128 129 130
static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
{
	return test_bit(flag, &n->_flags);
}

131 132 133 134 135 136
static inline int of_node_test_and_set_flag(struct device_node *n,
					    unsigned long flag)
{
	return test_and_set_bit(flag, &n->_flags);
}

137 138 139 140 141
static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
{
	set_bit(flag, &n->_flags);
}

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
{
	clear_bit(flag, &n->_flags);
}

static inline int of_property_check_flag(struct property *p, unsigned long flag)
{
	return test_bit(flag, &p->_flags);
}

static inline void of_property_set_flag(struct property *p, unsigned long flag)
{
	set_bit(flag, &p->_flags);
}

static inline void of_property_clear_flag(struct property *p, unsigned long flag)
{
	clear_bit(flag, &p->_flags);
}

G
Grant Likely 已提交
162
extern struct device_node *__of_find_all_nodes(struct device_node *prev);
163 164
extern struct device_node *of_find_all_nodes(struct device_node *prev);

165
/*
L
Lennert Buytenhek 已提交
166
 * OF address retrieval & translation
167 168 169
 */

/* Helper to read a big number; size is in cells (not bytes) */
170
static inline u64 of_read_number(const __be32 *cell, int size)
171 172 173
{
	u64 r = 0;
	while (size--)
174
		r = (r << 32) | be32_to_cpu(*(cell++));
175 176 177 178
	return r;
}

/* Like of_read_number, but we want an unsigned long result */
179
static inline unsigned long of_read_ulong(const __be32 *cell, int size)
180
{
181 182
	/* toss away upper bits if unsigned long is smaller than u64 */
	return of_read_number(cell, size);
183 184
}

R
Rob Herring 已提交
185
#if defined(CONFIG_SPARC)
186
#include <asm/prom.h>
R
Rob Herring 已提交
187
#endif
188

189 190 191 192 193 194 195 196
/* Default #address and #size cells.  Allow arch asm/prom.h to override */
#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
#endif

/* Default string compare functions, Allow arch asm/prom.h to override */
#if !defined(of_compat_cmp)
197
#define of_compat_cmp(s1, s2, l)	strcasecmp((s1), (s2))
198 199 200 201
#define of_prop_cmp(s1, s2)		strcmp((s1), (s2))
#define of_node_cmp(s1, s2)		strcasecmp((s1), (s2))
#endif

202 203 204
/* flag descriptions */
#define OF_DYNAMIC	1 /* node and properties were allocated via kmalloc */
#define OF_DETACHED	2 /* node has been detached from the device tree */
205
#define OF_POPULATED	3 /* device already created for the node */
206
#define OF_POPULATED_BUS	4 /* of_platform_populate recursed to children of this node */
207

208 209 210
#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)

211 212
#define OF_BAD_ADDR	((u64)-1)

213
static inline const char *of_node_full_name(const struct device_node *np)
214 215 216 217
{
	return np ? np->full_name : "<no-node>";
}

G
Grant Likely 已提交
218 219 220
#define for_each_of_allnodes_from(from, dn) \
	for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
#define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
221 222 223 224 225 226
extern struct device_node *of_find_node_by_name(struct device_node *from,
	const char *name);
extern struct device_node *of_find_node_by_type(struct device_node *from,
	const char *type);
extern struct device_node *of_find_compatible_node(struct device_node *from,
	const char *type, const char *compat);
227 228 229 230
extern struct device_node *of_find_matching_node_and_match(
	struct device_node *from,
	const struct of_device_id *matches,
	const struct of_device_id **match);
231

232 233 234
extern struct device_node *of_find_node_by_path(const char *path);
extern struct device_node *of_find_node_by_phandle(phandle handle);
extern struct device_node *of_get_parent(const struct device_node *node);
235
extern struct device_node *of_get_next_parent(struct device_node *node);
236 237
extern struct device_node *of_get_next_child(const struct device_node *node,
					     struct device_node *prev);
238 239 240
extern struct device_node *of_get_next_available_child(
	const struct device_node *node, struct device_node *prev);

241 242
extern struct device_node *of_get_child_by_name(const struct device_node *node,
					const char *name);
243

244 245
/* cache lookup */
extern struct device_node *of_find_next_cache_node(const struct device_node *);
246 247 248
extern struct device_node *of_find_node_with_property(
	struct device_node *from, const char *prop_name);

249 250 251
extern struct property *of_find_property(const struct device_node *np,
					 const char *name,
					 int *lenp);
252 253
extern int of_property_count_elems_of_size(const struct device_node *np,
				const char *propname, int elem_size);
254 255 256
extern int of_property_read_u32_index(const struct device_node *np,
				       const char *propname,
				       u32 index, u32 *out_value);
257 258 259 260
extern int of_property_read_u8_array(const struct device_node *np,
			const char *propname, u8 *out_values, size_t sz);
extern int of_property_read_u16_array(const struct device_node *np,
			const char *propname, u16 *out_values, size_t sz);
261
extern int of_property_read_u32_array(const struct device_node *np,
262
				      const char *propname,
263 264
				      u32 *out_values,
				      size_t sz);
265 266
extern int of_property_read_u64(const struct device_node *np,
				const char *propname, u64 *out_value);
267

268 269 270
extern int of_property_read_string(struct device_node *np,
				   const char *propname,
				   const char **out_string);
271 272 273
extern int of_property_match_string(struct device_node *np,
				    const char *propname,
				    const char *string);
274 275 276
extern int of_property_read_string_helper(struct device_node *np,
					      const char *propname,
					      const char **out_strs, size_t sz, int index);
277 278
extern int of_device_is_compatible(const struct device_node *device,
				   const char *);
279
extern bool of_device_is_available(const struct device_node *device);
280 281 282
extern const void *of_get_property(const struct device_node *node,
				const char *name,
				int *lenp);
283
extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
284 285
#define for_each_property_of_node(dn, pp) \
	for (pp = dn->properties; pp != NULL; pp = pp->next)
286

287 288
extern int of_n_addr_cells(struct device_node *np);
extern int of_n_size_cells(struct device_node *np);
289 290
extern const struct of_device_id *of_match_node(
	const struct of_device_id *matches, const struct device_node *node);
291
extern int of_modalias_node(struct device_node *node, char *modalias, int len);
292
extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
293
extern struct device_node *of_parse_phandle(const struct device_node *np,
294 295
					    const char *phandle_name,
					    int index);
296
extern int of_parse_phandle_with_args(const struct device_node *np,
297
	const char *list_name, const char *cells_name, int index,
298
	struct of_phandle_args *out_args);
299 300 301
extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
	const char *list_name, int cells_count, int index,
	struct of_phandle_args *out_args);
302 303
extern int of_count_phandle_with_args(const struct device_node *np,
	const char *list_name, const char *cells_name);
304

305 306 307
extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
extern int of_alias_get_id(struct device_node *np, const char *stem);

308 309
extern int of_machine_is_compatible(const char *compat);

310 311 312
extern int of_add_property(struct device_node *np, struct property *prop);
extern int of_remove_property(struct device_node *np, struct property *prop);
extern int of_update_property(struct device_node *np, struct property *newprop);
313

314
/* For updating the device tree at runtime */
315 316 317 318 319 320 321 322 323
#define OF_RECONFIG_ATTACH_NODE		0x0001
#define OF_RECONFIG_DETACH_NODE		0x0002
#define OF_RECONFIG_ADD_PROPERTY	0x0003
#define OF_RECONFIG_REMOVE_PROPERTY	0x0004
#define OF_RECONFIG_UPDATE_PROPERTY	0x0005

struct of_prop_reconfig {
	struct device_node	*dn;
	struct property		*prop;
324
	struct property		*old_prop;
325 326 327 328
};

extern int of_attach_node(struct device_node *);
extern int of_detach_node(struct device_node *);
329

B
Ben Dooks 已提交
330
#define of_match_ptr(_ptr)	(_ptr)
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

/*
 * struct property *prop;
 * const __be32 *p;
 * u32 u;
 *
 * of_property_for_each_u32(np, "propname", prop, p, u)
 *         printk("U32 value: %x\n", u);
 */
const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
			       u32 *pu);
/*
 * struct property *prop;
 * const char *s;
 *
 * of_property_for_each_string(np, "propname", prop, s)
 *         printk("String value: %s\n", s);
 */
const char *of_prop_next_string(struct property *prop, const char *cur);

351
bool of_console_check(struct device_node *dn, char *name, int index);
352

353
#else /* CONFIG_OF */
354

355
static inline const char* of_node_full_name(const struct device_node *np)
356 357 358 359
{
	return "<no-node>";
}

360 361 362 363 364 365
static inline struct device_node *of_find_node_by_name(struct device_node *from,
	const char *name)
{
	return NULL;
}

366 367
static inline struct device_node *of_find_node_by_type(struct device_node *from,
	const char *type)
368 369 370 371
{
	return NULL;
}

372 373 374 375
static inline struct device_node *of_find_matching_node_and_match(
	struct device_node *from,
	const struct of_device_id *matches,
	const struct of_device_id **match)
376
{
377
	return NULL;
378 379
}

380 381 382 383 384
static inline struct device_node *of_find_node_by_path(const char *path)
{
	return NULL;
}

385
static inline struct device_node *of_get_parent(const struct device_node *node)
386
{
387
	return NULL;
388 389
}

390 391 392 393 394
static inline struct device_node *of_get_next_child(
	const struct device_node *node, struct device_node *prev)
{
	return NULL;
}
395

396 397 398 399 400
static inline struct device_node *of_get_next_available_child(
	const struct device_node *node, struct device_node *prev)
{
	return NULL;
}
401

402 403
static inline struct device_node *of_find_node_with_property(
	struct device_node *from, const char *prop_name)
404 405 406 407
{
	return NULL;
}

408
static inline bool of_have_populated_dt(void)
409
{
410
	return false;
411 412
}

413 414 415
static inline struct device_node *of_get_child_by_name(
					const struct device_node *node,
					const char *name)
416
{
417
	return NULL;
418 419
}

420 421 422 423 424 425
static inline int of_device_is_compatible(const struct device_node *device,
					  const char *name)
{
	return 0;
}

426
static inline bool of_device_is_available(const struct device_node *device)
427
{
428
	return false;
429 430
}

431 432 433 434 435 436 437
static inline struct property *of_find_property(const struct device_node *np,
						const char *name,
						int *lenp)
{
	return NULL;
}

438 439 440 441 442 443 444 445
static inline struct device_node *of_find_compatible_node(
						struct device_node *from,
						const char *type,
						const char *compat)
{
	return NULL;
}

446 447 448 449 450 451
static inline int of_property_count_elems_of_size(const struct device_node *np,
			const char *propname, int elem_size)
{
	return -ENOSYS;
}

452 453 454 455 456 457
static inline int of_property_read_u32_index(const struct device_node *np,
			const char *propname, u32 index, u32 *out_value)
{
	return -ENOSYS;
}

458 459 460 461 462 463 464 465 466 467 468 469
static inline int of_property_read_u8_array(const struct device_node *np,
			const char *propname, u8 *out_values, size_t sz)
{
	return -ENOSYS;
}

static inline int of_property_read_u16_array(const struct device_node *np,
			const char *propname, u16 *out_values, size_t sz)
{
	return -ENOSYS;
}

470
static inline int of_property_read_u32_array(const struct device_node *np,
471 472
					     const char *propname,
					     u32 *out_values, size_t sz)
473 474 475 476 477
{
	return -ENOSYS;
}

static inline int of_property_read_string(struct device_node *np,
478 479
					  const char *propname,
					  const char **out_string)
480 481 482 483
{
	return -ENOSYS;
}

484 485 486
static inline int of_property_read_string_helper(struct device_node *np,
						 const char *propname,
						 const char **out_strs, size_t sz, int index)
487 488 489 490
{
	return -ENOSYS;
}

491 492 493 494 495 496 497
static inline const void *of_get_property(const struct device_node *node,
				const char *name,
				int *lenp)
{
	return NULL;
}

498 499 500 501 502 503
static inline struct device_node *of_get_cpu_node(int cpu,
					unsigned int *thread)
{
	return NULL;
}

504 505 506 507 508 509
static inline int of_property_read_u64(const struct device_node *np,
				       const char *propname, u64 *out_value)
{
	return -ENOSYS;
}

510 511 512 513 514 515 516
static inline int of_property_match_string(struct device_node *np,
					   const char *propname,
					   const char *string)
{
	return -ENOSYS;
}

517
static inline struct device_node *of_parse_phandle(const struct device_node *np,
518 519 520 521 522 523
						   const char *phandle_name,
						   int index)
{
	return NULL;
}

524 525 526 527 528 529 530 531 532
static inline int of_parse_phandle_with_args(struct device_node *np,
					     const char *list_name,
					     const char *cells_name,
					     int index,
					     struct of_phandle_args *out_args)
{
	return -ENOSYS;
}

533 534 535 536 537 538 539
static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
	const char *list_name, int cells_count, int index,
	struct of_phandle_args *out_args)
{
	return -ENOSYS;
}

540 541 542 543 544 545 546
static inline int of_count_phandle_with_args(struct device_node *np,
					     const char *list_name,
					     const char *cells_name)
{
	return -ENOSYS;
}

547 548 549 550 551
static inline int of_alias_get_id(struct device_node *np, const char *stem)
{
	return -ENOSYS;
}

552 553 554 555 556
static inline int of_machine_is_compatible(const char *compat)
{
	return 0;
}

557
static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
558
{
559
	return false;
560 561
}

562 563 564 565 566 567 568 569 570 571 572 573
static inline const __be32 *of_prop_next_u32(struct property *prop,
		const __be32 *cur, u32 *pu)
{
	return NULL;
}

static inline const char *of_prop_next_string(struct property *prop,
		const char *cur)
{
	return NULL;
}

B
Ben Dooks 已提交
574
#define of_match_ptr(_ptr)	NULL
575
#define of_match_node(_matches, _node)	NULL
576
#endif /* CONFIG_OF */
577

578 579 580 581
#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
extern int of_node_to_nid(struct device_node *np);
#else
static inline int of_node_to_nid(struct device_node *device) { return 0; }
P
Paul Mundt 已提交
582 583
#endif

584 585 586 587 588 589 590
static inline struct device_node *of_find_matching_node(
	struct device_node *from,
	const struct of_device_id *matches)
{
	return of_find_matching_node_and_match(from, matches, NULL);
}

591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
/**
 * of_property_count_u8_elems - Count the number of u8 elements in a property
 *
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 *
 * Search for a property in a device node and count the number of u8 elements
 * in it. Returns number of elements on sucess, -EINVAL if the property does
 * not exist or its length does not match a multiple of u8 and -ENODATA if the
 * property does not have a value.
 */
static inline int of_property_count_u8_elems(const struct device_node *np,
				const char *propname)
{
	return of_property_count_elems_of_size(np, propname, sizeof(u8));
}

/**
 * of_property_count_u16_elems - Count the number of u16 elements in a property
 *
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 *
 * Search for a property in a device node and count the number of u16 elements
 * in it. Returns number of elements on sucess, -EINVAL if the property does
 * not exist or its length does not match a multiple of u16 and -ENODATA if the
 * property does not have a value.
 */
static inline int of_property_count_u16_elems(const struct device_node *np,
				const char *propname)
{
	return of_property_count_elems_of_size(np, propname, sizeof(u16));
}

/**
 * of_property_count_u32_elems - Count the number of u32 elements in a property
 *
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 *
 * Search for a property in a device node and count the number of u32 elements
 * in it. Returns number of elements on sucess, -EINVAL if the property does
 * not exist or its length does not match a multiple of u32 and -ENODATA if the
 * property does not have a value.
 */
static inline int of_property_count_u32_elems(const struct device_node *np,
				const char *propname)
{
	return of_property_count_elems_of_size(np, propname, sizeof(u32));
}

/**
 * of_property_count_u64_elems - Count the number of u64 elements in a property
 *
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 *
 * Search for a property in a device node and count the number of u64 elements
 * in it. Returns number of elements on sucess, -EINVAL if the property does
 * not exist or its length does not match a multiple of u64 and -ENODATA if the
 * property does not have a value.
 */
static inline int of_property_count_u64_elems(const struct device_node *np,
				const char *propname)
{
	return of_property_count_elems_of_size(np, propname, sizeof(u64));
}

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
/**
 * of_property_read_string_array() - Read an array of strings from a multiple
 * strings property.
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 * @out_strs:	output array of string pointers.
 * @sz:		number of array elements to read.
 *
 * Search for a property in a device tree node and retrieve a list of
 * terminated string values (pointer to data, not a copy) in that property.
 *
 * If @out_strs is NULL, the number of strings in the property is returned.
 */
static inline int of_property_read_string_array(struct device_node *np,
						const char *propname, const char **out_strs,
						size_t sz)
{
	return of_property_read_string_helper(np, propname, out_strs, sz, 0);
}

/**
 * of_property_count_strings() - Find and return the number of strings from a
 * multiple strings property.
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 *
 * Search for a property in a device tree node and retrieve the number of null
 * terminated string contain in it. Returns the number of strings on
 * success, -EINVAL if the property does not exist, -ENODATA if property
 * does not have a value, and -EILSEQ if the string is not null-terminated
 * within the length of the property data.
 */
static inline int of_property_count_strings(struct device_node *np,
					    const char *propname)
{
	return of_property_read_string_helper(np, propname, NULL, 0, 0);
}

/**
 * of_property_read_string_index() - Find and read a string from a multiple
 * strings property.
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 * @index:	index of the string in the list of strings
 * @out_string:	pointer to null terminated return string, modified only if
 *		return value is 0.
 *
 * Search for a property in a device tree node and retrieve a null
 * terminated string value (pointer to data, not a copy) in the list of strings
 * contained in that property.
 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
 * property does not have a value, and -EILSEQ if the string is not
 * null-terminated within the length of the property data.
 *
 * The out_string pointer is modified only if a valid string can be decoded.
 */
static inline int of_property_read_string_index(struct device_node *np,
						const char *propname,
						int index, const char **output)
{
	int rc = of_property_read_string_helper(np, propname, output, 1, index);
	return rc < 0 ? rc : 0;
}

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
/**
 * of_property_read_bool - Findfrom a property
 * @np:		device node from which the property value is to be read.
 * @propname:	name of the property to be searched.
 *
 * Search for a property in a device node.
 * Returns true if the property exist false otherwise.
 */
static inline bool of_property_read_bool(const struct device_node *np,
					 const char *propname)
{
	struct property *prop = of_find_property(np, propname, NULL);

	return prop ? true : false;
}

739 740 741 742 743 744 745 746 747 748 749 750 751 752
static inline int of_property_read_u8(const struct device_node *np,
				       const char *propname,
				       u8 *out_value)
{
	return of_property_read_u8_array(np, propname, out_value, 1);
}

static inline int of_property_read_u16(const struct device_node *np,
				       const char *propname,
				       u16 *out_value)
{
	return of_property_read_u16_array(np, propname, out_value, 1);
}

753
static inline int of_property_read_u32(const struct device_node *np,
754
				       const char *propname,
755 756 757 758 759
				       u32 *out_value)
{
	return of_property_read_u32_array(np, propname, out_value, 1);
}

760 761 762 763 764 765 766
static inline int of_property_read_s32(const struct device_node *np,
				       const char *propname,
				       s32 *out_value)
{
	return of_property_read_u32(np, propname, (u32*) out_value);
}

767 768 769 770 771 772 773 774 775 776 777 778
#define of_property_for_each_u32(np, propname, prop, p, u)	\
	for (prop = of_find_property(np, propname, NULL),	\
		p = of_prop_next_u32(prop, NULL, &u);		\
		p;						\
		p = of_prop_next_u32(prop, p, &u))

#define of_property_for_each_string(np, propname, prop, s)	\
	for (prop = of_find_property(np, propname, NULL),	\
		s = of_prop_next_string(prop, NULL);		\
		s;						\
		s = of_prop_next_string(prop, s))

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
#define for_each_node_by_name(dn, name) \
	for (dn = of_find_node_by_name(NULL, name); dn; \
	     dn = of_find_node_by_name(dn, name))
#define for_each_node_by_type(dn, type) \
	for (dn = of_find_node_by_type(NULL, type); dn; \
	     dn = of_find_node_by_type(dn, type))
#define for_each_compatible_node(dn, type, compatible) \
	for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
	     dn = of_find_compatible_node(dn, type, compatible))
#define for_each_matching_node(dn, matches) \
	for (dn = of_find_matching_node(NULL, matches); dn; \
	     dn = of_find_matching_node(dn, matches))
#define for_each_matching_node_and_match(dn, matches, match) \
	for (dn = of_find_matching_node_and_match(NULL, matches, match); \
	     dn; dn = of_find_matching_node_and_match(dn, matches, match))

#define for_each_child_of_node(parent, child) \
	for (child = of_get_next_child(parent, NULL); child != NULL; \
	     child = of_get_next_child(parent, child))
#define for_each_available_child_of_node(parent, child) \
	for (child = of_get_next_available_child(parent, NULL); child != NULL; \
	     child = of_get_next_available_child(parent, child))

#define for_each_node_with_property(dn, prop_name) \
	for (dn = of_find_node_with_property(NULL, prop_name); dn; \
	     dn = of_find_node_with_property(dn, prop_name))

static inline int of_get_child_count(const struct device_node *np)
{
	struct device_node *child;
	int num = 0;

	for_each_child_of_node(np, child)
		num++;

	return num;
}

static inline int of_get_available_child_count(const struct device_node *np)
{
	struct device_node *child;
	int num = 0;

	for_each_available_child_of_node(np, child)
		num++;

	return num;
}

828 829 830 831 832 833 834
#ifdef CONFIG_OF
#define _OF_DECLARE(table, name, compat, fn, fn_type)			\
	static const struct of_device_id __of_table_##name		\
		__used __section(__##table##_of_table)			\
		 = { .compatible = compat,				\
		     .data = (fn == (fn_type)NULL) ? fn : fn  }
#else
835
#define _OF_DECLARE(table, name, compat, fn, fn_type)			\
836 837 838 839 840 841 842 843 844 845 846 847 848 849
	static const struct of_device_id __of_table_##name		\
		__attribute__((unused))					\
		 = { .compatible = compat,				\
		     .data = (fn == (fn_type)NULL) ? fn : fn }
#endif

typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
typedef void (*of_init_fn_1)(struct device_node *);

#define OF_DECLARE_1(table, name, compat, fn) \
		_OF_DECLARE(table, name, compat, fn, of_init_fn_1)
#define OF_DECLARE_2(table, name, compat, fn) \
		_OF_DECLARE(table, name, compat, fn, of_init_fn_2)

850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
/**
 * struct of_changeset_entry	- Holds a changeset entry
 *
 * @node:	list_head for the log list
 * @action:	notifier action
 * @np:		pointer to the device node affected
 * @prop:	pointer to the property affected
 * @old_prop:	hold a pointer to the original property
 *
 * Every modification of the device tree during a changeset
 * is held in a list of of_changeset_entry structures.
 * That way we can recover from a partial application, or we can
 * revert the changeset
 */
struct of_changeset_entry {
	struct list_head node;
	unsigned long action;
	struct device_node *np;
	struct property *prop;
	struct property *old_prop;
};

/**
 * struct of_changeset - changeset tracker structure
 *
 * @entries:	list_head for the changeset entries
 *
 * changesets are a convenient way to apply bulk changes to the
 * live tree. In case of an error, changes are rolled-back.
 * changesets live on after initial application, and if not
 * destroyed after use, they can be reverted in one single call.
 */
struct of_changeset {
	struct list_head entries;
};

886 887 888 889 890 891
enum of_reconfig_change {
	OF_RECONFIG_NO_CHANGE = 0,
	OF_RECONFIG_CHANGE_ADD,
	OF_RECONFIG_CHANGE_REMOVE,
};

892
#ifdef CONFIG_OF_DYNAMIC
893 894 895 896 897
extern int of_reconfig_notifier_register(struct notifier_block *);
extern int of_reconfig_notifier_unregister(struct notifier_block *);
extern int of_reconfig_notify(unsigned long, void *);
extern int of_reconfig_get_state_change(unsigned long action, void *arg);

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
extern void of_changeset_init(struct of_changeset *ocs);
extern void of_changeset_destroy(struct of_changeset *ocs);
extern int of_changeset_apply(struct of_changeset *ocs);
extern int of_changeset_revert(struct of_changeset *ocs);
extern int of_changeset_action(struct of_changeset *ocs,
		unsigned long action, struct device_node *np,
		struct property *prop);

static inline int of_changeset_attach_node(struct of_changeset *ocs,
		struct device_node *np)
{
	return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
}

static inline int of_changeset_detach_node(struct of_changeset *ocs,
		struct device_node *np)
{
	return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
}

static inline int of_changeset_add_property(struct of_changeset *ocs,
		struct device_node *np, struct property *prop)
{
	return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
}

static inline int of_changeset_remove_property(struct of_changeset *ocs,
		struct device_node *np, struct property *prop)
{
	return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
}

static inline int of_changeset_update_property(struct of_changeset *ocs,
		struct device_node *np, struct property *prop)
{
	return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
}
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
#else /* CONFIG_OF_DYNAMIC */
static inline int of_reconfig_notifier_register(struct notifier_block *nb)
{
	return -EINVAL;
}
static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
{
	return -EINVAL;
}
static inline int of_reconfig_notify(unsigned long action, void *arg)
{
	return -EINVAL;
}
static inline int of_reconfig_get_state_change(unsigned long action, void *arg)
{
	return -EINVAL;
}
#endif /* CONFIG_OF_DYNAMIC */
953

954 955 956
/* CONFIG_OF_RESOLVE api */
extern int of_resolve_phandles(struct device_node *tree);

957
#endif /* _LINUX_OF_H */