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/**
12 * struct alias_prop - Alias property in 'aliases' node
13 * @link: List node to link the structure in aliases_lookup list
14 * @alias: Alias property name
15 * @np: Pointer to device_node that the alias stands for
16 * @id: Index value from end of alias name
17 * @stem: Alias string without the index
18 *
19 * The structure represents one alias property of 'aliases' node as
20 * an entry in aliases_lookup list.
21 */
22struct alias_prop {
23 struct list_head link;
24 const char *alias;
25 struct device_node *np;
26 int id;
27 char stem[0];
28};
29
30#if defined(CONFIG_SPARC)
31#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 2
32#else
33#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
34#endif
35
36#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
37
38extern struct mutex of_mutex;
39extern struct list_head aliases_lookup;
40extern struct kset *of_kset;
41
42#if defined(CONFIG_OF_DYNAMIC)
43extern int of_property_notify(int action, struct device_node *np,
44 struct property *prop, struct property *old_prop);
45extern void of_node_release(struct kobject *kobj);
46extern int __of_changeset_apply_entries(struct of_changeset *ocs,
47 int *ret_revert);
48extern int __of_changeset_apply_notify(struct of_changeset *ocs);
49extern int __of_changeset_revert_entries(struct of_changeset *ocs,
50 int *ret_apply);
51extern int __of_changeset_revert_notify(struct of_changeset *ocs);
52#else /* CONFIG_OF_DYNAMIC */
53static inline int of_property_notify(int action, struct device_node *np,
54 struct property *prop, struct property *old_prop)
55{
56 return 0;
57}
58#endif /* CONFIG_OF_DYNAMIC */
59
60#if defined(CONFIG_OF_KOBJ)
61int of_node_is_attached(struct device_node *node);
62int __of_add_property_sysfs(struct device_node *np, struct property *pp);
63void __of_remove_property_sysfs(struct device_node *np, struct property *prop);
64void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
65 struct property *oldprop);
66int __of_attach_node_sysfs(struct device_node *np);
67void __of_detach_node_sysfs(struct device_node *np);
68#else
69static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp)
70{
71 return 0;
72}
73static inline void __of_remove_property_sysfs(struct device_node *np, struct property *prop) {}
74static inline void __of_update_property_sysfs(struct device_node *np,
75 struct property *newprop, struct property *oldprop) {}
76static inline int __of_attach_node_sysfs(struct device_node *np)
77{
78 return 0;
79}
80static inline void __of_detach_node_sysfs(struct device_node *np) {}
81#endif
82
83#if defined(CONFIG_OF_RESOLVE)
84int of_resolve_phandles(struct device_node *tree);
85#endif
86
87#if defined(CONFIG_OF_DYNAMIC)
88void __of_free_phandle_cache_entry(phandle handle);
89#endif
90
91#if defined(CONFIG_OF_OVERLAY)
92void of_overlay_mutex_lock(void);
93void of_overlay_mutex_unlock(void);
94int of_free_phandle_cache(void);
95void of_populate_phandle_cache(void);
96#else
97static inline void of_overlay_mutex_lock(void) {};
98static inline void of_overlay_mutex_unlock(void) {};
99#endif
100
101#if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
102extern void __init unittest_unflatten_overlay_base(void);
103#else
104static inline void unittest_unflatten_overlay_base(void) {};
105#endif
106
107extern void *__unflatten_device_tree(const void *blob,
108 struct device_node *dad,
109 struct device_node **mynodes,
110 void *(*dt_alloc)(u64 size, u64 align),
111 bool detached);
112
113/**
114 * General utilities for working with live trees.
115 *
116 * All functions with two leading underscores operate
117 * without taking node references, so you either have to
118 * own the devtree lock or work on detached trees only.
119 */
120struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
121struct device_node *__of_node_dup(const struct device_node *np,
122 const char *full_name);
123
124struct device_node *__of_find_node_by_path(struct device_node *parent,
125 const char *path);
126struct device_node *__of_find_node_by_full_path(struct device_node *node,
127 const char *path);
128
129extern const void *__of_get_property(const struct device_node *np,
130 const char *name, int *lenp);
131extern int __of_add_property(struct device_node *np, struct property *prop);
132extern int __of_add_property_sysfs(struct device_node *np,
133 struct property *prop);
134extern int __of_remove_property(struct device_node *np, struct property *prop);
135extern void __of_remove_property_sysfs(struct device_node *np,
136 struct property *prop);
137extern int __of_update_property(struct device_node *np,
138 struct property *newprop, struct property **oldprop);
139extern void __of_update_property_sysfs(struct device_node *np,
140 struct property *newprop, struct property *oldprop);
141
142extern int __of_attach_node_sysfs(struct device_node *np);
143extern void __of_detach_node(struct device_node *np);
144extern void __of_detach_node_sysfs(struct device_node *np);
145
146extern void __of_sysfs_remove_bin_file(struct device_node *np,
147 struct property *prop);
148
149/* illegal phandle value (set when unresolved) */
150#define OF_PHANDLE_ILLEGAL 0xdeadbeef
151
152/* iterators for transactions, used for overlays */
153/* forward iterator */
154#define for_each_transaction_entry(_oft, _te) \
155 list_for_each_entry(_te, &(_oft)->te_list, node)
156
157/* reverse iterator */
158#define for_each_transaction_entry_reverse(_oft, _te) \
159 list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
160
161#endif /* _LINUX_OF_PRIVATE_H */
162