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