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)
256 if (ofnode_is_np(node)) {
257 const __be32 *prop_val;
263 prop_val = of_get_address(ofnode_to_np(node), index, &size,
266 return FDT_ADDR_T_NONE;
268 ns = of_n_size_cells(ofnode_to_np(node));
270 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
271 return of_translate_address(ofnode_to_np(node), prop_val);
273 na = of_n_addr_cells(ofnode_to_np(node));
274 return of_read_number(prop_val, na);
277 return fdt_get_base_address(gd->fdt_blob,
278 ofnode_to_offset(node));
281 return FDT_ADDR_T_NONE;
284 fdt_addr_t ofnode_get_addr(ofnode node)
286 return ofnode_get_addr_index(node, 0);
289 int ofnode_stringlist_search(ofnode node, const char *property,
292 if (ofnode_is_np(node)) {
293 return of_property_match_string(ofnode_to_np(node),
298 ret = fdt_stringlist_search(gd->fdt_blob,
299 ofnode_to_offset(node), property,
301 if (ret == -FDT_ERR_NOTFOUND)
310 int ofnode_read_string_index(ofnode node, const char *property, int index,
313 if (ofnode_is_np(node)) {
314 return of_property_read_string_index(ofnode_to_np(node),
315 property, index, outp);
319 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
320 property, index, &len);
327 int ofnode_read_string_count(ofnode node, const char *property)
329 if (ofnode_is_np(node)) {
330 return of_property_count_strings(ofnode_to_np(node), property);
332 return fdt_stringlist_count(gd->fdt_blob,
333 ofnode_to_offset(node), property);
337 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
338 struct ofnode_phandle_args *out)
340 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
341 out->node = offset_to_ofnode(in->node);
342 out->args_count = in->args_count;
343 memcpy(out->args, in->args, sizeof(out->args));
346 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
347 struct ofnode_phandle_args *out)
349 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
350 out->node = np_to_ofnode(in->np);
351 out->args_count = in->args_count;
352 memcpy(out->args, in->args, sizeof(out->args));
355 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
356 const char *cells_name, int cell_count,
358 struct ofnode_phandle_args *out_args)
360 if (ofnode_is_np(node)) {
361 struct of_phandle_args args;
364 ret = of_parse_phandle_with_args(ofnode_to_np(node),
365 list_name, cells_name, index,
369 ofnode_from_of_phandle_args(&args, out_args);
371 struct fdtdec_phandle_args args;
374 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
375 ofnode_to_offset(node),
376 list_name, cells_name,
377 cell_count, index, &args);
380 ofnode_from_fdtdec_phandle_args(&args, out_args);
386 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
387 const char *cells_name)
389 if (ofnode_is_np(node))
390 return of_count_phandle_with_args(ofnode_to_np(node),
391 list_name, cells_name);
393 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
394 ofnode_to_offset(node), list_name, cells_name,
398 ofnode ofnode_path(const char *path)
400 if (of_live_active())
401 return np_to_ofnode(of_find_node_by_path(path));
403 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
406 const char *ofnode_get_chosen_prop(const char *name)
410 chosen_node = ofnode_path("/chosen");
412 return ofnode_read_string(chosen_node, name);
415 ofnode ofnode_get_chosen_node(const char *name)
419 prop = ofnode_get_chosen_prop(name);
421 return ofnode_null();
423 return ofnode_path(prop);
426 static int decode_timing_property(ofnode node, const char *name,
427 struct timing_entry *result)
431 length = ofnode_read_size(node, name);
433 debug("%s: could not find property %s\n",
434 ofnode_get_name(node), name);
438 if (length == sizeof(u32)) {
439 result->typ = ofnode_read_u32_default(node, name, 0);
440 result->min = result->typ;
441 result->max = result->typ;
443 ret = ofnode_read_u32_array(node, name, &result->min, 3);
449 int ofnode_decode_display_timing(ofnode parent, int index,
450 struct display_timing *dt)
453 ofnode timings, node;
457 timings = ofnode_find_subnode(parent, "display-timings");
458 if (!ofnode_valid(timings))
462 ofnode_for_each_subnode(node, timings) {
467 if (!ofnode_valid(node))
470 memset(dt, 0, sizeof(*dt));
472 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
473 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
474 ret |= decode_timing_property(node, "hactive", &dt->hactive);
475 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
476 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
477 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
478 ret |= decode_timing_property(node, "vactive", &dt->vactive);
479 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
480 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
483 val = ofnode_read_u32_default(node, "vsync-active", -1);
485 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
486 DISPLAY_FLAGS_VSYNC_LOW;
488 val = ofnode_read_u32_default(node, "hsync-active", -1);
490 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
491 DISPLAY_FLAGS_HSYNC_LOW;
493 val = ofnode_read_u32_default(node, "de-active", -1);
495 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
496 DISPLAY_FLAGS_DE_LOW;
498 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
500 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
501 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
504 if (ofnode_read_bool(node, "interlaced"))
505 dt->flags |= DISPLAY_FLAGS_INTERLACED;
506 if (ofnode_read_bool(node, "doublescan"))
507 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
508 if (ofnode_read_bool(node, "doubleclk"))
509 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
514 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
516 if (ofnode_is_np(node))
517 return of_get_property(ofnode_to_np(node), propname, lenp);
519 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
523 bool ofnode_is_available(ofnode node)
525 if (ofnode_is_np(node))
526 return of_device_is_available(ofnode_to_np(node));
528 return fdtdec_get_is_enabled(gd->fdt_blob,
529 ofnode_to_offset(node));
532 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
535 if (ofnode_is_np(node)) {
538 const struct device_node *np = ofnode_to_np(node);
539 const __be32 *prop = of_get_property(np, property, &psize);
542 return FDT_ADDR_T_NONE;
543 na = of_n_addr_cells(np);
544 ns = of_n_addr_cells(np);
545 *sizep = of_read_number(prop + na, ns);
546 return of_read_number(prop, na);
548 return fdtdec_get_addr_size(gd->fdt_blob,
549 ofnode_to_offset(node), property,
554 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
557 if (ofnode_is_np(node)) {
558 const struct device_node *np = ofnode_to_np(node);
560 const __be32 *prop = of_get_property(np, propname, &psize);
562 if (!prop || sz != psize)
564 return (uint8_t *)prop;
567 return fdtdec_locate_byte_array(gd->fdt_blob,
568 ofnode_to_offset(node), propname, sz);
572 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
573 const char *propname, struct fdt_pci_addr *addr)
579 debug("%s: %s: ", __func__, propname);
582 * If we follow the pci bus bindings strictly, we should check
583 * the value of the node's parent node's #address-cells and
584 * #size-cells. They need to be 3 and 2 accordingly. However,
585 * for simplicity we skip the check here.
587 cell = ofnode_get_property(node, propname, &len);
591 if ((len % FDT_PCI_REG_SIZE) == 0) {
592 int num = len / FDT_PCI_REG_SIZE;
595 for (i = 0; i < num; i++) {
596 debug("pci address #%d: %08lx %08lx %08lx\n", i,
597 (ulong)fdt32_to_cpu(cell[0]),
598 (ulong)fdt32_to_cpu(cell[1]),
599 (ulong)fdt32_to_cpu(cell[2]));
600 if ((fdt32_to_cpu(*cell) & type) == type) {
601 addr->phys_hi = fdt32_to_cpu(cell[0]);
602 addr->phys_mid = fdt32_to_cpu(cell[1]);
603 addr->phys_lo = fdt32_to_cpu(cell[1]);
607 cell += (FDT_PCI_ADDR_CELLS +
622 debug("(not found)\n");
626 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device)
628 const char *list, *end;
631 list = ofnode_get_property(node, "compatible", &len);
638 if (len >= strlen("pciVVVV,DDDD")) {
639 char *s = strstr(list, "pci");
642 * check if the string is something like pciVVVV,DDDD.RR
643 * or just pciVVVV,DDDD
645 if (s && s[7] == ',' &&
646 (s[12] == '.' || s[12] == 0)) {
648 *vendor = simple_strtol(s, NULL, 16);
651 *device = simple_strtol(s, NULL, 16);
662 int ofnode_read_addr_cells(ofnode node)
664 if (ofnode_is_np(node))
665 return of_n_addr_cells(ofnode_to_np(node));
666 else /* NOTE: this call should walk up the parent stack */
667 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
670 int ofnode_read_size_cells(ofnode node)
672 if (ofnode_is_np(node))
673 return of_n_size_cells(ofnode_to_np(node));
674 else /* NOTE: this call should walk up the parent stack */
675 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
678 int ofnode_read_simple_addr_cells(ofnode node)
680 if (ofnode_is_np(node))
681 return of_simple_addr_cells(ofnode_to_np(node));
683 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
686 int ofnode_read_simple_size_cells(ofnode node)
688 if (ofnode_is_np(node))
689 return of_simple_size_cells(ofnode_to_np(node));
691 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
694 bool ofnode_pre_reloc(ofnode node)
696 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
699 #ifdef CONFIG_TPL_BUILD
700 if (ofnode_read_bool(node, "u-boot,dm-tpl"))
702 #elif defined(CONFIG_SPL_BUILD)
703 if (ofnode_read_bool(node, "u-boot,dm-spl"))
707 * In regular builds individual spl and tpl handling both
708 * count as handled pre-relocation for later second init.
710 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
711 ofnode_read_bool(node, "u-boot,dm-tpl"))
718 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
720 if (ofnode_is_np(node)) {
721 return of_address_to_resource(ofnode_to_np(node), index, res);
723 struct fdt_resource fres;
726 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
727 "reg", index, &fres);
730 memset(res, '\0', sizeof(*res));
731 res->start = fres.start;
738 int ofnode_read_resource_byname(ofnode node, const char *name,
739 struct resource *res)
743 index = ofnode_stringlist_search(node, "reg-names", name);
747 return ofnode_read_resource(node, index, res);
750 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
752 if (ofnode_is_np(node))
753 return of_translate_address(ofnode_to_np(node), in_addr);
755 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
758 int ofnode_device_is_compatible(ofnode node, const char *compat)
760 if (ofnode_is_np(node))
761 return of_device_is_compatible(ofnode_to_np(node), compat,
764 return !fdt_node_check_compatible(gd->fdt_blob,
765 ofnode_to_offset(node),
769 ofnode ofnode_by_compatible(ofnode from, const char *compat)
771 if (of_live_active()) {
772 return np_to_ofnode(of_find_compatible_node(
773 (struct device_node *)ofnode_to_np(from), NULL,
776 return offset_to_ofnode(fdt_node_offset_by_compatible(
777 gd->fdt_blob, ofnode_to_offset(from), compat));