]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/of.h
pinctrl: implement pinctrl deferred probing
[mirror_ubuntu-jammy-kernel.git] / include / linux / of.h
CommitLineData
76c1ce78
SR
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>
1977f032 19#include <linux/bitops.h>
e51130c0 20#include <linux/errno.h>
6f192492 21#include <linux/kref.h>
283029d1 22#include <linux/mod_devicetable.h>
0d351c3e 23#include <linux/spinlock.h>
76c1ce78 24
2e89e685 25#include <asm/byteorder.h>
d0a99402 26#include <asm/errno.h>
2e89e685 27
731581e6
GL
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
6f192492
GL
40#if defined(CONFIG_SPARC)
41struct of_irq_controller;
42#endif
43
44struct device_node {
45 const char *name;
46 const char *type;
6016a363 47 phandle phandle;
6f192492
GL
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
15c9a0ac
GL
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
0f22dd39
GL
75#ifdef CONFIG_OF_DYNAMIC
76extern struct device_node *of_node_get(struct device_node *node);
77extern void of_node_put(struct device_node *node);
78#else /* CONFIG_OF_DYNAMIC */
3ecdd051
RH
79/* Dummy ref counting routines - to be implemented later */
80static inline struct device_node *of_node_get(struct device_node *node)
81{
82 return node;
83}
0f22dd39
GL
84static inline void of_node_put(struct device_node *node) { }
85#endif /* !CONFIG_OF_DYNAMIC */
3ecdd051 86
c9e358df
GL
87#ifdef CONFIG_OF
88
41f88009
GL
89/* Pointer for first entry in chain of all nodes. */
90extern struct device_node *allnodes;
fc0bdae4 91extern struct device_node *of_chosen;
611cad72 92extern struct device_node *of_aliases;
0d351c3e 93extern rwlock_t devtree_lock;
41f88009 94
3bcbaf6e
SAS
95static inline bool of_have_populated_dt(void)
96{
97 return allnodes != NULL;
98}
99
035ebefc
AS
100static inline bool of_node_is_root(const struct device_node *node)
101{
102 return node && (node->parent == NULL);
103}
104
50436312
GL
105static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
106{
107 return test_bit(flag, &n->_flags);
108}
109
110static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
111{
112 set_bit(flag, &n->_flags);
113}
114
e91edcf5
GL
115extern struct device_node *of_find_all_nodes(struct device_node *prev);
116
b6caf2ad 117/*
3d6b8828 118 * OF address retrieval & translation
b6caf2ad
GL
119 */
120
121/* Helper to read a big number; size is in cells (not bytes) */
2e89e685 122static inline u64 of_read_number(const __be32 *cell, int size)
b6caf2ad
GL
123{
124 u64 r = 0;
125 while (size--)
2e89e685 126 r = (r << 32) | be32_to_cpu(*(cell++));
b6caf2ad
GL
127 return r;
128}
129
130/* Like of_read_number, but we want an unsigned long result */
2e89e685 131static inline unsigned long of_read_ulong(const __be32 *cell, int size)
b6caf2ad 132{
2be09cb9
GL
133 /* toss away upper bits if unsigned long is smaller than u64 */
134 return of_read_number(cell, size);
b6caf2ad 135}
b6caf2ad 136
76c1ce78
SR
137#include <asm/prom.h>
138
7c7b60cb
GL
139/* Default #address and #size cells. Allow arch asm/prom.h to override */
140#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
141#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
142#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
143#endif
144
145/* Default string compare functions, Allow arch asm/prom.h to override */
146#if !defined(of_compat_cmp)
1976152f 147#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
7c7b60cb
GL
148#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
149#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
150#endif
151
76c1ce78
SR
152/* flag descriptions */
153#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
154#define OF_DETACHED 2 /* node has been detached from the device tree */
155
61e955db
GL
156#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
157#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
158
76c1ce78
SR
159#define OF_BAD_ADDR ((u64)-1)
160
559e2b7e
GL
161#ifndef of_node_to_nid
162static inline int of_node_to_nid(struct device_node *np) { return -1; }
163#define of_node_to_nid of_node_to_nid
164#endif
165
76c1ce78
SR
166extern struct device_node *of_find_node_by_name(struct device_node *from,
167 const char *name);
168#define for_each_node_by_name(dn, name) \
169 for (dn = of_find_node_by_name(NULL, name); dn; \
170 dn = of_find_node_by_name(dn, name))
171extern struct device_node *of_find_node_by_type(struct device_node *from,
172 const char *type);
173#define for_each_node_by_type(dn, type) \
174 for (dn = of_find_node_by_type(NULL, type); dn; \
175 dn = of_find_node_by_type(dn, type))
176extern struct device_node *of_find_compatible_node(struct device_node *from,
177 const char *type, const char *compat);
178#define for_each_compatible_node(dn, type, compatible) \
179 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
180 dn = of_find_compatible_node(dn, type, compatible))
283029d1
GL
181extern struct device_node *of_find_matching_node(struct device_node *from,
182 const struct of_device_id *matches);
183#define for_each_matching_node(dn, matches) \
184 for (dn = of_find_matching_node(NULL, matches); dn; \
185 dn = of_find_matching_node(dn, matches))
76c1ce78
SR
186extern struct device_node *of_find_node_by_path(const char *path);
187extern struct device_node *of_find_node_by_phandle(phandle handle);
188extern struct device_node *of_get_parent(const struct device_node *node);
f4eb0107 189extern struct device_node *of_get_next_parent(struct device_node *node);
76c1ce78
SR
190extern struct device_node *of_get_next_child(const struct device_node *node,
191 struct device_node *prev);
aabc08dc
ME
192#define for_each_child_of_node(parent, child) \
193 for (child = of_get_next_child(parent, NULL); child != NULL; \
194 child = of_get_next_child(parent, child))
195
1e291b14
ME
196extern struct device_node *of_find_node_with_property(
197 struct device_node *from, const char *prop_name);
198#define for_each_node_with_property(dn, prop_name) \
199 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
200 dn = of_find_node_with_property(dn, prop_name))
201
76c1ce78
SR
202extern struct property *of_find_property(const struct device_node *np,
203 const char *name,
204 int *lenp);
0e373639 205extern int of_property_read_u32_array(const struct device_node *np,
aac285c6 206 const char *propname,
0e373639
RH
207 u32 *out_values,
208 size_t sz);
4cd7f7a3
JI
209extern int of_property_read_u64(const struct device_node *np,
210 const char *propname, u64 *out_value);
0e373639 211
aac285c6
JI
212extern int of_property_read_string(struct device_node *np,
213 const char *propname,
214 const char **out_string);
4fcd15a0
BC
215extern int of_property_read_string_index(struct device_node *np,
216 const char *propname,
217 int index, const char **output);
7aff0fe3
GL
218extern int of_property_match_string(struct device_node *np,
219 const char *propname,
220 const char *string);
4fcd15a0
BC
221extern int of_property_count_strings(struct device_node *np,
222 const char *propname);
76c1ce78
SR
223extern int of_device_is_compatible(const struct device_node *device,
224 const char *);
834d97d4 225extern int of_device_is_available(const struct device_node *device);
76c1ce78
SR
226extern const void *of_get_property(const struct device_node *node,
227 const char *name,
228 int *lenp);
8af0da93
DA
229#define for_each_property_of_node(dn, pp) \
230 for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72 231
76c1ce78
SR
232extern int of_n_addr_cells(struct device_node *np);
233extern int of_n_size_cells(struct device_node *np);
283029d1
GL
234extern const struct of_device_id *of_match_node(
235 const struct of_device_id *matches, const struct device_node *node);
3f07af49 236extern int of_modalias_node(struct device_node *node, char *modalias, int len);
739649c5
GL
237extern struct device_node *of_parse_phandle(struct device_node *np,
238 const char *phandle_name,
239 int index);
15c9a0ac 240extern int of_parse_phandle_with_args(struct device_node *np,
64b60e09 241 const char *list_name, const char *cells_name, int index,
15c9a0ac 242 struct of_phandle_args *out_args);
76c1ce78 243
611cad72
SG
244extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
245extern int of_alias_get_id(struct device_node *np, const char *stem);
246
21b082ec
GL
247extern int of_machine_is_compatible(const char *compat);
248
249extern int prom_add_property(struct device_node* np, struct property* prop);
250extern int prom_remove_property(struct device_node *np, struct property *prop);
251extern int prom_update_property(struct device_node *np,
252 struct property *newprop,
253 struct property *oldprop);
254
fcdeb7fe
GL
255#if defined(CONFIG_OF_DYNAMIC)
256/* For updating the device tree at runtime */
257extern void of_attach_node(struct device_node *);
258extern void of_detach_node(struct device_node *);
259#endif
260
3a1e362e 261#define of_match_ptr(_ptr) (_ptr)
b98c0239 262#else /* CONFIG_OF */
3bcbaf6e
SAS
263
264static inline bool of_have_populated_dt(void)
265{
266 return false;
267}
268
aba3dfff
SW
269#define for_each_child_of_node(parent, child) \
270 while (0)
271
36a0904e
RN
272static inline int of_device_is_compatible(const struct device_node *device,
273 const char *name)
274{
275 return 0;
276}
277
aba3dfff
SW
278static inline struct property *of_find_property(const struct device_node *np,
279 const char *name,
280 int *lenp)
281{
282 return NULL;
283}
284
2261cc62
SG
285static inline struct device_node *of_find_compatible_node(
286 struct device_node *from,
287 const char *type,
288 const char *compat)
289{
290 return NULL;
291}
292
b98c0239 293static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6
JI
294 const char *propname,
295 u32 *out_values, size_t sz)
b98c0239
SG
296{
297 return -ENOSYS;
298}
299
300static inline int of_property_read_string(struct device_node *np,
aac285c6
JI
301 const char *propname,
302 const char **out_string)
b98c0239
SG
303{
304 return -ENOSYS;
305}
306
4fcd15a0
BC
307static inline int of_property_read_string_index(struct device_node *np,
308 const char *propname, int index,
309 const char **out_string)
310{
311 return -ENOSYS;
312}
313
314static inline int of_property_count_strings(struct device_node *np,
315 const char *propname)
316{
317 return -ENOSYS;
318}
319
89272b8c
SW
320static inline const void *of_get_property(const struct device_node *node,
321 const char *name,
322 int *lenp)
323{
324 return NULL;
325}
326
4cd7f7a3
JI
327static inline int of_property_read_u64(const struct device_node *np,
328 const char *propname, u64 *out_value)
329{
330 return -ENOSYS;
331}
332
36a0904e
RN
333static inline struct device_node *of_parse_phandle(struct device_node *np,
334 const char *phandle_name,
335 int index)
336{
337 return NULL;
338}
339
ed5f886d
NF
340static inline int of_alias_get_id(struct device_node *np, const char *stem)
341{
342 return -ENOSYS;
343}
344
50e07f88
SW
345static inline int of_machine_is_compatible(const char *compat)
346{
347 return 0;
348}
349
3a1e362e 350#define of_match_ptr(_ptr) NULL
5762c205 351#define of_match_node(_matches, _node) NULL
9dfbf207 352#endif /* CONFIG_OF */
b98c0239 353
fa4d34cc
JCPV
354/**
355 * of_property_read_bool - Findfrom a property
356 * @np: device node from which the property value is to be read.
357 * @propname: name of the property to be searched.
358 *
359 * Search for a property in a device node.
360 * Returns true if the property exist false otherwise.
361 */
362static inline bool of_property_read_bool(const struct device_node *np,
363 const char *propname)
364{
365 struct property *prop = of_find_property(np, propname, NULL);
366
367 return prop ? true : false;
368}
369
b98c0239 370static inline int of_property_read_u32(const struct device_node *np,
aac285c6 371 const char *propname,
b98c0239
SG
372 u32 *out_value)
373{
374 return of_property_read_u32_array(np, propname, out_value, 1);
375}
376
76c1ce78 377#endif /* _LINUX_OF_H */