blob: 3ae106d8979149e57fb1bce2cab413191014da39 [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 */
Shawn Guo611cad72011-08-15 15:28:14 +080020#include <linux/ctype.h>
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +010021#include <linux/cpu.h>
Stephen Rothwell97e873e2007-05-01 16:26:07 +100022#include <linux/module.h>
23#include <linux/of.h>
Stephen Rothwell581b6052007-04-24 16:46:53 +100024#include <linux/spinlock.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/slab.h>
Jeremy Kerra9f2f632010-02-01 21:34:14 -070026#include <linux/proc_fs.h>
Stephen Rothwell581b6052007-04-24 16:46:53 +100027
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -080028#include "of_private.h"
Shawn Guo611cad72011-08-15 15:28:14 +080029
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -080030LIST_HEAD(aliases_lookup);
Shawn Guo611cad72011-08-15 15:28:14 +080031
Randy Dunlap465aac62012-11-30 10:01:51 +000032struct device_node *of_allnodes;
33EXPORT_SYMBOL(of_allnodes);
Grant Likelyfc0bdae2010-02-14 07:13:55 -070034struct device_node *of_chosen;
Shawn Guo611cad72011-08-15 15:28:14 +080035struct device_node *of_aliases;
Sascha Hauer5c19e952013-08-05 14:40:44 +020036static struct device_node *of_stdout;
Shawn Guo611cad72011-08-15 15:28:14 +080037
Stepan Moskovchenkoced4eec2012-12-06 14:55:41 -080038DEFINE_MUTEX(of_aliases_mutex);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +100039
Stephen Rothwell581b6052007-04-24 16:46:53 +100040/* use when traversing tree through the allnext, child, sibling,
41 * or parent members of struct device_node.
42 */
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -050043DEFINE_RAW_SPINLOCK(devtree_lock);
Stephen Rothwell97e873e2007-05-01 16:26:07 +100044
45int of_n_addr_cells(struct device_node *np)
46{
Jeremy Kerra9fadee2010-10-10 21:24:10 -060047 const __be32 *ip;
Stephen Rothwell97e873e2007-05-01 16:26:07 +100048
49 do {
50 if (np->parent)
51 np = np->parent;
52 ip = of_get_property(np, "#address-cells", NULL);
53 if (ip)
Jeremy Kerr33714882010-01-30 01:45:26 -070054 return be32_to_cpup(ip);
Stephen Rothwell97e873e2007-05-01 16:26:07 +100055 } while (np->parent);
56 /* No #address-cells property for the root node */
57 return OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
58}
59EXPORT_SYMBOL(of_n_addr_cells);
60
61int of_n_size_cells(struct device_node *np)
62{
Jeremy Kerra9fadee2010-10-10 21:24:10 -060063 const __be32 *ip;
Stephen Rothwell97e873e2007-05-01 16:26:07 +100064
65 do {
66 if (np->parent)
67 np = np->parent;
68 ip = of_get_property(np, "#size-cells", NULL);
69 if (ip)
Jeremy Kerr33714882010-01-30 01:45:26 -070070 return be32_to_cpup(ip);
Stephen Rothwell97e873e2007-05-01 16:26:07 +100071 } while (np->parent);
72 /* No #size-cells property for the root node */
73 return OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
74}
75EXPORT_SYMBOL(of_n_size_cells);
76
Grant Likely0f22dd32012-02-15 20:38:40 -070077#if defined(CONFIG_OF_DYNAMIC)
Grant Likely923f7e32010-01-28 13:52:53 -070078/**
79 * of_node_get - Increment refcount of a node
80 * @node: Node to inc refcount, NULL is supported to
81 * simplify writing of callers
82 *
83 * Returns node.
84 */
85struct device_node *of_node_get(struct device_node *node)
86{
87 if (node)
88 kref_get(&node->kref);
89 return node;
90}
91EXPORT_SYMBOL(of_node_get);
92
93static inline struct device_node *kref_to_device_node(struct kref *kref)
94{
95 return container_of(kref, struct device_node, kref);
96}
97
98/**
99 * of_node_release - release a dynamically allocated node
100 * @kref: kref element of the node to be released
101 *
102 * In of_node_put() this function is passed to kref_put()
103 * as the destructor.
104 */
105static void of_node_release(struct kref *kref)
106{
107 struct device_node *node = kref_to_device_node(kref);
108 struct property *prop = node->properties;
109
110 /* We should never be releasing nodes that haven't been detached. */
111 if (!of_node_check_flag(node, OF_DETACHED)) {
112 pr_err("ERROR: Bad of_node_put() on %s\n", node->full_name);
113 dump_stack();
114 kref_init(&node->kref);
115 return;
116 }
117
118 if (!of_node_check_flag(node, OF_DYNAMIC))
119 return;
120
121 while (prop) {
122 struct property *next = prop->next;
123 kfree(prop->name);
124 kfree(prop->value);
125 kfree(prop);
126 prop = next;
127
128 if (!prop) {
129 prop = node->deadprops;
130 node->deadprops = NULL;
131 }
132 }
133 kfree(node->full_name);
134 kfree(node->data);
135 kfree(node);
136}
137
138/**
139 * of_node_put - Decrement refcount of a node
140 * @node: Node to dec refcount, NULL is supported to
141 * simplify writing of callers
142 *
143 */
144void of_node_put(struct device_node *node)
145{
146 if (node)
147 kref_put(&node->kref, of_node_release);
148}
149EXPORT_SYMBOL(of_node_put);
Grant Likely0f22dd32012-02-15 20:38:40 -0700150#endif /* CONFIG_OF_DYNAMIC */
Grant Likely923f7e32010-01-28 13:52:53 -0700151
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500152static struct property *__of_find_property(const struct device_node *np,
153 const char *name, int *lenp)
Stephen Rothwell581b6052007-04-24 16:46:53 +1000154{
155 struct property *pp;
156
Timur Tabi64e45662008-05-08 05:19:59 +1000157 if (!np)
158 return NULL;
159
Sachin Kamata3a7cab2012-06-27 09:44:45 +0530160 for (pp = np->properties; pp; pp = pp->next) {
Stephen Rothwell581b6052007-04-24 16:46:53 +1000161 if (of_prop_cmp(pp->name, name) == 0) {
Sachin Kamata3a7cab2012-06-27 09:44:45 +0530162 if (lenp)
Stephen Rothwell581b6052007-04-24 16:46:53 +1000163 *lenp = pp->length;
164 break;
165 }
166 }
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500167
168 return pp;
169}
170
171struct property *of_find_property(const struct device_node *np,
172 const char *name,
173 int *lenp)
174{
175 struct property *pp;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500176 unsigned long flags;
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500177
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500178 raw_spin_lock_irqsave(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500179 pp = __of_find_property(np, name, lenp);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500180 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell581b6052007-04-24 16:46:53 +1000181
182 return pp;
183}
184EXPORT_SYMBOL(of_find_property);
185
Grant Likelye91edcf2009-10-15 10:58:09 -0600186/**
187 * of_find_all_nodes - Get next node in global list
188 * @prev: Previous node or NULL to start iteration
189 * of_node_put() will be called on it
190 *
191 * Returns a node pointer with refcount incremented, use
192 * of_node_put() on it when done.
193 */
194struct device_node *of_find_all_nodes(struct device_node *prev)
195{
196 struct device_node *np;
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000197 unsigned long flags;
Grant Likelye91edcf2009-10-15 10:58:09 -0600198
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000199 raw_spin_lock_irqsave(&devtree_lock, flags);
Randy Dunlap465aac62012-11-30 10:01:51 +0000200 np = prev ? prev->allnext : of_allnodes;
Grant Likelye91edcf2009-10-15 10:58:09 -0600201 for (; np != NULL; np = np->allnext)
202 if (of_node_get(np))
203 break;
204 of_node_put(prev);
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000205 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likelye91edcf2009-10-15 10:58:09 -0600206 return np;
207}
208EXPORT_SYMBOL(of_find_all_nodes);
209
Stephen Rothwell97e873e2007-05-01 16:26:07 +1000210/*
211 * Find a property with a given name for a given node
212 * and return the value.
213 */
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500214static const void *__of_get_property(const struct device_node *np,
215 const char *name, int *lenp)
216{
217 struct property *pp = __of_find_property(np, name, lenp);
218
219 return pp ? pp->value : NULL;
220}
221
222/*
223 * Find a property with a given name for a given node
224 * and return the value.
225 */
Stephen Rothwell97e873e2007-05-01 16:26:07 +1000226const void *of_get_property(const struct device_node *np, const char *name,
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500227 int *lenp)
Stephen Rothwell97e873e2007-05-01 16:26:07 +1000228{
229 struct property *pp = of_find_property(np, name, lenp);
230
231 return pp ? pp->value : NULL;
232}
233EXPORT_SYMBOL(of_get_property);
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000234
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100235/*
236 * arch_match_cpu_phys_id - Match the given logical CPU and physical id
237 *
238 * @cpu: logical cpu index of a core/thread
239 * @phys_id: physical identifier of a core/thread
240 *
241 * CPU logical to physical index mapping is architecture specific.
242 * However this __weak function provides a default match of physical
243 * id to logical cpu index. phys_id provided here is usually values read
244 * from the device tree which must match the hardware internal registers.
245 *
246 * Returns true if the physical identifier and the logical cpu index
247 * correspond to the same core/thread, false otherwise.
248 */
249bool __weak arch_match_cpu_phys_id(int cpu, u64 phys_id)
250{
251 return (u32)phys_id == cpu;
252}
253
254/**
255 * Checks if the given "prop_name" property holds the physical id of the
256 * core/thread corresponding to the logical cpu 'cpu'. If 'thread' is not
257 * NULL, local thread number within the core is returned in it.
258 */
259static bool __of_find_n_match_cpu_property(struct device_node *cpun,
260 const char *prop_name, int cpu, unsigned int *thread)
261{
262 const __be32 *cell;
263 int ac, prop_len, tid;
264 u64 hwid;
265
266 ac = of_n_addr_cells(cpun);
267 cell = of_get_property(cpun, prop_name, &prop_len);
Grant Likelyf3cea452013-10-04 17:24:26 +0100268 if (!cell || !ac)
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100269 return false;
Grant Likelyf3cea452013-10-04 17:24:26 +0100270 prop_len /= sizeof(*cell) * ac;
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100271 for (tid = 0; tid < prop_len; tid++) {
272 hwid = of_read_number(cell, ac);
273 if (arch_match_cpu_phys_id(cpu, hwid)) {
274 if (thread)
275 *thread = tid;
276 return true;
277 }
278 cell += ac;
279 }
280 return false;
281}
282
David Millerd1cb9d12013-10-03 17:24:51 -0400283/*
284 * arch_find_n_match_cpu_physical_id - See if the given device node is
285 * for the cpu corresponding to logical cpu 'cpu'. Return true if so,
286 * else false. If 'thread' is non-NULL, the local thread number within the
287 * core is returned in it.
288 */
289bool __weak arch_find_n_match_cpu_physical_id(struct device_node *cpun,
290 int cpu, unsigned int *thread)
291{
292 /* Check for non-standard "ibm,ppc-interrupt-server#s" property
293 * for thread ids on PowerPC. If it doesn't exist fallback to
294 * standard "reg" property.
295 */
296 if (IS_ENABLED(CONFIG_PPC) &&
297 __of_find_n_match_cpu_property(cpun,
298 "ibm,ppc-interrupt-server#s",
299 cpu, thread))
300 return true;
301
302 if (__of_find_n_match_cpu_property(cpun, "reg", cpu, thread))
303 return true;
304
305 return false;
306}
307
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100308/**
309 * of_get_cpu_node - Get device node associated with the given logical CPU
310 *
311 * @cpu: CPU number(logical index) for which device node is required
312 * @thread: if not NULL, local thread number within the physical core is
313 * returned
314 *
315 * The main purpose of this function is to retrieve the device node for the
316 * given logical CPU index. It should be used to initialize the of_node in
317 * cpu device. Once of_node in cpu device is populated, all the further
318 * references can use that instead.
319 *
320 * CPU logical to physical index mapping is architecture specific and is built
321 * before booting secondary cores. This function uses arch_match_cpu_phys_id
322 * which can be overridden by architecture specific implementation.
323 *
324 * Returns a node pointer for the logical cpu if found, else NULL.
325 */
326struct device_node *of_get_cpu_node(int cpu, unsigned int *thread)
327{
David Millerd1cb9d12013-10-03 17:24:51 -0400328 struct device_node *cpun;
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100329
David Millerd1cb9d12013-10-03 17:24:51 -0400330 for_each_node_by_type(cpun, "cpu") {
331 if (arch_find_n_match_cpu_physical_id(cpun, cpu, thread))
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100332 return cpun;
333 }
334 return NULL;
335}
336EXPORT_SYMBOL(of_get_cpu_node);
337
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000338/** Checks if the given "compat" string matches one of the strings in
339 * the device's "compatible" property
340 */
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500341static int __of_device_is_compatible(const struct device_node *device,
342 const char *compat)
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000343{
344 const char* cp;
345 int cplen, l;
346
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500347 cp = __of_get_property(device, "compatible", &cplen);
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000348 if (cp == NULL)
349 return 0;
350 while (cplen > 0) {
351 if (of_compat_cmp(cp, compat, strlen(compat)) == 0)
352 return 1;
353 l = strlen(cp) + 1;
354 cp += l;
355 cplen -= l;
356 }
357
358 return 0;
359}
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500360
361/** Checks if the given "compat" string matches one of the strings in
362 * the device's "compatible" property
363 */
364int of_device_is_compatible(const struct device_node *device,
365 const char *compat)
366{
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500367 unsigned long flags;
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500368 int res;
369
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500370 raw_spin_lock_irqsave(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500371 res = __of_device_is_compatible(device, compat);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500372 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500373 return res;
374}
Stephen Rothwell0081cbc2007-05-01 16:29:19 +1000375EXPORT_SYMBOL(of_device_is_compatible);
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000376
377/**
Grant Likely71a157e2010-02-01 21:34:14 -0700378 * of_machine_is_compatible - Test root of device tree for a given compatible value
Grant Likely1f43cfb2010-01-28 13:47:25 -0700379 * @compat: compatible string to look for in root node's compatible property.
380 *
381 * Returns true if the root node has the given value in its
382 * compatible property.
383 */
Grant Likely71a157e2010-02-01 21:34:14 -0700384int of_machine_is_compatible(const char *compat)
Grant Likely1f43cfb2010-01-28 13:47:25 -0700385{
386 struct device_node *root;
387 int rc = 0;
388
389 root = of_find_node_by_path("/");
390 if (root) {
391 rc = of_device_is_compatible(root, compat);
392 of_node_put(root);
393 }
394 return rc;
395}
Grant Likely71a157e2010-02-01 21:34:14 -0700396EXPORT_SYMBOL(of_machine_is_compatible);
Grant Likely1f43cfb2010-01-28 13:47:25 -0700397
398/**
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700399 * __of_device_is_available - check if a device is available for use
Josh Boyer834d97d2008-03-27 00:33:14 +1100400 *
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700401 * @device: Node to check for availability, with locks already held
Josh Boyer834d97d2008-03-27 00:33:14 +1100402 *
403 * Returns 1 if the status property is absent or set to "okay" or "ok",
404 * 0 otherwise
405 */
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700406static int __of_device_is_available(const struct device_node *device)
Josh Boyer834d97d2008-03-27 00:33:14 +1100407{
408 const char *status;
409 int statlen;
410
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700411 status = __of_get_property(device, "status", &statlen);
Josh Boyer834d97d2008-03-27 00:33:14 +1100412 if (status == NULL)
413 return 1;
414
415 if (statlen > 0) {
416 if (!strcmp(status, "okay") || !strcmp(status, "ok"))
417 return 1;
418 }
419
420 return 0;
421}
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700422
423/**
424 * of_device_is_available - check if a device is available for use
425 *
426 * @device: Node to check for availability
427 *
428 * Returns 1 if the status property is absent or set to "okay" or "ok",
429 * 0 otherwise
430 */
431int of_device_is_available(const struct device_node *device)
432{
433 unsigned long flags;
434 int res;
435
436 raw_spin_lock_irqsave(&devtree_lock, flags);
437 res = __of_device_is_available(device);
438 raw_spin_unlock_irqrestore(&devtree_lock, flags);
439 return res;
440
441}
Josh Boyer834d97d2008-03-27 00:33:14 +1100442EXPORT_SYMBOL(of_device_is_available);
443
444/**
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000445 * of_get_parent - Get a node's parent if any
446 * @node: Node to get parent
447 *
448 * Returns a node pointer with refcount incremented, use
449 * of_node_put() on it when done.
450 */
451struct device_node *of_get_parent(const struct device_node *node)
452{
453 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500454 unsigned long flags;
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000455
456 if (!node)
457 return NULL;
458
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500459 raw_spin_lock_irqsave(&devtree_lock, flags);
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000460 np = of_node_get(node->parent);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500461 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwelle679c5f2007-04-24 17:16:16 +1000462 return np;
463}
464EXPORT_SYMBOL(of_get_parent);
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000465
466/**
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000467 * of_get_next_parent - Iterate to a node's parent
468 * @node: Node to get parent of
469 *
470 * This is like of_get_parent() except that it drops the
471 * refcount on the passed node, making it suitable for iterating
472 * through a node's parents.
473 *
474 * Returns a node pointer with refcount incremented, use
475 * of_node_put() on it when done.
476 */
477struct device_node *of_get_next_parent(struct device_node *node)
478{
479 struct device_node *parent;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500480 unsigned long flags;
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000481
482 if (!node)
483 return NULL;
484
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500485 raw_spin_lock_irqsave(&devtree_lock, flags);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000486 parent = of_node_get(node->parent);
487 of_node_put(node);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500488 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000489 return parent;
490}
Guennadi Liakhovetski6695be62013-04-02 12:28:11 -0300491EXPORT_SYMBOL(of_get_next_parent);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000492
493/**
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000494 * of_get_next_child - Iterate a node childs
495 * @node: parent node
496 * @prev: previous child of the parent node, or NULL to get first
497 *
498 * Returns a node pointer with refcount incremented, use
499 * of_node_put() on it when done.
500 */
501struct device_node *of_get_next_child(const struct device_node *node,
502 struct device_node *prev)
503{
504 struct device_node *next;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500505 unsigned long flags;
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000506
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500507 raw_spin_lock_irqsave(&devtree_lock, flags);
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000508 next = prev ? prev->sibling : node->child;
509 for (; next; next = next->sibling)
510 if (of_node_get(next))
511 break;
512 of_node_put(prev);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500513 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwelld1cd3552007-04-24 17:21:29 +1000514 return next;
515}
516EXPORT_SYMBOL(of_get_next_child);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000517
518/**
Timur Tabi32961932012-08-14 13:20:23 +0000519 * of_get_next_available_child - Find the next available child node
520 * @node: parent node
521 * @prev: previous child of the parent node, or NULL to get first
522 *
523 * This function is like of_get_next_child(), except that it
524 * automatically skips any disabled nodes (i.e. status = "disabled").
525 */
526struct device_node *of_get_next_available_child(const struct device_node *node,
527 struct device_node *prev)
528{
529 struct device_node *next;
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000530 unsigned long flags;
Timur Tabi32961932012-08-14 13:20:23 +0000531
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000532 raw_spin_lock_irqsave(&devtree_lock, flags);
Timur Tabi32961932012-08-14 13:20:23 +0000533 next = prev ? prev->sibling : node->child;
534 for (; next; next = next->sibling) {
Stephen Warrenc31a0c02013-02-11 14:15:32 -0700535 if (!__of_device_is_available(next))
Timur Tabi32961932012-08-14 13:20:23 +0000536 continue;
537 if (of_node_get(next))
538 break;
539 }
540 of_node_put(prev);
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000541 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Timur Tabi32961932012-08-14 13:20:23 +0000542 return next;
543}
544EXPORT_SYMBOL(of_get_next_available_child);
545
546/**
Srinivas Kandagatla9c197612012-09-18 08:10:28 +0100547 * of_get_child_by_name - Find the child node by name for a given parent
548 * @node: parent node
549 * @name: child name to look for.
550 *
551 * This function looks for child node for given matching name
552 *
553 * Returns a node pointer if found, with refcount incremented, use
554 * of_node_put() on it when done.
555 * Returns NULL if node is not found.
556 */
557struct device_node *of_get_child_by_name(const struct device_node *node,
558 const char *name)
559{
560 struct device_node *child;
561
562 for_each_child_of_node(node, child)
563 if (child->name && (of_node_cmp(child->name, name) == 0))
564 break;
565 return child;
566}
567EXPORT_SYMBOL(of_get_child_by_name);
568
569/**
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000570 * of_find_node_by_path - Find a node matching a full OF path
571 * @path: The full path to match
572 *
573 * Returns a node pointer with refcount incremented, use
574 * of_node_put() on it when done.
575 */
576struct device_node *of_find_node_by_path(const char *path)
577{
Randy Dunlap465aac62012-11-30 10:01:51 +0000578 struct device_node *np = of_allnodes;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500579 unsigned long flags;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000580
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500581 raw_spin_lock_irqsave(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000582 for (; np; np = np->allnext) {
583 if (np->full_name && (of_node_cmp(np->full_name, path) == 0)
584 && of_node_get(np))
585 break;
586 }
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500587 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000588 return np;
589}
590EXPORT_SYMBOL(of_find_node_by_path);
591
592/**
593 * of_find_node_by_name - Find a node by its "name" property
594 * @from: The node to start searching from or NULL, the node
595 * you pass will not be searched, only the next one
596 * will; typically, you pass what the previous call
597 * returned. of_node_put() will be called on it
598 * @name: The name string to match against
599 *
600 * Returns a node pointer with refcount incremented, use
601 * of_node_put() on it when done.
602 */
603struct device_node *of_find_node_by_name(struct device_node *from,
604 const char *name)
605{
606 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500607 unsigned long flags;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000608
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500609 raw_spin_lock_irqsave(&devtree_lock, flags);
Randy Dunlap465aac62012-11-30 10:01:51 +0000610 np = from ? from->allnext : of_allnodes;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000611 for (; np; np = np->allnext)
612 if (np->name && (of_node_cmp(np->name, name) == 0)
613 && of_node_get(np))
614 break;
615 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500616 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000617 return np;
618}
619EXPORT_SYMBOL(of_find_node_by_name);
620
621/**
622 * of_find_node_by_type - Find a node by its "device_type" property
623 * @from: The node to start searching from, or NULL to start searching
624 * the entire device tree. The node you pass will not be
625 * searched, only the next one will; typically, you pass
626 * what the previous call returned. of_node_put() will be
627 * called on from for you.
628 * @type: The type string to match against
629 *
630 * Returns a node pointer with refcount incremented, use
631 * of_node_put() on it when done.
632 */
633struct device_node *of_find_node_by_type(struct device_node *from,
634 const char *type)
635{
636 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500637 unsigned long flags;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000638
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500639 raw_spin_lock_irqsave(&devtree_lock, flags);
Randy Dunlap465aac62012-11-30 10:01:51 +0000640 np = from ? from->allnext : of_allnodes;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000641 for (; np; np = np->allnext)
642 if (np->type && (of_node_cmp(np->type, type) == 0)
643 && of_node_get(np))
644 break;
645 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500646 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000647 return np;
648}
649EXPORT_SYMBOL(of_find_node_by_type);
650
651/**
652 * of_find_compatible_node - Find a node based on type and one of the
653 * tokens in its "compatible" property
654 * @from: The node to start searching from or NULL, the node
655 * you pass will not be searched, only the next one
656 * will; typically, you pass what the previous call
657 * returned. of_node_put() will be called on it
658 * @type: The type string to match "device_type" or NULL to ignore
659 * @compatible: The string to match to one of the tokens in the device
660 * "compatible" list.
661 *
662 * Returns a node pointer with refcount incremented, use
663 * of_node_put() on it when done.
664 */
665struct device_node *of_find_compatible_node(struct device_node *from,
666 const char *type, const char *compatible)
667{
668 struct device_node *np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500669 unsigned long flags;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000670
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500671 raw_spin_lock_irqsave(&devtree_lock, flags);
Randy Dunlap465aac62012-11-30 10:01:51 +0000672 np = from ? from->allnext : of_allnodes;
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000673 for (; np; np = np->allnext) {
674 if (type
675 && !(np->type && (of_node_cmp(np->type, type) == 0)))
676 continue;
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500677 if (__of_device_is_compatible(np, compatible) &&
678 of_node_get(np))
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000679 break;
680 }
681 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500682 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Stephen Rothwell1ef4d422007-04-24 17:57:33 +1000683 return np;
684}
685EXPORT_SYMBOL(of_find_compatible_node);
Grant Likely283029d2008-01-09 06:20:40 +1100686
687/**
Michael Ellerman1e291b12008-11-12 18:54:42 +0000688 * of_find_node_with_property - Find a node which has a property with
689 * the given name.
690 * @from: The node to start searching from or NULL, the node
691 * you pass will not be searched, only the next one
692 * will; typically, you pass what the previous call
693 * returned. of_node_put() will be called on it
694 * @prop_name: The name of the property to look for.
695 *
696 * Returns a node pointer with refcount incremented, use
697 * of_node_put() on it when done.
698 */
699struct device_node *of_find_node_with_property(struct device_node *from,
700 const char *prop_name)
701{
702 struct device_node *np;
703 struct property *pp;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500704 unsigned long flags;
Michael Ellerman1e291b12008-11-12 18:54:42 +0000705
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500706 raw_spin_lock_irqsave(&devtree_lock, flags);
Randy Dunlap465aac62012-11-30 10:01:51 +0000707 np = from ? from->allnext : of_allnodes;
Michael Ellerman1e291b12008-11-12 18:54:42 +0000708 for (; np; np = np->allnext) {
Sachin Kamata3a7cab2012-06-27 09:44:45 +0530709 for (pp = np->properties; pp; pp = pp->next) {
Michael Ellerman1e291b12008-11-12 18:54:42 +0000710 if (of_prop_cmp(pp->name, prop_name) == 0) {
711 of_node_get(np);
712 goto out;
713 }
714 }
715 }
716out:
717 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500718 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000719 return np;
720}
721EXPORT_SYMBOL(of_find_node_with_property);
722
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500723static
724const struct of_device_id *__of_match_node(const struct of_device_id *matches,
725 const struct device_node *node)
Grant Likely283029d2008-01-09 06:20:40 +1100726{
Grant Likelya52f07e2011-03-18 10:21:29 -0600727 if (!matches)
728 return NULL;
729
Grant Likely283029d2008-01-09 06:20:40 +1100730 while (matches->name[0] || matches->type[0] || matches->compatible[0]) {
731 int match = 1;
732 if (matches->name[0])
733 match &= node->name
734 && !strcmp(matches->name, node->name);
735 if (matches->type[0])
736 match &= node->type
737 && !strcmp(matches->type, node->type);
Linus Torvaldsbc51b0c2012-07-10 12:49:32 -0700738 if (matches->compatible[0])
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500739 match &= __of_device_is_compatible(node,
740 matches->compatible);
Linus Torvaldsbc51b0c2012-07-10 12:49:32 -0700741 if (match)
Grant Likely283029d2008-01-09 06:20:40 +1100742 return matches;
743 matches++;
744 }
745 return NULL;
746}
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500747
748/**
749 * of_match_node - Tell if an device_node has a matching of_match structure
750 * @matches: array of of device match structures to search in
751 * @node: the of device structure to match against
752 *
753 * Low level utility function used by device matching.
754 */
755const struct of_device_id *of_match_node(const struct of_device_id *matches,
756 const struct device_node *node)
757{
758 const struct of_device_id *match;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500759 unsigned long flags;
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500760
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500761 raw_spin_lock_irqsave(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500762 match = __of_match_node(matches, node);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500763 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500764 return match;
765}
Grant Likely283029d2008-01-09 06:20:40 +1100766EXPORT_SYMBOL(of_match_node);
767
768/**
Stephen Warren50c8af42012-11-20 16:12:20 -0700769 * of_find_matching_node_and_match - Find a node based on an of_device_id
770 * match table.
Grant Likely283029d2008-01-09 06:20:40 +1100771 * @from: The node to start searching from or NULL, the node
772 * you pass will not be searched, only the next one
773 * will; typically, you pass what the previous call
774 * returned. of_node_put() will be called on it
775 * @matches: array of of device match structures to search in
Stephen Warren50c8af42012-11-20 16:12:20 -0700776 * @match Updated to point at the matches entry which matched
Grant Likely283029d2008-01-09 06:20:40 +1100777 *
778 * Returns a node pointer with refcount incremented, use
779 * of_node_put() on it when done.
780 */
Stephen Warren50c8af42012-11-20 16:12:20 -0700781struct device_node *of_find_matching_node_and_match(struct device_node *from,
782 const struct of_device_id *matches,
783 const struct of_device_id **match)
Grant Likely283029d2008-01-09 06:20:40 +1100784{
785 struct device_node *np;
Thomas Abrahamdc71bcf2013-01-19 10:20:42 -0800786 const struct of_device_id *m;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500787 unsigned long flags;
Grant Likely283029d2008-01-09 06:20:40 +1100788
Stephen Warren50c8af42012-11-20 16:12:20 -0700789 if (match)
790 *match = NULL;
791
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500792 raw_spin_lock_irqsave(&devtree_lock, flags);
Randy Dunlap465aac62012-11-30 10:01:51 +0000793 np = from ? from->allnext : of_allnodes;
Grant Likely283029d2008-01-09 06:20:40 +1100794 for (; np; np = np->allnext) {
Thomas Gleixner28d0e362013-01-25 13:21:47 -0500795 m = __of_match_node(matches, np);
Thomas Abrahamdc71bcf2013-01-19 10:20:42 -0800796 if (m && of_node_get(np)) {
Stephen Warren50c8af42012-11-20 16:12:20 -0700797 if (match)
Thomas Abrahamdc71bcf2013-01-19 10:20:42 -0800798 *match = m;
Grant Likely283029d2008-01-09 06:20:40 +1100799 break;
Stephen Warren50c8af42012-11-20 16:12:20 -0700800 }
Grant Likely283029d2008-01-09 06:20:40 +1100801 }
802 of_node_put(from);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500803 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely283029d2008-01-09 06:20:40 +1100804 return np;
805}
Grant Likely80c20222012-12-19 10:45:36 +0000806EXPORT_SYMBOL(of_find_matching_node_and_match);
Grant Likely3f07af42008-07-25 22:25:13 -0400807
808/**
Grant Likely3f07af42008-07-25 22:25:13 -0400809 * of_modalias_node - Lookup appropriate modalias for a device node
810 * @node: pointer to a device tree node
811 * @modalias: Pointer to buffer that modalias value will be copied into
812 * @len: Length of modalias value
813 *
Grant Likely2ffe8c52010-06-08 07:48:19 -0600814 * Based on the value of the compatible property, this routine will attempt
815 * to choose an appropriate modalias value for a particular device tree node.
816 * It does this by stripping the manufacturer prefix (as delimited by a ',')
817 * from the first entry in the compatible list property.
Grant Likely3f07af42008-07-25 22:25:13 -0400818 *
Grant Likely2ffe8c52010-06-08 07:48:19 -0600819 * This routine returns 0 on success, <0 on failure.
Grant Likely3f07af42008-07-25 22:25:13 -0400820 */
821int of_modalias_node(struct device_node *node, char *modalias, int len)
822{
Grant Likely2ffe8c52010-06-08 07:48:19 -0600823 const char *compatible, *p;
824 int cplen;
Grant Likely3f07af42008-07-25 22:25:13 -0400825
826 compatible = of_get_property(node, "compatible", &cplen);
Grant Likely2ffe8c52010-06-08 07:48:19 -0600827 if (!compatible || strlen(compatible) > cplen)
Grant Likely3f07af42008-07-25 22:25:13 -0400828 return -ENODEV;
Grant Likely3f07af42008-07-25 22:25:13 -0400829 p = strchr(compatible, ',');
Grant Likely2ffe8c52010-06-08 07:48:19 -0600830 strlcpy(modalias, p ? p + 1 : compatible, len);
Grant Likely3f07af42008-07-25 22:25:13 -0400831 return 0;
832}
833EXPORT_SYMBOL_GPL(of_modalias_node);
834
Anton Vorontsov64b60e02008-10-10 04:43:17 +0000835/**
Jeremy Kerr89751a72010-02-01 21:34:11 -0700836 * of_find_node_by_phandle - Find a node given a phandle
837 * @handle: phandle of the node to find
838 *
839 * Returns a node pointer with refcount incremented, use
840 * of_node_put() on it when done.
841 */
842struct device_node *of_find_node_by_phandle(phandle handle)
843{
844 struct device_node *np;
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000845 unsigned long flags;
Jeremy Kerr89751a72010-02-01 21:34:11 -0700846
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000847 raw_spin_lock_irqsave(&devtree_lock, flags);
Randy Dunlap465aac62012-11-30 10:01:51 +0000848 for (np = of_allnodes; np; np = np->allnext)
Jeremy Kerr89751a72010-02-01 21:34:11 -0700849 if (np->phandle == handle)
850 break;
851 of_node_get(np);
Benjamin Herrenschmidtd25d8692013-06-12 15:39:04 +1000852 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Jeremy Kerr89751a72010-02-01 21:34:11 -0700853 return np;
854}
855EXPORT_SYMBOL(of_find_node_by_phandle);
856
857/**
Tony Priskdaeec1f2013-04-03 17:57:11 +1300858 * of_find_property_value_of_size
859 *
860 * @np: device node from which the property value is to be read.
861 * @propname: name of the property to be searched.
862 * @len: requested length of property value
863 *
864 * Search for a property in a device node and valid the requested size.
865 * Returns the property value on success, -EINVAL if the property does not
866 * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
867 * property data isn't large enough.
868 *
869 */
870static void *of_find_property_value_of_size(const struct device_node *np,
871 const char *propname, u32 len)
872{
873 struct property *prop = of_find_property(np, propname, NULL);
874
875 if (!prop)
876 return ERR_PTR(-EINVAL);
877 if (!prop->value)
878 return ERR_PTR(-ENODATA);
879 if (len > prop->length)
880 return ERR_PTR(-EOVERFLOW);
881
882 return prop->value;
883}
884
885/**
Tony Prisk3daf3722013-03-23 17:02:15 +1300886 * of_property_read_u32_index - Find and read a u32 from a multi-value property.
887 *
888 * @np: device node from which the property value is to be read.
889 * @propname: name of the property to be searched.
890 * @index: index of the u32 in the list of values
891 * @out_value: pointer to return value, modified only if no error.
892 *
893 * Search for a property in a device node and read nth 32-bit value from
894 * it. Returns 0 on success, -EINVAL if the property does not exist,
895 * -ENODATA if property does not have a value, and -EOVERFLOW if the
896 * property data isn't large enough.
897 *
898 * The out_value is modified only if a valid u32 value can be decoded.
899 */
900int of_property_read_u32_index(const struct device_node *np,
901 const char *propname,
902 u32 index, u32 *out_value)
903{
Tony Priskdaeec1f2013-04-03 17:57:11 +1300904 const u32 *val = of_find_property_value_of_size(np, propname,
905 ((index + 1) * sizeof(*out_value)));
Tony Prisk3daf3722013-03-23 17:02:15 +1300906
Tony Priskdaeec1f2013-04-03 17:57:11 +1300907 if (IS_ERR(val))
908 return PTR_ERR(val);
Tony Prisk3daf3722013-03-23 17:02:15 +1300909
Tony Priskdaeec1f2013-04-03 17:57:11 +1300910 *out_value = be32_to_cpup(((__be32 *)val) + index);
Tony Prisk3daf3722013-03-23 17:02:15 +1300911 return 0;
912}
913EXPORT_SYMBOL_GPL(of_property_read_u32_index);
914
915/**
Viresh Kumarbe193242012-11-20 10:15:19 +0530916 * of_property_read_u8_array - Find and read an array of u8 from a property.
917 *
918 * @np: device node from which the property value is to be read.
919 * @propname: name of the property to be searched.
Lad, Prabhakar792efb82013-05-07 11:34:11 +0530920 * @out_values: pointer to return value, modified only if return value is 0.
Viresh Kumarbe193242012-11-20 10:15:19 +0530921 * @sz: number of array elements to read
922 *
923 * Search for a property in a device node and read 8-bit value(s) from
924 * it. Returns 0 on success, -EINVAL if the property does not exist,
925 * -ENODATA if property does not have a value, and -EOVERFLOW if the
926 * property data isn't large enough.
927 *
928 * dts entry of array should be like:
929 * property = /bits/ 8 <0x50 0x60 0x70>;
930 *
Lad, Prabhakar792efb82013-05-07 11:34:11 +0530931 * The out_values is modified only if a valid u8 value can be decoded.
Viresh Kumarbe193242012-11-20 10:15:19 +0530932 */
933int of_property_read_u8_array(const struct device_node *np,
934 const char *propname, u8 *out_values, size_t sz)
935{
Tony Priskdaeec1f2013-04-03 17:57:11 +1300936 const u8 *val = of_find_property_value_of_size(np, propname,
937 (sz * sizeof(*out_values)));
Viresh Kumarbe193242012-11-20 10:15:19 +0530938
Tony Priskdaeec1f2013-04-03 17:57:11 +1300939 if (IS_ERR(val))
940 return PTR_ERR(val);
Viresh Kumarbe193242012-11-20 10:15:19 +0530941
Viresh Kumarbe193242012-11-20 10:15:19 +0530942 while (sz--)
943 *out_values++ = *val++;
944 return 0;
945}
946EXPORT_SYMBOL_GPL(of_property_read_u8_array);
947
948/**
949 * of_property_read_u16_array - Find and read an array of u16 from a property.
950 *
951 * @np: device node from which the property value is to be read.
952 * @propname: name of the property to be searched.
Lad, Prabhakar792efb82013-05-07 11:34:11 +0530953 * @out_values: pointer to return value, modified only if return value is 0.
Viresh Kumarbe193242012-11-20 10:15:19 +0530954 * @sz: number of array elements to read
955 *
956 * Search for a property in a device node and read 16-bit value(s) from
957 * it. Returns 0 on success, -EINVAL if the property does not exist,
958 * -ENODATA if property does not have a value, and -EOVERFLOW if the
959 * property data isn't large enough.
960 *
961 * dts entry of array should be like:
962 * property = /bits/ 16 <0x5000 0x6000 0x7000>;
963 *
Lad, Prabhakar792efb82013-05-07 11:34:11 +0530964 * The out_values is modified only if a valid u16 value can be decoded.
Viresh Kumarbe193242012-11-20 10:15:19 +0530965 */
966int of_property_read_u16_array(const struct device_node *np,
967 const char *propname, u16 *out_values, size_t sz)
968{
Tony Priskdaeec1f2013-04-03 17:57:11 +1300969 const __be16 *val = of_find_property_value_of_size(np, propname,
970 (sz * sizeof(*out_values)));
Viresh Kumarbe193242012-11-20 10:15:19 +0530971
Tony Priskdaeec1f2013-04-03 17:57:11 +1300972 if (IS_ERR(val))
973 return PTR_ERR(val);
Viresh Kumarbe193242012-11-20 10:15:19 +0530974
Viresh Kumarbe193242012-11-20 10:15:19 +0530975 while (sz--)
976 *out_values++ = be16_to_cpup(val++);
977 return 0;
978}
979EXPORT_SYMBOL_GPL(of_property_read_u16_array);
980
981/**
Rob Herring0e373632011-07-06 15:42:58 -0500982 * of_property_read_u32_array - Find and read an array of 32 bit integers
983 * from a property.
984 *
Thomas Abrahama3b85362011-06-30 21:26:10 +0530985 * @np: device node from which the property value is to be read.
986 * @propname: name of the property to be searched.
Lad, Prabhakar792efb82013-05-07 11:34:11 +0530987 * @out_values: pointer to return value, modified only if return value is 0.
Viresh Kumarbe193242012-11-20 10:15:19 +0530988 * @sz: number of array elements to read
Thomas Abrahama3b85362011-06-30 21:26:10 +0530989 *
Rob Herring0e373632011-07-06 15:42:58 -0500990 * Search for a property in a device node and read 32-bit value(s) from
Thomas Abrahama3b85362011-06-30 21:26:10 +0530991 * it. Returns 0 on success, -EINVAL if the property does not exist,
992 * -ENODATA if property does not have a value, and -EOVERFLOW if the
993 * property data isn't large enough.
994 *
Lad, Prabhakar792efb82013-05-07 11:34:11 +0530995 * The out_values is modified only if a valid u32 value can be decoded.
Thomas Abrahama3b85362011-06-30 21:26:10 +0530996 */
Jamie Ilesaac285c2011-08-02 15:45:07 +0100997int of_property_read_u32_array(const struct device_node *np,
998 const char *propname, u32 *out_values,
999 size_t sz)
Thomas Abrahama3b85362011-06-30 21:26:10 +05301000{
Tony Priskdaeec1f2013-04-03 17:57:11 +13001001 const __be32 *val = of_find_property_value_of_size(np, propname,
1002 (sz * sizeof(*out_values)));
Thomas Abrahama3b85362011-06-30 21:26:10 +05301003
Tony Priskdaeec1f2013-04-03 17:57:11 +13001004 if (IS_ERR(val))
1005 return PTR_ERR(val);
Rob Herring0e373632011-07-06 15:42:58 -05001006
Rob Herring0e373632011-07-06 15:42:58 -05001007 while (sz--)
1008 *out_values++ = be32_to_cpup(val++);
Thomas Abrahama3b85362011-06-30 21:26:10 +05301009 return 0;
1010}
Rob Herring0e373632011-07-06 15:42:58 -05001011EXPORT_SYMBOL_GPL(of_property_read_u32_array);
Thomas Abrahama3b85362011-06-30 21:26:10 +05301012
1013/**
Jamie Iles4cd7f7a2011-09-14 20:49:59 +01001014 * of_property_read_u64 - Find and read a 64 bit integer from a property
1015 * @np: device node from which the property value is to be read.
1016 * @propname: name of the property to be searched.
1017 * @out_value: pointer to return value, modified only if return value is 0.
1018 *
1019 * Search for a property in a device node and read a 64-bit value from
1020 * it. Returns 0 on success, -EINVAL if the property does not exist,
1021 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1022 * property data isn't large enough.
1023 *
1024 * The out_value is modified only if a valid u64 value can be decoded.
1025 */
1026int of_property_read_u64(const struct device_node *np, const char *propname,
1027 u64 *out_value)
1028{
Tony Priskdaeec1f2013-04-03 17:57:11 +13001029 const __be32 *val = of_find_property_value_of_size(np, propname,
1030 sizeof(*out_value));
Jamie Iles4cd7f7a2011-09-14 20:49:59 +01001031
Tony Priskdaeec1f2013-04-03 17:57:11 +13001032 if (IS_ERR(val))
1033 return PTR_ERR(val);
1034
1035 *out_value = of_read_number(val, 2);
Jamie Iles4cd7f7a2011-09-14 20:49:59 +01001036 return 0;
1037}
1038EXPORT_SYMBOL_GPL(of_property_read_u64);
1039
1040/**
Thomas Abrahama3b85362011-06-30 21:26:10 +05301041 * of_property_read_string - Find and read a string from a property
1042 * @np: device node from which the property value is to be read.
1043 * @propname: name of the property to be searched.
1044 * @out_string: pointer to null terminated return string, modified only if
1045 * return value is 0.
1046 *
1047 * Search for a property in a device tree node and retrieve a null
1048 * terminated string value (pointer to data, not a copy). Returns 0 on
1049 * success, -EINVAL if the property does not exist, -ENODATA if property
1050 * does not have a value, and -EILSEQ if the string is not null-terminated
1051 * within the length of the property data.
1052 *
1053 * The out_string pointer is modified only if a valid string can be decoded.
1054 */
Jamie Ilesaac285c2011-08-02 15:45:07 +01001055int of_property_read_string(struct device_node *np, const char *propname,
Shawn Guof09bc832011-07-04 09:01:18 +08001056 const char **out_string)
Thomas Abrahama3b85362011-06-30 21:26:10 +05301057{
1058 struct property *prop = of_find_property(np, propname, NULL);
1059 if (!prop)
1060 return -EINVAL;
1061 if (!prop->value)
1062 return -ENODATA;
1063 if (strnlen(prop->value, prop->length) >= prop->length)
1064 return -EILSEQ;
1065 *out_string = prop->value;
1066 return 0;
1067}
1068EXPORT_SYMBOL_GPL(of_property_read_string);
1069
1070/**
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001071 * of_property_read_string_index - Find and read a string from a multiple
1072 * strings property.
1073 * @np: device node from which the property value is to be read.
1074 * @propname: name of the property to be searched.
1075 * @index: index of the string in the list of strings
1076 * @out_string: pointer to null terminated return string, modified only if
1077 * return value is 0.
1078 *
1079 * Search for a property in a device tree node and retrieve a null
1080 * terminated string value (pointer to data, not a copy) in the list of strings
1081 * contained in that property.
1082 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
1083 * property does not have a value, and -EILSEQ if the string is not
1084 * null-terminated within the length of the property data.
1085 *
1086 * The out_string pointer is modified only if a valid string can be decoded.
1087 */
1088int of_property_read_string_index(struct device_node *np, const char *propname,
1089 int index, const char **output)
1090{
1091 struct property *prop = of_find_property(np, propname, NULL);
1092 int i = 0;
1093 size_t l = 0, total = 0;
1094 const char *p;
1095
1096 if (!prop)
1097 return -EINVAL;
1098 if (!prop->value)
1099 return -ENODATA;
1100 if (strnlen(prop->value, prop->length) >= prop->length)
1101 return -EILSEQ;
1102
1103 p = prop->value;
1104
1105 for (i = 0; total < prop->length; total += l, p += l) {
1106 l = strlen(p) + 1;
Benoit Cousson88af7f52011-12-05 15:23:54 +01001107 if (i++ == index) {
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001108 *output = p;
1109 return 0;
1110 }
1111 }
1112 return -ENODATA;
1113}
1114EXPORT_SYMBOL_GPL(of_property_read_string_index);
1115
Grant Likely7aff0fe2011-12-12 09:25:58 -07001116/**
1117 * of_property_match_string() - Find string in a list and return index
1118 * @np: pointer to node containing string list property
1119 * @propname: string list property name
1120 * @string: pointer to string to search for in string list
1121 *
1122 * This function searches a string list property and returns the index
1123 * of a specific string value.
1124 */
1125int of_property_match_string(struct device_node *np, const char *propname,
1126 const char *string)
1127{
1128 struct property *prop = of_find_property(np, propname, NULL);
1129 size_t l;
1130 int i;
1131 const char *p, *end;
1132
1133 if (!prop)
1134 return -EINVAL;
1135 if (!prop->value)
1136 return -ENODATA;
1137
1138 p = prop->value;
1139 end = p + prop->length;
1140
1141 for (i = 0; p < end; i++, p += l) {
1142 l = strlen(p) + 1;
1143 if (p + l > end)
1144 return -EILSEQ;
1145 pr_debug("comparing %s with %s\n", string, p);
1146 if (strcmp(string, p) == 0)
1147 return i; /* Found it; return index */
1148 }
1149 return -ENODATA;
1150}
1151EXPORT_SYMBOL_GPL(of_property_match_string);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001152
1153/**
1154 * of_property_count_strings - Find and return the number of strings from a
1155 * multiple strings property.
1156 * @np: device node from which the property value is to be read.
1157 * @propname: name of the property to be searched.
1158 *
1159 * Search for a property in a device tree node and retrieve the number of null
1160 * terminated string contain in it. Returns the number of strings on
1161 * success, -EINVAL if the property does not exist, -ENODATA if property
1162 * does not have a value, and -EILSEQ if the string is not null-terminated
1163 * within the length of the property data.
1164 */
1165int of_property_count_strings(struct device_node *np, const char *propname)
1166{
1167 struct property *prop = of_find_property(np, propname, NULL);
1168 int i = 0;
1169 size_t l = 0, total = 0;
1170 const char *p;
1171
1172 if (!prop)
1173 return -EINVAL;
1174 if (!prop->value)
1175 return -ENODATA;
1176 if (strnlen(prop->value, prop->length) >= prop->length)
1177 return -EILSEQ;
1178
1179 p = prop->value;
1180
Benoit Cousson88af7f52011-12-05 15:23:54 +01001181 for (i = 0; total < prop->length; total += l, p += l, i++)
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001182 l = strlen(p) + 1;
Benoit Cousson88af7f52011-12-05 15:23:54 +01001183
Benoit Cousson4fcd15a2011-09-27 17:45:43 +02001184 return i;
1185}
1186EXPORT_SYMBOL_GPL(of_property_count_strings);
1187
Grant Likelybd69f732013-02-10 22:57:21 +00001188static int __of_parse_phandle_with_args(const struct device_node *np,
1189 const char *list_name,
Stephen Warren035fd942013-08-14 15:27:10 -06001190 const char *cells_name,
1191 int cell_count, int index,
Grant Likelybd69f732013-02-10 22:57:21 +00001192 struct of_phandle_args *out_args)
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001193{
Grant Likely15c9a0a2011-12-12 09:25:57 -07001194 const __be32 *list, *list_end;
Grant Likely23ce04c2013-02-12 21:21:49 +00001195 int rc = 0, size, cur_index = 0;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001196 uint32_t count = 0;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001197 struct device_node *node = NULL;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001198 phandle phandle;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001199
Grant Likely15c9a0a2011-12-12 09:25:57 -07001200 /* Retrieve the phandle list property */
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001201 list = of_get_property(np, list_name, &size);
Grant Likely15c9a0a2011-12-12 09:25:57 -07001202 if (!list)
Alexandre Courbot1af4c7f2012-06-29 13:57:58 +09001203 return -ENOENT;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001204 list_end = list + size / sizeof(*list);
1205
Grant Likely15c9a0a2011-12-12 09:25:57 -07001206 /* Loop over the phandles until all the requested entry is found */
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001207 while (list < list_end) {
Grant Likely23ce04c2013-02-12 21:21:49 +00001208 rc = -EINVAL;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001209 count = 0;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001210
Grant Likely15c9a0a2011-12-12 09:25:57 -07001211 /*
1212 * If phandle is 0, then it is an empty entry with no
1213 * arguments. Skip forward to the next entry.
1214 */
Grant Likely9a6b2e52010-07-23 01:48:25 -06001215 phandle = be32_to_cpup(list++);
Grant Likely15c9a0a2011-12-12 09:25:57 -07001216 if (phandle) {
1217 /*
1218 * Find the provider node and parse the #*-cells
Stephen Warren91d99422013-08-14 15:27:11 -06001219 * property to determine the argument length.
1220 *
1221 * This is not needed if the cell count is hard-coded
1222 * (i.e. cells_name not set, but cell_count is set),
1223 * except when we're going to return the found node
1224 * below.
Grant Likely15c9a0a2011-12-12 09:25:57 -07001225 */
Stephen Warren91d99422013-08-14 15:27:11 -06001226 if (cells_name || cur_index == index) {
1227 node = of_find_node_by_phandle(phandle);
1228 if (!node) {
1229 pr_err("%s: could not find phandle\n",
1230 np->full_name);
1231 goto err;
1232 }
Grant Likely15c9a0a2011-12-12 09:25:57 -07001233 }
Stephen Warren035fd942013-08-14 15:27:10 -06001234
1235 if (cells_name) {
1236 if (of_property_read_u32(node, cells_name,
1237 &count)) {
1238 pr_err("%s: could not get %s for %s\n",
1239 np->full_name, cells_name,
1240 node->full_name);
1241 goto err;
1242 }
1243 } else {
1244 count = cell_count;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001245 }
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001246
Grant Likely15c9a0a2011-12-12 09:25:57 -07001247 /*
1248 * Make sure that the arguments actually fit in the
1249 * remaining property data length
1250 */
1251 if (list + count > list_end) {
1252 pr_err("%s: arguments longer than property\n",
1253 np->full_name);
Grant Likely23ce04c2013-02-12 21:21:49 +00001254 goto err;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001255 }
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001256 }
1257
Grant Likely15c9a0a2011-12-12 09:25:57 -07001258 /*
1259 * All of the error cases above bail out of the loop, so at
1260 * this point, the parsing is successful. If the requested
1261 * index matches, then fill the out_args structure and return,
1262 * or return -ENOENT for an empty entry.
1263 */
Grant Likely23ce04c2013-02-12 21:21:49 +00001264 rc = -ENOENT;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001265 if (cur_index == index) {
1266 if (!phandle)
Grant Likely23ce04c2013-02-12 21:21:49 +00001267 goto err;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001268
Grant Likely15c9a0a2011-12-12 09:25:57 -07001269 if (out_args) {
1270 int i;
1271 if (WARN_ON(count > MAX_PHANDLE_ARGS))
1272 count = MAX_PHANDLE_ARGS;
1273 out_args->np = node;
1274 out_args->args_count = count;
1275 for (i = 0; i < count; i++)
1276 out_args->args[i] = be32_to_cpup(list++);
Tang Yuantianb855f162013-04-10 11:36:39 +08001277 } else {
1278 of_node_put(node);
Grant Likely15c9a0a2011-12-12 09:25:57 -07001279 }
Grant Likely23ce04c2013-02-12 21:21:49 +00001280
1281 /* Found it! return success */
Grant Likely15c9a0a2011-12-12 09:25:57 -07001282 return 0;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001283 }
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001284
1285 of_node_put(node);
1286 node = NULL;
Grant Likely15c9a0a2011-12-12 09:25:57 -07001287 list += count;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001288 cur_index++;
1289 }
1290
Grant Likely23ce04c2013-02-12 21:21:49 +00001291 /*
1292 * Unlock node before returning result; will be one of:
1293 * -ENOENT : index is for empty phandle
1294 * -EINVAL : parsing error on data
Grant Likelybd69f732013-02-10 22:57:21 +00001295 * [1..n] : Number of phandle (count mode; when index = -1)
Grant Likely23ce04c2013-02-12 21:21:49 +00001296 */
Grant Likelybd69f732013-02-10 22:57:21 +00001297 rc = index < 0 ? cur_index : -ENOENT;
Grant Likely23ce04c2013-02-12 21:21:49 +00001298 err:
Grant Likely15c9a0a2011-12-12 09:25:57 -07001299 if (node)
1300 of_node_put(node);
Grant Likely23ce04c2013-02-12 21:21:49 +00001301 return rc;
Anton Vorontsov64b60e02008-10-10 04:43:17 +00001302}
Grant Likelybd69f732013-02-10 22:57:21 +00001303
Stephen Warreneded9dd2013-08-14 15:27:08 -06001304/**
Stephen Warren5fba49e2013-08-14 15:27:09 -06001305 * of_parse_phandle - Resolve a phandle property to a device_node pointer
1306 * @np: Pointer to device node holding phandle property
1307 * @phandle_name: Name of property holding a phandle value
1308 * @index: For properties holding a table of phandles, this is the index into
1309 * the table
1310 *
1311 * Returns the device_node pointer with refcount incremented. Use
1312 * of_node_put() on it when done.
1313 */
1314struct device_node *of_parse_phandle(const struct device_node *np,
1315 const char *phandle_name, int index)
1316{
Stephen Warren91d99422013-08-14 15:27:11 -06001317 struct of_phandle_args args;
Stephen Warren5fba49e2013-08-14 15:27:09 -06001318
Stephen Warren91d99422013-08-14 15:27:11 -06001319 if (index < 0)
Stephen Warren5fba49e2013-08-14 15:27:09 -06001320 return NULL;
1321
Stephen Warren91d99422013-08-14 15:27:11 -06001322 if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0,
1323 index, &args))
1324 return NULL;
1325
1326 return args.np;
Stephen Warren5fba49e2013-08-14 15:27:09 -06001327}
1328EXPORT_SYMBOL(of_parse_phandle);
1329
1330/**
Stephen Warreneded9dd2013-08-14 15:27:08 -06001331 * of_parse_phandle_with_args() - Find a node pointed by phandle in a list
1332 * @np: pointer to a device tree node containing a list
1333 * @list_name: property name that contains a list
1334 * @cells_name: property name that specifies phandles' arguments count
1335 * @index: index of a phandle to parse out
1336 * @out_args: optional pointer to output arguments structure (will be filled)
1337 *
1338 * This function is useful to parse lists of phandles and their arguments.
1339 * Returns 0 on success and fills out_args, on error returns appropriate
1340 * errno value.
1341 *
1342 * Caller is responsible to call of_node_put() on the returned out_args->node
1343 * pointer.
1344 *
1345 * Example:
1346 *
1347 * phandle1: node1 {
1348 * #list-cells = <2>;
1349 * }
1350 *
1351 * phandle2: node2 {
1352 * #list-cells = <1>;
1353 * }
1354 *
1355 * node3 {
1356 * list = <&phandle1 1 2 &phandle2 3>;
1357 * }
1358 *
1359 * To get a device_node of the `node2' node you may call this:
1360 * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args);
1361 */
Grant Likelybd69f732013-02-10 22:57:21 +00001362int of_parse_phandle_with_args(const struct device_node *np, const char *list_name,
1363 const char *cells_name, int index,
1364 struct of_phandle_args *out_args)
1365{
1366 if (index < 0)
1367 return -EINVAL;
Stephen Warren035fd942013-08-14 15:27:10 -06001368 return __of_parse_phandle_with_args(np, list_name, cells_name, 0,
1369 index, out_args);
Grant Likelybd69f732013-02-10 22:57:21 +00001370}
Grant Likely15c9a0a2011-12-12 09:25:57 -07001371EXPORT_SYMBOL(of_parse_phandle_with_args);
Grant Likely02af11b2009-11-23 20:16:45 -07001372
Grant Likelybd69f732013-02-10 22:57:21 +00001373/**
Stephen Warren035fd942013-08-14 15:27:10 -06001374 * of_parse_phandle_with_fixed_args() - Find a node pointed by phandle in a list
1375 * @np: pointer to a device tree node containing a list
1376 * @list_name: property name that contains a list
1377 * @cell_count: number of argument cells following the phandle
1378 * @index: index of a phandle to parse out
1379 * @out_args: optional pointer to output arguments structure (will be filled)
1380 *
1381 * This function is useful to parse lists of phandles and their arguments.
1382 * Returns 0 on success and fills out_args, on error returns appropriate
1383 * errno value.
1384 *
1385 * Caller is responsible to call of_node_put() on the returned out_args->node
1386 * pointer.
1387 *
1388 * Example:
1389 *
1390 * phandle1: node1 {
1391 * }
1392 *
1393 * phandle2: node2 {
1394 * }
1395 *
1396 * node3 {
1397 * list = <&phandle1 0 2 &phandle2 2 3>;
1398 * }
1399 *
1400 * To get a device_node of the `node2' node you may call this:
1401 * of_parse_phandle_with_fixed_args(node3, "list", 2, 1, &args);
1402 */
1403int of_parse_phandle_with_fixed_args(const struct device_node *np,
1404 const char *list_name, int cell_count,
1405 int index, struct of_phandle_args *out_args)
1406{
1407 if (index < 0)
1408 return -EINVAL;
1409 return __of_parse_phandle_with_args(np, list_name, NULL, cell_count,
1410 index, out_args);
1411}
1412EXPORT_SYMBOL(of_parse_phandle_with_fixed_args);
1413
1414/**
Grant Likelybd69f732013-02-10 22:57:21 +00001415 * of_count_phandle_with_args() - Find the number of phandles references in a property
1416 * @np: pointer to a device tree node containing a list
1417 * @list_name: property name that contains a list
1418 * @cells_name: property name that specifies phandles' arguments count
1419 *
1420 * Returns the number of phandle + argument tuples within a property. It
1421 * is a typical pattern to encode a list of phandle and variable
1422 * arguments into a single property. The number of arguments is encoded
1423 * by a property in the phandle-target node. For example, a gpios
1424 * property would contain a list of GPIO specifies consisting of a
1425 * phandle and 1 or more arguments. The number of arguments are
1426 * determined by the #gpio-cells property in the node pointed to by the
1427 * phandle.
1428 */
1429int of_count_phandle_with_args(const struct device_node *np, const char *list_name,
1430 const char *cells_name)
1431{
Stephen Warren035fd942013-08-14 15:27:10 -06001432 return __of_parse_phandle_with_args(np, list_name, cells_name, 0, -1,
1433 NULL);
Grant Likelybd69f732013-02-10 22:57:21 +00001434}
1435EXPORT_SYMBOL(of_count_phandle_with_args);
1436
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001437#if defined(CONFIG_OF_DYNAMIC)
1438static int of_property_notify(int action, struct device_node *np,
1439 struct property *prop)
1440{
1441 struct of_prop_reconfig pr;
1442
1443 pr.dn = np;
1444 pr.prop = prop;
1445 return of_reconfig_notify(action, &pr);
1446}
1447#else
1448static int of_property_notify(int action, struct device_node *np,
1449 struct property *prop)
1450{
1451 return 0;
1452}
1453#endif
1454
Grant Likely02af11b2009-11-23 20:16:45 -07001455/**
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001456 * of_add_property - Add a property to a node
Grant Likely02af11b2009-11-23 20:16:45 -07001457 */
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001458int of_add_property(struct device_node *np, struct property *prop)
Grant Likely02af11b2009-11-23 20:16:45 -07001459{
1460 struct property **next;
1461 unsigned long flags;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001462 int rc;
1463
1464 rc = of_property_notify(OF_RECONFIG_ADD_PROPERTY, np, prop);
1465 if (rc)
1466 return rc;
Grant Likely02af11b2009-11-23 20:16:45 -07001467
1468 prop->next = NULL;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001469 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001470 next = &np->properties;
1471 while (*next) {
1472 if (strcmp(prop->name, (*next)->name) == 0) {
1473 /* duplicate ! don't insert it */
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001474 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001475 return -1;
1476 }
1477 next = &(*next)->next;
1478 }
1479 *next = prop;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001480 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001481
1482#ifdef CONFIG_PROC_DEVICETREE
1483 /* try to add to proc as well if it was initialized */
1484 if (np->pde)
1485 proc_device_tree_add_prop(np->pde, prop);
1486#endif /* CONFIG_PROC_DEVICETREE */
1487
1488 return 0;
1489}
1490
1491/**
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001492 * of_remove_property - Remove a property from a node.
Grant Likely02af11b2009-11-23 20:16:45 -07001493 *
1494 * Note that we don't actually remove it, since we have given out
1495 * who-knows-how-many pointers to the data using get-property.
1496 * Instead we just move the property to the "dead properties"
1497 * list, so it won't be found any more.
1498 */
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001499int of_remove_property(struct device_node *np, struct property *prop)
Grant Likely02af11b2009-11-23 20:16:45 -07001500{
1501 struct property **next;
1502 unsigned long flags;
1503 int found = 0;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001504 int rc;
1505
1506 rc = of_property_notify(OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1507 if (rc)
1508 return rc;
Grant Likely02af11b2009-11-23 20:16:45 -07001509
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001510 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001511 next = &np->properties;
1512 while (*next) {
1513 if (*next == prop) {
1514 /* found the node */
1515 *next = prop->next;
1516 prop->next = np->deadprops;
1517 np->deadprops = prop;
1518 found = 1;
1519 break;
1520 }
1521 next = &(*next)->next;
1522 }
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001523 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001524
1525 if (!found)
1526 return -ENODEV;
1527
1528#ifdef CONFIG_PROC_DEVICETREE
1529 /* try to remove the proc node as well */
1530 if (np->pde)
1531 proc_device_tree_remove_prop(np->pde, prop);
1532#endif /* CONFIG_PROC_DEVICETREE */
1533
1534 return 0;
1535}
1536
1537/*
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001538 * of_update_property - Update a property in a node, if the property does
Dong Aisheng475d0092012-07-11 15:16:37 +10001539 * not exist, add it.
Grant Likely02af11b2009-11-23 20:16:45 -07001540 *
1541 * Note that we don't actually remove it, since we have given out
1542 * who-knows-how-many pointers to the data using get-property.
1543 * Instead we just move the property to the "dead properties" list,
1544 * and add the new property to the property list
1545 */
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001546int of_update_property(struct device_node *np, struct property *newprop)
Grant Likely02af11b2009-11-23 20:16:45 -07001547{
Dong Aisheng475d0092012-07-11 15:16:37 +10001548 struct property **next, *oldprop;
Grant Likely02af11b2009-11-23 20:16:45 -07001549 unsigned long flags;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001550 int rc, found = 0;
1551
1552 rc = of_property_notify(OF_RECONFIG_UPDATE_PROPERTY, np, newprop);
1553 if (rc)
1554 return rc;
Grant Likely02af11b2009-11-23 20:16:45 -07001555
Dong Aisheng475d0092012-07-11 15:16:37 +10001556 if (!newprop->name)
1557 return -EINVAL;
1558
1559 oldprop = of_find_property(np, newprop->name, NULL);
1560 if (!oldprop)
Nathan Fontenot79d1c712012-10-02 16:58:46 +00001561 return of_add_property(np, newprop);
Dong Aisheng475d0092012-07-11 15:16:37 +10001562
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001563 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001564 next = &np->properties;
1565 while (*next) {
1566 if (*next == oldprop) {
1567 /* found the node */
1568 newprop->next = oldprop->next;
1569 *next = newprop;
1570 oldprop->next = np->deadprops;
1571 np->deadprops = oldprop;
1572 found = 1;
1573 break;
1574 }
1575 next = &(*next)->next;
1576 }
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001577 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Grant Likely02af11b2009-11-23 20:16:45 -07001578
1579 if (!found)
1580 return -ENODEV;
1581
1582#ifdef CONFIG_PROC_DEVICETREE
1583 /* try to add to proc as well if it was initialized */
1584 if (np->pde)
1585 proc_device_tree_update_prop(np->pde, newprop, oldprop);
1586#endif /* CONFIG_PROC_DEVICETREE */
1587
1588 return 0;
1589}
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001590
1591#if defined(CONFIG_OF_DYNAMIC)
1592/*
1593 * Support for dynamic device trees.
1594 *
1595 * On some platforms, the device tree can be manipulated at runtime.
1596 * The routines in this section support adding, removing and changing
1597 * device tree nodes.
1598 */
1599
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001600static BLOCKING_NOTIFIER_HEAD(of_reconfig_chain);
1601
1602int of_reconfig_notifier_register(struct notifier_block *nb)
1603{
1604 return blocking_notifier_chain_register(&of_reconfig_chain, nb);
1605}
Nathan Fontenot1a9bd452012-11-28 09:42:26 +00001606EXPORT_SYMBOL_GPL(of_reconfig_notifier_register);
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001607
1608int of_reconfig_notifier_unregister(struct notifier_block *nb)
1609{
1610 return blocking_notifier_chain_unregister(&of_reconfig_chain, nb);
1611}
Nathan Fontenot1a9bd452012-11-28 09:42:26 +00001612EXPORT_SYMBOL_GPL(of_reconfig_notifier_unregister);
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001613
1614int of_reconfig_notify(unsigned long action, void *p)
1615{
1616 int rc;
1617
1618 rc = blocking_notifier_call_chain(&of_reconfig_chain, action, p);
1619 return notifier_to_errno(rc);
1620}
1621
Nathan Fontenote81b3292012-10-02 16:55:01 +00001622#ifdef CONFIG_PROC_DEVICETREE
1623static void of_add_proc_dt_entry(struct device_node *dn)
1624{
1625 struct proc_dir_entry *ent;
1626
1627 ent = proc_mkdir(strrchr(dn->full_name, '/') + 1, dn->parent->pde);
1628 if (ent)
1629 proc_device_tree_add_node(dn, ent);
1630}
1631#else
1632static void of_add_proc_dt_entry(struct device_node *dn)
1633{
1634 return;
1635}
1636#endif
1637
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001638/**
1639 * of_attach_node - Plug a device node into the tree and global list.
1640 */
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001641int of_attach_node(struct device_node *np)
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001642{
1643 unsigned long flags;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001644 int rc;
1645
1646 rc = of_reconfig_notify(OF_RECONFIG_ATTACH_NODE, np);
1647 if (rc)
1648 return rc;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001649
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001650 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001651 np->sibling = np->parent->child;
Randy Dunlap465aac62012-11-30 10:01:51 +00001652 np->allnext = of_allnodes;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001653 np->parent->child = np;
Randy Dunlap465aac62012-11-30 10:01:51 +00001654 of_allnodes = np;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001655 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Nathan Fontenote81b3292012-10-02 16:55:01 +00001656
1657 of_add_proc_dt_entry(np);
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001658 return 0;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001659}
1660
Nathan Fontenote81b3292012-10-02 16:55:01 +00001661#ifdef CONFIG_PROC_DEVICETREE
1662static void of_remove_proc_dt_entry(struct device_node *dn)
1663{
David Howellsa8ca16e2013-04-12 17:27:28 +01001664 proc_remove(dn->pde);
Nathan Fontenote81b3292012-10-02 16:55:01 +00001665}
1666#else
1667static void of_remove_proc_dt_entry(struct device_node *dn)
1668{
1669 return;
1670}
1671#endif
1672
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001673/**
1674 * of_detach_node - "Unplug" a node from the device tree.
1675 *
1676 * The caller must hold a reference to the node. The memory associated with
1677 * the node is not freed until its refcount goes to zero.
1678 */
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001679int of_detach_node(struct device_node *np)
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001680{
1681 struct device_node *parent;
1682 unsigned long flags;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001683 int rc = 0;
1684
1685 rc = of_reconfig_notify(OF_RECONFIG_DETACH_NODE, np);
1686 if (rc)
1687 return rc;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001688
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001689 raw_spin_lock_irqsave(&devtree_lock, flags);
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001690
Nathan Fontenote81b3292012-10-02 16:55:01 +00001691 if (of_node_check_flag(np, OF_DETACHED)) {
1692 /* someone already detached it */
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001693 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001694 return rc;
Nathan Fontenote81b3292012-10-02 16:55:01 +00001695 }
1696
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001697 parent = np->parent;
Nathan Fontenote81b3292012-10-02 16:55:01 +00001698 if (!parent) {
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001699 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001700 return rc;
Nathan Fontenote81b3292012-10-02 16:55:01 +00001701 }
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001702
Randy Dunlap465aac62012-11-30 10:01:51 +00001703 if (of_allnodes == np)
1704 of_allnodes = np->allnext;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001705 else {
1706 struct device_node *prev;
Randy Dunlap465aac62012-11-30 10:01:51 +00001707 for (prev = of_allnodes;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001708 prev->allnext != np;
1709 prev = prev->allnext)
1710 ;
1711 prev->allnext = np->allnext;
1712 }
1713
1714 if (parent->child == np)
1715 parent->child = np->sibling;
1716 else {
1717 struct device_node *prevsib;
1718 for (prevsib = np->parent->child;
1719 prevsib->sibling != np;
1720 prevsib = prevsib->sibling)
1721 ;
1722 prevsib->sibling = np->sibling;
1723 }
1724
1725 of_node_set_flag(np, OF_DETACHED);
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -05001726 raw_spin_unlock_irqrestore(&devtree_lock, flags);
Nathan Fontenote81b3292012-10-02 16:55:01 +00001727
1728 of_remove_proc_dt_entry(np);
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +00001729 return rc;
Grant Likelyfcdeb7f2010-01-29 05:04:33 -07001730}
1731#endif /* defined(CONFIG_OF_DYNAMIC) */
1732
Shawn Guo611cad72011-08-15 15:28:14 +08001733static void of_alias_add(struct alias_prop *ap, struct device_node *np,
1734 int id, const char *stem, int stem_len)
1735{
1736 ap->np = np;
1737 ap->id = id;
1738 strncpy(ap->stem, stem, stem_len);
1739 ap->stem[stem_len] = 0;
1740 list_add_tail(&ap->link, &aliases_lookup);
1741 pr_debug("adding DT alias:%s: stem=%s id=%i node=%s\n",
Grant Likely74a7f082012-06-15 11:50:25 -06001742 ap->alias, ap->stem, ap->id, of_node_full_name(np));
Shawn Guo611cad72011-08-15 15:28:14 +08001743}
1744
1745/**
1746 * of_alias_scan - Scan all properties of 'aliases' node
1747 *
1748 * The function scans all the properties of 'aliases' node and populate
1749 * the the global lookup table with the properties. It returns the
1750 * number of alias_prop found, or error code in error case.
1751 *
1752 * @dt_alloc: An allocator that provides a virtual address to memory
1753 * for the resulting tree
1754 */
1755void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align))
1756{
1757 struct property *pp;
1758
1759 of_chosen = of_find_node_by_path("/chosen");
1760 if (of_chosen == NULL)
1761 of_chosen = of_find_node_by_path("/chosen@0");
Sascha Hauer5c19e952013-08-05 14:40:44 +02001762
1763 if (of_chosen) {
1764 const char *name;
1765
1766 name = of_get_property(of_chosen, "linux,stdout-path", NULL);
1767 if (name)
1768 of_stdout = of_find_node_by_path(name);
1769 }
1770
Shawn Guo611cad72011-08-15 15:28:14 +08001771 of_aliases = of_find_node_by_path("/aliases");
1772 if (!of_aliases)
1773 return;
1774
Dong Aisheng8af0da92011-12-22 20:19:24 +08001775 for_each_property_of_node(of_aliases, pp) {
Shawn Guo611cad72011-08-15 15:28:14 +08001776 const char *start = pp->name;
1777 const char *end = start + strlen(start);
1778 struct device_node *np;
1779 struct alias_prop *ap;
1780 int id, len;
1781
1782 /* Skip those we do not want to proceed */
1783 if (!strcmp(pp->name, "name") ||
1784 !strcmp(pp->name, "phandle") ||
1785 !strcmp(pp->name, "linux,phandle"))
1786 continue;
1787
1788 np = of_find_node_by_path(pp->value);
1789 if (!np)
1790 continue;
1791
1792 /* walk the alias backwards to extract the id and work out
1793 * the 'stem' string */
1794 while (isdigit(*(end-1)) && end > start)
1795 end--;
1796 len = end - start;
1797
1798 if (kstrtoint(end, 10, &id) < 0)
1799 continue;
1800
1801 /* Allocate an alias_prop with enough space for the stem */
1802 ap = dt_alloc(sizeof(*ap) + len + 1, 4);
1803 if (!ap)
1804 continue;
Grant Likely0640332e2013-08-28 21:24:17 +01001805 memset(ap, 0, sizeof(*ap) + len + 1);
Shawn Guo611cad72011-08-15 15:28:14 +08001806 ap->alias = start;
1807 of_alias_add(ap, np, id, start, len);
1808 }
1809}
1810
1811/**
1812 * of_alias_get_id - Get alias id for the given device_node
1813 * @np: Pointer to the given device_node
1814 * @stem: Alias stem of the given device_node
1815 *
1816 * The function travels the lookup table to get alias id for the given
1817 * device_node and alias stem. It returns the alias id if find it.
1818 */
1819int of_alias_get_id(struct device_node *np, const char *stem)
1820{
1821 struct alias_prop *app;
1822 int id = -ENODEV;
1823
1824 mutex_lock(&of_aliases_mutex);
1825 list_for_each_entry(app, &aliases_lookup, link) {
1826 if (strcmp(app->stem, stem) != 0)
1827 continue;
1828
1829 if (np == app->np) {
1830 id = app->id;
1831 break;
1832 }
1833 }
1834 mutex_unlock(&of_aliases_mutex);
1835
1836 return id;
1837}
1838EXPORT_SYMBOL_GPL(of_alias_get_id);
Stephen Warrenc541adc2012-04-04 09:27:46 -06001839
1840const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
1841 u32 *pu)
1842{
1843 const void *curv = cur;
1844
1845 if (!prop)
1846 return NULL;
1847
1848 if (!cur) {
1849 curv = prop->value;
1850 goto out_val;
1851 }
1852
1853 curv += sizeof(*cur);
1854 if (curv >= prop->value + prop->length)
1855 return NULL;
1856
1857out_val:
1858 *pu = be32_to_cpup(curv);
1859 return curv;
1860}
1861EXPORT_SYMBOL_GPL(of_prop_next_u32);
1862
1863const char *of_prop_next_string(struct property *prop, const char *cur)
1864{
1865 const void *curv = cur;
1866
1867 if (!prop)
1868 return NULL;
1869
1870 if (!cur)
1871 return prop->value;
1872
1873 curv += strlen(cur) + 1;
1874 if (curv >= prop->value + prop->length)
1875 return NULL;
1876
1877 return curv;
1878}
1879EXPORT_SYMBOL_GPL(of_prop_next_string);
Sascha Hauer5c19e952013-08-05 14:40:44 +02001880
1881/**
1882 * of_device_is_stdout_path - check if a device node matches the
1883 * linux,stdout-path property
1884 *
1885 * Check if this device node matches the linux,stdout-path property
1886 * in the chosen node. return true if yes, false otherwise.
1887 */
1888int of_device_is_stdout_path(struct device_node *dn)
1889{
1890 if (!of_stdout)
1891 return false;
1892
1893 return of_stdout == dn;
1894}
1895EXPORT_SYMBOL_GPL(of_device_is_stdout_path);