xref: /linux-6.15/include/linux/of_graph.h (revision bfe446e3)
1 /*
2  * OF graph binding parsing helpers
3  *
4  * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
5  * Author: Sylwester Nawrocki <[email protected]>
6  *
7  * Copyright (C) 2012 Renesas Electronics Corp.
8  * Author: Guennadi Liakhovetski <[email protected]>
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 
17 /**
18  * struct of_endpoint - the OF graph endpoint data structure
19  * @port: identifier (value of reg property) of a port this endpoint belongs to
20  * @id: identifier (value of reg property) of this endpoint
21  * @local_node: pointer to device_node of this endpoint
22  */
23 struct of_endpoint {
24 	unsigned int port;
25 	unsigned int id;
26 	const struct device_node *local_node;
27 };
28 
29 /**
30  * for_each_endpoint_of_node - iterate over every endpoint in a device node
31  * @parent: parent device node containing ports and endpoints
32  * @child: loop variable pointing to the current endpoint node
33  *
34  * When breaking out of the loop, of_node_put(child) has to be called manually.
35  */
36 #define for_each_endpoint_of_node(parent, child) \
37 	for (child = of_graph_get_next_endpoint(parent, NULL); child != NULL; \
38 	     child = of_graph_get_next_endpoint(parent, child))
39 
40 #ifdef CONFIG_OF
41 int of_graph_parse_endpoint(const struct device_node *node,
42 				struct of_endpoint *endpoint);
43 struct device_node *of_graph_get_port_by_id(struct device_node *node, u32 id);
44 struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
45 					struct device_node *previous);
46 struct device_node *of_graph_get_remote_port_parent(
47 					const struct device_node *node);
48 struct device_node *of_graph_get_remote_port(const struct device_node *node);
49 #else
50 
51 static inline int of_graph_parse_endpoint(const struct device_node *node,
52 					struct of_endpoint *endpoint)
53 {
54 	return -ENOSYS;
55 }
56 
57 static inline struct device_node *of_graph_get_port_by_id(
58 					struct device_node *node, u32 id)
59 {
60 	return NULL;
61 }
62 
63 static inline struct device_node *of_graph_get_next_endpoint(
64 					const struct device_node *parent,
65 					struct device_node *previous)
66 {
67 	return NULL;
68 }
69 
70 static inline struct device_node *of_graph_get_remote_port_parent(
71 					const struct device_node *node)
72 {
73 	return NULL;
74 }
75 
76 static inline struct device_node *of_graph_get_remote_port(
77 					const struct device_node *node)
78 {
79 	return NULL;
80 }
81 
82 #endif /* CONFIG_OF */
83 
84 #endif /* __LINUX_OF_GRAPH_H */
85