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 bool ofnode_read_bool(ofnode node, const char *propname)
62 assert(ofnode_valid(node));
63 debug("%s: %s: ", __func__, propname);
65 prop = ofnode_get_property(node, propname, NULL);
67 debug("%s\n", prop ? "true" : "false");
69 return prop ? true : false;
72 const char *ofnode_read_string(ofnode node, const char *propname)
74 const char *str = NULL;
77 assert(ofnode_valid(node));
78 debug("%s: %s: ", __func__, propname);
80 if (ofnode_is_np(node)) {
81 struct property *prop = of_find_property(
82 ofnode_to_np(node), propname, NULL);
89 str = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
93 debug("<not found>\n");
96 if (strnlen(str, len) >= len) {
105 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name)
109 assert(ofnode_valid(node));
110 debug("%s: %s: ", __func__, subnode_name);
112 if (ofnode_is_np(node)) {
113 const struct device_node *np = ofnode_to_np(node);
115 for (np = np->child; np; np = np->sibling) {
116 if (!strcmp(subnode_name, np->name))
119 subnode = np_to_ofnode(np);
121 int ooffset = fdt_subnode_offset(gd->fdt_blob,
122 ofnode_to_offset(node), subnode_name);
123 subnode = offset_to_ofnode(ooffset);
125 debug("%s\n", ofnode_valid(subnode) ?
126 ofnode_get_name(subnode) : "<none>");
131 int ofnode_read_u32_array(ofnode node, const char *propname,
132 u32 *out_values, size_t sz)
134 assert(ofnode_valid(node));
135 debug("%s: %s: ", __func__, propname);
137 if (ofnode_is_np(node)) {
138 return of_read_u32_array(ofnode_to_np(node), propname,
141 return fdtdec_get_int_array(gd->fdt_blob,
142 ofnode_to_offset(node), propname,
147 ofnode ofnode_first_subnode(ofnode node)
149 assert(ofnode_valid(node));
150 if (ofnode_is_np(node))
151 return np_to_ofnode(node.np->child);
153 return offset_to_ofnode(
154 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
157 ofnode ofnode_next_subnode(ofnode node)
159 assert(ofnode_valid(node));
160 if (ofnode_is_np(node))
161 return np_to_ofnode(node.np->sibling);
163 return offset_to_ofnode(
164 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
167 ofnode ofnode_get_parent(ofnode node)
171 assert(ofnode_valid(node));
172 if (ofnode_is_np(node))
173 parent = np_to_ofnode(of_get_parent(ofnode_to_np(node)));
175 parent.of_offset = fdt_parent_offset(gd->fdt_blob,
176 ofnode_to_offset(node));
181 const char *ofnode_get_name(ofnode node)
183 assert(ofnode_valid(node));
184 if (ofnode_is_np(node))
185 return strrchr(node.np->full_name, '/') + 1;
187 return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
190 ofnode ofnode_get_by_phandle(uint phandle)
194 if (of_live_active())
195 node = np_to_ofnode(of_find_node_by_phandle(phandle));
197 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
203 int ofnode_read_size(ofnode node, const char *propname)
207 if (ofnode_is_np(node)) {
208 struct property *prop = of_find_property(
209 ofnode_to_np(node), propname, NULL);
214 if (fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
222 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
224 if (ofnode_is_np(node)) {
225 const __be32 *prop_val;
231 prop_val = of_get_address(ofnode_to_np(node), index, &size,
234 return FDT_ADDR_T_NONE;
236 ns = of_n_size_cells(ofnode_to_np(node));
238 if (IS_ENABLED(CONFIG_OF_TRANSLATE) && ns > 0) {
239 return of_translate_address(ofnode_to_np(node), prop_val);
241 na = of_n_addr_cells(ofnode_to_np(node));
242 return of_read_number(prop_val, na);
245 return fdt_get_base_address(gd->fdt_blob,
246 ofnode_to_offset(node));
249 return FDT_ADDR_T_NONE;
252 fdt_addr_t ofnode_get_addr(ofnode node)
254 return ofnode_get_addr_index(node, 0);
257 int ofnode_stringlist_search(ofnode node, const char *property,
260 if (ofnode_is_np(node)) {
261 return of_property_match_string(ofnode_to_np(node),
266 ret = fdt_stringlist_search(gd->fdt_blob,
267 ofnode_to_offset(node), property,
269 if (ret == -FDT_ERR_NOTFOUND)
278 int ofnode_read_string_index(ofnode node, const char *property, int index,
281 if (ofnode_is_np(node)) {
282 return of_property_read_string_index(ofnode_to_np(node),
283 property, index, outp);
287 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
288 property, index, &len);
295 int ofnode_read_string_count(ofnode node, const char *property)
297 if (ofnode_is_np(node)) {
298 return of_property_count_strings(ofnode_to_np(node), property);
300 return fdt_stringlist_count(gd->fdt_blob,
301 ofnode_to_offset(node), property);
305 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
306 struct ofnode_phandle_args *out)
308 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
309 out->node = offset_to_ofnode(in->node);
310 out->args_count = in->args_count;
311 memcpy(out->args, in->args, sizeof(out->args));
314 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
315 struct ofnode_phandle_args *out)
317 assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
318 out->node = np_to_ofnode(in->np);
319 out->args_count = in->args_count;
320 memcpy(out->args, in->args, sizeof(out->args));
323 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
324 const char *cells_name, int cell_count,
326 struct ofnode_phandle_args *out_args)
328 if (ofnode_is_np(node)) {
329 struct of_phandle_args args;
332 ret = of_parse_phandle_with_args(ofnode_to_np(node),
333 list_name, cells_name, index,
337 ofnode_from_of_phandle_args(&args, out_args);
339 struct fdtdec_phandle_args args;
342 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
343 ofnode_to_offset(node),
344 list_name, cells_name,
345 cell_count, index, &args);
348 ofnode_from_fdtdec_phandle_args(&args, out_args);
354 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
355 const char *cells_name)
357 if (ofnode_is_np(node))
358 return of_count_phandle_with_args(ofnode_to_np(node),
359 list_name, cells_name);
361 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
362 ofnode_to_offset(node), list_name, cells_name,
366 ofnode ofnode_path(const char *path)
368 if (of_live_active())
369 return np_to_ofnode(of_find_node_by_path(path));
371 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
374 const char *ofnode_get_chosen_prop(const char *name)
378 chosen_node = ofnode_path("/chosen");
380 return ofnode_read_string(chosen_node, name);
383 ofnode ofnode_get_chosen_node(const char *name)
387 prop = ofnode_get_chosen_prop(name);
389 return ofnode_null();
391 return ofnode_path(prop);
394 static int decode_timing_property(ofnode node, const char *name,
395 struct timing_entry *result)
399 length = ofnode_read_size(node, name);
401 debug("%s: could not find property %s\n",
402 ofnode_get_name(node), name);
406 if (length == sizeof(u32)) {
407 result->typ = ofnode_read_u32_default(node, name, 0);
408 result->min = result->typ;
409 result->max = result->typ;
411 ret = ofnode_read_u32_array(node, name, &result->min, 3);
417 int ofnode_decode_display_timing(ofnode parent, int index,
418 struct display_timing *dt)
421 ofnode timings, node;
425 timings = ofnode_find_subnode(parent, "display-timings");
426 if (!ofnode_valid(timings))
430 ofnode_for_each_subnode(node, timings) {
435 if (!ofnode_valid(node))
438 memset(dt, 0, sizeof(*dt));
440 ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
441 ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
442 ret |= decode_timing_property(node, "hactive", &dt->hactive);
443 ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
444 ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
445 ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
446 ret |= decode_timing_property(node, "vactive", &dt->vactive);
447 ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
448 ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
451 val = ofnode_read_u32_default(node, "vsync-active", -1);
453 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
454 DISPLAY_FLAGS_VSYNC_LOW;
456 val = ofnode_read_u32_default(node, "hsync-active", -1);
458 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
459 DISPLAY_FLAGS_HSYNC_LOW;
461 val = ofnode_read_u32_default(node, "de-active", -1);
463 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
464 DISPLAY_FLAGS_DE_LOW;
466 val = ofnode_read_u32_default(node, "pixelclk-active", -1);
468 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
469 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
472 if (ofnode_read_bool(node, "interlaced"))
473 dt->flags |= DISPLAY_FLAGS_INTERLACED;
474 if (ofnode_read_bool(node, "doublescan"))
475 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
476 if (ofnode_read_bool(node, "doubleclk"))
477 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
482 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
484 if (ofnode_is_np(node))
485 return of_get_property(ofnode_to_np(node), propname, lenp);
487 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
491 bool ofnode_is_available(ofnode node)
493 if (ofnode_is_np(node))
494 return of_device_is_available(ofnode_to_np(node));
496 return fdtdec_get_is_enabled(gd->fdt_blob,
497 ofnode_to_offset(node));
500 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
503 if (ofnode_is_np(node)) {
506 const struct device_node *np = ofnode_to_np(node);
507 const __be32 *prop = of_get_property(np, property, &psize);
510 return FDT_ADDR_T_NONE;
511 na = of_n_addr_cells(np);
512 ns = of_n_addr_cells(np);
513 *sizep = of_read_number(prop + na, ns);
514 return of_read_number(prop, na);
516 return fdtdec_get_addr_size(gd->fdt_blob,
517 ofnode_to_offset(node), property,
522 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
525 if (ofnode_is_np(node)) {
526 const struct device_node *np = ofnode_to_np(node);
528 const __be32 *prop = of_get_property(np, propname, &psize);
530 if (!prop || sz != psize)
532 return (uint8_t *)prop;
535 return fdtdec_locate_byte_array(gd->fdt_blob,
536 ofnode_to_offset(node), propname, sz);
540 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
541 const char *propname, struct fdt_pci_addr *addr)
547 debug("%s: %s: ", __func__, propname);
550 * If we follow the pci bus bindings strictly, we should check
551 * the value of the node's parent node's #address-cells and
552 * #size-cells. They need to be 3 and 2 accordingly. However,
553 * for simplicity we skip the check here.
555 cell = ofnode_get_property(node, propname, &len);
559 if ((len % FDT_PCI_REG_SIZE) == 0) {
560 int num = len / FDT_PCI_REG_SIZE;
563 for (i = 0; i < num; i++) {
564 debug("pci address #%d: %08lx %08lx %08lx\n", i,
565 (ulong)fdt32_to_cpu(cell[0]),
566 (ulong)fdt32_to_cpu(cell[1]),
567 (ulong)fdt32_to_cpu(cell[2]));
568 if ((fdt32_to_cpu(*cell) & type) == type) {
569 addr->phys_hi = fdt32_to_cpu(cell[0]);
570 addr->phys_mid = fdt32_to_cpu(cell[1]);
571 addr->phys_lo = fdt32_to_cpu(cell[1]);
575 cell += (FDT_PCI_ADDR_CELLS +
590 debug("(not found)\n");
594 int ofnode_read_addr_cells(ofnode node)
596 if (ofnode_is_np(node))
597 return of_n_addr_cells(ofnode_to_np(node));
598 else /* NOTE: this call should walk up the parent stack */
599 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
602 int ofnode_read_size_cells(ofnode node)
604 if (ofnode_is_np(node))
605 return of_n_size_cells(ofnode_to_np(node));
606 else /* NOTE: this call should walk up the parent stack */
607 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
610 int ofnode_read_simple_addr_cells(ofnode node)
612 if (ofnode_is_np(node))
613 return of_simple_addr_cells(ofnode_to_np(node));
615 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
618 int ofnode_read_simple_size_cells(ofnode node)
620 if (ofnode_is_np(node))
621 return of_simple_size_cells(ofnode_to_np(node));
623 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
626 bool ofnode_pre_reloc(ofnode node)
628 if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
631 #ifdef CONFIG_TPL_BUILD
632 if (ofnode_read_bool(node, "u-boot,dm-tpl"))
634 #elif defined(CONFIG_SPL_BUILD)
635 if (ofnode_read_bool(node, "u-boot,dm-spl"))
639 * In regular builds individual spl and tpl handling both
640 * count as handled pre-relocation for later second init.
642 if (ofnode_read_bool(node, "u-boot,dm-spl") ||
643 ofnode_read_bool(node, "u-boot,dm-tpl"))
650 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
652 if (ofnode_is_np(node)) {
653 return of_address_to_resource(ofnode_to_np(node), index, res);
655 struct fdt_resource fres;
658 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
659 "reg", index, &fres);
662 memset(res, '\0', sizeof(*res));
663 res->start = fres.start;
670 int ofnode_read_resource_byname(ofnode node, const char *name,
671 struct resource *res)
675 index = ofnode_stringlist_search(node, "reg-names", name);
679 return ofnode_read_resource(node, index, res);
682 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
684 if (ofnode_is_np(node))
685 return of_translate_address(ofnode_to_np(node), in_addr);
687 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
690 int ofnode_device_is_compatible(ofnode node, const char *compat)
692 if (ofnode_is_np(node))
693 return of_device_is_compatible(ofnode_to_np(node), compat,
696 return !fdt_node_check_compatible(gd->fdt_blob,
697 ofnode_to_offset(node),