]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/of/base.c
Merge remote-tracking branch 'devicetree/devicetree/next'
[karo-tx-linux.git] / drivers / of / base.c
1 /*
2  * Procedures for creating, accessing and interpreting the device tree.
3  *
4  * Paul Mackerras       August 1996.
5  * Copyright (C) 1996-2005 Paul Mackerras.
6  *
7  *  Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
8  *    {engebret|bergner}@us.ibm.com
9  *
10  *  Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net
11  *
12  *  Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and
13  *  Grant Likely.
14  *
15  *      This program is free software; you can redistribute it and/or
16  *      modify it under the terms of the GNU General Public License
17  *      as published by the Free Software Foundation; either version
18  *      2 of the License, or (at your option) any later version.
19  */
20 #include <linux/ctype.h>
21 #include <linux/cpu.h>
22 #include <linux/module.h>
23 #include <linux/of.h>
24 #include <linux/spinlock.h>
25 #include <linux/slab.h>
26 #include <linux/proc_fs.h>
27
28 #include "of_private.h"
29
30 LIST_HEAD(aliases_lookup);
31
32 struct device_node *of_allnodes;
33 EXPORT_SYMBOL(of_allnodes);
34 struct device_node *of_chosen;
35 struct device_node *of_aliases;
36 static struct device_node *of_stdout;
37
38 DEFINE_MUTEX(of_aliases_mutex);
39
40 /* use when traversing tree through the allnext, child, sibling,
41  * or parent members of struct device_node.
42  */
43 DEFINE_RAW_SPINLOCK(devtree_lock);
44
45 int of_n_addr_cells(struct device_node *np)
46 {
47         const __be32 *ip;
48
49         do {
50                 if (np->parent)
51                         np = np->parent;
52                 ip = of_get_property(np, "#address-cells", NULL);
53                 if (ip)
54                         return be32_to_cpup(ip);
55         } while (np->parent);
56         /* No #address-cells property for the root node */
57         return OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
58 }
59 EXPORT_SYMBOL(of_n_addr_cells);
60
61 int of_n_size_cells(struct device_node *np)
62 {
63         const __be32 *ip;
64
65         do {
66                 if (np->parent)
67                         np = np->parent;
68                 ip = of_get_property(np, "#size-cells", NULL);
69                 if (ip)
70                         return be32_to_cpup(ip);
71         } while (np->parent);
72         /* No #size-cells property for the root node */
73         return OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
74 }
75 EXPORT_SYMBOL(of_n_size_cells);
76
77 #if defined(CONFIG_OF_DYNAMIC)
78 /**
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  */
85 struct device_node *of_node_get(struct device_node *node)
86 {
87         if (node)
88                 kref_get(&node->kref);
89         return node;
90 }
91 EXPORT_SYMBOL(of_node_get);
92
93 static 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  */
105 static 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  */
144 void of_node_put(struct device_node *node)
145 {
146         if (node)
147                 kref_put(&node->kref, of_node_release);
148 }
149 EXPORT_SYMBOL(of_node_put);
150 #endif /* CONFIG_OF_DYNAMIC */
151
152 static struct property *__of_find_property(const struct device_node *np,
153                                            const char *name, int *lenp)
154 {
155         struct property *pp;
156
157         if (!np)
158                 return NULL;
159
160         for (pp = np->properties; pp; pp = pp->next) {
161                 if (of_prop_cmp(pp->name, name) == 0) {
162                         if (lenp)
163                                 *lenp = pp->length;
164                         break;
165                 }
166         }
167
168         return pp;
169 }
170
171 struct property *of_find_property(const struct device_node *np,
172                                   const char *name,
173                                   int *lenp)
174 {
175         struct property *pp;
176         unsigned long flags;
177
178         raw_spin_lock_irqsave(&devtree_lock, flags);
179         pp = __of_find_property(np, name, lenp);
180         raw_spin_unlock_irqrestore(&devtree_lock, flags);
181
182         return pp;
183 }
184 EXPORT_SYMBOL(of_find_property);
185
186 /**
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  */
194 struct device_node *of_find_all_nodes(struct device_node *prev)
195 {
196         struct device_node *np;
197         unsigned long flags;
198
199         raw_spin_lock_irqsave(&devtree_lock, flags);
200         np = prev ? prev->allnext : of_allnodes;
201         for (; np != NULL; np = np->allnext)
202                 if (of_node_get(np))
203                         break;
204         of_node_put(prev);
205         raw_spin_unlock_irqrestore(&devtree_lock, flags);
206         return np;
207 }
208 EXPORT_SYMBOL(of_find_all_nodes);
209
210 /*
211  * Find a property with a given name for a given node
212  * and return the value.
213  */
214 static 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  */
226 const void *of_get_property(const struct device_node *np, const char *name,
227                             int *lenp)
228 {
229         struct property *pp = of_find_property(np, name, lenp);
230
231         return pp ? pp->value : NULL;
232 }
233 EXPORT_SYMBOL(of_get_property);
234
235 /*
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  */
249 bool __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  */
259 static 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);
268         if (!cell || !ac)
269                 return false;
270         prop_len /= sizeof(*cell) * ac;
271         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
283 /*
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  */
289 bool __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
308 /**
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  */
326 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread)
327 {
328         struct device_node *cpun;
329
330         for_each_node_by_type(cpun, "cpu") {
331                 if (arch_find_n_match_cpu_physical_id(cpun, cpu, thread))
332                         return cpun;
333         }
334         return NULL;
335 }
336 EXPORT_SYMBOL(of_get_cpu_node);
337
338 /** Checks if the given "compat" string matches one of the strings in
339  * the device's "compatible" property
340  */
341 static int __of_device_is_compatible(const struct device_node *device,
342                                      const char *compat)
343 {
344         const char* cp;
345         int cplen, l;
346
347         cp = __of_get_property(device, "compatible", &cplen);
348         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 }
360
361 /** Checks if the given "compat" string matches one of the strings in
362  * the device's "compatible" property
363  */
364 int of_device_is_compatible(const struct device_node *device,
365                 const char *compat)
366 {
367         unsigned long flags;
368         int res;
369
370         raw_spin_lock_irqsave(&devtree_lock, flags);
371         res = __of_device_is_compatible(device, compat);
372         raw_spin_unlock_irqrestore(&devtree_lock, flags);
373         return res;
374 }
375 EXPORT_SYMBOL(of_device_is_compatible);
376
377 /**
378  * of_machine_is_compatible - Test root of device tree for a given compatible value
379  * @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  */
384 int of_machine_is_compatible(const char *compat)
385 {
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 }
396 EXPORT_SYMBOL(of_machine_is_compatible);
397
398 /**
399  *  __of_device_is_available - check if a device is available for use
400  *
401  *  @device: Node to check for availability, with locks already held
402  *
403  *  Returns 1 if the status property is absent or set to "okay" or "ok",
404  *  0 otherwise
405  */
406 static int __of_device_is_available(const struct device_node *device)
407 {
408         const char *status;
409         int statlen;
410
411         status = __of_get_property(device, "status", &statlen);
412         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 }
422
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  */
431 int 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 }
442 EXPORT_SYMBOL(of_device_is_available);
443
444 /**
445  *      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  */
451 struct device_node *of_get_parent(const struct device_node *node)
452 {
453         struct device_node *np;
454         unsigned long flags;
455
456         if (!node)
457                 return NULL;
458
459         raw_spin_lock_irqsave(&devtree_lock, flags);
460         np = of_node_get(node->parent);
461         raw_spin_unlock_irqrestore(&devtree_lock, flags);
462         return np;
463 }
464 EXPORT_SYMBOL(of_get_parent);
465
466 /**
467  *      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  */
477 struct device_node *of_get_next_parent(struct device_node *node)
478 {
479         struct device_node *parent;
480         unsigned long flags;
481
482         if (!node)
483                 return NULL;
484
485         raw_spin_lock_irqsave(&devtree_lock, flags);
486         parent = of_node_get(node->parent);
487         of_node_put(node);
488         raw_spin_unlock_irqrestore(&devtree_lock, flags);
489         return parent;
490 }
491 EXPORT_SYMBOL(of_get_next_parent);
492
493 /**
494  *      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  */
501 struct device_node *of_get_next_child(const struct device_node *node,
502         struct device_node *prev)
503 {
504         struct device_node *next;
505         unsigned long flags;
506
507         raw_spin_lock_irqsave(&devtree_lock, flags);
508         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);
513         raw_spin_unlock_irqrestore(&devtree_lock, flags);
514         return next;
515 }
516 EXPORT_SYMBOL(of_get_next_child);
517
518 /**
519  *      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  */
526 struct device_node *of_get_next_available_child(const struct device_node *node,
527         struct device_node *prev)
528 {
529         struct device_node *next;
530         unsigned long flags;
531
532         raw_spin_lock_irqsave(&devtree_lock, flags);
533         next = prev ? prev->sibling : node->child;
534         for (; next; next = next->sibling) {
535                 if (!__of_device_is_available(next))
536                         continue;
537                 if (of_node_get(next))
538                         break;
539         }
540         of_node_put(prev);
541         raw_spin_unlock_irqrestore(&devtree_lock, flags);
542         return next;
543 }
544 EXPORT_SYMBOL(of_get_next_available_child);
545
546 /**
547  *      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  */
557 struct 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 }
567 EXPORT_SYMBOL(of_get_child_by_name);
568
569 /**
570  *      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  */
576 struct device_node *of_find_node_by_path(const char *path)
577 {
578         struct device_node *np = of_allnodes;
579         unsigned long flags;
580
581         raw_spin_lock_irqsave(&devtree_lock, flags);
582         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         }
587         raw_spin_unlock_irqrestore(&devtree_lock, flags);
588         return np;
589 }
590 EXPORT_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  */
603 struct device_node *of_find_node_by_name(struct device_node *from,
604         const char *name)
605 {
606         struct device_node *np;
607         unsigned long flags;
608
609         raw_spin_lock_irqsave(&devtree_lock, flags);
610         np = from ? from->allnext : of_allnodes;
611         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);
616         raw_spin_unlock_irqrestore(&devtree_lock, flags);
617         return np;
618 }
619 EXPORT_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  */
633 struct device_node *of_find_node_by_type(struct device_node *from,
634         const char *type)
635 {
636         struct device_node *np;
637         unsigned long flags;
638
639         raw_spin_lock_irqsave(&devtree_lock, flags);
640         np = from ? from->allnext : of_allnodes;
641         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);
646         raw_spin_unlock_irqrestore(&devtree_lock, flags);
647         return np;
648 }
649 EXPORT_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  */
665 struct device_node *of_find_compatible_node(struct device_node *from,
666         const char *type, const char *compatible)
667 {
668         struct device_node *np;
669         unsigned long flags;
670
671         raw_spin_lock_irqsave(&devtree_lock, flags);
672         np = from ? from->allnext : of_allnodes;
673         for (; np; np = np->allnext) {
674                 if (type
675                     && !(np->type && (of_node_cmp(np->type, type) == 0)))
676                         continue;
677                 if (__of_device_is_compatible(np, compatible) &&
678                     of_node_get(np))
679                         break;
680         }
681         of_node_put(from);
682         raw_spin_unlock_irqrestore(&devtree_lock, flags);
683         return np;
684 }
685 EXPORT_SYMBOL(of_find_compatible_node);
686
687 /**
688  *      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  */
699 struct 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;
704         unsigned long flags;
705
706         raw_spin_lock_irqsave(&devtree_lock, flags);
707         np = from ? from->allnext : of_allnodes;
708         for (; np; np = np->allnext) {
709                 for (pp = np->properties; pp; pp = pp->next) {
710                         if (of_prop_cmp(pp->name, prop_name) == 0) {
711                                 of_node_get(np);
712                                 goto out;
713                         }
714                 }
715         }
716 out:
717         of_node_put(from);
718         raw_spin_unlock_irqrestore(&devtree_lock, flags);
719         return np;
720 }
721 EXPORT_SYMBOL(of_find_node_with_property);
722
723 static
724 const struct of_device_id *__of_match_node(const struct of_device_id *matches,
725                                            const struct device_node *node)
726 {
727         if (!matches)
728                 return NULL;
729
730         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);
738                 if (matches->compatible[0])
739                         match &= __of_device_is_compatible(node,
740                                                            matches->compatible);
741                 if (match)
742                         return matches;
743                 matches++;
744         }
745         return NULL;
746 }
747
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  */
755 const 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;
759         unsigned long flags;
760
761         raw_spin_lock_irqsave(&devtree_lock, flags);
762         match = __of_match_node(matches, node);
763         raw_spin_unlock_irqrestore(&devtree_lock, flags);
764         return match;
765 }
766 EXPORT_SYMBOL(of_match_node);
767
768 /**
769  *      of_find_matching_node_and_match - Find a node based on an of_device_id
770  *                                        match table.
771  *      @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
776  *      @match          Updated to point at the matches entry which matched
777  *
778  *      Returns a node pointer with refcount incremented, use
779  *      of_node_put() on it when done.
780  */
781 struct 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)
784 {
785         struct device_node *np;
786         const struct of_device_id *m;
787         unsigned long flags;
788
789         if (match)
790                 *match = NULL;
791
792         raw_spin_lock_irqsave(&devtree_lock, flags);
793         np = from ? from->allnext : of_allnodes;
794         for (; np; np = np->allnext) {
795                 m = __of_match_node(matches, np);
796                 if (m && of_node_get(np)) {
797                         if (match)
798                                 *match = m;
799                         break;
800                 }
801         }
802         of_node_put(from);
803         raw_spin_unlock_irqrestore(&devtree_lock, flags);
804         return np;
805 }
806 EXPORT_SYMBOL(of_find_matching_node_and_match);
807
808 /**
809  * 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  *
814  * 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.
818  *
819  * This routine returns 0 on success, <0 on failure.
820  */
821 int of_modalias_node(struct device_node *node, char *modalias, int len)
822 {
823         const char *compatible, *p;
824         int cplen;
825
826         compatible = of_get_property(node, "compatible", &cplen);
827         if (!compatible || strlen(compatible) > cplen)
828                 return -ENODEV;
829         p = strchr(compatible, ',');
830         strlcpy(modalias, p ? p + 1 : compatible, len);
831         return 0;
832 }
833 EXPORT_SYMBOL_GPL(of_modalias_node);
834
835 /**
836  * 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  */
842 struct device_node *of_find_node_by_phandle(phandle handle)
843 {
844         struct device_node *np;
845         unsigned long flags;
846
847         raw_spin_lock_irqsave(&devtree_lock, flags);
848         for (np = of_allnodes; np; np = np->allnext)
849                 if (np->phandle == handle)
850                         break;
851         of_node_get(np);
852         raw_spin_unlock_irqrestore(&devtree_lock, flags);
853         return np;
854 }
855 EXPORT_SYMBOL(of_find_node_by_phandle);
856
857 /**
858  * 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  */
870 static 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 /**
886  * 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  */
900 int of_property_read_u32_index(const struct device_node *np,
901                                        const char *propname,
902                                        u32 index, u32 *out_value)
903 {
904         const u32 *val = of_find_property_value_of_size(np, propname,
905                                         ((index + 1) * sizeof(*out_value)));
906
907         if (IS_ERR(val))
908                 return PTR_ERR(val);
909
910         *out_value = be32_to_cpup(((__be32 *)val) + index);
911         return 0;
912 }
913 EXPORT_SYMBOL_GPL(of_property_read_u32_index);
914
915 /**
916  * 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.
920  * @out_values: pointer to return value, modified only if return value is 0.
921  * @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  *
931  * The out_values is modified only if a valid u8 value can be decoded.
932  */
933 int of_property_read_u8_array(const struct device_node *np,
934                         const char *propname, u8 *out_values, size_t sz)
935 {
936         const u8 *val = of_find_property_value_of_size(np, propname,
937                                                 (sz * sizeof(*out_values)));
938
939         if (IS_ERR(val))
940                 return PTR_ERR(val);
941
942         while (sz--)
943                 *out_values++ = *val++;
944         return 0;
945 }
946 EXPORT_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.
953  * @out_values: pointer to return value, modified only if return value is 0.
954  * @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  *
964  * The out_values is modified only if a valid u16 value can be decoded.
965  */
966 int of_property_read_u16_array(const struct device_node *np,
967                         const char *propname, u16 *out_values, size_t sz)
968 {
969         const __be16 *val = of_find_property_value_of_size(np, propname,
970                                                 (sz * sizeof(*out_values)));
971
972         if (IS_ERR(val))
973                 return PTR_ERR(val);
974
975         while (sz--)
976                 *out_values++ = be16_to_cpup(val++);
977         return 0;
978 }
979 EXPORT_SYMBOL_GPL(of_property_read_u16_array);
980
981 /**
982  * of_property_read_u32_array - Find and read an array of 32 bit integers
983  * from a property.
984  *
985  * @np:         device node from which the property value is to be read.
986  * @propname:   name of the property to be searched.
987  * @out_values: pointer to return value, modified only if return value is 0.
988  * @sz:         number of array elements to read
989  *
990  * Search for a property in a device node and read 32-bit value(s) from
991  * 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  *
995  * The out_values is modified only if a valid u32 value can be decoded.
996  */
997 int of_property_read_u32_array(const struct device_node *np,
998                                const char *propname, u32 *out_values,
999                                size_t sz)
1000 {
1001         const __be32 *val = of_find_property_value_of_size(np, propname,
1002                                                 (sz * sizeof(*out_values)));
1003
1004         if (IS_ERR(val))
1005                 return PTR_ERR(val);
1006
1007         while (sz--)
1008                 *out_values++ = be32_to_cpup(val++);
1009         return 0;
1010 }
1011 EXPORT_SYMBOL_GPL(of_property_read_u32_array);
1012
1013 /**
1014  * 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  */
1026 int of_property_read_u64(const struct device_node *np, const char *propname,
1027                          u64 *out_value)
1028 {
1029         const __be32 *val = of_find_property_value_of_size(np, propname,
1030                                                 sizeof(*out_value));
1031
1032         if (IS_ERR(val))
1033                 return PTR_ERR(val);
1034
1035         *out_value = of_read_number(val, 2);
1036         return 0;
1037 }
1038 EXPORT_SYMBOL_GPL(of_property_read_u64);
1039
1040 /**
1041  * 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  */
1055 int of_property_read_string(struct device_node *np, const char *propname,
1056                                 const char **out_string)
1057 {
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 }
1068 EXPORT_SYMBOL_GPL(of_property_read_string);
1069
1070 /**
1071  * 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  */
1088 int 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;
1107                 if (i++ == index) {
1108                         *output = p;
1109                         return 0;
1110                 }
1111         }
1112         return -ENODATA;
1113 }
1114 EXPORT_SYMBOL_GPL(of_property_read_string_index);
1115
1116 /**
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  */
1125 int 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 }
1151 EXPORT_SYMBOL_GPL(of_property_match_string);
1152
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  */
1165 int 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
1181         for (i = 0; total < prop->length; total += l, p += l, i++)
1182                 l = strlen(p) + 1;
1183
1184         return i;
1185 }
1186 EXPORT_SYMBOL_GPL(of_property_count_strings);
1187
1188 static int __of_parse_phandle_with_args(const struct device_node *np,
1189                                         const char *list_name,
1190                                         const char *cells_name,
1191                                         int cell_count, int index,
1192                                         struct of_phandle_args *out_args)
1193 {
1194         const __be32 *list, *list_end;
1195         int rc = 0, size, cur_index = 0;
1196         uint32_t count = 0;
1197         struct device_node *node = NULL;
1198         phandle phandle;
1199
1200         /* Retrieve the phandle list property */
1201         list = of_get_property(np, list_name, &size);
1202         if (!list)
1203                 return -ENOENT;
1204         list_end = list + size / sizeof(*list);
1205
1206         /* Loop over the phandles until all the requested entry is found */
1207         while (list < list_end) {
1208                 rc = -EINVAL;
1209                 count = 0;
1210
1211                 /*
1212                  * If phandle is 0, then it is an empty entry with no
1213                  * arguments.  Skip forward to the next entry.
1214                  */
1215                 phandle = be32_to_cpup(list++);
1216                 if (phandle) {
1217                         /*
1218                          * Find the provider node and parse the #*-cells
1219                          * 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.
1225                          */
1226                         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                                 }
1233                         }
1234
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;
1245                         }
1246
1247                         /*
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);
1254                                 goto err;
1255                         }
1256                 }
1257
1258                 /*
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                  */
1264                 rc = -ENOENT;
1265                 if (cur_index == index) {
1266                         if (!phandle)
1267                                 goto err;
1268
1269                         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++);
1277                         } else {
1278                                 of_node_put(node);
1279                         }
1280
1281                         /* Found it! return success */
1282                         return 0;
1283                 }
1284
1285                 of_node_put(node);
1286                 node = NULL;
1287                 list += count;
1288                 cur_index++;
1289         }
1290
1291         /*
1292          * Unlock node before returning result; will be one of:
1293          * -ENOENT : index is for empty phandle
1294          * -EINVAL : parsing error on data
1295          * [1..n]  : Number of phandle (count mode; when index = -1)
1296          */
1297         rc = index < 0 ? cur_index : -ENOENT;
1298  err:
1299         if (node)
1300                 of_node_put(node);
1301         return rc;
1302 }
1303
1304 /**
1305  * 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  */
1314 struct device_node *of_parse_phandle(const struct device_node *np,
1315                                      const char *phandle_name, int index)
1316 {
1317         struct of_phandle_args args;
1318
1319         if (index < 0)
1320                 return NULL;
1321
1322         if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0,
1323                                          index, &args))
1324                 return NULL;
1325
1326         return args.np;
1327 }
1328 EXPORT_SYMBOL(of_parse_phandle);
1329
1330 /**
1331  * 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  */
1362 int 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;
1368         return __of_parse_phandle_with_args(np, list_name, cells_name, 0,
1369                                             index, out_args);
1370 }
1371 EXPORT_SYMBOL(of_parse_phandle_with_args);
1372
1373 /**
1374  * 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  */
1403 int 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 }
1412 EXPORT_SYMBOL(of_parse_phandle_with_fixed_args);
1413
1414 /**
1415  * 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  */
1429 int of_count_phandle_with_args(const struct device_node *np, const char *list_name,
1430                                 const char *cells_name)
1431 {
1432         return __of_parse_phandle_with_args(np, list_name, cells_name, 0, -1,
1433                                             NULL);
1434 }
1435 EXPORT_SYMBOL(of_count_phandle_with_args);
1436
1437 #if defined(CONFIG_OF_DYNAMIC)
1438 static 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
1448 static int of_property_notify(int action, struct device_node *np,
1449                               struct property *prop)
1450 {
1451         return 0;
1452 }
1453 #endif
1454
1455 /**
1456  * of_add_property - Add a property to a node
1457  */
1458 int of_add_property(struct device_node *np, struct property *prop)
1459 {
1460         struct property **next;
1461         unsigned long flags;
1462         int rc;
1463
1464         rc = of_property_notify(OF_RECONFIG_ADD_PROPERTY, np, prop);
1465         if (rc)
1466                 return rc;
1467
1468         prop->next = NULL;
1469         raw_spin_lock_irqsave(&devtree_lock, flags);
1470         next = &np->properties;
1471         while (*next) {
1472                 if (strcmp(prop->name, (*next)->name) == 0) {
1473                         /* duplicate ! don't insert it */
1474                         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1475                         return -1;
1476                 }
1477                 next = &(*next)->next;
1478         }
1479         *next = prop;
1480         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1481
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 /**
1492  * of_remove_property - Remove a property from a node.
1493  *
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  */
1499 int of_remove_property(struct device_node *np, struct property *prop)
1500 {
1501         struct property **next;
1502         unsigned long flags;
1503         int found = 0;
1504         int rc;
1505
1506         rc = of_property_notify(OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1507         if (rc)
1508                 return rc;
1509
1510         raw_spin_lock_irqsave(&devtree_lock, flags);
1511         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         }
1523         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1524
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 /*
1538  * of_update_property - Update a property in a node, if the property does
1539  * not exist, add it.
1540  *
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  */
1546 int of_update_property(struct device_node *np, struct property *newprop)
1547 {
1548         struct property **next, *oldprop;
1549         unsigned long flags;
1550         int rc, found = 0;
1551
1552         rc = of_property_notify(OF_RECONFIG_UPDATE_PROPERTY, np, newprop);
1553         if (rc)
1554                 return rc;
1555
1556         if (!newprop->name)
1557                 return -EINVAL;
1558
1559         oldprop = of_find_property(np, newprop->name, NULL);
1560         if (!oldprop)
1561                 return of_add_property(np, newprop);
1562
1563         raw_spin_lock_irqsave(&devtree_lock, flags);
1564         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         }
1577         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1578
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 }
1590
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
1600 static BLOCKING_NOTIFIER_HEAD(of_reconfig_chain);
1601
1602 int of_reconfig_notifier_register(struct notifier_block *nb)
1603 {
1604         return blocking_notifier_chain_register(&of_reconfig_chain, nb);
1605 }
1606 EXPORT_SYMBOL_GPL(of_reconfig_notifier_register);
1607
1608 int of_reconfig_notifier_unregister(struct notifier_block *nb)
1609 {
1610         return blocking_notifier_chain_unregister(&of_reconfig_chain, nb);
1611 }
1612 EXPORT_SYMBOL_GPL(of_reconfig_notifier_unregister);
1613
1614 int 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
1622 #ifdef CONFIG_PROC_DEVICETREE
1623 static 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
1632 static void of_add_proc_dt_entry(struct device_node *dn)
1633 {
1634         return;
1635 }
1636 #endif
1637
1638 /**
1639  * of_attach_node - Plug a device node into the tree and global list.
1640  */
1641 int of_attach_node(struct device_node *np)
1642 {
1643         unsigned long flags;
1644         int rc;
1645
1646         rc = of_reconfig_notify(OF_RECONFIG_ATTACH_NODE, np);
1647         if (rc)
1648                 return rc;
1649
1650         raw_spin_lock_irqsave(&devtree_lock, flags);
1651         np->sibling = np->parent->child;
1652         np->allnext = of_allnodes;
1653         np->parent->child = np;
1654         of_allnodes = np;
1655         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1656
1657         of_add_proc_dt_entry(np);
1658         return 0;
1659 }
1660
1661 #ifdef CONFIG_PROC_DEVICETREE
1662 static void of_remove_proc_dt_entry(struct device_node *dn)
1663 {
1664         proc_remove(dn->pde);
1665 }
1666 #else
1667 static void of_remove_proc_dt_entry(struct device_node *dn)
1668 {
1669         return;
1670 }
1671 #endif
1672
1673 /**
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  */
1679 int of_detach_node(struct device_node *np)
1680 {
1681         struct device_node *parent;
1682         unsigned long flags;
1683         int rc = 0;
1684
1685         rc = of_reconfig_notify(OF_RECONFIG_DETACH_NODE, np);
1686         if (rc)
1687                 return rc;
1688
1689         raw_spin_lock_irqsave(&devtree_lock, flags);
1690
1691         if (of_node_check_flag(np, OF_DETACHED)) {
1692                 /* someone already detached it */
1693                 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1694                 return rc;
1695         }
1696
1697         parent = np->parent;
1698         if (!parent) {
1699                 raw_spin_unlock_irqrestore(&devtree_lock, flags);
1700                 return rc;
1701         }
1702
1703         if (of_allnodes == np)
1704                 of_allnodes = np->allnext;
1705         else {
1706                 struct device_node *prev;
1707                 for (prev = of_allnodes;
1708                      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);
1726         raw_spin_unlock_irqrestore(&devtree_lock, flags);
1727
1728         of_remove_proc_dt_entry(np);
1729         return rc;
1730 }
1731 #endif /* defined(CONFIG_OF_DYNAMIC) */
1732
1733 static 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",
1742                  ap->alias, ap->stem, ap->id, of_node_full_name(np));
1743 }
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  */
1755 void 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");
1762
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
1771         of_aliases = of_find_node_by_path("/aliases");
1772         if (!of_aliases)
1773                 return;
1774
1775         for_each_property_of_node(of_aliases, pp) {
1776                 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;
1805                 memset(ap, 0, sizeof(*ap) + len + 1);
1806                 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  */
1819 int 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 }
1838 EXPORT_SYMBOL_GPL(of_alias_get_id);
1839
1840 const __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
1857 out_val:
1858         *pu = be32_to_cpup(curv);
1859         return curv;
1860 }
1861 EXPORT_SYMBOL_GPL(of_prop_next_u32);
1862
1863 const 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 }
1879 EXPORT_SYMBOL_GPL(of_prop_next_string);
1880
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  */
1888 int of_device_is_stdout_path(struct device_node *dn)
1889 {
1890         if (!of_stdout)
1891                 return false;
1892
1893         return of_stdout == dn;
1894 }
1895 EXPORT_SYMBOL_GPL(of_device_is_stdout_path);