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

/*
 * OF graph binding parsing helpers
 *
 * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
 * Author: Sylwester Nawrocki <s.nawrocki@samsung.com>
 *
 * Copyright (C) 2012 Renesas Electronics Corp.
 * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 */
#ifndef __LINUX_OF_GRAPH_H
#define __LINUX_OF_GRAPH_H

#include <linux/types.h>

/**
 * struct of_endpoint - the OF graph endpoint data structure
 * @port: identifier (value of reg property) of a port this endpoint belongs to
 * @id: identifier (value of reg property) of this endpoint
 * @local_node: pointer to device_node of this endpoint
 */
struct of_endpoint {
	unsigned int port;
	unsigned int id;
	const struct device_node *local_node;
};

/**
 * for_each_endpoint_of_node - iterate over every endpoint in a device node
 * @parent: parent device node containing ports and endpoints
 * @child: loop variable pointing to the current endpoint node
 *
 * When breaking out of the loop, of_node_put(child) has to be called manually.
 */
#define for_each_endpoint_of_node(parent, child) \
	for (child = of_graph_get_next_endpoint(parent, NULL); child != NULL; \
	     child = of_graph_get_next_endpoint(parent, child))

#ifdef CONFIG_OF
int of_graph_parse_endpoint(const struct device_node *node,
				struct of_endpoint *endpoint);
struct device_node *of_graph_get_port_by_id(struct device_node *node, u32 id);
struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
					struct device_node *previous);
struct device_node *of_graph_get_remote_port_parent(
					const struct device_node *node);
struct device_node *of_graph_get_remote_port(const struct device_node *node);
#else

static inline int of_graph_parse_endpoint(const struct device_node *node,
					struct of_endpoint *endpoint)
{
	return -ENOSYS;
}

static inline struct device_node *of_graph_get_port_by_id(
					struct device_node *node, u32 id)
{
	return NULL;
}

static inline struct device_node *of_graph_get_next_endpoint(
					const struct device_node *parent,
					struct device_node *previous)
{
	return NULL;
}

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

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

#endif /* CONFIG_OF */

#endif /* __LINUX_OF_GRAPH_H */
Commit	Line	Data
fd9fdb78 PZ	1	/*
	2	* OF graph binding parsing helpers
	3	*
	4	* Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
	5	* Author: Sylwester Nawrocki <s.nawrocki@samsung.com>
	6	*
	7	* Copyright (C) 2012 Renesas Electronics Corp.
	8	* Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of version 2 of the GNU General Public License as
	12	* published by the Free Software Foundation.
	13	*/
	14	#ifndef __LINUX_OF_GRAPH_H
	15	#define __LINUX_OF_GRAPH_H
	16
01218bf1 MB	17	#include <linux/types.h>
01218bf1 MB	18
f2a575f6 PZ	19	/**
	20	* struct of_endpoint - the OF graph endpoint data structure
	21	* @port: identifier (value of reg property) of a port this endpoint belongs to
	22	* @id: identifier (value of reg property) of this endpoint
	23	* @local_node: pointer to device_node of this endpoint
	24	*/
	25	struct of_endpoint {
	26	unsigned int port;
	27	unsigned int id;
	28	const struct device_node *local_node;
	29	};
	30
ee890596 PZ	31	/**
	32	* for_each_endpoint_of_node - iterate over every endpoint in a device node
	33	* @parent: parent device node containing ports and endpoints
	34	* @child: loop variable pointing to the current endpoint node
	35	*
	36	* When breaking out of the loop, of_node_put(child) has to be called manually.
	37	*/
	38	#define for_each_endpoint_of_node(parent, child) \
	39	for (child = of_graph_get_next_endpoint(parent, NULL); child != NULL; \
	40	child = of_graph_get_next_endpoint(parent, child))
	41
fd9fdb78	42	#ifdef CONFIG_OF
f2a575f6 PZ	43	int of_graph_parse_endpoint(const struct device_node *node,
f2a575f6 PZ	44	struct of_endpoint *endpoint);
bfe446e3	45	struct device_node of_graph_get_port_by_id(struct device_node node, u32 id);
fd9fdb78 PZ	46	struct device_node of_graph_get_next_endpoint(const struct device_node parent,
	47	struct device_node *previous);
	48	struct device_node *of_graph_get_remote_port_parent(
	49	const struct device_node *node);
	50	struct device_node of_graph_get_remote_port(const struct device_node node);
	51	#else
	52
f2a575f6	53	static inline int of_graph_parse_endpoint(const struct device_node *node,
00fd9619	54	struct of_endpoint *endpoint)
f2a575f6 PZ	55	{
	56	return -ENOSYS;
	57	}
	58
bfe446e3 PZ	59	static inline struct device_node *of_graph_get_port_by_id(
	60	struct device_node *node, u32 id)
	61	{
	62	return NULL;
	63	}
	64
fd9fdb78 PZ	65	static inline struct device_node *of_graph_get_next_endpoint(
	66	const struct device_node *parent,
	67	struct device_node *previous)
	68	{
	69	return NULL;
	70	}
	71
	72	static inline struct device_node *of_graph_get_remote_port_parent(
	73	const struct device_node *node)
	74	{
	75	return NULL;
	76	}
	77
	78	static inline struct device_node *of_graph_get_remote_port(
	79	const struct device_node *node)
	80	{
	81	return NULL;
	82	}
	83
	84	#endif /* CONFIG_OF */
	85
	86	#endif /* __LINUX_OF_GRAPH_H */