xref: /rk3399_rockchip-uboot/drivers/core/ofnode.c (revision df5ceb01dbc6914ca7c4e6c2288ae27e11a24500)
1 /*
2  * Copyright (c) 2017 Google, Inc
3  * Written by Simon Glass <sjg@chromium.org>
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #include <common.h>
9 #include <dm.h>
10 #include <fdtdec.h>
11 #include <fdt_support.h>
12 #include <libfdt.h>
13 #include <dm/of_access.h>
14 #include <dm/of_addr.h>
15 #include <dm/ofnode.h>
16 #include <linux/err.h>
17 #include <linux/ioport.h>
18 
19 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp)
20 {
21 	assert(ofnode_valid(node));
22 	debug("%s: %s: ", __func__, propname);
23 
24 	if (ofnode_is_np(node)) {
25 		return of_read_u32(ofnode_to_np(node), propname, outp);
26 	} else {
27 		const fdt32_t *cell;
28 		int len;
29 
30 		cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
31 				   propname, &len);
32 		if (!cell || len < sizeof(int)) {
33 			debug("(not found)\n");
34 			return -EINVAL;
35 		}
36 		*outp = fdt32_to_cpu(cell[0]);
37 	}
38 	debug("%#x (%d)\n", *outp, *outp);
39 
40 	return 0;
41 }
42 
43 int ofnode_read_u32_default(ofnode node, const char *propname, u32 def)
44 {
45 	assert(ofnode_valid(node));
46 	ofnode_read_u32(node, propname, &def);
47 
48 	return def;
49 }
50 
51 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def)
52 {
53 	assert(ofnode_valid(node));
54 	ofnode_read_u32(node, propname, (u32 *)&def);
55 
56 	return def;
57 }
58 
59 bool ofnode_read_bool(ofnode node, const char *propname)
60 {
61 	const void *prop;
62 
63 	assert(ofnode_valid(node));
64 	debug("%s: %s: ", __func__, propname);
65 
66 	prop = ofnode_get_property(node, propname, NULL);
67 
68 	debug("%s\n", prop ? "true" : "false");
69 
70 	return prop ? true : false;
71 }
72 
73 const char *ofnode_read_string(ofnode node, const char *propname)
74 {
75 	const char *str = NULL;
76 	int len = -1;
77 
78 	assert(ofnode_valid(node));
79 	debug("%s: %s: ", __func__, propname);
80 
81 	if (ofnode_is_np(node)) {
82 		struct property *prop = of_find_property(
83 				ofnode_to_np(node), propname, NULL);
84 
85 		if (prop) {
86 			str = prop->value;
87 			len = prop->length;
88 		}
89 	} else {
90 		str = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
91 				  propname, &len);
92 	}
93 	if (!str) {
94 		debug("<not found>\n");
95 		return NULL;
96 	}
97 	if (strnlen(str, len) >= len) {
98 		debug("<invalid>\n");
99 		return NULL;
100 	}
101 	debug("%s\n", str);
102 
103 	return str;
104 }
105 
106 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name)
107 {
108 	ofnode subnode;
109 
110 	assert(ofnode_valid(node));
111 	debug("%s: %s: ", __func__, subnode_name);
112 
113 	if (ofnode_is_np(node)) {
114 		const struct device_node *np = ofnode_to_np(node);
115 
116 		for (np = np->child; np; np = np->sibling) {
117 			if (!strcmp(subnode_name, np->name))
118 				break;
119 		}
120 		subnode = np_to_ofnode(np);
121 	} else {
122 		int ooffset = fdt_subnode_offset(gd->fdt_blob,
123 				ofnode_to_offset(node), subnode_name);
124 		subnode = offset_to_ofnode(ooffset);
125 	}
126 	debug("%s\n", ofnode_valid(subnode) ?
127 	      ofnode_get_name(subnode) : "<none>");
128 
129 	return subnode;
130 }
131 
132 int ofnode_read_u32_array(ofnode node, const char *propname,
133 			  u32 *out_values, size_t sz)
134 {
135 	assert(ofnode_valid(node));
136 	debug("%s: %s: ", __func__, propname);
137 
138 	if (ofnode_is_np(node)) {
139 		return of_read_u32_array(ofnode_to_np(node), propname,
140 					 out_values, sz);
141 	} else {
142 		return fdtdec_get_int_array(gd->fdt_blob,
143 					    ofnode_to_offset(node), propname,
144 					    out_values, sz);
145 	}
146 }
147 
148 ofnode ofnode_first_subnode(ofnode node)
149 {
150 	assert(ofnode_valid(node));
151 	if (ofnode_is_np(node))
152 		return np_to_ofnode(node.np->child);
153 
154 	return offset_to_ofnode(
155 		fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
156 }
157 
158 ofnode ofnode_next_subnode(ofnode node)
159 {
160 	assert(ofnode_valid(node));
161 	if (ofnode_is_np(node))
162 		return np_to_ofnode(node.np->sibling);
163 
164 	return offset_to_ofnode(
165 		fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
166 }
167 
168 const char *ofnode_get_name(ofnode node)
169 {
170 	if(!ofnode_valid(node)){
171 		debug("%s node not valid\n", __func__);
172 		return NULL;
173 	}
174 	if (ofnode_is_np(node))
175 		return strrchr(node.np->full_name, '/') + 1;
176 
177 	return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
178 }
179 
180 ofnode ofnode_get_by_phandle(uint phandle)
181 {
182 	ofnode node;
183 
184 	if (of_live_active())
185 		node = np_to_ofnode(of_find_node_by_phandle(phandle));
186 	else
187 		node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
188 							    phandle);
189 
190 	return node;
191 }
192 
193 int ofnode_read_size(ofnode node, const char *propname)
194 {
195 	int len;
196 
197 	if (ofnode_is_np(node)) {
198 		struct property *prop = of_find_property(
199 				ofnode_to_np(node), propname, NULL);
200 
201 		if (prop)
202 			return prop->length;
203 	} else {
204 		if (fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
205 				&len))
206 			return len;
207 	}
208 
209 	return -EINVAL;
210 }
211 
212 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
213 {
214 	if (ofnode_is_np(node)) {
215 		const __be32 *prop_val;
216 		uint flags;
217 		u64 size;
218 		int na;
219 
220 		prop_val = of_get_address(ofnode_to_np(node), index, &size,
221 					  &flags);
222 		if (!prop_val)
223 			return FDT_ADDR_T_NONE;
224 		na = of_n_addr_cells(ofnode_to_np(node));
225 		return of_read_number(prop_val, na);
226 	} else {
227 		return fdt_get_base_address(gd->fdt_blob,
228 					    ofnode_to_offset(node));
229 	}
230 
231 	return FDT_ADDR_T_NONE;
232 }
233 
234 fdt_addr_t ofnode_get_addr(ofnode node)
235 {
236 	return ofnode_get_addr_index(node, 0);
237 }
238 
239 int ofnode_stringlist_search(ofnode node, const char *property,
240 			     const char *string)
241 {
242 	if (ofnode_is_np(node)) {
243 		return of_property_match_string(ofnode_to_np(node),
244 						property, string);
245 	} else {
246 		int ret;
247 
248 		ret = fdt_stringlist_search(gd->fdt_blob,
249 					    ofnode_to_offset(node), property,
250 					    string);
251 		if (ret == -FDT_ERR_NOTFOUND)
252 			return -ENODATA;
253 		else if (ret < 0)
254 			return -EINVAL;
255 
256 		return ret;
257 	}
258 }
259 
260 int ofnode_read_string_index(ofnode node, const char *property, int index,
261 			     const char **outp)
262 {
263 	if (ofnode_is_np(node)) {
264 		return of_property_read_string_index(ofnode_to_np(node),
265 						     property, index, outp);
266 	} else {
267 		int len;
268 
269 		*outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
270 					   property, index, &len);
271 		if (len < 0)
272 			return -EINVAL;
273 		return 0;
274 	}
275 }
276 
277 int ofnode_read_string_count(ofnode node, const char *property)
278 {
279 	if (ofnode_is_np(node)) {
280 		return of_property_count_strings(ofnode_to_np(node), property);
281 	} else {
282 		return fdt_stringlist_count(gd->fdt_blob,
283 					    ofnode_to_offset(node), property);
284 	}
285 }
286 
287 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
288 					    struct ofnode_phandle_args *out)
289 {
290 	assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
291 	out->node = offset_to_ofnode(in->node);
292 	out->args_count = in->args_count;
293 	memcpy(out->args, in->args, sizeof(out->args));
294 }
295 
296 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
297 					struct ofnode_phandle_args *out)
298 {
299 	assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
300 	out->node = np_to_ofnode(in->np);
301 	out->args_count = in->args_count;
302 	memcpy(out->args, in->args, sizeof(out->args));
303 }
304 
305 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
306 				   const char *cells_name, int cell_count,
307 				   int index,
308 				   struct ofnode_phandle_args *out_args)
309 {
310 	if (ofnode_is_np(node)) {
311 		struct of_phandle_args args;
312 		int ret;
313 
314 		ret = of_parse_phandle_with_args(ofnode_to_np(node),
315 				list_name, cells_name, index, &args);
316 		if (ret)
317 			return ret;
318 		ofnode_from_of_phandle_args(&args, out_args);
319 	} else {
320 		struct fdtdec_phandle_args args;
321 		int ret;
322 
323 		ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
324 				ofnode_to_offset(node), list_name, cells_name,
325 				cell_count, index, &args);
326 		if (ret)
327 			return ret;
328 		ofnode_from_fdtdec_phandle_args(&args, out_args);
329 	}
330 
331 	return 0;
332 }
333 
334 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
335 				   const char *cells_name)
336 {
337 	if (ofnode_is_np(node))
338 		return of_count_phandle_with_args(ofnode_to_np(node),
339 				list_name, cells_name);
340 	else
341 		return fdtdec_parse_phandle_with_args(gd->fdt_blob,
342 				ofnode_to_offset(node), list_name, cells_name,
343 				0, -1, NULL);
344 }
345 
346 ofnode ofnode_path(const char *path)
347 {
348 	if (of_live_active())
349 		return np_to_ofnode(of_find_node_by_path(path));
350 	else
351 		return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
352 }
353 
354 const char *ofnode_get_chosen_prop(const char *name)
355 {
356 	ofnode chosen_node;
357 
358 	chosen_node = ofnode_path("/chosen");
359 
360 	return ofnode_read_string(chosen_node, name);
361 }
362 
363 ofnode ofnode_get_chosen_node(const char *name)
364 {
365 	const char *prop;
366 
367 	prop = ofnode_get_chosen_prop(name);
368 	if (!prop)
369 		return ofnode_null();
370 
371 	return ofnode_path(prop);
372 }
373 
374 static int decode_timing_property(ofnode node, const char *name,
375 				  struct timing_entry *result)
376 {
377 	int length, ret = 0;
378 
379 	length = ofnode_read_size(node, name);
380 	if (length < 0) {
381 		debug("%s: could not find property %s\n",
382 		      ofnode_get_name(node), name);
383 		return length;
384 	}
385 
386 	if (length == sizeof(u32)) {
387 		result->typ = ofnode_read_u32_default(node, name, 0);
388 		result->min = result->typ;
389 		result->max = result->typ;
390 	} else {
391 		ret = ofnode_read_u32_array(node, name, &result->min, 3);
392 	}
393 
394 	return ret;
395 }
396 
397 int ofnode_decode_display_timing(ofnode parent, int index,
398 				 struct display_timing *dt)
399 {
400 	int i;
401 	ofnode timings, node;
402 	u32 val = 0;
403 	int ret = 0;
404 
405 	timings = ofnode_find_subnode(parent, "display-timings");
406 	if (!ofnode_valid(timings))
407 		return -EINVAL;
408 
409 	i = 0;
410 	ofnode_for_each_subnode(node, timings) {
411 		if (i++ == index)
412 			break;
413 	}
414 
415 	if (!ofnode_valid(node))
416 		return -EINVAL;
417 
418 	memset(dt, 0, sizeof(*dt));
419 
420 	ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
421 	ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
422 	ret |= decode_timing_property(node, "hactive", &dt->hactive);
423 	ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
424 	ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
425 	ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
426 	ret |= decode_timing_property(node, "vactive", &dt->vactive);
427 	ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
428 	ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
429 
430 	dt->flags = 0;
431 	val = ofnode_read_u32_default(node, "vsync-active", -1);
432 	if (val != -1) {
433 		dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
434 				DISPLAY_FLAGS_VSYNC_LOW;
435 	}
436 	val = ofnode_read_u32_default(node, "hsync-active", -1);
437 	if (val != -1) {
438 		dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
439 				DISPLAY_FLAGS_HSYNC_LOW;
440 	}
441 	val = ofnode_read_u32_default(node, "de-active", -1);
442 	if (val != -1) {
443 		dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
444 				DISPLAY_FLAGS_DE_LOW;
445 	}
446 	val = ofnode_read_u32_default(node, "pixelclk-active", -1);
447 	if (val != -1) {
448 		dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
449 				DISPLAY_FLAGS_PIXDATA_NEGEDGE;
450 	}
451 
452 	if (ofnode_read_bool(node, "interlaced"))
453 		dt->flags |= DISPLAY_FLAGS_INTERLACED;
454 	if (ofnode_read_bool(node, "doublescan"))
455 		dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
456 	if (ofnode_read_bool(node, "doubleclk"))
457 		dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
458 
459 	return ret;
460 }
461 
462 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
463 {
464 	if (ofnode_is_np(node))
465 		return of_get_property(ofnode_to_np(node), propname, lenp);
466 	else
467 		return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
468 				   propname, lenp);
469 }
470 
471 bool ofnode_is_available(ofnode node)
472 {
473 	if (ofnode_is_np(node))
474 		return of_device_is_available(ofnode_to_np(node));
475 	else
476 		return fdtdec_get_is_enabled(gd->fdt_blob,
477 					     ofnode_to_offset(node));
478 }
479 
480 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
481 				fdt_size_t *sizep)
482 {
483 	if (ofnode_is_np(node)) {
484 		int na, ns;
485 		int psize;
486 		const struct device_node *np = ofnode_to_np(node);
487 		const __be32 *prop = of_get_property(np, property, &psize);
488 
489 		if (!prop)
490 			return FDT_ADDR_T_NONE;
491 		na = of_n_addr_cells(np);
492 		ns = of_n_addr_cells(np);
493 		*sizep = of_read_number(prop + na, ns);
494 		return of_read_number(prop, na);
495 	} else {
496 		return fdtdec_get_addr_size(gd->fdt_blob,
497 					    ofnode_to_offset(node), property,
498 					    sizep);
499 	}
500 }
501 
502 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
503 					size_t sz)
504 {
505 	if (ofnode_is_np(node)) {
506 		const struct device_node *np = ofnode_to_np(node);
507 		int psize;
508 		const __be32 *prop = of_get_property(np, propname, &psize);
509 
510 		if (!prop || sz != psize)
511 			return NULL;
512 		return (uint8_t *)prop;
513 
514 	} else {
515 		return fdtdec_locate_byte_array(gd->fdt_blob,
516 				ofnode_to_offset(node), propname, sz);
517 	}
518 }
519 
520 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
521 			 const char *propname, struct fdt_pci_addr *addr)
522 {
523 	const fdt32_t *cell;
524 	int len;
525 	int ret = -ENOENT;
526 
527 	debug("%s: %s: ", __func__, propname);
528 
529 	/*
530 	 * If we follow the pci bus bindings strictly, we should check
531 	 * the value of the node's parent node's #address-cells and
532 	 * #size-cells. They need to be 3 and 2 accordingly. However,
533 	 * for simplicity we skip the check here.
534 	 */
535 	cell = ofnode_get_property(node, propname, &len);
536 	if (!cell)
537 		goto fail;
538 
539 	if ((len % FDT_PCI_REG_SIZE) == 0) {
540 		int num = len / FDT_PCI_REG_SIZE;
541 		int i;
542 
543 		for (i = 0; i < num; i++) {
544 			debug("pci address #%d: %08lx %08lx %08lx\n", i,
545 			      (ulong)fdt32_to_cpu(cell[0]),
546 			      (ulong)fdt32_to_cpu(cell[1]),
547 			      (ulong)fdt32_to_cpu(cell[2]));
548 			if ((fdt32_to_cpu(*cell) & type) == type) {
549 				addr->phys_hi = fdt32_to_cpu(cell[0]);
550 				addr->phys_mid = fdt32_to_cpu(cell[1]);
551 				addr->phys_lo = fdt32_to_cpu(cell[1]);
552 				break;
553 			} else {
554 				cell += (FDT_PCI_ADDR_CELLS +
555 					 FDT_PCI_SIZE_CELLS);
556 			}
557 		}
558 
559 		if (i == num) {
560 			ret = -ENXIO;
561 			goto fail;
562 		}
563 
564 		return 0;
565 	} else {
566 		ret = -EINVAL;
567 	}
568 
569 fail:
570 	debug("(not found)\n");
571 	return ret;
572 }
573 
574 int ofnode_read_addr_cells(ofnode node)
575 {
576 	if (ofnode_is_np(node))
577 		return of_n_addr_cells(ofnode_to_np(node));
578 	else  /* NOTE: this call should walk up the parent stack */
579 		return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
580 }
581 
582 int ofnode_read_size_cells(ofnode node)
583 {
584 	if (ofnode_is_np(node))
585 		return of_n_size_cells(ofnode_to_np(node));
586 	else  /* NOTE: this call should walk up the parent stack */
587 		return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
588 }
589 
590 int ofnode_read_simple_addr_cells(ofnode node)
591 {
592 	if (ofnode_is_np(node))
593 		return of_simple_addr_cells(ofnode_to_np(node));
594 	else
595 		return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
596 }
597 
598 int ofnode_read_simple_size_cells(ofnode node)
599 {
600 	if (ofnode_is_np(node))
601 		return of_simple_size_cells(ofnode_to_np(node));
602 	else
603 		return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
604 }
605 
606 bool ofnode_pre_reloc(ofnode node)
607 {
608 	if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
609 		return true;
610 
611 #ifdef CONFIG_TPL_BUILD
612 	if (ofnode_read_bool(node, "u-boot,dm-tpl"))
613 		return true;
614 #elif defined(CONFIG_SPL_BUILD)
615 	if (ofnode_read_bool(node, "u-boot,dm-spl"))
616 		return true;
617 #else
618 	/*
619 	 * In regular builds individual spl and tpl handling both
620 	 * count as handled pre-relocation for later second init.
621 	 */
622 	if (ofnode_read_bool(node, "u-boot,dm-spl") ||
623 	    ofnode_read_bool(node, "u-boot,dm-tpl"))
624 		return true;
625 #endif
626 
627 	return false;
628 }
629 
630 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
631 {
632 	if (ofnode_is_np(node)) {
633 		return of_address_to_resource(ofnode_to_np(node), index, res);
634 	} else {
635 		struct fdt_resource fres;
636 		int ret;
637 
638 		ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
639 				       "reg", index, &fres);
640 		if (ret < 0)
641 			return -EINVAL;
642 		memset(res, '\0', sizeof(*res));
643 		res->start = fres.start;
644 		res->end = fres.end;
645 
646 		return 0;
647 	}
648 }
649 
650 int ofnode_read_resource_byname(ofnode node, const char *name,
651 				struct resource *res)
652 {
653 	int index;
654 
655 	index = ofnode_stringlist_search(node, "reg-names", name);
656 	if (index < 0)
657 		return index;
658 
659 	return ofnode_read_resource(node, index, res);
660 }
661