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