Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef _LINUX_OF_H
2#define _LINUX_OF_H
3/*
4 * Definitions for talking to the Open Firmware PROM on
5 * Power Macintosh and other computers.
6 *
7 * Copyright (C) 1996-2005 Paul Mackerras.
8 *
9 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
10 * Updates for SPARC64 by David S. Miller
11 * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
12 *
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
17 */
18#include <linux/types.h>
19#include <linux/bitops.h>
20#include <linux/errno.h>
21#include <linux/kref.h>
22#include <linux/mod_devicetable.h>
23#include <linux/spinlock.h>
24
25#include <asm/byteorder.h>
26#include <asm/errno.h>
27
28typedef u32 phandle;
29typedef u32 ihandle;
30
31struct property {
32 char *name;
33 int length;
34 void *value;
35 struct property *next;
36 unsigned long _flags;
37 unsigned int unique_id;
38};
39
40#if defined(CONFIG_SPARC)
41struct of_irq_controller;
42#endif
43
44struct device_node {
45 const char *name;
46 const char *type;
47 phandle phandle;
48 char *full_name;
49
50 struct property *properties;
51 struct property *deadprops; /* removed properties */
52 struct device_node *parent;
53 struct device_node *child;
54 struct device_node *sibling;
55 struct device_node *next; /* next device of same type */
56 struct device_node *allnext; /* next in list of all nodes */
57 struct proc_dir_entry *pde; /* this node's proc directory */
58 struct kref kref;
59 unsigned long _flags;
60 void *data;
61#if defined(CONFIG_SPARC)
62 char *path_component_name;
63 unsigned int unique_id;
64 struct of_irq_controller *irq_trans;
65#endif
66};
67
68#define MAX_PHANDLE_ARGS 8
69struct of_phandle_args {
70 struct device_node *np;
71 int args_count;
72 uint32_t args[MAX_PHANDLE_ARGS];
73};
74
75#if defined(CONFIG_SPARC) || !defined(CONFIG_OF)
76/* Dummy ref counting routines - to be implemented later */
77static inline struct device_node *of_node_get(struct device_node *node)
78{
79 return node;
80}
81static inline void of_node_put(struct device_node *node)
82{
83}
84#else
85extern struct device_node *of_node_get(struct device_node *node);
86extern void of_node_put(struct device_node *node);
87#endif
88
89#ifdef CONFIG_OF
90
91/* Pointer for first entry in chain of all nodes. */
92extern struct device_node *allnodes;
93extern struct device_node *of_chosen;
94extern struct device_node *of_aliases;
95extern rwlock_t devtree_lock;
96
97static inline bool of_have_populated_dt(void)
98{
99 return allnodes != NULL;
100}
101
102static inline bool of_node_is_root(const struct device_node *node)
103{
104 return node && (node->parent == NULL);
105}
106
107static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
108{
109 return test_bit(flag, &n->_flags);
110}
111
112static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
113{
114 set_bit(flag, &n->_flags);
115}
116
117extern struct device_node *of_find_all_nodes(struct device_node *prev);
118
119/*
120 * OF address retrieval & translation
121 */
122
123/* Helper to read a big number; size is in cells (not bytes) */
124static inline u64 of_read_number(const __be32 *cell, int size)
125{
126 u64 r = 0;
127 while (size--)
128 r = (r << 32) | be32_to_cpu(*(cell++));
129 return r;
130}
131
132/* Like of_read_number, but we want an unsigned long result */
133static inline unsigned long of_read_ulong(const __be32 *cell, int size)
134{
135 /* toss away upper bits if unsigned long is smaller than u64 */
136 return of_read_number(cell, size);
137}
138
139#include <asm/prom.h>
140
141/* Default #address and #size cells. Allow arch asm/prom.h to override */
142#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
143#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
144#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
145#endif
146
147/* Default string compare functions, Allow arch asm/prom.h to override */
148#if !defined(of_compat_cmp)
149#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
150#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
151#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
152#endif
153
154/* flag descriptions */
155#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
156#define OF_DETACHED 2 /* node has been detached from the device tree */
157
158#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
159#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
160
161#define OF_BAD_ADDR ((u64)-1)
162
163#ifndef of_node_to_nid
164static inline int of_node_to_nid(struct device_node *np) { return -1; }
165#define of_node_to_nid of_node_to_nid
166#endif
167
168extern struct device_node *of_find_node_by_name(struct device_node *from,
169 const char *name);
170#define for_each_node_by_name(dn, name) \
171 for (dn = of_find_node_by_name(NULL, name); dn; \
172 dn = of_find_node_by_name(dn, name))
173extern struct device_node *of_find_node_by_type(struct device_node *from,
174 const char *type);
175#define for_each_node_by_type(dn, type) \
176 for (dn = of_find_node_by_type(NULL, type); dn; \
177 dn = of_find_node_by_type(dn, type))
178extern struct device_node *of_find_compatible_node(struct device_node *from,
179 const char *type, const char *compat);
180#define for_each_compatible_node(dn, type, compatible) \
181 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
182 dn = of_find_compatible_node(dn, type, compatible))
183extern struct device_node *of_find_matching_node(struct device_node *from,
184 const struct of_device_id *matches);
185#define for_each_matching_node(dn, matches) \
186 for (dn = of_find_matching_node(NULL, matches); dn; \
187 dn = of_find_matching_node(dn, matches))
188extern struct device_node *of_find_node_by_path(const char *path);
189extern struct device_node *of_find_node_by_phandle(phandle handle);
190extern struct device_node *of_get_parent(const struct device_node *node);
191extern struct device_node *of_get_next_parent(struct device_node *node);
192extern struct device_node *of_get_next_child(const struct device_node *node,
193 struct device_node *prev);
194#define for_each_child_of_node(parent, child) \
195 for (child = of_get_next_child(parent, NULL); child != NULL; \
196 child = of_get_next_child(parent, child))
197
198extern struct device_node *of_find_node_with_property(
199 struct device_node *from, const char *prop_name);
200#define for_each_node_with_property(dn, prop_name) \
201 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
202 dn = of_find_node_with_property(dn, prop_name))
203
204extern struct property *of_find_property(const struct device_node *np,
205 const char *name,
206 int *lenp);
207extern int of_property_read_u32_array(const struct device_node *np,
208 const char *propname,
209 u32 *out_values,
210 size_t sz);
211extern int of_property_read_u64(const struct device_node *np,
212 const char *propname, u64 *out_value);
213
214extern int of_property_read_string(struct device_node *np,
215 const char *propname,
216 const char **out_string);
217extern int of_property_read_string_index(struct device_node *np,
218 const char *propname,
219 int index, const char **output);
220extern int of_property_count_strings(struct device_node *np,
221 const char *propname);
222extern int of_device_is_compatible(const struct device_node *device,
223 const char *);
224extern int of_device_is_available(const struct device_node *device);
225extern const void *of_get_property(const struct device_node *node,
226 const char *name,
227 int *lenp);
228#define for_each_property_of_node(dn, pp) \
229 for (pp = dn->properties; pp != NULL; pp = pp->next)
230
231extern int of_n_addr_cells(struct device_node *np);
232extern int of_n_size_cells(struct device_node *np);
233extern const struct of_device_id *of_match_node(
234 const struct of_device_id *matches, const struct device_node *node);
235extern int of_modalias_node(struct device_node *node, char *modalias, int len);
236extern struct device_node *of_parse_phandle(struct device_node *np,
237 const char *phandle_name,
238 int index);
239extern int of_parse_phandle_with_args(struct device_node *np,
240 const char *list_name, const char *cells_name, int index,
241 struct of_phandle_args *out_args);
242
243extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
244extern int of_alias_get_id(struct device_node *np, const char *stem);
245
246extern int of_machine_is_compatible(const char *compat);
247
248extern int prom_add_property(struct device_node* np, struct property* prop);
249extern int prom_remove_property(struct device_node *np, struct property *prop);
250extern int prom_update_property(struct device_node *np,
251 struct property *newprop,
252 struct property *oldprop);
253
254#if defined(CONFIG_OF_DYNAMIC)
255/* For updating the device tree at runtime */
256extern void of_attach_node(struct device_node *);
257extern void of_detach_node(struct device_node *);
258#endif
259
260#define of_match_ptr(_ptr) (_ptr)
261#else /* CONFIG_OF */
262
263static inline bool of_have_populated_dt(void)
264{
265 return false;
266}
267
268#define for_each_child_of_node(parent, child) \
269 while (0)
270
271static inline int of_device_is_compatible(const struct device_node *device,
272 const char *name)
273{
274 return 0;
275}
276
277static inline struct property *of_find_property(const struct device_node *np,
278 const char *name,
279 int *lenp)
280{
281 return NULL;
282}
283
284static inline int of_property_read_u32_array(const struct device_node *np,
285 const char *propname,
286 u32 *out_values, size_t sz)
287{
288 return -ENOSYS;
289}
290
291static inline int of_property_read_string(struct device_node *np,
292 const char *propname,
293 const char **out_string)
294{
295 return -ENOSYS;
296}
297
298static inline int of_property_read_string_index(struct device_node *np,
299 const char *propname, int index,
300 const char **out_string)
301{
302 return -ENOSYS;
303}
304
305static inline int of_property_count_strings(struct device_node *np,
306 const char *propname)
307{
308 return -ENOSYS;
309}
310
311static inline const void *of_get_property(const struct device_node *node,
312 const char *name,
313 int *lenp)
314{
315 return NULL;
316}
317
318static inline int of_property_read_u64(const struct device_node *np,
319 const char *propname, u64 *out_value)
320{
321 return -ENOSYS;
322}
323
324static inline struct device_node *of_parse_phandle(struct device_node *np,
325 const char *phandle_name,
326 int index)
327{
328 return NULL;
329}
330
331static inline int of_alias_get_id(struct device_node *np, const char *stem)
332{
333 return -ENOSYS;
334}
335
336static inline int of_machine_is_compatible(const char *compat)
337{
338 return 0;
339}
340
341#define of_match_ptr(_ptr) NULL
342#define of_match_node(_matches, _node) NULL
343#endif /* CONFIG_OF */
344
345static inline int of_property_read_u32(const struct device_node *np,
346 const char *propname,
347 u32 *out_value)
348{
349 return of_property_read_u32_array(np, propname, out_value, 1);
350}
351
352#endif /* _LINUX_OF_H */