]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/linux/of.h
mfd: twl4030-audio: Get audio MCLK via twl-core API instead of pdata
[mirror_ubuntu-eoan-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>
5ca4db61 24#include <linux/topology.h>
76c1ce78 25
2e89e685 26#include <asm/byteorder.h>
d0a99402 27#include <asm/errno.h>
2e89e685 28
731581e6
GL
29typedef u32 phandle;
30typedef u32 ihandle;
31
32struct property {
33 char *name;
34 int length;
35 void *value;
36 struct property *next;
37 unsigned long _flags;
38 unsigned int unique_id;
39};
40
6f192492
GL
41#if defined(CONFIG_SPARC)
42struct of_irq_controller;
43#endif
44
45struct device_node {
46 const char *name;
47 const char *type;
6016a363 48 phandle phandle;
6f192492
GL
49 char *full_name;
50
51 struct property *properties;
52 struct property *deadprops; /* removed properties */
53 struct device_node *parent;
54 struct device_node *child;
55 struct device_node *sibling;
56 struct device_node *next; /* next device of same type */
57 struct device_node *allnext; /* next in list of all nodes */
58 struct proc_dir_entry *pde; /* this node's proc directory */
59 struct kref kref;
60 unsigned long _flags;
61 void *data;
62#if defined(CONFIG_SPARC)
63 char *path_component_name;
64 unsigned int unique_id;
65 struct of_irq_controller *irq_trans;
66#endif
67};
68
15c9a0ac
GL
69#define MAX_PHANDLE_ARGS 8
70struct of_phandle_args {
71 struct device_node *np;
72 int args_count;
73 uint32_t args[MAX_PHANDLE_ARGS];
74};
75
0f22dd39
GL
76#ifdef CONFIG_OF_DYNAMIC
77extern struct device_node *of_node_get(struct device_node *node);
78extern void of_node_put(struct device_node *node);
79#else /* CONFIG_OF_DYNAMIC */
3ecdd051
RH
80/* Dummy ref counting routines - to be implemented later */
81static inline struct device_node *of_node_get(struct device_node *node)
82{
83 return node;
84}
0f22dd39
GL
85static inline void of_node_put(struct device_node *node) { }
86#endif /* !CONFIG_OF_DYNAMIC */
3ecdd051 87
c9e358df
GL
88#ifdef CONFIG_OF
89
41f88009
GL
90/* Pointer for first entry in chain of all nodes. */
91extern struct device_node *allnodes;
fc0bdae4 92extern struct device_node *of_chosen;
611cad72 93extern struct device_node *of_aliases;
0d351c3e 94extern rwlock_t devtree_lock;
41f88009 95
3bcbaf6e
SAS
96static inline bool of_have_populated_dt(void)
97{
98 return allnodes != NULL;
99}
100
035ebefc
AS
101static inline bool of_node_is_root(const struct device_node *node)
102{
103 return node && (node->parent == NULL);
104}
105
50436312
GL
106static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
107{
108 return test_bit(flag, &n->_flags);
109}
110
111static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
112{
113 set_bit(flag, &n->_flags);
114}
115
e91edcf5
GL
116extern struct device_node *of_find_all_nodes(struct device_node *prev);
117
b6caf2ad 118/*
3d6b8828 119 * OF address retrieval & translation
b6caf2ad
GL
120 */
121
122/* Helper to read a big number; size is in cells (not bytes) */
2e89e685 123static inline u64 of_read_number(const __be32 *cell, int size)
b6caf2ad
GL
124{
125 u64 r = 0;
126 while (size--)
2e89e685 127 r = (r << 32) | be32_to_cpu(*(cell++));
b6caf2ad
GL
128 return r;
129}
130
131/* Like of_read_number, but we want an unsigned long result */
2e89e685 132static inline unsigned long of_read_ulong(const __be32 *cell, int size)
b6caf2ad 133{
2be09cb9
GL
134 /* toss away upper bits if unsigned long is smaller than u64 */
135 return of_read_number(cell, size);
b6caf2ad 136}
b6caf2ad 137
76c1ce78
SR
138#include <asm/prom.h>
139
7c7b60cb
GL
140/* Default #address and #size cells. Allow arch asm/prom.h to override */
141#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
142#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
143#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
144#endif
145
146/* Default string compare functions, Allow arch asm/prom.h to override */
147#if !defined(of_compat_cmp)
1976152f 148#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
7c7b60cb
GL
149#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
150#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
151#endif
152
76c1ce78
SR
153/* flag descriptions */
154#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
155#define OF_DETACHED 2 /* node has been detached from the device tree */
156
61e955db
GL
157#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
158#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
159
76c1ce78
SR
160#define OF_BAD_ADDR ((u64)-1)
161
74a7f084
GL
162static inline const char* of_node_full_name(struct device_node *np)
163{
164 return np ? np->full_name : "<no-node>";
165}
166
76c1ce78
SR
167extern struct device_node *of_find_node_by_name(struct device_node *from,
168 const char *name);
169#define for_each_node_by_name(dn, name) \
170 for (dn = of_find_node_by_name(NULL, name); dn; \
171 dn = of_find_node_by_name(dn, name))
172extern struct device_node *of_find_node_by_type(struct device_node *from,
173 const char *type);
174#define for_each_node_by_type(dn, type) \
175 for (dn = of_find_node_by_type(NULL, type); dn; \
176 dn = of_find_node_by_type(dn, type))
177extern struct device_node *of_find_compatible_node(struct device_node *from,
178 const char *type, const char *compat);
179#define for_each_compatible_node(dn, type, compatible) \
180 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
181 dn = of_find_compatible_node(dn, type, compatible))
283029d1
GL
182extern struct device_node *of_find_matching_node(struct device_node *from,
183 const struct of_device_id *matches);
184#define for_each_matching_node(dn, matches) \
185 for (dn = of_find_matching_node(NULL, matches); dn; \
186 dn = of_find_matching_node(dn, matches))
76c1ce78
SR
187extern struct device_node *of_find_node_by_path(const char *path);
188extern struct device_node *of_find_node_by_phandle(phandle handle);
189extern struct device_node *of_get_parent(const struct device_node *node);
f4eb0107 190extern struct device_node *of_get_next_parent(struct device_node *node);
76c1ce78
SR
191extern struct device_node *of_get_next_child(const struct device_node *node,
192 struct device_node *prev);
aabc08dc
ME
193#define for_each_child_of_node(parent, child) \
194 for (child = of_get_next_child(parent, NULL); child != NULL; \
195 child = of_get_next_child(parent, child))
196
183f1d0c
DA
197static inline int of_get_child_count(const struct device_node *np)
198{
199 struct device_node *child;
200 int num = 0;
201
202 for_each_child_of_node(np, child)
203 num++;
204
205 return num;
206}
207
1e291b14
ME
208extern struct device_node *of_find_node_with_property(
209 struct device_node *from, const char *prop_name);
210#define for_each_node_with_property(dn, prop_name) \
211 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
212 dn = of_find_node_with_property(dn, prop_name))
213
76c1ce78
SR
214extern struct property *of_find_property(const struct device_node *np,
215 const char *name,
216 int *lenp);
0e373639 217extern int of_property_read_u32_array(const struct device_node *np,
aac285c6 218 const char *propname,
0e373639
RH
219 u32 *out_values,
220 size_t sz);
4cd7f7a3
JI
221extern int of_property_read_u64(const struct device_node *np,
222 const char *propname, u64 *out_value);
0e373639 223
aac285c6
JI
224extern int of_property_read_string(struct device_node *np,
225 const char *propname,
226 const char **out_string);
4fcd15a0
BC
227extern int of_property_read_string_index(struct device_node *np,
228 const char *propname,
229 int index, const char **output);
7aff0fe3
GL
230extern int of_property_match_string(struct device_node *np,
231 const char *propname,
232 const char *string);
4fcd15a0
BC
233extern int of_property_count_strings(struct device_node *np,
234 const char *propname);
76c1ce78
SR
235extern int of_device_is_compatible(const struct device_node *device,
236 const char *);
834d97d4 237extern int of_device_is_available(const struct device_node *device);
76c1ce78
SR
238extern const void *of_get_property(const struct device_node *node,
239 const char *name,
240 int *lenp);
8af0da93
DA
241#define for_each_property_of_node(dn, pp) \
242 for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72 243
76c1ce78
SR
244extern int of_n_addr_cells(struct device_node *np);
245extern int of_n_size_cells(struct device_node *np);
283029d1
GL
246extern const struct of_device_id *of_match_node(
247 const struct of_device_id *matches, const struct device_node *node);
3f07af49 248extern int of_modalias_node(struct device_node *node, char *modalias, int len);
739649c5
GL
249extern struct device_node *of_parse_phandle(struct device_node *np,
250 const char *phandle_name,
251 int index);
15c9a0ac 252extern int of_parse_phandle_with_args(struct device_node *np,
64b60e09 253 const char *list_name, const char *cells_name, int index,
15c9a0ac 254 struct of_phandle_args *out_args);
76c1ce78 255
611cad72
SG
256extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
257extern int of_alias_get_id(struct device_node *np, const char *stem);
258
21b082ec
GL
259extern int of_machine_is_compatible(const char *compat);
260
261extern int prom_add_property(struct device_node* np, struct property* prop);
262extern int prom_remove_property(struct device_node *np, struct property *prop);
263extern int prom_update_property(struct device_node *np,
475d0094 264 struct property *newprop);
21b082ec 265
fcdeb7fe
GL
266#if defined(CONFIG_OF_DYNAMIC)
267/* For updating the device tree at runtime */
268extern void of_attach_node(struct device_node *);
269extern void of_detach_node(struct device_node *);
270#endif
271
3a1e362e 272#define of_match_ptr(_ptr) (_ptr)
c541adc6
SW
273
274/*
275 * struct property *prop;
276 * const __be32 *p;
277 * u32 u;
278 *
279 * of_property_for_each_u32(np, "propname", prop, p, u)
280 * printk("U32 value: %x\n", u);
281 */
282const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
283 u32 *pu);
284#define of_property_for_each_u32(np, propname, prop, p, u) \
285 for (prop = of_find_property(np, propname, NULL), \
286 p = of_prop_next_u32(prop, NULL, &u); \
287 p; \
288 p = of_prop_next_u32(prop, p, &u))
289
290/*
291 * struct property *prop;
292 * const char *s;
293 *
294 * of_property_for_each_string(np, "propname", prop, s)
295 * printk("String value: %s\n", s);
296 */
297const char *of_prop_next_string(struct property *prop, const char *cur);
298#define of_property_for_each_string(np, propname, prop, s) \
299 for (prop = of_find_property(np, propname, NULL), \
300 s = of_prop_next_string(prop, NULL); \
301 s; \
302 s = of_prop_next_string(prop, s))
303
b98c0239 304#else /* CONFIG_OF */
3bcbaf6e 305
74a7f084
GL
306static inline const char* of_node_full_name(struct device_node *np)
307{
308 return "<no-node>";
309}
310
3bcbaf6e
SAS
311static inline bool of_have_populated_dt(void)
312{
313 return false;
314}
315
aba3dfff
SW
316#define for_each_child_of_node(parent, child) \
317 while (0)
318
183f1d0c
DA
319static inline int of_get_child_count(const struct device_node *np)
320{
321 return 0;
322}
323
36a0904e
RN
324static inline int of_device_is_compatible(const struct device_node *device,
325 const char *name)
326{
327 return 0;
328}
329
aba3dfff
SW
330static inline struct property *of_find_property(const struct device_node *np,
331 const char *name,
332 int *lenp)
333{
334 return NULL;
335}
336
2261cc62
SG
337static inline struct device_node *of_find_compatible_node(
338 struct device_node *from,
339 const char *type,
340 const char *compat)
341{
342 return NULL;
343}
344
b98c0239 345static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6
JI
346 const char *propname,
347 u32 *out_values, size_t sz)
b98c0239
SG
348{
349 return -ENOSYS;
350}
351
352static inline int of_property_read_string(struct device_node *np,
aac285c6
JI
353 const char *propname,
354 const char **out_string)
b98c0239
SG
355{
356 return -ENOSYS;
357}
358
4fcd15a0
BC
359static inline int of_property_read_string_index(struct device_node *np,
360 const char *propname, int index,
361 const char **out_string)
362{
363 return -ENOSYS;
364}
365
366static inline int of_property_count_strings(struct device_node *np,
367 const char *propname)
368{
369 return -ENOSYS;
370}
371
89272b8c
SW
372static inline const void *of_get_property(const struct device_node *node,
373 const char *name,
374 int *lenp)
375{
376 return NULL;
377}
378
4cd7f7a3
JI
379static inline int of_property_read_u64(const struct device_node *np,
380 const char *propname, u64 *out_value)
381{
382 return -ENOSYS;
383}
384
bd3d5500
TR
385static inline int of_property_match_string(struct device_node *np,
386 const char *propname,
387 const char *string)
388{
389 return -ENOSYS;
390}
391
36a0904e
RN
392static inline struct device_node *of_parse_phandle(struct device_node *np,
393 const char *phandle_name,
394 int index)
395{
396 return NULL;
397}
398
e05e5070
TR
399static inline int of_parse_phandle_with_args(struct device_node *np,
400 const char *list_name,
401 const char *cells_name,
402 int index,
403 struct of_phandle_args *out_args)
404{
405 return -ENOSYS;
406}
407
ed5f886d
NF
408static inline int of_alias_get_id(struct device_node *np, const char *stem)
409{
410 return -ENOSYS;
411}
412
50e07f88
SW
413static inline int of_machine_is_compatible(const char *compat)
414{
415 return 0;
416}
417
3a1e362e 418#define of_match_ptr(_ptr) NULL
5762c205 419#define of_match_node(_matches, _node) NULL
c541adc6
SW
420#define of_property_for_each_u32(np, propname, prop, p, u) \
421 while (0)
422#define of_property_for_each_string(np, propname, prop, s) \
423 while (0)
9dfbf207 424#endif /* CONFIG_OF */
b98c0239 425
5ca4db61
PM
426#ifndef of_node_to_nid
427static inline int of_node_to_nid(struct device_node *np)
428{
429 return numa_node_id();
430}
431
432#define of_node_to_nid of_node_to_nid
433#endif
434
fa4d34cc
JCPV
435/**
436 * of_property_read_bool - Findfrom a property
437 * @np: device node from which the property value is to be read.
438 * @propname: name of the property to be searched.
439 *
440 * Search for a property in a device node.
441 * Returns true if the property exist false otherwise.
442 */
443static inline bool of_property_read_bool(const struct device_node *np,
444 const char *propname)
445{
446 struct property *prop = of_find_property(np, propname, NULL);
447
448 return prop ? true : false;
449}
450
b98c0239 451static inline int of_property_read_u32(const struct device_node *np,
aac285c6 452 const char *propname,
b98c0239
SG
453 u32 *out_value)
454{
455 return of_property_read_u32_array(np, propname, out_value, 1);
456}
457
76c1ce78 458#endif /* _LINUX_OF_H */