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