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/kref.h>
21#include <linux/mod_devicetable.h>
22#include <linux/spinlock.h>
23
24#include <asm/byteorder.h>
25
26typedef u32 phandle;
27typedef u32 ihandle;
28
29struct property {
30 char *name;
31 int length;
32 void *value;
33 struct property *next;
34 unsigned long _flags;
35 unsigned int unique_id;
36};
37
38#if defined(CONFIG_SPARC)
39struct of_irq_controller;
40#endif
41
42struct device_node {
43 const char *name;
44 const char *type;
45 phandle phandle;
46 char *full_name;
47
48 struct property *properties;
49 struct property *deadprops; /* removed properties */
50 struct device_node *parent;
51 struct device_node *child;
52 struct device_node *sibling;
53 struct device_node *next; /* next device of same type */
54 struct device_node *allnext; /* next in list of all nodes */
55 struct proc_dir_entry *pde; /* this node's proc directory */
56 struct kref kref;
57 unsigned long _flags;
58 void *data;
59#if defined(CONFIG_SPARC)
60 char *path_component_name;
61 unsigned int unique_id;
62 struct of_irq_controller *irq_trans;
63#endif
64};
65
66#ifdef CONFIG_OF
67
68/* Pointer for first entry in chain of all nodes. */
69extern struct device_node *allnodes;
70extern struct device_node *of_chosen;
71extern rwlock_t devtree_lock;
72
73static inline bool of_have_populated_dt(void)
74{
75 return allnodes != NULL;
76}
77
78static inline bool of_node_is_root(const struct device_node *node)
79{
80 return node && (node->parent == NULL);
81}
82
83static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
84{
85 return test_bit(flag, &n->_flags);
86}
87
88static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
89{
90 set_bit(flag, &n->_flags);
91}
92
93extern struct device_node *of_find_all_nodes(struct device_node *prev);
94
95#if defined(CONFIG_SPARC)
96/* Dummy ref counting routines - to be implemented later */
97static inline struct device_node *of_node_get(struct device_node *node)
98{
99 return node;
100}
101static inline void of_node_put(struct device_node *node)
102{
103}
104
105#else
106extern struct device_node *of_node_get(struct device_node *node);
107extern void of_node_put(struct device_node *node);
108#endif
109
110/*
111 * OF address retrieval & translation
112 */
113
114/* Helper to read a big number; size is in cells (not bytes) */
115static inline u64 of_read_number(const __be32 *cell, int size)
116{
117 u64 r = 0;
118 while (size--)
119 r = (r << 32) | be32_to_cpu(*(cell++));
120 return r;
121}
122
123/* Like of_read_number, but we want an unsigned long result */
124static inline unsigned long of_read_ulong(const __be32 *cell, int size)
125{
126 /* toss away upper bits if unsigned long is smaller than u64 */
127 return of_read_number(cell, size);
128}
129
130#include <asm/prom.h>
131
132/* Default #address and #size cells. Allow arch asm/prom.h to override */
133#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
134#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
135#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
136#endif
137
138/* Default string compare functions, Allow arch asm/prom.h to override */
139#if !defined(of_compat_cmp)
140#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
141#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
142#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
143#endif
144
145/* flag descriptions */
146#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
147#define OF_DETACHED 2 /* node has been detached from the device tree */
148
149#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
150#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
151
152#define OF_BAD_ADDR ((u64)-1)
153
154#ifndef of_node_to_nid
155static inline int of_node_to_nid(struct device_node *np) { return -1; }
156#define of_node_to_nid of_node_to_nid
157#endif
158
159extern struct device_node *of_find_node_by_name(struct device_node *from,
160 const char *name);
161#define for_each_node_by_name(dn, name) \
162 for (dn = of_find_node_by_name(NULL, name); dn; \
163 dn = of_find_node_by_name(dn, name))
164extern struct device_node *of_find_node_by_type(struct device_node *from,
165 const char *type);
166#define for_each_node_by_type(dn, type) \
167 for (dn = of_find_node_by_type(NULL, type); dn; \
168 dn = of_find_node_by_type(dn, type))
169extern struct device_node *of_find_compatible_node(struct device_node *from,
170 const char *type, const char *compat);
171#define for_each_compatible_node(dn, type, compatible) \
172 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
173 dn = of_find_compatible_node(dn, type, compatible))
174extern struct device_node *of_find_matching_node(struct device_node *from,
175 const struct of_device_id *matches);
176#define for_each_matching_node(dn, matches) \
177 for (dn = of_find_matching_node(NULL, matches); dn; \
178 dn = of_find_matching_node(dn, matches))
179extern struct device_node *of_find_node_by_path(const char *path);
180extern struct device_node *of_find_node_by_phandle(phandle handle);
181extern struct device_node *of_get_parent(const struct device_node *node);
182extern struct device_node *of_get_next_parent(struct device_node *node);
183extern struct device_node *of_get_next_child(const struct device_node *node,
184 struct device_node *prev);
185#define for_each_child_of_node(parent, child) \
186 for (child = of_get_next_child(parent, NULL); child != NULL; \
187 child = of_get_next_child(parent, child))
188
189extern struct device_node *of_find_node_with_property(
190 struct device_node *from, const char *prop_name);
191#define for_each_node_with_property(dn, prop_name) \
192 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
193 dn = of_find_node_with_property(dn, prop_name))
194
195extern struct property *of_find_property(const struct device_node *np,
196 const char *name,
197 int *lenp);
198extern int of_device_is_compatible(const struct device_node *device,
199 const char *);
200extern int of_device_is_available(const struct device_node *device);
201extern const void *of_get_property(const struct device_node *node,
202 const char *name,
203 int *lenp);
204extern int of_n_addr_cells(struct device_node *np);
205extern int of_n_size_cells(struct device_node *np);
206extern const struct of_device_id *of_match_node(
207 const struct of_device_id *matches, const struct device_node *node);
208extern int of_modalias_node(struct device_node *node, char *modalias, int len);
209extern struct device_node *of_parse_phandle(struct device_node *np,
210 const char *phandle_name,
211 int index);
212extern int of_parse_phandles_with_args(struct device_node *np,
213 const char *list_name, const char *cells_name, int index,
214 struct device_node **out_node, const void **out_args);
215
216extern int of_machine_is_compatible(const char *compat);
217
218extern int prom_add_property(struct device_node* np, struct property* prop);
219extern int prom_remove_property(struct device_node *np, struct property *prop);
220extern int prom_update_property(struct device_node *np,
221 struct property *newprop,
222 struct property *oldprop);
223
224#if defined(CONFIG_OF_DYNAMIC)
225/* For updating the device tree at runtime */
226extern void of_attach_node(struct device_node *);
227extern void of_detach_node(struct device_node *);
228#endif
229
230#else
231
232static inline bool of_have_populated_dt(void)
233{
234 return false;
235}
236
237#endif /* CONFIG_OF */
238#endif /* _LINUX_OF_H */