of.h 18.4 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 59

	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 */
60
	struct	kobject kobj;
G
Grant Likely 已提交
61 62 63
	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
};

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

77 78
extern int of_node_add(struct device_node *node);

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

91 92
#ifdef CONFIG_OF

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

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

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

109 110 111 112 113 114 115 116 117 118
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);
}

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
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);
}

139 140
extern struct device_node *of_find_all_nodes(struct device_node *prev);

141
/*
L
Lennert Buytenhek 已提交
142
 * OF address retrieval & translation
143 144 145
 */

/* Helper to read a big number; size is in cells (not bytes) */
146
static inline u64 of_read_number(const __be32 *cell, int size)
147 148 149
{
	u64 r = 0;
	while (size--)
150
		r = (r << 32) | be32_to_cpu(*(cell++));
151 152 153 154
	return r;
}

/* Like of_read_number, but we want an unsigned long result */
155
static inline unsigned long of_read_ulong(const __be32 *cell, int size)
156
{
157 158
	/* toss away upper bits if unsigned long is smaller than u64 */
	return of_read_number(cell, size);
159 160
}

R
Rob Herring 已提交
161
#if defined(CONFIG_SPARC)
162
#include <asm/prom.h>
R
Rob Herring 已提交
163
#endif
164

165 166 167 168 169 170 171 172
/* 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)
173
#define of_compat_cmp(s1, s2, l)	strcasecmp((s1), (s2))
174 175 176 177
#define of_prop_cmp(s1, s2)		strcmp((s1), (s2))
#define of_node_cmp(s1, s2)		strcasecmp((s1), (s2))
#endif

178 179 180 181
/* 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 */

182 183 184
#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)

185 186
#define OF_BAD_ADDR	((u64)-1)

187
static inline const char *of_node_full_name(const struct device_node *np)
188 189 190 191
{
	return np ? np->full_name : "<no-node>";
}

192 193
#define for_each_of_allnodes(dn) \
	for (dn = of_allnodes; dn; dn = dn->allnext)
194 195 196 197 198 199
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);
200 201 202 203
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);
204

205 206 207
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);
208
extern struct device_node *of_get_next_parent(struct device_node *node);
209 210
extern struct device_node *of_get_next_child(const struct device_node *node,
					     struct device_node *prev);
211 212 213
extern struct device_node *of_get_next_available_child(
	const struct device_node *node, struct device_node *prev);

214 215
extern struct device_node *of_get_child_by_name(const struct device_node *node,
					const char *name);
216

217 218
/* cache lookup */
extern struct device_node *of_find_next_cache_node(const struct device_node *);
219 220 221
extern struct device_node *of_find_node_with_property(
	struct device_node *from, const char *prop_name);

222 223 224
extern struct property *of_find_property(const struct device_node *np,
					 const char *name,
					 int *lenp);
225 226 227
extern int of_property_read_u32_index(const struct device_node *np,
				       const char *propname,
				       u32 index, u32 *out_value);
228 229 230 231
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);
232
extern int of_property_read_u32_array(const struct device_node *np,
233
				      const char *propname,
234 235
				      u32 *out_values,
				      size_t sz);
236 237
extern int of_property_read_u64(const struct device_node *np,
				const char *propname, u64 *out_value);
238

239 240 241
extern int of_property_read_string(struct device_node *np,
				   const char *propname,
				   const char **out_string);
242 243 244
extern int of_property_read_string_index(struct device_node *np,
					 const char *propname,
					 int index, const char **output);
245 246 247
extern int of_property_match_string(struct device_node *np,
				    const char *propname,
				    const char *string);
248 249
extern int of_property_count_strings(struct device_node *np,
				     const char *propname);
250 251
extern int of_device_is_compatible(const struct device_node *device,
				   const char *);
252
extern int of_device_is_available(const struct device_node *device);
253 254 255
extern const void *of_get_property(const struct device_node *node,
				const char *name,
				int *lenp);
256
extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
257 258
#define for_each_property_of_node(dn, pp) \
	for (pp = dn->properties; pp != NULL; pp = pp->next)
259

260 261
extern int of_n_addr_cells(struct device_node *np);
extern int of_n_size_cells(struct device_node *np);
262 263
extern const struct of_device_id *of_match_node(
	const struct of_device_id *matches, const struct device_node *node);
264
extern int of_modalias_node(struct device_node *node, char *modalias, int len);
265
extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
266
extern struct device_node *of_parse_phandle(const struct device_node *np,
267 268
					    const char *phandle_name,
					    int index);
269
extern int of_parse_phandle_with_args(const struct device_node *np,
270
	const char *list_name, const char *cells_name, int index,
271
	struct of_phandle_args *out_args);
272 273 274
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);
275 276
extern int of_count_phandle_with_args(const struct device_node *np,
	const char *list_name, const char *cells_name);
277

278 279 280
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);

281 282
extern int of_machine_is_compatible(const char *compat);

283 284 285
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);
286

287
/* For updating the device tree at runtime */
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
#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 *);
305

B
Ben Dooks 已提交
306
#define of_match_ptr(_ptr)	(_ptr)
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

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

327 328
int of_device_is_stdout_path(struct device_node *dn);

329
#else /* CONFIG_OF */
330

331 332 333 334 335
static inline const char* of_node_full_name(struct device_node *np)
{
	return "<no-node>";
}

336 337 338 339 340 341
static inline struct device_node *of_find_node_by_name(struct device_node *from,
	const char *name)
{
	return NULL;
}

342 343
static inline struct device_node *of_find_node_by_type(struct device_node *from,
	const char *type)
344 345 346 347
{
	return NULL;
}

348 349 350 351
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)
352
{
353
	return NULL;
354 355
}

356
static inline struct device_node *of_get_parent(const struct device_node *node)
357
{
358
	return NULL;
359 360
}

361 362 363 364 365
static inline struct device_node *of_get_next_child(
	const struct device_node *node, struct device_node *prev)
{
	return NULL;
}
366

367 368 369 370 371
static inline struct device_node *of_get_next_available_child(
	const struct device_node *node, struct device_node *prev)
{
	return NULL;
}
372

373 374
static inline struct device_node *of_find_node_with_property(
	struct device_node *from, const char *prop_name)
375 376 377 378
{
	return NULL;
}

379
static inline bool of_have_populated_dt(void)
380
{
381
	return false;
382 383
}

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

391 392 393 394 395 396
static inline int of_device_is_compatible(const struct device_node *device,
					  const char *name)
{
	return 0;
}

397 398 399 400 401
static inline int of_device_is_available(const struct device_node *device)
{
	return 0;
}

402 403 404 405 406 407 408
static inline struct property *of_find_property(const struct device_node *np,
						const char *name,
						int *lenp)
{
	return NULL;
}

409 410 411 412 413 414 415 416
static inline struct device_node *of_find_compatible_node(
						struct device_node *from,
						const char *type,
						const char *compat)
{
	return NULL;
}

417 418 419 420 421 422
static inline int of_property_read_u32_index(const struct device_node *np,
			const char *propname, u32 index, u32 *out_value)
{
	return -ENOSYS;
}

423 424 425 426 427 428 429 430 431 432 433 434
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;
}

435
static inline int of_property_read_u32_array(const struct device_node *np,
436 437
					     const char *propname,
					     u32 *out_values, size_t sz)
438 439 440 441 442
{
	return -ENOSYS;
}

static inline int of_property_read_string(struct device_node *np,
443 444
					  const char *propname,
					  const char **out_string)
445 446 447 448
{
	return -ENOSYS;
}

449 450 451 452 453 454 455 456 457 458 459 460 461
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;
}

462 463 464 465 466 467 468
static inline const void *of_get_property(const struct device_node *node,
				const char *name,
				int *lenp)
{
	return NULL;
}

469 470 471 472 473 474
static inline struct device_node *of_get_cpu_node(int cpu,
					unsigned int *thread)
{
	return NULL;
}

475 476 477 478 479 480
static inline int of_property_read_u64(const struct device_node *np,
				       const char *propname, u64 *out_value)
{
	return -ENOSYS;
}

481 482 483 484 485 486 487
static inline int of_property_match_string(struct device_node *np,
					   const char *propname,
					   const char *string)
{
	return -ENOSYS;
}

488
static inline struct device_node *of_parse_phandle(const struct device_node *np,
489 490 491 492 493 494
						   const char *phandle_name,
						   int index)
{
	return NULL;
}

495 496 497 498 499 500 501 502 503
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;
}

504 505 506 507 508 509 510
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;
}

511 512 513 514 515 516 517
static inline int of_count_phandle_with_args(struct device_node *np,
					     const char *list_name,
					     const char *cells_name)
{
	return -ENOSYS;
}

518 519 520 521 522
static inline int of_alias_get_id(struct device_node *np, const char *stem)
{
	return -ENOSYS;
}

523 524 525 526 527
static inline int of_machine_is_compatible(const char *compat)
{
	return 0;
}

528 529 530 531 532
static inline int of_device_is_stdout_path(struct device_node *dn)
{
	return 0;
}

533 534 535 536 537 538 539 540 541 542 543 544
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 已提交
545
#define of_match_ptr(_ptr)	NULL
546
#define of_match_node(_matches, _node)	NULL
547
#endif /* CONFIG_OF */
548

549 550 551 552
#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 已提交
553 554
#endif

555 556 557 558 559 560 561
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);
}

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
/**
 * 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;
}

578 579 580 581 582 583 584 585 586 587 588 589 590 591
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);
}

592
static inline int of_property_read_u32(const struct device_node *np,
593
				       const char *propname,
594 595 596 597 598
				       u32 *out_value)
{
	return of_property_read_u32_array(np, propname, out_value, 1);
}

599 600 601 602 603 604 605 606 607 608 609 610
#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))

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 659
#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;
}

660
#endif /* _LINUX_OF_H */