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