[mirror_ubuntu-zesty-kernel.git] / include / linux / of.h

#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>
#include <linux/bitops.h>
#include <linux/errno.h>
#include <linux/kref.h>
#include <linux/mod_devicetable.h>
#include <linux/spinlock.h>
#include <linux/topology.h>
#include <linux/notifier.h>

#include <asm/byteorder.h>
#include <asm/errno.h>

typedef u32 phandle;
typedef u32 ihandle;

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

#if defined(CONFIG_SPARC)
struct of_irq_controller;
#endif

struct device_node {
	const char *name;
	const char *type;
	phandle phandle;
	const char *full_name;

	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)
	const char *path_component_name;
	unsigned int unique_id;
	struct of_irq_controller *irq_trans;
#endif
};

#define MAX_PHANDLE_ARGS 8
struct of_phandle_args {
	struct device_node *np;
	int args_count;
	uint32_t args[MAX_PHANDLE_ARGS];
};

#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 */
/* Dummy ref counting routines - to be implemented later */
static inline struct device_node *of_node_get(struct device_node *node)
{
	return node;
}
static inline void of_node_put(struct device_node *node) { }
#endif /* !CONFIG_OF_DYNAMIC */

#ifdef CONFIG_OF

/* Pointer for first entry in chain of all nodes. */
extern struct device_node *of_allnodes;
extern struct device_node *of_chosen;
extern struct device_node *of_aliases;
extern raw_spinlock_t devtree_lock;

static inline bool of_have_populated_dt(void)
{
	return of_allnodes != NULL;
}

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

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);
}

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

/*
 * OF address retrieval & translation
 */

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

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

#include <asm/prom.h>

/* 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)
#define of_compat_cmp(s1, s2, l)	strcasecmp((s1), (s2))
#define of_prop_cmp(s1, s2)		strcmp((s1), (s2))
#define of_node_cmp(s1, s2)		strcasecmp((s1), (s2))
#endif

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

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

#define OF_BAD_ADDR	((u64)-1)

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

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))
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);
}
#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))
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);
extern struct device_node *of_get_next_parent(struct device_node *node);
extern struct device_node *of_get_next_child(const struct device_node *node,
					     struct device_node *prev);
extern struct device_node *of_get_next_available_child(
	const struct device_node *node, struct device_node *prev);

extern struct device_node *of_get_child_by_name(const struct device_node *node,
					const char *name);
#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))

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

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))

extern struct property *of_find_property(const struct device_node *np,
					 const char *name,
					 int *lenp);
extern int of_property_read_u32_index(const struct device_node *np,
				       const char *propname,
				       u32 index, u32 *out_value);
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);
extern int of_property_read_u32_array(const struct device_node *np,
				      const char *propname,
				      u32 *out_values,
				      size_t sz);
extern int of_property_read_u64(const struct device_node *np,
				const char *propname, u64 *out_value);

extern int of_property_read_string(struct device_node *np,
				   const char *propname,
				   const char **out_string);
extern int of_property_read_string_index(struct device_node *np,
					 const char *propname,
					 int index, const char **output);
extern int of_property_match_string(struct device_node *np,
				    const char *propname,
				    const char *string);
extern int of_property_count_strings(struct device_node *np,
				     const char *propname);
extern int of_device_is_compatible(const struct device_node *device,
				   const char *);
extern int of_device_is_available(const struct device_node *device);
extern const void *of_get_property(const struct device_node *node,
				const char *name,
				int *lenp);
extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
#define for_each_property_of_node(dn, pp) \
	for (pp = dn->properties; pp != NULL; pp = pp->next)

extern int of_n_addr_cells(struct device_node *np);
extern int of_n_size_cells(struct device_node *np);
extern const struct of_device_id *of_match_node(
	const struct of_device_id *matches, const struct device_node *node);
extern int of_modalias_node(struct device_node *node, char *modalias, int len);
extern struct device_node *of_parse_phandle(const struct device_node *np,
					    const char *phandle_name,
					    int index);
extern int of_parse_phandle_with_args(const struct device_node *np,
	const char *list_name, const char *cells_name, int index,
	struct of_phandle_args *out_args);
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);
extern int of_count_phandle_with_args(const struct device_node *np,
	const char *list_name, const char *cells_name);

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

extern int of_machine_is_compatible(const char *compat);

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

/* For updating the device tree at runtime */
#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 *);

#define of_match_ptr(_ptr)	(_ptr)

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

int of_device_is_stdout_path(struct device_node *dn);

#else /* CONFIG_OF */

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

static inline struct device_node *of_find_node_by_name(struct device_node *from,
	const char *name)
{
	return NULL;
}

static inline struct device_node *of_get_parent(const struct device_node *node)
{
	return NULL;
}

static inline bool of_have_populated_dt(void)
{
	return false;
}

#define for_each_child_of_node(parent, child) \
	while (0)

static inline struct device_node *of_get_child_by_name(
					const struct device_node *node,
					const char *name)
{
	return NULL;
}

static inline int of_get_child_count(const struct device_node *np)
{
	return 0;
}

static inline int of_device_is_compatible(const struct device_node *device,
					  const char *name)
{
	return 0;
}

static inline int of_device_is_available(const struct device_node *device)
{
	return 0;
}

static inline struct property *of_find_property(const struct device_node *np,
						const char *name,
						int *lenp)
{
	return NULL;
}

static inline struct device_node *of_find_compatible_node(
						struct device_node *from,
						const char *type,
						const char *compat)
{
	return NULL;
}

static inline int of_property_read_u32_index(const struct device_node *np,
			const char *propname, u32 index, u32 *out_value)
{
	return -ENOSYS;
}

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

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

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

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

static inline const void *of_get_property(const struct device_node *node,
				const char *name,
				int *lenp)
{
	return NULL;
}

static inline struct device_node *of_get_cpu_node(int cpu,
					unsigned int *thread)
{
	return NULL;
}

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

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

static inline struct device_node *of_parse_phandle(const struct device_node *np,
						   const char *phandle_name,
						   int index)
{
	return NULL;
}

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

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

static inline int of_count_phandle_with_args(struct device_node *np,
					     const char *list_name,
					     const char *cells_name)
{
	return -ENOSYS;
}

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

static inline int of_machine_is_compatible(const char *compat)
{
	return 0;
}

static inline int of_device_is_stdout_path(struct device_node *dn)
{
	return 0;
}

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

#define of_match_ptr(_ptr)	NULL
#define of_match_node(_matches, _node)	NULL
#endif /* CONFIG_OF */

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

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

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);
}

static inline int of_property_read_u32(const struct device_node *np,
				       const char *propname,
				       u32 *out_value)
{
	return of_property_read_u32_array(np, propname, out_value, 1);
}

#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))

#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

#endif /* _LINUX_OF_H */
Commit	Line	Data
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>
6f192492	21	#include <linux/kref.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	30	typedef u32 phandle;
	31	typedef u32 ihandle;
	32
	33	struct property {
	34	char *name;
	35	int length;
	36	void *value;
	37	struct property *next;
	38	unsigned long _flags;
	39	unsigned int unique_id;
	40	};
	41
6f192492 GL	42	#if defined(CONFIG_SPARC)
	43	struct of_irq_controller;
	44	#endif
	45
	46	struct device_node {
	47	const char *name;
	48	const char *type;
6016a363	49	phandle phandle;
c22618a1	50	const char *full_name;
6f192492 GL	51
	52	struct property *properties;
	53	struct property deadprops; / removed properties */
	54	struct device_node *parent;
	55	struct device_node *child;
	56	struct device_node *sibling;
	57	struct device_node next; / next device of same type */
	58	struct device_node allnext; / next in list of all nodes */
	59	struct proc_dir_entry pde; / this node's proc directory */
	60	struct kref kref;
	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
15c9a0ac GL	70	#define MAX_PHANDLE_ARGS 8
	71	struct of_phandle_args {
	72	struct device_node *np;
	73	int args_count;
	74	uint32_t args[MAX_PHANDLE_ARGS];
	75	};
	76
0f22dd39 GL	77	#ifdef CONFIG_OF_DYNAMIC
	78	extern struct device_node of_node_get(struct device_node node);
	79	extern void of_node_put(struct device_node *node);
	80	#else /* CONFIG_OF_DYNAMIC */
3ecdd051 RH	81	/* Dummy ref counting routines - to be implemented later */
	82	static inline struct device_node of_node_get(struct device_node node)
	83	{
	84	return node;
	85	}
0f22dd39 GL	86	static inline void of_node_put(struct device_node *node) { }
0f22dd39 GL	87	#endif /* !CONFIG_OF_DYNAMIC */
3ecdd051	88
c9e358df GL	89	#ifdef CONFIG_OF
c9e358df GL	90
41f88009	91	/* Pointer for first entry in chain of all nodes. */
465aac6d	92	extern struct device_node *of_allnodes;
fc0bdae4	93	extern struct device_node *of_chosen;
611cad72	94	extern struct device_node *of_aliases;
d6d3c4e6	95	extern raw_spinlock_t devtree_lock;
41f88009	96
3bcbaf6e SAS	97	static inline bool of_have_populated_dt(void)
3bcbaf6e SAS	98	{
465aac6d	99	return of_allnodes != NULL;
3bcbaf6e SAS	100	}
3bcbaf6e SAS	101
035ebefc AS	102	static inline bool of_node_is_root(const struct device_node *node)
	103	{
	104	return node && (node->parent == NULL);
	105	}
	106
50436312 GL	107	static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
	108	{
	109	return test_bit(flag, &n->_flags);
	110	}
	111
	112	static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
	113	{
	114	set_bit(flag, &n->_flags);
	115	}
	116
e91edcf5 GL	117	extern struct device_node of_find_all_nodes(struct device_node prev);
e91edcf5 GL	118
b6caf2ad	119	/*
3d6b8828	120	* OF address retrieval & translation
b6caf2ad GL	121	*/
	122
	123	/* Helper to read a big number; size is in cells (not bytes) */
2e89e685	124	static inline u64 of_read_number(const __be32 *cell, int size)
b6caf2ad GL	125	{
	126	u64 r = 0;
	127	while (size--)
2e89e685	128	r = (r << 32) \| be32_to_cpu(*(cell++));
b6caf2ad GL	129	return r;
	130	}
	131
	132	/* Like of_read_number, but we want an unsigned long result */
2e89e685	133	static inline unsigned long of_read_ulong(const __be32 *cell, int size)
b6caf2ad	134	{
2be09cb9 GL	135	/* toss away upper bits if unsigned long is smaller than u64 */
2be09cb9 GL	136	return of_read_number(cell, size);
b6caf2ad	137	}
b6caf2ad	138
76c1ce78 SR	139	#include <asm/prom.h>
76c1ce78 SR	140
7c7b60cb GL	141	/* Default #address and #size cells. Allow arch asm/prom.h to override */
	142	#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
	143	#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
	144	#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
	145	#endif
	146
	147	/* Default string compare functions, Allow arch asm/prom.h to override */
	148	#if !defined(of_compat_cmp)
1976152f	149	#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
7c7b60cb GL	150	#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
	151	#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
	152	#endif
	153
76c1ce78 SR	154	/* flag descriptions */
	155	#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
	156	#define OF_DETACHED 2 /* node has been detached from the device tree */
	157
61e955db GL	158	#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
	159	#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
	160
76c1ce78 SR	161	#define OF_BAD_ADDR ((u64)-1)
76c1ce78 SR	162
c0a05bf0	163	static inline const char of_node_full_name(const struct device_node np)
74a7f084 GL	164	{
	165	return np ? np->full_name : "<no-node>";
	166	}
	167
76c1ce78 SR	168	extern struct device_node of_find_node_by_name(struct device_node from,
	169	const char *name);
	170	#define for_each_node_by_name(dn, name) \
	171	for (dn = of_find_node_by_name(NULL, name); dn; \
	172	dn = of_find_node_by_name(dn, name))
	173	extern struct device_node of_find_node_by_type(struct device_node from,
	174	const char *type);
	175	#define for_each_node_by_type(dn, type) \
	176	for (dn = of_find_node_by_type(NULL, type); dn; \
	177	dn = of_find_node_by_type(dn, type))
	178	extern struct device_node of_find_compatible_node(struct device_node from,
	179	const char type, const char compat);
	180	#define for_each_compatible_node(dn, type, compatible) \
	181	for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
	182	dn = of_find_compatible_node(dn, type, compatible))
50c8af4c SW	183	extern struct device_node *of_find_matching_node_and_match(
	184	struct device_node *from,
	185	const struct of_device_id *matches,
	186	const struct of_device_id **match);
	187	static inline struct device_node *of_find_matching_node(
	188	struct device_node *from,
	189	const struct of_device_id *matches)
	190	{
	191	return of_find_matching_node_and_match(from, matches, NULL);
	192	}
283029d1 GL	193	#define for_each_matching_node(dn, matches) \
	194	for (dn = of_find_matching_node(NULL, matches); dn; \
	195	dn = of_find_matching_node(dn, matches))
50c8af4c SW	196	#define for_each_matching_node_and_match(dn, matches, match) \
	197	for (dn = of_find_matching_node_and_match(NULL, matches, match); \
	198	dn; dn = of_find_matching_node_and_match(dn, matches, match))
76c1ce78 SR	199	extern struct device_node of_find_node_by_path(const char path);
	200	extern struct device_node *of_find_node_by_phandle(phandle handle);
	201	extern struct device_node of_get_parent(const struct device_node node);
f4eb0107	202	extern struct device_node of_get_next_parent(struct device_node node);
76c1ce78 SR	203	extern struct device_node of_get_next_child(const struct device_node node,
76c1ce78 SR	204	struct device_node *prev);
3296193d TT	205	extern struct device_node *of_get_next_available_child(
	206	const struct device_node node, struct device_node prev);
	207
9c19761a SK	208	extern struct device_node of_get_child_by_name(const struct device_node node,
9c19761a SK	209	const char *name);
aabc08dc ME	210	#define for_each_child_of_node(parent, child) \
	211	for (child = of_get_next_child(parent, NULL); child != NULL; \
	212	child = of_get_next_child(parent, child))
	213
3296193d TT	214	#define for_each_available_child_of_node(parent, child) \
	215	for (child = of_get_next_available_child(parent, NULL); child != NULL; \
	216	child = of_get_next_available_child(parent, child))
	217
183f1d0c DA	218	static inline int of_get_child_count(const struct device_node *np)
	219	{
	220	struct device_node *child;
	221	int num = 0;
	222
	223	for_each_child_of_node(np, child)
	224	num++;
	225
	226	return num;
	227	}
	228
1e291b14 ME	229	extern struct device_node *of_find_node_with_property(
	230	struct device_node from, const char prop_name);
	231	#define for_each_node_with_property(dn, prop_name) \
	232	for (dn = of_find_node_with_property(NULL, prop_name); dn; \
	233	dn = of_find_node_with_property(dn, prop_name))
	234
76c1ce78 SR	235	extern struct property of_find_property(const struct device_node np,
	236	const char *name,
	237	int *lenp);
3daf3726 TP	238	extern int of_property_read_u32_index(const struct device_node *np,
	239	const char *propname,
	240	u32 index, u32 *out_value);
be193249 VK	241	extern int of_property_read_u8_array(const struct device_node *np,
	242	const char propname, u8 out_values, size_t sz);
	243	extern int of_property_read_u16_array(const struct device_node *np,
	244	const char propname, u16 out_values, size_t sz);
0e373639	245	extern int of_property_read_u32_array(const struct device_node *np,
aac285c6	246	const char *propname,
0e373639 RH	247	u32 *out_values,
0e373639 RH	248	size_t sz);
4cd7f7a3 JI	249	extern int of_property_read_u64(const struct device_node *np,
4cd7f7a3 JI	250	const char propname, u64 out_value);
0e373639	251
aac285c6 JI	252	extern int of_property_read_string(struct device_node *np,
	253	const char *propname,
	254	const char **out_string);
4fcd15a0 BC	255	extern int of_property_read_string_index(struct device_node *np,
	256	const char *propname,
	257	int index, const char **output);
7aff0fe3 GL	258	extern int of_property_match_string(struct device_node *np,
	259	const char *propname,
	260	const char *string);
4fcd15a0 BC	261	extern int of_property_count_strings(struct device_node *np,
4fcd15a0 BC	262	const char *propname);
76c1ce78 SR	263	extern int of_device_is_compatible(const struct device_node *device,
76c1ce78 SR	264	const char *);
834d97d4	265	extern int of_device_is_available(const struct device_node *device);
76c1ce78 SR	266	extern const void of_get_property(const struct device_node node,
	267	const char *name,
	268	int *lenp);
183912d3	269	extern struct device_node of_get_cpu_node(int cpu, unsigned int thread);
8af0da93 DA	270	#define for_each_property_of_node(dn, pp) \
8af0da93 DA	271	for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72	272
76c1ce78 SR	273	extern int of_n_addr_cells(struct device_node *np);
76c1ce78 SR	274	extern int of_n_size_cells(struct device_node *np);
283029d1 GL	275	extern const struct of_device_id *of_match_node(
283029d1 GL	276	const struct of_device_id matches, const struct device_node node);
3f07af49	277	extern int of_modalias_node(struct device_node node, char modalias, int len);
b8fbdc42	278	extern struct device_node of_parse_phandle(const struct device_node np,
739649c5 GL	279	const char *phandle_name,
739649c5 GL	280	int index);
93c667ca	281	extern int of_parse_phandle_with_args(const struct device_node *np,
64b60e09	282	const char list_name, const char cells_name, int index,
15c9a0ac	283	struct of_phandle_args *out_args);
035fd948 SW	284	extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
	285	const char *list_name, int cells_count, int index,
	286	struct of_phandle_args *out_args);
bd69f73f GL	287	extern int of_count_phandle_with_args(const struct device_node *np,
bd69f73f GL	288	const char list_name, const char cells_name);
76c1ce78	289
611cad72 SG	290	extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
	291	extern int of_alias_get_id(struct device_node np, const char stem);
	292
21b082ec GL	293	extern int of_machine_is_compatible(const char *compat);
21b082ec GL	294
79d1c712 NF	295	extern int of_add_property(struct device_node np, struct property prop);
	296	extern int of_remove_property(struct device_node np, struct property prop);
	297	extern int of_update_property(struct device_node np, struct property newprop);
21b082ec	298
fcdeb7fe	299	/* For updating the device tree at runtime */
1cf3d8b3 NF	300	#define OF_RECONFIG_ATTACH_NODE 0x0001
	301	#define OF_RECONFIG_DETACH_NODE 0x0002
	302	#define OF_RECONFIG_ADD_PROPERTY 0x0003
	303	#define OF_RECONFIG_REMOVE_PROPERTY 0x0004
	304	#define OF_RECONFIG_UPDATE_PROPERTY 0x0005
	305
	306	struct of_prop_reconfig {
	307	struct device_node *dn;
	308	struct property *prop;
	309	};
	310
	311	extern int of_reconfig_notifier_register(struct notifier_block *);
	312	extern int of_reconfig_notifier_unregister(struct notifier_block *);
	313	extern int of_reconfig_notify(unsigned long, void *);
	314
	315	extern int of_attach_node(struct device_node *);
	316	extern int of_detach_node(struct device_node *);
fcdeb7fe	317
3a1e362e	318	#define of_match_ptr(_ptr) (_ptr)
c541adc6 SW	319
	320	/*
	321	* struct property *prop;
	322	* const __be32 *p;
	323	* u32 u;
	324	*
	325	* of_property_for_each_u32(np, "propname", prop, p, u)
	326	* printk("U32 value: %x\n", u);
	327	*/
	328	const __be32 of_prop_next_u32(struct property prop, const __be32 *cur,
	329	u32 *pu);
c541adc6 SW	330	/*
	331	* struct property *prop;
	332	* const char *s;
	333	*
	334	* of_property_for_each_string(np, "propname", prop, s)
	335	* printk("String value: %s\n", s);
	336	*/
	337	const char of_prop_next_string(struct property prop, const char *cur);
c541adc6	338
5c19e952 SH	339	int of_device_is_stdout_path(struct device_node *dn);
5c19e952 SH	340
b98c0239	341	#else /* CONFIG_OF */
3bcbaf6e	342
74a7f084 GL	343	static inline const char* of_node_full_name(struct device_node *np)
	344	{
	345	return "<no-node>";
	346	}
	347
1cc44f43 PU	348	static inline struct device_node of_find_node_by_name(struct device_node from,
	349	const char *name)
	350	{
	351	return NULL;
	352	}
	353
066ec1dd AS	354	static inline struct device_node of_get_parent(const struct device_node node)
	355	{
	356	return NULL;
	357	}
	358
3bcbaf6e SAS	359	static inline bool of_have_populated_dt(void)
	360	{
	361	return false;
	362	}
	363
aba3dfff SW	364	#define for_each_child_of_node(parent, child) \
	365	while (0)
	366
25c040c9 OJ	367	static inline struct device_node *of_get_child_by_name(
	368	const struct device_node *node,
	369	const char *name)
	370	{
	371	return NULL;
	372	}
	373
183f1d0c DA	374	static inline int of_get_child_count(const struct device_node *np)
	375	{
	376	return 0;
	377	}
	378
36a0904e RN	379	static inline int of_device_is_compatible(const struct device_node *device,
	380	const char *name)
	381	{
	382	return 0;
	383	}
	384
d7195696 RH	385	static inline int of_device_is_available(const struct device_node *device)
	386	{
	387	return 0;
	388	}
	389
aba3dfff SW	390	static inline struct property of_find_property(const struct device_node np,
	391	const char *name,
	392	int *lenp)
	393	{
	394	return NULL;
	395	}
	396
2261cc62 SG	397	static inline struct device_node *of_find_compatible_node(
	398	struct device_node *from,
	399	const char *type,
	400	const char *compat)
	401	{
	402	return NULL;
	403	}
	404
3daf3726 TP	405	static inline int of_property_read_u32_index(const struct device_node *np,
	406	const char propname, u32 index, u32 out_value)
	407	{
	408	return -ENOSYS;
	409	}
	410
be193249 VK	411	static inline int of_property_read_u8_array(const struct device_node *np,
	412	const char propname, u8 out_values, size_t sz)
	413	{
	414	return -ENOSYS;
	415	}
	416
	417	static inline int of_property_read_u16_array(const struct device_node *np,
	418	const char propname, u16 out_values, size_t sz)
	419	{
	420	return -ENOSYS;
	421	}
	422
b98c0239	423	static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6 JI	424	const char *propname,
aac285c6 JI	425	u32 *out_values, size_t sz)
b98c0239 SG	426	{
	427	return -ENOSYS;
	428	}
	429
	430	static inline int of_property_read_string(struct device_node *np,
aac285c6 JI	431	const char *propname,
aac285c6 JI	432	const char **out_string)
b98c0239 SG	433	{
	434	return -ENOSYS;
	435	}
	436
4fcd15a0 BC	437	static inline int of_property_read_string_index(struct device_node *np,
	438	const char *propname, int index,
	439	const char **out_string)
	440	{
	441	return -ENOSYS;
	442	}
	443
	444	static inline int of_property_count_strings(struct device_node *np,
	445	const char *propname)
	446	{
	447	return -ENOSYS;
	448	}
	449
89272b8c SW	450	static inline const void of_get_property(const struct device_node node,
	451	const char *name,
	452	int *lenp)
	453	{
	454	return NULL;
	455	}
	456
183912d3 SH	457	static inline struct device_node *of_get_cpu_node(int cpu,
	458	unsigned int *thread)
	459	{
	460	return NULL;
	461	}
	462
4cd7f7a3 JI	463	static inline int of_property_read_u64(const struct device_node *np,
	464	const char propname, u64 out_value)
	465	{
	466	return -ENOSYS;
	467	}
	468
bd3d5500 TR	469	static inline int of_property_match_string(struct device_node *np,
	470	const char *propname,
	471	const char *string)
	472	{
	473	return -ENOSYS;
	474	}
	475
b8fbdc42	476	static inline struct device_node of_parse_phandle(const struct device_node np,
36a0904e RN	477	const char *phandle_name,
	478	int index)
	479	{
	480	return NULL;
	481	}
	482
e05e5070 TR	483	static inline int of_parse_phandle_with_args(struct device_node *np,
	484	const char *list_name,
	485	const char *cells_name,
	486	int index,
	487	struct of_phandle_args *out_args)
	488	{
	489	return -ENOSYS;
	490	}
	491
035fd948 SW	492	static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
	493	const char *list_name, int cells_count, int index,
	494	struct of_phandle_args *out_args)
	495	{
	496	return -ENOSYS;
	497	}
	498
bd69f73f GL	499	static inline int of_count_phandle_with_args(struct device_node *np,
	500	const char *list_name,
	501	const char *cells_name)
	502	{
	503	return -ENOSYS;
	504	}
	505
ed5f886d NF	506	static inline int of_alias_get_id(struct device_node np, const char stem)
	507	{
	508	return -ENOSYS;
	509	}
	510
50e07f88 SW	511	static inline int of_machine_is_compatible(const char *compat)
	512	{
	513	return 0;
	514	}
	515
5c19e952 SH	516	static inline int of_device_is_stdout_path(struct device_node *dn)
	517	{
	518	return 0;
	519	}
	520
2adfffa2 SAS	521	static inline const __be32 of_prop_next_u32(struct property prop,
	522	const __be32 cur, u32 pu)
	523	{
	524	return NULL;
	525	}
	526
	527	static inline const char of_prop_next_string(struct property prop,
	528	const char *cur)
	529	{
	530	return NULL;
	531	}
	532
3a1e362e	533	#define of_match_ptr(_ptr) NULL
5762c205	534	#define of_match_node(_matches, _node) NULL
9dfbf207	535	#endif /* CONFIG_OF */
b98c0239	536
0c3f061c RH	537	#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
	538	extern int of_node_to_nid(struct device_node *np);
	539	#else
	540	static inline int of_node_to_nid(struct device_node *device) { return 0; }
5ca4db61 PM	541	#endif
5ca4db61 PM	542
fa4d34cc JCPV	543	/**
	544	* of_property_read_bool - Findfrom a property
	545	* @np: device node from which the property value is to be read.
	546	* @propname: name of the property to be searched.
	547	*
	548	* Search for a property in a device node.
	549	* Returns true if the property exist false otherwise.
	550	*/
	551	static inline bool of_property_read_bool(const struct device_node *np,
	552	const char *propname)
	553	{
	554	struct property *prop = of_find_property(np, propname, NULL);
	555
	556	return prop ? true : false;
	557	}
	558
be193249 VK	559	static inline int of_property_read_u8(const struct device_node *np,
	560	const char *propname,
	561	u8 *out_value)
	562	{
	563	return of_property_read_u8_array(np, propname, out_value, 1);
	564	}
	565
	566	static inline int of_property_read_u16(const struct device_node *np,
	567	const char *propname,
	568	u16 *out_value)
	569	{
	570	return of_property_read_u16_array(np, propname, out_value, 1);
	571	}
	572
b98c0239	573	static inline int of_property_read_u32(const struct device_node *np,
aac285c6	574	const char *propname,
b98c0239 SG	575	u32 *out_value)
	576	{
	577	return of_property_read_u32_array(np, propname, out_value, 1);
	578	}
	579
2adfffa2 SAS	580	#define of_property_for_each_u32(np, propname, prop, p, u) \
	581	for (prop = of_find_property(np, propname, NULL), \
	582	p = of_prop_next_u32(prop, NULL, &u); \
	583	p; \
	584	p = of_prop_next_u32(prop, p, &u))
	585
	586	#define of_property_for_each_string(np, propname, prop, s) \
	587	for (prop = of_find_property(np, propname, NULL), \
	588	s = of_prop_next_string(prop, NULL); \
	589	s; \
	590	s = of_prop_next_string(prop, s))
	591
34db8aaf DH	592	#if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
	593	extern void proc_device_tree_add_node(struct device_node , struct proc_dir_entry );
	594	extern void proc_device_tree_add_prop(struct proc_dir_entry pde, struct property prop);
	595	extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
	596	struct property *prop);
	597	extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
	598	struct property *newprop,
	599	struct property *oldprop);
	600	#endif
	601
76c1ce78	602	#endif /* _LINUX_OF_H */