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

static phandle prom_node_to_node(const char *type, phandle node)
{
	unsigned long args[5];

	args[0] = (unsigned long) type;
	args[1] = 1;
	args[2] = 1;
	args[3] = (unsigned int) node;
	args[4] = (unsigned long) -1;

	p1275_cmd_direct(args);

	return (phandle) args[4];
}

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

inline phandle prom_getchild(phandle node)
{
	phandle cnode;

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

inline phandle prom_getparent(phandle node)
{
	phandle cnode;

	if (node == -1)
		return 0;
	cnode = prom_node_to_node("parent", node);
	if (cnode == -1)
		return 0;
	return cnode;
}

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

inline phandle prom_getsibling(phandle node)
{
	phandle 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(phandle node, const char *prop)
{
	unsigned long args[6];

	if (!node || !prop)
		return -1;

	args[0] = (unsigned long) "getproplen";
	args[1] = 2;
	args[2] = 1;
	args[3] = (unsigned int) node;
	args[4] = (unsigned long) prop;
	args[5] = (unsigned long) -1;

	p1275_cmd_direct(args);

	return (int) args[5];
}
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(phandle node, const char *prop,
			    char *buffer, int bufsize)
{
	unsigned long args[8];
	int plen;

	plen = prom_getproplen(node, prop);
	if ((plen > bufsize) || (plen == 0) || (plen == -1))
		return -1;

	args[0] = (unsigned long) prom_getprop_name;
	args[1] = 4;
	args[2] = 1;
	args[3] = (unsigned int) node;
	args[4] = (unsigned long) prop;
	args[5] = (unsigned long) buffer;
	args[6] = bufsize;
	args[7] = (unsigned long) -1;

	p1275_cmd_direct(args);

	return (int) args[7];
}
EXPORT_SYMBOL(prom_getproperty);

/* Acquire an integer property and return its value.  Returns -1
 * on failure.
 */
inline int prom_getint(phandle 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(phandle 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(phandle 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(phandle 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(phandle 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.
 */
phandle prom_searchsiblings(phandle node_start, const char *nodename)
{
	phandle thisnode;
	int 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);

static const char *prom_nextprop_name = "nextprop";

/* Return the first property type for node 'node'.
 * buffer should be at least 32B in length
 */
inline char *prom_firstprop(phandle node, char *buffer)
{
	unsigned long args[7];

	*buffer = 0;
	if (node == -1)
		return buffer;

	args[0] = (unsigned long) prom_nextprop_name;
	args[1] = 3;
	args[2] = 1;
	args[3] = (unsigned int) node;
	args[4] = 0;
	args[5] = (unsigned long) buffer;
	args[6] = (unsigned long) -1;

	p1275_cmd_direct(args);

	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(phandle node, const char *oprop, char *buffer)
{
	unsigned long args[7];
	char buf[32];

	if (node == -1) {
		*buffer = 0;
		return buffer;
	}
	if (oprop == buffer) {
		strcpy (buf, oprop);
		oprop = buf;
	}

	args[0] = (unsigned long) prom_nextprop_name;
	args[1] = 3;
	args[2] = 1;
	args[3] = (unsigned int) node;
	args[4] = (unsigned long) oprop;
	args[5] = (unsigned long) buffer;
	args[6] = (unsigned long) -1;

	p1275_cmd_direct(args);

	return buffer;
}
EXPORT_SYMBOL(prom_nextprop);

phandle prom_finddevice(const char *name)
{
	unsigned long args[5];

	if (!name)
		return 0;
	args[0] = (unsigned long) "finddevice";
	args[1] = 1;
	args[2] = 1;
	args[3] = (unsigned long) name;
	args[4] = (unsigned long) -1;

	p1275_cmd_direct(args);

	return (int) args[4];
}
EXPORT_SYMBOL(prom_finddevice);

int prom_node_has_property(phandle 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(phandle node, const char *pname, char *value, int size)
{
	unsigned long args[8];

	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
	args[0] = (unsigned long) "setprop";
	args[1] = 4;
	args[2] = 1;
	args[3] = (unsigned int) node;
	args[4] = (unsigned long) pname;
	args[5] = (unsigned long) value;
	args[6] = size;
	args[7] = (unsigned long) -1;

	p1275_cmd_direct(args);

	return (int) args[7];
}
EXPORT_SYMBOL(prom_setprop);

inline phandle prom_inst2pkg(int inst)
{
	unsigned long args[5];
	phandle node;
	
	args[0] = (unsigned long) "instance-to-package";
	args[1] = 1;
	args[2] = 1;
	args[3] = (unsigned int) inst;
	args[4] = (unsigned long) -1;

	p1275_cmd_direct(args);

	node = (int) args[4];
	if (node == -1)
		return 0;
	return node;
}

int prom_ihandle2path(int handle, char *buffer, int bufsize)
{
	unsigned long args[7];

	args[0] = (unsigned long) "instance-to-path";
	args[1] = 3;
	args[2] = 1;
	args[3] = (unsigned int) handle;
	args[4] = (unsigned long) buffer;
	args[5] = bufsize;
	args[6] = (unsigned long) -1;

	p1275_cmd_direct(args);

	return (int) args[6];
}
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	18
8d125562	19	static phandle prom_node_to_node(const char *type, phandle node)
25edd694 DM	20	{
	21	unsigned long args[5];
	22
	23	args[0] = (unsigned long) type;
	24	args[1] = 1;
	25	args[2] = 1;
	26	args[3] = (unsigned int) node;
	27	args[4] = (unsigned long) -1;
	28
	29	p1275_cmd_direct(args);
	30
8d125562	31	return (phandle) args[4];
25edd694 DM	32	}
25edd694 DM	33
1da177e4 LT	34	/* Return the child of node 'node' or zero if no this node has no
	35	* direct descendent.
	36	*/
8d125562	37	inline phandle __prom_getchild(phandle node)
1da177e4	38	{
25edd694	39	return prom_node_to_node("child", node);
1da177e4 LT	40	}
1da177e4 LT	41
8d125562	42	inline phandle prom_getchild(phandle node)
1da177e4	43	{
8d125562	44	phandle cnode;
1da177e4	45
25edd694 DM	46	if (node == -1)
25edd694 DM	47	return 0;
1da177e4	48	cnode = __prom_getchild(node);
25edd694 DM	49	if (cnode == -1)
	50	return 0;
	51	return cnode;
1da177e4	52	}
917c3660	53	EXPORT_SYMBOL(prom_getchild);
1da177e4	54
8d125562	55	inline phandle prom_getparent(phandle node)
1da177e4	56	{
8d125562	57	phandle cnode;
1da177e4	58
25edd694 DM	59	if (node == -1)
	60	return 0;
	61	cnode = prom_node_to_node("parent", node);
	62	if (cnode == -1)
	63	return 0;
	64	return cnode;
1da177e4 LT	65	}
	66
	67	/* Return the next sibling of node 'node' or zero if no more siblings
	68	* at this level of depth in the tree.
	69	*/
8d125562	70	inline phandle __prom_getsibling(phandle node)
1da177e4	71	{
25edd694	72	return prom_node_to_node(prom_peer_name, node);
1da177e4 LT	73	}
1da177e4 LT	74
8d125562	75	inline phandle prom_getsibling(phandle node)
1da177e4	76	{
8d125562	77	phandle sibnode;
1da177e4	78
d82ace7d DM	79	if (node == -1)
d82ace7d DM	80	return 0;
1da177e4	81	sibnode = __prom_getsibling(node);
d82ace7d DM	82	if (sibnode == -1)
	83	return 0;
	84
1da177e4 LT	85	return sibnode;
1da177e4 LT	86	}
917c3660	87	EXPORT_SYMBOL(prom_getsibling);
1da177e4 LT	88
	89	/* Return the length in bytes of property 'prop' at node 'node'.
	90	* Return -1 on error.
	91	*/
8d125562	92	inline int prom_getproplen(phandle node, const char *prop)
1da177e4	93	{
25edd694 DM	94	unsigned long args[6];
	95
	96	if (!node \|\| !prop)
	97	return -1;
	98
	99	args[0] = (unsigned long) "getproplen";
	100	args[1] = 2;
	101	args[2] = 1;
	102	args[3] = (unsigned int) node;
	103	args[4] = (unsigned long) prop;
	104	args[5] = (unsigned long) -1;
	105
	106	p1275_cmd_direct(args);
	107
	108	return (int) args[5];
1da177e4	109	}
917c3660	110	EXPORT_SYMBOL(prom_getproplen);
1da177e4 LT	111
	112	/* Acquire a property 'prop' at node 'node' and place it in
	113	* 'buffer' which has a size of 'bufsize'. If the acquisition
	114	* was successful the length will be returned, else -1 is returned.
	115	*/
8d125562	116	inline int prom_getproperty(phandle node, const char *prop,
d979f179	117	char *buffer, int bufsize)
1da177e4	118	{
25edd694	119	unsigned long args[8];
1da177e4 LT	120	int plen;
	121
	122	plen = prom_getproplen(node, prop);
25edd694	123	if ((plen > bufsize) \|\| (plen == 0) \|\| (plen == -1))
1da177e4	124	return -1;
25edd694 DM	125
	126	args[0] = (unsigned long) prom_getprop_name;
	127	args[1] = 4;
	128	args[2] = 1;
	129	args[3] = (unsigned int) node;
	130	args[4] = (unsigned long) prop;
	131	args[5] = (unsigned long) buffer;
	132	args[6] = bufsize;
	133	args[7] = (unsigned long) -1;
	134
	135	p1275_cmd_direct(args);
	136
	137	return (int) args[7];
1da177e4	138	}
917c3660	139	EXPORT_SYMBOL(prom_getproperty);
1da177e4 LT	140
	141	/* Acquire an integer property and return its value. Returns -1
	142	* on failure.
	143	*/
8d125562	144	inline int prom_getint(phandle node, const char *prop)
1da177e4 LT	145	{
	146	int intprop;
	147
25edd694	148	if (prom_getproperty(node, prop, (char *) &intprop, sizeof(int)) != -1)
1da177e4 LT	149	return intprop;
	150
	151	return -1;
	152	}
917c3660	153	EXPORT_SYMBOL(prom_getint);
1da177e4 LT	154
	155	/* Acquire an integer property, upon error return the passed default
	156	* integer.
	157	*/
	158
8d125562	159	int prom_getintdefault(phandle node, const char *property, int deflt)
1da177e4 LT	160	{
	161	int retval;
	162
	163	retval = prom_getint(node, property);
25edd694 DM	164	if (retval == -1)
25edd694 DM	165	return deflt;
1da177e4 LT	166
	167	return retval;
	168	}
917c3660	169	EXPORT_SYMBOL(prom_getintdefault);
1da177e4 LT	170
1da177e4 LT	171	/* Acquire a boolean property, 1=TRUE 0=FALSE. */
8d125562	172	int prom_getbool(phandle node, const char *prop)
1da177e4 LT	173	{
	174	int retval;
	175
	176	retval = prom_getproplen(node, prop);
25edd694 DM	177	if (retval == -1)
25edd694 DM	178	return 0;
1da177e4 LT	179	return 1;
1da177e4 LT	180	}
917c3660	181	EXPORT_SYMBOL(prom_getbool);
1da177e4 LT	182
	183	/* Acquire a property whose value is a string, returns a null
	184	* string on error. The char pointer is the user supplied string
	185	* buffer.
	186	*/
8d125562 AS	187	void prom_getstring(phandle node, const char prop, char user_buf,
8d125562 AS	188	int ubuf_size)
1da177e4 LT	189	{
	190	int len;
	191
	192	len = prom_getproperty(node, prop, user_buf, ubuf_size);
25edd694 DM	193	if (len != -1)
25edd694 DM	194	return;
1da177e4	195	user_buf[0] = 0;
1da177e4	196	}
917c3660	197	EXPORT_SYMBOL(prom_getstring);
1da177e4 LT	198
	199	/* Does the device at node 'node' have name 'name'?
	200	* YES = 1 NO = 0
	201	*/
8d125562	202	int prom_nodematch(phandle node, const char *name)
1da177e4 LT	203	{
	204	char namebuf[128];
	205	prom_getproperty(node, "name", namebuf, sizeof(namebuf));
25edd694 DM	206	if (strcmp(namebuf, name) == 0)
25edd694 DM	207	return 1;
1da177e4 LT	208	return 0;
	209	}
	210
	211	/* Search siblings at 'node_start' for a node with name
	212	* 'nodename'. Return node if successful, zero if not.
	213	*/
8d125562	214	phandle prom_searchsiblings(phandle node_start, const char *nodename)
1da177e4	215	{
8d125562 AS	216	phandle thisnode;
8d125562 AS	217	int error;
1da177e4 LT	218	char promlib_buf[128];
	219
	220	for(thisnode = node_start; thisnode;
	221	thisnode=prom_getsibling(thisnode)) {
	222	error = prom_getproperty(thisnode, "name", promlib_buf,
	223	sizeof(promlib_buf));
	224	/* Should this ever happen? */
	225	if(error == -1) continue;
	226	if(strcmp(nodename, promlib_buf)==0) return thisnode;
	227	}
	228
	229	return 0;
	230	}
917c3660	231	EXPORT_SYMBOL(prom_searchsiblings);
1da177e4	232
25edd694 DM	233	static const char *prom_nextprop_name = "nextprop";
25edd694 DM	234
1da177e4 LT	235	/* Return the first property type for node 'node'.
	236	* buffer should be at least 32B in length
	237	*/
8d125562	238	inline char prom_firstprop(phandle node, char buffer)
1da177e4	239	{
25edd694 DM	240	unsigned long args[7];
25edd694 DM	241
1da177e4	242	*buffer = 0;
25edd694 DM	243	if (node == -1)
	244	return buffer;
	245
	246	args[0] = (unsigned long) prom_nextprop_name;
	247	args[1] = 3;
	248	args[2] = 1;
	249	args[3] = (unsigned int) node;
	250	args[4] = 0;
	251	args[5] = (unsigned long) buffer;
	252	args[6] = (unsigned long) -1;
	253
	254	p1275_cmd_direct(args);
	255
1da177e4 LT	256	return buffer;
1da177e4 LT	257	}
917c3660	258	EXPORT_SYMBOL(prom_firstprop);
1da177e4 LT	259
	260	/* Return the property type string after property type 'oprop'
	261	* at node 'node' . Returns NULL string if no more
	262	* property types for this node.
	263	*/
8d125562	264	inline char prom_nextprop(phandle node, const char oprop, char *buffer)
1da177e4	265	{
25edd694	266	unsigned long args[7];
1da177e4 LT	267	char buf[32];
1da177e4 LT	268
25edd694	269	if (node == -1) {
1da177e4 LT	270	*buffer = 0;
	271	return buffer;
	272	}
	273	if (oprop == buffer) {
	274	strcpy (buf, oprop);
	275	oprop = buf;
	276	}
25edd694 DM	277
	278	args[0] = (unsigned long) prom_nextprop_name;
	279	args[1] = 3;
	280	args[2] = 1;
	281	args[3] = (unsigned int) node;
	282	args[4] = (unsigned long) oprop;
	283	args[5] = (unsigned long) buffer;
	284	args[6] = (unsigned long) -1;
	285
	286	p1275_cmd_direct(args);
	287
1da177e4 LT	288	return buffer;
1da177e4 LT	289	}
917c3660	290	EXPORT_SYMBOL(prom_nextprop);
1da177e4	291
8d125562	292	phandle prom_finddevice(const char *name)
1da177e4	293	{
25edd694 DM	294	unsigned long args[5];
25edd694 DM	295
bff06d55 DM	296	if (!name)
bff06d55 DM	297	return 0;
25edd694 DM	298	args[0] = (unsigned long) "finddevice";
	299	args[1] = 1;
	300	args[2] = 1;
	301	args[3] = (unsigned long) name;
	302	args[4] = (unsigned long) -1;
	303
	304	p1275_cmd_direct(args);
	305
	306	return (int) args[4];
1da177e4	307	}
917c3660	308	EXPORT_SYMBOL(prom_finddevice);
1da177e4	309
8d125562	310	int prom_node_has_property(phandle node, const char *prop)
1da177e4 LT	311	{
	312	char buf [32];
	313
	314	*buf = 0;
	315	do {
	316	prom_nextprop(node, buf, buf);
25edd694	317	if (!strcmp(buf, prop))
1da177e4 LT	318	return 1;
	319	} while (*buf);
	320	return 0;
	321	}
917c3660 SR	322	EXPORT_SYMBOL(prom_node_has_property);
917c3660 SR	323
1da177e4 LT	324	/* Set property 'pname' at node 'node' to value 'value' which has a length
	325	* of 'size' bytes. Return the number of bytes the prom accepted.
	326	*/
	327	int
8d125562	328	prom_setprop(phandle node, const char pname, char value, int size)
1da177e4	329	{
25edd694 DM	330	unsigned long args[8];
25edd694 DM	331
b3e13fbe DM	332	if (size == 0)
	333	return 0;
	334	if ((pname == 0) \|\| (value == 0))
	335	return 0;
1da177e4	336
b3e13fbe DM	337	#ifdef CONFIG_SUN_LDOMS
	338	if (ldom_domaining_enabled) {
	339	ldom_set_var(pname, value);
	340	return 0;
	341	}
	342	#endif
25edd694 DM	343	args[0] = (unsigned long) "setprop";
	344	args[1] = 4;
	345	args[2] = 1;
	346	args[3] = (unsigned int) node;
	347	args[4] = (unsigned long) pname;
	348	args[5] = (unsigned long) value;
	349	args[6] = size;
	350	args[7] = (unsigned long) -1;
	351
	352	p1275_cmd_direct(args);
	353
	354	return (int) args[7];
1da177e4	355	}
917c3660	356	EXPORT_SYMBOL(prom_setprop);
1da177e4	357
8d125562	358	inline phandle prom_inst2pkg(int inst)
1da177e4	359	{
25edd694	360	unsigned long args[5];
8d125562	361	phandle node;
1da177e4	362
25edd694 DM	363	args[0] = (unsigned long) "instance-to-package";
	364	args[1] = 1;
	365	args[2] = 1;
	366	args[3] = (unsigned int) inst;
	367	args[4] = (unsigned long) -1;
	368
	369	p1275_cmd_direct(args);
	370
	371	node = (int) args[4];
	372	if (node == -1)
	373	return 0;
1da177e4 LT	374	return node;
	375	}
	376
c73fcc84 DM	377	int prom_ihandle2path(int handle, char *buffer, int bufsize)
c73fcc84 DM	378	{
25edd694 DM	379	unsigned long args[7];
	380
	381	args[0] = (unsigned long) "instance-to-path";
	382	args[1] = 3;
	383	args[2] = 1;
	384	args[3] = (unsigned int) handle;
	385	args[4] = (unsigned long) buffer;
	386	args[5] = bufsize;
	387	args[6] = (unsigned long) -1;
	388
	389	p1275_cmd_direct(args);
	390
	391	return (int) args[6];
c73fcc84	392	}