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
 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_OVERLAY)
 80void of_overlay_mutex_lock(void);
 81void of_overlay_mutex_unlock(void);
 82#else
 83static inline void of_overlay_mutex_lock(void) {};
 84static inline void of_overlay_mutex_unlock(void) {};
 85#endif
 86
 87#if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
 88extern void __init unittest_unflatten_overlay_base(void);
 89#else
 90static inline void unittest_unflatten_overlay_base(void) {};
 91#endif
 92
 93extern void *__unflatten_device_tree(const void *blob,
 94			      struct device_node *dad,
 95			      struct device_node **mynodes,
 96			      void *(*dt_alloc)(u64 size, u64 align),
 97			      bool detached);
 98
 99/**
100 * General utilities for working with live trees.
101 *
102 * All functions with two leading underscores operate
103 * without taking node references, so you either have to
104 * own the devtree lock or work on detached trees only.
105 */
106struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
107struct device_node *__of_node_dup(const struct device_node *np,
108				  const char *full_name);
109
110struct device_node *__of_find_node_by_path(struct device_node *parent,
111						const char *path);
112struct device_node *__of_find_node_by_full_path(struct device_node *node,
113						const char *path);
114
115extern const void *__of_get_property(const struct device_node *np,
116				     const char *name, int *lenp);
117extern int __of_add_property(struct device_node *np, struct property *prop);
118extern int __of_add_property_sysfs(struct device_node *np,
119		struct property *prop);
120extern int __of_remove_property(struct device_node *np, struct property *prop);
121extern void __of_remove_property_sysfs(struct device_node *np,
122		struct property *prop);
123extern int __of_update_property(struct device_node *np,
124		struct property *newprop, struct property **oldprop);
125extern void __of_update_property_sysfs(struct device_node *np,
126		struct property *newprop, struct property *oldprop);
127
128extern int __of_attach_node_sysfs(struct device_node *np);
129extern void __of_detach_node(struct device_node *np);
130extern void __of_detach_node_sysfs(struct device_node *np);
131
132extern void __of_sysfs_remove_bin_file(struct device_node *np,
133				       struct property *prop);
134
135/* illegal phandle value (set when unresolved) */
136#define OF_PHANDLE_ILLEGAL	0xdeadbeef
137
138/* iterators for transactions, used for overlays */
139/* forward iterator */
140#define for_each_transaction_entry(_oft, _te) \
141	list_for_each_entry(_te, &(_oft)->te_list, node)
142
143/* reverse iterator */
144#define for_each_transaction_entry_reverse(_oft, _te) \
145	list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
146
147#endif /* _LINUX_OF_PRIVATE_H */