[mirror_ubuntu-jammy-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/kref.h>
#include <linux/mod_devicetable.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	node;
#if !defined(CONFIG_SPARC)
	phandle linux_phandle;
#endif
	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)
	char	*path_component_name;
	unsigned int unique_id;
	struct of_irq_controller *irq_trans;
#endif
};

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

static inline void
set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
{
	dn->pde = de;
}

#if defined(CONFIG_SPARC)
/* 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)
{
}

#else
extern struct device_node *of_find_all_nodes(struct device_node *prev);
extern struct device_node *of_node_get(struct device_node *node);
extern void of_node_put(struct device_node *node);
#endif

/*
 * OF address retreival & translation
 */

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

/* Like of_read_number, but we want an unsigned long result */
#ifdef CONFIG_PPC32
static inline unsigned long of_read_ulong(const u32 *cell, int size)
{
	return cell[size-1];
}
#else
#define of_read_ulong(cell, size)	of_read_number(cell, size)
#endif

#include <asm/prom.h>

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

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

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_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 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_phandles_with_args(struct device_node *np,
	const char *list_name, const char *cells_name, int index,
	struct device_node **out_node, const void **out_args);

#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>
6f192492	20	#include <linux/kref.h>
283029d1	21	#include <linux/mod_devicetable.h>
76c1ce78	22
731581e6 GL	23	typedef u32 phandle;
	24	typedef u32 ihandle;
	25
	26	struct property {
	27	char *name;
	28	int length;
	29	void *value;
	30	struct property *next;
	31	unsigned long _flags;
	32	unsigned int unique_id;
	33	};
	34
6f192492 GL	35	#if defined(CONFIG_SPARC)
	36	struct of_irq_controller;
	37	#endif
	38
	39	struct device_node {
	40	const char *name;
	41	const char *type;
	42	phandle node;
	43	#if !defined(CONFIG_SPARC)
	44	phandle linux_phandle;
	45	#endif
	46	char *full_name;
	47
	48	struct property *properties;
	49	struct property deadprops; / removed properties */
	50	struct device_node *parent;
	51	struct device_node *child;
	52	struct device_node *sibling;
	53	struct device_node next; / next device of same type */
	54	struct device_node allnext; / next in list of all nodes */
	55	struct proc_dir_entry pde; / this node's proc directory */
	56	struct kref kref;
	57	unsigned long _flags;
	58	void *data;
	59	#if defined(CONFIG_SPARC)
	60	char *path_component_name;
	61	unsigned int unique_id;
	62	struct of_irq_controller *irq_trans;
	63	#endif
	64	};
	65
50436312 GL	66	static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
	67	{
	68	return test_bit(flag, &n->_flags);
	69	}
	70
	71	static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
	72	{
	73	set_bit(flag, &n->_flags);
	74	}
	75
	76	static inline void
	77	set_node_proc_entry(struct device_node dn, struct proc_dir_entry de)
	78	{
	79	dn->pde = de;
	80	}
	81
526b5b3e GL	82	#if defined(CONFIG_SPARC)
	83	/* Dummy ref counting routines - to be implemented later */
	84	static inline struct device_node of_node_get(struct device_node node)
	85	{
	86	return node;
	87	}
	88	static inline void of_node_put(struct device_node *node)
	89	{
	90	}
	91
	92	#else
	93	extern struct device_node of_find_all_nodes(struct device_node prev);
	94	extern struct device_node of_node_get(struct device_node node);
	95	extern void of_node_put(struct device_node *node);
	96	#endif
	97
b6caf2ad GL	98	/*
	99	* OF address retreival & translation
	100	*/
	101
	102	/* Helper to read a big number; size is in cells (not bytes) */
	103	static inline u64 of_read_number(const u32 *cell, int size)
	104	{
	105	u64 r = 0;
	106	while (size--)
	107	r = (r << 32) \| *(cell++);
	108	return r;
	109	}
	110
	111	/* Like of_read_number, but we want an unsigned long result */
	112	#ifdef CONFIG_PPC32
	113	static inline unsigned long of_read_ulong(const u32 *cell, int size)
	114	{
	115	return cell[size-1];
	116	}
	117	#else
	118	#define of_read_ulong(cell, size) of_read_number(cell, size)
	119	#endif
	120
76c1ce78 SR	121	#include <asm/prom.h>
	122
	123	/* flag descriptions */
	124	#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
	125	#define OF_DETACHED 2 /* node has been detached from the device tree */
	126
61e955db GL	127	#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
	128	#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
	129
76c1ce78 SR	130	#define OF_BAD_ADDR ((u64)-1)
	131
	132	extern struct device_node of_find_node_by_name(struct device_node from,
	133	const char *name);
	134	#define for_each_node_by_name(dn, name) \
	135	for (dn = of_find_node_by_name(NULL, name); dn; \
	136	dn = of_find_node_by_name(dn, name))
	137	extern struct device_node of_find_node_by_type(struct device_node from,
	138	const char *type);
	139	#define for_each_node_by_type(dn, type) \
	140	for (dn = of_find_node_by_type(NULL, type); dn; \
	141	dn = of_find_node_by_type(dn, type))
	142	extern struct device_node of_find_compatible_node(struct device_node from,
	143	const char type, const char compat);
	144	#define for_each_compatible_node(dn, type, compatible) \
	145	for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
	146	dn = of_find_compatible_node(dn, type, compatible))
283029d1 GL	147	extern struct device_node of_find_matching_node(struct device_node from,
	148	const struct of_device_id *matches);
	149	#define for_each_matching_node(dn, matches) \
	150	for (dn = of_find_matching_node(NULL, matches); dn; \
	151	dn = of_find_matching_node(dn, matches))
76c1ce78 SR	152	extern struct device_node of_find_node_by_path(const char path);
	153	extern struct device_node *of_find_node_by_phandle(phandle handle);
	154	extern struct device_node of_get_parent(const struct device_node node);
f4eb0107	155	extern struct device_node of_get_next_parent(struct device_node node);
76c1ce78 SR	156	extern struct device_node of_get_next_child(const struct device_node node,
76c1ce78 SR	157	struct device_node *prev);
aabc08dc ME	158	#define for_each_child_of_node(parent, child) \
	159	for (child = of_get_next_child(parent, NULL); child != NULL; \
	160	child = of_get_next_child(parent, child))
	161
1e291b14 ME	162	extern struct device_node *of_find_node_with_property(
	163	struct device_node from, const char prop_name);
	164	#define for_each_node_with_property(dn, prop_name) \
	165	for (dn = of_find_node_with_property(NULL, prop_name); dn; \
	166	dn = of_find_node_with_property(dn, prop_name))
	167
76c1ce78 SR	168	extern struct property of_find_property(const struct device_node np,
	169	const char *name,
	170	int *lenp);
	171	extern int of_device_is_compatible(const struct device_node *device,
	172	const char *);
834d97d4	173	extern int of_device_is_available(const struct device_node *device);
76c1ce78 SR	174	extern const void of_get_property(const struct device_node node,
	175	const char *name,
	176	int *lenp);
76c1ce78 SR	177	extern int of_n_addr_cells(struct device_node *np);
76c1ce78 SR	178	extern int of_n_size_cells(struct device_node *np);
283029d1 GL	179	extern const struct of_device_id *of_match_node(
283029d1 GL	180	const struct of_device_id matches, const struct device_node node);
3f07af49	181	extern int of_modalias_node(struct device_node node, char modalias, int len);
739649c5 GL	182	extern struct device_node of_parse_phandle(struct device_node np,
	183	const char *phandle_name,
	184	int index);
64b60e09 AV	185	extern int of_parse_phandles_with_args(struct device_node *np,
	186	const char list_name, const char cells_name, int index,
	187	struct device_node out_node, const void out_args);
76c1ce78 SR	188
76c1ce78 SR	189	#endif /* _LINUX_OF_H */