[mirror_ubuntu-bionic-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 <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 *allnodes;
extern struct device_node *of_chosen;
extern struct device_node *of_aliases;
extern rwlock_t devtree_lock;

static inline bool of_have_populated_dt(void)
{
	return 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(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(struct device_node *from,
	const struct of_device_id *matches);
#define for_each_matching_node(dn, matches) \
	for (dn = of_find_matching_node(NULL, matches); dn; \
	     dn = of_find_matching_node(dn, matches))
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_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);
#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(struct device_node *np,
					    const char *phandle_name,
					    int index);
extern 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);

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 prom_add_property(struct device_node* np, struct property* prop);
extern int prom_remove_property(struct device_node *np, struct property *prop);
extern int prom_update_property(struct device_node *np,
				struct property *newprop);

#if defined(CONFIG_OF_DYNAMIC)
/* For updating the device tree at runtime */
extern void of_attach_node(struct device_node *);
extern void of_detach_node(struct device_node *);
#endif

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

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

#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 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 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_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 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(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_alias_get_id(struct device_node *np, const char *stem)
{
	return -ENOSYS;
}

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

#define of_match_ptr(_ptr)	NULL
#define of_match_node(_matches, _node)	NULL
#define of_property_for_each_u32(np, propname, prop, p, u) \
	while (0)
#define of_property_for_each_string(np, propname, prop, s) \
	while (0)
#endif /* CONFIG_OF */

#ifndef of_node_to_nid
static inline int of_node_to_nid(struct device_node *np)
{
	return numa_node_id();
}

#define of_node_to_nid of_node_to_nid
#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);
}

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