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 ofnode ofnode_first_subnode(ofnode node)
231 assert(ofnode_valid(node));
232 if (ofnode_is_np(node))
233 return np_to_ofnode(node.np->child);
235 return offset_to_ofnode(
236 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
239 ofnode ofnode_next_subnode(ofnode node)
241 assert(ofnode_valid(node));
242 if (ofnode_is_np(node))
243 return np_to_ofnode(node.np->sibling);
245 return offset_to_ofnode(
246 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
249 ofnode ofnode_get_parent(ofnode node)
253 assert(ofnode_valid(node));
254 if (ofnode_is_np(node))
255 parent = np_to_ofnode(of_get_parent(ofnode_to_np(node)));
257 parent.of_offset = fdt_parent_offset(gd->fdt_blob,
258 ofnode_to_offset(node));
263 const char *ofnode_get_name(ofnode node)
265 if (!ofnode_valid(node)) {
266 debug("%s node not valid\n", __func__);
270 if (ofnode_is_np(node))
271 return strrchr(node.np->full_name, '/') + 1;
273 return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
276 ofnode ofnode_get_by_phandle(uint phandle)
280 if (of_live_active())
281 node = np_to_ofnode(of_find_node_by_phandle(phandle));
283 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
289 fdt_addr_t ofnode_get_addr_size_index(ofnode node, int index, fdt_size_t *size)
293 if (ofnode_is_np(node)) {
294 const __be32 *prop_val;
298 prop_val = of_get_address(ofnode_to_np(node), index, &size64,
301 return FDT_ADDR_T_NONE;
305 ns = of_n_size_cells(ofnode_to_np(node));
307 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
308 return of_translate_address(ofnode_to_np(node), prop_val);
310 na = of_n_addr_cells(ofnode_to_np(node));
311 return of_read_number(prop_val, na);
314 na = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
315 ns = ofnode_read_simple_size_cells(ofnode_get_parent(node));
316 return fdtdec_get_addr_size_fixed(gd->fdt_blob,
317 ofnode_to_offset(node), "reg",
318 index, na, ns, size, true);
321 return FDT_ADDR_T_NONE;
324 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
328 return ofnode_get_addr_size_index(node, index, &size);
331 fdt_addr_t ofnode_get_addr(ofnode node)
333 return ofnode_get_addr_index(node, 0);
336 int ofnode_stringlist_search(ofnode node, const char *property,
339 if (ofnode_is_np(node)) {
340 return of_property_match_string(ofnode_to_np(node),
345 ret = fdt_stringlist_search(gd->fdt_blob,
346 ofnode_to_offset(node), property,
348 if (ret == -FDT_ERR_NOTFOUND)
357 int ofnode_read_string_index(ofnode node, const char *property, int index,
360 if (ofnode_is_np(node)) {
361 return of_property_read_string_index(ofnode_to_np(node),
362 property, index, outp);
366 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
367 property, index, &len);
374 int ofnode_read_string_count(ofnode node, const char *property)
376 if (ofnode_is_np(node)) {
377 return of_property_count_strings(ofnode_to_np(node), property);
379 return fdt_stringlist_count(gd->fdt_blob,
380 ofnode_to_offset(node), property);
384 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
385 struct ofnode_phandle_args *out)
387 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
388 out->node = offset_to_ofnode(in->node);
389 out->args_count = in->args_count;
390 memcpy(out->args, in->args, sizeof(out->args));
393 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
394 struct ofnode_phandle_args *out)
396 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
397 out->node = np_to_ofnode(in->np);
398 out->args_count = in->args_count;
399 memcpy(out->args, in->args, sizeof(out->args));
402 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
403 const char *cells_name, int cell_count,
405 struct ofnode_phandle_args *out_args)
407 if (ofnode_is_np(node)) {
408 struct of_phandle_args args;
411 ret = of_parse_phandle_with_args(ofnode_to_np(node),
412 list_name, cells_name,
417 ofnode_from_of_phandle_args(&args, out_args);
419 struct fdtdec_phandle_args args;
422 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
423 ofnode_to_offset(node),
424 list_name, cells_name,
425 cell_count, index, &args);
428 ofnode_from_fdtdec_phandle_args(&args, out_args);
434 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
435 const char *cells_name, int cell_count)
437 if (ofnode_is_np(node))
438 return of_count_phandle_with_args(ofnode_to_np(node),
439 list_name, cells_name, cell_count);
441 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
442 ofnode_to_offset(node), list_name, cells_name,
443 cell_count, -1, NULL);
446 ofnode ofnode_path(const char *path)
448 if (of_live_active())
449 return np_to_ofnode(of_find_node_by_path(path));
451 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
454 const void *ofnode_read_chosen_prop(const char *propname, int *sizep)
458 chosen_node = ofnode_path("/chosen");
460 return ofnode_read_prop(chosen_node, propname, sizep);
463 const char *ofnode_read_chosen_string(const char *propname)
465 return ofnode_read_chosen_prop(propname, NULL);
468 ofnode ofnode_get_chosen_node(const char *name)
472 prop = ofnode_read_chosen_prop(name, NULL);
474 return ofnode_null();
476 return ofnode_path(prop);
479 const void *ofnode_read_aliases_prop(const char *propname, int *sizep)
483 node = ofnode_path("/aliases");
485 return ofnode_read_prop(node, propname, sizep);
488 ofnode ofnode_get_aliases_node(const char *name)
492 prop = ofnode_read_aliases_prop(name, NULL);
494 return ofnode_null();
496 debug("%s: node_path: %s\n", __func__, prop);
498 return ofnode_path(prop);
501 int ofnode_get_child_count(ofnode parent)
506 ofnode_for_each_subnode(child, parent)
512 static int decode_timing_property(ofnode node, const char *name,
513 struct timing_entry *result)
517 length = ofnode_read_size(node, name);
519 debug("%s: could not find property %s\n",
520 ofnode_get_name(node), name);
524 if (length == sizeof(u32)) {
525 result->typ = ofnode_read_u32_default(node, name, 0);
526 result->min = result->typ;
527 result->max = result->typ;
529 ret = ofnode_read_u32_array(node, name, &result->min, 3);
535 int ofnode_decode_display_timing(ofnode parent, int index,
536 struct display_timing *dt)
539 ofnode timings, node;
543 timings = ofnode_find_subnode(parent, "display-timings");
544 if (!ofnode_valid(timings))
548 ofnode_for_each_subnode(node, timings) {
553 if (!ofnode_valid(node))
556 memset(dt, 0, sizeof(*dt));
558 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
559 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
560 ret |= decode_timing_property(node, "hactive", &dt->hactive);
561 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
562 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
563 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
564 ret |= decode_timing_property(node, "vactive", &dt->vactive);
565 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
566 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
569 val = ofnode_read_u32_default(node, "vsync-active", -1);
571 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
572 DISPLAY_FLAGS_VSYNC_LOW;
574 val = ofnode_read_u32_default(node, "hsync-active", -1);
576 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
577 DISPLAY_FLAGS_HSYNC_LOW;
579 val = ofnode_read_u32_default(node, "de-active", -1);
581 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
582 DISPLAY_FLAGS_DE_LOW;
584 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
586 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
587 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
590 if (ofnode_read_bool(node, "interlaced"))
591 dt->flags |= DISPLAY_FLAGS_INTERLACED;
592 if (ofnode_read_bool(node, "doublescan"))
593 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
594 if (ofnode_read_bool(node, "doubleclk"))
595 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
600 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
602 if (ofnode_is_np(node))
603 return of_get_property(ofnode_to_np(node), propname, lenp);
605 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
609 int ofnode_get_first_property(ofnode node, struct ofprop *prop)
613 if (ofnode_is_np(node)) {
614 prop->prop = of_get_first_property(ofnode_to_np(prop->node));
616 return -FDT_ERR_NOTFOUND;
619 fdt_first_property_offset(gd->fdt_blob,
620 ofnode_to_offset(prop->node));
621 if (prop->offset < 0)
628 int ofnode_get_next_property(struct ofprop *prop)
630 if (ofnode_is_np(prop->node)) {
631 prop->prop = of_get_next_property(ofnode_to_np(prop->node),
634 return -FDT_ERR_NOTFOUND;
636 prop->offset = fdt_next_property_offset(gd->fdt_blob,
638 if (prop->offset < 0)
645 const void *ofnode_get_property_by_prop(const struct ofprop *prop,
646 const char **propname, int *lenp)
648 if (ofnode_is_np(prop->node))
649 return of_get_property_by_prop(ofnode_to_np(prop->node),
650 prop->prop, propname, lenp);
652 return fdt_getprop_by_offset(gd->fdt_blob,
657 bool ofnode_is_available(ofnode node)
659 if (ofnode_is_np(node))
660 return of_device_is_available(ofnode_to_np(node));
662 return fdtdec_get_is_enabled(gd->fdt_blob,
663 ofnode_to_offset(node));
666 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
669 if (ofnode_is_np(node)) {
672 const struct device_node *np = ofnode_to_np(node);
673 const __be32 *prop = of_get_property(np, property, &psize);
676 return FDT_ADDR_T_NONE;
677 na = of_n_addr_cells(np);
678 ns = of_n_size_cells(np);
679 *sizep = of_read_number(prop + na, ns);
681 if (CONFIG_IS_ENABLED(OF_TRANSLATE) && ns > 0)
682 return of_translate_address(np, prop);
684 return of_read_number(prop, na);
686 return fdtdec_get_addr_size(gd->fdt_blob,
687 ofnode_to_offset(node), property,
692 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
695 if (ofnode_is_np(node)) {
696 const struct device_node *np = ofnode_to_np(node);
698 const __be32 *prop = of_get_property(np, propname, &psize);
700 if (!prop || sz != psize)
702 return (uint8_t *)prop;
705 return fdtdec_locate_byte_array(gd->fdt_blob,
706 ofnode_to_offset(node), propname, sz);
710 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
711 const char *propname, struct fdt_pci_addr *addr)
717 debug("%s: %s: ", __func__, propname);
720 * If we follow the pci bus bindings strictly, we should check
721 * the value of the node's parent node's #address-cells and
722 * #size-cells. They need to be 3 and 2 accordingly. However,
723 * for simplicity we skip the check here.
725 cell = ofnode_get_property(node, propname, &len);
729 if ((len % FDT_PCI_REG_SIZE) == 0) {
730 int num = len / FDT_PCI_REG_SIZE;
733 for (i = 0; i < num; i++) {
734 debug("pci address #%d: %08lx %08lx %08lx\n", i,
735 (ulong)fdt32_to_cpu(cell[0]),
736 (ulong)fdt32_to_cpu(cell[1]),
737 (ulong)fdt32_to_cpu(cell[2]));
738 if ((fdt32_to_cpu(*cell) & type) == type) {
739 addr->phys_hi = fdt32_to_cpu(cell[0]);
740 addr->phys_mid = fdt32_to_cpu(cell[1]);
741 addr->phys_lo = fdt32_to_cpu(cell[2]);
745 cell += (FDT_PCI_ADDR_CELLS +
760 debug("(not found)\n");
764 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device)
766 const char *list, *end;
769 list = ofnode_get_property(node, "compatible", &len);
776 if (len >= strlen("pciVVVV,DDDD")) {
777 char *s = strstr(list, "pci");
780 * check if the string is something like pciVVVV,DDDD.RR
781 * or just pciVVVV,DDDD
783 if (s && s[7] == ',' &&
784 (s[12] == '.' || s[12] == 0)) {
786 *vendor = simple_strtol(s, NULL, 16);
789 *device = simple_strtol(s, NULL, 16);
800 int ofnode_read_addr_cells(ofnode node)
802 if (ofnode_is_np(node)) {
803 return of_n_addr_cells(ofnode_to_np(node));
805 int parent = fdt_parent_offset(gd->fdt_blob,
806 ofnode_to_offset(node));
808 return fdt_address_cells(gd->fdt_blob, parent);
812 int ofnode_read_size_cells(ofnode node)
814 if (ofnode_is_np(node)) {
815 return of_n_size_cells(ofnode_to_np(node));
817 int parent = fdt_parent_offset(gd->fdt_blob,
818 ofnode_to_offset(node));
820 return fdt_size_cells(gd->fdt_blob, parent);
824 int ofnode_read_simple_addr_cells(ofnode node)
826 if (ofnode_is_np(node))
827 return of_simple_addr_cells(ofnode_to_np(node));
829 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
832 int ofnode_read_simple_size_cells(ofnode node)
834 if (ofnode_is_np(node))
835 return of_simple_size_cells(ofnode_to_np(node));
837 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
840 bool ofnode_pre_reloc(ofnode node)
842 #if defined(CONFIG_SPL_BUILD) || defined(CONFIG_TPL_BUILD)
843 /* for SPL and TPL the remaining nodes after the fdtgrep 1st pass
844 * had property dm-pre-reloc or u-boot,dm-spl/tpl.
845 * They are removed in final dtb (fdtgrep 2nd pass)
849 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
851 if (ofnode_read_bool(node, "u-boot,dm-pre-proper"))
855 * In regular builds individual spl and tpl handling both
856 * count as handled pre-relocation for later second init.
858 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
859 ofnode_read_bool(node, "u-boot,dm-tpl"))
866 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
868 if (ofnode_is_np(node)) {
869 return of_address_to_resource(ofnode_to_np(node), index, res);
871 struct fdt_resource fres;
874 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
875 "reg", index, &fres);
878 memset(res, '\0', sizeof(*res));
879 res->start = fres.start;
886 int ofnode_read_resource_byname(ofnode node, const char *name,
887 struct resource *res)
891 index = ofnode_stringlist_search(node, "reg-names", name);
895 return ofnode_read_resource(node, index, res);
898 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
900 if (ofnode_is_np(node))
901 return of_translate_address(ofnode_to_np(node), in_addr);
903 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
906 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr)
908 if (ofnode_is_np(node))
909 return of_translate_dma_address(ofnode_to_np(node), in_addr);
911 return fdt_translate_dma_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
914 int ofnode_device_is_compatible(ofnode node, const char *compat)
916 if (ofnode_is_np(node))
917 return of_device_is_compatible(ofnode_to_np(node), compat,
920 return !fdt_node_check_compatible(gd->fdt_blob,
921 ofnode_to_offset(node),
925 ofnode ofnode_by_compatible(ofnode from, const char *compat)
927 if (of_live_active()) {
928 return np_to_ofnode(of_find_compatible_node(
929 (struct device_node *)ofnode_to_np(from), NULL,
932 return offset_to_ofnode(fdt_node_offset_by_compatible(
933 gd->fdt_blob, ofnode_to_offset(from), compat));
937 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
938 const void *propval, int proplen)
940 if (of_live_active()) {
941 return np_to_ofnode(of_find_node_by_prop_value(
942 (struct device_node *)ofnode_to_np(from), propname,
945 return offset_to_ofnode(fdt_node_offset_by_prop_value(
946 gd->fdt_blob, ofnode_to_offset(from),
947 propname, propval, proplen));
951 int ofnode_write_prop(ofnode node, const char *propname, int len,
954 const struct device_node *np = ofnode_to_np(node);
956 struct property *pp_last = NULL;
957 struct property *new;
959 if (!of_live_active())
965 for (pp = np->properties; pp; pp = pp->next) {
966 if (strcmp(pp->name, propname) == 0) {
967 /* Property exists -> change value */
968 pp->value = (void *)value;
978 /* Property does not exist -> append new property */
979 new = malloc(sizeof(struct property));
983 new->name = strdup(propname);
989 new->value = (void *)value;
998 int ofnode_write_string(ofnode node, const char *propname, const char *value)
1000 if (!of_live_active())
1003 assert(ofnode_valid(node));
1005 debug("%s: %s = %s", __func__, propname, value);
1007 return ofnode_write_prop(node, propname, strlen(value) + 1, value);
1010 int ofnode_set_enabled(ofnode node, bool value)
1012 if (!of_live_active())
1015 assert(ofnode_valid(node));
1018 return ofnode_write_string(node, "status", "okay");
1020 return ofnode_write_string(node, "status", "disabled");