xref: /openbmc/linux/drivers/of/of_private.h (revision bbecb07f)
1 #ifndef _LINUX_OF_PRIVATE_H
2 #define _LINUX_OF_PRIVATE_H
3 /*
4  * Private symbols used by OF support code
5  *
6  * Paul Mackerras	August 1996.
7  * Copyright (C) 1996-2005 Paul Mackerras.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version
12  * 2 of the License, or (at your option) any later version.
13  */
14 
15 /**
16  * struct alias_prop - Alias property in 'aliases' node
17  * @link:	List node to link the structure in aliases_lookup list
18  * @alias:	Alias property name
19  * @np:		Pointer to device_node that the alias stands for
20  * @id:		Index value from end of alias name
21  * @stem:	Alias string without the index
22  *
23  * The structure represents one alias property of 'aliases' node as
24  * an entry in aliases_lookup list.
25  */
26 struct alias_prop {
27 	struct list_head link;
28 	const char *alias;
29 	struct device_node *np;
30 	int id;
31 	char stem[0];
32 };
33 
34 extern struct mutex of_mutex;
35 extern struct list_head aliases_lookup;
36 extern struct kset *of_kset;
37 
38 #if defined(CONFIG_OF_DYNAMIC)
39 extern int of_property_notify(int action, struct device_node *np,
40 			      struct property *prop, struct property *old_prop);
41 extern void of_node_release(struct kobject *kobj);
42 extern int __of_changeset_apply_entries(struct of_changeset *ocs,
43 					int *ret_revert);
44 extern int __of_changeset_apply_notify(struct of_changeset *ocs);
45 extern int __of_changeset_revert_entries(struct of_changeset *ocs,
46 					 int *ret_apply);
47 extern int __of_changeset_revert_notify(struct of_changeset *ocs);
48 #else /* CONFIG_OF_DYNAMIC */
49 static inline int of_property_notify(int action, struct device_node *np,
50 				     struct property *prop, struct property *old_prop)
51 {
52 	return 0;
53 }
54 #endif /* CONFIG_OF_DYNAMIC */
55 
56 #if defined(CONFIG_OF_KOBJ)
57 int of_node_is_attached(struct device_node *node);
58 int __of_add_property_sysfs(struct device_node *np, struct property *pp);
59 void __of_remove_property_sysfs(struct device_node *np, struct property *prop);
60 void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
61 		struct property *oldprop);
62 int __of_attach_node_sysfs(struct device_node *np);
63 void __of_detach_node_sysfs(struct device_node *np);
64 #else
65 static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp)
66 {
67 	return 0;
68 }
69 static inline void __of_remove_property_sysfs(struct device_node *np, struct property *prop) {}
70 static inline void __of_update_property_sysfs(struct device_node *np,
71 		struct property *newprop, struct property *oldprop) {}
72 static inline int __of_attach_node_sysfs(struct device_node *np)
73 {
74 	return 0;
75 }
76 static inline void __of_detach_node_sysfs(struct device_node *np) {}
77 #endif
78 
79 #if defined(CONFIG_OF_RESOLVE)
80 int of_resolve_phandles(struct device_node *tree);
81 #endif
82 
83 #if defined(CONFIG_OF_OVERLAY)
84 void of_overlay_mutex_lock(void);
85 void of_overlay_mutex_unlock(void);
86 #else
87 static inline void of_overlay_mutex_lock(void) {};
88 static inline void of_overlay_mutex_unlock(void) {};
89 #endif
90 
91 #if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
92 extern void __init unittest_unflatten_overlay_base(void);
93 #else
94 static inline void unittest_unflatten_overlay_base(void) {};
95 #endif
96 
97 extern void *__unflatten_device_tree(const void *blob,
98 			      struct device_node *dad,
99 			      struct device_node **mynodes,
100 			      void *(*dt_alloc)(u64 size, u64 align),
101 			      bool detached);
102 
103 /**
104  * General utilities for working with live trees.
105  *
106  * All functions with two leading underscores operate
107  * without taking node references, so you either have to
108  * own the devtree lock or work on detached trees only.
109  */
110 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
111 __printf(2, 3) struct device_node *__of_node_dup(const struct device_node *np, const char *fmt, ...);
112 
113 struct device_node *__of_find_node_by_path(struct device_node *parent,
114 						const char *path);
115 struct device_node *__of_find_node_by_full_path(struct device_node *node,
116 						const char *path);
117 
118 extern const void *__of_get_property(const struct device_node *np,
119 				     const char *name, int *lenp);
120 extern int __of_add_property(struct device_node *np, struct property *prop);
121 extern int __of_add_property_sysfs(struct device_node *np,
122 		struct property *prop);
123 extern int __of_remove_property(struct device_node *np, struct property *prop);
124 extern void __of_remove_property_sysfs(struct device_node *np,
125 		struct property *prop);
126 extern int __of_update_property(struct device_node *np,
127 		struct property *newprop, struct property **oldprop);
128 extern void __of_update_property_sysfs(struct device_node *np,
129 		struct property *newprop, struct property *oldprop);
130 
131 extern int __of_attach_node_sysfs(struct device_node *np);
132 extern void __of_detach_node(struct device_node *np);
133 extern void __of_detach_node_sysfs(struct device_node *np);
134 
135 extern void __of_sysfs_remove_bin_file(struct device_node *np,
136 				       struct property *prop);
137 
138 /* iterators for transactions, used for overlays */
139 /* forward iterator */
140 #define for_each_transaction_entry(_oft, _te) \
141 	list_for_each_entry(_te, &(_oft)->te_list, node)
142 
143 /* reverse iterator */
144 #define for_each_transaction_entry_reverse(_oft, _te) \
145 	list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
146 
147 #endif /* _LINUX_OF_PRIVATE_H */
148