xref: /openbmc/linux/drivers/of/of_private.h (revision 239480ab)
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 
39 static inline struct device_node *kobj_to_device_node(struct kobject *kobj)
40 {
41 	return container_of(kobj, struct device_node, kobj);
42 }
43 
44 #if defined(CONFIG_OF_DYNAMIC)
45 extern int of_property_notify(int action, struct device_node *np,
46 			      struct property *prop, struct property *old_prop);
47 extern void of_node_release(struct kobject *kobj);
48 extern int __of_changeset_apply(struct of_changeset *ocs);
49 extern int __of_changeset_revert(struct of_changeset *ocs);
50 #else /* CONFIG_OF_DYNAMIC */
51 static inline int of_property_notify(int action, struct device_node *np,
52 				     struct property *prop, struct property *old_prop)
53 {
54 	return 0;
55 }
56 #endif /* CONFIG_OF_DYNAMIC */
57 
58 #if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
59 extern void __init unittest_unflatten_overlay_base(void);
60 #else
61 static inline void unittest_unflatten_overlay_base(void) {};
62 #endif
63 
64 extern void *__unflatten_device_tree(const void *blob,
65 			      struct device_node *dad,
66 			      struct device_node **mynodes,
67 			      void *(*dt_alloc)(u64 size, u64 align),
68 			      bool detached);
69 
70 /**
71  * General utilities for working with live trees.
72  *
73  * All functions with two leading underscores operate
74  * without taking node references, so you either have to
75  * own the devtree lock or work on detached trees only.
76  */
77 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
78 __printf(2, 3) struct device_node *__of_node_dup(const struct device_node *np, const char *fmt, ...);
79 
80 extern const void *__of_get_property(const struct device_node *np,
81 				     const char *name, int *lenp);
82 extern int __of_add_property(struct device_node *np, struct property *prop);
83 extern int __of_add_property_sysfs(struct device_node *np,
84 		struct property *prop);
85 extern int __of_remove_property(struct device_node *np, struct property *prop);
86 extern void __of_remove_property_sysfs(struct device_node *np,
87 		struct property *prop);
88 extern int __of_update_property(struct device_node *np,
89 		struct property *newprop, struct property **oldprop);
90 extern void __of_update_property_sysfs(struct device_node *np,
91 		struct property *newprop, struct property *oldprop);
92 
93 extern void __of_attach_node(struct device_node *np);
94 extern int __of_attach_node_sysfs(struct device_node *np);
95 extern void __of_detach_node(struct device_node *np);
96 extern void __of_detach_node_sysfs(struct device_node *np);
97 
98 extern void __of_sysfs_remove_bin_file(struct device_node *np,
99 				       struct property *prop);
100 
101 /* iterators for transactions, used for overlays */
102 /* forward iterator */
103 #define for_each_transaction_entry(_oft, _te) \
104 	list_for_each_entry(_te, &(_oft)->te_list, node)
105 
106 /* reverse iterator */
107 #define for_each_transaction_entry_reverse(_oft, _te) \
108 	list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
109 
110 #endif /* _LINUX_OF_PRIVATE_H */
111