Loading...
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 */
24struct 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
40extern struct mutex of_mutex;
41extern raw_spinlock_t devtree_lock;
42extern struct list_head aliases_lookup;
43extern struct kset *of_kset;
44
45#if defined(CONFIG_OF_DYNAMIC)
46extern int of_property_notify(int action, struct device_node *np,
47 struct property *prop, struct property *old_prop);
48extern void of_node_release(struct kobject *kobj);
49extern int __of_changeset_apply_entries(struct of_changeset *ocs,
50 int *ret_revert);
51extern int __of_changeset_apply_notify(struct of_changeset *ocs);
52extern int __of_changeset_revert_entries(struct of_changeset *ocs,
53 int *ret_apply);
54extern int __of_changeset_revert_notify(struct of_changeset *ocs);
55#else /* CONFIG_OF_DYNAMIC */
56static 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)
64void of_platform_register_reconfig_notifier(void);
65#else
66static inline void of_platform_register_reconfig_notifier(void) { }
67#endif
68
69#if defined(CONFIG_OF_KOBJ)
70int of_node_is_attached(const struct device_node *node);
71int __of_add_property_sysfs(struct device_node *np, struct property *pp);
72void __of_remove_property_sysfs(struct device_node *np, struct property *prop);
73void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
74 struct property *oldprop);
75int __of_attach_node_sysfs(struct device_node *np);
76void __of_detach_node_sysfs(struct device_node *np);
77#else
78static inline int __of_add_property_sysfs(struct device_node *np, struct property *pp)
79{
80 return 0;
81}
82static inline void __of_remove_property_sysfs(struct device_node *np, struct property *prop) {}
83static inline void __of_update_property_sysfs(struct device_node *np,
84 struct property *newprop, struct property *oldprop) {}
85static inline int __of_attach_node_sysfs(struct device_node *np)
86{
87 return 0;
88}
89static inline void __of_detach_node_sysfs(struct device_node *np) {}
90#endif
91
92#if defined(CONFIG_OF_RESOLVE)
93int of_resolve_phandles(struct device_node *tree);
94#endif
95
96void __of_phandle_cache_inv_entry(phandle handle);
97
98#if defined(CONFIG_OF_OVERLAY)
99void of_overlay_mutex_lock(void);
100void of_overlay_mutex_unlock(void);
101#else
102static inline void of_overlay_mutex_lock(void) {};
103static inline void of_overlay_mutex_unlock(void) {};
104#endif
105
106#if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
107extern void __init unittest_unflatten_overlay_base(void);
108#else
109static inline void unittest_unflatten_overlay_base(void) {};
110#endif
111
112extern 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 */
125struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
126struct device_node *__of_node_dup(const struct device_node *np,
127 const char *full_name);
128
129struct device_node *__of_find_node_by_path(struct device_node *parent,
130 const char *path);
131struct device_node *__of_find_node_by_full_path(struct device_node *node,
132 const char *path);
133
134extern const void *__of_get_property(const struct device_node *np,
135 const char *name, int *lenp);
136extern int __of_add_property(struct device_node *np, struct property *prop);
137extern int __of_remove_property(struct device_node *np, struct property *prop);
138extern int __of_update_property(struct device_node *np,
139 struct property *newprop, struct property **oldprop);
140
141extern void __of_detach_node(struct device_node *np);
142
143extern 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
158extern int of_bus_n_addr_cells(struct device_node *np);
159extern int of_bus_n_size_cells(struct device_node *np);
160
161struct bus_dma_region;
162#if defined(CONFIG_OF_ADDRESS) && defined(CONFIG_HAS_DMA)
163int of_dma_get_range(struct device_node *np,
164 const struct bus_dma_region **map);
165struct device_node *__of_get_dma_parent(const struct device_node *np);
166#else
167static inline int of_dma_get_range(struct device_node *np,
168 const struct bus_dma_region **map)
169{
170 return -ENODEV;
171}
172static inline struct device_node *__of_get_dma_parent(const struct device_node *np)
173{
174 return of_get_parent(np);
175}
176#endif
177
178void fdt_init_reserved_mem(void);
179void 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 */
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[];
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
87void __of_phandle_cache_inv_entry(phandle handle);
88
89#if defined(CONFIG_OF_OVERLAY)
90void of_overlay_mutex_lock(void);
91void of_overlay_mutex_unlock(void);
92#else
93static inline void of_overlay_mutex_lock(void) {};
94static inline void of_overlay_mutex_unlock(void) {};
95#endif
96
97#if defined(CONFIG_OF_UNITTEST) && defined(CONFIG_OF_OVERLAY)
98extern void __init unittest_unflatten_overlay_base(void);
99#else
100static inline void unittest_unflatten_overlay_base(void) {};
101#endif
102
103extern void *__unflatten_device_tree(const void *blob,
104 struct device_node *dad,
105 struct device_node **mynodes,
106 void *(*dt_alloc)(u64 size, u64 align),
107 bool detached);
108
109/**
110 * General utilities for working with live trees.
111 *
112 * All functions with two leading underscores operate
113 * without taking node references, so you either have to
114 * own the devtree lock or work on detached trees only.
115 */
116struct property *__of_prop_dup(const struct property *prop, gfp_t allocflags);
117struct device_node *__of_node_dup(const struct device_node *np,
118 const char *full_name);
119
120struct device_node *__of_find_node_by_path(struct device_node *parent,
121 const char *path);
122struct device_node *__of_find_node_by_full_path(struct device_node *node,
123 const char *path);
124
125extern const void *__of_get_property(const struct device_node *np,
126 const char *name, int *lenp);
127extern int __of_add_property(struct device_node *np, struct property *prop);
128extern int __of_add_property_sysfs(struct device_node *np,
129 struct property *prop);
130extern int __of_remove_property(struct device_node *np, struct property *prop);
131extern void __of_remove_property_sysfs(struct device_node *np,
132 struct property *prop);
133extern int __of_update_property(struct device_node *np,
134 struct property *newprop, struct property **oldprop);
135extern void __of_update_property_sysfs(struct device_node *np,
136 struct property *newprop, struct property *oldprop);
137
138extern int __of_attach_node_sysfs(struct device_node *np);
139extern void __of_detach_node(struct device_node *np);
140extern void __of_detach_node_sysfs(struct device_node *np);
141
142extern void __of_sysfs_remove_bin_file(struct device_node *np,
143 struct property *prop);
144
145/* illegal phandle value (set when unresolved) */
146#define OF_PHANDLE_ILLEGAL 0xdeadbeef
147
148/* iterators for transactions, used for overlays */
149/* forward iterator */
150#define for_each_transaction_entry(_oft, _te) \
151 list_for_each_entry(_te, &(_oft)->te_list, node)
152
153/* reverse iterator */
154#define for_each_transaction_entry_reverse(_oft, _te) \
155 list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
156
157extern int of_bus_n_addr_cells(struct device_node *np);
158extern int of_bus_n_size_cells(struct device_node *np);
159
160#ifdef CONFIG_OF_ADDRESS
161extern int of_dma_get_range(struct device_node *np, u64 *dma_addr,
162 u64 *paddr, u64 *size);
163#else
164static inline int of_dma_get_range(struct device_node *np, u64 *dma_addr,
165 u64 *paddr, u64 *size)
166{
167 return -ENODEV;
168}
169#endif
170
171#endif /* _LINUX_OF_PRIVATE_H */