1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2017 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
10 #include <fdt_support.h>
11 #include <linux/libfdt.h>
12 #include <dm/of_access.h>
13 #include <dm/of_addr.h>
14 #include <dm/ofnode.h>
15 #include <linux/err.h>
16 #include <linux/ioport.h>
18 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp)
20 assert(ofnode_valid(node));
21 debug("%s: %s: ", __func__, propname);
23 if (ofnode_is_np(node)) {
24 return of_read_u32(ofnode_to_np(node), propname, outp);
29 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
31 if (!cell || len < sizeof(int)) {
32 debug("(not found)\n");
35 *outp = fdt32_to_cpu(cell[0]);
37 debug("%#x (%d)\n", *outp, *outp);
42 u32 ofnode_read_u32_default(ofnode node, const char *propname, u32 def)
44 assert(ofnode_valid(node));
45 ofnode_read_u32(node, propname, &def);
50 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def)
52 assert(ofnode_valid(node));
53 ofnode_read_u32(node, propname, (u32 *)&def);
58 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp)
60 const unaligned_fdt64_t *cell;
63 assert(ofnode_valid(node));
64 debug("%s: %s: ", __func__, propname);
66 if (ofnode_is_np(node))
67 return of_read_u64(ofnode_to_np(node), propname, outp);
69 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
71 if (!cell || len < sizeof(*cell)) {
72 debug("(not found)\n");
75 *outp = fdt64_to_cpu(cell[0]);
76 debug("%#llx (%lld)\n", (unsigned long long)*outp,
77 (unsigned long long)*outp);
82 u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def)
84 assert(ofnode_valid(node));
85 ofnode_read_u64(node, propname, &def);
90 bool ofnode_read_bool(ofnode node, const char *propname)
94 assert(ofnode_valid(node));
95 debug("%s: %s: ", __func__, propname);
97 prop = ofnode_get_property(node, propname, NULL);
99 debug("%s\n", prop ? "true" : "false");
101 return prop ? true : false;
104 const void *ofnode_read_prop(ofnode node, const char *propname, int *sizep)
106 const char *val = NULL;
109 assert(ofnode_valid(node));
110 debug("%s: %s: ", __func__, propname);
112 if (ofnode_is_np(node)) {
113 struct property *prop = of_find_property(
114 ofnode_to_np(node), propname, &len);
121 val = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
125 debug("<not found>\n");
127 *sizep = -FDT_ERR_NOTFOUND;
136 const char *ofnode_read_string(ofnode node, const char *propname)
141 str = ofnode_read_prop(node, propname, &len);
145 if (strnlen(str, len) >= len) {
146 debug("<invalid>\n");
154 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name)
158 assert(ofnode_valid(node));
159 debug("%s: %s: ", __func__, subnode_name);
161 if (ofnode_is_np(node)) {
162 const struct device_node *np = ofnode_to_np(node);
164 for (np = np->child; np; np = np->sibling) {
165 if (!strcmp(subnode_name, np->name))
168 subnode = np_to_ofnode(np);
170 int ooffset = fdt_subnode_offset(gd->fdt_blob,
171 ofnode_to_offset(node), subnode_name);
172 subnode = offset_to_ofnode(ooffset);
174 debug("%s\n", ofnode_valid(subnode) ?
175 ofnode_get_name(subnode) : "<none>");
180 int ofnode_read_u32_array(ofnode node, const char *propname,
181 u32 *out_values, size_t sz)
183 assert(ofnode_valid(node));
184 debug("%s: %s: ", __func__, propname);
186 if (ofnode_is_np(node)) {
187 return of_read_u32_array(ofnode_to_np(node), propname,
190 return fdtdec_get_int_array(gd->fdt_blob,
191 ofnode_to_offset(node), propname,
196 ofnode ofnode_first_subnode(ofnode node)
198 assert(ofnode_valid(node));
199 if (ofnode_is_np(node))
200 return np_to_ofnode(node.np->child);
202 return offset_to_ofnode(
203 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
206 ofnode ofnode_next_subnode(ofnode node)
208 assert(ofnode_valid(node));
209 if (ofnode_is_np(node))
210 return np_to_ofnode(node.np->sibling);
212 return offset_to_ofnode(
213 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
216 ofnode ofnode_get_parent(ofnode node)
220 assert(ofnode_valid(node));
221 if (ofnode_is_np(node))
222 parent = np_to_ofnode(of_get_parent(ofnode_to_np(node)));
224 parent.of_offset = fdt_parent_offset(gd->fdt_blob,
225 ofnode_to_offset(node));
230 const char *ofnode_get_name(ofnode node)
232 if (!ofnode_valid(node)) {
233 debug("%s node not valid\n", __func__);
237 if (ofnode_is_np(node))
238 return strrchr(node.np->full_name, '/') + 1;
240 return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
243 ofnode ofnode_get_by_phandle(uint phandle)
247 if (of_live_active())
248 node = np_to_ofnode(of_find_node_by_phandle(phandle));
250 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
256 int ofnode_read_size(ofnode node, const char *propname)
260 if (ofnode_is_np(node)) {
261 struct property *prop = of_find_property(
262 ofnode_to_np(node), propname, NULL);
267 if (fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
275 fdt_addr_t ofnode_get_addr_size_index(ofnode node, int index, fdt_size_t *size)
279 if (ofnode_is_np(node)) {
280 const __be32 *prop_val;
284 prop_val = of_get_address(ofnode_to_np(node), index, &size64,
287 return FDT_ADDR_T_NONE;
291 ns = of_n_size_cells(ofnode_to_np(node));
293 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
294 return of_translate_address(ofnode_to_np(node), prop_val);
296 na = of_n_addr_cells(ofnode_to_np(node));
297 return of_read_number(prop_val, na);
300 na = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
301 ns = ofnode_read_simple_size_cells(ofnode_get_parent(node));
302 return fdtdec_get_addr_size_fixed(gd->fdt_blob,
303 ofnode_to_offset(node), "reg",
304 index, na, ns, size, true);
307 return FDT_ADDR_T_NONE;
310 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
314 return ofnode_get_addr_size_index(node, index, &size);
317 fdt_addr_t ofnode_get_addr(ofnode node)
319 return ofnode_get_addr_index(node, 0);
322 int ofnode_stringlist_search(ofnode node, const char *property,
325 if (ofnode_is_np(node)) {
326 return of_property_match_string(ofnode_to_np(node),
331 ret = fdt_stringlist_search(gd->fdt_blob,
332 ofnode_to_offset(node), property,
334 if (ret == -FDT_ERR_NOTFOUND)
343 int ofnode_read_string_index(ofnode node, const char *property, int index,
346 if (ofnode_is_np(node)) {
347 return of_property_read_string_index(ofnode_to_np(node),
348 property, index, outp);
352 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
353 property, index, &len);
360 int ofnode_read_string_count(ofnode node, const char *property)
362 if (ofnode_is_np(node)) {
363 return of_property_count_strings(ofnode_to_np(node), property);
365 return fdt_stringlist_count(gd->fdt_blob,
366 ofnode_to_offset(node), property);
370 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
371 struct ofnode_phandle_args *out)
373 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
374 out->node = offset_to_ofnode(in->node);
375 out->args_count = in->args_count;
376 memcpy(out->args, in->args, sizeof(out->args));
379 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
380 struct ofnode_phandle_args *out)
382 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
383 out->node = np_to_ofnode(in->np);
384 out->args_count = in->args_count;
385 memcpy(out->args, in->args, sizeof(out->args));
388 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
389 const char *cells_name, int cell_count,
391 struct ofnode_phandle_args *out_args)
393 if (ofnode_is_np(node)) {
394 struct of_phandle_args args;
397 ret = of_parse_phandle_with_args(ofnode_to_np(node),
398 list_name, cells_name, index,
402 ofnode_from_of_phandle_args(&args, out_args);
404 struct fdtdec_phandle_args args;
407 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
408 ofnode_to_offset(node),
409 list_name, cells_name,
410 cell_count, index, &args);
413 ofnode_from_fdtdec_phandle_args(&args, out_args);
419 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
420 const char *cells_name)
422 if (ofnode_is_np(node))
423 return of_count_phandle_with_args(ofnode_to_np(node),
424 list_name, cells_name);
426 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
427 ofnode_to_offset(node), list_name, cells_name,
431 ofnode ofnode_path(const char *path)
433 if (of_live_active())
434 return np_to_ofnode(of_find_node_by_path(path));
436 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
439 const char *ofnode_read_chosen_string(const char *name)
443 chosen_node = ofnode_path("/chosen");
445 return ofnode_read_string(chosen_node, name);
448 ofnode ofnode_get_chosen_node(const char *name)
452 prop = ofnode_read_chosen_string(name);
454 return ofnode_null();
456 return ofnode_path(prop);
459 static int decode_timing_property(ofnode node, const char *name,
460 struct timing_entry *result)
464 length = ofnode_read_size(node, name);
466 debug("%s: could not find property %s\n",
467 ofnode_get_name(node), name);
471 if (length == sizeof(u32)) {
472 result->typ = ofnode_read_u32_default(node, name, 0);
473 result->min = result->typ;
474 result->max = result->typ;
476 ret = ofnode_read_u32_array(node, name, &result->min, 3);
482 int ofnode_decode_display_timing(ofnode parent, int index,
483 struct display_timing *dt)
486 ofnode timings, node;
490 timings = ofnode_find_subnode(parent, "display-timings");
491 if (!ofnode_valid(timings))
495 ofnode_for_each_subnode(node, timings) {
500 if (!ofnode_valid(node))
503 memset(dt, 0, sizeof(*dt));
505 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
506 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
507 ret |= decode_timing_property(node, "hactive", &dt->hactive);
508 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
509 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
510 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
511 ret |= decode_timing_property(node, "vactive", &dt->vactive);
512 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
513 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
516 val = ofnode_read_u32_default(node, "vsync-active", -1);
518 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
519 DISPLAY_FLAGS_VSYNC_LOW;
521 val = ofnode_read_u32_default(node, "hsync-active", -1);
523 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
524 DISPLAY_FLAGS_HSYNC_LOW;
526 val = ofnode_read_u32_default(node, "de-active", -1);
528 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
529 DISPLAY_FLAGS_DE_LOW;
531 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
533 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
534 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
537 if (ofnode_read_bool(node, "interlaced"))
538 dt->flags |= DISPLAY_FLAGS_INTERLACED;
539 if (ofnode_read_bool(node, "doublescan"))
540 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
541 if (ofnode_read_bool(node, "doubleclk"))
542 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
547 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
549 if (ofnode_is_np(node))
550 return of_get_property(ofnode_to_np(node), propname, lenp);
552 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
556 bool ofnode_is_available(ofnode node)
558 if (ofnode_is_np(node))
559 return of_device_is_available(ofnode_to_np(node));
561 return fdtdec_get_is_enabled(gd->fdt_blob,
562 ofnode_to_offset(node));
565 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
568 if (ofnode_is_np(node)) {
571 const struct device_node *np = ofnode_to_np(node);
572 const __be32 *prop = of_get_property(np, property, &psize);
575 return FDT_ADDR_T_NONE;
576 na = of_n_addr_cells(np);
577 ns = of_n_size_cells(np);
578 *sizep = of_read_number(prop + na, ns);
580 if (CONFIG_IS_ENABLED(OF_TRANSLATE) && ns > 0)
581 return of_translate_address(np, prop);
583 return of_read_number(prop, na);
585 return fdtdec_get_addr_size(gd->fdt_blob,
586 ofnode_to_offset(node), property,
591 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
594 if (ofnode_is_np(node)) {
595 const struct device_node *np = ofnode_to_np(node);
597 const __be32 *prop = of_get_property(np, propname, &psize);
599 if (!prop || sz != psize)
601 return (uint8_t *)prop;
604 return fdtdec_locate_byte_array(gd->fdt_blob,
605 ofnode_to_offset(node), propname, sz);
609 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
610 const char *propname, struct fdt_pci_addr *addr)
616 debug("%s: %s: ", __func__, propname);
619 * If we follow the pci bus bindings strictly, we should check
620 * the value of the node's parent node's #address-cells and
621 * #size-cells. They need to be 3 and 2 accordingly. However,
622 * for simplicity we skip the check here.
624 cell = ofnode_get_property(node, propname, &len);
628 if ((len % FDT_PCI_REG_SIZE) == 0) {
629 int num = len / FDT_PCI_REG_SIZE;
632 for (i = 0; i < num; i++) {
633 debug("pci address #%d: %08lx %08lx %08lx\n", i,
634 (ulong)fdt32_to_cpu(cell[0]),
635 (ulong)fdt32_to_cpu(cell[1]),
636 (ulong)fdt32_to_cpu(cell[2]));
637 if ((fdt32_to_cpu(*cell) & type) == type) {
638 addr->phys_hi = fdt32_to_cpu(cell[0]);
639 addr->phys_mid = fdt32_to_cpu(cell[1]);
640 addr->phys_lo = fdt32_to_cpu(cell[2]);
644 cell += (FDT_PCI_ADDR_CELLS +
659 debug("(not found)\n");
663 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device)
665 const char *list, *end;
668 list = ofnode_get_property(node, "compatible", &len);
675 if (len >= strlen("pciVVVV,DDDD")) {
676 char *s = strstr(list, "pci");
679 * check if the string is something like pciVVVV,DDDD.RR
680 * or just pciVVVV,DDDD
682 if (s && s[7] == ',' &&
683 (s[12] == '.' || s[12] == 0)) {
685 *vendor = simple_strtol(s, NULL, 16);
688 *device = simple_strtol(s, NULL, 16);
699 int ofnode_read_addr_cells(ofnode node)
701 if (ofnode_is_np(node))
702 return of_n_addr_cells(ofnode_to_np(node));
703 else /* NOTE: this call should walk up the parent stack */
704 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
707 int ofnode_read_size_cells(ofnode node)
709 if (ofnode_is_np(node))
710 return of_n_size_cells(ofnode_to_np(node));
711 else /* NOTE: this call should walk up the parent stack */
712 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
715 int ofnode_read_simple_addr_cells(ofnode node)
717 if (ofnode_is_np(node))
718 return of_simple_addr_cells(ofnode_to_np(node));
720 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
723 int ofnode_read_simple_size_cells(ofnode node)
725 if (ofnode_is_np(node))
726 return of_simple_size_cells(ofnode_to_np(node));
728 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
731 bool ofnode_pre_reloc(ofnode node)
733 #if defined(CONFIG_SPL_BUILD) || defined(CONFIG_TPL_BUILD)
734 /* for SPL and TPL the remaining nodes after the fdtgrep 1st pass
735 * had property dm-pre-reloc or u-boot,dm-spl/tpl.
736 * They are removed in final dtb (fdtgrep 2nd pass)
740 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
742 if (ofnode_read_bool(node, "u-boot,dm-pre-proper"))
746 * In regular builds individual spl and tpl handling both
747 * count as handled pre-relocation for later second init.
749 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
750 ofnode_read_bool(node, "u-boot,dm-tpl"))
757 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
759 if (ofnode_is_np(node)) {
760 return of_address_to_resource(ofnode_to_np(node), index, res);
762 struct fdt_resource fres;
765 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
766 "reg", index, &fres);
769 memset(res, '\0', sizeof(*res));
770 res->start = fres.start;
777 int ofnode_read_resource_byname(ofnode node, const char *name,
778 struct resource *res)
782 index = ofnode_stringlist_search(node, "reg-names", name);
786 return ofnode_read_resource(node, index, res);
789 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
791 if (ofnode_is_np(node))
792 return of_translate_address(ofnode_to_np(node), in_addr);
794 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
797 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr)
799 if (ofnode_is_np(node))
800 return of_translate_dma_address(ofnode_to_np(node), in_addr);
802 return fdt_translate_dma_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
805 int ofnode_device_is_compatible(ofnode node, const char *compat)
807 if (ofnode_is_np(node))
808 return of_device_is_compatible(ofnode_to_np(node), compat,
811 return !fdt_node_check_compatible(gd->fdt_blob,
812 ofnode_to_offset(node),
816 ofnode ofnode_by_compatible(ofnode from, const char *compat)
818 if (of_live_active()) {
819 return np_to_ofnode(of_find_compatible_node(
820 (struct device_node *)ofnode_to_np(from), NULL,
823 return offset_to_ofnode(fdt_node_offset_by_compatible(
824 gd->fdt_blob, ofnode_to_offset(from), compat));
828 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
829 const void *propval, int proplen)
831 if (of_live_active()) {
832 return np_to_ofnode(of_find_node_by_prop_value(
833 (struct device_node *)ofnode_to_np(from), propname,
836 return offset_to_ofnode(fdt_node_offset_by_prop_value(
837 gd->fdt_blob, ofnode_to_offset(from),
838 propname, propval, proplen));
842 int ofnode_write_prop(ofnode node, const char *propname, int len,
845 const struct device_node *np = ofnode_to_np(node);
847 struct property *pp_last = NULL;
848 struct property *new;
850 if (!of_live_active())
856 for (pp = np->properties; pp; pp = pp->next) {
857 if (strcmp(pp->name, propname) == 0) {
858 /* Property exists -> change value */
859 pp->value = (void *)value;
869 /* Property does not exist -> append new property */
870 new = malloc(sizeof(struct property));
874 new->name = strdup(propname);
880 new->value = (void *)value;
889 int ofnode_write_string(ofnode node, const char *propname, const char *value)
891 if (!of_live_active())
894 assert(ofnode_valid(node));
896 debug("%s: %s = %s", __func__, propname, value);
898 return ofnode_write_prop(node, propname, strlen(value) + 1, value);
901 int ofnode_set_enabled(ofnode node, bool value)
903 if (!of_live_active())
906 assert(ofnode_valid(node));
909 return ofnode_write_string(node, "status", "okay");
911 return ofnode_write_string(node, "status", "disabled");