xref: /linux-6.15/include/linux/of_graph.h (revision 4c9c3d59)
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 #include <linux/types.h>
18 #include <linux/errno.h>
19 
20 /**
21  * struct of_endpoint - the OF graph endpoint data structure
22  * @port: identifier (value of reg property) of a port this endpoint belongs to
23  * @id: identifier (value of reg property) of this endpoint
24  * @local_node: pointer to device_node of this endpoint
25  */
26 struct of_endpoint {
27 	unsigned int port;
28 	unsigned int id;
29 	const struct device_node *local_node;
30 };
31 
32 /**
33  * for_each_endpoint_of_node - iterate over every endpoint in a device node
34  * @parent: parent device node containing ports and endpoints
35  * @child: loop variable pointing to the current endpoint node
36  *
37  * When breaking out of the loop, of_node_put(child) has to be called manually.
38  */
39 #define for_each_endpoint_of_node(parent, child) \
40 	for (child = of_graph_get_next_endpoint(parent, NULL); child != NULL; \
41 	     child = of_graph_get_next_endpoint(parent, child))
42 
43 #ifdef CONFIG_OF
44 int of_graph_parse_endpoint(const struct device_node *node,
45 				struct of_endpoint *endpoint);
46 struct device_node *of_graph_get_port_by_id(struct device_node *node, u32 id);
47 struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
48 					struct device_node *previous);
49 struct device_node *of_graph_get_endpoint_by_regs(
50 		const struct device_node *parent, int port_reg, int reg);
51 struct device_node *of_graph_get_remote_endpoint(
52 					const struct device_node *node);
53 struct device_node *of_graph_get_remote_port_parent(
54 					const struct device_node *node);
55 struct device_node *of_graph_get_remote_port(const struct device_node *node);
56 struct device_node *of_graph_get_remote_node(const struct device_node *node,
57 					     u32 port, u32 endpoint);
58 #else
59 
60 static inline int of_graph_parse_endpoint(const struct device_node *node,
61 					struct of_endpoint *endpoint)
62 {
63 	return -ENOSYS;
64 }
65 
66 static inline struct device_node *of_graph_get_port_by_id(
67 					struct device_node *node, u32 id)
68 {
69 	return NULL;
70 }
71 
72 static inline struct device_node *of_graph_get_next_endpoint(
73 					const struct device_node *parent,
74 					struct device_node *previous)
75 {
76 	return NULL;
77 }
78 
79 static inline struct device_node *of_graph_get_endpoint_by_regs(
80 		const struct device_node *parent, int port_reg, int reg)
81 {
82 	return NULL;
83 }
84 
85 static inline struct device_node *of_graph_get_remote_endpoint(
86 					const struct device_node *node)
87 {
88 	return NULL;
89 }
90 
91 static inline struct device_node *of_graph_get_remote_port_parent(
92 					const struct device_node *node)
93 {
94 	return NULL;
95 }
96 
97 static inline struct device_node *of_graph_get_remote_port(
98 					const struct device_node *node)
99 {
100 	return NULL;
101 }
102 static inline struct device_node *of_graph_get_remote_node(
103 					const struct device_node *node,
104 					u32 port, u32 endpoint)
105 {
106 	return NULL;
107 }
108 
109 #endif /* CONFIG_OF */
110 
111 #endif /* __LINUX_OF_GRAPH_H */
112