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>
12 #include <linux/libfdt.h>
13 #include <dm/of_access.h>
14 #include <dm/of_addr.h>
15 #include <dm/ofnode.h>
16 #include <linux/err.h>
17 #include <linux/ioport.h>
19 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp)
21 assert(ofnode_valid(node));
22 debug("%s: %s: ", __func__, propname);
24 if (ofnode_is_np(node)) {
25 return of_read_u32(ofnode_to_np(node), propname, outp);
30 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
32 if (!cell || len < sizeof(int)) {
33 debug("(not found)\n");
36 *outp = fdt32_to_cpu(cell[0]);
38 debug("%#x (%d)\n", *outp, *outp);
43 u32 ofnode_read_u32_default(ofnode node, const char *propname, u32 def)
45 assert(ofnode_valid(node));
46 ofnode_read_u32(node, propname, &def);
51 int ofnode_read_u32_index(ofnode node, const char *propname, int index,
57 assert(ofnode_valid(node));
58 debug("%s: %s: ", __func__, propname);
60 if (ofnode_is_np(node))
61 return of_read_u32_index(ofnode_to_np(node), propname, index,
64 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
67 debug("(not found)\n");
71 if (len < (sizeof(int) * (index + 1))) {
72 debug("(not large enough)\n");
76 *outp = fdt32_to_cpu(cell[index]);
77 debug("%#x (%d)\n", *outp, *outp);
82 u32 ofnode_read_u32_index_default(ofnode node, const char *propname, int index,
85 assert(ofnode_valid(node));
86 ofnode_read_u32_index(node, propname, index, &def);
91 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def)
93 assert(ofnode_valid(node));
94 ofnode_read_u32(node, propname, (u32 *)&def);
99 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp)
101 const unaligned_fdt64_t *cell;
104 assert(ofnode_valid(node));
105 debug("%s: %s: ", __func__, propname);
107 if (ofnode_is_np(node))
108 return of_read_u64(ofnode_to_np(node), propname, outp);
110 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
112 if (!cell || len < sizeof(*cell)) {
113 debug("(not found)\n");
116 *outp = fdt64_to_cpu(cell[0]);
117 debug("%#llx (%lld)\n", (unsigned long long)*outp,
118 (unsigned long long)*outp);
123 u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def)
125 assert(ofnode_valid(node));
126 ofnode_read_u64(node, propname, &def);
131 bool ofnode_read_bool(ofnode node, const char *propname)
135 assert(ofnode_valid(node));
136 debug("%s: %s: ", __func__, propname);
138 prop = ofnode_get_property(node, propname, NULL);
140 debug("%s\n", prop ? "true" : "false");
142 return prop ? true : false;
145 const void *ofnode_read_prop(ofnode node, const char *propname, int *sizep)
147 const char *val = NULL;
150 assert(ofnode_valid(node));
151 debug("%s: %s: ", __func__, propname);
153 if (ofnode_is_np(node)) {
154 struct property *prop = of_find_property(
155 ofnode_to_np(node), propname, &len);
162 val = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
166 debug("<not found>\n");
168 *sizep = -FDT_ERR_NOTFOUND;
177 const char *ofnode_read_string(ofnode node, const char *propname)
182 str = ofnode_read_prop(node, propname, &len);
186 if (strnlen(str, len) >= len) {
187 debug("<invalid>\n");
195 int ofnode_read_size(ofnode node, const char *propname)
199 if (!ofnode_read_prop(node, propname, &len))
205 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name)
209 assert(ofnode_valid(node));
210 debug("%s: %s: ", __func__, subnode_name);
212 if (ofnode_is_np(node)) {
213 const struct device_node *np = ofnode_to_np(node);
215 for (np = np->child; np; np = np->sibling) {
216 if (!strcmp(subnode_name, np->name))
219 subnode = np_to_ofnode(np);
221 int ooffset = fdt_subnode_offset(gd->fdt_blob,
222 ofnode_to_offset(node), subnode_name);
223 subnode = offset_to_ofnode(ooffset);
225 debug("%s\n", ofnode_valid(subnode) ?
226 ofnode_get_name(subnode) : "<none>");
231 int ofnode_read_u32_array(ofnode node, const char *propname,
232 u32 *out_values, size_t sz)
234 assert(ofnode_valid(node));
235 debug("%s: %s: ", __func__, propname);
237 if (ofnode_is_np(node)) {
238 return of_read_u32_array(ofnode_to_np(node), propname,
241 return fdtdec_get_int_array(gd->fdt_blob,
242 ofnode_to_offset(node), propname,
247 ofnode ofnode_first_subnode(ofnode node)
249 assert(ofnode_valid(node));
250 if (ofnode_is_np(node))
251 return np_to_ofnode(node.np->child);
253 return offset_to_ofnode(
254 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
257 ofnode ofnode_next_subnode(ofnode node)
259 assert(ofnode_valid(node));
260 if (ofnode_is_np(node))
261 return np_to_ofnode(node.np->sibling);
263 return offset_to_ofnode(
264 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
267 ofnode ofnode_get_parent(ofnode node)
271 assert(ofnode_valid(node));
272 if (ofnode_is_np(node))
273 parent = np_to_ofnode(of_get_parent(ofnode_to_np(node)));
275 parent.of_offset = fdt_parent_offset(gd->fdt_blob,
276 ofnode_to_offset(node));
281 const char *ofnode_get_name(ofnode node)
283 if (!ofnode_valid(node)) {
284 debug("%s node not valid\n", __func__);
288 if (ofnode_is_np(node))
289 return strrchr(node.np->full_name, '/') + 1;
291 return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
294 ofnode ofnode_get_by_phandle(uint phandle)
298 if (of_live_active())
299 node = np_to_ofnode(of_find_node_by_phandle(phandle));
301 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
307 fdt_addr_t ofnode_get_addr_size_index(ofnode node, int index, fdt_size_t *size)
311 if (ofnode_is_np(node)) {
312 const __be32 *prop_val;
316 prop_val = of_get_address(ofnode_to_np(node), index, &size64,
319 return FDT_ADDR_T_NONE;
323 ns = of_n_size_cells(ofnode_to_np(node));
325 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
326 return of_translate_address(ofnode_to_np(node), prop_val);
328 na = of_n_addr_cells(ofnode_to_np(node));
329 return of_read_number(prop_val, na);
332 na = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
333 ns = ofnode_read_simple_size_cells(ofnode_get_parent(node));
334 return fdtdec_get_addr_size_fixed(gd->fdt_blob,
335 ofnode_to_offset(node), "reg",
336 index, na, ns, size, true);
339 return FDT_ADDR_T_NONE;
342 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
346 return ofnode_get_addr_size_index(node, index, &size);
349 fdt_addr_t ofnode_get_addr(ofnode node)
351 return ofnode_get_addr_index(node, 0);
354 int ofnode_stringlist_search(ofnode node, const char *property,
357 if (ofnode_is_np(node)) {
358 return of_property_match_string(ofnode_to_np(node),
363 ret = fdt_stringlist_search(gd->fdt_blob,
364 ofnode_to_offset(node), property,
366 if (ret == -FDT_ERR_NOTFOUND)
375 int ofnode_read_string_index(ofnode node, const char *property, int index,
378 if (ofnode_is_np(node)) {
379 return of_property_read_string_index(ofnode_to_np(node),
380 property, index, outp);
384 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
385 property, index, &len);
392 int ofnode_read_string_count(ofnode node, const char *property)
394 if (ofnode_is_np(node)) {
395 return of_property_count_strings(ofnode_to_np(node), property);
397 return fdt_stringlist_count(gd->fdt_blob,
398 ofnode_to_offset(node), property);
402 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
403 struct ofnode_phandle_args *out)
405 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
406 out->node = offset_to_ofnode(in->node);
407 out->args_count = in->args_count;
408 memcpy(out->args, in->args, sizeof(out->args));
411 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
412 struct ofnode_phandle_args *out)
414 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
415 out->node = np_to_ofnode(in->np);
416 out->args_count = in->args_count;
417 memcpy(out->args, in->args, sizeof(out->args));
420 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
421 const char *cells_name, int cell_count,
423 struct ofnode_phandle_args *out_args)
425 if (ofnode_is_np(node)) {
426 struct of_phandle_args args;
429 ret = of_parse_phandle_with_args(ofnode_to_np(node),
430 list_name, cells_name, index,
434 ofnode_from_of_phandle_args(&args, out_args);
436 struct fdtdec_phandle_args args;
439 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
440 ofnode_to_offset(node),
441 list_name, cells_name,
442 cell_count, index, &args);
445 ofnode_from_fdtdec_phandle_args(&args, out_args);
451 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
452 const char *cells_name)
454 if (ofnode_is_np(node))
455 return of_count_phandle_with_args(ofnode_to_np(node),
456 list_name, cells_name);
458 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
459 ofnode_to_offset(node), list_name, cells_name,
463 ofnode ofnode_path(const char *path)
465 if (of_live_active())
466 return np_to_ofnode(of_find_node_by_path(path));
468 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
471 const void *ofnode_read_chosen_prop(const char *propname, int *sizep)
475 chosen_node = ofnode_path("/chosen");
477 return ofnode_read_prop(chosen_node, propname, sizep);
480 const char *ofnode_read_chosen_string(const char *propname)
482 return ofnode_read_chosen_prop(propname, NULL);
485 ofnode ofnode_get_chosen_node(const char *name)
489 prop = ofnode_read_chosen_prop(name, NULL);
491 return ofnode_null();
493 return ofnode_path(prop);
496 static int decode_timing_property(ofnode node, const char *name,
497 struct timing_entry *result)
501 length = ofnode_read_size(node, name);
503 debug("%s: could not find property %s\n",
504 ofnode_get_name(node), name);
508 if (length == sizeof(u32)) {
509 result->typ = ofnode_read_u32_default(node, name, 0);
510 result->min = result->typ;
511 result->max = result->typ;
513 ret = ofnode_read_u32_array(node, name, &result->min, 3);
519 int ofnode_decode_display_timing(ofnode parent, int index,
520 struct display_timing *dt)
523 ofnode timings, node;
527 timings = ofnode_find_subnode(parent, "display-timings");
528 if (!ofnode_valid(timings))
532 ofnode_for_each_subnode(node, timings) {
537 if (!ofnode_valid(node))
540 memset(dt, 0, sizeof(*dt));
542 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
543 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
544 ret |= decode_timing_property(node, "hactive", &dt->hactive);
545 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
546 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
547 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
548 ret |= decode_timing_property(node, "vactive", &dt->vactive);
549 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
550 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
553 val = ofnode_read_u32_default(node, "vsync-active", -1);
555 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
556 DISPLAY_FLAGS_VSYNC_LOW;
558 val = ofnode_read_u32_default(node, "hsync-active", -1);
560 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
561 DISPLAY_FLAGS_HSYNC_LOW;
563 val = ofnode_read_u32_default(node, "de-active", -1);
565 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
566 DISPLAY_FLAGS_DE_LOW;
568 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
570 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
571 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
574 if (ofnode_read_bool(node, "interlaced"))
575 dt->flags |= DISPLAY_FLAGS_INTERLACED;
576 if (ofnode_read_bool(node, "doublescan"))
577 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
578 if (ofnode_read_bool(node, "doubleclk"))
579 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
584 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
586 if (ofnode_is_np(node))
587 return of_get_property(ofnode_to_np(node), propname, lenp);
589 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
593 bool ofnode_is_available(ofnode node)
595 if (ofnode_is_np(node))
596 return of_device_is_available(ofnode_to_np(node));
598 return fdtdec_get_is_enabled(gd->fdt_blob,
599 ofnode_to_offset(node));
602 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
605 if (ofnode_is_np(node)) {
608 const struct device_node *np = ofnode_to_np(node);
609 const __be32 *prop = of_get_property(np, property, &psize);
612 return FDT_ADDR_T_NONE;
613 na = of_n_addr_cells(np);
614 ns = of_n_size_cells(np);
615 *sizep = of_read_number(prop + na, ns);
617 if (CONFIG_IS_ENABLED(OF_TRANSLATE) && ns > 0)
618 return of_translate_address(np, prop);
620 return of_read_number(prop, na);
622 return fdtdec_get_addr_size(gd->fdt_blob,
623 ofnode_to_offset(node), property,
628 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
631 if (ofnode_is_np(node)) {
632 const struct device_node *np = ofnode_to_np(node);
634 const __be32 *prop = of_get_property(np, propname, &psize);
636 if (!prop || sz != psize)
638 return (uint8_t *)prop;
641 return fdtdec_locate_byte_array(gd->fdt_blob,
642 ofnode_to_offset(node), propname, sz);
646 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
647 const char *propname, struct fdt_pci_addr *addr)
653 debug("%s: %s: ", __func__, propname);
656 * If we follow the pci bus bindings strictly, we should check
657 * the value of the node's parent node's #address-cells and
658 * #size-cells. They need to be 3 and 2 accordingly. However,
659 * for simplicity we skip the check here.
661 cell = ofnode_get_property(node, propname, &len);
665 if ((len % FDT_PCI_REG_SIZE) == 0) {
666 int num = len / FDT_PCI_REG_SIZE;
669 for (i = 0; i < num; i++) {
670 debug("pci address #%d: %08lx %08lx %08lx\n", i,
671 (ulong)fdt32_to_cpu(cell[0]),
672 (ulong)fdt32_to_cpu(cell[1]),
673 (ulong)fdt32_to_cpu(cell[2]));
674 if ((fdt32_to_cpu(*cell) & type) == type) {
675 addr->phys_hi = fdt32_to_cpu(cell[0]);
676 addr->phys_mid = fdt32_to_cpu(cell[1]);
677 addr->phys_lo = fdt32_to_cpu(cell[2]);
681 cell += (FDT_PCI_ADDR_CELLS +
696 debug("(not found)\n");
700 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device)
702 const char *list, *end;
705 list = ofnode_get_property(node, "compatible", &len);
712 if (len >= strlen("pciVVVV,DDDD")) {
713 char *s = strstr(list, "pci");
716 * check if the string is something like pciVVVV,DDDD.RR
717 * or just pciVVVV,DDDD
719 if (s && s[7] == ',' &&
720 (s[12] == '.' || s[12] == 0)) {
722 *vendor = simple_strtol(s, NULL, 16);
725 *device = simple_strtol(s, NULL, 16);
736 int ofnode_read_addr_cells(ofnode node)
738 if (ofnode_is_np(node))
739 return of_n_addr_cells(ofnode_to_np(node));
740 else /* NOTE: this call should walk up the parent stack */
741 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
744 int ofnode_read_size_cells(ofnode node)
746 if (ofnode_is_np(node))
747 return of_n_size_cells(ofnode_to_np(node));
748 else /* NOTE: this call should walk up the parent stack */
749 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
752 int ofnode_read_simple_addr_cells(ofnode node)
754 if (ofnode_is_np(node))
755 return of_simple_addr_cells(ofnode_to_np(node));
757 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
760 int ofnode_read_simple_size_cells(ofnode node)
762 if (ofnode_is_np(node))
763 return of_simple_size_cells(ofnode_to_np(node));
765 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
768 bool ofnode_pre_reloc(ofnode node)
770 #if defined(CONFIG_SPL_BUILD) || defined(CONFIG_TPL_BUILD)
771 /* for SPL and TPL the remaining nodes after the fdtgrep 1st pass
772 * had property dm-pre-reloc or u-boot,dm-spl/tpl.
773 * They are removed in final dtb (fdtgrep 2nd pass)
777 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
779 if (ofnode_read_bool(node, "u-boot,dm-pre-proper"))
783 * In regular builds individual spl and tpl handling both
784 * count as handled pre-relocation for later second init.
786 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
787 ofnode_read_bool(node, "u-boot,dm-tpl"))
794 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
796 if (ofnode_is_np(node)) {
797 return of_address_to_resource(ofnode_to_np(node), index, res);
799 struct fdt_resource fres;
802 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
803 "reg", index, &fres);
806 memset(res, '\0', sizeof(*res));
807 res->start = fres.start;
814 int ofnode_read_resource_byname(ofnode node, const char *name,
815 struct resource *res)
819 index = ofnode_stringlist_search(node, "reg-names", name);
823 return ofnode_read_resource(node, index, res);
826 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
828 if (ofnode_is_np(node))
829 return of_translate_address(ofnode_to_np(node), in_addr);
831 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
834 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr)
836 if (ofnode_is_np(node))
837 return of_translate_dma_address(ofnode_to_np(node), in_addr);
839 return fdt_translate_dma_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
842 int ofnode_device_is_compatible(ofnode node, const char *compat)
844 if (ofnode_is_np(node))
845 return of_device_is_compatible(ofnode_to_np(node), compat,
848 return !fdt_node_check_compatible(gd->fdt_blob,
849 ofnode_to_offset(node),
853 ofnode ofnode_by_compatible(ofnode from, const char *compat)
855 if (of_live_active()) {
856 return np_to_ofnode(of_find_compatible_node(
857 (struct device_node *)ofnode_to_np(from), NULL,
860 return offset_to_ofnode(fdt_node_offset_by_compatible(
861 gd->fdt_blob, ofnode_to_offset(from), compat));
865 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
866 const void *propval, int proplen)
868 if (of_live_active()) {
869 return np_to_ofnode(of_find_node_by_prop_value(
870 (struct device_node *)ofnode_to_np(from), propname,
873 return offset_to_ofnode(fdt_node_offset_by_prop_value(
874 gd->fdt_blob, ofnode_to_offset(from),
875 propname, propval, proplen));
879 int ofnode_write_prop(ofnode node, const char *propname, int len,
882 const struct device_node *np = ofnode_to_np(node);
884 struct property *pp_last = NULL;
885 struct property *new;
887 if (!of_live_active())
893 for (pp = np->properties; pp; pp = pp->next) {
894 if (strcmp(pp->name, propname) == 0) {
895 /* Property exists -> change value */
896 pp->value = (void *)value;
906 /* Property does not exist -> append new property */
907 new = malloc(sizeof(struct property));
911 new->name = strdup(propname);
917 new->value = (void *)value;
926 int ofnode_write_string(ofnode node, const char *propname, const char *value)
928 if (!of_live_active())
931 assert(ofnode_valid(node));
933 debug("%s: %s = %s", __func__, propname, value);
935 return ofnode_write_prop(node, propname, strlen(value) + 1, value);
938 int ofnode_set_enabled(ofnode node, bool value)
940 if (!of_live_active())
943 assert(ofnode_valid(node));
946 return ofnode_write_string(node, "status", "okay");
948 return ofnode_write_string(node, "status", "disabled");