]>
Commit | Line | Data |
---|---|---|
97e873e5 SR |
1 | /* |
2 | * Procedures for creating, accessing and interpreting the device tree. | |
3 | * | |
4 | * Paul Mackerras August 1996. | |
5 | * Copyright (C) 1996-2005 Paul Mackerras. | |
6 | * | |
7 | * Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner. | |
8 | * {engebret|bergner}@us.ibm.com | |
9 | * | |
10 | * Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net | |
11 | * | |
e91edcf5 GL |
12 | * Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and |
13 | * Grant Likely. | |
97e873e5 SR |
14 | * |
15 | * This program is free software; you can redistribute it and/or | |
16 | * modify it under the terms of the GNU General Public License | |
17 | * as published by the Free Software Foundation; either version | |
18 | * 2 of the License, or (at your option) any later version. | |
19 | */ | |
611cad72 | 20 | #include <linux/ctype.h> |
183912d3 | 21 | #include <linux/cpu.h> |
97e873e5 SR |
22 | #include <linux/module.h> |
23 | #include <linux/of.h> | |
fd9fdb78 | 24 | #include <linux/of_graph.h> |
581b605a | 25 | #include <linux/spinlock.h> |
5a0e3ad6 | 26 | #include <linux/slab.h> |
75b57ecf | 27 | #include <linux/string.h> |
a9f2f63a | 28 | #include <linux/proc_fs.h> |
581b605a | 29 | |
ced4eec9 | 30 | #include "of_private.h" |
611cad72 | 31 | |
ced4eec9 | 32 | LIST_HEAD(aliases_lookup); |
611cad72 | 33 | |
465aac6d RD |
34 | struct device_node *of_allnodes; |
35 | EXPORT_SYMBOL(of_allnodes); | |
fc0bdae4 | 36 | struct device_node *of_chosen; |
611cad72 | 37 | struct device_node *of_aliases; |
5c19e952 | 38 | static struct device_node *of_stdout; |
611cad72 | 39 | |
75b57ecf GL |
40 | static struct kset *of_kset; |
41 | ||
42 | /* | |
43 | * Used to protect the of_aliases; but also overloaded to hold off addition of | |
44 | * nodes to sysfs | |
45 | */ | |
ced4eec9 | 46 | DEFINE_MUTEX(of_aliases_mutex); |
1ef4d424 | 47 | |
581b605a SR |
48 | /* use when traversing tree through the allnext, child, sibling, |
49 | * or parent members of struct device_node. | |
50 | */ | |
d6d3c4e6 | 51 | DEFINE_RAW_SPINLOCK(devtree_lock); |
97e873e5 SR |
52 | |
53 | int of_n_addr_cells(struct device_node *np) | |
54 | { | |
a9fadeef | 55 | const __be32 *ip; |
97e873e5 SR |
56 | |
57 | do { | |
58 | if (np->parent) | |
59 | np = np->parent; | |
60 | ip = of_get_property(np, "#address-cells", NULL); | |
61 | if (ip) | |
33714881 | 62 | return be32_to_cpup(ip); |
97e873e5 SR |
63 | } while (np->parent); |
64 | /* No #address-cells property for the root node */ | |
65 | return OF_ROOT_NODE_ADDR_CELLS_DEFAULT; | |
66 | } | |
67 | EXPORT_SYMBOL(of_n_addr_cells); | |
68 | ||
69 | int of_n_size_cells(struct device_node *np) | |
70 | { | |
a9fadeef | 71 | const __be32 *ip; |
97e873e5 SR |
72 | |
73 | do { | |
74 | if (np->parent) | |
75 | np = np->parent; | |
76 | ip = of_get_property(np, "#size-cells", NULL); | |
77 | if (ip) | |
33714881 | 78 | return be32_to_cpup(ip); |
97e873e5 SR |
79 | } while (np->parent); |
80 | /* No #size-cells property for the root node */ | |
81 | return OF_ROOT_NODE_SIZE_CELLS_DEFAULT; | |
82 | } | |
83 | EXPORT_SYMBOL(of_n_size_cells); | |
84 | ||
0c3f061c RH |
85 | #ifdef CONFIG_NUMA |
86 | int __weak of_node_to_nid(struct device_node *np) | |
87 | { | |
88 | return numa_node_id(); | |
89 | } | |
90 | #endif | |
91 | ||
0f22dd39 | 92 | #if defined(CONFIG_OF_DYNAMIC) |
923f7e30 GL |
93 | /** |
94 | * of_node_get - Increment refcount of a node | |
95 | * @node: Node to inc refcount, NULL is supported to | |
96 | * simplify writing of callers | |
97 | * | |
98 | * Returns node. | |
99 | */ | |
100 | struct device_node *of_node_get(struct device_node *node) | |
101 | { | |
102 | if (node) | |
75b57ecf | 103 | kobject_get(&node->kobj); |
923f7e30 GL |
104 | return node; |
105 | } | |
106 | EXPORT_SYMBOL(of_node_get); | |
107 | ||
75b57ecf | 108 | static inline struct device_node *kobj_to_device_node(struct kobject *kobj) |
923f7e30 | 109 | { |
75b57ecf | 110 | return container_of(kobj, struct device_node, kobj); |
923f7e30 GL |
111 | } |
112 | ||
113 | /** | |
114 | * of_node_release - release a dynamically allocated node | |
115 | * @kref: kref element of the node to be released | |
116 | * | |
117 | * In of_node_put() this function is passed to kref_put() | |
118 | * as the destructor. | |
119 | */ | |
75b57ecf | 120 | static void of_node_release(struct kobject *kobj) |
923f7e30 | 121 | { |
75b57ecf | 122 | struct device_node *node = kobj_to_device_node(kobj); |
923f7e30 GL |
123 | struct property *prop = node->properties; |
124 | ||
125 | /* We should never be releasing nodes that haven't been detached. */ | |
126 | if (!of_node_check_flag(node, OF_DETACHED)) { | |
127 | pr_err("ERROR: Bad of_node_put() on %s\n", node->full_name); | |
128 | dump_stack(); | |
923f7e30 GL |
129 | return; |
130 | } | |
131 | ||
132 | if (!of_node_check_flag(node, OF_DYNAMIC)) | |
133 | return; | |
134 | ||
135 | while (prop) { | |
136 | struct property *next = prop->next; | |
137 | kfree(prop->name); | |
138 | kfree(prop->value); | |
139 | kfree(prop); | |
140 | prop = next; | |
141 | ||
142 | if (!prop) { | |
143 | prop = node->deadprops; | |
144 | node->deadprops = NULL; | |
145 | } | |
146 | } | |
147 | kfree(node->full_name); | |
148 | kfree(node->data); | |
149 | kfree(node); | |
150 | } | |
151 | ||
152 | /** | |
153 | * of_node_put - Decrement refcount of a node | |
154 | * @node: Node to dec refcount, NULL is supported to | |
155 | * simplify writing of callers | |
156 | * | |
157 | */ | |
158 | void of_node_put(struct device_node *node) | |
159 | { | |
160 | if (node) | |
75b57ecf | 161 | kobject_put(&node->kobj); |
923f7e30 GL |
162 | } |
163 | EXPORT_SYMBOL(of_node_put); | |
75b57ecf GL |
164 | #else |
165 | static void of_node_release(struct kobject *kobj) | |
166 | { | |
167 | /* Without CONFIG_OF_DYNAMIC, no nodes gets freed */ | |
168 | } | |
0f22dd39 | 169 | #endif /* CONFIG_OF_DYNAMIC */ |
923f7e30 | 170 | |
75b57ecf GL |
171 | struct kobj_type of_node_ktype = { |
172 | .release = of_node_release, | |
173 | }; | |
174 | ||
175 | static ssize_t of_node_property_read(struct file *filp, struct kobject *kobj, | |
176 | struct bin_attribute *bin_attr, char *buf, | |
177 | loff_t offset, size_t count) | |
178 | { | |
179 | struct property *pp = container_of(bin_attr, struct property, attr); | |
180 | return memory_read_from_buffer(buf, count, &offset, pp->value, pp->length); | |
181 | } | |
182 | ||
183 | static const char *safe_name(struct kobject *kobj, const char *orig_name) | |
184 | { | |
185 | const char *name = orig_name; | |
186 | struct kernfs_node *kn; | |
187 | int i = 0; | |
188 | ||
189 | /* don't be a hero. After 16 tries give up */ | |
190 | while (i < 16 && (kn = sysfs_get_dirent(kobj->sd, name))) { | |
191 | sysfs_put(kn); | |
192 | if (name != orig_name) | |
193 | kfree(name); | |
194 | name = kasprintf(GFP_KERNEL, "%s#%i", orig_name, ++i); | |
195 | } | |
196 | ||
197 | if (name != orig_name) | |
198 | pr_warn("device-tree: Duplicate name in %s, renamed to \"%s\"\n", | |
199 | kobject_name(kobj), name); | |
200 | return name; | |
201 | } | |
202 | ||
203 | static int __of_add_property_sysfs(struct device_node *np, struct property *pp) | |
204 | { | |
205 | int rc; | |
206 | ||
207 | /* Important: Don't leak passwords */ | |
208 | bool secure = strncmp(pp->name, "security-", 9) == 0; | |
209 | ||
210 | sysfs_bin_attr_init(&pp->attr); | |
211 | pp->attr.attr.name = safe_name(&np->kobj, pp->name); | |
212 | pp->attr.attr.mode = secure ? S_IRUSR : S_IRUGO; | |
213 | pp->attr.size = secure ? 0 : pp->length; | |
214 | pp->attr.read = of_node_property_read; | |
215 | ||
216 | rc = sysfs_create_bin_file(&np->kobj, &pp->attr); | |
217 | WARN(rc, "error adding attribute %s to node %s\n", pp->name, np->full_name); | |
218 | return rc; | |
219 | } | |
220 | ||
221 | static int __of_node_add(struct device_node *np) | |
222 | { | |
223 | const char *name; | |
224 | struct property *pp; | |
225 | int rc; | |
226 | ||
227 | np->kobj.kset = of_kset; | |
228 | if (!np->parent) { | |
229 | /* Nodes without parents are new top level trees */ | |
230 | rc = kobject_add(&np->kobj, NULL, safe_name(&of_kset->kobj, "base")); | |
231 | } else { | |
232 | name = safe_name(&np->parent->kobj, kbasename(np->full_name)); | |
233 | if (!name || !name[0]) | |
234 | return -EINVAL; | |
235 | ||
236 | rc = kobject_add(&np->kobj, &np->parent->kobj, "%s", name); | |
237 | } | |
238 | if (rc) | |
239 | return rc; | |
240 | ||
241 | for_each_property_of_node(np, pp) | |
242 | __of_add_property_sysfs(np, pp); | |
243 | ||
244 | return 0; | |
245 | } | |
246 | ||
247 | int of_node_add(struct device_node *np) | |
248 | { | |
249 | int rc = 0; | |
0829f6d1 PA |
250 | |
251 | BUG_ON(!of_node_is_initialized(np)); | |
252 | ||
253 | /* | |
254 | * Grab the mutex here so that in a race condition between of_init() and | |
255 | * of_node_add(), node addition will still be consistent. | |
256 | */ | |
75b57ecf GL |
257 | mutex_lock(&of_aliases_mutex); |
258 | if (of_kset) | |
259 | rc = __of_node_add(np); | |
0829f6d1 PA |
260 | else |
261 | /* This scenario may be perfectly valid, but report it anyway */ | |
262 | pr_info("of_node_add(%s) before of_init()\n", np->full_name); | |
75b57ecf GL |
263 | mutex_unlock(&of_aliases_mutex); |
264 | return rc; | |
265 | } | |
266 | ||
267 | #if defined(CONFIG_OF_DYNAMIC) | |
268 | static void of_node_remove(struct device_node *np) | |
269 | { | |
270 | struct property *pp; | |
271 | ||
0829f6d1 | 272 | BUG_ON(!of_node_is_initialized(np)); |
75b57ecf | 273 | |
0829f6d1 PA |
274 | /* only remove properties if on sysfs */ |
275 | if (of_node_is_attached(np)) { | |
276 | for_each_property_of_node(np, pp) | |
277 | sysfs_remove_bin_file(&np->kobj, &pp->attr); | |
278 | kobject_del(&np->kobj); | |
279 | } | |
280 | ||
281 | /* finally remove the kobj_init ref */ | |
282 | of_node_put(np); | |
75b57ecf GL |
283 | } |
284 | #endif | |
285 | ||
286 | static int __init of_init(void) | |
287 | { | |
288 | struct device_node *np; | |
289 | ||
290 | /* Create the kset, and register existing nodes */ | |
291 | mutex_lock(&of_aliases_mutex); | |
292 | of_kset = kset_create_and_add("devicetree", NULL, firmware_kobj); | |
293 | if (!of_kset) { | |
294 | mutex_unlock(&of_aliases_mutex); | |
295 | return -ENOMEM; | |
296 | } | |
297 | for_each_of_allnodes(np) | |
298 | __of_node_add(np); | |
299 | mutex_unlock(&of_aliases_mutex); | |
300 | ||
8357041a | 301 | /* Symlink in /proc as required by userspace ABI */ |
75b57ecf GL |
302 | if (of_allnodes) |
303 | proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base"); | |
75b57ecf GL |
304 | |
305 | return 0; | |
306 | } | |
307 | core_initcall(of_init); | |
308 | ||
28d0e36b TG |
309 | static struct property *__of_find_property(const struct device_node *np, |
310 | const char *name, int *lenp) | |
581b605a SR |
311 | { |
312 | struct property *pp; | |
313 | ||
64e4566f TT |
314 | if (!np) |
315 | return NULL; | |
316 | ||
a3a7cab1 | 317 | for (pp = np->properties; pp; pp = pp->next) { |
581b605a | 318 | if (of_prop_cmp(pp->name, name) == 0) { |
a3a7cab1 | 319 | if (lenp) |
581b605a SR |
320 | *lenp = pp->length; |
321 | break; | |
322 | } | |
323 | } | |
28d0e36b TG |
324 | |
325 | return pp; | |
326 | } | |
327 | ||
328 | struct property *of_find_property(const struct device_node *np, | |
329 | const char *name, | |
330 | int *lenp) | |
331 | { | |
332 | struct property *pp; | |
d6d3c4e6 | 333 | unsigned long flags; |
28d0e36b | 334 | |
d6d3c4e6 | 335 | raw_spin_lock_irqsave(&devtree_lock, flags); |
28d0e36b | 336 | pp = __of_find_property(np, name, lenp); |
d6d3c4e6 | 337 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
581b605a SR |
338 | |
339 | return pp; | |
340 | } | |
341 | EXPORT_SYMBOL(of_find_property); | |
342 | ||
e91edcf5 GL |
343 | /** |
344 | * of_find_all_nodes - Get next node in global list | |
345 | * @prev: Previous node or NULL to start iteration | |
346 | * of_node_put() will be called on it | |
347 | * | |
348 | * Returns a node pointer with refcount incremented, use | |
349 | * of_node_put() on it when done. | |
350 | */ | |
351 | struct device_node *of_find_all_nodes(struct device_node *prev) | |
352 | { | |
353 | struct device_node *np; | |
d25d8694 | 354 | unsigned long flags; |
e91edcf5 | 355 | |
d25d8694 | 356 | raw_spin_lock_irqsave(&devtree_lock, flags); |
465aac6d | 357 | np = prev ? prev->allnext : of_allnodes; |
e91edcf5 GL |
358 | for (; np != NULL; np = np->allnext) |
359 | if (of_node_get(np)) | |
360 | break; | |
361 | of_node_put(prev); | |
d25d8694 | 362 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
e91edcf5 GL |
363 | return np; |
364 | } | |
365 | EXPORT_SYMBOL(of_find_all_nodes); | |
366 | ||
28d0e36b TG |
367 | /* |
368 | * Find a property with a given name for a given node | |
369 | * and return the value. | |
370 | */ | |
371 | static const void *__of_get_property(const struct device_node *np, | |
372 | const char *name, int *lenp) | |
373 | { | |
374 | struct property *pp = __of_find_property(np, name, lenp); | |
375 | ||
376 | return pp ? pp->value : NULL; | |
377 | } | |
378 | ||
97e873e5 SR |
379 | /* |
380 | * Find a property with a given name for a given node | |
381 | * and return the value. | |
382 | */ | |
383 | const void *of_get_property(const struct device_node *np, const char *name, | |
28d0e36b | 384 | int *lenp) |
97e873e5 SR |
385 | { |
386 | struct property *pp = of_find_property(np, name, lenp); | |
387 | ||
388 | return pp ? pp->value : NULL; | |
389 | } | |
390 | EXPORT_SYMBOL(of_get_property); | |
0081cbc3 | 391 | |
183912d3 SH |
392 | /* |
393 | * arch_match_cpu_phys_id - Match the given logical CPU and physical id | |
394 | * | |
395 | * @cpu: logical cpu index of a core/thread | |
396 | * @phys_id: physical identifier of a core/thread | |
397 | * | |
398 | * CPU logical to physical index mapping is architecture specific. | |
399 | * However this __weak function provides a default match of physical | |
400 | * id to logical cpu index. phys_id provided here is usually values read | |
401 | * from the device tree which must match the hardware internal registers. | |
402 | * | |
403 | * Returns true if the physical identifier and the logical cpu index | |
404 | * correspond to the same core/thread, false otherwise. | |
405 | */ | |
406 | bool __weak arch_match_cpu_phys_id(int cpu, u64 phys_id) | |
407 | { | |
408 | return (u32)phys_id == cpu; | |
409 | } | |
410 | ||
411 | /** | |
412 | * Checks if the given "prop_name" property holds the physical id of the | |
413 | * core/thread corresponding to the logical cpu 'cpu'. If 'thread' is not | |
414 | * NULL, local thread number within the core is returned in it. | |
415 | */ | |
416 | static bool __of_find_n_match_cpu_property(struct device_node *cpun, | |
417 | const char *prop_name, int cpu, unsigned int *thread) | |
418 | { | |
419 | const __be32 *cell; | |
420 | int ac, prop_len, tid; | |
421 | u64 hwid; | |
422 | ||
423 | ac = of_n_addr_cells(cpun); | |
424 | cell = of_get_property(cpun, prop_name, &prop_len); | |
f3cea45a | 425 | if (!cell || !ac) |
183912d3 | 426 | return false; |
f3cea45a | 427 | prop_len /= sizeof(*cell) * ac; |
183912d3 SH |
428 | for (tid = 0; tid < prop_len; tid++) { |
429 | hwid = of_read_number(cell, ac); | |
430 | if (arch_match_cpu_phys_id(cpu, hwid)) { | |
431 | if (thread) | |
432 | *thread = tid; | |
433 | return true; | |
434 | } | |
435 | cell += ac; | |
436 | } | |
437 | return false; | |
438 | } | |
439 | ||
d1cb9d1a DM |
440 | /* |
441 | * arch_find_n_match_cpu_physical_id - See if the given device node is | |
442 | * for the cpu corresponding to logical cpu 'cpu'. Return true if so, | |
443 | * else false. If 'thread' is non-NULL, the local thread number within the | |
444 | * core is returned in it. | |
445 | */ | |
446 | bool __weak arch_find_n_match_cpu_physical_id(struct device_node *cpun, | |
447 | int cpu, unsigned int *thread) | |
448 | { | |
449 | /* Check for non-standard "ibm,ppc-interrupt-server#s" property | |
450 | * for thread ids on PowerPC. If it doesn't exist fallback to | |
451 | * standard "reg" property. | |
452 | */ | |
453 | if (IS_ENABLED(CONFIG_PPC) && | |
454 | __of_find_n_match_cpu_property(cpun, | |
455 | "ibm,ppc-interrupt-server#s", | |
456 | cpu, thread)) | |
457 | return true; | |
458 | ||
459 | if (__of_find_n_match_cpu_property(cpun, "reg", cpu, thread)) | |
460 | return true; | |
461 | ||
462 | return false; | |
463 | } | |
464 | ||
183912d3 SH |
465 | /** |
466 | * of_get_cpu_node - Get device node associated with the given logical CPU | |
467 | * | |
468 | * @cpu: CPU number(logical index) for which device node is required | |
469 | * @thread: if not NULL, local thread number within the physical core is | |
470 | * returned | |
471 | * | |
472 | * The main purpose of this function is to retrieve the device node for the | |
473 | * given logical CPU index. It should be used to initialize the of_node in | |
474 | * cpu device. Once of_node in cpu device is populated, all the further | |
475 | * references can use that instead. | |
476 | * | |
477 | * CPU logical to physical index mapping is architecture specific and is built | |
478 | * before booting secondary cores. This function uses arch_match_cpu_phys_id | |
479 | * which can be overridden by architecture specific implementation. | |
480 | * | |
481 | * Returns a node pointer for the logical cpu if found, else NULL. | |
482 | */ | |
483 | struct device_node *of_get_cpu_node(int cpu, unsigned int *thread) | |
484 | { | |
d1cb9d1a | 485 | struct device_node *cpun; |
183912d3 | 486 | |
d1cb9d1a DM |
487 | for_each_node_by_type(cpun, "cpu") { |
488 | if (arch_find_n_match_cpu_physical_id(cpun, cpu, thread)) | |
183912d3 SH |
489 | return cpun; |
490 | } | |
491 | return NULL; | |
492 | } | |
493 | EXPORT_SYMBOL(of_get_cpu_node); | |
494 | ||
215a14cf KH |
495 | /** |
496 | * __of_device_is_compatible() - Check if the node matches given constraints | |
497 | * @device: pointer to node | |
498 | * @compat: required compatible string, NULL or "" for any match | |
499 | * @type: required device_type value, NULL or "" for any match | |
500 | * @name: required node name, NULL or "" for any match | |
501 | * | |
502 | * Checks if the given @compat, @type and @name strings match the | |
503 | * properties of the given @device. A constraints can be skipped by | |
504 | * passing NULL or an empty string as the constraint. | |
505 | * | |
506 | * Returns 0 for no match, and a positive integer on match. The return | |
507 | * value is a relative score with larger values indicating better | |
508 | * matches. The score is weighted for the most specific compatible value | |
509 | * to get the highest score. Matching type is next, followed by matching | |
510 | * name. Practically speaking, this results in the following priority | |
511 | * order for matches: | |
512 | * | |
513 | * 1. specific compatible && type && name | |
514 | * 2. specific compatible && type | |
515 | * 3. specific compatible && name | |
516 | * 4. specific compatible | |
517 | * 5. general compatible && type && name | |
518 | * 6. general compatible && type | |
519 | * 7. general compatible && name | |
520 | * 8. general compatible | |
521 | * 9. type && name | |
522 | * 10. type | |
523 | * 11. name | |
0081cbc3 | 524 | */ |
28d0e36b | 525 | static int __of_device_is_compatible(const struct device_node *device, |
215a14cf KH |
526 | const char *compat, const char *type, const char *name) |
527 | { | |
528 | struct property *prop; | |
529 | const char *cp; | |
530 | int index = 0, score = 0; | |
531 | ||
532 | /* Compatible match has highest priority */ | |
533 | if (compat && compat[0]) { | |
534 | prop = __of_find_property(device, "compatible", NULL); | |
535 | for (cp = of_prop_next_string(prop, NULL); cp; | |
536 | cp = of_prop_next_string(prop, cp), index++) { | |
537 | if (of_compat_cmp(cp, compat, strlen(compat)) == 0) { | |
538 | score = INT_MAX/2 - (index << 2); | |
539 | break; | |
540 | } | |
541 | } | |
542 | if (!score) | |
543 | return 0; | |
544 | } | |
0081cbc3 | 545 | |
215a14cf KH |
546 | /* Matching type is better than matching name */ |
547 | if (type && type[0]) { | |
548 | if (!device->type || of_node_cmp(type, device->type)) | |
549 | return 0; | |
550 | score += 2; | |
0081cbc3 SR |
551 | } |
552 | ||
215a14cf KH |
553 | /* Matching name is a bit better than not */ |
554 | if (name && name[0]) { | |
555 | if (!device->name || of_node_cmp(name, device->name)) | |
556 | return 0; | |
557 | score++; | |
558 | } | |
559 | ||
560 | return score; | |
0081cbc3 | 561 | } |
28d0e36b TG |
562 | |
563 | /** Checks if the given "compat" string matches one of the strings in | |
564 | * the device's "compatible" property | |
565 | */ | |
566 | int of_device_is_compatible(const struct device_node *device, | |
567 | const char *compat) | |
568 | { | |
d6d3c4e6 | 569 | unsigned long flags; |
28d0e36b TG |
570 | int res; |
571 | ||
d6d3c4e6 | 572 | raw_spin_lock_irqsave(&devtree_lock, flags); |
215a14cf | 573 | res = __of_device_is_compatible(device, compat, NULL, NULL); |
d6d3c4e6 | 574 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
28d0e36b TG |
575 | return res; |
576 | } | |
0081cbc3 | 577 | EXPORT_SYMBOL(of_device_is_compatible); |
e679c5f4 | 578 | |
1f43cfb9 | 579 | /** |
71a157e8 | 580 | * of_machine_is_compatible - Test root of device tree for a given compatible value |
1f43cfb9 GL |
581 | * @compat: compatible string to look for in root node's compatible property. |
582 | * | |
583 | * Returns true if the root node has the given value in its | |
584 | * compatible property. | |
585 | */ | |
71a157e8 | 586 | int of_machine_is_compatible(const char *compat) |
1f43cfb9 GL |
587 | { |
588 | struct device_node *root; | |
589 | int rc = 0; | |
590 | ||
591 | root = of_find_node_by_path("/"); | |
592 | if (root) { | |
593 | rc = of_device_is_compatible(root, compat); | |
594 | of_node_put(root); | |
595 | } | |
596 | return rc; | |
597 | } | |
71a157e8 | 598 | EXPORT_SYMBOL(of_machine_is_compatible); |
1f43cfb9 | 599 | |
834d97d4 | 600 | /** |
c31a0c05 | 601 | * __of_device_is_available - check if a device is available for use |
834d97d4 | 602 | * |
c31a0c05 | 603 | * @device: Node to check for availability, with locks already held |
834d97d4 JB |
604 | * |
605 | * Returns 1 if the status property is absent or set to "okay" or "ok", | |
606 | * 0 otherwise | |
607 | */ | |
c31a0c05 | 608 | static int __of_device_is_available(const struct device_node *device) |
834d97d4 JB |
609 | { |
610 | const char *status; | |
611 | int statlen; | |
612 | ||
42ccd781 XL |
613 | if (!device) |
614 | return 0; | |
615 | ||
c31a0c05 | 616 | status = __of_get_property(device, "status", &statlen); |
834d97d4 JB |
617 | if (status == NULL) |
618 | return 1; | |
619 | ||
620 | if (statlen > 0) { | |
621 | if (!strcmp(status, "okay") || !strcmp(status, "ok")) | |
622 | return 1; | |
623 | } | |
624 | ||
625 | return 0; | |
626 | } | |
c31a0c05 SW |
627 | |
628 | /** | |
629 | * of_device_is_available - check if a device is available for use | |
630 | * | |
631 | * @device: Node to check for availability | |
632 | * | |
633 | * Returns 1 if the status property is absent or set to "okay" or "ok", | |
634 | * 0 otherwise | |
635 | */ | |
636 | int of_device_is_available(const struct device_node *device) | |
637 | { | |
638 | unsigned long flags; | |
639 | int res; | |
640 | ||
641 | raw_spin_lock_irqsave(&devtree_lock, flags); | |
642 | res = __of_device_is_available(device); | |
643 | raw_spin_unlock_irqrestore(&devtree_lock, flags); | |
644 | return res; | |
645 | ||
646 | } | |
834d97d4 JB |
647 | EXPORT_SYMBOL(of_device_is_available); |
648 | ||
e679c5f4 SR |
649 | /** |
650 | * of_get_parent - Get a node's parent if any | |
651 | * @node: Node to get parent | |
652 | * | |
653 | * Returns a node pointer with refcount incremented, use | |
654 | * of_node_put() on it when done. | |
655 | */ | |
656 | struct device_node *of_get_parent(const struct device_node *node) | |
657 | { | |
658 | struct device_node *np; | |
d6d3c4e6 | 659 | unsigned long flags; |
e679c5f4 SR |
660 | |
661 | if (!node) | |
662 | return NULL; | |
663 | ||
d6d3c4e6 | 664 | raw_spin_lock_irqsave(&devtree_lock, flags); |
e679c5f4 | 665 | np = of_node_get(node->parent); |
d6d3c4e6 | 666 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
e679c5f4 SR |
667 | return np; |
668 | } | |
669 | EXPORT_SYMBOL(of_get_parent); | |
d1cd355a | 670 | |
f4eb0107 ME |
671 | /** |
672 | * of_get_next_parent - Iterate to a node's parent | |
673 | * @node: Node to get parent of | |
674 | * | |
675 | * This is like of_get_parent() except that it drops the | |
676 | * refcount on the passed node, making it suitable for iterating | |
677 | * through a node's parents. | |
678 | * | |
679 | * Returns a node pointer with refcount incremented, use | |
680 | * of_node_put() on it when done. | |
681 | */ | |
682 | struct device_node *of_get_next_parent(struct device_node *node) | |
683 | { | |
684 | struct device_node *parent; | |
d6d3c4e6 | 685 | unsigned long flags; |
f4eb0107 ME |
686 | |
687 | if (!node) | |
688 | return NULL; | |
689 | ||
d6d3c4e6 | 690 | raw_spin_lock_irqsave(&devtree_lock, flags); |
f4eb0107 ME |
691 | parent = of_node_get(node->parent); |
692 | of_node_put(node); | |
d6d3c4e6 | 693 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
f4eb0107 ME |
694 | return parent; |
695 | } | |
6695be68 | 696 | EXPORT_SYMBOL(of_get_next_parent); |
f4eb0107 | 697 | |
0d0e02d6 GL |
698 | static struct device_node *__of_get_next_child(const struct device_node *node, |
699 | struct device_node *prev) | |
700 | { | |
701 | struct device_node *next; | |
702 | ||
703 | next = prev ? prev->sibling : node->child; | |
704 | for (; next; next = next->sibling) | |
705 | if (of_node_get(next)) | |
706 | break; | |
707 | of_node_put(prev); | |
708 | return next; | |
709 | } | |
710 | #define __for_each_child_of_node(parent, child) \ | |
711 | for (child = __of_get_next_child(parent, NULL); child != NULL; \ | |
712 | child = __of_get_next_child(parent, child)) | |
713 | ||
d1cd355a SR |
714 | /** |
715 | * of_get_next_child - Iterate a node childs | |
716 | * @node: parent node | |
717 | * @prev: previous child of the parent node, or NULL to get first | |
718 | * | |
719 | * Returns a node pointer with refcount incremented, use | |
720 | * of_node_put() on it when done. | |
721 | */ | |
722 | struct device_node *of_get_next_child(const struct device_node *node, | |
723 | struct device_node *prev) | |
724 | { | |
725 | struct device_node *next; | |
d6d3c4e6 | 726 | unsigned long flags; |
d1cd355a | 727 | |
d6d3c4e6 | 728 | raw_spin_lock_irqsave(&devtree_lock, flags); |
0d0e02d6 | 729 | next = __of_get_next_child(node, prev); |
d6d3c4e6 | 730 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
d1cd355a SR |
731 | return next; |
732 | } | |
733 | EXPORT_SYMBOL(of_get_next_child); | |
1ef4d424 | 734 | |
3296193d TT |
735 | /** |
736 | * of_get_next_available_child - Find the next available child node | |
737 | * @node: parent node | |
738 | * @prev: previous child of the parent node, or NULL to get first | |
739 | * | |
740 | * This function is like of_get_next_child(), except that it | |
741 | * automatically skips any disabled nodes (i.e. status = "disabled"). | |
742 | */ | |
743 | struct device_node *of_get_next_available_child(const struct device_node *node, | |
744 | struct device_node *prev) | |
745 | { | |
746 | struct device_node *next; | |
d25d8694 | 747 | unsigned long flags; |
3296193d | 748 | |
d25d8694 | 749 | raw_spin_lock_irqsave(&devtree_lock, flags); |
3296193d TT |
750 | next = prev ? prev->sibling : node->child; |
751 | for (; next; next = next->sibling) { | |
c31a0c05 | 752 | if (!__of_device_is_available(next)) |
3296193d TT |
753 | continue; |
754 | if (of_node_get(next)) | |
755 | break; | |
756 | } | |
757 | of_node_put(prev); | |
d25d8694 | 758 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
3296193d TT |
759 | return next; |
760 | } | |
761 | EXPORT_SYMBOL(of_get_next_available_child); | |
762 | ||
9c19761a SK |
763 | /** |
764 | * of_get_child_by_name - Find the child node by name for a given parent | |
765 | * @node: parent node | |
766 | * @name: child name to look for. | |
767 | * | |
768 | * This function looks for child node for given matching name | |
769 | * | |
770 | * Returns a node pointer if found, with refcount incremented, use | |
771 | * of_node_put() on it when done. | |
772 | * Returns NULL if node is not found. | |
773 | */ | |
774 | struct device_node *of_get_child_by_name(const struct device_node *node, | |
775 | const char *name) | |
776 | { | |
777 | struct device_node *child; | |
778 | ||
779 | for_each_child_of_node(node, child) | |
780 | if (child->name && (of_node_cmp(child->name, name) == 0)) | |
781 | break; | |
782 | return child; | |
783 | } | |
784 | EXPORT_SYMBOL(of_get_child_by_name); | |
785 | ||
c22e650e GL |
786 | static struct device_node *__of_find_node_by_path(struct device_node *parent, |
787 | const char *path) | |
788 | { | |
789 | struct device_node *child; | |
790 | int len = strchrnul(path, '/') - path; | |
791 | ||
792 | if (!len) | |
793 | return NULL; | |
794 | ||
795 | __for_each_child_of_node(parent, child) { | |
796 | const char *name = strrchr(child->full_name, '/'); | |
797 | if (WARN(!name, "malformed device_node %s\n", child->full_name)) | |
798 | continue; | |
799 | name++; | |
800 | if (strncmp(path, name, len) == 0 && (strlen(name) == len)) | |
801 | return child; | |
802 | } | |
803 | return NULL; | |
804 | } | |
805 | ||
1ef4d424 SR |
806 | /** |
807 | * of_find_node_by_path - Find a node matching a full OF path | |
c22e650e GL |
808 | * @path: Either the full path to match, or if the path does not |
809 | * start with '/', the name of a property of the /aliases | |
810 | * node (an alias). In the case of an alias, the node | |
811 | * matching the alias' value will be returned. | |
812 | * | |
813 | * Valid paths: | |
814 | * /foo/bar Full path | |
815 | * foo Valid alias | |
816 | * foo/bar Valid alias + relative path | |
1ef4d424 SR |
817 | * |
818 | * Returns a node pointer with refcount incremented, use | |
819 | * of_node_put() on it when done. | |
820 | */ | |
821 | struct device_node *of_find_node_by_path(const char *path) | |
822 | { | |
c22e650e GL |
823 | struct device_node *np = NULL; |
824 | struct property *pp; | |
d6d3c4e6 | 825 | unsigned long flags; |
1ef4d424 | 826 | |
c22e650e GL |
827 | if (strcmp(path, "/") == 0) |
828 | return of_node_get(of_allnodes); | |
829 | ||
830 | /* The path could begin with an alias */ | |
831 | if (*path != '/') { | |
832 | char *p = strchrnul(path, '/'); | |
833 | int len = p - path; | |
834 | ||
835 | /* of_aliases must not be NULL */ | |
836 | if (!of_aliases) | |
837 | return NULL; | |
838 | ||
839 | for_each_property_of_node(of_aliases, pp) { | |
840 | if (strlen(pp->name) == len && !strncmp(pp->name, path, len)) { | |
841 | np = of_find_node_by_path(pp->value); | |
842 | break; | |
843 | } | |
844 | } | |
845 | if (!np) | |
846 | return NULL; | |
847 | path = p; | |
848 | } | |
849 | ||
850 | /* Step down the tree matching path components */ | |
d6d3c4e6 | 851 | raw_spin_lock_irqsave(&devtree_lock, flags); |
c22e650e GL |
852 | if (!np) |
853 | np = of_node_get(of_allnodes); | |
854 | while (np && *path == '/') { | |
855 | path++; /* Increment past '/' delimiter */ | |
856 | np = __of_find_node_by_path(np, path); | |
857 | path = strchrnul(path, '/'); | |
1ef4d424 | 858 | } |
d6d3c4e6 | 859 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
1ef4d424 SR |
860 | return np; |
861 | } | |
862 | EXPORT_SYMBOL(of_find_node_by_path); | |
863 | ||
864 | /** | |
865 | * of_find_node_by_name - Find a node by its "name" property | |
866 | * @from: The node to start searching from or NULL, the node | |
867 | * you pass will not be searched, only the next one | |
868 | * will; typically, you pass what the previous call | |
869 | * returned. of_node_put() will be called on it | |
870 | * @name: The name string to match against | |
871 | * | |
872 | * Returns a node pointer with refcount incremented, use | |
873 | * of_node_put() on it when done. | |
874 | */ | |
875 | struct device_node *of_find_node_by_name(struct device_node *from, | |
876 | const char *name) | |
877 | { | |
878 | struct device_node *np; | |
d6d3c4e6 | 879 | unsigned long flags; |
1ef4d424 | 880 | |
d6d3c4e6 | 881 | raw_spin_lock_irqsave(&devtree_lock, flags); |
465aac6d | 882 | np = from ? from->allnext : of_allnodes; |
1ef4d424 SR |
883 | for (; np; np = np->allnext) |
884 | if (np->name && (of_node_cmp(np->name, name) == 0) | |
885 | && of_node_get(np)) | |
886 | break; | |
887 | of_node_put(from); | |
d6d3c4e6 | 888 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
1ef4d424 SR |
889 | return np; |
890 | } | |
891 | EXPORT_SYMBOL(of_find_node_by_name); | |
892 | ||
893 | /** | |
894 | * of_find_node_by_type - Find a node by its "device_type" property | |
895 | * @from: The node to start searching from, or NULL to start searching | |
896 | * the entire device tree. The node you pass will not be | |
897 | * searched, only the next one will; typically, you pass | |
898 | * what the previous call returned. of_node_put() will be | |
899 | * called on from for you. | |
900 | * @type: The type string to match against | |
901 | * | |
902 | * Returns a node pointer with refcount incremented, use | |
903 | * of_node_put() on it when done. | |
904 | */ | |
905 | struct device_node *of_find_node_by_type(struct device_node *from, | |
906 | const char *type) | |
907 | { | |
908 | struct device_node *np; | |
d6d3c4e6 | 909 | unsigned long flags; |
1ef4d424 | 910 | |
d6d3c4e6 | 911 | raw_spin_lock_irqsave(&devtree_lock, flags); |
465aac6d | 912 | np = from ? from->allnext : of_allnodes; |
1ef4d424 SR |
913 | for (; np; np = np->allnext) |
914 | if (np->type && (of_node_cmp(np->type, type) == 0) | |
915 | && of_node_get(np)) | |
916 | break; | |
917 | of_node_put(from); | |
d6d3c4e6 | 918 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
1ef4d424 SR |
919 | return np; |
920 | } | |
921 | EXPORT_SYMBOL(of_find_node_by_type); | |
922 | ||
923 | /** | |
924 | * of_find_compatible_node - Find a node based on type and one of the | |
925 | * tokens in its "compatible" property | |
926 | * @from: The node to start searching from or NULL, the node | |
927 | * you pass will not be searched, only the next one | |
928 | * will; typically, you pass what the previous call | |
929 | * returned. of_node_put() will be called on it | |
930 | * @type: The type string to match "device_type" or NULL to ignore | |
931 | * @compatible: The string to match to one of the tokens in the device | |
932 | * "compatible" list. | |
933 | * | |
934 | * Returns a node pointer with refcount incremented, use | |
935 | * of_node_put() on it when done. | |
936 | */ | |
937 | struct device_node *of_find_compatible_node(struct device_node *from, | |
938 | const char *type, const char *compatible) | |
939 | { | |
940 | struct device_node *np; | |
d6d3c4e6 | 941 | unsigned long flags; |
1ef4d424 | 942 | |
d6d3c4e6 | 943 | raw_spin_lock_irqsave(&devtree_lock, flags); |
465aac6d | 944 | np = from ? from->allnext : of_allnodes; |
1ef4d424 | 945 | for (; np; np = np->allnext) { |
215a14cf | 946 | if (__of_device_is_compatible(np, compatible, type, NULL) && |
28d0e36b | 947 | of_node_get(np)) |
1ef4d424 SR |
948 | break; |
949 | } | |
950 | of_node_put(from); | |
d6d3c4e6 | 951 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
1ef4d424 SR |
952 | return np; |
953 | } | |
954 | EXPORT_SYMBOL(of_find_compatible_node); | |
283029d1 | 955 | |
1e291b14 ME |
956 | /** |
957 | * of_find_node_with_property - Find a node which has a property with | |
958 | * the given name. | |
959 | * @from: The node to start searching from or NULL, the node | |
960 | * you pass will not be searched, only the next one | |
961 | * will; typically, you pass what the previous call | |
962 | * returned. of_node_put() will be called on it | |
963 | * @prop_name: The name of the property to look for. | |
964 | * | |
965 | * Returns a node pointer with refcount incremented, use | |
966 | * of_node_put() on it when done. | |
967 | */ | |
968 | struct device_node *of_find_node_with_property(struct device_node *from, | |
969 | const char *prop_name) | |
970 | { | |
971 | struct device_node *np; | |
972 | struct property *pp; | |
d6d3c4e6 | 973 | unsigned long flags; |
1e291b14 | 974 | |
d6d3c4e6 | 975 | raw_spin_lock_irqsave(&devtree_lock, flags); |
465aac6d | 976 | np = from ? from->allnext : of_allnodes; |
1e291b14 | 977 | for (; np; np = np->allnext) { |
a3a7cab1 | 978 | for (pp = np->properties; pp; pp = pp->next) { |
1e291b14 ME |
979 | if (of_prop_cmp(pp->name, prop_name) == 0) { |
980 | of_node_get(np); | |
981 | goto out; | |
982 | } | |
983 | } | |
984 | } | |
985 | out: | |
986 | of_node_put(from); | |
d6d3c4e6 | 987 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
1e291b14 ME |
988 | return np; |
989 | } | |
990 | EXPORT_SYMBOL(of_find_node_with_property); | |
991 | ||
28d0e36b TG |
992 | static |
993 | const struct of_device_id *__of_match_node(const struct of_device_id *matches, | |
994 | const struct device_node *node) | |
283029d1 | 995 | { |
215a14cf KH |
996 | const struct of_device_id *best_match = NULL; |
997 | int score, best_score = 0; | |
998 | ||
a52f07ec GL |
999 | if (!matches) |
1000 | return NULL; | |
1001 | ||
215a14cf KH |
1002 | for (; matches->name[0] || matches->type[0] || matches->compatible[0]; matches++) { |
1003 | score = __of_device_is_compatible(node, matches->compatible, | |
1004 | matches->type, matches->name); | |
1005 | if (score > best_score) { | |
1006 | best_match = matches; | |
1007 | best_score = score; | |
1008 | } | |
4e8ca6ee | 1009 | } |
215a14cf KH |
1010 | |
1011 | return best_match; | |
283029d1 | 1012 | } |
28d0e36b TG |
1013 | |
1014 | /** | |
1015 | * of_match_node - Tell if an device_node has a matching of_match structure | |
1016 | * @matches: array of of device match structures to search in | |
1017 | * @node: the of device structure to match against | |
1018 | * | |
71c5498e | 1019 | * Low level utility function used by device matching. |
28d0e36b TG |
1020 | */ |
1021 | const struct of_device_id *of_match_node(const struct of_device_id *matches, | |
1022 | const struct device_node *node) | |
1023 | { | |
1024 | const struct of_device_id *match; | |
d6d3c4e6 | 1025 | unsigned long flags; |
28d0e36b | 1026 | |
d6d3c4e6 | 1027 | raw_spin_lock_irqsave(&devtree_lock, flags); |
28d0e36b | 1028 | match = __of_match_node(matches, node); |
d6d3c4e6 | 1029 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
28d0e36b TG |
1030 | return match; |
1031 | } | |
283029d1 GL |
1032 | EXPORT_SYMBOL(of_match_node); |
1033 | ||
1034 | /** | |
50c8af4c SW |
1035 | * of_find_matching_node_and_match - Find a node based on an of_device_id |
1036 | * match table. | |
283029d1 GL |
1037 | * @from: The node to start searching from or NULL, the node |
1038 | * you pass will not be searched, only the next one | |
1039 | * will; typically, you pass what the previous call | |
1040 | * returned. of_node_put() will be called on it | |
1041 | * @matches: array of of device match structures to search in | |
50c8af4c | 1042 | * @match Updated to point at the matches entry which matched |
283029d1 GL |
1043 | * |
1044 | * Returns a node pointer with refcount incremented, use | |
1045 | * of_node_put() on it when done. | |
1046 | */ | |
50c8af4c SW |
1047 | struct device_node *of_find_matching_node_and_match(struct device_node *from, |
1048 | const struct of_device_id *matches, | |
1049 | const struct of_device_id **match) | |
283029d1 GL |
1050 | { |
1051 | struct device_node *np; | |
dc71bcf1 | 1052 | const struct of_device_id *m; |
d6d3c4e6 | 1053 | unsigned long flags; |
283029d1 | 1054 | |
50c8af4c SW |
1055 | if (match) |
1056 | *match = NULL; | |
1057 | ||
d6d3c4e6 | 1058 | raw_spin_lock_irqsave(&devtree_lock, flags); |
465aac6d | 1059 | np = from ? from->allnext : of_allnodes; |
283029d1 | 1060 | for (; np; np = np->allnext) { |
28d0e36b | 1061 | m = __of_match_node(matches, np); |
dc71bcf1 | 1062 | if (m && of_node_get(np)) { |
50c8af4c | 1063 | if (match) |
dc71bcf1 | 1064 | *match = m; |
283029d1 | 1065 | break; |
50c8af4c | 1066 | } |
283029d1 GL |
1067 | } |
1068 | of_node_put(from); | |
d6d3c4e6 | 1069 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
283029d1 GL |
1070 | return np; |
1071 | } | |
80c2022e | 1072 | EXPORT_SYMBOL(of_find_matching_node_and_match); |
3f07af49 | 1073 | |
3f07af49 GL |
1074 | /** |
1075 | * of_modalias_node - Lookup appropriate modalias for a device node | |
1076 | * @node: pointer to a device tree node | |
1077 | * @modalias: Pointer to buffer that modalias value will be copied into | |
1078 | * @len: Length of modalias value | |
1079 | * | |
2ffe8c5f GL |
1080 | * Based on the value of the compatible property, this routine will attempt |
1081 | * to choose an appropriate modalias value for a particular device tree node. | |
1082 | * It does this by stripping the manufacturer prefix (as delimited by a ',') | |
1083 | * from the first entry in the compatible list property. | |
3f07af49 | 1084 | * |
2ffe8c5f | 1085 | * This routine returns 0 on success, <0 on failure. |
3f07af49 GL |
1086 | */ |
1087 | int of_modalias_node(struct device_node *node, char *modalias, int len) | |
1088 | { | |
2ffe8c5f GL |
1089 | const char *compatible, *p; |
1090 | int cplen; | |
3f07af49 GL |
1091 | |
1092 | compatible = of_get_property(node, "compatible", &cplen); | |
2ffe8c5f | 1093 | if (!compatible || strlen(compatible) > cplen) |
3f07af49 | 1094 | return -ENODEV; |
3f07af49 | 1095 | p = strchr(compatible, ','); |
2ffe8c5f | 1096 | strlcpy(modalias, p ? p + 1 : compatible, len); |
3f07af49 GL |
1097 | return 0; |
1098 | } | |
1099 | EXPORT_SYMBOL_GPL(of_modalias_node); | |
1100 | ||
89751a7c JK |
1101 | /** |
1102 | * of_find_node_by_phandle - Find a node given a phandle | |
1103 | * @handle: phandle of the node to find | |
1104 | * | |
1105 | * Returns a node pointer with refcount incremented, use | |
1106 | * of_node_put() on it when done. | |
1107 | */ | |
1108 | struct device_node *of_find_node_by_phandle(phandle handle) | |
1109 | { | |
1110 | struct device_node *np; | |
d25d8694 | 1111 | unsigned long flags; |
89751a7c | 1112 | |
d25d8694 | 1113 | raw_spin_lock_irqsave(&devtree_lock, flags); |
465aac6d | 1114 | for (np = of_allnodes; np; np = np->allnext) |
89751a7c JK |
1115 | if (np->phandle == handle) |
1116 | break; | |
1117 | of_node_get(np); | |
d25d8694 | 1118 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
89751a7c JK |
1119 | return np; |
1120 | } | |
1121 | EXPORT_SYMBOL(of_find_node_by_phandle); | |
1122 | ||
ad54a0cf HS |
1123 | /** |
1124 | * of_property_count_elems_of_size - Count the number of elements in a property | |
1125 | * | |
1126 | * @np: device node from which the property value is to be read. | |
1127 | * @propname: name of the property to be searched. | |
1128 | * @elem_size: size of the individual element | |
1129 | * | |
1130 | * Search for a property in a device node and count the number of elements of | |
1131 | * size elem_size in it. Returns number of elements on sucess, -EINVAL if the | |
1132 | * property does not exist or its length does not match a multiple of elem_size | |
1133 | * and -ENODATA if the property does not have a value. | |
1134 | */ | |
1135 | int of_property_count_elems_of_size(const struct device_node *np, | |
1136 | const char *propname, int elem_size) | |
1137 | { | |
1138 | struct property *prop = of_find_property(np, propname, NULL); | |
1139 | ||
1140 | if (!prop) | |
1141 | return -EINVAL; | |
1142 | if (!prop->value) | |
1143 | return -ENODATA; | |
1144 | ||
1145 | if (prop->length % elem_size != 0) { | |
1146 | pr_err("size of %s in node %s is not a multiple of %d\n", | |
1147 | propname, np->full_name, elem_size); | |
1148 | return -EINVAL; | |
1149 | } | |
1150 | ||
1151 | return prop->length / elem_size; | |
1152 | } | |
1153 | EXPORT_SYMBOL_GPL(of_property_count_elems_of_size); | |
1154 | ||
daeec1f0 TP |
1155 | /** |
1156 | * of_find_property_value_of_size | |
1157 | * | |
1158 | * @np: device node from which the property value is to be read. | |
1159 | * @propname: name of the property to be searched. | |
1160 | * @len: requested length of property value | |
1161 | * | |
1162 | * Search for a property in a device node and valid the requested size. | |
1163 | * Returns the property value on success, -EINVAL if the property does not | |
1164 | * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the | |
1165 | * property data isn't large enough. | |
1166 | * | |
1167 | */ | |
1168 | static void *of_find_property_value_of_size(const struct device_node *np, | |
1169 | const char *propname, u32 len) | |
1170 | { | |
1171 | struct property *prop = of_find_property(np, propname, NULL); | |
1172 | ||
1173 | if (!prop) | |
1174 | return ERR_PTR(-EINVAL); | |
1175 | if (!prop->value) | |
1176 | return ERR_PTR(-ENODATA); | |
1177 | if (len > prop->length) | |
1178 | return ERR_PTR(-EOVERFLOW); | |
1179 | ||
1180 | return prop->value; | |
1181 | } | |
1182 | ||
3daf3726 TP |
1183 | /** |
1184 | * of_property_read_u32_index - Find and read a u32 from a multi-value property. | |
1185 | * | |
1186 | * @np: device node from which the property value is to be read. | |
1187 | * @propname: name of the property to be searched. | |
1188 | * @index: index of the u32 in the list of values | |
1189 | * @out_value: pointer to return value, modified only if no error. | |
1190 | * | |
1191 | * Search for a property in a device node and read nth 32-bit value from | |
1192 | * it. Returns 0 on success, -EINVAL if the property does not exist, | |
1193 | * -ENODATA if property does not have a value, and -EOVERFLOW if the | |
1194 | * property data isn't large enough. | |
1195 | * | |
1196 | * The out_value is modified only if a valid u32 value can be decoded. | |
1197 | */ | |
1198 | int of_property_read_u32_index(const struct device_node *np, | |
1199 | const char *propname, | |
1200 | u32 index, u32 *out_value) | |
1201 | { | |
daeec1f0 TP |
1202 | const u32 *val = of_find_property_value_of_size(np, propname, |
1203 | ((index + 1) * sizeof(*out_value))); | |
3daf3726 | 1204 | |
daeec1f0 TP |
1205 | if (IS_ERR(val)) |
1206 | return PTR_ERR(val); | |
3daf3726 | 1207 | |
daeec1f0 | 1208 | *out_value = be32_to_cpup(((__be32 *)val) + index); |
3daf3726 TP |
1209 | return 0; |
1210 | } | |
1211 | EXPORT_SYMBOL_GPL(of_property_read_u32_index); | |
1212 | ||
be193249 VK |
1213 | /** |
1214 | * of_property_read_u8_array - Find and read an array of u8 from a property. | |
1215 | * | |
1216 | * @np: device node from which the property value is to be read. | |
1217 | * @propname: name of the property to be searched. | |
792efb84 | 1218 | * @out_values: pointer to return value, modified only if return value is 0. |
be193249 VK |
1219 | * @sz: number of array elements to read |
1220 | * | |
1221 | * Search for a property in a device node and read 8-bit value(s) from | |
1222 | * it. Returns 0 on success, -EINVAL if the property does not exist, | |
1223 | * -ENODATA if property does not have a value, and -EOVERFLOW if the | |
1224 | * property data isn't large enough. | |
1225 | * | |
1226 | * dts entry of array should be like: | |
1227 | * property = /bits/ 8 <0x50 0x60 0x70>; | |
1228 | * | |
792efb84 | 1229 | * The out_values is modified only if a valid u8 value can be decoded. |
be193249 VK |
1230 | */ |
1231 | int of_property_read_u8_array(const struct device_node *np, | |
1232 | const char *propname, u8 *out_values, size_t sz) | |
1233 | { | |
daeec1f0 TP |
1234 | const u8 *val = of_find_property_value_of_size(np, propname, |
1235 | (sz * sizeof(*out_values))); | |
be193249 | 1236 | |
daeec1f0 TP |
1237 | if (IS_ERR(val)) |
1238 | return PTR_ERR(val); | |
be193249 | 1239 | |
be193249 VK |
1240 | while (sz--) |
1241 | *out_values++ = *val++; | |
1242 | return 0; | |
1243 | } | |
1244 | EXPORT_SYMBOL_GPL(of_property_read_u8_array); | |
1245 | ||
1246 | /** | |
1247 | * of_property_read_u16_array - Find and read an array of u16 from a property. | |
1248 | * | |
1249 | * @np: device node from which the property value is to be read. | |
1250 | * @propname: name of the property to be searched. | |
792efb84 | 1251 | * @out_values: pointer to return value, modified only if return value is 0. |
be193249 VK |
1252 | * @sz: number of array elements to read |
1253 | * | |
1254 | * Search for a property in a device node and read 16-bit value(s) from | |
1255 | * it. Returns 0 on success, -EINVAL if the property does not exist, | |
1256 | * -ENODATA if property does not have a value, and -EOVERFLOW if the | |
1257 | * property data isn't large enough. | |
1258 | * | |
1259 | * dts entry of array should be like: | |
1260 | * property = /bits/ 16 <0x5000 0x6000 0x7000>; | |
1261 | * | |
792efb84 | 1262 | * The out_values is modified only if a valid u16 value can be decoded. |
be193249 VK |
1263 | */ |
1264 | int of_property_read_u16_array(const struct device_node *np, | |
1265 | const char *propname, u16 *out_values, size_t sz) | |
1266 | { | |
daeec1f0 TP |
1267 | const __be16 *val = of_find_property_value_of_size(np, propname, |
1268 | (sz * sizeof(*out_values))); | |
be193249 | 1269 | |
daeec1f0 TP |
1270 | if (IS_ERR(val)) |
1271 | return PTR_ERR(val); | |
be193249 | 1272 | |
be193249 VK |
1273 | while (sz--) |
1274 | *out_values++ = be16_to_cpup(val++); | |
1275 | return 0; | |
1276 | } | |
1277 | EXPORT_SYMBOL_GPL(of_property_read_u16_array); | |
1278 | ||
a3b85363 | 1279 | /** |
0e373639 RH |
1280 | * of_property_read_u32_array - Find and read an array of 32 bit integers |
1281 | * from a property. | |
1282 | * | |
a3b85363 TA |
1283 | * @np: device node from which the property value is to be read. |
1284 | * @propname: name of the property to be searched. | |
792efb84 | 1285 | * @out_values: pointer to return value, modified only if return value is 0. |
be193249 | 1286 | * @sz: number of array elements to read |
a3b85363 | 1287 | * |
0e373639 | 1288 | * Search for a property in a device node and read 32-bit value(s) from |
a3b85363 TA |
1289 | * it. Returns 0 on success, -EINVAL if the property does not exist, |
1290 | * -ENODATA if property does not have a value, and -EOVERFLOW if the | |
1291 | * property data isn't large enough. | |
1292 | * | |
792efb84 | 1293 | * The out_values is modified only if a valid u32 value can be decoded. |
a3b85363 | 1294 | */ |
aac285c6 JI |
1295 | int of_property_read_u32_array(const struct device_node *np, |
1296 | const char *propname, u32 *out_values, | |
1297 | size_t sz) | |
a3b85363 | 1298 | { |
daeec1f0 TP |
1299 | const __be32 *val = of_find_property_value_of_size(np, propname, |
1300 | (sz * sizeof(*out_values))); | |
a3b85363 | 1301 | |
daeec1f0 TP |
1302 | if (IS_ERR(val)) |
1303 | return PTR_ERR(val); | |
0e373639 | 1304 | |
0e373639 RH |
1305 | while (sz--) |
1306 | *out_values++ = be32_to_cpup(val++); | |
a3b85363 TA |
1307 | return 0; |
1308 | } | |
0e373639 | 1309 | EXPORT_SYMBOL_GPL(of_property_read_u32_array); |
a3b85363 | 1310 | |
4cd7f7a3 JI |
1311 | /** |
1312 | * of_property_read_u64 - Find and read a 64 bit integer from a property | |
1313 | * @np: device node from which the property value is to be read. | |
1314 | * @propname: name of the property to be searched. | |
1315 | * @out_value: pointer to return value, modified only if return value is 0. | |
1316 | * | |
1317 | * Search for a property in a device node and read a 64-bit value from | |
1318 | * it. Returns 0 on success, -EINVAL if the property does not exist, | |
1319 | * -ENODATA if property does not have a value, and -EOVERFLOW if the | |
1320 | * property data isn't large enough. | |
1321 | * | |
1322 | * The out_value is modified only if a valid u64 value can be decoded. | |
1323 | */ | |
1324 | int of_property_read_u64(const struct device_node *np, const char *propname, | |
1325 | u64 *out_value) | |
1326 | { | |
daeec1f0 TP |
1327 | const __be32 *val = of_find_property_value_of_size(np, propname, |
1328 | sizeof(*out_value)); | |
4cd7f7a3 | 1329 | |
daeec1f0 TP |
1330 | if (IS_ERR(val)) |
1331 | return PTR_ERR(val); | |
1332 | ||
1333 | *out_value = of_read_number(val, 2); | |
4cd7f7a3 JI |
1334 | return 0; |
1335 | } | |
1336 | EXPORT_SYMBOL_GPL(of_property_read_u64); | |
1337 | ||
a3b85363 TA |
1338 | /** |
1339 | * of_property_read_string - Find and read a string from a property | |
1340 | * @np: device node from which the property value is to be read. | |
1341 | * @propname: name of the property to be searched. | |
1342 | * @out_string: pointer to null terminated return string, modified only if | |
1343 | * return value is 0. | |
1344 | * | |
1345 | * Search for a property in a device tree node and retrieve a null | |
1346 | * terminated string value (pointer to data, not a copy). Returns 0 on | |
1347 | * success, -EINVAL if the property does not exist, -ENODATA if property | |
1348 | * does not have a value, and -EILSEQ if the string is not null-terminated | |
1349 | * within the length of the property data. | |
1350 | * | |
1351 | * The out_string pointer is modified only if a valid string can be decoded. | |
1352 | */ | |
aac285c6 | 1353 | int of_property_read_string(struct device_node *np, const char *propname, |
f09bc831 | 1354 | const char **out_string) |
a3b85363 TA |
1355 | { |
1356 | struct property *prop = of_find_property(np, propname, NULL); | |
1357 | if (!prop) | |
1358 | return -EINVAL; | |
1359 | if (!prop->value) | |
1360 | return -ENODATA; | |
1361 | if (strnlen(prop->value, prop->length) >= prop->length) | |
1362 | return -EILSEQ; | |
1363 | *out_string = prop->value; | |
1364 | return 0; | |
1365 | } | |
1366 | EXPORT_SYMBOL_GPL(of_property_read_string); | |
1367 | ||
4fcd15a0 BC |
1368 | /** |
1369 | * of_property_read_string_index - Find and read a string from a multiple | |
1370 | * strings property. | |
1371 | * @np: device node from which the property value is to be read. | |
1372 | * @propname: name of the property to be searched. | |
1373 | * @index: index of the string in the list of strings | |
1374 | * @out_string: pointer to null terminated return string, modified only if | |
1375 | * return value is 0. | |
1376 | * | |
1377 | * Search for a property in a device tree node and retrieve a null | |
1378 | * terminated string value (pointer to data, not a copy) in the list of strings | |
1379 | * contained in that property. | |
1380 | * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if | |
1381 | * property does not have a value, and -EILSEQ if the string is not | |
1382 | * null-terminated within the length of the property data. | |
1383 | * | |
1384 | * The out_string pointer is modified only if a valid string can be decoded. | |
1385 | */ | |
1386 | int of_property_read_string_index(struct device_node *np, const char *propname, | |
1387 | int index, const char **output) | |
1388 | { | |
1389 | struct property *prop = of_find_property(np, propname, NULL); | |
1390 | int i = 0; | |
1391 | size_t l = 0, total = 0; | |
1392 | const char *p; | |
1393 | ||
1394 | if (!prop) | |
1395 | return -EINVAL; | |
1396 | if (!prop->value) | |
1397 | return -ENODATA; | |
1398 | if (strnlen(prop->value, prop->length) >= prop->length) | |
1399 | return -EILSEQ; | |
1400 | ||
1401 | p = prop->value; | |
1402 | ||
1403 | for (i = 0; total < prop->length; total += l, p += l) { | |
1404 | l = strlen(p) + 1; | |
88af7f58 | 1405 | if (i++ == index) { |
4fcd15a0 BC |
1406 | *output = p; |
1407 | return 0; | |
1408 | } | |
1409 | } | |
1410 | return -ENODATA; | |
1411 | } | |
1412 | EXPORT_SYMBOL_GPL(of_property_read_string_index); | |
1413 | ||
7aff0fe3 GL |
1414 | /** |
1415 | * of_property_match_string() - Find string in a list and return index | |
1416 | * @np: pointer to node containing string list property | |
1417 | * @propname: string list property name | |
1418 | * @string: pointer to string to search for in string list | |
1419 | * | |
1420 | * This function searches a string list property and returns the index | |
1421 | * of a specific string value. | |
1422 | */ | |
1423 | int of_property_match_string(struct device_node *np, const char *propname, | |
1424 | const char *string) | |
1425 | { | |
1426 | struct property *prop = of_find_property(np, propname, NULL); | |
1427 | size_t l; | |
1428 | int i; | |
1429 | const char *p, *end; | |
1430 | ||
1431 | if (!prop) | |
1432 | return -EINVAL; | |
1433 | if (!prop->value) | |
1434 | return -ENODATA; | |
1435 | ||
1436 | p = prop->value; | |
1437 | end = p + prop->length; | |
1438 | ||
1439 | for (i = 0; p < end; i++, p += l) { | |
1440 | l = strlen(p) + 1; | |
1441 | if (p + l > end) | |
1442 | return -EILSEQ; | |
1443 | pr_debug("comparing %s with %s\n", string, p); | |
1444 | if (strcmp(string, p) == 0) | |
1445 | return i; /* Found it; return index */ | |
1446 | } | |
1447 | return -ENODATA; | |
1448 | } | |
1449 | EXPORT_SYMBOL_GPL(of_property_match_string); | |
4fcd15a0 BC |
1450 | |
1451 | /** | |
1452 | * of_property_count_strings - Find and return the number of strings from a | |
1453 | * multiple strings property. | |
1454 | * @np: device node from which the property value is to be read. | |
1455 | * @propname: name of the property to be searched. | |
1456 | * | |
1457 | * Search for a property in a device tree node and retrieve the number of null | |
1458 | * terminated string contain in it. Returns the number of strings on | |
1459 | * success, -EINVAL if the property does not exist, -ENODATA if property | |
1460 | * does not have a value, and -EILSEQ if the string is not null-terminated | |
1461 | * within the length of the property data. | |
1462 | */ | |
1463 | int of_property_count_strings(struct device_node *np, const char *propname) | |
1464 | { | |
1465 | struct property *prop = of_find_property(np, propname, NULL); | |
1466 | int i = 0; | |
1467 | size_t l = 0, total = 0; | |
1468 | const char *p; | |
1469 | ||
1470 | if (!prop) | |
1471 | return -EINVAL; | |
1472 | if (!prop->value) | |
1473 | return -ENODATA; | |
1474 | if (strnlen(prop->value, prop->length) >= prop->length) | |
1475 | return -EILSEQ; | |
1476 | ||
1477 | p = prop->value; | |
1478 | ||
88af7f58 | 1479 | for (i = 0; total < prop->length; total += l, p += l, i++) |
4fcd15a0 | 1480 | l = strlen(p) + 1; |
88af7f58 | 1481 | |
4fcd15a0 BC |
1482 | return i; |
1483 | } | |
1484 | EXPORT_SYMBOL_GPL(of_property_count_strings); | |
1485 | ||
624cfca5 GL |
1486 | void of_print_phandle_args(const char *msg, const struct of_phandle_args *args) |
1487 | { | |
1488 | int i; | |
1489 | printk("%s %s", msg, of_node_full_name(args->np)); | |
1490 | for (i = 0; i < args->args_count; i++) | |
1491 | printk(i ? ",%08x" : ":%08x", args->args[i]); | |
1492 | printk("\n"); | |
1493 | } | |
1494 | ||
bd69f73f GL |
1495 | static int __of_parse_phandle_with_args(const struct device_node *np, |
1496 | const char *list_name, | |
035fd948 SW |
1497 | const char *cells_name, |
1498 | int cell_count, int index, | |
bd69f73f | 1499 | struct of_phandle_args *out_args) |
64b60e09 | 1500 | { |
15c9a0ac | 1501 | const __be32 *list, *list_end; |
23ce04c0 | 1502 | int rc = 0, size, cur_index = 0; |
15c9a0ac | 1503 | uint32_t count = 0; |
64b60e09 | 1504 | struct device_node *node = NULL; |
15c9a0ac | 1505 | phandle phandle; |
64b60e09 | 1506 | |
15c9a0ac | 1507 | /* Retrieve the phandle list property */ |
64b60e09 | 1508 | list = of_get_property(np, list_name, &size); |
15c9a0ac | 1509 | if (!list) |
1af4c7f1 | 1510 | return -ENOENT; |
64b60e09 AV |
1511 | list_end = list + size / sizeof(*list); |
1512 | ||
15c9a0ac | 1513 | /* Loop over the phandles until all the requested entry is found */ |
64b60e09 | 1514 | while (list < list_end) { |
23ce04c0 | 1515 | rc = -EINVAL; |
15c9a0ac | 1516 | count = 0; |
64b60e09 | 1517 | |
15c9a0ac GL |
1518 | /* |
1519 | * If phandle is 0, then it is an empty entry with no | |
1520 | * arguments. Skip forward to the next entry. | |
1521 | */ | |
9a6b2e58 | 1522 | phandle = be32_to_cpup(list++); |
15c9a0ac GL |
1523 | if (phandle) { |
1524 | /* | |
1525 | * Find the provider node and parse the #*-cells | |
91d9942c SW |
1526 | * property to determine the argument length. |
1527 | * | |
1528 | * This is not needed if the cell count is hard-coded | |
1529 | * (i.e. cells_name not set, but cell_count is set), | |
1530 | * except when we're going to return the found node | |
1531 | * below. | |
15c9a0ac | 1532 | */ |
91d9942c SW |
1533 | if (cells_name || cur_index == index) { |
1534 | node = of_find_node_by_phandle(phandle); | |
1535 | if (!node) { | |
1536 | pr_err("%s: could not find phandle\n", | |
1537 | np->full_name); | |
1538 | goto err; | |
1539 | } | |
15c9a0ac | 1540 | } |
035fd948 SW |
1541 | |
1542 | if (cells_name) { | |
1543 | if (of_property_read_u32(node, cells_name, | |
1544 | &count)) { | |
1545 | pr_err("%s: could not get %s for %s\n", | |
1546 | np->full_name, cells_name, | |
1547 | node->full_name); | |
1548 | goto err; | |
1549 | } | |
1550 | } else { | |
1551 | count = cell_count; | |
15c9a0ac | 1552 | } |
64b60e09 | 1553 | |
15c9a0ac GL |
1554 | /* |
1555 | * Make sure that the arguments actually fit in the | |
1556 | * remaining property data length | |
1557 | */ | |
1558 | if (list + count > list_end) { | |
1559 | pr_err("%s: arguments longer than property\n", | |
1560 | np->full_name); | |
23ce04c0 | 1561 | goto err; |
15c9a0ac | 1562 | } |
64b60e09 AV |
1563 | } |
1564 | ||
15c9a0ac GL |
1565 | /* |
1566 | * All of the error cases above bail out of the loop, so at | |
1567 | * this point, the parsing is successful. If the requested | |
1568 | * index matches, then fill the out_args structure and return, | |
1569 | * or return -ENOENT for an empty entry. | |
1570 | */ | |
23ce04c0 | 1571 | rc = -ENOENT; |
15c9a0ac GL |
1572 | if (cur_index == index) { |
1573 | if (!phandle) | |
23ce04c0 | 1574 | goto err; |
15c9a0ac GL |
1575 | |
1576 | if (out_args) { | |
1577 | int i; | |
1578 | if (WARN_ON(count > MAX_PHANDLE_ARGS)) | |
1579 | count = MAX_PHANDLE_ARGS; | |
1580 | out_args->np = node; | |
1581 | out_args->args_count = count; | |
1582 | for (i = 0; i < count; i++) | |
1583 | out_args->args[i] = be32_to_cpup(list++); | |
b855f16b TY |
1584 | } else { |
1585 | of_node_put(node); | |
15c9a0ac | 1586 | } |
23ce04c0 GL |
1587 | |
1588 | /* Found it! return success */ | |
15c9a0ac | 1589 | return 0; |
64b60e09 | 1590 | } |
64b60e09 AV |
1591 | |
1592 | of_node_put(node); | |
1593 | node = NULL; | |
15c9a0ac | 1594 | list += count; |
64b60e09 AV |
1595 | cur_index++; |
1596 | } | |
1597 | ||
23ce04c0 GL |
1598 | /* |
1599 | * Unlock node before returning result; will be one of: | |
1600 | * -ENOENT : index is for empty phandle | |
1601 | * -EINVAL : parsing error on data | |
bd69f73f | 1602 | * [1..n] : Number of phandle (count mode; when index = -1) |
23ce04c0 | 1603 | */ |
bd69f73f | 1604 | rc = index < 0 ? cur_index : -ENOENT; |
23ce04c0 | 1605 | err: |
15c9a0ac GL |
1606 | if (node) |
1607 | of_node_put(node); | |
23ce04c0 | 1608 | return rc; |
64b60e09 | 1609 | } |
bd69f73f | 1610 | |
5fba49e3 SW |
1611 | /** |
1612 | * of_parse_phandle - Resolve a phandle property to a device_node pointer | |
1613 | * @np: Pointer to device node holding phandle property | |
1614 | * @phandle_name: Name of property holding a phandle value | |
1615 | * @index: For properties holding a table of phandles, this is the index into | |
1616 | * the table | |
1617 | * | |
1618 | * Returns the device_node pointer with refcount incremented. Use | |
1619 | * of_node_put() on it when done. | |
1620 | */ | |
1621 | struct device_node *of_parse_phandle(const struct device_node *np, | |
1622 | const char *phandle_name, int index) | |
1623 | { | |
91d9942c SW |
1624 | struct of_phandle_args args; |
1625 | ||
1626 | if (index < 0) | |
1627 | return NULL; | |
5fba49e3 | 1628 | |
91d9942c SW |
1629 | if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0, |
1630 | index, &args)) | |
5fba49e3 SW |
1631 | return NULL; |
1632 | ||
91d9942c | 1633 | return args.np; |
5fba49e3 SW |
1634 | } |
1635 | EXPORT_SYMBOL(of_parse_phandle); | |
1636 | ||
eded9dd4 SW |
1637 | /** |
1638 | * of_parse_phandle_with_args() - Find a node pointed by phandle in a list | |
1639 | * @np: pointer to a device tree node containing a list | |
1640 | * @list_name: property name that contains a list | |
1641 | * @cells_name: property name that specifies phandles' arguments count | |
1642 | * @index: index of a phandle to parse out | |
1643 | * @out_args: optional pointer to output arguments structure (will be filled) | |
1644 | * | |
1645 | * This function is useful to parse lists of phandles and their arguments. | |
1646 | * Returns 0 on success and fills out_args, on error returns appropriate | |
1647 | * errno value. | |
1648 | * | |
1649 | * Caller is responsible to call of_node_put() on the returned out_args->node | |
1650 | * pointer. | |
1651 | * | |
1652 | * Example: | |
1653 | * | |
1654 | * phandle1: node1 { | |
1655 | * #list-cells = <2>; | |
1656 | * } | |
1657 | * | |
1658 | * phandle2: node2 { | |
1659 | * #list-cells = <1>; | |
1660 | * } | |
1661 | * | |
1662 | * node3 { | |
1663 | * list = <&phandle1 1 2 &phandle2 3>; | |
1664 | * } | |
1665 | * | |
1666 | * To get a device_node of the `node2' node you may call this: | |
1667 | * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args); | |
1668 | */ | |
bd69f73f GL |
1669 | int of_parse_phandle_with_args(const struct device_node *np, const char *list_name, |
1670 | const char *cells_name, int index, | |
1671 | struct of_phandle_args *out_args) | |
1672 | { | |
1673 | if (index < 0) | |
1674 | return -EINVAL; | |
035fd948 SW |
1675 | return __of_parse_phandle_with_args(np, list_name, cells_name, 0, |
1676 | index, out_args); | |
bd69f73f | 1677 | } |
15c9a0ac | 1678 | EXPORT_SYMBOL(of_parse_phandle_with_args); |
02af11b0 | 1679 | |
035fd948 SW |
1680 | /** |
1681 | * of_parse_phandle_with_fixed_args() - Find a node pointed by phandle in a list | |
1682 | * @np: pointer to a device tree node containing a list | |
1683 | * @list_name: property name that contains a list | |
1684 | * @cell_count: number of argument cells following the phandle | |
1685 | * @index: index of a phandle to parse out | |
1686 | * @out_args: optional pointer to output arguments structure (will be filled) | |
1687 | * | |
1688 | * This function is useful to parse lists of phandles and their arguments. | |
1689 | * Returns 0 on success and fills out_args, on error returns appropriate | |
1690 | * errno value. | |
1691 | * | |
1692 | * Caller is responsible to call of_node_put() on the returned out_args->node | |
1693 | * pointer. | |
1694 | * | |
1695 | * Example: | |
1696 | * | |
1697 | * phandle1: node1 { | |
1698 | * } | |
1699 | * | |
1700 | * phandle2: node2 { | |
1701 | * } | |
1702 | * | |
1703 | * node3 { | |
1704 | * list = <&phandle1 0 2 &phandle2 2 3>; | |
1705 | * } | |
1706 | * | |
1707 | * To get a device_node of the `node2' node you may call this: | |
1708 | * of_parse_phandle_with_fixed_args(node3, "list", 2, 1, &args); | |
1709 | */ | |
1710 | int of_parse_phandle_with_fixed_args(const struct device_node *np, | |
1711 | const char *list_name, int cell_count, | |
1712 | int index, struct of_phandle_args *out_args) | |
1713 | { | |
1714 | if (index < 0) | |
1715 | return -EINVAL; | |
1716 | return __of_parse_phandle_with_args(np, list_name, NULL, cell_count, | |
1717 | index, out_args); | |
1718 | } | |
1719 | EXPORT_SYMBOL(of_parse_phandle_with_fixed_args); | |
1720 | ||
bd69f73f GL |
1721 | /** |
1722 | * of_count_phandle_with_args() - Find the number of phandles references in a property | |
1723 | * @np: pointer to a device tree node containing a list | |
1724 | * @list_name: property name that contains a list | |
1725 | * @cells_name: property name that specifies phandles' arguments count | |
1726 | * | |
1727 | * Returns the number of phandle + argument tuples within a property. It | |
1728 | * is a typical pattern to encode a list of phandle and variable | |
1729 | * arguments into a single property. The number of arguments is encoded | |
1730 | * by a property in the phandle-target node. For example, a gpios | |
1731 | * property would contain a list of GPIO specifies consisting of a | |
1732 | * phandle and 1 or more arguments. The number of arguments are | |
1733 | * determined by the #gpio-cells property in the node pointed to by the | |
1734 | * phandle. | |
1735 | */ | |
1736 | int of_count_phandle_with_args(const struct device_node *np, const char *list_name, | |
1737 | const char *cells_name) | |
1738 | { | |
035fd948 SW |
1739 | return __of_parse_phandle_with_args(np, list_name, cells_name, 0, -1, |
1740 | NULL); | |
bd69f73f GL |
1741 | } |
1742 | EXPORT_SYMBOL(of_count_phandle_with_args); | |
1743 | ||
1cf3d8b3 NF |
1744 | #if defined(CONFIG_OF_DYNAMIC) |
1745 | static int of_property_notify(int action, struct device_node *np, | |
1746 | struct property *prop) | |
1747 | { | |
1748 | struct of_prop_reconfig pr; | |
1749 | ||
0829f6d1 PA |
1750 | /* only call notifiers if the node is attached */ |
1751 | if (!of_node_is_attached(np)) | |
1752 | return 0; | |
1753 | ||
1cf3d8b3 NF |
1754 | pr.dn = np; |
1755 | pr.prop = prop; | |
1756 | return of_reconfig_notify(action, &pr); | |
1757 | } | |
1758 | #else | |
1759 | static int of_property_notify(int action, struct device_node *np, | |
1760 | struct property *prop) | |
1761 | { | |
1762 | return 0; | |
1763 | } | |
1764 | #endif | |
1765 | ||
62664f67 XL |
1766 | /** |
1767 | * __of_add_property - Add a property to a node without lock operations | |
1768 | */ | |
1769 | static int __of_add_property(struct device_node *np, struct property *prop) | |
1770 | { | |
1771 | struct property **next; | |
1772 | ||
1773 | prop->next = NULL; | |
1774 | next = &np->properties; | |
1775 | while (*next) { | |
1776 | if (strcmp(prop->name, (*next)->name) == 0) | |
1777 | /* duplicate ! don't insert it */ | |
1778 | return -EEXIST; | |
1779 | ||
1780 | next = &(*next)->next; | |
1781 | } | |
1782 | *next = prop; | |
1783 | ||
1784 | return 0; | |
1785 | } | |
1786 | ||
02af11b0 | 1787 | /** |
79d1c712 | 1788 | * of_add_property - Add a property to a node |
02af11b0 | 1789 | */ |
79d1c712 | 1790 | int of_add_property(struct device_node *np, struct property *prop) |
02af11b0 | 1791 | { |
02af11b0 | 1792 | unsigned long flags; |
1cf3d8b3 NF |
1793 | int rc; |
1794 | ||
1795 | rc = of_property_notify(OF_RECONFIG_ADD_PROPERTY, np, prop); | |
1796 | if (rc) | |
1797 | return rc; | |
02af11b0 | 1798 | |
d6d3c4e6 | 1799 | raw_spin_lock_irqsave(&devtree_lock, flags); |
62664f67 | 1800 | rc = __of_add_property(np, prop); |
d6d3c4e6 | 1801 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
75b57ecf GL |
1802 | if (rc) |
1803 | return rc; | |
02af11b0 | 1804 | |
0829f6d1 PA |
1805 | if (of_node_is_attached(np)) |
1806 | __of_add_property_sysfs(np, prop); | |
02af11b0 | 1807 | |
62664f67 | 1808 | return rc; |
02af11b0 GL |
1809 | } |
1810 | ||
1811 | /** | |
79d1c712 | 1812 | * of_remove_property - Remove a property from a node. |
02af11b0 GL |
1813 | * |
1814 | * Note that we don't actually remove it, since we have given out | |
1815 | * who-knows-how-many pointers to the data using get-property. | |
1816 | * Instead we just move the property to the "dead properties" | |
1817 | * list, so it won't be found any more. | |
1818 | */ | |
79d1c712 | 1819 | int of_remove_property(struct device_node *np, struct property *prop) |
02af11b0 GL |
1820 | { |
1821 | struct property **next; | |
1822 | unsigned long flags; | |
1823 | int found = 0; | |
1cf3d8b3 NF |
1824 | int rc; |
1825 | ||
1826 | rc = of_property_notify(OF_RECONFIG_REMOVE_PROPERTY, np, prop); | |
1827 | if (rc) | |
1828 | return rc; | |
02af11b0 | 1829 | |
d6d3c4e6 | 1830 | raw_spin_lock_irqsave(&devtree_lock, flags); |
02af11b0 GL |
1831 | next = &np->properties; |
1832 | while (*next) { | |
1833 | if (*next == prop) { | |
1834 | /* found the node */ | |
1835 | *next = prop->next; | |
1836 | prop->next = np->deadprops; | |
1837 | np->deadprops = prop; | |
1838 | found = 1; | |
1839 | break; | |
1840 | } | |
1841 | next = &(*next)->next; | |
1842 | } | |
d6d3c4e6 | 1843 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
02af11b0 GL |
1844 | |
1845 | if (!found) | |
1846 | return -ENODEV; | |
1847 | ||
75b57ecf GL |
1848 | /* at early boot, bail hear and defer setup to of_init() */ |
1849 | if (!of_kset) | |
1850 | return 0; | |
1851 | ||
1852 | sysfs_remove_bin_file(&np->kobj, &prop->attr); | |
02af11b0 GL |
1853 | |
1854 | return 0; | |
1855 | } | |
1856 | ||
1857 | /* | |
79d1c712 | 1858 | * of_update_property - Update a property in a node, if the property does |
475d0094 | 1859 | * not exist, add it. |
02af11b0 GL |
1860 | * |
1861 | * Note that we don't actually remove it, since we have given out | |
1862 | * who-knows-how-many pointers to the data using get-property. | |
1863 | * Instead we just move the property to the "dead properties" list, | |
1864 | * and add the new property to the property list | |
1865 | */ | |
79d1c712 | 1866 | int of_update_property(struct device_node *np, struct property *newprop) |
02af11b0 | 1867 | { |
475d0094 | 1868 | struct property **next, *oldprop; |
02af11b0 | 1869 | unsigned long flags; |
947fdaad | 1870 | int rc; |
1cf3d8b3 NF |
1871 | |
1872 | rc = of_property_notify(OF_RECONFIG_UPDATE_PROPERTY, np, newprop); | |
1873 | if (rc) | |
1874 | return rc; | |
02af11b0 | 1875 | |
475d0094 DA |
1876 | if (!newprop->name) |
1877 | return -EINVAL; | |
1878 | ||
d6d3c4e6 | 1879 | raw_spin_lock_irqsave(&devtree_lock, flags); |
02af11b0 | 1880 | next = &np->properties; |
947fdaad XL |
1881 | oldprop = __of_find_property(np, newprop->name, NULL); |
1882 | if (!oldprop) { | |
1883 | /* add the new node */ | |
1884 | rc = __of_add_property(np, newprop); | |
1885 | } else while (*next) { | |
1886 | /* replace the node */ | |
02af11b0 | 1887 | if (*next == oldprop) { |
02af11b0 GL |
1888 | newprop->next = oldprop->next; |
1889 | *next = newprop; | |
1890 | oldprop->next = np->deadprops; | |
1891 | np->deadprops = oldprop; | |
02af11b0 GL |
1892 | break; |
1893 | } | |
1894 | next = &(*next)->next; | |
1895 | } | |
d6d3c4e6 | 1896 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
947fdaad XL |
1897 | if (rc) |
1898 | return rc; | |
1899 | ||
1900 | /* At early boot, bail out and defer setup to of_init() */ | |
1901 | if (!of_kset) | |
1902 | return 0; | |
75b57ecf GL |
1903 | |
1904 | /* Update the sysfs attribute */ | |
947fdaad XL |
1905 | if (oldprop) |
1906 | sysfs_remove_bin_file(&np->kobj, &oldprop->attr); | |
75b57ecf | 1907 | __of_add_property_sysfs(np, newprop); |
02af11b0 | 1908 | |
02af11b0 GL |
1909 | return 0; |
1910 | } | |
fcdeb7fe GL |
1911 | |
1912 | #if defined(CONFIG_OF_DYNAMIC) | |
1913 | /* | |
1914 | * Support for dynamic device trees. | |
1915 | * | |
1916 | * On some platforms, the device tree can be manipulated at runtime. | |
1917 | * The routines in this section support adding, removing and changing | |
1918 | * device tree nodes. | |
1919 | */ | |
1920 | ||
1cf3d8b3 NF |
1921 | static BLOCKING_NOTIFIER_HEAD(of_reconfig_chain); |
1922 | ||
1923 | int of_reconfig_notifier_register(struct notifier_block *nb) | |
1924 | { | |
1925 | return blocking_notifier_chain_register(&of_reconfig_chain, nb); | |
1926 | } | |
1a9bd454 | 1927 | EXPORT_SYMBOL_GPL(of_reconfig_notifier_register); |
1cf3d8b3 NF |
1928 | |
1929 | int of_reconfig_notifier_unregister(struct notifier_block *nb) | |
1930 | { | |
1931 | return blocking_notifier_chain_unregister(&of_reconfig_chain, nb); | |
1932 | } | |
1a9bd454 | 1933 | EXPORT_SYMBOL_GPL(of_reconfig_notifier_unregister); |
1cf3d8b3 NF |
1934 | |
1935 | int of_reconfig_notify(unsigned long action, void *p) | |
1936 | { | |
1937 | int rc; | |
1938 | ||
1939 | rc = blocking_notifier_call_chain(&of_reconfig_chain, action, p); | |
1940 | return notifier_to_errno(rc); | |
1941 | } | |
1942 | ||
fcdeb7fe GL |
1943 | /** |
1944 | * of_attach_node - Plug a device node into the tree and global list. | |
1945 | */ | |
1cf3d8b3 | 1946 | int of_attach_node(struct device_node *np) |
fcdeb7fe GL |
1947 | { |
1948 | unsigned long flags; | |
1cf3d8b3 NF |
1949 | int rc; |
1950 | ||
1951 | rc = of_reconfig_notify(OF_RECONFIG_ATTACH_NODE, np); | |
1952 | if (rc) | |
1953 | return rc; | |
fcdeb7fe | 1954 | |
d6d3c4e6 | 1955 | raw_spin_lock_irqsave(&devtree_lock, flags); |
fcdeb7fe | 1956 | np->sibling = np->parent->child; |
465aac6d | 1957 | np->allnext = of_allnodes; |
fcdeb7fe | 1958 | np->parent->child = np; |
465aac6d | 1959 | of_allnodes = np; |
e3963fd6 | 1960 | of_node_clear_flag(np, OF_DETACHED); |
d6d3c4e6 | 1961 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
e81b3295 | 1962 | |
75b57ecf | 1963 | of_node_add(np); |
1cf3d8b3 | 1964 | return 0; |
fcdeb7fe GL |
1965 | } |
1966 | ||
1967 | /** | |
1968 | * of_detach_node - "Unplug" a node from the device tree. | |
1969 | * | |
1970 | * The caller must hold a reference to the node. The memory associated with | |
1971 | * the node is not freed until its refcount goes to zero. | |
1972 | */ | |
1cf3d8b3 | 1973 | int of_detach_node(struct device_node *np) |
fcdeb7fe GL |
1974 | { |
1975 | struct device_node *parent; | |
1976 | unsigned long flags; | |
1cf3d8b3 NF |
1977 | int rc = 0; |
1978 | ||
1979 | rc = of_reconfig_notify(OF_RECONFIG_DETACH_NODE, np); | |
1980 | if (rc) | |
1981 | return rc; | |
fcdeb7fe | 1982 | |
d6d3c4e6 | 1983 | raw_spin_lock_irqsave(&devtree_lock, flags); |
fcdeb7fe | 1984 | |
e81b3295 NF |
1985 | if (of_node_check_flag(np, OF_DETACHED)) { |
1986 | /* someone already detached it */ | |
d6d3c4e6 | 1987 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
1cf3d8b3 | 1988 | return rc; |
e81b3295 NF |
1989 | } |
1990 | ||
fcdeb7fe | 1991 | parent = np->parent; |
e81b3295 | 1992 | if (!parent) { |
d6d3c4e6 | 1993 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
1cf3d8b3 | 1994 | return rc; |
e81b3295 | 1995 | } |
fcdeb7fe | 1996 | |
465aac6d RD |
1997 | if (of_allnodes == np) |
1998 | of_allnodes = np->allnext; | |
fcdeb7fe GL |
1999 | else { |
2000 | struct device_node *prev; | |
465aac6d | 2001 | for (prev = of_allnodes; |
fcdeb7fe GL |
2002 | prev->allnext != np; |
2003 | prev = prev->allnext) | |
2004 | ; | |
2005 | prev->allnext = np->allnext; | |
2006 | } | |
2007 | ||
2008 | if (parent->child == np) | |
2009 | parent->child = np->sibling; | |
2010 | else { | |
2011 | struct device_node *prevsib; | |
2012 | for (prevsib = np->parent->child; | |
2013 | prevsib->sibling != np; | |
2014 | prevsib = prevsib->sibling) | |
2015 | ; | |
2016 | prevsib->sibling = np->sibling; | |
2017 | } | |
2018 | ||
2019 | of_node_set_flag(np, OF_DETACHED); | |
d6d3c4e6 | 2020 | raw_spin_unlock_irqrestore(&devtree_lock, flags); |
e81b3295 | 2021 | |
75b57ecf | 2022 | of_node_remove(np); |
1cf3d8b3 | 2023 | return rc; |
fcdeb7fe GL |
2024 | } |
2025 | #endif /* defined(CONFIG_OF_DYNAMIC) */ | |
2026 | ||
611cad72 SG |
2027 | static void of_alias_add(struct alias_prop *ap, struct device_node *np, |
2028 | int id, const char *stem, int stem_len) | |
2029 | { | |
2030 | ap->np = np; | |
2031 | ap->id = id; | |
2032 | strncpy(ap->stem, stem, stem_len); | |
2033 | ap->stem[stem_len] = 0; | |
2034 | list_add_tail(&ap->link, &aliases_lookup); | |
2035 | pr_debug("adding DT alias:%s: stem=%s id=%i node=%s\n", | |
74a7f084 | 2036 | ap->alias, ap->stem, ap->id, of_node_full_name(np)); |
611cad72 SG |
2037 | } |
2038 | ||
2039 | /** | |
2040 | * of_alias_scan - Scan all properties of 'aliases' node | |
2041 | * | |
2042 | * The function scans all the properties of 'aliases' node and populate | |
2043 | * the the global lookup table with the properties. It returns the | |
2044 | * number of alias_prop found, or error code in error case. | |
2045 | * | |
2046 | * @dt_alloc: An allocator that provides a virtual address to memory | |
2047 | * for the resulting tree | |
2048 | */ | |
2049 | void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)) | |
2050 | { | |
2051 | struct property *pp; | |
2052 | ||
2053 | of_chosen = of_find_node_by_path("/chosen"); | |
2054 | if (of_chosen == NULL) | |
2055 | of_chosen = of_find_node_by_path("/chosen@0"); | |
5c19e952 SH |
2056 | |
2057 | if (of_chosen) { | |
676e1b2f GL |
2058 | const char *name = of_get_property(of_chosen, "stdout-path", NULL); |
2059 | if (!name) | |
2060 | name = of_get_property(of_chosen, "linux,stdout-path", NULL); | |
5c19e952 SH |
2061 | if (name) |
2062 | of_stdout = of_find_node_by_path(name); | |
2063 | } | |
2064 | ||
611cad72 SG |
2065 | of_aliases = of_find_node_by_path("/aliases"); |
2066 | if (!of_aliases) | |
2067 | return; | |
2068 | ||
8af0da93 | 2069 | for_each_property_of_node(of_aliases, pp) { |
611cad72 SG |
2070 | const char *start = pp->name; |
2071 | const char *end = start + strlen(start); | |
2072 | struct device_node *np; | |
2073 | struct alias_prop *ap; | |
2074 | int id, len; | |
2075 | ||
2076 | /* Skip those we do not want to proceed */ | |
2077 | if (!strcmp(pp->name, "name") || | |
2078 | !strcmp(pp->name, "phandle") || | |
2079 | !strcmp(pp->name, "linux,phandle")) | |
2080 | continue; | |
2081 | ||
2082 | np = of_find_node_by_path(pp->value); | |
2083 | if (!np) | |
2084 | continue; | |
2085 | ||
2086 | /* walk the alias backwards to extract the id and work out | |
2087 | * the 'stem' string */ | |
2088 | while (isdigit(*(end-1)) && end > start) | |
2089 | end--; | |
2090 | len = end - start; | |
2091 | ||
2092 | if (kstrtoint(end, 10, &id) < 0) | |
2093 | continue; | |
2094 | ||
2095 | /* Allocate an alias_prop with enough space for the stem */ | |
2096 | ap = dt_alloc(sizeof(*ap) + len + 1, 4); | |
2097 | if (!ap) | |
2098 | continue; | |
0640332e | 2099 | memset(ap, 0, sizeof(*ap) + len + 1); |
611cad72 SG |
2100 | ap->alias = start; |
2101 | of_alias_add(ap, np, id, start, len); | |
2102 | } | |
2103 | } | |
2104 | ||
2105 | /** | |
2106 | * of_alias_get_id - Get alias id for the given device_node | |
2107 | * @np: Pointer to the given device_node | |
2108 | * @stem: Alias stem of the given device_node | |
2109 | * | |
2110 | * The function travels the lookup table to get alias id for the given | |
2111 | * device_node and alias stem. It returns the alias id if find it. | |
2112 | */ | |
2113 | int of_alias_get_id(struct device_node *np, const char *stem) | |
2114 | { | |
2115 | struct alias_prop *app; | |
2116 | int id = -ENODEV; | |
2117 | ||
2118 | mutex_lock(&of_aliases_mutex); | |
2119 | list_for_each_entry(app, &aliases_lookup, link) { | |
2120 | if (strcmp(app->stem, stem) != 0) | |
2121 | continue; | |
2122 | ||
2123 | if (np == app->np) { | |
2124 | id = app->id; | |
2125 | break; | |
2126 | } | |
2127 | } | |
2128 | mutex_unlock(&of_aliases_mutex); | |
2129 | ||
2130 | return id; | |
2131 | } | |
2132 | EXPORT_SYMBOL_GPL(of_alias_get_id); | |
c541adc6 SW |
2133 | |
2134 | const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, | |
2135 | u32 *pu) | |
2136 | { | |
2137 | const void *curv = cur; | |
2138 | ||
2139 | if (!prop) | |
2140 | return NULL; | |
2141 | ||
2142 | if (!cur) { | |
2143 | curv = prop->value; | |
2144 | goto out_val; | |
2145 | } | |
2146 | ||
2147 | curv += sizeof(*cur); | |
2148 | if (curv >= prop->value + prop->length) | |
2149 | return NULL; | |
2150 | ||
2151 | out_val: | |
2152 | *pu = be32_to_cpup(curv); | |
2153 | return curv; | |
2154 | } | |
2155 | EXPORT_SYMBOL_GPL(of_prop_next_u32); | |
2156 | ||
2157 | const char *of_prop_next_string(struct property *prop, const char *cur) | |
2158 | { | |
2159 | const void *curv = cur; | |
2160 | ||
2161 | if (!prop) | |
2162 | return NULL; | |
2163 | ||
2164 | if (!cur) | |
2165 | return prop->value; | |
2166 | ||
2167 | curv += strlen(cur) + 1; | |
2168 | if (curv >= prop->value + prop->length) | |
2169 | return NULL; | |
2170 | ||
2171 | return curv; | |
2172 | } | |
2173 | EXPORT_SYMBOL_GPL(of_prop_next_string); | |
5c19e952 SH |
2174 | |
2175 | /** | |
2176 | * of_device_is_stdout_path - check if a device node matches the | |
2177 | * linux,stdout-path property | |
2178 | * | |
2179 | * Check if this device node matches the linux,stdout-path property | |
2180 | * in the chosen node. return true if yes, false otherwise. | |
2181 | */ | |
2182 | int of_device_is_stdout_path(struct device_node *dn) | |
2183 | { | |
2184 | if (!of_stdout) | |
2185 | return false; | |
2186 | ||
2187 | return of_stdout == dn; | |
2188 | } | |
2189 | EXPORT_SYMBOL_GPL(of_device_is_stdout_path); | |
a3e31b45 SH |
2190 | |
2191 | /** | |
2192 | * of_find_next_cache_node - Find a node's subsidiary cache | |
2193 | * @np: node of type "cpu" or "cache" | |
2194 | * | |
2195 | * Returns a node pointer with refcount incremented, use | |
2196 | * of_node_put() on it when done. Caller should hold a reference | |
2197 | * to np. | |
2198 | */ | |
2199 | struct device_node *of_find_next_cache_node(const struct device_node *np) | |
2200 | { | |
2201 | struct device_node *child; | |
2202 | const phandle *handle; | |
2203 | ||
2204 | handle = of_get_property(np, "l2-cache", NULL); | |
2205 | if (!handle) | |
2206 | handle = of_get_property(np, "next-level-cache", NULL); | |
2207 | ||
2208 | if (handle) | |
2209 | return of_find_node_by_phandle(be32_to_cpup(handle)); | |
2210 | ||
2211 | /* OF on pmac has nodes instead of properties named "l2-cache" | |
2212 | * beneath CPU nodes. | |
2213 | */ | |
2214 | if (!strcmp(np->type, "cpu")) | |
2215 | for_each_child_of_node(np, child) | |
2216 | if (!strcmp(child->type, "cache")) | |
2217 | return child; | |
2218 | ||
2219 | return NULL; | |
2220 | } | |
fd9fdb78 | 2221 | |
f2a575f6 PZ |
2222 | /** |
2223 | * of_graph_parse_endpoint() - parse common endpoint node properties | |
2224 | * @node: pointer to endpoint device_node | |
2225 | * @endpoint: pointer to the OF endpoint data structure | |
2226 | * | |
2227 | * The caller should hold a reference to @node. | |
2228 | */ | |
2229 | int of_graph_parse_endpoint(const struct device_node *node, | |
2230 | struct of_endpoint *endpoint) | |
2231 | { | |
2232 | struct device_node *port_node = of_get_parent(node); | |
2233 | ||
d484700a PZ |
2234 | WARN_ONCE(!port_node, "%s(): endpoint %s has no parent node\n", |
2235 | __func__, node->full_name); | |
2236 | ||
f2a575f6 PZ |
2237 | memset(endpoint, 0, sizeof(*endpoint)); |
2238 | ||
2239 | endpoint->local_node = node; | |
2240 | /* | |
2241 | * It doesn't matter whether the two calls below succeed. | |
2242 | * If they don't then the default value 0 is used. | |
2243 | */ | |
2244 | of_property_read_u32(port_node, "reg", &endpoint->port); | |
2245 | of_property_read_u32(node, "reg", &endpoint->id); | |
2246 | ||
2247 | of_node_put(port_node); | |
2248 | ||
2249 | return 0; | |
2250 | } | |
2251 | EXPORT_SYMBOL(of_graph_parse_endpoint); | |
2252 | ||
fd9fdb78 PZ |
2253 | /** |
2254 | * of_graph_get_next_endpoint() - get next endpoint node | |
2255 | * @parent: pointer to the parent device node | |
2256 | * @prev: previous endpoint node, or NULL to get first | |
2257 | * | |
2258 | * Return: An 'endpoint' node pointer with refcount incremented. Refcount | |
2259 | * of the passed @prev node is not decremented, the caller have to use | |
2260 | * of_node_put() on it when done. | |
2261 | */ | |
2262 | struct device_node *of_graph_get_next_endpoint(const struct device_node *parent, | |
2263 | struct device_node *prev) | |
2264 | { | |
2265 | struct device_node *endpoint; | |
3c83e61e | 2266 | struct device_node *port; |
fd9fdb78 PZ |
2267 | |
2268 | if (!parent) | |
2269 | return NULL; | |
2270 | ||
3c83e61e LT |
2271 | /* |
2272 | * Start by locating the port node. If no previous endpoint is specified | |
2273 | * search for the first port node, otherwise get the previous endpoint | |
2274 | * parent port node. | |
2275 | */ | |
fd9fdb78 PZ |
2276 | if (!prev) { |
2277 | struct device_node *node; | |
3c83e61e | 2278 | |
fd9fdb78 PZ |
2279 | node = of_get_child_by_name(parent, "ports"); |
2280 | if (node) | |
2281 | parent = node; | |
2282 | ||
2283 | port = of_get_child_by_name(parent, "port"); | |
fd9fdb78 | 2284 | of_node_put(node); |
fd9fdb78 | 2285 | |
3c83e61e LT |
2286 | if (!port) { |
2287 | pr_err("%s(): no port node found in %s\n", | |
2288 | __func__, parent->full_name); | |
2289 | return NULL; | |
2290 | } | |
2291 | } else { | |
2292 | port = of_get_parent(prev); | |
2293 | if (WARN_ONCE(!port, "%s(): endpoint %s has no parent node\n", | |
2294 | __func__, prev->full_name)) | |
2295 | return NULL; | |
fd9fdb78 | 2296 | |
3c83e61e LT |
2297 | /* |
2298 | * Avoid dropping prev node refcount to 0 when getting the next | |
2299 | * child below. | |
2300 | */ | |
2301 | of_node_get(prev); | |
fd9fdb78 PZ |
2302 | } |
2303 | ||
3c83e61e LT |
2304 | while (1) { |
2305 | /* | |
2306 | * Now that we have a port node, get the next endpoint by | |
2307 | * getting the next child. If the previous endpoint is NULL this | |
2308 | * will return the first child. | |
2309 | */ | |
2310 | endpoint = of_get_next_child(port, prev); | |
2311 | if (endpoint) { | |
2312 | of_node_put(port); | |
2313 | return endpoint; | |
2314 | } | |
4329b93b | 2315 | |
3c83e61e LT |
2316 | /* No more endpoints under this port, try the next one. */ |
2317 | prev = NULL; | |
4329b93b | 2318 | |
3c83e61e LT |
2319 | do { |
2320 | port = of_get_next_child(parent, port); | |
2321 | if (!port) | |
2322 | return NULL; | |
2323 | } while (of_node_cmp(port->name, "port")); | |
2324 | } | |
fd9fdb78 PZ |
2325 | } |
2326 | EXPORT_SYMBOL(of_graph_get_next_endpoint); | |
2327 | ||
2328 | /** | |
2329 | * of_graph_get_remote_port_parent() - get remote port's parent node | |
2330 | * @node: pointer to a local endpoint device_node | |
2331 | * | |
2332 | * Return: Remote device node associated with remote endpoint node linked | |
2333 | * to @node. Use of_node_put() on it when done. | |
2334 | */ | |
2335 | struct device_node *of_graph_get_remote_port_parent( | |
2336 | const struct device_node *node) | |
2337 | { | |
2338 | struct device_node *np; | |
2339 | unsigned int depth; | |
2340 | ||
2341 | /* Get remote endpoint node. */ | |
2342 | np = of_parse_phandle(node, "remote-endpoint", 0); | |
2343 | ||
2344 | /* Walk 3 levels up only if there is 'ports' node. */ | |
2345 | for (depth = 3; depth && np; depth--) { | |
2346 | np = of_get_next_parent(np); | |
2347 | if (depth == 2 && of_node_cmp(np->name, "ports")) | |
2348 | break; | |
2349 | } | |
2350 | return np; | |
2351 | } | |
2352 | EXPORT_SYMBOL(of_graph_get_remote_port_parent); | |
2353 | ||
2354 | /** | |
2355 | * of_graph_get_remote_port() - get remote port node | |
2356 | * @node: pointer to a local endpoint device_node | |
2357 | * | |
2358 | * Return: Remote port node associated with remote endpoint node linked | |
2359 | * to @node. Use of_node_put() on it when done. | |
2360 | */ | |
2361 | struct device_node *of_graph_get_remote_port(const struct device_node *node) | |
2362 | { | |
2363 | struct device_node *np; | |
2364 | ||
2365 | /* Get remote endpoint node. */ | |
2366 | np = of_parse_phandle(node, "remote-endpoint", 0); | |
2367 | if (!np) | |
2368 | return NULL; | |
2369 | return of_get_next_parent(np); | |
2370 | } | |
2371 | EXPORT_SYMBOL(of_graph_get_remote_port); |