of.h 17.9 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>
G
Grant Likely 已提交
21
#include <linux/kref.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 40 41
typedef u32 phandle;
typedef u32 ihandle;

struct property {
	char	*name;
	int	length;
	void	*value;
	struct property *next;
	unsigned long _flags;
	unsigned int unique_id;
};

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

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

	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 */
	struct	device_node *allnext;	/* next in list of all nodes */
	struct	proc_dir_entry *pde;	/* this node's proc directory */
	struct	kref kref;
	unsigned long _flags;
	void	*data;
#if defined(CONFIG_SPARC)
64
	const char *path_component_name;
G
Grant Likely 已提交
65 66 67 68 69
	unsigned int unique_id;
	struct of_irq_controller *irq_trans;
#endif
};

70 71 72 73 74 75 76
#define MAX_PHANDLE_ARGS 8
struct of_phandle_args {
	struct device_node *np;
	int args_count;
	uint32_t args[MAX_PHANDLE_ARGS];
};

77 78 79 80
#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 */
81 82 83 84 85
/* Dummy ref counting routines - to be implemented later */
static inline struct device_node *of_node_get(struct device_node *node)
{
	return node;
}
86 87
static inline void of_node_put(struct device_node *node) { }
#endif /* !CONFIG_OF_DYNAMIC */
88

89 90
#ifdef CONFIG_OF

91
/* Pointer for first entry in chain of all nodes. */
92
extern struct device_node *of_allnodes;
93
extern struct device_node *of_chosen;
94
extern struct device_node *of_aliases;
95
extern raw_spinlock_t devtree_lock;
96

97 98
static inline bool of_have_populated_dt(void)
{
99
	return of_allnodes != NULL;
100 101
}

102 103 104 105 106
static inline bool of_node_is_root(const struct device_node *node)
{
	return node && (node->parent == NULL);
}

107 108 109 110 111 112 113 114 115 116
static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
{
	return test_bit(flag, &n->_flags);
}

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

117 118
extern struct device_node *of_find_all_nodes(struct device_node *prev);

119
/*
L
Lennert Buytenhek 已提交
120
 * OF address retrieval & translation
121 122 123
 */

/* Helper to read a big number; size is in cells (not bytes) */
124
static inline u64 of_read_number(const __be32 *cell, int size)
125 126 127
{
	u64 r = 0;
	while (size--)
128
		r = (r << 32) | be32_to_cpu(*(cell++));
129 130 131 132
	return r;
}

/* Like of_read_number, but we want an unsigned long result */
133
static inline unsigned long of_read_ulong(const __be32 *cell, int size)
134
{
135 136
	/* toss away upper bits if unsigned long is smaller than u64 */
	return of_read_number(cell, size);
137 138
}

R
Rob Herring 已提交
139
#if defined(CONFIG_SPARC)
140
#include <asm/prom.h>
R
Rob Herring 已提交
141
#endif
142

143 144 145 146 147 148 149 150
/* 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)
151
#define of_compat_cmp(s1, s2, l)	strcasecmp((s1), (s2))
152 153 154 155
#define of_prop_cmp(s1, s2)		strcmp((s1), (s2))
#define of_node_cmp(s1, s2)		strcasecmp((s1), (s2))
#endif

156 157 158 159
/* 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 */

160 161 162
#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)

163 164
#define OF_BAD_ADDR	((u64)-1)

165
static inline const char *of_node_full_name(const struct device_node *np)
166 167 168 169
{
	return np ? np->full_name : "<no-node>";
}

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
extern struct device_node *of_find_node_by_name(struct device_node *from,
	const char *name);
#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))
extern struct device_node *of_find_node_by_type(struct device_node *from,
	const char *type);
#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))
extern struct device_node *of_find_compatible_node(struct device_node *from,
	const char *type, const char *compat);
#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))
185 186 187 188 189 190 191 192 193 194
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);
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);
}
195 196 197
#define for_each_matching_node(dn, matches) \
	for (dn = of_find_matching_node(NULL, matches); dn; \
	     dn = of_find_matching_node(dn, matches))
198 199 200
#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))
201 202 203
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);
204
extern struct device_node *of_get_next_parent(struct device_node *node);
205 206
extern struct device_node *of_get_next_child(const struct device_node *node,
					     struct device_node *prev);
207 208 209
extern struct device_node *of_get_next_available_child(
	const struct device_node *node, struct device_node *prev);

210 211
extern struct device_node *of_get_child_by_name(const struct device_node *node,
					const char *name);
212 213 214 215
#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))

216 217 218 219
#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))

220 221 222 223 224 225 226 227 228 229 230
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;
}

231 232 233 234 235 236 237 238 239 240 241
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;
}

242 243
/* cache lookup */
extern struct device_node *of_find_next_cache_node(const struct device_node *);
244 245 246 247 248 249
extern struct device_node *of_find_node_with_property(
	struct device_node *from, const char *prop_name);
#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))

250 251 252
extern struct property *of_find_property(const struct device_node *np,
					 const char *name,
					 int *lenp);
253 254 255
extern int of_property_read_u32_index(const struct device_node *np,
				       const char *propname,
				       u32 index, u32 *out_value);
256 257 258 259
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);
260
extern int of_property_read_u32_array(const struct device_node *np,
261
				      const char *propname,
262 263
				      u32 *out_values,
				      size_t sz);
264 265
extern int of_property_read_u64(const struct device_node *np,
				const char *propname, u64 *out_value);
266

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

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

306 307 308
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);

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

311 312 313
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);
314

315
/* For updating the device tree at runtime */
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
#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;
};

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_attach_node(struct device_node *);
extern int of_detach_node(struct device_node *);
333

B
Ben Dooks 已提交
334
#define of_match_ptr(_ptr)	(_ptr)
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

/*
 * 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);

355 356
int of_device_is_stdout_path(struct device_node *dn);

357
#else /* CONFIG_OF */
358

359 360 361 362 363
static inline const char* of_node_full_name(struct device_node *np)
{
	return "<no-node>";
}

364 365 366 367 368 369
static inline struct device_node *of_find_node_by_name(struct device_node *from,
	const char *name)
{
	return NULL;
}

370 371 372 373 374
static inline struct device_node *of_get_parent(const struct device_node *node)
{
	return NULL;
}

375 376 377 378 379
static inline bool of_have_populated_dt(void)
{
	return false;
}

380 381 382
#define for_each_child_of_node(parent, child) \
	while (0)

383 384 385
#define for_each_available_child_of_node(parent, child) \
	while (0)

386 387 388 389 390 391 392
static inline struct device_node *of_get_child_by_name(
					const struct device_node *node,
					const char *name)
{
	return NULL;
}

393 394 395 396 397
static inline int of_get_child_count(const struct device_node *np)
{
	return 0;
}

398 399 400 401 402
static inline int of_get_available_child_count(const struct device_node *np)
{
	return 0;
}

403 404 405 406 407 408
static inline int of_device_is_compatible(const struct device_node *device,
					  const char *name)
{
	return 0;
}

409 410 411 412 413
static inline int of_device_is_available(const struct device_node *device)
{
	return 0;
}

414 415 416 417 418 419 420
static inline struct property *of_find_property(const struct device_node *np,
						const char *name,
						int *lenp)
{
	return NULL;
}

421 422 423 424 425 426 427 428
static inline struct device_node *of_find_compatible_node(
						struct device_node *from,
						const char *type,
						const char *compat)
{
	return NULL;
}

429 430 431 432 433 434
static inline int of_property_read_u32_index(const struct device_node *np,
			const char *propname, u32 index, u32 *out_value)
{
	return -ENOSYS;
}

435 436 437 438 439 440 441 442 443 444 445 446
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;
}

447
static inline int of_property_read_u32_array(const struct device_node *np,
448 449
					     const char *propname,
					     u32 *out_values, size_t sz)
450 451 452 453 454
{
	return -ENOSYS;
}

static inline int of_property_read_string(struct device_node *np,
455 456
					  const char *propname,
					  const char **out_string)
457 458 459 460
{
	return -ENOSYS;
}

461 462 463 464 465 466 467 468 469 470 471 472 473
static inline int of_property_read_string_index(struct device_node *np,
						const char *propname, int index,
						const char **out_string)
{
	return -ENOSYS;
}

static inline int of_property_count_strings(struct device_node *np,
					    const char *propname)
{
	return -ENOSYS;
}

474 475 476 477 478 479 480
static inline const void *of_get_property(const struct device_node *node,
				const char *name,
				int *lenp)
{
	return NULL;
}

481 482 483 484 485 486
static inline struct device_node *of_get_cpu_node(int cpu,
					unsigned int *thread)
{
	return NULL;
}

487 488 489 490 491 492
static inline int of_property_read_u64(const struct device_node *np,
				       const char *propname, u64 *out_value)
{
	return -ENOSYS;
}

493 494 495 496 497 498 499
static inline int of_property_match_string(struct device_node *np,
					   const char *propname,
					   const char *string)
{
	return -ENOSYS;
}

500
static inline struct device_node *of_parse_phandle(const struct device_node *np,
501 502 503 504 505 506
						   const char *phandle_name,
						   int index)
{
	return NULL;
}

507 508 509 510 511 512 513 514 515
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;
}

516 517 518 519 520 521 522
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;
}

523 524 525 526 527 528 529
static inline int of_count_phandle_with_args(struct device_node *np,
					     const char *list_name,
					     const char *cells_name)
{
	return -ENOSYS;
}

530 531 532 533 534
static inline int of_alias_get_id(struct device_node *np, const char *stem)
{
	return -ENOSYS;
}

535 536 537 538 539
static inline int of_machine_is_compatible(const char *compat)
{
	return 0;
}

540 541 542 543 544
static inline int of_device_is_stdout_path(struct device_node *dn)
{
	return 0;
}

545 546 547 548 549 550 551 552 553 554 555 556
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 已提交
557
#define of_match_ptr(_ptr)	NULL
558
#define of_match_node(_matches, _node)	NULL
559
#endif /* CONFIG_OF */
560

561 562 563 564
#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 已提交
565 566
#endif

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
/**
 * 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;
}

583 584 585 586 587 588 589 590 591 592 593 594 595 596
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);
}

597
static inline int of_property_read_u32(const struct device_node *np,
598
				       const char *propname,
599 600 601 602 603
				       u32 *out_value)
{
	return of_property_read_u32_array(np, propname, out_value, 1);
}

604 605 606 607 608 609 610 611 612 613 614 615
#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))

616 617 618 619 620 621 622 623 624 625
#if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
					 struct property *prop);
extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
					 struct property *newprop,
					 struct property *oldprop);
#endif

626
#endif /* _LINUX_OF_H */