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)
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 char *ofnode_read_string(ofnode node, const char *propname)
106 const char *str = 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, NULL);
121 str = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
125 debug("<not found>\n");
128 if (strnlen(str, len) >= len) {
129 debug("<invalid>\n");
137 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name)
141 assert(ofnode_valid(node));
142 debug("%s: %s: ", __func__, subnode_name);
144 if (ofnode_is_np(node)) {
145 const struct device_node *np = ofnode_to_np(node);
147 for (np = np->child; np; np = np->sibling) {
148 if (!strcmp(subnode_name, np->name))
151 subnode = np_to_ofnode(np);
153 int ooffset = fdt_subnode_offset(gd->fdt_blob,
154 ofnode_to_offset(node), subnode_name);
155 subnode = offset_to_ofnode(ooffset);
157 debug("%s\n", ofnode_valid(subnode) ?
158 ofnode_get_name(subnode) : "<none>");
163 int ofnode_read_u32_array(ofnode node, const char *propname,
164 u32 *out_values, size_t sz)
166 assert(ofnode_valid(node));
167 debug("%s: %s: ", __func__, propname);
169 if (ofnode_is_np(node)) {
170 return of_read_u32_array(ofnode_to_np(node), propname,
173 return fdtdec_get_int_array(gd->fdt_blob,
174 ofnode_to_offset(node), propname,
179 ofnode ofnode_first_subnode(ofnode node)
181 assert(ofnode_valid(node));
182 if (ofnode_is_np(node))
183 return np_to_ofnode(node.np->child);
185 return offset_to_ofnode(
186 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
189 ofnode ofnode_next_subnode(ofnode node)
191 assert(ofnode_valid(node));
192 if (ofnode_is_np(node))
193 return np_to_ofnode(node.np->sibling);
195 return offset_to_ofnode(
196 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
199 ofnode ofnode_get_parent(ofnode node)
203 assert(ofnode_valid(node));
204 if (ofnode_is_np(node))
205 parent = np_to_ofnode(of_get_parent(ofnode_to_np(node)));
207 parent.of_offset = fdt_parent_offset(gd->fdt_blob,
208 ofnode_to_offset(node));
213 const char *ofnode_get_name(ofnode node)
215 if (!ofnode_valid(node)) {
216 debug("%s node not valid\n", __func__);
220 if (ofnode_is_np(node))
221 return strrchr(node.np->full_name, '/') + 1;
223 return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
226 ofnode ofnode_get_by_phandle(uint phandle)
230 if (of_live_active())
231 node = np_to_ofnode(of_find_node_by_phandle(phandle));
233 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
239 int ofnode_read_size(ofnode node, const char *propname)
243 if (ofnode_is_np(node)) {
244 struct property *prop = of_find_property(
245 ofnode_to_np(node), propname, NULL);
250 if (fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
258 fdt_addr_t ofnode_get_addr_size_index(ofnode node, int index, fdt_size_t *size)
262 if (ofnode_is_np(node)) {
263 const __be32 *prop_val;
266 prop_val = of_get_address(ofnode_to_np(node), index,
267 (u64 *)size, &flags);
269 return FDT_ADDR_T_NONE;
271 ns = of_n_size_cells(ofnode_to_np(node));
273 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
274 return of_translate_address(ofnode_to_np(node), prop_val);
276 na = of_n_addr_cells(ofnode_to_np(node));
277 return of_read_number(prop_val, na);
280 na = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
281 ns = ofnode_read_simple_size_cells(ofnode_get_parent(node));
282 return fdtdec_get_addr_size_fixed(gd->fdt_blob,
283 ofnode_to_offset(node), "reg",
284 index, na, ns, size, true);
287 return FDT_ADDR_T_NONE;
290 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
294 return ofnode_get_addr_size_index(node, index, &size);
297 fdt_addr_t ofnode_get_addr(ofnode node)
299 return ofnode_get_addr_index(node, 0);
302 int ofnode_stringlist_search(ofnode node, const char *property,
305 if (ofnode_is_np(node)) {
306 return of_property_match_string(ofnode_to_np(node),
311 ret = fdt_stringlist_search(gd->fdt_blob,
312 ofnode_to_offset(node), property,
314 if (ret == -FDT_ERR_NOTFOUND)
323 int ofnode_read_string_index(ofnode node, const char *property, int index,
326 if (ofnode_is_np(node)) {
327 return of_property_read_string_index(ofnode_to_np(node),
328 property, index, outp);
332 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
333 property, index, &len);
340 int ofnode_read_string_count(ofnode node, const char *property)
342 if (ofnode_is_np(node)) {
343 return of_property_count_strings(ofnode_to_np(node), property);
345 return fdt_stringlist_count(gd->fdt_blob,
346 ofnode_to_offset(node), property);
350 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
351 struct ofnode_phandle_args *out)
353 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
354 out->node = offset_to_ofnode(in->node);
355 out->args_count = in->args_count;
356 memcpy(out->args, in->args, sizeof(out->args));
359 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
360 struct ofnode_phandle_args *out)
362 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
363 out->node = np_to_ofnode(in->np);
364 out->args_count = in->args_count;
365 memcpy(out->args, in->args, sizeof(out->args));
368 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
369 const char *cells_name, int cell_count,
371 struct ofnode_phandle_args *out_args)
373 if (ofnode_is_np(node)) {
374 struct of_phandle_args args;
377 ret = of_parse_phandle_with_args(ofnode_to_np(node),
378 list_name, cells_name, index,
382 ofnode_from_of_phandle_args(&args, out_args);
384 struct fdtdec_phandle_args args;
387 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
388 ofnode_to_offset(node),
389 list_name, cells_name,
390 cell_count, index, &args);
393 ofnode_from_fdtdec_phandle_args(&args, out_args);
399 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
400 const char *cells_name)
402 if (ofnode_is_np(node))
403 return of_count_phandle_with_args(ofnode_to_np(node),
404 list_name, cells_name);
406 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
407 ofnode_to_offset(node), list_name, cells_name,
411 ofnode ofnode_path(const char *path)
413 if (of_live_active())
414 return np_to_ofnode(of_find_node_by_path(path));
416 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
419 const char *ofnode_get_chosen_prop(const char *name)
423 chosen_node = ofnode_path("/chosen");
425 return ofnode_read_string(chosen_node, name);
428 ofnode ofnode_get_chosen_node(const char *name)
432 prop = ofnode_get_chosen_prop(name);
434 return ofnode_null();
436 return ofnode_path(prop);
439 static int decode_timing_property(ofnode node, const char *name,
440 struct timing_entry *result)
444 length = ofnode_read_size(node, name);
446 debug("%s: could not find property %s\n",
447 ofnode_get_name(node), name);
451 if (length == sizeof(u32)) {
452 result->typ = ofnode_read_u32_default(node, name, 0);
453 result->min = result->typ;
454 result->max = result->typ;
456 ret = ofnode_read_u32_array(node, name, &result->min, 3);
462 int ofnode_decode_display_timing(ofnode parent, int index,
463 struct display_timing *dt)
466 ofnode timings, node;
470 timings = ofnode_find_subnode(parent, "display-timings");
471 if (!ofnode_valid(timings))
475 ofnode_for_each_subnode(node, timings) {
480 if (!ofnode_valid(node))
483 memset(dt, 0, sizeof(*dt));
485 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
486 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
487 ret |= decode_timing_property(node, "hactive", &dt->hactive);
488 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
489 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
490 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
491 ret |= decode_timing_property(node, "vactive", &dt->vactive);
492 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
493 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
496 val = ofnode_read_u32_default(node, "vsync-active", -1);
498 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
499 DISPLAY_FLAGS_VSYNC_LOW;
501 val = ofnode_read_u32_default(node, "hsync-active", -1);
503 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
504 DISPLAY_FLAGS_HSYNC_LOW;
506 val = ofnode_read_u32_default(node, "de-active", -1);
508 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
509 DISPLAY_FLAGS_DE_LOW;
511 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
513 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
514 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
517 if (ofnode_read_bool(node, "interlaced"))
518 dt->flags |= DISPLAY_FLAGS_INTERLACED;
519 if (ofnode_read_bool(node, "doublescan"))
520 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
521 if (ofnode_read_bool(node, "doubleclk"))
522 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
527 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
529 if (ofnode_is_np(node))
530 return of_get_property(ofnode_to_np(node), propname, lenp);
532 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
536 bool ofnode_is_available(ofnode node)
538 if (ofnode_is_np(node))
539 return of_device_is_available(ofnode_to_np(node));
541 return fdtdec_get_is_enabled(gd->fdt_blob,
542 ofnode_to_offset(node));
545 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
548 if (ofnode_is_np(node)) {
551 const struct device_node *np = ofnode_to_np(node);
552 const __be32 *prop = of_get_property(np, property, &psize);
555 return FDT_ADDR_T_NONE;
556 na = of_n_addr_cells(np);
557 ns = of_n_size_cells(np);
558 *sizep = of_read_number(prop + na, ns);
560 if (CONFIG_IS_ENABLED(OF_TRANSLATE) && ns > 0)
561 return of_translate_address(np, prop);
563 return of_read_number(prop, na);
565 return fdtdec_get_addr_size(gd->fdt_blob,
566 ofnode_to_offset(node), property,
571 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
574 if (ofnode_is_np(node)) {
575 const struct device_node *np = ofnode_to_np(node);
577 const __be32 *prop = of_get_property(np, propname, &psize);
579 if (!prop || sz != psize)
581 return (uint8_t *)prop;
584 return fdtdec_locate_byte_array(gd->fdt_blob,
585 ofnode_to_offset(node), propname, sz);
589 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
590 const char *propname, struct fdt_pci_addr *addr)
596 debug("%s: %s: ", __func__, propname);
599 * If we follow the pci bus bindings strictly, we should check
600 * the value of the node's parent node's #address-cells and
601 * #size-cells. They need to be 3 and 2 accordingly. However,
602 * for simplicity we skip the check here.
604 cell = ofnode_get_property(node, propname, &len);
608 if ((len % FDT_PCI_REG_SIZE) == 0) {
609 int num = len / FDT_PCI_REG_SIZE;
612 for (i = 0; i < num; i++) {
613 debug("pci address #%d: %08lx %08lx %08lx\n", i,
614 (ulong)fdt32_to_cpu(cell[0]),
615 (ulong)fdt32_to_cpu(cell[1]),
616 (ulong)fdt32_to_cpu(cell[2]));
617 if ((fdt32_to_cpu(*cell) & type) == type) {
618 addr->phys_hi = fdt32_to_cpu(cell[0]);
619 addr->phys_mid = fdt32_to_cpu(cell[1]);
620 addr->phys_lo = fdt32_to_cpu(cell[1]);
624 cell += (FDT_PCI_ADDR_CELLS +
639 debug("(not found)\n");
643 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device)
645 const char *list, *end;
648 list = ofnode_get_property(node, "compatible", &len);
655 if (len >= strlen("pciVVVV,DDDD")) {
656 char *s = strstr(list, "pci");
659 * check if the string is something like pciVVVV,DDDD.RR
660 * or just pciVVVV,DDDD
662 if (s && s[7] == ',' &&
663 (s[12] == '.' || s[12] == 0)) {
665 *vendor = simple_strtol(s, NULL, 16);
668 *device = simple_strtol(s, NULL, 16);
679 int ofnode_read_addr_cells(ofnode node)
681 if (ofnode_is_np(node))
682 return of_n_addr_cells(ofnode_to_np(node));
683 else /* NOTE: this call should walk up the parent stack */
684 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
687 int ofnode_read_size_cells(ofnode node)
689 if (ofnode_is_np(node))
690 return of_n_size_cells(ofnode_to_np(node));
691 else /* NOTE: this call should walk up the parent stack */
692 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
695 int ofnode_read_simple_addr_cells(ofnode node)
697 if (ofnode_is_np(node))
698 return of_simple_addr_cells(ofnode_to_np(node));
700 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
703 int ofnode_read_simple_size_cells(ofnode node)
705 if (ofnode_is_np(node))
706 return of_simple_size_cells(ofnode_to_np(node));
708 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
711 bool ofnode_pre_reloc(ofnode node)
713 #if defined(CONFIG_SPL_BUILD) || defined(CONFIG_TPL_BUILD)
714 /* for SPL and TPL the remaining nodes after the fdtgrep 1st pass
715 * had property dm-pre-reloc or u-boot,dm-spl/tpl.
716 * They are removed in final dtb (fdtgrep 2nd pass)
720 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
722 if (ofnode_read_bool(node, "u-boot,dm-pre-proper"))
726 * In regular builds individual spl and tpl handling both
727 * count as handled pre-relocation for later second init.
729 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
730 ofnode_read_bool(node, "u-boot,dm-tpl"))
737 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
739 if (ofnode_is_np(node)) {
740 return of_address_to_resource(ofnode_to_np(node), index, res);
742 struct fdt_resource fres;
745 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
746 "reg", index, &fres);
749 memset(res, '\0', sizeof(*res));
750 res->start = fres.start;
757 int ofnode_read_resource_byname(ofnode node, const char *name,
758 struct resource *res)
762 index = ofnode_stringlist_search(node, "reg-names", name);
766 return ofnode_read_resource(node, index, res);
769 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
771 if (ofnode_is_np(node))
772 return of_translate_address(ofnode_to_np(node), in_addr);
774 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
777 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr)
779 if (ofnode_is_np(node))
780 return of_translate_dma_address(ofnode_to_np(node), in_addr);
782 return fdt_translate_dma_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
785 int ofnode_device_is_compatible(ofnode node, const char *compat)
787 if (ofnode_is_np(node))
788 return of_device_is_compatible(ofnode_to_np(node), compat,
791 return !fdt_node_check_compatible(gd->fdt_blob,
792 ofnode_to_offset(node),
796 ofnode ofnode_by_compatible(ofnode from, const char *compat)
798 if (of_live_active()) {
799 return np_to_ofnode(of_find_compatible_node(
800 (struct device_node *)ofnode_to_np(from), NULL,
803 return offset_to_ofnode(fdt_node_offset_by_compatible(
804 gd->fdt_blob, ofnode_to_offset(from), compat));
808 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
809 const void *propval, int proplen)
811 if (of_live_active()) {
812 return np_to_ofnode(of_find_node_by_prop_value(
813 (struct device_node *)ofnode_to_np(from), propname,
816 return offset_to_ofnode(fdt_node_offset_by_prop_value(
817 gd->fdt_blob, ofnode_to_offset(from),
818 propname, propval, proplen));
822 int ofnode_write_prop(ofnode node, const char *propname, int len,
825 const struct device_node *np = ofnode_to_np(node);
827 struct property *pp_last = NULL;
828 struct property *new;
830 if (!of_live_active())
836 for (pp = np->properties; pp; pp = pp->next) {
837 if (strcmp(pp->name, propname) == 0) {
838 /* Property exists -> change value */
839 pp->value = (void *)value;
849 /* Property does not exist -> append new property */
850 new = malloc(sizeof(struct property));
854 new->name = strdup(propname);
860 new->value = (void *)value;
869 int ofnode_write_string(ofnode node, const char *propname, const char *value)
871 if (!of_live_active())
874 assert(ofnode_valid(node));
876 debug("%s: %s = %s", __func__, propname, value);
878 return ofnode_write_prop(node, propname, strlen(value) + 1, value);
881 int ofnode_set_enabled(ofnode node, bool value)
883 if (!of_live_active())
886 assert(ofnode_valid(node));
889 return ofnode_write_string(node, "status", "okay");
891 return ofnode_write_string(node, "status", "disabled");