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 int 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 int 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 assert(ofnode_valid(node));
216 if (ofnode_is_np(node))
217 return strrchr(node.np->full_name, '/') + 1;
219 return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
222 ofnode ofnode_get_by_phandle(uint phandle)
226 if (of_live_active())
227 node = np_to_ofnode(of_find_node_by_phandle(phandle));
229 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
235 int ofnode_read_size(ofnode node, const char *propname)
239 if (ofnode_is_np(node)) {
240 struct property *prop = of_find_property(
241 ofnode_to_np(node), propname, NULL);
246 if (fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
254 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
258 if (ofnode_is_np(node)) {
259 const __be32 *prop_val;
262 prop_val = of_get_address(ofnode_to_np(node), index,
265 return FDT_ADDR_T_NONE;
267 ns = of_n_size_cells(ofnode_to_np(node));
269 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
270 return of_translate_address(ofnode_to_np(node), prop_val);
272 na = of_n_addr_cells(ofnode_to_np(node));
273 return of_read_number(prop_val, na);
276 na = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
277 ns = ofnode_read_simple_size_cells(ofnode_get_parent(node));
278 return fdtdec_get_addr_size_fixed(gd->fdt_blob,
279 ofnode_to_offset(node), "reg",
280 index, na, ns, NULL, true);
283 return FDT_ADDR_T_NONE;
286 fdt_addr_t ofnode_get_addr(ofnode node)
288 return ofnode_get_addr_index(node, 0);
291 int ofnode_stringlist_search(ofnode node, const char *property,
294 if (ofnode_is_np(node)) {
295 return of_property_match_string(ofnode_to_np(node),
300 ret = fdt_stringlist_search(gd->fdt_blob,
301 ofnode_to_offset(node), property,
303 if (ret == -FDT_ERR_NOTFOUND)
312 int ofnode_read_string_index(ofnode node, const char *property, int index,
315 if (ofnode_is_np(node)) {
316 return of_property_read_string_index(ofnode_to_np(node),
317 property, index, outp);
321 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
322 property, index, &len);
329 int ofnode_read_string_count(ofnode node, const char *property)
331 if (ofnode_is_np(node)) {
332 return of_property_count_strings(ofnode_to_np(node), property);
334 return fdt_stringlist_count(gd->fdt_blob,
335 ofnode_to_offset(node), property);
339 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
340 struct ofnode_phandle_args *out)
342 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
343 out->node = offset_to_ofnode(in->node);
344 out->args_count = in->args_count;
345 memcpy(out->args, in->args, sizeof(out->args));
348 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
349 struct ofnode_phandle_args *out)
351 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
352 out->node = np_to_ofnode(in->np);
353 out->args_count = in->args_count;
354 memcpy(out->args, in->args, sizeof(out->args));
357 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
358 const char *cells_name, int cell_count,
360 struct ofnode_phandle_args *out_args)
362 if (ofnode_is_np(node)) {
363 struct of_phandle_args args;
366 ret = of_parse_phandle_with_args(ofnode_to_np(node),
367 list_name, cells_name, index,
371 ofnode_from_of_phandle_args(&args, out_args);
373 struct fdtdec_phandle_args args;
376 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
377 ofnode_to_offset(node),
378 list_name, cells_name,
379 cell_count, index, &args);
382 ofnode_from_fdtdec_phandle_args(&args, out_args);
388 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
389 const char *cells_name)
391 if (ofnode_is_np(node))
392 return of_count_phandle_with_args(ofnode_to_np(node),
393 list_name, cells_name);
395 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
396 ofnode_to_offset(node), list_name, cells_name,
400 ofnode ofnode_path(const char *path)
402 if (of_live_active())
403 return np_to_ofnode(of_find_node_by_path(path));
405 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
408 const char *ofnode_get_chosen_prop(const char *name)
412 chosen_node = ofnode_path("/chosen");
414 return ofnode_read_string(chosen_node, name);
417 ofnode ofnode_get_chosen_node(const char *name)
421 prop = ofnode_get_chosen_prop(name);
423 return ofnode_null();
425 return ofnode_path(prop);
428 static int decode_timing_property(ofnode node, const char *name,
429 struct timing_entry *result)
433 length = ofnode_read_size(node, name);
435 debug("%s: could not find property %s\n",
436 ofnode_get_name(node), name);
440 if (length == sizeof(u32)) {
441 result->typ = ofnode_read_u32_default(node, name, 0);
442 result->min = result->typ;
443 result->max = result->typ;
445 ret = ofnode_read_u32_array(node, name, &result->min, 3);
451 int ofnode_decode_display_timing(ofnode parent, int index,
452 struct display_timing *dt)
455 ofnode timings, node;
459 timings = ofnode_find_subnode(parent, "display-timings");
460 if (!ofnode_valid(timings))
464 ofnode_for_each_subnode(node, timings) {
469 if (!ofnode_valid(node))
472 memset(dt, 0, sizeof(*dt));
474 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
475 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
476 ret |= decode_timing_property(node, "hactive", &dt->hactive);
477 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
478 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
479 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
480 ret |= decode_timing_property(node, "vactive", &dt->vactive);
481 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
482 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
485 val = ofnode_read_u32_default(node, "vsync-active", -1);
487 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
488 DISPLAY_FLAGS_VSYNC_LOW;
490 val = ofnode_read_u32_default(node, "hsync-active", -1);
492 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
493 DISPLAY_FLAGS_HSYNC_LOW;
495 val = ofnode_read_u32_default(node, "de-active", -1);
497 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
498 DISPLAY_FLAGS_DE_LOW;
500 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
502 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
503 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
506 if (ofnode_read_bool(node, "interlaced"))
507 dt->flags |= DISPLAY_FLAGS_INTERLACED;
508 if (ofnode_read_bool(node, "doublescan"))
509 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
510 if (ofnode_read_bool(node, "doubleclk"))
511 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
516 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
518 if (ofnode_is_np(node))
519 return of_get_property(ofnode_to_np(node), propname, lenp);
521 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
525 bool ofnode_is_available(ofnode node)
527 if (ofnode_is_np(node))
528 return of_device_is_available(ofnode_to_np(node));
530 return fdtdec_get_is_enabled(gd->fdt_blob,
531 ofnode_to_offset(node));
534 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
537 if (ofnode_is_np(node)) {
540 const struct device_node *np = ofnode_to_np(node);
541 const __be32 *prop = of_get_property(np, property, &psize);
544 return FDT_ADDR_T_NONE;
545 na = of_n_addr_cells(np);
546 ns = of_n_size_cells(np);
547 *sizep = of_read_number(prop + na, ns);
549 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0)
550 return of_translate_address(np, prop);
552 return of_read_number(prop, na);
554 return fdtdec_get_addr_size(gd->fdt_blob,
555 ofnode_to_offset(node), property,
560 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
563 if (ofnode_is_np(node)) {
564 const struct device_node *np = ofnode_to_np(node);
566 const __be32 *prop = of_get_property(np, propname, &psize);
568 if (!prop || sz != psize)
570 return (uint8_t *)prop;
573 return fdtdec_locate_byte_array(gd->fdt_blob,
574 ofnode_to_offset(node), propname, sz);
578 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
579 const char *propname, struct fdt_pci_addr *addr)
585 debug("%s: %s: ", __func__, propname);
588 * If we follow the pci bus bindings strictly, we should check
589 * the value of the node's parent node's #address-cells and
590 * #size-cells. They need to be 3 and 2 accordingly. However,
591 * for simplicity we skip the check here.
593 cell = ofnode_get_property(node, propname, &len);
597 if ((len % FDT_PCI_REG_SIZE) == 0) {
598 int num = len / FDT_PCI_REG_SIZE;
601 for (i = 0; i < num; i++) {
602 debug("pci address #%d: %08lx %08lx %08lx\n", i,
603 (ulong)fdt32_to_cpu(cell[0]),
604 (ulong)fdt32_to_cpu(cell[1]),
605 (ulong)fdt32_to_cpu(cell[2]));
606 if ((fdt32_to_cpu(*cell) & type) == type) {
607 addr->phys_hi = fdt32_to_cpu(cell[0]);
608 addr->phys_mid = fdt32_to_cpu(cell[1]);
609 addr->phys_lo = fdt32_to_cpu(cell[1]);
613 cell += (FDT_PCI_ADDR_CELLS +
628 debug("(not found)\n");
632 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device)
634 const char *list, *end;
637 list = ofnode_get_property(node, "compatible", &len);
644 if (len >= strlen("pciVVVV,DDDD")) {
645 char *s = strstr(list, "pci");
648 * check if the string is something like pciVVVV,DDDD.RR
649 * or just pciVVVV,DDDD
651 if (s && s[7] == ',' &&
652 (s[12] == '.' || s[12] == 0)) {
654 *vendor = simple_strtol(s, NULL, 16);
657 *device = simple_strtol(s, NULL, 16);
668 int ofnode_read_addr_cells(ofnode node)
670 if (ofnode_is_np(node))
671 return of_n_addr_cells(ofnode_to_np(node));
672 else /* NOTE: this call should walk up the parent stack */
673 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
676 int ofnode_read_size_cells(ofnode node)
678 if (ofnode_is_np(node))
679 return of_n_size_cells(ofnode_to_np(node));
680 else /* NOTE: this call should walk up the parent stack */
681 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
684 int ofnode_read_simple_addr_cells(ofnode node)
686 if (ofnode_is_np(node))
687 return of_simple_addr_cells(ofnode_to_np(node));
689 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
692 int ofnode_read_simple_size_cells(ofnode node)
694 if (ofnode_is_np(node))
695 return of_simple_size_cells(ofnode_to_np(node));
697 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
700 bool ofnode_pre_reloc(ofnode node)
702 #if defined(CONFIG_SPL_BUILD) || defined(CONFIG_TPL_BUILD)
703 /* for SPL and TPL the remaining nodes after the fdtgrep 1st pass
704 * had property dm-pre-reloc or u-boot,dm-spl/tpl.
705 * They are removed in final dtb (fdtgrep 2nd pass)
709 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
711 if (ofnode_read_bool(node, "u-boot,dm-pre-proper"))
715 * In regular builds individual spl and tpl handling both
716 * count as handled pre-relocation for later second init.
718 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
719 ofnode_read_bool(node, "u-boot,dm-tpl"))
726 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
728 if (ofnode_is_np(node)) {
729 return of_address_to_resource(ofnode_to_np(node), index, res);
731 struct fdt_resource fres;
734 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
735 "reg", index, &fres);
738 memset(res, '\0', sizeof(*res));
739 res->start = fres.start;
746 int ofnode_read_resource_byname(ofnode node, const char *name,
747 struct resource *res)
751 index = ofnode_stringlist_search(node, "reg-names", name);
755 return ofnode_read_resource(node, index, res);
758 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
760 if (ofnode_is_np(node))
761 return of_translate_address(ofnode_to_np(node), in_addr);
763 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
766 int ofnode_device_is_compatible(ofnode node, const char *compat)
768 if (ofnode_is_np(node))
769 return of_device_is_compatible(ofnode_to_np(node), compat,
772 return !fdt_node_check_compatible(gd->fdt_blob,
773 ofnode_to_offset(node),
777 ofnode ofnode_by_compatible(ofnode from, const char *compat)
779 if (of_live_active()) {
780 return np_to_ofnode(of_find_compatible_node(
781 (struct device_node *)ofnode_to_np(from), NULL,
784 return offset_to_ofnode(fdt_node_offset_by_compatible(
785 gd->fdt_blob, ofnode_to_offset(from), compat));
789 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
790 const void *propval, int proplen)
792 if (of_live_active()) {
793 return np_to_ofnode(of_find_node_by_prop_value(
794 (struct device_node *)ofnode_to_np(from), propname,
797 return offset_to_ofnode(fdt_node_offset_by_prop_value(
798 gd->fdt_blob, ofnode_to_offset(from),
799 propname, propval, proplen));
803 int ofnode_write_prop(ofnode node, const char *propname, int len,
806 const struct device_node *np = ofnode_to_np(node);
808 struct property *pp_last = NULL;
809 struct property *new;
811 if (!of_live_active())
817 for (pp = np->properties; pp; pp = pp->next) {
818 if (strcmp(pp->name, propname) == 0) {
819 /* Property exists -> change value */
820 pp->value = (void *)value;
830 /* Property does not exist -> append new property */
831 new = malloc(sizeof(struct property));
835 new->name = strdup(propname);
841 new->value = (void *)value;
850 int ofnode_write_string(ofnode node, const char *propname, const char *value)
852 if (!of_live_active())
855 assert(ofnode_valid(node));
857 debug("%s: %s = %s", __func__, propname, value);
859 return ofnode_write_prop(node, propname, strlen(value) + 1, value);
862 int ofnode_set_enabled(ofnode node, bool value)
864 if (!of_live_active())
867 assert(ofnode_valid(node));
870 return ofnode_write_string(node, "status", "okay");
872 return ofnode_write_string(node, "status", "disable");