Merge tag 'soc-drivers-6.9' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[linux-2.6-microblaze.git] / drivers / of / of_private.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 #ifndef _LINUX_OF_PRIVATE_H
3 #define _LINUX_OF_PRIVATE_H
4 /*
5  * Private symbols used by OF support code
6  *
7  * Paul Mackerras       August 1996.
8  * Copyright (C) 1996-2005 Paul Mackerras.
9  */
10
11 #define FDT_ALIGN_SIZE 8
12
13 /**
14  * struct alias_prop - Alias property in 'aliases' node
15  * @link:       List node to link the structure in aliases_lookup list
16  * @alias:      Alias property name
17  * @np:         Pointer to device_node that the alias stands for
18  * @id:         Index value from end of alias name
19  * @stem:       Alias string without the index
20  *
21  * The structure represents one alias property of 'aliases' node as
22  * an entry in aliases_lookup list.
23  */
24 struct alias_prop {
25         struct list_head link;
26         const char *alias;
27         struct device_node *np;
28         int id;
29         char stem[];
30 };
31
32 #if defined(CONFIG_SPARC)
33 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 2
34 #else
35 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
36 #endif
37
38 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
39
40 extern struct mutex of_mutex;
41 extern raw_spinlock_t devtree_lock;
42 extern struct list_head aliases_lookup;
43 extern struct kset *of_kset;
44
45 #if defined(CONFIG_OF_DYNAMIC)
46 extern int of_property_notify(int action, struct device_node *np,
47                               struct property *prop, struct property *old_prop);
48 extern void of_node_release(struct kobject *kobj);
49 extern int __of_changeset_apply_entries(struct of_changeset *ocs,
50                                         int *ret_revert);
51 extern int __of_changeset_apply_notify(struct of_changeset *ocs);
52 extern int __of_changeset_revert_entries(struct of_changeset *ocs,
53                                          int *ret_apply);
54 extern int __of_changeset_revert_notify(struct of_changeset *ocs);
55 #else /* CONFIG_OF_DYNAMIC */
56 static inline int of_property_notify(int action, struct device_node *np,
57                                      struct property *prop, struct property *old_prop)
58 {
59         return 0;
60 }
61 #endif /* CONFIG_OF_DYNAMIC */
62
63 #if defined(CONFIG_OF_DYNAMIC) && defined(CONFIG_OF_ADDRESS)
64 void of_platform_register_reconfig_notifier(void);
65 #else
66 static inline void of_platform_register_reconfig_notifier(void) { }
67 #endif
68
69 #if defined(CONFIG_OF_KOBJ)
70 int of_node_is_attached(const struct device_node *node);
71 int __of_add_property_sysfs(struct device_node *np, struct property *pp);
72 void __of_remove_property_sysfs(struct device_node *np, struct property *prop);
73 void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
74                 struct property *oldprop);
75 int __of_attach_node_sysfs(struct device_node *np);
76 void __of_detach_node_sysfs(struct device_node *np);
77 #else
78 static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp)
79 {
80         return 0;
81 }
82 static inline void __of_remove_property_sysfs(struct device_node *np, struct property *prop) {}
83 static inline void __of_update_property_sysfs(struct device_node *np,
84                 struct property *newprop, struct property *oldprop) {}
85 static inline int __of_attach_node_sysfs(struct device_node *np)
86 {
87         return 0;
88 }
89 static inline void __of_detach_node_sysfs(struct device_node *np) {}
90 #endif
91
92 #if defined(CONFIG_OF_RESOLVE)
93 int of_resolve_phandles(struct device_node *tree);
94 #endif
95
96 void __of_phandle_cache_inv_entry(phandle handle);
97
98 #if defined(CONFIG_OF_OVERLAY)
99 void of_overlay_mutex_lock(void);
100 void of_overlay_mutex_unlock(void);
101 #else
102 static inline void of_overlay_mutex_lock(void) {};
103 static inline void of_overlay_mutex_unlock(void) {};
104 #endif
105
106 #if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
107 extern void __init unittest_unflatten_overlay_base(void);
108 #else
109 static inline void unittest_unflatten_overlay_base(void) {};
110 #endif
111
112 extern void *__unflatten_device_tree(const void *blob,
113                               struct device_node *dad,
114                               struct device_node **mynodes,
115                               void *(*dt_alloc)(u64 size, u64 align),
116                               bool detached);
117
118 /**
119  * General utilities for working with live trees.
120  *
121  * All functions with two leading underscores operate
122  * without taking node references, so you either have to
123  * own the devtree lock or work on detached trees only.
124  */
125 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
126 struct device_node *__of_node_dup(const struct device_node *np,
127                                   const char *full_name);
128
129 struct device_node *__of_find_node_by_path(struct device_node *parent,
130                                                 const char *path);
131 struct device_node *__of_find_node_by_full_path(struct device_node *node,
132                                                 const char *path);
133
134 extern const void *__of_get_property(const struct device_node *np,
135                                      const char *name, int *lenp);
136 extern int __of_add_property(struct device_node *np, struct property *prop);
137 extern int __of_remove_property(struct device_node *np, struct property *prop);
138 extern int __of_update_property(struct device_node *np,
139                 struct property *newprop, struct property **oldprop);
140
141 extern void __of_detach_node(struct device_node *np);
142
143 extern void __of_sysfs_remove_bin_file(struct device_node *np,
144                                        struct property *prop);
145
146 /* illegal phandle value (set when unresolved) */
147 #define OF_PHANDLE_ILLEGAL      0xdeadbeef
148
149 /* iterators for transactions, used for overlays */
150 /* forward iterator */
151 #define for_each_transaction_entry(_oft, _te) \
152         list_for_each_entry(_te, &(_oft)->te_list, node)
153
154 /* reverse iterator */
155 #define for_each_transaction_entry_reverse(_oft, _te) \
156         list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
157
158 extern int of_bus_n_addr_cells(struct device_node *np);
159 extern int of_bus_n_size_cells(struct device_node *np);
160
161 struct bus_dma_region;
162 #if defined(CONFIG_OF_ADDRESS) && defined(CONFIG_HAS_DMA)
163 int of_dma_get_range(struct device_node *np,
164                 const struct bus_dma_region **map);
165 struct device_node *__of_get_dma_parent(const struct device_node *np);
166 #else
167 static inline int of_dma_get_range(struct device_node *np,
168                 const struct bus_dma_region **map)
169 {
170         return -ENODEV;
171 }
172 static inline struct device_node *__of_get_dma_parent(const struct device_node *np)
173 {
174         return of_get_parent(np);
175 }
176 #endif
177
178 void fdt_init_reserved_mem(void);
179 void fdt_reserved_mem_save_node(unsigned long node, const char *uname,
180                                phys_addr_t base, phys_addr_t size);
181
182 #endif /* _LINUX_OF_PRIVATE_H */