tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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);
126void __of_prop_free(struct property *prop);
127struct device_node *__of_node_dup(const struct device_node *np,
128 const char *full_name);
129
130struct device_node *__of_find_node_by_path(struct device_node *parent,
131 const char *path);
132struct device_node *__of_find_node_by_full_path(struct device_node *node,
133 const char *path);
134
135extern const void *__of_get_property(const struct device_node *np,
136 const char *name, int *lenp);
137extern int __of_add_property(struct device_node *np, struct property *prop);
138extern int __of_remove_property(struct device_node *np, struct property *prop);
139extern int __of_update_property(struct device_node *np,
140 struct property *newprop, struct property **oldprop);
141
142extern void __of_detach_node(struct device_node *np);
143
144extern void __of_sysfs_remove_bin_file(struct device_node *np,
145 struct property *prop);
146
147/* illegal phandle value (set when unresolved) */
148#define OF_PHANDLE_ILLEGAL 0xdeadbeef
149
150/* iterators for transactions, used for overlays */
151/* forward iterator */
152#define for_each_transaction_entry(_oft, _te) \
153 list_for_each_entry(_te, &(_oft)->te_list, node)
154
155/* reverse iterator */
156#define for_each_transaction_entry_reverse(_oft, _te) \
157 list_for_each_entry_reverse(_te, &(_oft)->te_list, node)
158
159extern int of_bus_n_addr_cells(struct device_node *np);
160extern int of_bus_n_size_cells(struct device_node *np);
161
162struct bus_dma_region;
163#if defined(CONFIG_OF_ADDRESS) && defined(CONFIG_HAS_DMA)
164int of_dma_get_range(struct device_node *np,
165 const struct bus_dma_region **map);
166struct device_node *__of_get_dma_parent(const struct device_node *np);
167#else
168static inline int of_dma_get_range(struct device_node *np,
169 const struct bus_dma_region **map)
170{
171 return -ENODEV;
172}
173static inline struct device_node *__of_get_dma_parent(const struct device_node *np)
174{
175 return of_get_parent(np);
176}
177#endif
178
179int fdt_scan_reserved_mem(void);
180void fdt_init_reserved_mem(void);
181
182bool of_fdt_device_is_available(const void *blob, unsigned long node);
183
184#endif /* _LINUX_OF_PRIVATE_H */