[deliverable/linux.git] / arch / sparc / prom / tree_64.c

/*
 * tree.c: Basic device tree traversal/scanning for the Linux
 *         prom library.
 *
 * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
 * Copyright (C) 1996,1997 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
 */

#include <linux/string.h>
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/module.h>

#include <asm/openprom.h>
#include <asm/oplib.h>
#include <asm/ldc.h>

/* Return the child of node 'node' or zero if no this node has no
 * direct descendent.
 */
inline int __prom_getchild(int node)
{
	return p1275_cmd ("child", P1275_INOUT(1, 1), node);
}

inline int prom_getchild(int node)
{
	int cnode;

	if(node == -1) return 0;
	cnode = __prom_getchild(node);
	if(cnode == -1) return 0;
	return (int)cnode;
}
EXPORT_SYMBOL(prom_getchild);

inline int prom_getparent(int node)
{
	int cnode;

	if(node == -1) return 0;
	cnode = p1275_cmd ("parent", P1275_INOUT(1, 1), node);
	if(cnode == -1) return 0;
	return (int)cnode;
}

/* Return the next sibling of node 'node' or zero if no more siblings
 * at this level of depth in the tree.
 */
inline int __prom_getsibling(int node)
{
	return p1275_cmd(prom_peer_name, P1275_INOUT(1, 1), node);
}

inline int prom_getsibling(int node)
{
	int sibnode;

	if (node == -1)
		return 0;
	sibnode = __prom_getsibling(node);
	if (sibnode == -1)
		return 0;

	return sibnode;
}
EXPORT_SYMBOL(prom_getsibling);

/* Return the length in bytes of property 'prop' at node 'node'.
 * Return -1 on error.
 */
inline int prom_getproplen(int node, const char *prop)
{
	if((!node) || (!prop)) return -1;
	return p1275_cmd ("getproplen", 
			  P1275_ARG(1,P1275_ARG_IN_STRING)|
			  P1275_INOUT(2, 1), 
			  node, prop);
}
EXPORT_SYMBOL(prom_getproplen);

/* Acquire a property 'prop' at node 'node' and place it in
 * 'buffer' which has a size of 'bufsize'.  If the acquisition
 * was successful the length will be returned, else -1 is returned.
 */
inline int prom_getproperty(int node, const char *prop,
			    char *buffer, int bufsize)
{
	int plen;

	plen = prom_getproplen(node, prop);
	if ((plen > bufsize) || (plen == 0) || (plen == -1)) {
		return -1;
	} else {
		/* Ok, things seem all right. */
		return p1275_cmd(prom_getprop_name, 
				 P1275_ARG(1,P1275_ARG_IN_STRING)|
				 P1275_ARG(2,P1275_ARG_OUT_BUF)|
				 P1275_INOUT(4, 1), 
				 node, prop, buffer, P1275_SIZE(plen));
	}
}
EXPORT_SYMBOL(prom_getproperty);

/* Acquire an integer property and return its value.  Returns -1
 * on failure.
 */
inline int prom_getint(int node, const char *prop)
{
	int intprop;

	if(prom_getproperty(node, prop, (char *) &intprop, sizeof(int)) != -1)
		return intprop;

	return -1;
}
EXPORT_SYMBOL(prom_getint);

/* Acquire an integer property, upon error return the passed default
 * integer.
 */

int prom_getintdefault(int node, const char *property, int deflt)
{
	int retval;

	retval = prom_getint(node, property);
	if(retval == -1) return deflt;

	return retval;
}
EXPORT_SYMBOL(prom_getintdefault);

/* Acquire a boolean property, 1=TRUE 0=FALSE. */
int prom_getbool(int node, const char *prop)
{
	int retval;

	retval = prom_getproplen(node, prop);
	if(retval == -1) return 0;
	return 1;
}
EXPORT_SYMBOL(prom_getbool);

/* Acquire a property whose value is a string, returns a null
 * string on error.  The char pointer is the user supplied string
 * buffer.
 */
void prom_getstring(int node, const char *prop, char *user_buf, int ubuf_size)
{
	int len;

	len = prom_getproperty(node, prop, user_buf, ubuf_size);
	if(len != -1) return;
	user_buf[0] = 0;
}
EXPORT_SYMBOL(prom_getstring);

/* Does the device at node 'node' have name 'name'?
 * YES = 1   NO = 0
 */
int prom_nodematch(int node, const char *name)
{
	char namebuf[128];
	prom_getproperty(node, "name", namebuf, sizeof(namebuf));
	if(strcmp(namebuf, name) == 0) return 1;
	return 0;
}

/* Search siblings at 'node_start' for a node with name
 * 'nodename'.  Return node if successful, zero if not.
 */
int prom_searchsiblings(int node_start, const char *nodename)
{

	int thisnode, error;
	char promlib_buf[128];

	for(thisnode = node_start; thisnode;
	    thisnode=prom_getsibling(thisnode)) {
		error = prom_getproperty(thisnode, "name", promlib_buf,
					 sizeof(promlib_buf));
		/* Should this ever happen? */
		if(error == -1) continue;
		if(strcmp(nodename, promlib_buf)==0) return thisnode;
	}

	return 0;
}
EXPORT_SYMBOL(prom_searchsiblings);

/* Return the first property type for node 'node'.
 * buffer should be at least 32B in length
 */
inline char *prom_firstprop(int node, char *buffer)
{
	*buffer = 0;
	if(node == -1) return buffer;
	p1275_cmd ("nextprop", P1275_ARG(2,P1275_ARG_OUT_32B)|
			       P1275_INOUT(3, 0), 
			       node, (char *) 0x0, buffer);
	return buffer;
}
EXPORT_SYMBOL(prom_firstprop);

/* Return the property type string after property type 'oprop'
 * at node 'node' .  Returns NULL string if no more
 * property types for this node.
 */
inline char *prom_nextprop(int node, const char *oprop, char *buffer)
{
	char buf[32];

	if(node == -1) {
		*buffer = 0;
		return buffer;
	}
	if (oprop == buffer) {
		strcpy (buf, oprop);
		oprop = buf;
	}
	p1275_cmd ("nextprop", P1275_ARG(1,P1275_ARG_IN_STRING)|
				    P1275_ARG(2,P1275_ARG_OUT_32B)|
				    P1275_INOUT(3, 0), 
				    node, oprop, buffer); 
	return buffer;
}
EXPORT_SYMBOL(prom_nextprop);

int
prom_finddevice(const char *name)
{
	if (!name)
		return 0;
	return p1275_cmd(prom_finddev_name,
			 P1275_ARG(0,P1275_ARG_IN_STRING)|
			 P1275_INOUT(1, 1), 
			 name);
}
EXPORT_SYMBOL(prom_finddevice);

int prom_node_has_property(int node, const char *prop)
{
	char buf [32];
        
	*buf = 0;
	do {
		prom_nextprop(node, buf, buf);
		if(!strcmp(buf, prop))
			return 1;
	} while (*buf);
	return 0;
}
EXPORT_SYMBOL(prom_node_has_property);

/* Set property 'pname' at node 'node' to value 'value' which has a length
 * of 'size' bytes.  Return the number of bytes the prom accepted.
 */
int
prom_setprop(int node, const char *pname, char *value, int size)
{
	if (size == 0)
		return 0;
	if ((pname == 0) || (value == 0))
		return 0;
	
#ifdef CONFIG_SUN_LDOMS
	if (ldom_domaining_enabled) {
		ldom_set_var(pname, value);
		return 0;
	}
#endif
	return p1275_cmd ("setprop", P1275_ARG(1,P1275_ARG_IN_STRING)|
					  P1275_ARG(2,P1275_ARG_IN_BUF)|
					  P1275_INOUT(4, 1), 
					  node, pname, value, P1275_SIZE(size));
}
EXPORT_SYMBOL(prom_setprop);

inline int prom_inst2pkg(int inst)
{
	int node;
	
	node = p1275_cmd ("instance-to-package", P1275_INOUT(1, 1), inst);
	if (node == -1) return 0;
	return node;
}

/* Return 'node' assigned to a particular prom 'path'
 * FIXME: Should work for v0 as well
 */
int
prom_pathtoinode(const char *path)
{
	int node, inst;

	inst = prom_devopen (path);
	if (inst == 0) return 0;
	node = prom_inst2pkg (inst);
	prom_devclose (inst);
	if (node == -1) return 0;
	return node;
}

int prom_ihandle2path(int handle, char *buffer, int bufsize)
{
	return p1275_cmd("instance-to-path",
			 P1275_ARG(1,P1275_ARG_OUT_BUF)|
			 P1275_INOUT(3, 1),
			 handle, buffer, P1275_SIZE(bufsize));
}
Commit	Line	Data
b00dc837	1	/*
1da177e4 LT	2	* tree.c: Basic device tree traversal/scanning for the Linux
	3	* prom library.
	4	*
	5	* Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
	6	* Copyright (C) 1996,1997 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
	7	*/
	8
	9	#include <linux/string.h>
	10	#include <linux/types.h>
	11	#include <linux/kernel.h>
	12	#include <linux/sched.h>
917c3660	13	#include <linux/module.h>
1da177e4 LT	14
	15	#include <asm/openprom.h>
	16	#include <asm/oplib.h>
b3e13fbe	17	#include <asm/ldc.h>
1da177e4 LT	18
	19	/* Return the child of node 'node' or zero if no this node has no
	20	* direct descendent.
	21	*/
d979f179	22	inline int __prom_getchild(int node)
1da177e4 LT	23	{
	24	return p1275_cmd ("child", P1275_INOUT(1, 1), node);
	25	}
	26
d979f179	27	inline int prom_getchild(int node)
1da177e4 LT	28	{
	29	int cnode;
	30
	31	if(node == -1) return 0;
	32	cnode = __prom_getchild(node);
	33	if(cnode == -1) return 0;
	34	return (int)cnode;
	35	}
917c3660	36	EXPORT_SYMBOL(prom_getchild);
1da177e4	37
d979f179	38	inline int prom_getparent(int node)
1da177e4 LT	39	{
	40	int cnode;
	41
	42	if(node == -1) return 0;
	43	cnode = p1275_cmd ("parent", P1275_INOUT(1, 1), node);
	44	if(cnode == -1) return 0;
	45	return (int)cnode;
	46	}
	47
	48	/* Return the next sibling of node 'node' or zero if no more siblings
	49	* at this level of depth in the tree.
	50	*/
d979f179	51	inline int __prom_getsibling(int node)
1da177e4	52	{
d82ace7d	53	return p1275_cmd(prom_peer_name, P1275_INOUT(1, 1), node);
1da177e4 LT	54	}
1da177e4 LT	55
d979f179	56	inline int prom_getsibling(int node)
1da177e4 LT	57	{
	58	int sibnode;
	59
d82ace7d DM	60	if (node == -1)
d82ace7d DM	61	return 0;
1da177e4	62	sibnode = __prom_getsibling(node);
d82ace7d DM	63	if (sibnode == -1)
	64	return 0;
	65
1da177e4 LT	66	return sibnode;
1da177e4 LT	67	}
917c3660	68	EXPORT_SYMBOL(prom_getsibling);
1da177e4 LT	69
	70	/* Return the length in bytes of property 'prop' at node 'node'.
	71	* Return -1 on error.
	72	*/
d979f179	73	inline int prom_getproplen(int node, const char *prop)
1da177e4 LT	74	{
	75	if((!node) \|\| (!prop)) return -1;
	76	return p1275_cmd ("getproplen",
	77	P1275_ARG(1,P1275_ARG_IN_STRING)\|
	78	P1275_INOUT(2, 1),
	79	node, prop);
	80	}
917c3660	81	EXPORT_SYMBOL(prom_getproplen);
1da177e4 LT	82
	83	/* Acquire a property 'prop' at node 'node' and place it in
	84	* 'buffer' which has a size of 'bufsize'. If the acquisition
	85	* was successful the length will be returned, else -1 is returned.
	86	*/
d979f179 DM	87	inline int prom_getproperty(int node, const char *prop,
d979f179 DM	88	char *buffer, int bufsize)
1da177e4 LT	89	{
	90	int plen;
	91
	92	plen = prom_getproplen(node, prop);
bff06d55	93	if ((plen > bufsize) \|\| (plen == 0) \|\| (plen == -1)) {
1da177e4	94	return -1;
bff06d55	95	} else {
1da177e4	96	/* Ok, things seem all right. */
bff06d55 DM	97	return p1275_cmd(prom_getprop_name,
	98	P1275_ARG(1,P1275_ARG_IN_STRING)\|
	99	P1275_ARG(2,P1275_ARG_OUT_BUF)\|
	100	P1275_INOUT(4, 1),
	101	node, prop, buffer, P1275_SIZE(plen));
1da177e4 LT	102	}
1da177e4 LT	103	}
917c3660	104	EXPORT_SYMBOL(prom_getproperty);
1da177e4 LT	105
	106	/* Acquire an integer property and return its value. Returns -1
	107	* on failure.
	108	*/
d979f179	109	inline int prom_getint(int node, const char *prop)
1da177e4 LT	110	{
	111	int intprop;
	112
	113	if(prom_getproperty(node, prop, (char *) &intprop, sizeof(int)) != -1)
	114	return intprop;
	115
	116	return -1;
	117	}
917c3660	118	EXPORT_SYMBOL(prom_getint);
1da177e4 LT	119
	120	/* Acquire an integer property, upon error return the passed default
	121	* integer.
	122	*/
	123
d979f179	124	int prom_getintdefault(int node, const char *property, int deflt)
1da177e4 LT	125	{
	126	int retval;
	127
	128	retval = prom_getint(node, property);
	129	if(retval == -1) return deflt;
	130
	131	return retval;
	132	}
917c3660	133	EXPORT_SYMBOL(prom_getintdefault);
1da177e4 LT	134
1da177e4 LT	135	/* Acquire a boolean property, 1=TRUE 0=FALSE. */
d979f179	136	int prom_getbool(int node, const char *prop)
1da177e4 LT	137	{
	138	int retval;
	139
	140	retval = prom_getproplen(node, prop);
	141	if(retval == -1) return 0;
	142	return 1;
	143	}
917c3660	144	EXPORT_SYMBOL(prom_getbool);
1da177e4 LT	145
	146	/* Acquire a property whose value is a string, returns a null
	147	* string on error. The char pointer is the user supplied string
	148	* buffer.
	149	*/
d979f179	150	void prom_getstring(int node, const char prop, char user_buf, int ubuf_size)
1da177e4 LT	151	{
	152	int len;
	153
	154	len = prom_getproperty(node, prop, user_buf, ubuf_size);
	155	if(len != -1) return;
	156	user_buf[0] = 0;
1da177e4	157	}
917c3660	158	EXPORT_SYMBOL(prom_getstring);
1da177e4 LT	159
	160	/* Does the device at node 'node' have name 'name'?
	161	* YES = 1 NO = 0
	162	*/
d979f179	163	int prom_nodematch(int node, const char *name)
1da177e4 LT	164	{
	165	char namebuf[128];
	166	prom_getproperty(node, "name", namebuf, sizeof(namebuf));
	167	if(strcmp(namebuf, name) == 0) return 1;
	168	return 0;
	169	}
	170
	171	/* Search siblings at 'node_start' for a node with name
	172	* 'nodename'. Return node if successful, zero if not.
	173	*/
d979f179	174	int prom_searchsiblings(int node_start, const char *nodename)
1da177e4 LT	175	{
	176
	177	int thisnode, error;
	178	char promlib_buf[128];
	179
	180	for(thisnode = node_start; thisnode;
	181	thisnode=prom_getsibling(thisnode)) {
	182	error = prom_getproperty(thisnode, "name", promlib_buf,
	183	sizeof(promlib_buf));
	184	/* Should this ever happen? */
	185	if(error == -1) continue;
	186	if(strcmp(nodename, promlib_buf)==0) return thisnode;
	187	}
	188
	189	return 0;
	190	}
917c3660	191	EXPORT_SYMBOL(prom_searchsiblings);
1da177e4	192
1da177e4 LT	193	/* Return the first property type for node 'node'.
	194	* buffer should be at least 32B in length
	195	*/
d979f179	196	inline char prom_firstprop(int node, char buffer)
1da177e4 LT	197	{
	198	*buffer = 0;
	199	if(node == -1) return buffer;
	200	p1275_cmd ("nextprop", P1275_ARG(2,P1275_ARG_OUT_32B)\|
	201	P1275_INOUT(3, 0),
	202	node, (char *) 0x0, buffer);
	203	return buffer;
	204	}
917c3660	205	EXPORT_SYMBOL(prom_firstprop);
1da177e4 LT	206
	207	/* Return the property type string after property type 'oprop'
	208	* at node 'node' . Returns NULL string if no more
	209	* property types for this node.
	210	*/
d979f179	211	inline char prom_nextprop(int node, const char oprop, char *buffer)
1da177e4 LT	212	{
	213	char buf[32];
	214
	215	if(node == -1) {
	216	*buffer = 0;
	217	return buffer;
	218	}
	219	if (oprop == buffer) {
	220	strcpy (buf, oprop);
	221	oprop = buf;
	222	}
	223	p1275_cmd ("nextprop", P1275_ARG(1,P1275_ARG_IN_STRING)\|
	224	P1275_ARG(2,P1275_ARG_OUT_32B)\|
	225	P1275_INOUT(3, 0),
	226	node, oprop, buffer);
	227	return buffer;
	228	}
917c3660	229	EXPORT_SYMBOL(prom_nextprop);
1da177e4 LT	230
1da177e4 LT	231	int
bff06d55	232	prom_finddevice(const char *name)
1da177e4	233	{
bff06d55 DM	234	if (!name)
	235	return 0;
	236	return p1275_cmd(prom_finddev_name,
	237	P1275_ARG(0,P1275_ARG_IN_STRING)\|
	238	P1275_INOUT(1, 1),
	239	name);
1da177e4	240	}
917c3660	241	EXPORT_SYMBOL(prom_finddevice);
1da177e4	242
bff06d55	243	int prom_node_has_property(int node, const char *prop)
1da177e4 LT	244	{
	245	char buf [32];
	246
	247	*buf = 0;
	248	do {
	249	prom_nextprop(node, buf, buf);
	250	if(!strcmp(buf, prop))
	251	return 1;
	252	} while (*buf);
	253	return 0;
	254	}
917c3660 SR	255	EXPORT_SYMBOL(prom_node_has_property);
917c3660 SR	256
1da177e4 LT	257	/* Set property 'pname' at node 'node' to value 'value' which has a length
	258	* of 'size' bytes. Return the number of bytes the prom accepted.
	259	*/
	260	int
bff06d55	261	prom_setprop(int node, const char pname, char value, int size)
1da177e4	262	{
b3e13fbe DM	263	if (size == 0)
	264	return 0;
	265	if ((pname == 0) \|\| (value == 0))
	266	return 0;
1da177e4	267
b3e13fbe DM	268	#ifdef CONFIG_SUN_LDOMS
	269	if (ldom_domaining_enabled) {
	270	ldom_set_var(pname, value);
	271	return 0;
	272	}
	273	#endif
1da177e4 LT	274	return p1275_cmd ("setprop", P1275_ARG(1,P1275_ARG_IN_STRING)\|
	275	P1275_ARG(2,P1275_ARG_IN_BUF)\|
	276	P1275_INOUT(4, 1),
	277	node, pname, value, P1275_SIZE(size));
	278	}
917c3660	279	EXPORT_SYMBOL(prom_setprop);
1da177e4	280
d979f179	281	inline int prom_inst2pkg(int inst)
1da177e4 LT	282	{
	283	int node;
	284
	285	node = p1275_cmd ("instance-to-package", P1275_INOUT(1, 1), inst);
	286	if (node == -1) return 0;
	287	return node;
	288	}
	289
	290	/* Return 'node' assigned to a particular prom 'path'
	291	* FIXME: Should work for v0 as well
	292	*/
	293	int
bff06d55	294	prom_pathtoinode(const char *path)
1da177e4 LT	295	{
	296	int node, inst;
	297
	298	inst = prom_devopen (path);
	299	if (inst == 0) return 0;
	300	node = prom_inst2pkg (inst);
	301	prom_devclose (inst);
	302	if (node == -1) return 0;
	303	return node;
	304	}
c73fcc84 DM	305
	306	int prom_ihandle2path(int handle, char *buffer, int bufsize)
	307	{
	308	return p1275_cmd("instance-to-path",
	309	P1275_ARG(1,P1275_ARG_OUT_BUF)\|
	310	P1275_INOUT(3, 1),
	311	handle, buffer, P1275_SIZE(bufsize));
	312	}