xref: /optee_os/core/kernel/dt_driver.c (revision 8fd620f75b68cd47c13807b45b78ea9c931de9b6)
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3  * Copyright (c) 2021, Linaro Limited
4  * Copyright (c) 2021, Bootlin
5  * Copyright (c) 2021, Linaro Limited
6  * Copyright (c) 2021, STMicroelectronics
7  */
8 
9 #include <assert.h>
10 #include <config.h>
11 #include <initcall.h>
12 #include <kernel/boot.h>
13 #include <kernel/dt.h>
14 #include <kernel/dt_driver.h>
15 #include <libfdt.h>
16 #include <malloc.h>
17 #include <sys/queue.h>
18 #include <tee_api_defines_extensions.h>
19 #include <tee_api_types.h>
20 
21 /*
22  * struct dt_driver_probe - Node instance in secure FDT to probe a driver for
23  *
24  * @link: List hook
25  * @nodeoffset: Node offset of device referenced in the FDT
26  * @type: One of DT_DRIVER_* or DT_DRIVER_NOTYPE.
27  * @deferrals: Driver probe deferrals count
28  * @dt_drv: Matching driver to probe if found or NULL
29  * @dm: Matching reference if applicable or NULL
30  */
31 struct dt_driver_probe {
32 	int nodeoffset;
33 	enum dt_driver_type type;
34 	unsigned int deferrals;
35 	const struct dt_driver *dt_drv;
36 	const struct dt_device_match *dm;
37 	TAILQ_ENTRY(dt_driver_probe) link;
38 };
39 
40 /*
41  * struct dt_driver_provider - DT related info on probed device
42  *
43  * Saves information on the probed device so that device
44  * drivers can get resources from DT phandle and related arguments.
45  *
46  * @nodeoffset: Node offset of device referenced in the FDT
47  * @type: One of DT_DRIVER_* or DT_DRIVER_NOTYPE.
48  * @provider_cells: Cells count in the FDT used by the driver's references
49  * @get_of_device: Function to get driver's device ref from phandle data
50  * @priv_data: Driver private data passed as @get_of_device argument
51  * @link: Reference in DT driver providers list
52  */
53 struct dt_driver_provider {
54 	int nodeoffset;
55 	enum dt_driver_type type;
56 	unsigned int provider_cells;
57 	uint32_t phandle;
58 	get_of_device_func get_of_device;
59 	void *priv_data;
60 	SLIST_ENTRY(dt_driver_provider) link;
61 };
62 
63 /*
64  * Device driver providers are able to provide a driver specific instance
65  * related to device phandle arguments found in the secure embedded FDT.
66  */
67 static SLIST_HEAD(, dt_driver_provider) dt_driver_provider_list =
68 	SLIST_HEAD_INITIALIZER(dt_driver_provider_list);
69 
70 /* FDT nodes for which a matching driver is to be probed */
71 static TAILQ_HEAD(dt_driver_probe_head, dt_driver_probe) dt_driver_probe_list =
72 	TAILQ_HEAD_INITIALIZER(dt_driver_probe_list);
73 
74 /* FDT nodes for which a matching driver has been successfully probed */
75 static TAILQ_HEAD(, dt_driver_probe) dt_driver_ready_list =
76 	TAILQ_HEAD_INITIALIZER(dt_driver_ready_list);
77 
78 /* List of the nodes for which a compatible driver but reported a failure */
79 static TAILQ_HEAD(, dt_driver_probe) dt_driver_failed_list =
80 	TAILQ_HEAD_INITIALIZER(dt_driver_failed_list);
81 
82 /* Flag enabled when a new node (possibly typed) is added in the probe list */
83 static bool added_node;
84 
85 /* Resolve drivers dependencies on core crypto layer */
86 static bool tee_crypt_is_ready;
87 
88 void dt_driver_crypt_init_complete(void)
89 {
90 	assert(!tee_crypt_is_ready);
91 	tee_crypt_is_ready = true;
92 }
93 
94 TEE_Result dt_driver_get_crypto(void)
95 {
96 	if (tee_crypt_is_ready)
97 		return TEE_SUCCESS;
98 	else
99 		return TEE_ERROR_DEFER_DRIVER_INIT;
100 }
101 
102 static void assert_type_is_valid(enum dt_driver_type type)
103 {
104 	switch (type) {
105 	case DT_DRIVER_NOTYPE:
106 	case DT_DRIVER_CLK:
107 	case DT_DRIVER_RSTCTRL:
108 	case DT_DRIVER_UART:
109 	case DT_DRIVER_GPIO:
110 	case DT_DRIVER_I2C:
111 	case DT_DRIVER_PINCTRL:
112 		return;
113 	default:
114 		assert(0);
115 	}
116 }
117 
118 /*
119  * Driver provider registering API functions
120  */
121 
122 TEE_Result dt_driver_register_provider(const void *fdt, int nodeoffset,
123 				       get_of_device_func get_of_device,
124 				       void *priv, enum dt_driver_type type)
125 {
126 	struct dt_driver_provider *prv = NULL;
127 	int provider_cells = 0;
128 	uint32_t phandle = 0;
129 
130 	assert_type_is_valid(type);
131 
132 	provider_cells = fdt_get_dt_driver_cells(fdt, nodeoffset, type);
133 	if (provider_cells < 0) {
134 		DMSG("Failed to find provider cells: %d", provider_cells);
135 		return TEE_ERROR_GENERIC;
136 	}
137 
138 	phandle = fdt_get_phandle(fdt, nodeoffset);
139 	if (phandle == (uint32_t)-1) {
140 		DMSG("Failed to find provide phandle");
141 		return TEE_ERROR_GENERIC;
142 	}
143 
144 	prv = calloc(1, sizeof(*prv));
145 	if (!prv)
146 		return TEE_ERROR_OUT_OF_MEMORY;
147 
148 	prv->nodeoffset = nodeoffset;
149 	prv->type = type;
150 	prv->provider_cells = provider_cells;
151 	prv->phandle = phandle;
152 	prv->get_of_device = get_of_device;
153 	prv->priv_data = priv;
154 
155 	SLIST_INSERT_HEAD(&dt_driver_provider_list, prv, link);
156 
157 	return TEE_SUCCESS;
158 }
159 
160 static bool dt_driver_use_parent_controller(enum dt_driver_type type)
161 {
162 	switch (type) {
163 	case DT_DRIVER_PINCTRL:
164 		return true;
165 	default:
166 		return false;
167 	}
168 }
169 
170 /*
171  * Helper functions for dt_drivers querying driver provider information
172  */
173 
174 int fdt_get_dt_driver_cells(const void *fdt, int nodeoffset,
175 			    enum dt_driver_type type)
176 {
177 	const char *cells_name = NULL;
178 	const fdt32_t *c = NULL;
179 	int len = 0;
180 
181 	if (dt_driver_use_parent_controller(type))
182 		return 0;
183 
184 	switch (type) {
185 	case DT_DRIVER_CLK:
186 		cells_name = "#clock-cells";
187 		break;
188 	case DT_DRIVER_RSTCTRL:
189 		cells_name = "#reset-cells";
190 		break;
191 	case DT_DRIVER_GPIO:
192 		cells_name = "#gpio-cells";
193 		break;
194 	case DT_DRIVER_I2C:
195 		return 0;
196 	default:
197 		panic();
198 	}
199 
200 	c = fdt_getprop(fdt, nodeoffset, cells_name, &len);
201 	if (!c)
202 		return len;
203 
204 	if (len != sizeof(*c))
205 		return -FDT_ERR_BADNCELLS;
206 
207 	return fdt32_to_cpu(*c);
208 }
209 
210 unsigned int dt_driver_provider_cells(struct dt_driver_provider *prv)
211 {
212 	return prv->provider_cells;
213 }
214 
215 struct dt_driver_provider *
216 dt_driver_get_provider_by_node(int nodeoffset, enum dt_driver_type type)
217 {
218 	struct dt_driver_provider *prv = NULL;
219 
220 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
221 		if (prv->nodeoffset == nodeoffset && prv->type == type)
222 			return prv;
223 
224 	return NULL;
225 }
226 
227 struct dt_driver_provider *
228 dt_driver_get_provider_by_phandle(uint32_t phandle, enum dt_driver_type type)
229 {
230 	struct dt_driver_provider *prv = NULL;
231 
232 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
233 		if (prv->phandle == phandle && prv->type == type)
234 			return prv;
235 
236 	return NULL;
237 }
238 
239 static void *device_from_provider_prop(struct dt_driver_provider *prv,
240 				       const void *fdt, int phandle_node,
241 				       const uint32_t *prop, TEE_Result *res)
242 {
243 	struct dt_pargs *pargs = NULL;
244 	unsigned int n = 0;
245 	void *device = NULL;
246 
247 	pargs = calloc(1, prv->provider_cells * sizeof(uint32_t *) +
248 		       sizeof(*pargs));
249 	if (!pargs) {
250 		*res = TEE_ERROR_OUT_OF_MEMORY;
251 		return NULL;
252 	}
253 
254 	pargs->fdt = fdt;
255 	pargs->phandle_node = phandle_node;
256 	pargs->args_count = prv->provider_cells;
257 	for (n = 0; n < prv->provider_cells; n++)
258 		pargs->args[n] = fdt32_to_cpu(prop[n + 1]);
259 
260 	device = prv->get_of_device(pargs, prv->priv_data, res);
261 
262 	free(pargs);
263 
264 	return device;
265 }
266 
267 void *dt_driver_device_from_parent(const void *fdt, int nodeoffset,
268 				   enum dt_driver_type type, TEE_Result *res)
269 {
270 	int parent = -1;
271 	struct dt_driver_provider *prv = NULL;
272 
273 	assert(fdt == get_secure_dt());
274 
275 	parent = fdt_parent_offset(fdt, nodeoffset);
276 	if (parent < 0) {
277 		*res =  TEE_ERROR_GENERIC;
278 		return NULL;
279 	}
280 
281 	prv = dt_driver_get_provider_by_node(parent, type);
282 	if (!prv) {
283 		/* No provider registered yet */
284 		*res = TEE_ERROR_DEFER_DRIVER_INIT;
285 		return NULL;
286 	}
287 
288 	return device_from_provider_prop(prv, fdt, nodeoffset, NULL, res);
289 }
290 
291 void *dt_driver_device_from_node_idx_prop(const char *prop_name,
292 					  const void *fdt, int nodeoffset,
293 					  unsigned int prop_idx,
294 					  enum dt_driver_type type,
295 					  TEE_Result *res)
296 {
297 	int len = 0;
298 	int idx = 0;
299 	int idx32 = 0;
300 	int prv_cells = 0;
301 	int phandle_node = -1;
302 	uint32_t phandle = 0;
303 	const uint32_t *prop = NULL;
304 	struct dt_driver_provider *prv = NULL;
305 
306 	prop = fdt_getprop(fdt, nodeoffset, prop_name, &len);
307 	if (!prop) {
308 		DMSG("Property %s missing in node %s", prop_name,
309 		     fdt_get_name(fdt, nodeoffset, NULL));
310 		*res = TEE_ERROR_ITEM_NOT_FOUND;
311 		return NULL;
312 	}
313 
314 	while (idx < len) {
315 		idx32 = idx / sizeof(uint32_t);
316 		phandle = fdt32_to_cpu(prop[idx32]);
317 		if (!phandle) {
318 			if (!prop_idx)
319 				break;
320 			idx += sizeof(phandle);
321 			prop_idx--;
322 			continue;
323 		}
324 
325 		/*
326 		 * In some cases, pinctrl, i2c, nvmem, etc, the consumer phandle
327 		 * points directly to a subnode of the parent. In such cases,
328 		 * the provider does not have any "-cells" property and
329 		 * potentially no "phandle" property.
330 		 */
331 		if (dt_driver_use_parent_controller(type)) {
332 			phandle_node = fdt_node_offset_by_phandle(fdt, phandle);
333 			if (phandle_node < 0) {
334 				*res = TEE_ERROR_GENERIC;
335 				return NULL;
336 			}
337 
338 			nodeoffset = fdt_parent_offset(fdt, phandle_node);
339 			if (nodeoffset < 0) {
340 				*res = TEE_ERROR_GENERIC;
341 				return NULL;
342 			}
343 
344 			prv = dt_driver_get_provider_by_node(nodeoffset, type);
345 			if (!prv) {
346 				*res = TEE_ERROR_DEFER_DRIVER_INIT;
347 				return NULL;
348 			}
349 		} else {
350 			prv = dt_driver_get_provider_by_phandle(phandle, type);
351 			if (!prv) {
352 				/* No provider registered yet */
353 				*res = TEE_ERROR_DEFER_DRIVER_INIT;
354 				return NULL;
355 			}
356 		}
357 
358 		prv_cells = dt_driver_provider_cells(prv);
359 		if (prop_idx) {
360 			prop_idx--;
361 			idx += sizeof(phandle) + prv_cells * sizeof(uint32_t);
362 			continue;
363 		}
364 
365 		return device_from_provider_prop(prv, fdt, phandle_node,
366 						 prop + idx32, res);
367 	}
368 
369 	*res = TEE_ERROR_ITEM_NOT_FOUND;
370 	return NULL;
371 }
372 
373 static void __maybe_unused print_probe_list(const void *fdt __maybe_unused)
374 {
375 	struct dt_driver_probe *elt = NULL;
376 	unsigned int count = 0;
377 
378 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
379 		count++;
380 
381 	DMSG("Probe list: %u elements", count);
382 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
383 		DMSG("|- Driver %s probes on node %s",
384 		     elt->dt_drv->name,
385 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
386 
387 	DMSG("`- Probe list end");
388 
389 	count = 0;
390 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
391 		count++;
392 
393 	DMSG("Failed list: %u elements", count);
394 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
395 		EMSG("|- Driver %s on node %s failed", elt->dt_drv->name,
396 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
397 
398 	DMSG("`- Failed list end");
399 }
400 
401 /*
402  * Probe element: push to ready list if succeeds, push to probe list if probe
403  * if deferred, panic with an error trace otherwise.
404  */
405 static TEE_Result probe_driver_node(const void *fdt,
406 				    struct dt_driver_probe *elt)
407 {
408 	TEE_Result res = TEE_ERROR_GENERIC;
409 	const char __maybe_unused *drv_name = NULL;
410 	const char __maybe_unused *node_name = NULL;
411 
412 	node_name = fdt_get_name(fdt, elt->nodeoffset, NULL);
413 	drv_name = elt->dt_drv->name;
414 
415 	if (!elt->dt_drv->probe) {
416 		DMSG("No probe operator for driver %s, skipped", drv_name);
417 		return TEE_SUCCESS;
418 	}
419 
420 	FMSG("Probing %s on node %s", drv_name, node_name);
421 
422 	res = elt->dt_drv->probe(fdt, elt->nodeoffset, elt->dm->compat_data);
423 	switch (res) {
424 	case TEE_SUCCESS:
425 		TAILQ_INSERT_HEAD(&dt_driver_ready_list, elt, link);
426 
427 		DMSG("element: %s on node %s initialized", drv_name, node_name);
428 		break;
429 	case TEE_ERROR_DEFER_DRIVER_INIT:
430 		elt->deferrals++;
431 		TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
432 
433 		DMSG("element: %s on node %s deferred %u time(s)", drv_name,
434 		     node_name, elt->deferrals);
435 		break;
436 	case TEE_ERROR_NODE_DISABLED:
437 		DMSG("element: %s on node %s is disabled", drv_name, node_name);
438 		break;
439 	default:
440 		TAILQ_INSERT_HEAD(&dt_driver_failed_list, elt, link);
441 
442 		EMSG("Failed to probe %s on node %s: %#"PRIx32,
443 		     drv_name, node_name, res);
444 		break;
445 	}
446 
447 	return res;
448 }
449 
450 static TEE_Result alloc_elt_and_probe(const void *fdt, int node,
451 				      const struct dt_driver *dt_drv,
452 				      const struct dt_device_match *dm)
453 {
454 	struct dt_driver_probe *elt = NULL;
455 
456 	/* Will be freed when lists are released */
457 	elt = calloc(1, sizeof(*elt));
458 	if (!elt)
459 		return TEE_ERROR_OUT_OF_MEMORY;
460 
461 	elt->nodeoffset = node;
462 	elt->dt_drv = dt_drv;
463 	elt->dm = dm;
464 	elt->type = dt_drv->type;
465 
466 	return probe_driver_node(fdt, elt);
467 }
468 
469 /* Lookup a compatible driver, possibly of a specific @type, for the FDT node */
470 static TEE_Result probe_device_by_compat(const void *fdt, int node,
471 					 const char *compat,
472 					 enum dt_driver_type type)
473 {
474 	const struct dt_driver *drv = NULL;
475 	const struct dt_device_match *dm = NULL;
476 
477 	for_each_dt_driver(drv) {
478 		if (drv->type != type)
479 			continue;
480 
481 		for (dm = drv->match_table; dm && dm->compatible; dm++)
482 			if (strcmp(dm->compatible, compat) == 0)
483 				return alloc_elt_and_probe(fdt, node, drv, dm);
484 	}
485 
486 	return TEE_ERROR_ITEM_NOT_FOUND;
487 }
488 
489 /*
490  * Lookup the best matching compatible driver, possibly of a specific @type,
491  * for the FDT node.
492  */
493 TEE_Result dt_driver_probe_device_by_node(const void *fdt, int nodeoffset,
494 					  enum dt_driver_type type)
495 {
496 	int idx = 0;
497 	int len = 0;
498 	int count = 0;
499 	const char *compat = NULL;
500 	TEE_Result res = TEE_ERROR_GENERIC;
501 
502 	assert_type_is_valid(type);
503 
504 	count = fdt_stringlist_count(fdt, nodeoffset, "compatible");
505 	if (count < 0)
506 		return TEE_ERROR_ITEM_NOT_FOUND;
507 
508 	for (idx = 0; idx < count; idx++) {
509 		compat = fdt_stringlist_get(fdt, nodeoffset, "compatible",
510 					    idx, &len);
511 		if (!compat)
512 			return TEE_ERROR_GENERIC;
513 
514 		res = probe_device_by_compat(fdt, nodeoffset, compat, type);
515 
516 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
517 			return res;
518 	}
519 
520 	return TEE_ERROR_ITEM_NOT_FOUND;
521 }
522 
523 static TEE_Result process_probe_list(const void *fdt)
524 {
525 	struct dt_driver_probe *elt = NULL;
526 	struct dt_driver_probe *prev = NULL;
527 	static unsigned int __maybe_unused loop_count;
528 	static unsigned int __maybe_unused deferral_loop_count;
529 	bool __maybe_unused one_deferred = false;
530 	bool one_probed_ok = false;
531 
532 	do {
533 		loop_count++;
534 		FMSG("Probe loop %u after %u for deferral(s)", loop_count,
535 		     deferral_loop_count);
536 
537 		/* Hack here for TRACE_DEBUG messages on probe list elements */
538 		if (TRACE_LEVEL >= TRACE_FLOW)
539 			print_probe_list(fdt);
540 
541 		if (TAILQ_EMPTY(&dt_driver_probe_list))
542 			return TEE_SUCCESS;
543 
544 		/*
545 		 * Probe from current end to top. Deferred probed node are
546 		 * pushed back after current tail for the next probe round.
547 		 * Reset probe result flags and see status after probe round.
548 		 */
549 		one_deferred = false;
550 		one_probed_ok = false;
551 		added_node = false;
552 
553 		TAILQ_FOREACH_REVERSE_SAFE(elt, &dt_driver_probe_list,
554 					   dt_driver_probe_head, link, prev) {
555 			TAILQ_REMOVE(&dt_driver_probe_list, elt, link);
556 
557 			switch (probe_driver_node(fdt, elt)) {
558 			case TEE_SUCCESS:
559 				one_probed_ok = true;
560 				break;
561 			case TEE_ERROR_DEFER_DRIVER_INIT:
562 				one_deferred = true;
563 				break;
564 			default:
565 				break;
566 			}
567 		}
568 
569 		if (one_deferred)
570 			deferral_loop_count++;
571 
572 	} while (added_node || one_probed_ok);
573 
574 	DMSG("Unresolved dependencies after %u rounds, %u deferred",
575 	     loop_count, deferral_loop_count);
576 
577 	if (one_deferred)
578 		return TEE_ERROR_DEFER_DRIVER_INIT;
579 	else
580 		return TEE_ERROR_GENERIC;
581 }
582 
583 static int driver_probe_compare(struct dt_driver_probe *candidate,
584 				struct dt_driver_probe *elt)
585 {
586 	if (candidate->nodeoffset != elt->nodeoffset ||
587 	    candidate->type != elt->type)
588 		return 1;
589 
590 	assert(elt->dt_drv == candidate->dt_drv);
591 	return 0;
592 }
593 
594 /*
595  * Return TEE_SUCCESS if compatible found
596  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
597  */
598 static TEE_Result add_node_to_probe(const void *fdt, int node,
599 				    const struct dt_driver *dt_drv,
600 				    const struct dt_device_match *dm)
601 {
602 	const char __maybe_unused *node_name = fdt_get_name(fdt, node, NULL);
603 	const char __maybe_unused *drv_name = dt_drv->name;
604 	struct dt_driver_probe *elt = NULL;
605 	struct dt_driver_probe elt_new = {
606 		.dm = dm,
607 		.dt_drv = dt_drv,
608 		.nodeoffset = node,
609 		.type = dt_drv->type,
610 	};
611 
612 	/* If node/type found in probe list or ready list, nothing to do */
613 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
614 		if (!driver_probe_compare(&elt_new, elt))
615 			return TEE_SUCCESS;
616 
617 	TAILQ_FOREACH(elt, &dt_driver_ready_list, link)
618 		if (!driver_probe_compare(&elt_new, elt))
619 			return TEE_SUCCESS;
620 
621 	elt = malloc(sizeof(*elt));
622 	if (!elt)
623 		return TEE_ERROR_OUT_OF_MEMORY;
624 
625 	DMSG("element: %s on node %s", node_name, drv_name);
626 
627 	memcpy(elt, &elt_new, sizeof(*elt));
628 
629 	added_node = true;
630 
631 	TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
632 
633 	/* Hack here for TRACE_DEBUG messages on current probe list elements */
634 	if (TRACE_LEVEL >= TRACE_FLOW)
635 		print_probe_list(fdt);
636 
637 	return TEE_SUCCESS;
638 }
639 
640 /*
641  * Add a node to the probe list if a dt_driver matches target compatible.
642  *
643  * If @type is DT_DRIVER_ANY, probe list can hold only 1 driver to probe for
644  * the node. A node may probe several drivers if have a unique driver type.
645  *
646  * Return TEE_SUCCESS if compatible found
647  *	  TEE_ERROR_ITEM_NOT_FOUND if no matching driver
648  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
649  */
650 static TEE_Result add_probe_node_by_compat(const void *fdt, int node,
651 					   const char *compat)
652 {
653 	TEE_Result res = TEE_ERROR_ITEM_NOT_FOUND;
654 	const struct dt_driver *dt_drv = NULL;
655 	const struct dt_device_match *dm = NULL;
656 	uint32_t found_types = 0;
657 
658 	for_each_dt_driver(dt_drv) {
659 		for (dm = dt_drv->match_table; dm && dm->compatible; dm++) {
660 			if (strcmp(dm->compatible, compat) == 0) {
661 				assert(dt_drv->type < 32);
662 
663 				res = add_node_to_probe(fdt, node, dt_drv, dm);
664 				if (res)
665 					return res;
666 
667 				if (found_types & BIT(dt_drv->type)) {
668 					EMSG("Driver %s multi hit on type %u",
669 					     dt_drv->name, dt_drv->type);
670 					panic();
671 				}
672 				found_types |= BIT(dt_drv->type);
673 
674 				/* Matching found for this driver, try next */
675 				break;
676 			}
677 		}
678 	}
679 
680 	return res;
681 }
682 
683 /*
684  * Add the node to the probe list if matching compatible drivers are found.
685  * Follow node's compatible property list ordering to find matching driver.
686  */
687 TEE_Result dt_driver_maybe_add_probe_node(const void *fdt, int node)
688 {
689 	int idx = 0;
690 	int len = 0;
691 	int count = 0;
692 	const char *compat = NULL;
693 	TEE_Result res = TEE_ERROR_GENERIC;
694 
695 	if (fdt_get_status(fdt, node) == DT_STATUS_DISABLED)
696 		return TEE_SUCCESS;
697 
698 	count = fdt_stringlist_count(fdt, node, "compatible");
699 	if (count < 0)
700 		return TEE_SUCCESS;
701 
702 	for (idx = 0; idx < count; idx++) {
703 		compat = fdt_stringlist_get(fdt, node, "compatible", idx, &len);
704 		assert(compat && len > 0);
705 
706 		res = add_probe_node_by_compat(fdt, node, compat);
707 
708 		/* Stop lookup if something was found */
709 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
710 			return res;
711 	}
712 
713 	return TEE_SUCCESS;
714 }
715 
716 static void parse_node(const void *fdt, int node)
717 {
718 	TEE_Result __maybe_unused res = TEE_ERROR_GENERIC;
719 	int subnode = 0;
720 
721 	fdt_for_each_subnode(subnode, fdt, node) {
722 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
723 		if (res) {
724 			EMSG("Failed on node %s with %#"PRIx32,
725 			     fdt_get_name(fdt, subnode, NULL), res);
726 			panic();
727 		}
728 
729 		/*
730 		 * Rescursively parse the FDT, skipping disabled nodes.
731 		 * FDT is expected reliable and core shall have sufficient
732 		 * stack depth to possibly parse all DT nodes.
733 		 */
734 		if (IS_ENABLED(CFG_DRIVERS_DT_RECURSIVE_PROBE)) {
735 			if (fdt_get_status(fdt, subnode) == DT_STATUS_DISABLED)
736 				continue;
737 
738 			parse_node(fdt, subnode);
739 		}
740 	}
741 }
742 
743 /*
744  * Parse FDT for nodes and save in probe list the node for which a dt_driver
745  * matches node's compatible property.
746  */
747 static TEE_Result probe_dt_drivers_early(void)
748 {
749 	TEE_Result res = TEE_ERROR_GENERIC;
750 	const void *fdt = NULL;
751 
752 	fdt = get_secure_dt();
753 	if (!fdt)
754 		return TEE_SUCCESS;
755 
756 	parse_node(fdt, fdt_path_offset(fdt, "/"));
757 
758 	res = process_probe_list(fdt);
759 	if (res == TEE_ERROR_DEFER_DRIVER_INIT) {
760 		DMSG("Deferred drivers probing");
761 		print_probe_list(fdt);
762 		res = TEE_SUCCESS;
763 	}
764 
765 	return res;
766 }
767 
768 static TEE_Result probe_dt_drivers(void)
769 {
770 	TEE_Result res = TEE_ERROR_GENERIC;
771 	const void *fdt = NULL;
772 
773 	fdt = get_secure_dt();
774 	if (!fdt)
775 		return TEE_SUCCESS;
776 
777 	res = process_probe_list(fdt);
778 	if (res || !TAILQ_EMPTY(&dt_driver_failed_list)) {
779 		EMSG("Probe sequence result: %#"PRIx32, res);
780 		print_probe_list(fdt);
781 	}
782 	if (res)
783 		panic();
784 
785 	return TEE_SUCCESS;
786 }
787 
788 early_init_late(probe_dt_drivers_early);
789 driver_init(probe_dt_drivers);
790 
791 static TEE_Result release_probe_lists(void)
792 {
793 	struct dt_driver_probe *elt = NULL;
794 	struct dt_driver_probe *next = NULL;
795 	struct dt_driver_provider *prov = NULL;
796 	struct dt_driver_provider *next_prov = NULL;
797 	const void *fdt = NULL;
798 
799 	fdt = get_secure_dt();
800 	if (!fdt)
801 		return TEE_SUCCESS;
802 
803 	assert(fdt && TAILQ_EMPTY(&dt_driver_probe_list));
804 
805 	TAILQ_FOREACH_SAFE(elt, &dt_driver_ready_list, link, next)
806 		free(elt);
807 
808 	TAILQ_FOREACH_SAFE(elt, &dt_driver_failed_list, link, next)
809 	       free(elt);
810 
811 	SLIST_FOREACH_SAFE(prov, &dt_driver_provider_list, link, next_prov)
812 	       free(prov);
813 
814 	return TEE_SUCCESS;
815 }
816 
817 release_init_resource(release_probe_lists);
818 
819 /*
820  * Simple bus support: handy to parse subnodes
821  */
822 static TEE_Result simple_bus_probe(const void *fdt, int node,
823 				   const void *compat_data __unused)
824 {
825 	TEE_Result res = TEE_ERROR_GENERIC;
826 	int subnode = 0;
827 
828 	fdt_for_each_subnode(subnode, fdt, node) {
829 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
830 		if (res) {
831 			EMSG("Failed on node %s with %#"PRIx32,
832 			     fdt_get_name(fdt, subnode, NULL), res);
833 			panic();
834 		}
835 	}
836 
837 	return TEE_SUCCESS;
838 }
839 
840 static const struct dt_device_match simple_bus_match_table[] = {
841 	{ .compatible = "simple-bus" },
842 	{ }
843 };
844 
845 DEFINE_DT_DRIVER(simple_bus_dt_driver) = {
846 	.name = "simple-bus",
847 	.match_table = simple_bus_match_table,
848 	.probe = simple_bus_probe,
849 };
850