dm: core: Create a new header file for 'compat' features
[oweals/u-boot.git] / drivers / core / of_access.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Originally from Linux v4.9
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  * Modified for U-Boot
16  * Copyright (c) 2017 Google, Inc
17  *
18  * This file follows drivers/of/base.c with functions in the same order as the
19  * Linux version.
20  */
21
22 #include <common.h>
23 #include <malloc.h>
24 #include <linux/libfdt.h>
25 #include <dm/of_access.h>
26 #include <linux/ctype.h>
27 #include <linux/err.h>
28 #include <linux/ioport.h>
29
30 DECLARE_GLOBAL_DATA_PTR;
31
32 /* list of struct alias_prop aliases */
33 LIST_HEAD(aliases_lookup);
34
35 /* "/aliaes" node */
36 static struct device_node *of_aliases;
37
38 /* "/chosen" node */
39 static struct device_node *of_chosen;
40
41 /* node pointed to by the stdout-path alias */
42 static struct device_node *of_stdout;
43
44 /* pointer to options given after the alias (separated by :) or NULL if none */
45 static const char *of_stdout_options;
46
47 /**
48  * struct alias_prop - Alias property in 'aliases' node
49  *
50  * The structure represents one alias property of 'aliases' node as
51  * an entry in aliases_lookup list.
52  *
53  * @link:       List node to link the structure in aliases_lookup list
54  * @alias:      Alias property name
55  * @np:         Pointer to device_node that the alias stands for
56  * @id:         Index value from end of alias name
57  * @stem:       Alias string without the index
58  */
59 struct alias_prop {
60         struct list_head link;
61         const char *alias;
62         struct device_node *np;
63         int id;
64         char stem[0];
65 };
66
67 int of_n_addr_cells(const struct device_node *np)
68 {
69         const __be32 *ip;
70
71         do {
72                 if (np->parent)
73                         np = np->parent;
74                 ip = of_get_property(np, "#address-cells", NULL);
75                 if (ip)
76                         return be32_to_cpup(ip);
77         } while (np->parent);
78
79         /* No #address-cells property for the root node */
80         return OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
81 }
82
83 int of_n_size_cells(const struct device_node *np)
84 {
85         const __be32 *ip;
86
87         do {
88                 if (np->parent)
89                         np = np->parent;
90                 ip = of_get_property(np, "#size-cells", NULL);
91                 if (ip)
92                         return be32_to_cpup(ip);
93         } while (np->parent);
94
95         /* No #size-cells property for the root node */
96         return OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
97 }
98
99 int of_simple_addr_cells(const struct device_node *np)
100 {
101         const __be32 *ip;
102
103         ip = of_get_property(np, "#address-cells", NULL);
104         if (ip)
105                 return be32_to_cpup(ip);
106
107         /* Return a default of 2 to match fdt_address_cells()*/
108         return 2;
109 }
110
111 int of_simple_size_cells(const struct device_node *np)
112 {
113         const __be32 *ip;
114
115         ip = of_get_property(np, "#size-cells", NULL);
116         if (ip)
117                 return be32_to_cpup(ip);
118
119         /* Return a default of 2 to match fdt_size_cells()*/
120         return 2;
121 }
122
123 struct property *of_find_property(const struct device_node *np,
124                                   const char *name, int *lenp)
125 {
126         struct property *pp;
127
128         if (!np)
129                 return NULL;
130
131         for (pp = np->properties; pp; pp = pp->next) {
132                 if (strcmp(pp->name, name) == 0) {
133                         if (lenp)
134                                 *lenp = pp->length;
135                         break;
136                 }
137         }
138         if (!pp && lenp)
139                 *lenp = -FDT_ERR_NOTFOUND;
140
141         return pp;
142 }
143
144 struct device_node *of_find_all_nodes(struct device_node *prev)
145 {
146         struct device_node *np;
147
148         if (!prev) {
149                 np = gd->of_root;
150         } else if (prev->child) {
151                 np = prev->child;
152         } else {
153                 /*
154                  * Walk back up looking for a sibling, or the end of the
155                  * structure
156                  */
157                 np = prev;
158                 while (np->parent && !np->sibling)
159                         np = np->parent;
160                 np = np->sibling; /* Might be null at the end of the tree */
161         }
162
163         return np;
164 }
165
166 const void *of_get_property(const struct device_node *np, const char *name,
167                             int *lenp)
168 {
169         struct property *pp = of_find_property(np, name, lenp);
170
171         return pp ? pp->value : NULL;
172 }
173
174 static const char *of_prop_next_string(struct property *prop, const char *cur)
175 {
176         const void *curv = cur;
177
178         if (!prop)
179                 return NULL;
180
181         if (!cur)
182                 return prop->value;
183
184         curv += strlen(cur) + 1;
185         if (curv >= prop->value + prop->length)
186                 return NULL;
187
188         return curv;
189 }
190
191 int of_device_is_compatible(const struct device_node *device,
192                             const char *compat, const char *type,
193                             const char *name)
194 {
195         struct property *prop;
196         const char *cp;
197         int index = 0, score = 0;
198
199         /* Compatible match has highest priority */
200         if (compat && compat[0]) {
201                 prop = of_find_property(device, "compatible", NULL);
202                 for (cp = of_prop_next_string(prop, NULL); cp;
203                      cp = of_prop_next_string(prop, cp), index++) {
204                         if (of_compat_cmp(cp, compat, strlen(compat)) == 0) {
205                                 score = INT_MAX/2 - (index << 2);
206                                 break;
207                         }
208                 }
209                 if (!score)
210                         return 0;
211         }
212
213         /* Matching type is better than matching name */
214         if (type && type[0]) {
215                 if (!device->type || of_node_cmp(type, device->type))
216                         return 0;
217                 score += 2;
218         }
219
220         /* Matching name is a bit better than not */
221         if (name && name[0]) {
222                 if (!device->name || of_node_cmp(name, device->name))
223                         return 0;
224                 score++;
225         }
226
227         return score;
228 }
229
230 bool of_device_is_available(const struct device_node *device)
231 {
232         const char *status;
233         int statlen;
234
235         if (!device)
236                 return false;
237
238         status = of_get_property(device, "status", &statlen);
239         if (status == NULL)
240                 return true;
241
242         if (statlen > 0) {
243                 if (!strcmp(status, "okay"))
244                         return true;
245         }
246
247         return false;
248 }
249
250 struct device_node *of_get_parent(const struct device_node *node)
251 {
252         const struct device_node *np;
253
254         if (!node)
255                 return NULL;
256
257         np = of_node_get(node->parent);
258
259         return (struct device_node *)np;
260 }
261
262 static struct device_node *__of_get_next_child(const struct device_node *node,
263                                                struct device_node *prev)
264 {
265         struct device_node *next;
266
267         if (!node)
268                 return NULL;
269
270         next = prev ? prev->sibling : node->child;
271         /*
272          * coverity[dead_error_line : FALSE]
273          * Dead code here since our current implementation of of_node_get()
274          * always returns NULL (Coverity CID 163245). But we leave it as is
275          * since we may want to implement get/put later.
276          */
277         for (; next; next = next->sibling)
278                 if (of_node_get(next))
279                         break;
280         of_node_put(prev);
281         return next;
282 }
283
284 #define __for_each_child_of_node(parent, child) \
285         for (child = __of_get_next_child(parent, NULL); child != NULL; \
286              child = __of_get_next_child(parent, child))
287
288 static struct device_node *__of_find_node_by_path(struct device_node *parent,
289                                                   const char *path)
290 {
291         struct device_node *child;
292         int len;
293
294         len = strcspn(path, "/:");
295         if (!len)
296                 return NULL;
297
298         __for_each_child_of_node(parent, child) {
299                 const char *name = strrchr(child->full_name, '/');
300
301                 name++;
302                 if (strncmp(path, name, len) == 0 && (strlen(name) == len))
303                         return child;
304         }
305         return NULL;
306 }
307
308 #define for_each_property_of_node(dn, pp) \
309         for (pp = dn->properties; pp != NULL; pp = pp->next)
310
311 struct device_node *of_find_node_opts_by_path(const char *path,
312                                               const char **opts)
313 {
314         struct device_node *np = NULL;
315         struct property *pp;
316         const char *separator = strchr(path, ':');
317
318         if (opts)
319                 *opts = separator ? separator + 1 : NULL;
320
321         if (strcmp(path, "/") == 0)
322                 return of_node_get(gd->of_root);
323
324         /* The path could begin with an alias */
325         if (*path != '/') {
326                 int len;
327                 const char *p = separator;
328
329                 if (!p)
330                         p = strchrnul(path, '/');
331                 len = p - path;
332
333                 /* of_aliases must not be NULL */
334                 if (!of_aliases)
335                         return NULL;
336
337                 for_each_property_of_node(of_aliases, pp) {
338                         if (strlen(pp->name) == len && !strncmp(pp->name, path,
339                                                                 len)) {
340                                 np = of_find_node_by_path(pp->value);
341                                 break;
342                         }
343                 }
344                 if (!np)
345                         return NULL;
346                 path = p;
347         }
348
349         /* Step down the tree matching path components */
350         if (!np)
351                 np = of_node_get(gd->of_root);
352         while (np && *path == '/') {
353                 struct device_node *tmp = np;
354
355                 path++; /* Increment past '/' delimiter */
356                 np = __of_find_node_by_path(np, path);
357                 of_node_put(tmp);
358                 path = strchrnul(path, '/');
359                 if (separator && separator < path)
360                         break;
361         }
362
363         return np;
364 }
365
366 struct device_node *of_find_compatible_node(struct device_node *from,
367                 const char *type, const char *compatible)
368 {
369         struct device_node *np;
370
371         for_each_of_allnodes_from(from, np)
372                 if (of_device_is_compatible(np, compatible, type, NULL) &&
373                     of_node_get(np))
374                         break;
375         of_node_put(from);
376
377         return np;
378 }
379
380 static int of_device_has_prop_value(const struct device_node *device,
381                                     const char *propname, const void *propval,
382                                     int proplen)
383 {
384         struct property *prop = of_find_property(device, propname, NULL);
385
386         if (!prop || !prop->value || prop->length != proplen)
387                 return 0;
388         return !memcmp(prop->value, propval, proplen);
389 }
390
391 struct device_node *of_find_node_by_prop_value(struct device_node *from,
392                                                const char *propname,
393                                                const void *propval, int proplen)
394 {
395         struct device_node *np;
396
397         for_each_of_allnodes_from(from, np) {
398                 if (of_device_has_prop_value(np, propname, propval, proplen) &&
399                     of_node_get(np))
400                         break;
401         }
402         of_node_put(from);
403
404         return np;
405 }
406
407 struct device_node *of_find_node_by_phandle(phandle handle)
408 {
409         struct device_node *np;
410
411         if (!handle)
412                 return NULL;
413
414         for_each_of_allnodes(np)
415                 if (np->phandle == handle)
416                         break;
417         (void)of_node_get(np);
418
419         return np;
420 }
421
422 /**
423  * of_find_property_value_of_size() - find property of given size
424  *
425  * Search for a property in a device node and validate the requested size.
426  *
427  * @np:         device node from which the property value is to be read.
428  * @propname:   name of the property to be searched.
429  * @len:        requested length of property value
430  *
431  * @return the property value on success, -EINVAL if the property does not
432  * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
433  * property data isn't large enough.
434  */
435 static void *of_find_property_value_of_size(const struct device_node *np,
436                                             const char *propname, u32 len)
437 {
438         struct property *prop = of_find_property(np, propname, NULL);
439
440         if (!prop)
441                 return ERR_PTR(-EINVAL);
442         if (!prop->value)
443                 return ERR_PTR(-ENODATA);
444         if (len > prop->length)
445                 return ERR_PTR(-EOVERFLOW);
446
447         return prop->value;
448 }
449
450 int of_read_u32(const struct device_node *np, const char *propname, u32 *outp)
451 {
452         const __be32 *val;
453
454         debug("%s: %s: ", __func__, propname);
455         if (!np)
456                 return -EINVAL;
457         val = of_find_property_value_of_size(np, propname, sizeof(*outp));
458         if (IS_ERR(val)) {
459                 debug("(not found)\n");
460                 return PTR_ERR(val);
461         }
462
463         *outp = be32_to_cpup(val);
464         debug("%#x (%d)\n", *outp, *outp);
465
466         return 0;
467 }
468
469 int of_read_u32_array(const struct device_node *np, const char *propname,
470                       u32 *out_values, size_t sz)
471 {
472         const __be32 *val;
473
474         debug("%s: %s: ", __func__, propname);
475         val = of_find_property_value_of_size(np, propname,
476                                              sz * sizeof(*out_values));
477
478         if (IS_ERR(val))
479                 return PTR_ERR(val);
480
481         debug("size %zd\n", sz);
482         while (sz--)
483                 *out_values++ = be32_to_cpup(val++);
484
485         return 0;
486 }
487
488 int of_read_u64(const struct device_node *np, const char *propname, u64 *outp)
489 {
490         const __be64 *val;
491
492         debug("%s: %s: ", __func__, propname);
493         if (!np)
494                 return -EINVAL;
495         val = of_find_property_value_of_size(np, propname, sizeof(*outp));
496         if (IS_ERR(val)) {
497                 debug("(not found)\n");
498                 return PTR_ERR(val);
499         }
500
501         *outp = be64_to_cpup(val);
502         debug("%#llx (%lld)\n", (unsigned long long)*outp,
503               (unsigned long long)*outp);
504
505         return 0;
506 }
507
508 int of_property_match_string(const struct device_node *np, const char *propname,
509                              const char *string)
510 {
511         const struct property *prop = of_find_property(np, propname, NULL);
512         size_t l;
513         int i;
514         const char *p, *end;
515
516         if (!prop)
517                 return -EINVAL;
518         if (!prop->value)
519                 return -ENODATA;
520
521         p = prop->value;
522         end = p + prop->length;
523
524         for (i = 0; p < end; i++, p += l) {
525                 l = strnlen(p, end - p) + 1;
526                 if (p + l > end)
527                         return -EILSEQ;
528                 debug("comparing %s with %s\n", string, p);
529                 if (strcmp(string, p) == 0)
530                         return i; /* Found it; return index */
531         }
532         return -ENODATA;
533 }
534
535 /**
536  * of_property_read_string_helper() - Utility helper for parsing string properties
537  * @np:         device node from which the property value is to be read.
538  * @propname:   name of the property to be searched.
539  * @out_strs:   output array of string pointers.
540  * @sz:         number of array elements to read.
541  * @skip:       Number of strings to skip over at beginning of list.
542  *
543  * Don't call this function directly. It is a utility helper for the
544  * of_property_read_string*() family of functions.
545  */
546 int of_property_read_string_helper(const struct device_node *np,
547                                    const char *propname, const char **out_strs,
548                                    size_t sz, int skip)
549 {
550         const struct property *prop = of_find_property(np, propname, NULL);
551         int l = 0, i = 0;
552         const char *p, *end;
553
554         if (!prop)
555                 return -EINVAL;
556         if (!prop->value)
557                 return -ENODATA;
558         p = prop->value;
559         end = p + prop->length;
560
561         for (i = 0; p < end && (!out_strs || i < skip + sz); i++, p += l) {
562                 l = strnlen(p, end - p) + 1;
563                 if (p + l > end)
564                         return -EILSEQ;
565                 if (out_strs && i >= skip)
566                         *out_strs++ = p;
567         }
568         i -= skip;
569         return i <= 0 ? -ENODATA : i;
570 }
571
572 static int __of_parse_phandle_with_args(const struct device_node *np,
573                                         const char *list_name,
574                                         const char *cells_name,
575                                         int cell_count, int index,
576                                         struct of_phandle_args *out_args)
577 {
578         const __be32 *list, *list_end;
579         int rc = 0, cur_index = 0;
580         uint32_t count = 0;
581         struct device_node *node = NULL;
582         phandle phandle;
583         int size;
584
585         /* Retrieve the phandle list property */
586         list = of_get_property(np, list_name, &size);
587         if (!list)
588                 return -ENOENT;
589         list_end = list + size / sizeof(*list);
590
591         /* Loop over the phandles until all the requested entry is found */
592         while (list < list_end) {
593                 rc = -EINVAL;
594                 count = 0;
595
596                 /*
597                  * If phandle is 0, then it is an empty entry with no
598                  * arguments.  Skip forward to the next entry.
599                  */
600                 phandle = be32_to_cpup(list++);
601                 if (phandle) {
602                         /*
603                          * Find the provider node and parse the #*-cells
604                          * property to determine the argument length.
605                          *
606                          * This is not needed if the cell count is hard-coded
607                          * (i.e. cells_name not set, but cell_count is set),
608                          * except when we're going to return the found node
609                          * below.
610                          */
611                         if (cells_name || cur_index == index) {
612                                 node = of_find_node_by_phandle(phandle);
613                                 if (!node) {
614                                         debug("%s: could not find phandle\n",
615                                               np->full_name);
616                                         goto err;
617                                 }
618                         }
619
620                         if (cells_name) {
621                                 if (of_read_u32(node, cells_name, &count)) {
622                                         debug("%s: could not get %s for %s\n",
623                                               np->full_name, cells_name,
624                                               node->full_name);
625                                         goto err;
626                                 }
627                         } else {
628                                 count = cell_count;
629                         }
630
631                         /*
632                          * Make sure that the arguments actually fit in the
633                          * remaining property data length
634                          */
635                         if (list + count > list_end) {
636                                 debug("%s: arguments longer than property\n",
637                                       np->full_name);
638                                 goto err;
639                         }
640                 }
641
642                 /*
643                  * All of the error cases above bail out of the loop, so at
644                  * this point, the parsing is successful. If the requested
645                  * index matches, then fill the out_args structure and return,
646                  * or return -ENOENT for an empty entry.
647                  */
648                 rc = -ENOENT;
649                 if (cur_index == index) {
650                         if (!phandle)
651                                 goto err;
652
653                         if (out_args) {
654                                 int i;
655                                 if (WARN_ON(count > OF_MAX_PHANDLE_ARGS))
656                                         count = OF_MAX_PHANDLE_ARGS;
657                                 out_args->np = node;
658                                 out_args->args_count = count;
659                                 for (i = 0; i < count; i++)
660                                         out_args->args[i] =
661                                                         be32_to_cpup(list++);
662                         } else {
663                                 of_node_put(node);
664                         }
665
666                         /* Found it! return success */
667                         return 0;
668                 }
669
670                 of_node_put(node);
671                 node = NULL;
672                 list += count;
673                 cur_index++;
674         }
675
676         /*
677          * Unlock node before returning result; will be one of:
678          * -ENOENT : index is for empty phandle
679          * -EINVAL : parsing error on data
680          * [1..n]  : Number of phandle (count mode; when index = -1)
681          */
682         rc = index < 0 ? cur_index : -ENOENT;
683  err:
684         if (node)
685                 of_node_put(node);
686         return rc;
687 }
688
689 struct device_node *of_parse_phandle(const struct device_node *np,
690                                      const char *phandle_name, int index)
691 {
692         struct of_phandle_args args;
693
694         if (index < 0)
695                 return NULL;
696
697         if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0, index,
698                                          &args))
699                 return NULL;
700
701         return args.np;
702 }
703
704 int of_parse_phandle_with_args(const struct device_node *np,
705                                const char *list_name, const char *cells_name,
706                                int index, struct of_phandle_args *out_args)
707 {
708         if (index < 0)
709                 return -EINVAL;
710
711         return __of_parse_phandle_with_args(np, list_name, cells_name, 0,
712                                             index, out_args);
713 }
714
715 int of_count_phandle_with_args(const struct device_node *np,
716                                const char *list_name, const char *cells_name)
717 {
718         return __of_parse_phandle_with_args(np, list_name, cells_name, 0,
719                                             -1, NULL);
720 }
721
722 static void of_alias_add(struct alias_prop *ap, struct device_node *np,
723                          int id, const char *stem, int stem_len)
724 {
725         ap->np = np;
726         ap->id = id;
727         strncpy(ap->stem, stem, stem_len);
728         ap->stem[stem_len] = 0;
729         list_add_tail(&ap->link, &aliases_lookup);
730         debug("adding DT alias:%s: stem=%s id=%i node=%s\n",
731               ap->alias, ap->stem, ap->id, of_node_full_name(np));
732 }
733
734 int of_alias_scan(void)
735 {
736         struct property *pp;
737
738         of_aliases = of_find_node_by_path("/aliases");
739         of_chosen = of_find_node_by_path("/chosen");
740         if (of_chosen == NULL)
741                 of_chosen = of_find_node_by_path("/chosen@0");
742
743         if (of_chosen) {
744                 const char *name;
745
746                 name = of_get_property(of_chosen, "stdout-path", NULL);
747                 if (name)
748                         of_stdout = of_find_node_opts_by_path(name,
749                                                         &of_stdout_options);
750         }
751
752         if (!of_aliases)
753                 return 0;
754
755         for_each_property_of_node(of_aliases, pp) {
756                 const char *start = pp->name;
757                 const char *end = start + strlen(start);
758                 struct device_node *np;
759                 struct alias_prop *ap;
760                 ulong id;
761                 int len;
762
763                 /* Skip those we do not want to proceed */
764                 if (!strcmp(pp->name, "name") ||
765                     !strcmp(pp->name, "phandle") ||
766                     !strcmp(pp->name, "linux,phandle"))
767                         continue;
768
769                 np = of_find_node_by_path(pp->value);
770                 if (!np)
771                         continue;
772
773                 /*
774                  * walk the alias backwards to extract the id and work out
775                  * the 'stem' string
776                  */
777                 while (isdigit(*(end-1)) && end > start)
778                         end--;
779                 len = end - start;
780
781                 if (strict_strtoul(end, 10, &id) < 0)
782                         continue;
783
784                 /* Allocate an alias_prop with enough space for the stem */
785                 ap = malloc(sizeof(*ap) + len + 1);
786                 if (!ap)
787                         return -ENOMEM;
788                 memset(ap, 0, sizeof(*ap) + len + 1);
789                 ap->alias = start;
790                 of_alias_add(ap, np, id, start, len);
791         }
792
793         return 0;
794 }
795
796 int of_alias_get_id(const struct device_node *np, const char *stem)
797 {
798         struct alias_prop *app;
799         int id = -ENODEV;
800
801         mutex_lock(&of_mutex);
802         list_for_each_entry(app, &aliases_lookup, link) {
803                 if (strcmp(app->stem, stem) != 0)
804                         continue;
805
806                 if (np == app->np) {
807                         id = app->id;
808                         break;
809                 }
810         }
811         mutex_unlock(&of_mutex);
812
813         return id;
814 }
815
816 int of_alias_get_highest_id(const char *stem)
817 {
818         struct alias_prop *app;
819         int id = -1;
820
821         mutex_lock(&of_mutex);
822         list_for_each_entry(app, &aliases_lookup, link) {
823                 if (strcmp(app->stem, stem) != 0)
824                         continue;
825
826                 if (app->id > id)
827                         id = app->id;
828         }
829         mutex_unlock(&of_mutex);
830
831         return id;
832 }
833
834 struct device_node *of_get_stdout(void)
835 {
836         return of_stdout;
837 }