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