blob: b299de2b3afad1eb8a9832cf0fe74f2918797013 [file] [log] [blame]
Stephen Rothwell97e873e2007-05-01 16:26:07 +10001/*
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 *
Grant Likelye91edcf2009-10-15 10:58:09 -060012 * Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and
13 * Grant Likely.
Stephen Rothwell97e873e2007-05-01 16:26:07 +100014 *
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 */
Grant Likely3482f2c2014-03-27 17:18:55 -070020#include <linux/console.h>
Shawn Guo611cad72011-08-15 15:28:14 +080021#include <linux/ctype.h>
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +010022#include <linux/cpu.h>
Stephen Rothwell97e873e2007-05-01 16:26:07 +100023#include <linux/module.h>
24#include <linux/of.h>
Philipp Zabelfd9fdb72014-02-10 22:01:48 +010025#include <linux/of_graph.h>
Stephen Rothwell581b6052007-04-24 16:46:53 +100026#include <linux/spinlock.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/slab.h>
Grant Likely75b57ec2014-02-20 18:02:11 +000028#include <linux/string.h>
Jeremy Kerra9f2f632010-02-01 21:34:14 -070029#include <linux/proc_fs.h>
Stephen Rothwell581b6052007-04-24 16:46:53 +100030
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -080031#include "of_private.h"
Shawn Guo611cad72011-08-15 15:28:14 +080032
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -080033LIST_HEAD(aliases_lookup);
Shawn Guo611cad72011-08-15 15:28:14 +080034
Grant Likely5063e252014-10-03 16:28:27 +010035struct device_node *of_root;
36EXPORT_SYMBOL(of_root);
Grant Likelyfc0bdae2010-02-14 07:13:55 -070037struct device_node *of_chosen;
Shawn Guo611cad72011-08-15 15:28:14 +080038struct device_node *of_aliases;
Grant Likelya752ee52014-03-28 08:12:18 -070039struct device_node *of_stdout;
Leif Lindholm7914a7c2014-11-27 17:56:07 +000040static const char *of_stdout_options;
Shawn Guo611cad72011-08-15 15:28:14 +080041
Grant Likely8a2b22a2014-07-23 17:05:06 -060042struct kset *of_kset;
Grant Likely75b57ec2014-02-20 18:02:11 +000043
44/*
Grant Likely8a2b22a2014-07-23 17:05:06 -060045 * Used to protect the of_aliases, to hold off addition of nodes to sysfs.
46 * This mutex must be held whenever modifications are being made to the
47 * device tree. The of_{attach,detach}_node() and
48 * of_{add,remove,update}_property() helpers make sure this happens.
Grant Likely75b57ec2014-02-20 18:02:11 +000049 */
Pantelis Antoniouc05aba22014-07-04 19:58:03 +030050DEFINE_MUTEX(of_mutex);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +100051
Grant Likely5063e252014-10-03 16:28:27 +010052/* use when traversing tree through the child, sibling,
Stephen Rothwell581b6052007-04-24 16:46:53 +100053 * or parent members of struct device_node.
54 */
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -050055DEFINE_RAW_SPINLOCK(devtree_lock);
Stephen Rothwell97e873e2007-05-01 16:26:07 +100056
57int of_n_addr_cells(struct device_node *np)
58{
Jeremy Kerra9fadee2010-10-10 21:24:10 -060059 const __be32 *ip;
Stephen Rothwell97e873e2007-05-01 16:26:07 +100060
61 do {
62 if (np->parent)
63 np = np->parent;
64 ip = of_get_property(np, "#address-cells", NULL);
65 if (ip)
Jeremy Kerr33714882010-01-30 01:45:26 -070066 return be32_to_cpup(ip);
Stephen Rothwell97e873e2007-05-01 16:26:07 +100067 } while (np->parent);
68 /* No #address-cells property for the root node */
69 return OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
70}
71EXPORT_SYMBOL(of_n_addr_cells);
72
73int of_n_size_cells(struct device_node *np)
74{
Jeremy Kerra9fadee2010-10-10 21:24:10 -060075 const __be32 *ip;
Stephen Rothwell97e873e2007-05-01 16:26:07 +100076
77 do {
78 if (np->parent)
79 np = np->parent;
80 ip = of_get_property(np, "#size-cells", NULL);
81 if (ip)
Jeremy Kerr33714882010-01-30 01:45:26 -070082 return be32_to_cpup(ip);
Stephen Rothwell97e873e2007-05-01 16:26:07 +100083 } while (np->parent);
84 /* No #size-cells property for the root node */
85 return OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
86}
87EXPORT_SYMBOL(of_n_size_cells);
88
Rob Herring0c3f0612013-09-17 10:42:50 -050089#ifdef CONFIG_NUMA
90int __weak of_node_to_nid(struct device_node *np)
91{
Konstantin Khlebnikovc8fff7b2015-04-08 19:59:20 +030092 return NUMA_NO_NODE;
Rob Herring0c3f0612013-09-17 10:42:50 -050093}
94#endif
95
Grant Likely6afc0dc2014-06-26 15:40:48 +010096#ifndef CONFIG_OF_DYNAMIC
Grant Likely75b57ec2014-02-20 18:02:11 +000097static void of_node_release(struct kobject *kobj)
98{
99 /* Without CONFIG_OF_DYNAMIC, no nodes gets freed */
100}
Grant Likely0f22dd32012-02-15 20:38:40 -0700101#endif /* CONFIG_OF_DYNAMIC */
Grant Likely923f7e32010-01-28 13:52:53 -0700102
Grant Likely75b57ec2014-02-20 18:02:11 +0000103struct kobj_type of_node_ktype = {
104 .release = of_node_release,
105};
106
107static ssize_t of_node_property_read(struct file *filp, struct kobject *kobj,
108 struct bin_attribute *bin_attr, char *buf,
109 loff_t offset, size_t count)
110{
111 struct property *pp = container_of(bin_attr, struct property, attr);
112 return memory_read_from_buffer(buf, count, &offset, pp->value, pp->length);
113}
114
115static const char *safe_name(struct kobject *kobj, const char *orig_name)
116{
117 const char *name = orig_name;
118 struct kernfs_node *kn;
119 int i = 0;
120
121 /* don't be a hero. After 16 tries give up */
122 while (i < 16 && (kn = sysfs_get_dirent(kobj->sd, name))) {
123 sysfs_put(kn);
124 if (name != orig_name)
125 kfree(name);
126 name = kasprintf(GFP_KERNEL, "%s#%i", orig_name, ++i);
127 }
128
129 if (name != orig_name)
130 pr_warn("device-tree: Duplicate name in %s, renamed to \"%s\"\n",
131 kobject_name(kobj), name);
132 return name;
133}
134
Grant Likely8a2b22a2014-07-23 17:05:06 -0600135int __of_add_property_sysfs(struct device_node *np, struct property *pp)
Grant Likely75b57ec2014-02-20 18:02:11 +0000136{
137 int rc;
138
139 /* Important: Don't leak passwords */
140 bool secure = strncmp(pp->name, "security-", 9) == 0;
141
Gaurav Minochaef69d742014-09-05 09:56:13 -0700142 if (!IS_ENABLED(CONFIG_SYSFS))
143 return 0;
144
Grant Likely8a2b22a2014-07-23 17:05:06 -0600145 if (!of_kset || !of_node_is_attached(np))
146 return 0;
147
Grant Likely75b57ec2014-02-20 18:02:11 +0000148 sysfs_bin_attr_init(&pp->attr);
149 pp->attr.attr.name = safe_name(&np->kobj, pp->name);
150 pp->attr.attr.mode = secure ? S_IRUSR : S_IRUGO;
151 pp->attr.size = secure ? 0 : pp->length;
152 pp->attr.read = of_node_property_read;
153
154 rc = sysfs_create_bin_file(&np->kobj, &pp->attr);
155 WARN(rc, "error adding attribute %s to node %s\n", pp->name, np->full_name);
156 return rc;
157}
158
Grant Likely8a2b22a2014-07-23 17:05:06 -0600159int __of_attach_node_sysfs(struct device_node *np)
Grant Likely75b57ec2014-02-20 18:02:11 +0000160{
161 const char *name;
162 struct property *pp;
163 int rc;
164
Gaurav Minochaef69d742014-09-05 09:56:13 -0700165 if (!IS_ENABLED(CONFIG_SYSFS))
166 return 0;
167
Grant Likely8a2b22a2014-07-23 17:05:06 -0600168 if (!of_kset)
169 return 0;
170
Grant Likely75b57ec2014-02-20 18:02:11 +0000171 np->kobj.kset = of_kset;
172 if (!np->parent) {
173 /* Nodes without parents are new top level trees */
Kees Cook28d3ee42014-06-10 09:57:00 -0700174 rc = kobject_add(&np->kobj, NULL, "%s",
175 safe_name(&of_kset->kobj, "base"));
Grant Likely75b57ec2014-02-20 18:02:11 +0000176 } else {
177 name = safe_name(&np->parent->kobj, kbasename(np->full_name));
178 if (!name || !name[0])
179 return -EINVAL;
180
181 rc = kobject_add(&np->kobj, &np->parent->kobj, "%s", name);
182 }
183 if (rc)
184 return rc;
185
186 for_each_property_of_node(np, pp)
187 __of_add_property_sysfs(np, pp);
188
189 return 0;
190}
191
Sudeep Holla194ec932015-05-14 15:28:24 +0100192void __init of_core_init(void)
Grant Likely75b57ec2014-02-20 18:02:11 +0000193{
194 struct device_node *np;
195
196 /* Create the kset, and register existing nodes */
Pantelis Antoniouc05aba22014-07-04 19:58:03 +0300197 mutex_lock(&of_mutex);
Grant Likely75b57ec2014-02-20 18:02:11 +0000198 of_kset = kset_create_and_add("devicetree", NULL, firmware_kobj);
199 if (!of_kset) {
Pantelis Antoniouc05aba22014-07-04 19:58:03 +0300200 mutex_unlock(&of_mutex);
Sudeep Holla194ec932015-05-14 15:28:24 +0100201 pr_err("devicetree: failed to register existing nodes\n");
202 return;
Grant Likely75b57ec2014-02-20 18:02:11 +0000203 }
204 for_each_of_allnodes(np)
Grant Likely8a2b22a2014-07-23 17:05:06 -0600205 __of_attach_node_sysfs(np);
Pantelis Antoniouc05aba22014-07-04 19:58:03 +0300206 mutex_unlock(&of_mutex);
Grant Likely75b57ec2014-02-20 18:02:11 +0000207
Grant Likely83570412012-11-06 21:03:27 +0000208 /* Symlink in /proc as required by userspace ABI */
Grant Likely5063e252014-10-03 16:28:27 +0100209 if (of_root)
Grant Likely75b57ec2014-02-20 18:02:11 +0000210 proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
Grant Likely75b57ec2014-02-20 18:02:11 +0000211}
Grant Likely75b57ec2014-02-20 18:02:11 +0000212
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500213static struct property *__of_find_property(const struct device_node *np,
214 const char *name, int *lenp)
Stephen Rothwell581b6052007-04-24 16:46:53 +1000215{
216 struct property *pp;
217
Timur Tabi64e45662008-05-08 05:19:59 +1000218 if (!np)
219 return NULL;
220
Sachin Kamata3a7cab2012-06-27 09:44:45 +0530221 for (pp = np->properties; pp; pp = pp->next) {
Stephen Rothwell581b6052007-04-24 16:46:53 +1000222 if (of_prop_cmp(pp->name, name) == 0) {
Sachin Kamata3a7cab2012-06-27 09:44:45 +0530223 if (lenp)
Stephen Rothwell581b6052007-04-24 16:46:53 +1000224 *lenp = pp->length;
225 break;
226 }
227 }
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500228
229 return pp;
230}
231
232struct property *of_find_property(const struct device_node *np,
233 const char *name,
234 int *lenp)
235{
236 struct property *pp;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500237 unsigned long flags;
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500238
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500239 raw_spin_lock_irqsave(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500240 pp = __of_find_property(np, name, lenp);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500241 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell581b6052007-04-24 16:46:53 +1000242
243 return pp;
244}
245EXPORT_SYMBOL(of_find_property);
246
Grant Likely5063e252014-10-03 16:28:27 +0100247struct device_node *__of_find_all_nodes(struct device_node *prev)
248{
249 struct device_node *np;
250 if (!prev) {
251 np = of_root;
252 } else if (prev->child) {
253 np = prev->child;
254 } else {
255 /* Walk back up looking for a sibling, or the end of the structure */
256 np = prev;
257 while (np->parent && !np->sibling)
258 np = np->parent;
259 np = np->sibling; /* Might be null at the end of the tree */
260 }
261 return np;
262}
263
Grant Likelye91edcf2009-10-15 10:58:09 -0600264/**
265 * of_find_all_nodes - Get next node in global list
266 * @prev: Previous node or NULL to start iteration
267 * of_node_put() will be called on it
268 *
269 * Returns a node pointer with refcount incremented, use
270 * of_node_put() on it when done.
271 */
272struct device_node *of_find_all_nodes(struct device_node *prev)
273{
274 struct device_node *np;
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000275 unsigned long flags;
Grant Likelye91edcf2009-10-15 10:58:09 -0600276
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000277 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely5063e252014-10-03 16:28:27 +0100278 np = __of_find_all_nodes(prev);
279 of_node_get(np);
Grant Likelye91edcf2009-10-15 10:58:09 -0600280 of_node_put(prev);
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000281 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likelye91edcf2009-10-15 10:58:09 -0600282 return np;
283}
284EXPORT_SYMBOL(of_find_all_nodes);
285
Stephen Rothwell97e873e2007-05-01 16:26:07 +1000286/*
287 * Find a property with a given name for a given node
288 * and return the value.
289 */
Grant Likelya25095d2014-07-15 23:25:43 -0600290const void *__of_get_property(const struct device_node *np,
291 const char *name, int *lenp)
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500292{
293 struct property *pp = __of_find_property(np, name, lenp);
294
295 return pp ? pp->value : NULL;
296}
297
298/*
299 * Find a property with a given name for a given node
300 * and return the value.
301 */
Stephen Rothwell97e873e2007-05-01 16:26:07 +1000302const void *of_get_property(const struct device_node *np, const char *name,
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500303 int *lenp)
Stephen Rothwell97e873e2007-05-01 16:26:07 +1000304{
305 struct property *pp = of_find_property(np, name, lenp);
306
307 return pp ? pp->value : NULL;
308}
309EXPORT_SYMBOL(of_get_property);
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000310
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100311/*
312 * arch_match_cpu_phys_id - Match the given logical CPU and physical id
313 *
314 * @cpu: logical cpu index of a core/thread
315 * @phys_id: physical identifier of a core/thread
316 *
317 * CPU logical to physical index mapping is architecture specific.
318 * However this __weak function provides a default match of physical
319 * id to logical cpu index. phys_id provided here is usually values read
320 * from the device tree which must match the hardware internal registers.
321 *
322 * Returns true if the physical identifier and the logical cpu index
323 * correspond to the same core/thread, false otherwise.
324 */
325bool __weak arch_match_cpu_phys_id(int cpu, u64 phys_id)
326{
327 return (u32)phys_id == cpu;
328}
329
330/**
331 * Checks if the given "prop_name" property holds the physical id of the
332 * core/thread corresponding to the logical cpu 'cpu'. If 'thread' is not
333 * NULL, local thread number within the core is returned in it.
334 */
335static bool __of_find_n_match_cpu_property(struct device_node *cpun,
336 const char *prop_name, int cpu, unsigned int *thread)
337{
338 const __be32 *cell;
339 int ac, prop_len, tid;
340 u64 hwid;
341
342 ac = of_n_addr_cells(cpun);
343 cell = of_get_property(cpun, prop_name, &prop_len);
Grant Likelyf3cea452013-10-04 17:24:26 +0100344 if (!cell || !ac)
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100345 return false;
Grant Likelyf3cea452013-10-04 17:24:26 +0100346 prop_len /= sizeof(*cell) * ac;
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100347 for (tid = 0; tid < prop_len; tid++) {
348 hwid = of_read_number(cell, ac);
349 if (arch_match_cpu_phys_id(cpu, hwid)) {
350 if (thread)
351 *thread = tid;
352 return true;
353 }
354 cell += ac;
355 }
356 return false;
357}
358
David Millerd1cb9d12013-10-03 17:24:51 -0400359/*
360 * arch_find_n_match_cpu_physical_id - See if the given device node is
361 * for the cpu corresponding to logical cpu 'cpu'. Return true if so,
362 * else false. If 'thread' is non-NULL, the local thread number within the
363 * core is returned in it.
364 */
365bool __weak arch_find_n_match_cpu_physical_id(struct device_node *cpun,
366 int cpu, unsigned int *thread)
367{
368 /* Check for non-standard "ibm,ppc-interrupt-server#s" property
369 * for thread ids on PowerPC. If it doesn't exist fallback to
370 * standard "reg" property.
371 */
372 if (IS_ENABLED(CONFIG_PPC) &&
373 __of_find_n_match_cpu_property(cpun,
374 "ibm,ppc-interrupt-server#s",
375 cpu, thread))
376 return true;
377
Masahiro Yamada510bd062015-10-28 12:05:27 +0900378 return __of_find_n_match_cpu_property(cpun, "reg", cpu, thread);
David Millerd1cb9d12013-10-03 17:24:51 -0400379}
380
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100381/**
382 * of_get_cpu_node - Get device node associated with the given logical CPU
383 *
384 * @cpu: CPU number(logical index) for which device node is required
385 * @thread: if not NULL, local thread number within the physical core is
386 * returned
387 *
388 * The main purpose of this function is to retrieve the device node for the
389 * given logical CPU index. It should be used to initialize the of_node in
390 * cpu device. Once of_node in cpu device is populated, all the further
391 * references can use that instead.
392 *
393 * CPU logical to physical index mapping is architecture specific and is built
394 * before booting secondary cores. This function uses arch_match_cpu_phys_id
395 * which can be overridden by architecture specific implementation.
396 *
397 * Returns a node pointer for the logical cpu if found, else NULL.
398 */
399struct device_node *of_get_cpu_node(int cpu, unsigned int *thread)
400{
David Millerd1cb9d12013-10-03 17:24:51 -0400401 struct device_node *cpun;
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100402
David Millerd1cb9d12013-10-03 17:24:51 -0400403 for_each_node_by_type(cpun, "cpu") {
404 if (arch_find_n_match_cpu_physical_id(cpun, cpu, thread))
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100405 return cpun;
406 }
407 return NULL;
408}
409EXPORT_SYMBOL(of_get_cpu_node);
410
Kevin Hao215a14c2014-02-19 16:15:45 +0800411/**
412 * __of_device_is_compatible() - Check if the node matches given constraints
413 * @device: pointer to node
414 * @compat: required compatible string, NULL or "" for any match
415 * @type: required device_type value, NULL or "" for any match
416 * @name: required node name, NULL or "" for any match
417 *
418 * Checks if the given @compat, @type and @name strings match the
419 * properties of the given @device. A constraints can be skipped by
420 * passing NULL or an empty string as the constraint.
421 *
422 * Returns 0 for no match, and a positive integer on match. The return
423 * value is a relative score with larger values indicating better
424 * matches. The score is weighted for the most specific compatible value
425 * to get the highest score. Matching type is next, followed by matching
426 * name. Practically speaking, this results in the following priority
427 * order for matches:
428 *
429 * 1. specific compatible && type && name
430 * 2. specific compatible && type
431 * 3. specific compatible && name
432 * 4. specific compatible
433 * 5. general compatible && type && name
434 * 6. general compatible && type
435 * 7. general compatible && name
436 * 8. general compatible
437 * 9. type && name
438 * 10. type
439 * 11. name
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000440 */
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500441static int __of_device_is_compatible(const struct device_node *device,
Kevin Hao215a14c2014-02-19 16:15:45 +0800442 const char *compat, const char *type, const char *name)
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000443{
Kevin Hao215a14c2014-02-19 16:15:45 +0800444 struct property *prop;
445 const char *cp;
446 int index = 0, score = 0;
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000447
Kevin Hao215a14c2014-02-19 16:15:45 +0800448 /* Compatible match has highest priority */
449 if (compat && compat[0]) {
450 prop = __of_find_property(device, "compatible", NULL);
451 for (cp = of_prop_next_string(prop, NULL); cp;
452 cp = of_prop_next_string(prop, cp), index++) {
453 if (of_compat_cmp(cp, compat, strlen(compat)) == 0) {
454 score = INT_MAX/2 - (index << 2);
455 break;
456 }
457 }
458 if (!score)
459 return 0;
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000460 }
461
Kevin Hao215a14c2014-02-19 16:15:45 +0800462 /* Matching type is better than matching name */
463 if (type && type[0]) {
464 if (!device->type || of_node_cmp(type, device->type))
465 return 0;
466 score += 2;
467 }
468
469 /* Matching name is a bit better than not */
470 if (name && name[0]) {
471 if (!device->name || of_node_cmp(name, device->name))
472 return 0;
473 score++;
474 }
475
476 return score;
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000477}
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500478
479/** Checks if the given "compat" string matches one of the strings in
480 * the device's "compatible" property
481 */
482int of_device_is_compatible(const struct device_node *device,
483 const char *compat)
484{
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500485 unsigned long flags;
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500486 int res;
487
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500488 raw_spin_lock_irqsave(&devtree_lock, flags);
Kevin Hao215a14c2014-02-19 16:15:45 +0800489 res = __of_device_is_compatible(device, compat, NULL, NULL);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500490 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500491 return res;
492}
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000493EXPORT_SYMBOL(of_device_is_compatible);
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000494
495/**
Grant Likely71a157e2010-02-01 21:34:14 -0700496 * of_machine_is_compatible - Test root of device tree for a given compatible value
Grant Likely1f43cfb2010-01-28 13:47:25 -0700497 * @compat: compatible string to look for in root node's compatible property.
498 *
Kevin Cernekee25c7a1d2014-11-12 12:54:00 -0800499 * Returns a positive integer if the root node has the given value in its
Grant Likely1f43cfb2010-01-28 13:47:25 -0700500 * compatible property.
501 */
Grant Likely71a157e2010-02-01 21:34:14 -0700502int of_machine_is_compatible(const char *compat)
Grant Likely1f43cfb2010-01-28 13:47:25 -0700503{
504 struct device_node *root;
505 int rc = 0;
506
507 root = of_find_node_by_path("/");
508 if (root) {
509 rc = of_device_is_compatible(root, compat);
510 of_node_put(root);
511 }
512 return rc;
513}
Grant Likely71a157e2010-02-01 21:34:14 -0700514EXPORT_SYMBOL(of_machine_is_compatible);
Grant Likely1f43cfb2010-01-28 13:47:25 -0700515
516/**
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700517 * __of_device_is_available - check if a device is available for use
Josh Boyer834d97d2008-03-27 00:33:14 +1100518 *
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700519 * @device: Node to check for availability, with locks already held
Josh Boyer834d97d2008-03-27 00:33:14 +1100520 *
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800521 * Returns true if the status property is absent or set to "okay" or "ok",
522 * false otherwise
Josh Boyer834d97d2008-03-27 00:33:14 +1100523 */
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800524static bool __of_device_is_available(const struct device_node *device)
Josh Boyer834d97d2008-03-27 00:33:14 +1100525{
526 const char *status;
527 int statlen;
528
Xiubo Li42ccd782014-01-13 11:07:28 +0800529 if (!device)
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800530 return false;
Xiubo Li42ccd782014-01-13 11:07:28 +0800531
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700532 status = __of_get_property(device, "status", &statlen);
Josh Boyer834d97d2008-03-27 00:33:14 +1100533 if (status == NULL)
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800534 return true;
Josh Boyer834d97d2008-03-27 00:33:14 +1100535
536 if (statlen > 0) {
537 if (!strcmp(status, "okay") || !strcmp(status, "ok"))
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800538 return true;
Josh Boyer834d97d2008-03-27 00:33:14 +1100539 }
540
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800541 return false;
Josh Boyer834d97d2008-03-27 00:33:14 +1100542}
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700543
544/**
545 * of_device_is_available - check if a device is available for use
546 *
547 * @device: Node to check for availability
548 *
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800549 * Returns true if the status property is absent or set to "okay" or "ok",
550 * false otherwise
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700551 */
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800552bool of_device_is_available(const struct device_node *device)
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700553{
554 unsigned long flags;
Kevin Cernekee53a4ab92014-11-12 12:54:01 -0800555 bool res;
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700556
557 raw_spin_lock_irqsave(&devtree_lock, flags);
558 res = __of_device_is_available(device);
559 raw_spin_unlock_irqrestore(&devtree_lock, flags);
560 return res;
561
562}
Josh Boyer834d97d2008-03-27 00:33:14 +1100563EXPORT_SYMBOL(of_device_is_available);
564
565/**
Kevin Cernekee37786c72015-04-09 13:05:14 -0700566 * of_device_is_big_endian - check if a device has BE registers
567 *
568 * @device: Node to check for endianness
569 *
570 * Returns true if the device has a "big-endian" property, or if the kernel
571 * was compiled for BE *and* the device has a "native-endian" property.
572 * Returns false otherwise.
573 *
574 * Callers would nominally use ioread32be/iowrite32be if
575 * of_device_is_big_endian() == true, or readl/writel otherwise.
576 */
577bool of_device_is_big_endian(const struct device_node *device)
578{
579 if (of_property_read_bool(device, "big-endian"))
580 return true;
581 if (IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) &&
582 of_property_read_bool(device, "native-endian"))
583 return true;
584 return false;
585}
586EXPORT_SYMBOL(of_device_is_big_endian);
587
588/**
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000589 * of_get_parent - Get a node's parent if any
590 * @node: Node to get parent
591 *
592 * Returns a node pointer with refcount incremented, use
593 * of_node_put() on it when done.
594 */
595struct device_node *of_get_parent(const struct device_node *node)
596{
597 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500598 unsigned long flags;
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000599
600 if (!node)
601 return NULL;
602
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500603 raw_spin_lock_irqsave(&devtree_lock, flags);
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000604 np = of_node_get(node->parent);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500605 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000606 return np;
607}
608EXPORT_SYMBOL(of_get_parent);
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000609
610/**
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000611 * of_get_next_parent - Iterate to a node's parent
612 * @node: Node to get parent of
613 *
Geert Uytterhoevenc0e848d2014-10-22 11:44:55 +0200614 * This is like of_get_parent() except that it drops the
615 * refcount on the passed node, making it suitable for iterating
616 * through a node's parents.
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000617 *
618 * Returns a node pointer with refcount incremented, use
619 * of_node_put() on it when done.
620 */
621struct device_node *of_get_next_parent(struct device_node *node)
622{
623 struct device_node *parent;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500624 unsigned long flags;
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000625
626 if (!node)
627 return NULL;
628
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500629 raw_spin_lock_irqsave(&devtree_lock, flags);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000630 parent = of_node_get(node->parent);
631 of_node_put(node);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500632 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000633 return parent;
634}
Guennadi Liakhovetski6695be62013-04-02 12:28:11 -0300635EXPORT_SYMBOL(of_get_next_parent);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000636
Grant Likely0d0e02d2014-05-22 01:04:17 +0900637static struct device_node *__of_get_next_child(const struct device_node *node,
638 struct device_node *prev)
639{
640 struct device_node *next;
641
Florian Fainelli43cb4362014-05-28 10:39:02 -0700642 if (!node)
643 return NULL;
644
Grant Likely0d0e02d2014-05-22 01:04:17 +0900645 next = prev ? prev->sibling : node->child;
646 for (; next; next = next->sibling)
647 if (of_node_get(next))
648 break;
649 of_node_put(prev);
650 return next;
651}
652#define __for_each_child_of_node(parent, child) \
653 for (child = __of_get_next_child(parent, NULL); child != NULL; \
654 child = __of_get_next_child(parent, child))
655
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000656/**
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000657 * of_get_next_child - Iterate a node childs
658 * @node: parent node
659 * @prev: previous child of the parent node, or NULL to get first
660 *
Baruch Siach64808272015-03-19 14:03:41 +0200661 * Returns a node pointer with refcount incremented, use of_node_put() on
662 * it when done. Returns NULL when prev is the last child. Decrements the
663 * refcount of prev.
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000664 */
665struct device_node *of_get_next_child(const struct device_node *node,
666 struct device_node *prev)
667{
668 struct device_node *next;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500669 unsigned long flags;
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000670
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500671 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely0d0e02d2014-05-22 01:04:17 +0900672 next = __of_get_next_child(node, prev);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500673 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000674 return next;
675}
676EXPORT_SYMBOL(of_get_next_child);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000677
678/**
Timur Tabi32961932012-08-14 13:20:23 +0000679 * of_get_next_available_child - Find the next available child node
680 * @node: parent node
681 * @prev: previous child of the parent node, or NULL to get first
682 *
683 * This function is like of_get_next_child(), except that it
684 * automatically skips any disabled nodes (i.e. status = "disabled").
685 */
686struct device_node *of_get_next_available_child(const struct device_node *node,
687 struct device_node *prev)
688{
689 struct device_node *next;
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000690 unsigned long flags;
Timur Tabi32961932012-08-14 13:20:23 +0000691
Florian Fainelli43cb4362014-05-28 10:39:02 -0700692 if (!node)
693 return NULL;
694
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000695 raw_spin_lock_irqsave(&devtree_lock, flags);
Timur Tabi32961932012-08-14 13:20:23 +0000696 next = prev ? prev->sibling : node->child;
697 for (; next; next = next->sibling) {
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700698 if (!__of_device_is_available(next))
Timur Tabi32961932012-08-14 13:20:23 +0000699 continue;
700 if (of_node_get(next))
701 break;
702 }
703 of_node_put(prev);
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000704 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Timur Tabi32961932012-08-14 13:20:23 +0000705 return next;
706}
707EXPORT_SYMBOL(of_get_next_available_child);
708
709/**
Srinivas Kandagatla9c197612012-09-18 08:10:28 +0100710 * of_get_child_by_name - Find the child node by name for a given parent
711 * @node: parent node
712 * @name: child name to look for.
713 *
714 * This function looks for child node for given matching name
715 *
716 * Returns a node pointer if found, with refcount incremented, use
717 * of_node_put() on it when done.
718 * Returns NULL if node is not found.
719 */
720struct device_node *of_get_child_by_name(const struct device_node *node,
721 const char *name)
722{
723 struct device_node *child;
724
725 for_each_child_of_node(node, child)
726 if (child->name && (of_node_cmp(child->name, name) == 0))
727 break;
728 return child;
729}
730EXPORT_SYMBOL(of_get_child_by_name);
731
Grant Likelyc22e6502014-03-14 17:07:12 +0000732static struct device_node *__of_find_node_by_path(struct device_node *parent,
733 const char *path)
734{
735 struct device_node *child;
Leif Lindholm106937e2015-03-06 16:52:53 +0000736 int len;
Grant Likelyc22e6502014-03-14 17:07:12 +0000737
Brian Norris721a09e2015-03-17 12:30:31 -0700738 len = strcspn(path, "/:");
Grant Likelyc22e6502014-03-14 17:07:12 +0000739 if (!len)
740 return NULL;
741
742 __for_each_child_of_node(parent, child) {
743 const char *name = strrchr(child->full_name, '/');
744 if (WARN(!name, "malformed device_node %s\n", child->full_name))
745 continue;
746 name++;
747 if (strncmp(path, name, len) == 0 && (strlen(name) == len))
748 return child;
749 }
750 return NULL;
751}
752
Srinivas Kandagatla9c197612012-09-18 08:10:28 +0100753/**
Leif Lindholm75c28c02014-11-28 11:34:28 +0000754 * of_find_node_opts_by_path - Find a node matching a full OF path
Grant Likelyc22e6502014-03-14 17:07:12 +0000755 * @path: Either the full path to match, or if the path does not
756 * start with '/', the name of a property of the /aliases
757 * node (an alias). In the case of an alias, the node
758 * matching the alias' value will be returned.
Leif Lindholm75c28c02014-11-28 11:34:28 +0000759 * @opts: Address of a pointer into which to store the start of
760 * an options string appended to the end of the path with
761 * a ':' separator.
Grant Likelyc22e6502014-03-14 17:07:12 +0000762 *
763 * Valid paths:
764 * /foo/bar Full path
765 * foo Valid alias
766 * foo/bar Valid alias + relative path
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000767 *
768 * Returns a node pointer with refcount incremented, use
769 * of_node_put() on it when done.
770 */
Leif Lindholm75c28c02014-11-28 11:34:28 +0000771struct device_node *of_find_node_opts_by_path(const char *path, const char **opts)
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000772{
Grant Likelyc22e6502014-03-14 17:07:12 +0000773 struct device_node *np = NULL;
774 struct property *pp;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500775 unsigned long flags;
Leif Lindholm75c28c02014-11-28 11:34:28 +0000776 const char *separator = strchr(path, ':');
777
778 if (opts)
779 *opts = separator ? separator + 1 : NULL;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000780
Grant Likelyc22e6502014-03-14 17:07:12 +0000781 if (strcmp(path, "/") == 0)
Grant Likely5063e252014-10-03 16:28:27 +0100782 return of_node_get(of_root);
Grant Likelyc22e6502014-03-14 17:07:12 +0000783
784 /* The path could begin with an alias */
785 if (*path != '/') {
Leif Lindholm106937e2015-03-06 16:52:53 +0000786 int len;
787 const char *p = separator;
788
789 if (!p)
790 p = strchrnul(path, '/');
791 len = p - path;
Grant Likelyc22e6502014-03-14 17:07:12 +0000792
793 /* of_aliases must not be NULL */
794 if (!of_aliases)
795 return NULL;
796
797 for_each_property_of_node(of_aliases, pp) {
798 if (strlen(pp->name) == len && !strncmp(pp->name, path, len)) {
799 np = of_find_node_by_path(pp->value);
800 break;
801 }
802 }
803 if (!np)
804 return NULL;
805 path = p;
806 }
807
808 /* Step down the tree matching path components */
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500809 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likelyc22e6502014-03-14 17:07:12 +0000810 if (!np)
Grant Likely5063e252014-10-03 16:28:27 +0100811 np = of_node_get(of_root);
Grant Likelyc22e6502014-03-14 17:07:12 +0000812 while (np && *path == '/') {
813 path++; /* Increment past '/' delimiter */
814 np = __of_find_node_by_path(np, path);
815 path = strchrnul(path, '/');
Leif Lindholm106937e2015-03-06 16:52:53 +0000816 if (separator && separator < path)
817 break;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000818 }
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500819 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000820 return np;
821}
Leif Lindholm75c28c02014-11-28 11:34:28 +0000822EXPORT_SYMBOL(of_find_node_opts_by_path);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000823
824/**
825 * of_find_node_by_name - Find a node by its "name" property
826 * @from: The node to start searching from or NULL, the node
827 * you pass will not be searched, only the next one
828 * will; typically, you pass what the previous call
829 * returned. of_node_put() will be called on it
830 * @name: The name string to match against
831 *
832 * Returns a node pointer with refcount incremented, use
833 * of_node_put() on it when done.
834 */
835struct device_node *of_find_node_by_name(struct device_node *from,
836 const char *name)
837{
838 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500839 unsigned long flags;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000840
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500841 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely5063e252014-10-03 16:28:27 +0100842 for_each_of_allnodes_from(from, np)
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000843 if (np->name && (of_node_cmp(np->name, name) == 0)
844 && of_node_get(np))
845 break;
846 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500847 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000848 return np;
849}
850EXPORT_SYMBOL(of_find_node_by_name);
851
852/**
853 * of_find_node_by_type - Find a node by its "device_type" property
854 * @from: The node to start searching from, or NULL to start searching
855 * the entire device tree. The node you pass will not be
856 * searched, only the next one will; typically, you pass
857 * what the previous call returned. of_node_put() will be
858 * called on from for you.
859 * @type: The type string to match against
860 *
861 * Returns a node pointer with refcount incremented, use
862 * of_node_put() on it when done.
863 */
864struct device_node *of_find_node_by_type(struct device_node *from,
865 const char *type)
866{
867 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500868 unsigned long flags;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000869
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500870 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely5063e252014-10-03 16:28:27 +0100871 for_each_of_allnodes_from(from, np)
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000872 if (np->type && (of_node_cmp(np->type, type) == 0)
873 && of_node_get(np))
874 break;
875 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500876 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000877 return np;
878}
879EXPORT_SYMBOL(of_find_node_by_type);
880
881/**
882 * of_find_compatible_node - Find a node based on type and one of the
883 * tokens in its "compatible" property
884 * @from: The node to start searching from or NULL, the node
885 * you pass will not be searched, only the next one
886 * will; typically, you pass what the previous call
887 * returned. of_node_put() will be called on it
888 * @type: The type string to match "device_type" or NULL to ignore
889 * @compatible: The string to match to one of the tokens in the device
890 * "compatible" list.
891 *
892 * Returns a node pointer with refcount incremented, use
893 * of_node_put() on it when done.
894 */
895struct device_node *of_find_compatible_node(struct device_node *from,
896 const char *type, const char *compatible)
897{
898 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500899 unsigned long flags;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000900
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500901 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely5063e252014-10-03 16:28:27 +0100902 for_each_of_allnodes_from(from, np)
Kevin Hao215a14c2014-02-19 16:15:45 +0800903 if (__of_device_is_compatible(np, compatible, type, NULL) &&
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500904 of_node_get(np))
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000905 break;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000906 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500907 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000908 return np;
909}
910EXPORT_SYMBOL(of_find_compatible_node);
Grant Likely283029d2008-01-09 06:20:40 +1100911
912/**
Michael Ellerman1e291b12008-11-12 18:54:42 +0000913 * of_find_node_with_property - Find a node which has a property with
914 * the given name.
915 * @from: The node to start searching from or NULL, the node
916 * you pass will not be searched, only the next one
917 * will; typically, you pass what the previous call
918 * returned. of_node_put() will be called on it
919 * @prop_name: The name of the property to look for.
920 *
921 * Returns a node pointer with refcount incremented, use
922 * of_node_put() on it when done.
923 */
924struct device_node *of_find_node_with_property(struct device_node *from,
925 const char *prop_name)
926{
927 struct device_node *np;
928 struct property *pp;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500929 unsigned long flags;
Michael Ellerman1e291b12008-11-12 18:54:42 +0000930
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500931 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely5063e252014-10-03 16:28:27 +0100932 for_each_of_allnodes_from(from, np) {
Sachin Kamata3a7cab2012-06-27 09:44:45 +0530933 for (pp = np->properties; pp; pp = pp->next) {
Michael Ellerman1e291b12008-11-12 18:54:42 +0000934 if (of_prop_cmp(pp->name, prop_name) == 0) {
935 of_node_get(np);
936 goto out;
937 }
938 }
939 }
940out:
941 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500942 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000943 return np;
944}
945EXPORT_SYMBOL(of_find_node_with_property);
946
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500947static
948const struct of_device_id *__of_match_node(const struct of_device_id *matches,
949 const struct device_node *node)
Grant Likely283029d2008-01-09 06:20:40 +1100950{
Kevin Hao215a14c2014-02-19 16:15:45 +0800951 const struct of_device_id *best_match = NULL;
952 int score, best_score = 0;
953
Grant Likelya52f07e2011-03-18 10:21:29 -0600954 if (!matches)
955 return NULL;
956
Kevin Hao215a14c2014-02-19 16:15:45 +0800957 for (; matches->name[0] || matches->type[0] || matches->compatible[0]; matches++) {
958 score = __of_device_is_compatible(node, matches->compatible,
959 matches->type, matches->name);
960 if (score > best_score) {
961 best_match = matches;
962 best_score = score;
963 }
Kevin Hao4e8ca6e2014-02-14 13:22:45 +0800964 }
Kevin Hao215a14c2014-02-19 16:15:45 +0800965
966 return best_match;
Grant Likely283029d2008-01-09 06:20:40 +1100967}
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500968
969/**
Geert Uytterhoevenc50949d2014-10-22 11:44:54 +0200970 * of_match_node - Tell if a device_node has a matching of_match structure
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500971 * @matches: array of of device match structures to search in
972 * @node: the of device structure to match against
973 *
Kevin Hao71c54982014-02-18 15:57:29 +0800974 * Low level utility function used by device matching.
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500975 */
976const struct of_device_id *of_match_node(const struct of_device_id *matches,
977 const struct device_node *node)
978{
979 const struct of_device_id *match;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500980 unsigned long flags;
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500981
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500982 raw_spin_lock_irqsave(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500983 match = __of_match_node(matches, node);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500984 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500985 return match;
986}
Grant Likely283029d2008-01-09 06:20:40 +1100987EXPORT_SYMBOL(of_match_node);
988
989/**
Stephen Warren50c8af42012-11-20 16:12:20 -0700990 * of_find_matching_node_and_match - Find a node based on an of_device_id
991 * match table.
Grant Likely283029d2008-01-09 06:20:40 +1100992 * @from: The node to start searching from or NULL, the node
993 * you pass will not be searched, only the next one
994 * will; typically, you pass what the previous call
995 * returned. of_node_put() will be called on it
996 * @matches: array of of device match structures to search in
Stephen Warren50c8af42012-11-20 16:12:20 -0700997 * @match Updated to point at the matches entry which matched
Grant Likely283029d2008-01-09 06:20:40 +1100998 *
999 * Returns a node pointer with refcount incremented, use
1000 * of_node_put() on it when done.
1001 */
Stephen Warren50c8af42012-11-20 16:12:20 -07001002struct device_node *of_find_matching_node_and_match(struct device_node *from,
1003 const struct of_device_id *matches,
1004 const struct of_device_id **match)
Grant Likely283029d2008-01-09 06:20:40 +11001005{
1006 struct device_node *np;
Thomas Abrahamdc71bcf2013-01-19 10:20:42 -08001007 const struct of_device_id *m;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001008 unsigned long flags;
Grant Likely283029d2008-01-09 06:20:40 +11001009
Stephen Warren50c8af42012-11-20 16:12:20 -07001010 if (match)
1011 *match = NULL;
1012
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001013 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely5063e252014-10-03 16:28:27 +01001014 for_each_of_allnodes_from(from, np) {
Thomas Gleixner28d0e362013-01-25 13:21:47 -05001015 m = __of_match_node(matches, np);
Thomas Abrahamdc71bcf2013-01-19 10:20:42 -08001016 if (m && of_node_get(np)) {
Stephen Warren50c8af42012-11-20 16:12:20 -07001017 if (match)
Thomas Abrahamdc71bcf2013-01-19 10:20:42 -08001018 *match = m;
Grant Likely283029d2008-01-09 06:20:40 +11001019 break;
Stephen Warren50c8af42012-11-20 16:12:20 -07001020 }
Grant Likely283029d2008-01-09 06:20:40 +11001021 }
1022 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001023 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely283029d2008-01-09 06:20:40 +11001024 return np;
1025}
Grant Likely80c20222012-12-19 10:45:36 +00001026EXPORT_SYMBOL(of_find_matching_node_and_match);
Grant Likely3f07af42008-07-25 22:25:13 -04001027
1028/**
Grant Likely3f07af42008-07-25 22:25:13 -04001029 * of_modalias_node - Lookup appropriate modalias for a device node
1030 * @node: pointer to a device tree node
1031 * @modalias: Pointer to buffer that modalias value will be copied into
1032 * @len: Length of modalias value
1033 *
Grant Likely2ffe8c52010-06-08 07:48:19 -06001034 * Based on the value of the compatible property, this routine will attempt
1035 * to choose an appropriate modalias value for a particular device tree node.
1036 * It does this by stripping the manufacturer prefix (as delimited by a ',')
1037 * from the first entry in the compatible list property.
Grant Likely3f07af42008-07-25 22:25:13 -04001038 *
Grant Likely2ffe8c52010-06-08 07:48:19 -06001039 * This routine returns 0 on success, <0 on failure.
Grant Likely3f07af42008-07-25 22:25:13 -04001040 */
1041int of_modalias_node(struct device_node *node, char *modalias, int len)
1042{
Grant Likely2ffe8c52010-06-08 07:48:19 -06001043 const char *compatible, *p;
1044 int cplen;
Grant Likely3f07af42008-07-25 22:25:13 -04001045
1046 compatible = of_get_property(node, "compatible", &cplen);
Grant Likely2ffe8c52010-06-08 07:48:19 -06001047 if (!compatible || strlen(compatible) > cplen)
Grant Likely3f07af42008-07-25 22:25:13 -04001048 return -ENODEV;
Grant Likely3f07af42008-07-25 22:25:13 -04001049 p = strchr(compatible, ',');
Grant Likely2ffe8c52010-06-08 07:48:19 -06001050 strlcpy(modalias, p ? p + 1 : compatible, len);
Grant Likely3f07af42008-07-25 22:25:13 -04001051 return 0;
1052}
1053EXPORT_SYMBOL_GPL(of_modalias_node);
1054
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001055/**
Jeremy Kerr89751a72010-02-01 21:34:11 -07001056 * of_find_node_by_phandle - Find a node given a phandle
1057 * @handle: phandle of the node to find
1058 *
1059 * Returns a node pointer with refcount incremented, use
1060 * of_node_put() on it when done.
1061 */
1062struct device_node *of_find_node_by_phandle(phandle handle)
1063{
1064 struct device_node *np;
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +10001065 unsigned long flags;
Jeremy Kerr89751a72010-02-01 21:34:11 -07001066
Grant Likelyfc59b442014-10-02 13:08:02 +01001067 if (!handle)
1068 return NULL;
1069
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +10001070 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely5063e252014-10-03 16:28:27 +01001071 for_each_of_allnodes(np)
Jeremy Kerr89751a72010-02-01 21:34:11 -07001072 if (np->phandle == handle)
1073 break;
1074 of_node_get(np);
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +10001075 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Jeremy Kerr89751a72010-02-01 21:34:11 -07001076 return np;
1077}
1078EXPORT_SYMBOL(of_find_node_by_phandle);
1079
1080/**
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +01001081 * of_property_count_elems_of_size - Count the number of elements in a property
1082 *
1083 * @np: device node from which the property value is to be read.
1084 * @propname: name of the property to be searched.
1085 * @elem_size: size of the individual element
1086 *
1087 * Search for a property in a device node and count the number of elements of
1088 * size elem_size in it. Returns number of elements on sucess, -EINVAL if the
1089 * property does not exist or its length does not match a multiple of elem_size
1090 * and -ENODATA if the property does not have a value.
1091 */
1092int of_property_count_elems_of_size(const struct device_node *np,
1093 const char *propname, int elem_size)
1094{
1095 struct property *prop = of_find_property(np, propname, NULL);
1096
1097 if (!prop)
1098 return -EINVAL;
1099 if (!prop->value)
1100 return -ENODATA;
1101
1102 if (prop->length % elem_size != 0) {
1103 pr_err("size of %s in node %s is not a multiple of %d\n",
1104 propname, np->full_name, elem_size);
1105 return -EINVAL;
1106 }
1107
1108 return prop->length / elem_size;
1109}
1110EXPORT_SYMBOL_GPL(of_property_count_elems_of_size);
1111
1112/**
Tony Priskdaeec1f2013-04-03 17:57:11 +13001113 * of_find_property_value_of_size
1114 *
1115 * @np: device node from which the property value is to be read.
1116 * @propname: name of the property to be searched.
1117 * @len: requested length of property value
1118 *
1119 * Search for a property in a device node and valid the requested size.
1120 * Returns the property value on success, -EINVAL if the property does not
1121 * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
1122 * property data isn't large enough.
1123 *
1124 */
1125static void *of_find_property_value_of_size(const struct device_node *np,
1126 const char *propname, u32 len)
1127{
1128 struct property *prop = of_find_property(np, propname, NULL);
1129
1130 if (!prop)
1131 return ERR_PTR(-EINVAL);
1132 if (!prop->value)
1133 return ERR_PTR(-ENODATA);
1134 if (len > prop->length)
1135 return ERR_PTR(-EOVERFLOW);
1136
1137 return prop->value;
1138}
1139
1140/**
Tony Prisk3daf3722013-03-23 17:02:15 +13001141 * of_property_read_u32_index - Find and read a u32 from a multi-value property.
1142 *
1143 * @np: device node from which the property value is to be read.
1144 * @propname: name of the property to be searched.
1145 * @index: index of the u32 in the list of values
1146 * @out_value: pointer to return value, modified only if no error.
1147 *
1148 * Search for a property in a device node and read nth 32-bit value from
1149 * it. Returns 0 on success, -EINVAL if the property does not exist,
1150 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1151 * property data isn't large enough.
1152 *
1153 * The out_value is modified only if a valid u32 value can be decoded.
1154 */
1155int of_property_read_u32_index(const struct device_node *np,
1156 const char *propname,
1157 u32 index, u32 *out_value)
1158{
Tony Priskdaeec1f2013-04-03 17:57:11 +13001159 const u32 *val = of_find_property_value_of_size(np, propname,
1160 ((index + 1) * sizeof(*out_value)));
Tony Prisk3daf3722013-03-23 17:02:15 +13001161
Tony Priskdaeec1f2013-04-03 17:57:11 +13001162 if (IS_ERR(val))
1163 return PTR_ERR(val);
Tony Prisk3daf3722013-03-23 17:02:15 +13001164
Tony Priskdaeec1f2013-04-03 17:57:11 +13001165 *out_value = be32_to_cpup(((__be32 *)val) + index);
Tony Prisk3daf3722013-03-23 17:02:15 +13001166 return 0;
1167}
1168EXPORT_SYMBOL_GPL(of_property_read_u32_index);
1169
1170/**
Viresh Kumarbe193242012-11-20 10:15:19 +05301171 * of_property_read_u8_array - Find and read an array of u8 from a property.
1172 *
1173 * @np: device node from which the property value is to be read.
1174 * @propname: name of the property to be searched.
Lad, Prabhakar792efb82013-05-07 11:34:11 +05301175 * @out_values: pointer to return value, modified only if return value is 0.
Viresh Kumarbe193242012-11-20 10:15:19 +05301176 * @sz: number of array elements to read
1177 *
1178 * Search for a property in a device node and read 8-bit value(s) from
1179 * it. Returns 0 on success, -EINVAL if the property does not exist,
1180 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1181 * property data isn't large enough.
1182 *
1183 * dts entry of array should be like:
1184 * property = /bits/ 8 <0x50 0x60 0x70>;
1185 *
Lad, Prabhakar792efb82013-05-07 11:34:11 +05301186 * The out_values is modified only if a valid u8 value can be decoded.
Viresh Kumarbe193242012-11-20 10:15:19 +05301187 */
1188int of_property_read_u8_array(const struct device_node *np,
1189 const char *propname, u8 *out_values, size_t sz)
1190{
Tony Priskdaeec1f2013-04-03 17:57:11 +13001191 const u8 *val = of_find_property_value_of_size(np, propname,
1192 (sz * sizeof(*out_values)));
Viresh Kumarbe193242012-11-20 10:15:19 +05301193
Tony Priskdaeec1f2013-04-03 17:57:11 +13001194 if (IS_ERR(val))
1195 return PTR_ERR(val);
Viresh Kumarbe193242012-11-20 10:15:19 +05301196
Viresh Kumarbe193242012-11-20 10:15:19 +05301197 while (sz--)
1198 *out_values++ = *val++;
1199 return 0;
1200}
1201EXPORT_SYMBOL_GPL(of_property_read_u8_array);
1202
1203/**
1204 * of_property_read_u16_array - Find and read an array of u16 from a property.
1205 *
1206 * @np: device node from which the property value is to be read.
1207 * @propname: name of the property to be searched.
Lad, Prabhakar792efb82013-05-07 11:34:11 +05301208 * @out_values: pointer to return value, modified only if return value is 0.
Viresh Kumarbe193242012-11-20 10:15:19 +05301209 * @sz: number of array elements to read
1210 *
1211 * Search for a property in a device node and read 16-bit value(s) from
1212 * it. Returns 0 on success, -EINVAL if the property does not exist,
1213 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1214 * property data isn't large enough.
1215 *
1216 * dts entry of array should be like:
1217 * property = /bits/ 16 <0x5000 0x6000 0x7000>;
1218 *
Lad, Prabhakar792efb82013-05-07 11:34:11 +05301219 * The out_values is modified only if a valid u16 value can be decoded.
Viresh Kumarbe193242012-11-20 10:15:19 +05301220 */
1221int of_property_read_u16_array(const struct device_node *np,
1222 const char *propname, u16 *out_values, size_t sz)
1223{
Tony Priskdaeec1f2013-04-03 17:57:11 +13001224 const __be16 *val = of_find_property_value_of_size(np, propname,
1225 (sz * sizeof(*out_values)));
Viresh Kumarbe193242012-11-20 10:15:19 +05301226
Tony Priskdaeec1f2013-04-03 17:57:11 +13001227 if (IS_ERR(val))
1228 return PTR_ERR(val);
Viresh Kumarbe193242012-11-20 10:15:19 +05301229
Viresh Kumarbe193242012-11-20 10:15:19 +05301230 while (sz--)
1231 *out_values++ = be16_to_cpup(val++);
1232 return 0;
1233}
1234EXPORT_SYMBOL_GPL(of_property_read_u16_array);
1235
1236/**
Rob Herring0e373632011-07-06 15:42:58 -05001237 * of_property_read_u32_array - Find and read an array of 32 bit integers
1238 * from a property.
1239 *
Thomas Abrahama3b85362011-06-30 21:26:10 +05301240 * @np: device node from which the property value is to be read.
1241 * @propname: name of the property to be searched.
Lad, Prabhakar792efb82013-05-07 11:34:11 +05301242 * @out_values: pointer to return value, modified only if return value is 0.
Viresh Kumarbe193242012-11-20 10:15:19 +05301243 * @sz: number of array elements to read
Thomas Abrahama3b85362011-06-30 21:26:10 +05301244 *
Rob Herring0e373632011-07-06 15:42:58 -05001245 * Search for a property in a device node and read 32-bit value(s) from
Thomas Abrahama3b85362011-06-30 21:26:10 +05301246 * it. Returns 0 on success, -EINVAL if the property does not exist,
1247 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1248 * property data isn't large enough.
1249 *
Lad, Prabhakar792efb82013-05-07 11:34:11 +05301250 * The out_values is modified only if a valid u32 value can be decoded.
Thomas Abrahama3b85362011-06-30 21:26:10 +05301251 */
Jamie Ilesaac285c2011-08-02 15:45:07 +01001252int of_property_read_u32_array(const struct device_node *np,
1253 const char *propname, u32 *out_values,
1254 size_t sz)
Thomas Abrahama3b85362011-06-30 21:26:10 +05301255{
Tony Priskdaeec1f2013-04-03 17:57:11 +13001256 const __be32 *val = of_find_property_value_of_size(np, propname,
1257 (sz * sizeof(*out_values)));
Thomas Abrahama3b85362011-06-30 21:26:10 +05301258
Tony Priskdaeec1f2013-04-03 17:57:11 +13001259 if (IS_ERR(val))
1260 return PTR_ERR(val);
Rob Herring0e373632011-07-06 15:42:58 -05001261
Rob Herring0e373632011-07-06 15:42:58 -05001262 while (sz--)
1263 *out_values++ = be32_to_cpup(val++);
Thomas Abrahama3b85362011-06-30 21:26:10 +05301264 return 0;
1265}
Rob Herring0e373632011-07-06 15:42:58 -05001266EXPORT_SYMBOL_GPL(of_property_read_u32_array);
Thomas Abrahama3b85362011-06-30 21:26:10 +05301267
1268/**
Jamie Iles4cd7f7a2011-09-14 20:49:59 +01001269 * of_property_read_u64 - Find and read a 64 bit integer from a property
1270 * @np: device node from which the property value is to be read.
1271 * @propname: name of the property to be searched.
1272 * @out_value: pointer to return value, modified only if return value is 0.
1273 *
1274 * Search for a property in a device node and read a 64-bit value from
1275 * it. Returns 0 on success, -EINVAL if the property does not exist,
1276 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1277 * property data isn't large enough.
1278 *
1279 * The out_value is modified only if a valid u64 value can be decoded.
1280 */
1281int of_property_read_u64(const struct device_node *np, const char *propname,
1282 u64 *out_value)
1283{
Tony Priskdaeec1f2013-04-03 17:57:11 +13001284 const __be32 *val = of_find_property_value_of_size(np, propname,
1285 sizeof(*out_value));
Jamie Iles4cd7f7a2011-09-14 20:49:59 +01001286
Tony Priskdaeec1f2013-04-03 17:57:11 +13001287 if (IS_ERR(val))
1288 return PTR_ERR(val);
1289
1290 *out_value = of_read_number(val, 2);
Jamie Iles4cd7f7a2011-09-14 20:49:59 +01001291 return 0;
1292}
1293EXPORT_SYMBOL_GPL(of_property_read_u64);
1294
1295/**
Rafael J. Wysockib31384f2014-11-04 01:28:56 +01001296 * of_property_read_u64_array - Find and read an array of 64 bit integers
1297 * from a property.
1298 *
1299 * @np: device node from which the property value is to be read.
1300 * @propname: name of the property to be searched.
1301 * @out_values: pointer to return value, modified only if return value is 0.
1302 * @sz: number of array elements to read
1303 *
1304 * Search for a property in a device node and read 64-bit value(s) from
1305 * it. Returns 0 on success, -EINVAL if the property does not exist,
1306 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1307 * property data isn't large enough.
1308 *
1309 * The out_values is modified only if a valid u64 value can be decoded.
1310 */
1311int of_property_read_u64_array(const struct device_node *np,
1312 const char *propname, u64 *out_values,
1313 size_t sz)
1314{
1315 const __be32 *val = of_find_property_value_of_size(np, propname,
1316 (sz * sizeof(*out_values)));
1317
1318 if (IS_ERR(val))
1319 return PTR_ERR(val);
1320
1321 while (sz--) {
1322 *out_values++ = of_read_number(val, 2);
1323 val += 2;
1324 }
1325 return 0;
1326}
Sakari Ailus2d4c0ae2015-01-27 12:26:35 +02001327EXPORT_SYMBOL_GPL(of_property_read_u64_array);
Rafael J. Wysockib31384f2014-11-04 01:28:56 +01001328
1329/**
Thomas Abrahama3b85362011-06-30 21:26:10 +05301330 * of_property_read_string - Find and read a string from a property
1331 * @np: device node from which the property value is to be read.
1332 * @propname: name of the property to be searched.
1333 * @out_string: pointer to null terminated return string, modified only if
1334 * return value is 0.
1335 *
1336 * Search for a property in a device tree node and retrieve a null
1337 * terminated string value (pointer to data, not a copy). Returns 0 on
1338 * success, -EINVAL if the property does not exist, -ENODATA if property
1339 * does not have a value, and -EILSEQ if the string is not null-terminated
1340 * within the length of the property data.
1341 *
1342 * The out_string pointer is modified only if a valid string can be decoded.
1343 */
David Rivshinfe99c702016-03-02 16:35:51 -05001344int of_property_read_string(const struct device_node *np, const char *propname,
Shawn Guof09bc832011-07-04 09:01:18 +08001345 const char **out_string)
Thomas Abrahama3b85362011-06-30 21:26:10 +05301346{
David Rivshinfe99c702016-03-02 16:35:51 -05001347 const struct property *prop = of_find_property(np, propname, NULL);
Thomas Abrahama3b85362011-06-30 21:26:10 +05301348 if (!prop)
1349 return -EINVAL;
1350 if (!prop->value)
1351 return -ENODATA;
1352 if (strnlen(prop->value, prop->length) >= prop->length)
1353 return -EILSEQ;
1354 *out_string = prop->value;
1355 return 0;
1356}
1357EXPORT_SYMBOL_GPL(of_property_read_string);
1358
1359/**
Grant Likely7aff0fe2011-12-12 09:25:58 -07001360 * of_property_match_string() - Find string in a list and return index
1361 * @np: pointer to node containing string list property
1362 * @propname: string list property name
1363 * @string: pointer to string to search for in string list
1364 *
1365 * This function searches a string list property and returns the index
1366 * of a specific string value.
1367 */
David Rivshinfe99c702016-03-02 16:35:51 -05001368int of_property_match_string(const struct device_node *np, const char *propname,
Grant Likely7aff0fe2011-12-12 09:25:58 -07001369 const char *string)
1370{
David Rivshinfe99c702016-03-02 16:35:51 -05001371 const struct property *prop = of_find_property(np, propname, NULL);
Grant Likely7aff0fe2011-12-12 09:25:58 -07001372 size_t l;
1373 int i;
1374 const char *p, *end;
1375
1376 if (!prop)
1377 return -EINVAL;
1378 if (!prop->value)
1379 return -ENODATA;
1380
1381 p = prop->value;
1382 end = p + prop->length;
1383
1384 for (i = 0; p < end; i++, p += l) {
Grant Likelya87fa1d2014-11-03 15:15:35 +00001385 l = strnlen(p, end - p) + 1;
Grant Likely7aff0fe2011-12-12 09:25:58 -07001386 if (p + l > end)
1387 return -EILSEQ;
1388 pr_debug("comparing %s with %s\n", string, p);
1389 if (strcmp(string, p) == 0)
1390 return i; /* Found it; return index */
1391 }
1392 return -ENODATA;
1393}
1394EXPORT_SYMBOL_GPL(of_property_match_string);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001395
1396/**
Jiri Slabye99010e2014-11-21 13:23:09 +01001397 * of_property_read_string_helper() - Utility helper for parsing string properties
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001398 * @np: device node from which the property value is to be read.
1399 * @propname: name of the property to be searched.
Grant Likelya87fa1d2014-11-03 15:15:35 +00001400 * @out_strs: output array of string pointers.
1401 * @sz: number of array elements to read.
1402 * @skip: Number of strings to skip over at beginning of list.
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001403 *
Grant Likelya87fa1d2014-11-03 15:15:35 +00001404 * Don't call this function directly. It is a utility helper for the
1405 * of_property_read_string*() family of functions.
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001406 */
David Rivshinfe99c702016-03-02 16:35:51 -05001407int of_property_read_string_helper(const struct device_node *np,
1408 const char *propname, const char **out_strs,
1409 size_t sz, int skip)
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001410{
David Rivshinfe99c702016-03-02 16:35:51 -05001411 const struct property *prop = of_find_property(np, propname, NULL);
Grant Likelya87fa1d2014-11-03 15:15:35 +00001412 int l = 0, i = 0;
1413 const char *p, *end;
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001414
1415 if (!prop)
1416 return -EINVAL;
1417 if (!prop->value)
1418 return -ENODATA;
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001419 p = prop->value;
Grant Likelya87fa1d2014-11-03 15:15:35 +00001420 end = p + prop->length;
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001421
Grant Likelya87fa1d2014-11-03 15:15:35 +00001422 for (i = 0; p < end && (!out_strs || i < skip + sz); i++, p += l) {
1423 l = strnlen(p, end - p) + 1;
1424 if (p + l > end)
1425 return -EILSEQ;
1426 if (out_strs && i >= skip)
1427 *out_strs++ = p;
1428 }
1429 i -= skip;
1430 return i <= 0 ? -ENODATA : i;
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001431}
Grant Likelya87fa1d2014-11-03 15:15:35 +00001432EXPORT_SYMBOL_GPL(of_property_read_string_helper);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001433
Grant Likely624cfca2013-10-11 22:05:10 +01001434void of_print_phandle_args(const char *msg, const struct of_phandle_args *args)
1435{
1436 int i;
1437 printk("%s %s", msg, of_node_full_name(args->np));
1438 for (i = 0; i < args->args_count; i++)
1439 printk(i ? ",%08x" : ":%08x", args->args[i]);
1440 printk("\n");
1441}
1442
Grant Likelybd69f732013-02-10 22:57:21 +00001443static int __of_parse_phandle_with_args(const struct device_node *np,
1444 const char *list_name,
Stephen Warren035fd942013-08-14 15:27:10 -06001445 const char *cells_name,
1446 int cell_count, int index,
Grant Likelybd69f732013-02-10 22:57:21 +00001447 struct of_phandle_args *out_args)
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001448{
Grant Likely15c9a0a2011-12-12 09:25:57 -07001449 const __be32 *list, *list_end;
Grant Likely23ce04c2013-02-12 21:21:49 +00001450 int rc = 0, size, cur_index = 0;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001451 uint32_t count = 0;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001452 struct device_node *node = NULL;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001453 phandle phandle;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001454
Grant Likely15c9a0a2011-12-12 09:25:57 -07001455 /* Retrieve the phandle list property */
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001456 list = of_get_property(np, list_name, &size);
Grant Likely15c9a0a2011-12-12 09:25:57 -07001457 if (!list)
Alexandre Courbot1af4c7f2012-06-29 13:57:58 +09001458 return -ENOENT;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001459 list_end = list + size / sizeof(*list);
1460
Grant Likely15c9a0a2011-12-12 09:25:57 -07001461 /* Loop over the phandles until all the requested entry is found */
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001462 while (list < list_end) {
Grant Likely23ce04c2013-02-12 21:21:49 +00001463 rc = -EINVAL;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001464 count = 0;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001465
Grant Likely15c9a0a2011-12-12 09:25:57 -07001466 /*
1467 * If phandle is 0, then it is an empty entry with no
1468 * arguments. Skip forward to the next entry.
1469 */
Grant Likely9a6b2e52010-07-23 01:48:25 -06001470 phandle = be32_to_cpup(list++);
Grant Likely15c9a0a2011-12-12 09:25:57 -07001471 if (phandle) {
1472 /*
1473 * Find the provider node and parse the #*-cells
Stephen Warren91d99422013-08-14 15:27:11 -06001474 * property to determine the argument length.
1475 *
1476 * This is not needed if the cell count is hard-coded
1477 * (i.e. cells_name not set, but cell_count is set),
1478 * except when we're going to return the found node
1479 * below.
Grant Likely15c9a0a2011-12-12 09:25:57 -07001480 */
Stephen Warren91d99422013-08-14 15:27:11 -06001481 if (cells_name || cur_index == index) {
1482 node = of_find_node_by_phandle(phandle);
1483 if (!node) {
1484 pr_err("%s: could not find phandle\n",
1485 np->full_name);
1486 goto err;
1487 }
Grant Likely15c9a0a2011-12-12 09:25:57 -07001488 }
Stephen Warren035fd942013-08-14 15:27:10 -06001489
1490 if (cells_name) {
1491 if (of_property_read_u32(node, cells_name,
1492 &count)) {
1493 pr_err("%s: could not get %s for %s\n",
1494 np->full_name, cells_name,
1495 node->full_name);
1496 goto err;
1497 }
1498 } else {
1499 count = cell_count;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001500 }
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001501
Grant Likely15c9a0a2011-12-12 09:25:57 -07001502 /*
1503 * Make sure that the arguments actually fit in the
1504 * remaining property data length
1505 */
1506 if (list + count > list_end) {
1507 pr_err("%s: arguments longer than property\n",
1508 np->full_name);
Grant Likely23ce04c2013-02-12 21:21:49 +00001509 goto err;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001510 }
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001511 }
1512
Grant Likely15c9a0a2011-12-12 09:25:57 -07001513 /*
1514 * All of the error cases above bail out of the loop, so at
1515 * this point, the parsing is successful. If the requested
1516 * index matches, then fill the out_args structure and return,
1517 * or return -ENOENT for an empty entry.
1518 */
Grant Likely23ce04c2013-02-12 21:21:49 +00001519 rc = -ENOENT;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001520 if (cur_index == index) {
1521 if (!phandle)
Grant Likely23ce04c2013-02-12 21:21:49 +00001522 goto err;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001523
Grant Likely15c9a0a2011-12-12 09:25:57 -07001524 if (out_args) {
1525 int i;
1526 if (WARN_ON(count > MAX_PHANDLE_ARGS))
1527 count = MAX_PHANDLE_ARGS;
1528 out_args->np = node;
1529 out_args->args_count = count;
1530 for (i = 0; i < count; i++)
1531 out_args->args[i] = be32_to_cpup(list++);
Tang Yuantianb855f162013-04-10 11:36:39 +08001532 } else {
1533 of_node_put(node);
Grant Likely15c9a0a2011-12-12 09:25:57 -07001534 }
Grant Likely23ce04c2013-02-12 21:21:49 +00001535
1536 /* Found it! return success */
Grant Likely15c9a0a2011-12-12 09:25:57 -07001537 return 0;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001538 }
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001539
1540 of_node_put(node);
1541 node = NULL;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001542 list += count;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001543 cur_index++;
1544 }
1545
Grant Likely23ce04c2013-02-12 21:21:49 +00001546 /*
1547 * Unlock node before returning result; will be one of:
1548 * -ENOENT : index is for empty phandle
1549 * -EINVAL : parsing error on data
Grant Likelybd69f732013-02-10 22:57:21 +00001550 * [1..n] : Number of phandle (count mode; when index = -1)
Grant Likely23ce04c2013-02-12 21:21:49 +00001551 */
Grant Likelybd69f732013-02-10 22:57:21 +00001552 rc = index < 0 ? cur_index : -ENOENT;
Grant Likely23ce04c2013-02-12 21:21:49 +00001553 err:
Grant Likely15c9a0a2011-12-12 09:25:57 -07001554 if (node)
1555 of_node_put(node);
Grant Likely23ce04c2013-02-12 21:21:49 +00001556 return rc;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001557}
Grant Likelybd69f732013-02-10 22:57:21 +00001558
Stephen Warreneded9dd2013-08-14 15:27:08 -06001559/**
Stephen Warren5fba49e2013-08-14 15:27:09 -06001560 * of_parse_phandle - Resolve a phandle property to a device_node pointer
1561 * @np: Pointer to device node holding phandle property
1562 * @phandle_name: Name of property holding a phandle value
1563 * @index: For properties holding a table of phandles, this is the index into
1564 * the table
1565 *
1566 * Returns the device_node pointer with refcount incremented. Use
1567 * of_node_put() on it when done.
1568 */
1569struct device_node *of_parse_phandle(const struct device_node *np,
1570 const char *phandle_name, int index)
1571{
Stephen Warren91d99422013-08-14 15:27:11 -06001572 struct of_phandle_args args;
Stephen Warren5fba49e2013-08-14 15:27:09 -06001573
Stephen Warren91d99422013-08-14 15:27:11 -06001574 if (index < 0)
Stephen Warren5fba49e2013-08-14 15:27:09 -06001575 return NULL;
1576
Stephen Warren91d99422013-08-14 15:27:11 -06001577 if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0,
1578 index, &args))
1579 return NULL;
1580
1581 return args.np;
Stephen Warren5fba49e2013-08-14 15:27:09 -06001582}
1583EXPORT_SYMBOL(of_parse_phandle);
1584
1585/**
Stephen Warreneded9dd2013-08-14 15:27:08 -06001586 * of_parse_phandle_with_args() - Find a node pointed by phandle in a list
1587 * @np: pointer to a device tree node containing a list
1588 * @list_name: property name that contains a list
1589 * @cells_name: property name that specifies phandles' arguments count
1590 * @index: index of a phandle to parse out
1591 * @out_args: optional pointer to output arguments structure (will be filled)
1592 *
1593 * This function is useful to parse lists of phandles and their arguments.
1594 * Returns 0 on success and fills out_args, on error returns appropriate
1595 * errno value.
1596 *
Geert Uytterhoevend94a75c2014-10-22 11:44:52 +02001597 * Caller is responsible to call of_node_put() on the returned out_args->np
Stephen Warreneded9dd2013-08-14 15:27:08 -06001598 * pointer.
1599 *
1600 * Example:
1601 *
1602 * phandle1: node1 {
Geert Uytterhoevenc0e848d2014-10-22 11:44:55 +02001603 * #list-cells = <2>;
Stephen Warreneded9dd2013-08-14 15:27:08 -06001604 * }
1605 *
1606 * phandle2: node2 {
Geert Uytterhoevenc0e848d2014-10-22 11:44:55 +02001607 * #list-cells = <1>;
Stephen Warreneded9dd2013-08-14 15:27:08 -06001608 * }
1609 *
1610 * node3 {
Geert Uytterhoevenc0e848d2014-10-22 11:44:55 +02001611 * list = <&phandle1 1 2 &phandle2 3>;
Stephen Warreneded9dd2013-08-14 15:27:08 -06001612 * }
1613 *
1614 * To get a device_node of the `node2' node you may call this:
1615 * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args);
1616 */
Grant Likelybd69f732013-02-10 22:57:21 +00001617int of_parse_phandle_with_args(const struct device_node *np, const char *list_name,
1618 const char *cells_name, int index,
1619 struct of_phandle_args *out_args)
1620{
1621 if (index < 0)
1622 return -EINVAL;
Stephen Warren035fd942013-08-14 15:27:10 -06001623 return __of_parse_phandle_with_args(np, list_name, cells_name, 0,
1624 index, out_args);
Grant Likelybd69f732013-02-10 22:57:21 +00001625}
Grant Likely15c9a0a2011-12-12 09:25:57 -07001626EXPORT_SYMBOL(of_parse_phandle_with_args);
Grant Likely02af11b2009-11-23 20:16:45 -07001627
Grant Likelybd69f732013-02-10 22:57:21 +00001628/**
Stephen Warren035fd942013-08-14 15:27:10 -06001629 * of_parse_phandle_with_fixed_args() - Find a node pointed by phandle in a list
1630 * @np: pointer to a device tree node containing a list
1631 * @list_name: property name that contains a list
1632 * @cell_count: number of argument cells following the phandle
1633 * @index: index of a phandle to parse out
1634 * @out_args: optional pointer to output arguments structure (will be filled)
1635 *
1636 * This function is useful to parse lists of phandles and their arguments.
1637 * Returns 0 on success and fills out_args, on error returns appropriate
1638 * errno value.
1639 *
Geert Uytterhoevend94a75c2014-10-22 11:44:52 +02001640 * Caller is responsible to call of_node_put() on the returned out_args->np
Stephen Warren035fd942013-08-14 15:27:10 -06001641 * pointer.
1642 *
1643 * Example:
1644 *
1645 * phandle1: node1 {
1646 * }
1647 *
1648 * phandle2: node2 {
1649 * }
1650 *
1651 * node3 {
Geert Uytterhoevenc0e848d2014-10-22 11:44:55 +02001652 * list = <&phandle1 0 2 &phandle2 2 3>;
Stephen Warren035fd942013-08-14 15:27:10 -06001653 * }
1654 *
1655 * To get a device_node of the `node2' node you may call this:
1656 * of_parse_phandle_with_fixed_args(node3, "list", 2, 1, &args);
1657 */
1658int of_parse_phandle_with_fixed_args(const struct device_node *np,
1659 const char *list_name, int cell_count,
1660 int index, struct of_phandle_args *out_args)
1661{
1662 if (index < 0)
1663 return -EINVAL;
1664 return __of_parse_phandle_with_args(np, list_name, NULL, cell_count,
1665 index, out_args);
1666}
1667EXPORT_SYMBOL(of_parse_phandle_with_fixed_args);
1668
1669/**
Grant Likelybd69f732013-02-10 22:57:21 +00001670 * of_count_phandle_with_args() - Find the number of phandles references in a property
1671 * @np: pointer to a device tree node containing a list
1672 * @list_name: property name that contains a list
1673 * @cells_name: property name that specifies phandles' arguments count
1674 *
1675 * Returns the number of phandle + argument tuples within a property. It
1676 * is a typical pattern to encode a list of phandle and variable
1677 * arguments into a single property. The number of arguments is encoded
1678 * by a property in the phandle-target node. For example, a gpios
1679 * property would contain a list of GPIO specifies consisting of a
1680 * phandle and 1 or more arguments. The number of arguments are
1681 * determined by the #gpio-cells property in the node pointed to by the
1682 * phandle.
1683 */
1684int of_count_phandle_with_args(const struct device_node *np, const char *list_name,
1685 const char *cells_name)
1686{
Stephen Warren035fd942013-08-14 15:27:10 -06001687 return __of_parse_phandle_with_args(np, list_name, cells_name, 0, -1,
1688 NULL);
Grant Likelybd69f732013-02-10 22:57:21 +00001689}
1690EXPORT_SYMBOL(of_count_phandle_with_args);
1691
Grant Likely02af11b2009-11-23 20:16:45 -07001692/**
Xiubo Li62664f62014-01-22 13:57:39 +08001693 * __of_add_property - Add a property to a node without lock operations
1694 */
Pantelis Antonioud8c50082014-07-04 19:58:46 +03001695int __of_add_property(struct device_node *np, struct property *prop)
Xiubo Li62664f62014-01-22 13:57:39 +08001696{
1697 struct property **next;
1698
1699 prop->next = NULL;
1700 next = &np->properties;
1701 while (*next) {
1702 if (strcmp(prop->name, (*next)->name) == 0)
1703 /* duplicate ! don't insert it */
1704 return -EEXIST;
1705
1706 next = &(*next)->next;
1707 }
1708 *next = prop;
1709
1710 return 0;
1711}
1712
1713/**
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001714 * of_add_property - Add a property to a node
Grant Likely02af11b2009-11-23 20:16:45 -07001715 */
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001716int of_add_property(struct device_node *np, struct property *prop)
Grant Likely02af11b2009-11-23 20:16:45 -07001717{
Grant Likely02af11b2009-11-23 20:16:45 -07001718 unsigned long flags;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001719 int rc;
1720
Grant Likely8a2b22a2014-07-23 17:05:06 -06001721 mutex_lock(&of_mutex);
Grant Likely02af11b2009-11-23 20:16:45 -07001722
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001723 raw_spin_lock_irqsave(&devtree_lock, flags);
Xiubo Li62664f62014-01-22 13:57:39 +08001724 rc = __of_add_property(np, prop);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001725 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001726
Grant Likely8a2b22a2014-07-23 17:05:06 -06001727 if (!rc)
Pantelis Antoniou0829f6d2013-12-13 20:08:59 +02001728 __of_add_property_sysfs(np, prop);
Grant Likely02af11b2009-11-23 20:16:45 -07001729
Grant Likely8a2b22a2014-07-23 17:05:06 -06001730 mutex_unlock(&of_mutex);
1731
Grant Likely259092a2014-07-16 12:48:23 -06001732 if (!rc)
1733 of_property_notify(OF_RECONFIG_ADD_PROPERTY, np, prop, NULL);
1734
Xiubo Li62664f62014-01-22 13:57:39 +08001735 return rc;
Grant Likely02af11b2009-11-23 20:16:45 -07001736}
1737
Pantelis Antonioud8c50082014-07-04 19:58:46 +03001738int __of_remove_property(struct device_node *np, struct property *prop)
1739{
1740 struct property **next;
1741
1742 for (next = &np->properties; *next; next = &(*next)->next) {
1743 if (*next == prop)
1744 break;
1745 }
1746 if (*next == NULL)
1747 return -ENODEV;
1748
1749 /* found the node */
1750 *next = prop->next;
1751 prop->next = np->deadprops;
1752 np->deadprops = prop;
1753
1754 return 0;
1755}
1756
Grant Likely8a2b22a2014-07-23 17:05:06 -06001757void __of_remove_property_sysfs(struct device_node *np, struct property *prop)
1758{
Gaurav Minochaef69d742014-09-05 09:56:13 -07001759 if (!IS_ENABLED(CONFIG_SYSFS))
1760 return;
1761
Grant Likely8a2b22a2014-07-23 17:05:06 -06001762 /* at early boot, bail here and defer setup to of_init() */
1763 if (of_kset && of_node_is_attached(np))
1764 sysfs_remove_bin_file(&np->kobj, &prop->attr);
1765}
1766
Grant Likely02af11b2009-11-23 20:16:45 -07001767/**
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001768 * of_remove_property - Remove a property from a node.
Grant Likely02af11b2009-11-23 20:16:45 -07001769 *
1770 * Note that we don't actually remove it, since we have given out
1771 * who-knows-how-many pointers to the data using get-property.
1772 * Instead we just move the property to the "dead properties"
1773 * list, so it won't be found any more.
1774 */
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001775int of_remove_property(struct device_node *np, struct property *prop)
Grant Likely02af11b2009-11-23 20:16:45 -07001776{
Grant Likely02af11b2009-11-23 20:16:45 -07001777 unsigned long flags;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001778 int rc;
1779
Grant Likely8a2b22a2014-07-23 17:05:06 -06001780 mutex_lock(&of_mutex);
Grant Likely02af11b2009-11-23 20:16:45 -07001781
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001782 raw_spin_lock_irqsave(&devtree_lock, flags);
Pantelis Antonioud8c50082014-07-04 19:58:46 +03001783 rc = __of_remove_property(np, prop);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001784 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001785
Grant Likely8a2b22a2014-07-23 17:05:06 -06001786 if (!rc)
1787 __of_remove_property_sysfs(np, prop);
Grant Likely02af11b2009-11-23 20:16:45 -07001788
Grant Likely8a2b22a2014-07-23 17:05:06 -06001789 mutex_unlock(&of_mutex);
Grant Likely75b57ec2014-02-20 18:02:11 +00001790
Grant Likely259092a2014-07-16 12:48:23 -06001791 if (!rc)
1792 of_property_notify(OF_RECONFIG_REMOVE_PROPERTY, np, prop, NULL);
1793
Grant Likely8a2b22a2014-07-23 17:05:06 -06001794 return rc;
Grant Likely02af11b2009-11-23 20:16:45 -07001795}
1796
Pantelis Antonioud8c50082014-07-04 19:58:46 +03001797int __of_update_property(struct device_node *np, struct property *newprop,
1798 struct property **oldpropp)
1799{
1800 struct property **next, *oldprop;
1801
1802 for (next = &np->properties; *next; next = &(*next)->next) {
1803 if (of_prop_cmp((*next)->name, newprop->name) == 0)
1804 break;
1805 }
1806 *oldpropp = oldprop = *next;
1807
1808 if (oldprop) {
1809 /* replace the node */
1810 newprop->next = oldprop->next;
1811 *next = newprop;
1812 oldprop->next = np->deadprops;
1813 np->deadprops = oldprop;
1814 } else {
1815 /* new node */
1816 newprop->next = NULL;
1817 *next = newprop;
1818 }
Grant Likely02af11b2009-11-23 20:16:45 -07001819
1820 return 0;
1821}
1822
Grant Likely8a2b22a2014-07-23 17:05:06 -06001823void __of_update_property_sysfs(struct device_node *np, struct property *newprop,
1824 struct property *oldprop)
1825{
Gaurav Minochaef69d742014-09-05 09:56:13 -07001826 if (!IS_ENABLED(CONFIG_SYSFS))
1827 return;
1828
Grant Likely8a2b22a2014-07-23 17:05:06 -06001829 /* At early boot, bail out and defer setup to of_init() */
1830 if (!of_kset)
1831 return;
1832
1833 if (oldprop)
1834 sysfs_remove_bin_file(&np->kobj, &oldprop->attr);
1835 __of_add_property_sysfs(np, newprop);
1836}
1837
Grant Likely02af11b2009-11-23 20:16:45 -07001838/*
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001839 * of_update_property - Update a property in a node, if the property does
Dong Aisheng475d0092012-07-11 15:16:37 +10001840 * not exist, add it.
Grant Likely02af11b2009-11-23 20:16:45 -07001841 *
1842 * Note that we don't actually remove it, since we have given out
1843 * who-knows-how-many pointers to the data using get-property.
1844 * Instead we just move the property to the "dead properties" list,
1845 * and add the new property to the property list
1846 */
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001847int of_update_property(struct device_node *np, struct property *newprop)
Grant Likely02af11b2009-11-23 20:16:45 -07001848{
Pantelis Antonioud8c50082014-07-04 19:58:46 +03001849 struct property *oldprop;
Grant Likely02af11b2009-11-23 20:16:45 -07001850 unsigned long flags;
Xiubo Li947fdaad02014-04-17 15:48:29 +08001851 int rc;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001852
Dong Aisheng475d0092012-07-11 15:16:37 +10001853 if (!newprop->name)
1854 return -EINVAL;
1855
Grant Likely8a2b22a2014-07-23 17:05:06 -06001856 mutex_lock(&of_mutex);
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001857
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001858 raw_spin_lock_irqsave(&devtree_lock, flags);
Pantelis Antonioud8c50082014-07-04 19:58:46 +03001859 rc = __of_update_property(np, newprop, &oldprop);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001860 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Nathan Fontenote81b3292012-10-02 16:55:01 +00001861
Grant Likely8a2b22a2014-07-23 17:05:06 -06001862 if (!rc)
1863 __of_update_property_sysfs(np, newprop, oldprop);
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001864
Grant Likely8a2b22a2014-07-23 17:05:06 -06001865 mutex_unlock(&of_mutex);
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001866
Grant Likely259092a2014-07-16 12:48:23 -06001867 if (!rc)
1868 of_property_notify(OF_RECONFIG_UPDATE_PROPERTY, np, newprop, oldprop);
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001869
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001870 return rc;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001871}
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001872
Shawn Guo611cad72011-08-15 15:28:14 +08001873static void of_alias_add(struct alias_prop *ap, struct device_node *np,
1874 int id, const char *stem, int stem_len)
1875{
1876 ap->np = np;
1877 ap->id = id;
1878 strncpy(ap->stem, stem, stem_len);
1879 ap->stem[stem_len] = 0;
1880 list_add_tail(&ap->link, &aliases_lookup);
1881 pr_debug("adding DT alias:%s: stem=%s id=%i node=%s\n",
Grant Likely74a7f082012-06-15 11:50:25 -06001882 ap->alias, ap->stem, ap->id, of_node_full_name(np));
Shawn Guo611cad72011-08-15 15:28:14 +08001883}
1884
1885/**
Geert Uytterhoeven1821dda2014-10-22 11:44:53 +02001886 * of_alias_scan - Scan all properties of the 'aliases' node
Shawn Guo611cad72011-08-15 15:28:14 +08001887 *
Geert Uytterhoeven1821dda2014-10-22 11:44:53 +02001888 * The function scans all the properties of the 'aliases' node and populates
1889 * the global lookup table with the properties. It returns the
1890 * number of alias properties found, or an error code in case of failure.
Shawn Guo611cad72011-08-15 15:28:14 +08001891 *
1892 * @dt_alloc: An allocator that provides a virtual address to memory
Geert Uytterhoeven1821dda2014-10-22 11:44:53 +02001893 * for storing the resulting tree
Shawn Guo611cad72011-08-15 15:28:14 +08001894 */
1895void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align))
1896{
1897 struct property *pp;
1898
Laurentiu Tudor7dbe5842014-08-27 17:09:39 +03001899 of_aliases = of_find_node_by_path("/aliases");
Shawn Guo611cad72011-08-15 15:28:14 +08001900 of_chosen = of_find_node_by_path("/chosen");
1901 if (of_chosen == NULL)
1902 of_chosen = of_find_node_by_path("/chosen@0");
Sascha Hauer5c19e952013-08-05 14:40:44 +02001903
1904 if (of_chosen) {
Grant Likelya752ee52014-03-28 08:12:18 -07001905 /* linux,stdout-path and /aliases/stdout are for legacy compatibility */
Grant Likely676e1b22014-03-27 17:11:23 -07001906 const char *name = of_get_property(of_chosen, "stdout-path", NULL);
1907 if (!name)
1908 name = of_get_property(of_chosen, "linux,stdout-path", NULL);
Grant Likelya752ee52014-03-28 08:12:18 -07001909 if (IS_ENABLED(CONFIG_PPC) && !name)
1910 name = of_get_property(of_aliases, "stdout", NULL);
Peter Hurleyf64255b2015-03-17 16:46:33 -04001911 if (name)
Leif Lindholm7914a7c2014-11-27 17:56:07 +00001912 of_stdout = of_find_node_opts_by_path(name, &of_stdout_options);
Sascha Hauer5c19e952013-08-05 14:40:44 +02001913 }
1914
Shawn Guo611cad72011-08-15 15:28:14 +08001915 if (!of_aliases)
1916 return;
1917
Dong Aisheng8af0da92011-12-22 20:19:24 +08001918 for_each_property_of_node(of_aliases, pp) {
Shawn Guo611cad72011-08-15 15:28:14 +08001919 const char *start = pp->name;
1920 const char *end = start + strlen(start);
1921 struct device_node *np;
1922 struct alias_prop *ap;
1923 int id, len;
1924
1925 /* Skip those we do not want to proceed */
1926 if (!strcmp(pp->name, "name") ||
1927 !strcmp(pp->name, "phandle") ||
1928 !strcmp(pp->name, "linux,phandle"))
1929 continue;
1930
1931 np = of_find_node_by_path(pp->value);
1932 if (!np)
1933 continue;
1934
1935 /* walk the alias backwards to extract the id and work out
1936 * the 'stem' string */
1937 while (isdigit(*(end-1)) && end > start)
1938 end--;
1939 len = end - start;
1940
1941 if (kstrtoint(end, 10, &id) < 0)
1942 continue;
1943
1944 /* Allocate an alias_prop with enough space for the stem */
1945 ap = dt_alloc(sizeof(*ap) + len + 1, 4);
1946 if (!ap)
1947 continue;
Grant Likely0640332e2013-08-28 21:24:17 +01001948 memset(ap, 0, sizeof(*ap) + len + 1);
Shawn Guo611cad72011-08-15 15:28:14 +08001949 ap->alias = start;
1950 of_alias_add(ap, np, id, start, len);
1951 }
1952}
1953
1954/**
1955 * of_alias_get_id - Get alias id for the given device_node
1956 * @np: Pointer to the given device_node
1957 * @stem: Alias stem of the given device_node
1958 *
Geert Uytterhoeven5a53a072014-03-11 11:23:38 +01001959 * The function travels the lookup table to get the alias id for the given
1960 * device_node and alias stem. It returns the alias id if found.
Shawn Guo611cad72011-08-15 15:28:14 +08001961 */
1962int of_alias_get_id(struct device_node *np, const char *stem)
1963{
1964 struct alias_prop *app;
1965 int id = -ENODEV;
1966
Pantelis Antoniouc05aba22014-07-04 19:58:03 +03001967 mutex_lock(&of_mutex);
Shawn Guo611cad72011-08-15 15:28:14 +08001968 list_for_each_entry(app, &aliases_lookup, link) {
1969 if (strcmp(app->stem, stem) != 0)
1970 continue;
1971
1972 if (np == app->np) {
1973 id = app->id;
1974 break;
1975 }
1976 }
Pantelis Antoniouc05aba22014-07-04 19:58:03 +03001977 mutex_unlock(&of_mutex);
Shawn Guo611cad72011-08-15 15:28:14 +08001978
1979 return id;
1980}
1981EXPORT_SYMBOL_GPL(of_alias_get_id);
Stephen Warrenc541adc2012-04-04 09:27:46 -06001982
Wolfram Sang351d2242015-03-12 17:17:58 +01001983/**
1984 * of_alias_get_highest_id - Get highest alias id for the given stem
1985 * @stem: Alias stem to be examined
1986 *
1987 * The function travels the lookup table to get the highest alias id for the
1988 * given alias stem. It returns the alias id if found.
1989 */
1990int of_alias_get_highest_id(const char *stem)
1991{
1992 struct alias_prop *app;
1993 int id = -ENODEV;
1994
1995 mutex_lock(&of_mutex);
1996 list_for_each_entry(app, &aliases_lookup, link) {
1997 if (strcmp(app->stem, stem) != 0)
1998 continue;
1999
2000 if (app->id > id)
2001 id = app->id;
2002 }
2003 mutex_unlock(&of_mutex);
2004
2005 return id;
2006}
2007EXPORT_SYMBOL_GPL(of_alias_get_highest_id);
2008
Stephen Warrenc541adc2012-04-04 09:27:46 -06002009const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
2010 u32 *pu)
2011{
2012 const void *curv = cur;
2013
2014 if (!prop)
2015 return NULL;
2016
2017 if (!cur) {
2018 curv = prop->value;
2019 goto out_val;
2020 }
2021
2022 curv += sizeof(*cur);
2023 if (curv >= prop->value + prop->length)
2024 return NULL;
2025
2026out_val:
2027 *pu = be32_to_cpup(curv);
2028 return curv;
2029}
2030EXPORT_SYMBOL_GPL(of_prop_next_u32);
2031
2032const char *of_prop_next_string(struct property *prop, const char *cur)
2033{
2034 const void *curv = cur;
2035
2036 if (!prop)
2037 return NULL;
2038
2039 if (!cur)
2040 return prop->value;
2041
2042 curv += strlen(cur) + 1;
2043 if (curv >= prop->value + prop->length)
2044 return NULL;
2045
2046 return curv;
2047}
2048EXPORT_SYMBOL_GPL(of_prop_next_string);
Sascha Hauer5c19e952013-08-05 14:40:44 +02002049
2050/**
Grant Likely3482f2c2014-03-27 17:18:55 -07002051 * of_console_check() - Test and setup console for DT setup
2052 * @dn - Pointer to device node
2053 * @name - Name to use for preferred console without index. ex. "ttyS"
2054 * @index - Index to use for preferred console.
Sascha Hauer5c19e952013-08-05 14:40:44 +02002055 *
Grant Likely3482f2c2014-03-27 17:18:55 -07002056 * Check if the given device node matches the stdout-path property in the
2057 * /chosen node. If it does then register it as the preferred console and return
2058 * TRUE. Otherwise return FALSE.
Sascha Hauer5c19e952013-08-05 14:40:44 +02002059 */
Grant Likely3482f2c2014-03-27 17:18:55 -07002060bool of_console_check(struct device_node *dn, char *name, int index)
Sascha Hauer5c19e952013-08-05 14:40:44 +02002061{
Grant Likely3482f2c2014-03-27 17:18:55 -07002062 if (!dn || dn != of_stdout || console_set_on_cmdline)
Sascha Hauer5c19e952013-08-05 14:40:44 +02002063 return false;
Leif Lindholm7914a7c2014-11-27 17:56:07 +00002064 return !add_preferred_console(name, index,
2065 kstrdup(of_stdout_options, GFP_KERNEL));
Sascha Hauer5c19e952013-08-05 14:40:44 +02002066}
Grant Likely3482f2c2014-03-27 17:18:55 -07002067EXPORT_SYMBOL_GPL(of_console_check);
Sudeep KarkadaNageshaa3e31b42013-09-18 11:53:05 +01002068
2069/**
2070 * of_find_next_cache_node - Find a node's subsidiary cache
2071 * @np: node of type "cpu" or "cache"
2072 *
2073 * Returns a node pointer with refcount incremented, use
2074 * of_node_put() on it when done. Caller should hold a reference
2075 * to np.
2076 */
2077struct device_node *of_find_next_cache_node(const struct device_node *np)
2078{
2079 struct device_node *child;
2080 const phandle *handle;
2081
2082 handle = of_get_property(np, "l2-cache", NULL);
2083 if (!handle)
2084 handle = of_get_property(np, "next-level-cache", NULL);
2085
2086 if (handle)
2087 return of_find_node_by_phandle(be32_to_cpup(handle));
2088
2089 /* OF on pmac has nodes instead of properties named "l2-cache"
2090 * beneath CPU nodes.
2091 */
2092 if (!strcmp(np->type, "cpu"))
2093 for_each_child_of_node(np, child)
2094 if (!strcmp(child->type, "cache"))
2095 return child;
2096
2097 return NULL;
2098}
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002099
2100/**
Philipp Zabelf2a575f2014-02-14 11:53:56 +01002101 * of_graph_parse_endpoint() - parse common endpoint node properties
2102 * @node: pointer to endpoint device_node
2103 * @endpoint: pointer to the OF endpoint data structure
2104 *
2105 * The caller should hold a reference to @node.
2106 */
2107int of_graph_parse_endpoint(const struct device_node *node,
2108 struct of_endpoint *endpoint)
2109{
2110 struct device_node *port_node = of_get_parent(node);
2111
Philipp Zabeld4847002014-03-04 12:31:24 +01002112 WARN_ONCE(!port_node, "%s(): endpoint %s has no parent node\n",
2113 __func__, node->full_name);
2114
Philipp Zabelf2a575f2014-02-14 11:53:56 +01002115 memset(endpoint, 0, sizeof(*endpoint));
2116
2117 endpoint->local_node = node;
2118 /*
2119 * It doesn't matter whether the two calls below succeed.
2120 * If they don't then the default value 0 is used.
2121 */
2122 of_property_read_u32(port_node, "reg", &endpoint->port);
2123 of_property_read_u32(node, "reg", &endpoint->id);
2124
2125 of_node_put(port_node);
2126
2127 return 0;
2128}
2129EXPORT_SYMBOL(of_graph_parse_endpoint);
2130
2131/**
Philipp Zabelbfe446e2014-03-11 11:21:11 +01002132 * of_graph_get_port_by_id() - get the port matching a given id
2133 * @parent: pointer to the parent device node
2134 * @id: id of the port
2135 *
2136 * Return: A 'port' node pointer with refcount incremented. The caller
2137 * has to use of_node_put() on it when done.
2138 */
2139struct device_node *of_graph_get_port_by_id(struct device_node *parent, u32 id)
2140{
2141 struct device_node *node, *port;
2142
2143 node = of_get_child_by_name(parent, "ports");
2144 if (node)
2145 parent = node;
2146
2147 for_each_child_of_node(parent, port) {
2148 u32 port_id = 0;
2149
2150 if (of_node_cmp(port->name, "port") != 0)
2151 continue;
2152 of_property_read_u32(port, "reg", &port_id);
2153 if (id == port_id)
2154 break;
2155 }
2156
2157 of_node_put(node);
2158
2159 return port;
2160}
2161EXPORT_SYMBOL(of_graph_get_port_by_id);
2162
2163/**
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002164 * of_graph_get_next_endpoint() - get next endpoint node
2165 * @parent: pointer to the parent device node
2166 * @prev: previous endpoint node, or NULL to get first
2167 *
2168 * Return: An 'endpoint' node pointer with refcount incremented. Refcount
Philipp Zabelf033c0b2014-12-01 13:32:32 +01002169 * of the passed @prev node is decremented.
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002170 */
2171struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
2172 struct device_node *prev)
2173{
2174 struct device_node *endpoint;
Linus Torvalds3c83e612014-04-04 09:50:07 -07002175 struct device_node *port;
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002176
2177 if (!parent)
2178 return NULL;
2179
Linus Torvalds3c83e612014-04-04 09:50:07 -07002180 /*
2181 * Start by locating the port node. If no previous endpoint is specified
2182 * search for the first port node, otherwise get the previous endpoint
2183 * parent port node.
2184 */
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002185 if (!prev) {
2186 struct device_node *node;
Linus Torvalds3c83e612014-04-04 09:50:07 -07002187
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002188 node = of_get_child_by_name(parent, "ports");
2189 if (node)
2190 parent = node;
2191
2192 port = of_get_child_by_name(parent, "port");
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002193 of_node_put(node);
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002194
Linus Torvalds3c83e612014-04-04 09:50:07 -07002195 if (!port) {
2196 pr_err("%s(): no port node found in %s\n",
2197 __func__, parent->full_name);
Philipp Zabel4329b932014-02-26 20:43:42 +01002198 return NULL;
Linus Torvalds3c83e612014-04-04 09:50:07 -07002199 }
2200 } else {
2201 port = of_get_parent(prev);
2202 if (WARN_ONCE(!port, "%s(): endpoint %s has no parent node\n",
2203 __func__, prev->full_name))
2204 return NULL;
Linus Torvalds3c83e612014-04-04 09:50:07 -07002205 }
Philipp Zabel4329b932014-02-26 20:43:42 +01002206
Linus Torvalds3c83e612014-04-04 09:50:07 -07002207 while (1) {
2208 /*
2209 * Now that we have a port node, get the next endpoint by
2210 * getting the next child. If the previous endpoint is NULL this
2211 * will return the first child.
2212 */
2213 endpoint = of_get_next_child(port, prev);
2214 if (endpoint) {
2215 of_node_put(port);
2216 return endpoint;
2217 }
2218
2219 /* No more endpoints under this port, try the next one. */
2220 prev = NULL;
2221
2222 do {
2223 port = of_get_next_child(parent, port);
2224 if (!port)
2225 return NULL;
2226 } while (of_node_cmp(port->name, "port"));
2227 }
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002228}
2229EXPORT_SYMBOL(of_graph_get_next_endpoint);
2230
2231/**
Hyungwon Hwang8ccd0d02015-06-12 21:59:01 +09002232 * of_graph_get_endpoint_by_regs() - get endpoint node of specific identifiers
2233 * @parent: pointer to the parent device node
2234 * @port_reg: identifier (value of reg property) of the parent port node
2235 * @reg: identifier (value of reg property) of the endpoint node
2236 *
2237 * Return: An 'endpoint' node pointer which is identified by reg and at the same
2238 * is the child of a port node identified by port_reg. reg and port_reg are
2239 * ignored when they are -1.
2240 */
2241struct device_node *of_graph_get_endpoint_by_regs(
2242 const struct device_node *parent, int port_reg, int reg)
2243{
2244 struct of_endpoint endpoint;
2245 struct device_node *node, *prev_node = NULL;
2246
2247 while (1) {
2248 node = of_graph_get_next_endpoint(parent, prev_node);
2249 of_node_put(prev_node);
2250 if (!node)
2251 break;
2252
2253 of_graph_parse_endpoint(node, &endpoint);
2254 if (((port_reg == -1) || (endpoint.port == port_reg)) &&
2255 ((reg == -1) || (endpoint.id == reg)))
2256 return node;
2257
2258 prev_node = node;
2259 }
2260
2261 return NULL;
2262}
Dave Airlie8ffaa902015-06-23 10:19:10 +10002263EXPORT_SYMBOL(of_graph_get_endpoint_by_regs);
Hyungwon Hwang8ccd0d02015-06-12 21:59:01 +09002264
2265/**
Philipp Zabelfd9fdb72014-02-10 22:01:48 +01002266 * of_graph_get_remote_port_parent() - get remote port's parent node
2267 * @node: pointer to a local endpoint device_node
2268 *
2269 * Return: Remote device node associated with remote endpoint node linked
2270 * to @node. Use of_node_put() on it when done.
2271 */
2272struct device_node *of_graph_get_remote_port_parent(
2273 const struct device_node *node)
2274{
2275 struct device_node *np;
2276 unsigned int depth;
2277
2278 /* Get remote endpoint node. */
2279 np = of_parse_phandle(node, "remote-endpoint", 0);
2280
2281 /* Walk 3 levels up only if there is 'ports' node. */
2282 for (depth = 3; depth && np; depth--) {
2283 np = of_get_next_parent(np);
2284 if (depth == 2 && of_node_cmp(np->name, "ports"))
2285 break;
2286 }
2287 return np;
2288}
2289EXPORT_SYMBOL(of_graph_get_remote_port_parent);
2290
2291/**
2292 * of_graph_get_remote_port() - get remote port node
2293 * @node: pointer to a local endpoint device_node
2294 *
2295 * Return: Remote port node associated with remote endpoint node linked
2296 * to @node. Use of_node_put() on it when done.
2297 */
2298struct device_node *of_graph_get_remote_port(const struct device_node *node)
2299{
2300 struct device_node *np;
2301
2302 /* Get remote endpoint node. */
2303 np = of_parse_phandle(node, "remote-endpoint", 0);
2304 if (!np)
2305 return NULL;
2306 return of_get_next_parent(np);
2307}
2308EXPORT_SYMBOL(of_graph_get_remote_port);