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>
13 #include <linux/libfdt.h>
14 #include <dm/of_access.h>
15 #include <dm/of_addr.h>
16 #include <dm/ofnode.h>
17 #include <linux/err.h>
18 #include <linux/ioport.h>
20 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp)
22 return ofnode_read_u32_index(node, propname, 0, outp);
25 u32 ofnode_read_u32_default(ofnode node, const char *propname, u32 def)
27 assert(ofnode_valid(node));
28 ofnode_read_u32_index(node, propname, 0, &def);
33 int ofnode_read_u32_index(ofnode node, const char *propname, int index,
39 assert(ofnode_valid(node));
40 debug("%s: %s: ", __func__, propname);
42 if (ofnode_is_np(node))
43 return of_read_u32_index(ofnode_to_np(node), propname, index,
46 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
49 debug("(not found)\n");
53 if (len < (sizeof(int) * (index + 1))) {
54 debug("(not large enough)\n");
58 *outp = fdt32_to_cpu(cell[index]);
59 debug("%#x (%d)\n", *outp, *outp);
64 u32 ofnode_read_u32_index_default(ofnode node, const char *propname, int index,
67 assert(ofnode_valid(node));
68 ofnode_read_u32_index(node, propname, index, &def);
73 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def)
75 assert(ofnode_valid(node));
76 ofnode_read_u32(node, propname, (u32 *)&def);
81 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp)
83 const unaligned_fdt64_t *cell;
86 assert(ofnode_valid(node));
87 debug("%s: %s: ", __func__, propname);
89 if (ofnode_is_np(node))
90 return of_read_u64(ofnode_to_np(node), propname, outp);
92 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
94 if (!cell || len < sizeof(*cell)) {
95 debug("(not found)\n");
98 *outp = fdt64_to_cpu(cell[0]);
99 debug("%#llx (%lld)\n", (unsigned long long)*outp,
100 (unsigned long long)*outp);
105 u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def)
107 assert(ofnode_valid(node));
108 ofnode_read_u64(node, propname, &def);
113 bool ofnode_read_bool(ofnode node, const char *propname)
117 assert(ofnode_valid(node));
118 debug("%s: %s: ", __func__, propname);
120 prop = ofnode_get_property(node, propname, NULL);
122 debug("%s\n", prop ? "true" : "false");
124 return prop ? true : false;
127 const void *ofnode_read_prop(ofnode node, const char *propname, int *sizep)
129 const char *val = NULL;
132 assert(ofnode_valid(node));
133 debug("%s: %s: ", __func__, propname);
135 if (ofnode_is_np(node)) {
136 struct property *prop = of_find_property(
137 ofnode_to_np(node), propname, &len);
144 val = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
148 debug("<not found>\n");
150 *sizep = -FDT_ERR_NOTFOUND;
159 const char *ofnode_read_string(ofnode node, const char *propname)
164 str = ofnode_read_prop(node, propname, &len);
168 if (strnlen(str, len) >= len) {
169 debug("<invalid>\n");
177 int ofnode_read_size(ofnode node, const char *propname)
181 if (!ofnode_read_prop(node, propname, &len))
187 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name)
191 assert(ofnode_valid(node));
192 debug("%s: %s: ", __func__, subnode_name);
194 if (ofnode_is_np(node)) {
195 const struct device_node *np = ofnode_to_np(node);
197 for (np = np->child; np; np = np->sibling) {
198 if (!strcmp(subnode_name, np->name))
201 subnode = np_to_ofnode(np);
203 int ooffset = fdt_subnode_offset(gd->fdt_blob,
204 ofnode_to_offset(node), subnode_name);
205 subnode = offset_to_ofnode(ooffset);
207 debug("%s\n", ofnode_valid(subnode) ?
208 ofnode_get_name(subnode) : "<none>");
213 int ofnode_read_u32_array(ofnode node, const char *propname,
214 u32 *out_values, size_t sz)
216 assert(ofnode_valid(node));
217 debug("%s: %s: ", __func__, propname);
219 if (ofnode_is_np(node)) {
220 return of_read_u32_array(ofnode_to_np(node), propname,
223 return fdtdec_get_int_array(gd->fdt_blob,
224 ofnode_to_offset(node), propname,
229 #if !CONFIG_IS_ENABLED(DM_INLINE_OFNODE)
230 bool ofnode_is_enabled(ofnode node)
232 if (ofnode_is_np(node)) {
233 return of_device_is_available(ofnode_to_np(node));
235 return fdtdec_get_is_enabled(gd->fdt_blob,
236 ofnode_to_offset(node));
240 ofnode ofnode_first_subnode(ofnode node)
242 assert(ofnode_valid(node));
243 if (ofnode_is_np(node))
244 return np_to_ofnode(node.np->child);
246 return offset_to_ofnode(
247 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
250 ofnode ofnode_next_subnode(ofnode node)
252 assert(ofnode_valid(node));
253 if (ofnode_is_np(node))
254 return np_to_ofnode(node.np->sibling);
256 return offset_to_ofnode(
257 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
259 #endif /* !DM_INLINE_OFNODE */
261 ofnode ofnode_get_parent(ofnode node)
265 assert(ofnode_valid(node));
266 if (ofnode_is_np(node))
267 parent = np_to_ofnode(of_get_parent(ofnode_to_np(node)));
269 parent.of_offset = fdt_parent_offset(gd->fdt_blob,
270 ofnode_to_offset(node));
275 const char *ofnode_get_name(ofnode node)
277 if (!ofnode_valid(node)) {
278 debug("%s node not valid\n", __func__);
282 if (ofnode_is_np(node))
283 return strrchr(node.np->full_name, '/') + 1;
285 return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
288 ofnode ofnode_get_by_phandle(uint phandle)
292 if (of_live_active())
293 node = np_to_ofnode(of_find_node_by_phandle(phandle));
295 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
301 fdt_addr_t ofnode_get_addr_size_index(ofnode node, int index, fdt_size_t *size)
305 if (ofnode_is_np(node)) {
306 const __be32 *prop_val;
310 prop_val = of_get_address(ofnode_to_np(node), index, &size64,
313 return FDT_ADDR_T_NONE;
317 ns = of_n_size_cells(ofnode_to_np(node));
319 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
320 return of_translate_address(ofnode_to_np(node), prop_val);
322 na = of_n_addr_cells(ofnode_to_np(node));
323 return of_read_number(prop_val, na);
326 na = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
327 ns = ofnode_read_simple_size_cells(ofnode_get_parent(node));
328 return fdtdec_get_addr_size_fixed(gd->fdt_blob,
329 ofnode_to_offset(node), "reg",
330 index, na, ns, size, true);
333 return FDT_ADDR_T_NONE;
336 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
340 return ofnode_get_addr_size_index(node, index, &size);
343 fdt_addr_t ofnode_get_addr(ofnode node)
345 return ofnode_get_addr_index(node, 0);
348 int ofnode_stringlist_search(ofnode node, const char *property,
351 if (ofnode_is_np(node)) {
352 return of_property_match_string(ofnode_to_np(node),
357 ret = fdt_stringlist_search(gd->fdt_blob,
358 ofnode_to_offset(node), property,
360 if (ret == -FDT_ERR_NOTFOUND)
369 int ofnode_read_string_index(ofnode node, const char *property, int index,
372 if (ofnode_is_np(node)) {
373 return of_property_read_string_index(ofnode_to_np(node),
374 property, index, outp);
378 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
379 property, index, &len);
386 int ofnode_read_string_count(ofnode node, const char *property)
388 if (ofnode_is_np(node)) {
389 return of_property_count_strings(ofnode_to_np(node), property);
391 return fdt_stringlist_count(gd->fdt_blob,
392 ofnode_to_offset(node), property);
396 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
397 struct ofnode_phandle_args *out)
399 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
400 out->node = offset_to_ofnode(in->node);
401 out->args_count = in->args_count;
402 memcpy(out->args, in->args, sizeof(out->args));
405 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
406 struct ofnode_phandle_args *out)
408 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
409 out->node = np_to_ofnode(in->np);
410 out->args_count = in->args_count;
411 memcpy(out->args, in->args, sizeof(out->args));
414 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
415 const char *cells_name, int cell_count,
417 struct ofnode_phandle_args *out_args)
419 if (ofnode_is_np(node)) {
420 struct of_phandle_args args;
423 ret = of_parse_phandle_with_args(ofnode_to_np(node),
424 list_name, cells_name,
429 ofnode_from_of_phandle_args(&args, out_args);
431 struct fdtdec_phandle_args args;
434 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
435 ofnode_to_offset(node),
436 list_name, cells_name,
437 cell_count, index, &args);
440 ofnode_from_fdtdec_phandle_args(&args, out_args);
446 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
447 const char *cells_name, int cell_count)
449 if (ofnode_is_np(node))
450 return of_count_phandle_with_args(ofnode_to_np(node),
451 list_name, cells_name, cell_count);
453 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
454 ofnode_to_offset(node), list_name, cells_name,
455 cell_count, -1, NULL);
458 ofnode ofnode_path(const char *path)
460 if (of_live_active())
461 return np_to_ofnode(of_find_node_by_path(path));
463 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
466 const void *ofnode_read_chosen_prop(const char *propname, int *sizep)
470 chosen_node = ofnode_path("/chosen");
472 return ofnode_read_prop(chosen_node, propname, sizep);
475 const char *ofnode_read_chosen_string(const char *propname)
477 return ofnode_read_chosen_prop(propname, NULL);
480 ofnode ofnode_get_chosen_node(const char *name)
484 prop = ofnode_read_chosen_prop(name, NULL);
486 return ofnode_null();
488 return ofnode_path(prop);
491 const void *ofnode_read_aliases_prop(const char *propname, int *sizep)
495 node = ofnode_path("/aliases");
497 return ofnode_read_prop(node, propname, sizep);
500 ofnode ofnode_get_aliases_node(const char *name)
504 prop = ofnode_read_aliases_prop(name, NULL);
506 return ofnode_null();
508 debug("%s: node_path: %s\n", __func__, prop);
510 return ofnode_path(prop);
513 int ofnode_get_child_count(ofnode parent)
518 ofnode_for_each_subnode(child, parent)
524 static int decode_timing_property(ofnode node, const char *name,
525 struct timing_entry *result)
529 length = ofnode_read_size(node, name);
531 debug("%s: could not find property %s\n",
532 ofnode_get_name(node), name);
536 if (length == sizeof(u32)) {
537 result->typ = ofnode_read_u32_default(node, name, 0);
538 result->min = result->typ;
539 result->max = result->typ;
541 ret = ofnode_read_u32_array(node, name, &result->min, 3);
547 int ofnode_decode_display_timing(ofnode parent, int index,
548 struct display_timing *dt)
551 ofnode timings, node;
555 timings = ofnode_find_subnode(parent, "display-timings");
556 if (!ofnode_valid(timings))
560 ofnode_for_each_subnode(node, timings) {
565 if (!ofnode_valid(node))
568 memset(dt, 0, sizeof(*dt));
570 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
571 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
572 ret |= decode_timing_property(node, "hactive", &dt->hactive);
573 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
574 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
575 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
576 ret |= decode_timing_property(node, "vactive", &dt->vactive);
577 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
578 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
581 val = ofnode_read_u32_default(node, "vsync-active", -1);
583 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
584 DISPLAY_FLAGS_VSYNC_LOW;
586 val = ofnode_read_u32_default(node, "hsync-active", -1);
588 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
589 DISPLAY_FLAGS_HSYNC_LOW;
591 val = ofnode_read_u32_default(node, "de-active", -1);
593 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
594 DISPLAY_FLAGS_DE_LOW;
596 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
598 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
599 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
602 if (ofnode_read_bool(node, "interlaced"))
603 dt->flags |= DISPLAY_FLAGS_INTERLACED;
604 if (ofnode_read_bool(node, "doublescan"))
605 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
606 if (ofnode_read_bool(node, "doubleclk"))
607 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
612 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
614 if (ofnode_is_np(node))
615 return of_get_property(ofnode_to_np(node), propname, lenp);
617 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
621 int ofnode_get_first_property(ofnode node, struct ofprop *prop)
625 if (ofnode_is_np(node)) {
626 prop->prop = of_get_first_property(ofnode_to_np(prop->node));
628 return -FDT_ERR_NOTFOUND;
631 fdt_first_property_offset(gd->fdt_blob,
632 ofnode_to_offset(prop->node));
633 if (prop->offset < 0)
640 int ofnode_get_next_property(struct ofprop *prop)
642 if (ofnode_is_np(prop->node)) {
643 prop->prop = of_get_next_property(ofnode_to_np(prop->node),
646 return -FDT_ERR_NOTFOUND;
648 prop->offset = fdt_next_property_offset(gd->fdt_blob,
650 if (prop->offset < 0)
657 const void *ofnode_get_property_by_prop(const struct ofprop *prop,
658 const char **propname, int *lenp)
660 if (ofnode_is_np(prop->node))
661 return of_get_property_by_prop(ofnode_to_np(prop->node),
662 prop->prop, propname, lenp);
664 return fdt_getprop_by_offset(gd->fdt_blob,
669 bool ofnode_is_available(ofnode node)
671 if (ofnode_is_np(node))
672 return of_device_is_available(ofnode_to_np(node));
674 return fdtdec_get_is_enabled(gd->fdt_blob,
675 ofnode_to_offset(node));
678 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
681 if (ofnode_is_np(node)) {
684 const struct device_node *np = ofnode_to_np(node);
685 const __be32 *prop = of_get_property(np, property, &psize);
688 return FDT_ADDR_T_NONE;
689 na = of_n_addr_cells(np);
690 ns = of_n_size_cells(np);
691 *sizep = of_read_number(prop + na, ns);
693 if (CONFIG_IS_ENABLED(OF_TRANSLATE) && ns > 0)
694 return of_translate_address(np, prop);
696 return of_read_number(prop, na);
698 return fdtdec_get_addr_size(gd->fdt_blob,
699 ofnode_to_offset(node), property,
704 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
707 if (ofnode_is_np(node)) {
708 const struct device_node *np = ofnode_to_np(node);
710 const __be32 *prop = of_get_property(np, propname, &psize);
712 if (!prop || sz != psize)
714 return (uint8_t *)prop;
717 return fdtdec_locate_byte_array(gd->fdt_blob,
718 ofnode_to_offset(node), propname, sz);
722 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
723 const char *propname, struct fdt_pci_addr *addr)
729 debug("%s: %s: ", __func__, propname);
732 * If we follow the pci bus bindings strictly, we should check
733 * the value of the node's parent node's #address-cells and
734 * #size-cells. They need to be 3 and 2 accordingly. However,
735 * for simplicity we skip the check here.
737 cell = ofnode_get_property(node, propname, &len);
741 if ((len % FDT_PCI_REG_SIZE) == 0) {
742 int num = len / FDT_PCI_REG_SIZE;
745 for (i = 0; i < num; i++) {
746 debug("pci address #%d: %08lx %08lx %08lx\n", i,
747 (ulong)fdt32_to_cpu(cell[0]),
748 (ulong)fdt32_to_cpu(cell[1]),
749 (ulong)fdt32_to_cpu(cell[2]));
750 if ((fdt32_to_cpu(*cell) & type) == type) {
751 addr->phys_hi = fdt32_to_cpu(cell[0]);
752 addr->phys_mid = fdt32_to_cpu(cell[1]);
753 addr->phys_lo = fdt32_to_cpu(cell[2]);
757 cell += (FDT_PCI_ADDR_CELLS +
772 debug("(not found)\n");
776 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device)
778 const char *list, *end;
781 list = ofnode_get_property(node, "compatible", &len);
788 if (len >= strlen("pciVVVV,DDDD")) {
789 char *s = strstr(list, "pci");
792 * check if the string is something like pciVVVV,DDDD.RR
793 * or just pciVVVV,DDDD
795 if (s && s[7] == ',' &&
796 (s[12] == '.' || s[12] == 0)) {
798 *vendor = simple_strtol(s, NULL, 16);
801 *device = simple_strtol(s, NULL, 16);
812 int ofnode_read_addr_cells(ofnode node)
814 if (ofnode_is_np(node)) {
815 return of_n_addr_cells(ofnode_to_np(node));
817 int parent = fdt_parent_offset(gd->fdt_blob,
818 ofnode_to_offset(node));
820 return fdt_address_cells(gd->fdt_blob, parent);
824 int ofnode_read_size_cells(ofnode node)
826 if (ofnode_is_np(node)) {
827 return of_n_size_cells(ofnode_to_np(node));
829 int parent = fdt_parent_offset(gd->fdt_blob,
830 ofnode_to_offset(node));
832 return fdt_size_cells(gd->fdt_blob, parent);
836 int ofnode_read_simple_addr_cells(ofnode node)
838 if (ofnode_is_np(node))
839 return of_simple_addr_cells(ofnode_to_np(node));
841 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
844 int ofnode_read_simple_size_cells(ofnode node)
846 if (ofnode_is_np(node))
847 return of_simple_size_cells(ofnode_to_np(node));
849 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
852 bool ofnode_pre_reloc(ofnode node)
854 #if defined(CONFIG_SPL_BUILD) || defined(CONFIG_TPL_BUILD)
855 /* for SPL and TPL the remaining nodes after the fdtgrep 1st pass
856 * had property dm-pre-reloc or u-boot,dm-spl/tpl.
857 * They are removed in final dtb (fdtgrep 2nd pass)
861 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
863 if (ofnode_read_bool(node, "u-boot,dm-pre-proper"))
867 * In regular builds individual spl and tpl handling both
868 * count as handled pre-relocation for later second init.
870 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
871 ofnode_read_bool(node, "u-boot,dm-tpl"))
878 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
880 if (ofnode_is_np(node)) {
881 return of_address_to_resource(ofnode_to_np(node), index, res);
883 struct fdt_resource fres;
886 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
887 "reg", index, &fres);
890 memset(res, '\0', sizeof(*res));
891 res->start = fres.start;
898 int ofnode_read_resource_byname(ofnode node, const char *name,
899 struct resource *res)
903 index = ofnode_stringlist_search(node, "reg-names", name);
907 return ofnode_read_resource(node, index, res);
910 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
912 if (ofnode_is_np(node))
913 return of_translate_address(ofnode_to_np(node), in_addr);
915 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
918 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr)
920 if (ofnode_is_np(node))
921 return of_translate_dma_address(ofnode_to_np(node), in_addr);
923 return fdt_translate_dma_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
926 int ofnode_device_is_compatible(ofnode node, const char *compat)
928 if (ofnode_is_np(node))
929 return of_device_is_compatible(ofnode_to_np(node), compat,
932 return !fdt_node_check_compatible(gd->fdt_blob,
933 ofnode_to_offset(node),
937 ofnode ofnode_by_compatible(ofnode from, const char *compat)
939 if (of_live_active()) {
940 return np_to_ofnode(of_find_compatible_node(
941 (struct device_node *)ofnode_to_np(from), NULL,
944 return offset_to_ofnode(fdt_node_offset_by_compatible(
945 gd->fdt_blob, ofnode_to_offset(from), compat));
949 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
950 const void *propval, int proplen)
952 if (of_live_active()) {
953 return np_to_ofnode(of_find_node_by_prop_value(
954 (struct device_node *)ofnode_to_np(from), propname,
957 return offset_to_ofnode(fdt_node_offset_by_prop_value(
958 gd->fdt_blob, ofnode_to_offset(from),
959 propname, propval, proplen));
963 int ofnode_write_prop(ofnode node, const char *propname, int len,
966 const struct device_node *np = ofnode_to_np(node);
968 struct property *pp_last = NULL;
969 struct property *new;
971 if (!of_live_active())
977 for (pp = np->properties; pp; pp = pp->next) {
978 if (strcmp(pp->name, propname) == 0) {
979 /* Property exists -> change value */
980 pp->value = (void *)value;
990 /* Property does not exist -> append new property */
991 new = malloc(sizeof(struct property));
995 new->name = strdup(propname);
1001 new->value = (void *)value;
1005 pp_last->next = new;
1010 int ofnode_write_string(ofnode node, const char *propname, const char *value)
1012 if (!of_live_active())
1015 assert(ofnode_valid(node));
1017 debug("%s: %s = %s", __func__, propname, value);
1019 return ofnode_write_prop(node, propname, strlen(value) + 1, value);
1022 int ofnode_set_enabled(ofnode node, bool value)
1024 if (!of_live_active())
1027 assert(ofnode_valid(node));
1030 return ofnode_write_string(node, "status", "okay");
1032 return ofnode_write_string(node, "status", "disabled");