1 /* SPDX-License-Identifier: GPL-2.0+ */
2 #ifndef _LINUX_OF_PRIVATE_H
3 #define _LINUX_OF_PRIVATE_H
5 * Private symbols used by OF support code
7 * Paul Mackerras August 1996.
8 * Copyright (C) 1996-2005 Paul Mackerras.
11 #define FDT_ALIGN_SIZE 8
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
21 * The structure represents one alias property of 'aliases' node as
22 * an entry in aliases_lookup list.
25 struct list_head link;
27 struct device_node *np;
32 #if defined(CONFIG_SPARC)
33 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 2
35 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
38 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
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;
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,
51 extern int __of_changeset_apply_notify(struct of_changeset *ocs);
52 extern int __of_changeset_revert_entries(struct of_changeset *ocs,
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)
61 #endif /* CONFIG_OF_DYNAMIC */
63 #if defined(CONFIG_OF_KOBJ)
64 int of_node_is_attached(const struct device_node *node);
65 int __of_add_property_sysfs(struct device_node *np, struct property *pp);
66 void __of_remove_property_sysfs(struct device_node *np, struct property *prop);
67 void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
68 struct property *oldprop);
69 int __of_attach_node_sysfs(struct device_node *np);
70 void __of_detach_node_sysfs(struct device_node *np);
72 static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp)
76 static inline void __of_remove_property_sysfs(struct device_node *np, struct property *prop) {}
77 static inline void __of_update_property_sysfs(struct device_node *np,
78 struct property *newprop, struct property *oldprop) {}
79 static inline int __of_attach_node_sysfs(struct device_node *np)
83 static inline void __of_detach_node_sysfs(struct device_node *np) {}
86 #if defined(CONFIG_OF_RESOLVE)
87 int of_resolve_phandles(struct device_node *tree);
90 void __of_phandle_cache_inv_entry(phandle handle);
92 #if defined(CONFIG_OF_OVERLAY)
93 void of_overlay_mutex_lock(void);
94 void of_overlay_mutex_unlock(void);
96 static inline void of_overlay_mutex_lock(void) {};
97 static inline void of_overlay_mutex_unlock(void) {};
100 #if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
101 extern void __init unittest_unflatten_overlay_base(void);
103 static inline void unittest_unflatten_overlay_base(void) {};
106 extern void *__unflatten_device_tree(const void *blob,
107 struct device_node *dad,
108 struct device_node **mynodes,
109 void *(*dt_alloc)(u64 size, u64 align),
113 * General utilities for working with live trees.
115 * All functions with two leading underscores operate
116 * without taking node references, so you either have to
117 * own the devtree lock or work on detached trees only.
119 struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
120 struct device_node *__of_node_dup(const struct device_node *np,
121 const char *full_name);
123 struct device_node *__of_find_node_by_path(struct device_node *parent,
125 struct device_node *__of_find_node_by_full_path(struct device_node *node,
128 extern const void *__of_get_property(const struct device_node *np,
129 const char *name, int *lenp);
130 extern int __of_add_property(struct device_node *np, struct property *prop);
131 extern int __of_remove_property(struct device_node *np, struct property *prop);
132 extern int __of_update_property(struct device_node *np,
133 struct property *newprop, struct property **oldprop);
135 extern void __of_detach_node(struct device_node *np);
137 extern void __of_sysfs_remove_bin_file(struct device_node *np,
138 struct property *prop);
140 /* illegal phandle value (set when unresolved) */
141 #define OF_PHANDLE_ILLEGAL 0xdeadbeef
143 /* iterators for transactions, used for overlays */
144 /* forward iterator */
145 #define for_each_transaction_entry(_oft, _te) \
146 list_for_each_entry(_te, &(_oft)->te_list, node)
148 /* reverse iterator */
149 #define for_each_transaction_entry_reverse(_oft, _te) \
150 list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
152 extern int of_bus_n_addr_cells(struct device_node *np);
153 extern int of_bus_n_size_cells(struct device_node *np);
155 struct bus_dma_region;
156 #if defined(CONFIG_OF_ADDRESS) && defined(CONFIG_HAS_DMA)
157 int of_dma_get_range(struct device_node *np,
158 const struct bus_dma_region **map);
159 struct device_node *__of_get_dma_parent(const struct device_node *np);
161 static inline int of_dma_get_range(struct device_node *np,
162 const struct bus_dma_region **map)
166 static inline struct device_node *__of_get_dma_parent(const struct device_node *np)
168 return of_get_parent(np);
172 void fdt_init_reserved_mem(void);
173 void fdt_reserved_mem_save_node(unsigned long node, const char *uname,
174 phys_addr_t base, phys_addr_t size);
176 #endif /* _LINUX_OF_PRIVATE_H */