xref: /optee_os/core/kernel/dt_driver.c (revision ed33eb2e57ba488d7574437bfb98bb9aaf0fc31b)
18c0c44c9SEtienne Carriere // SPDX-License-Identifier: BSD-2-Clause
28c0c44c9SEtienne Carriere /*
38c0c44c9SEtienne Carriere  * Copyright (c) 2021, Linaro Limited
48c0c44c9SEtienne Carriere  * Copyright (c) 2021, Bootlin
5b3a88b52SEtienne Carriere  * Copyright (c) 2021, Linaro Limited
6b3a88b52SEtienne Carriere  * Copyright (c) 2021, STMicroelectronics
78c0c44c9SEtienne Carriere  */
88c0c44c9SEtienne Carriere 
9b3a88b52SEtienne Carriere #include <assert.h>
10b3a88b52SEtienne Carriere #include <config.h>
113fd340e5SEtienne Carriere #include <initcall.h>
12b3a88b52SEtienne Carriere #include <kernel/boot.h>
133fd340e5SEtienne Carriere #include <kernel/dt.h>
148c0c44c9SEtienne Carriere #include <kernel/dt_driver.h>
153fd340e5SEtienne Carriere #include <libfdt.h>
163fd340e5SEtienne Carriere #include <malloc.h>
178c0c44c9SEtienne Carriere #include <sys/queue.h>
18b3a88b52SEtienne Carriere #include <tee_api_defines_extensions.h>
193fd340e5SEtienne Carriere #include <tee_api_types.h>
208c0c44c9SEtienne Carriere 
21704f6eddSEtienne Carriere /*
22b3a88b52SEtienne Carriere  * struct dt_driver_probe - Node instance in secure FDT to probe a driver for
23b3a88b52SEtienne Carriere  *
24b3a88b52SEtienne Carriere  * @link: List hook
25b3a88b52SEtienne Carriere  * @nodeoffset: Node offset of device referenced in the FDT
26b3a88b52SEtienne Carriere  * @type: One of DT_DRIVER_* or DT_DRIVER_NOTYPE.
27b3a88b52SEtienne Carriere  * @deferrals: Driver probe deferrals count
28b3a88b52SEtienne Carriere  * @dt_drv: Matching driver to probe if found or NULL
29b3a88b52SEtienne Carriere  * @dm: Matching reference if applicable or NULL
30b3a88b52SEtienne Carriere  */
31b3a88b52SEtienne Carriere struct dt_driver_probe {
32b3a88b52SEtienne Carriere 	int nodeoffset;
33b3a88b52SEtienne Carriere 	enum dt_driver_type type;
34b3a88b52SEtienne Carriere 	unsigned int deferrals;
35b3a88b52SEtienne Carriere 	const struct dt_driver *dt_drv;
36b3a88b52SEtienne Carriere 	const struct dt_device_match *dm;
37b3a88b52SEtienne Carriere 	TAILQ_ENTRY(dt_driver_probe) link;
38b3a88b52SEtienne Carriere };
39b3a88b52SEtienne Carriere 
40b3a88b52SEtienne Carriere /*
41704f6eddSEtienne Carriere  * struct dt_driver_provider - DT related info on probed device
42704f6eddSEtienne Carriere  *
43704f6eddSEtienne Carriere  * Saves information on the probed device so that device
44704f6eddSEtienne Carriere  * drivers can get resources from DT phandle and related arguments.
45704f6eddSEtienne Carriere  *
46704f6eddSEtienne Carriere  * @nodeoffset: Node offset of device referenced in the FDT
47704f6eddSEtienne Carriere  * @type: One of DT_DRIVER_* or DT_DRIVER_NOTYPE.
48704f6eddSEtienne Carriere  * @provider_cells: Cells count in the FDT used by the driver's references
49704f6eddSEtienne Carriere  * @get_of_device: Function to get driver's device ref from phandle data
50704f6eddSEtienne Carriere  * @priv_data: Driver private data passed as @get_of_device argument
51704f6eddSEtienne Carriere  * @link: Reference in DT driver providers list
52704f6eddSEtienne Carriere  */
53704f6eddSEtienne Carriere struct dt_driver_provider {
54704f6eddSEtienne Carriere 	int nodeoffset;
55704f6eddSEtienne Carriere 	enum dt_driver_type type;
56704f6eddSEtienne Carriere 	unsigned int provider_cells;
57704f6eddSEtienne Carriere 	uint32_t phandle;
58704f6eddSEtienne Carriere 	get_of_device_func get_of_device;
59704f6eddSEtienne Carriere 	void *priv_data;
60704f6eddSEtienne Carriere 	SLIST_ENTRY(dt_driver_provider) link;
61704f6eddSEtienne Carriere };
62704f6eddSEtienne Carriere 
63b3a88b52SEtienne Carriere /*
64b3a88b52SEtienne Carriere  * Device driver providers are able to provide a driver specific instance
65b3a88b52SEtienne Carriere  * related to device phandle arguments found in the secure embedded FDT.
66b3a88b52SEtienne Carriere  */
67704f6eddSEtienne Carriere static SLIST_HEAD(, dt_driver_provider) dt_driver_provider_list =
688c0c44c9SEtienne Carriere 	SLIST_HEAD_INITIALIZER(dt_driver_provider_list);
693fd340e5SEtienne Carriere 
70b3a88b52SEtienne Carriere /* FDT nodes for which a matching driver is to be probed */
71b3a88b52SEtienne Carriere static TAILQ_HEAD(dt_driver_probe_head, dt_driver_probe) dt_driver_probe_list =
72b3a88b52SEtienne Carriere 	TAILQ_HEAD_INITIALIZER(dt_driver_probe_list);
73b3a88b52SEtienne Carriere 
74b3a88b52SEtienne Carriere /* FDT nodes for which a matching driver has been successfully probed */
75b3a88b52SEtienne Carriere static TAILQ_HEAD(, dt_driver_probe) dt_driver_ready_list =
76b3a88b52SEtienne Carriere 	TAILQ_HEAD_INITIALIZER(dt_driver_ready_list);
77b3a88b52SEtienne Carriere 
78736cb9e1SEtienne Carriere /* List of the nodes for which a compatible driver but reported a failure */
79736cb9e1SEtienne Carriere static TAILQ_HEAD(, dt_driver_probe) dt_driver_failed_list =
80736cb9e1SEtienne Carriere 	TAILQ_HEAD_INITIALIZER(dt_driver_failed_list);
81736cb9e1SEtienne Carriere 
82b3a88b52SEtienne Carriere /* Flag enabled when a new node (possibly typed) is added in the probe list */
83b3a88b52SEtienne Carriere static bool added_node;
84b3a88b52SEtienne Carriere 
853de8f0deSEtienne Carriere /* Resolve drivers dependencies on core crypto layer */
863de8f0deSEtienne Carriere static bool tee_crypt_is_ready;
873de8f0deSEtienne Carriere 
883de8f0deSEtienne Carriere void dt_driver_crypt_init_complete(void)
893de8f0deSEtienne Carriere {
903de8f0deSEtienne Carriere 	assert(!tee_crypt_is_ready);
913de8f0deSEtienne Carriere 	tee_crypt_is_ready = true;
923de8f0deSEtienne Carriere }
933de8f0deSEtienne Carriere 
943de8f0deSEtienne Carriere TEE_Result dt_driver_get_crypto(void)
953de8f0deSEtienne Carriere {
963de8f0deSEtienne Carriere 	if (tee_crypt_is_ready)
973de8f0deSEtienne Carriere 		return TEE_SUCCESS;
983de8f0deSEtienne Carriere 	else
993de8f0deSEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
1003de8f0deSEtienne Carriere }
1013de8f0deSEtienne Carriere 
102b3a88b52SEtienne Carriere static void assert_type_is_valid(enum dt_driver_type type)
103b3a88b52SEtienne Carriere {
104b3a88b52SEtienne Carriere 	switch (type) {
105b3a88b52SEtienne Carriere 	case DT_DRIVER_NOTYPE:
106b3a88b52SEtienne Carriere 	case DT_DRIVER_CLK:
107c78b2c66SEtienne Carriere 	case DT_DRIVER_RSTCTRL:
108c78b2c66SEtienne Carriere 	case DT_DRIVER_UART:
1094fc179b6SThomas Perrot 	case DT_DRIVER_GPIO:
110e7a2db34SClément Léger 	case DT_DRIVER_I2C:
111b5aff6deSClément Léger 	case DT_DRIVER_PINCTRL:
112*ed33eb2eSEtienne Carriere 	case DT_DRIVER_INTERRUPT:
113b3a88b52SEtienne Carriere 		return;
114b3a88b52SEtienne Carriere 	default:
115b3a88b52SEtienne Carriere 		assert(0);
116b3a88b52SEtienne Carriere 	}
117b3a88b52SEtienne Carriere }
118b3a88b52SEtienne Carriere 
1193fd340e5SEtienne Carriere /*
1203fd340e5SEtienne Carriere  * Driver provider registering API functions
1213fd340e5SEtienne Carriere  */
1223fd340e5SEtienne Carriere 
1233fd340e5SEtienne Carriere TEE_Result dt_driver_register_provider(const void *fdt, int nodeoffset,
1243fd340e5SEtienne Carriere 				       get_of_device_func get_of_device,
1253fd340e5SEtienne Carriere 				       void *priv, enum dt_driver_type type)
1263fd340e5SEtienne Carriere {
1273fd340e5SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
1283fd340e5SEtienne Carriere 	int provider_cells = 0;
1293fd340e5SEtienne Carriere 	uint32_t phandle = 0;
1303fd340e5SEtienne Carriere 
131b3a88b52SEtienne Carriere 	assert_type_is_valid(type);
132b3a88b52SEtienne Carriere 
1333fd340e5SEtienne Carriere 	provider_cells = fdt_get_dt_driver_cells(fdt, nodeoffset, type);
1343fd340e5SEtienne Carriere 	if (provider_cells < 0) {
1353fd340e5SEtienne Carriere 		DMSG("Failed to find provider cells: %d", provider_cells);
1363fd340e5SEtienne Carriere 		return TEE_ERROR_GENERIC;
1373fd340e5SEtienne Carriere 	}
1383fd340e5SEtienne Carriere 
1393fd340e5SEtienne Carriere 	phandle = fdt_get_phandle(fdt, nodeoffset);
1400f9f9a37SGatien Chevallier 	if (phandle == (uint32_t)-1) {
1413fd340e5SEtienne Carriere 		DMSG("Failed to find provide phandle");
1423fd340e5SEtienne Carriere 		return TEE_ERROR_GENERIC;
1433fd340e5SEtienne Carriere 	}
1443fd340e5SEtienne Carriere 
1453fd340e5SEtienne Carriere 	prv = calloc(1, sizeof(*prv));
1463fd340e5SEtienne Carriere 	if (!prv)
1473fd340e5SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
1483fd340e5SEtienne Carriere 
1493fd340e5SEtienne Carriere 	prv->nodeoffset = nodeoffset;
1503fd340e5SEtienne Carriere 	prv->type = type;
1513fd340e5SEtienne Carriere 	prv->provider_cells = provider_cells;
1523fd340e5SEtienne Carriere 	prv->phandle = phandle;
1533fd340e5SEtienne Carriere 	prv->get_of_device = get_of_device;
1543fd340e5SEtienne Carriere 	prv->priv_data = priv;
1553fd340e5SEtienne Carriere 
1563fd340e5SEtienne Carriere 	SLIST_INSERT_HEAD(&dt_driver_provider_list, prv, link);
1573fd340e5SEtienne Carriere 
1583fd340e5SEtienne Carriere 	return TEE_SUCCESS;
1593fd340e5SEtienne Carriere }
1603fd340e5SEtienne Carriere 
161b5aff6deSClément Léger static bool dt_driver_use_parent_controller(enum dt_driver_type type)
162b5aff6deSClément Léger {
163b5aff6deSClément Léger 	switch (type) {
164b5aff6deSClément Léger 	case DT_DRIVER_PINCTRL:
165b5aff6deSClément Léger 		return true;
166b5aff6deSClément Léger 	default:
167b5aff6deSClément Léger 		return false;
168b5aff6deSClément Léger 	}
169b5aff6deSClément Léger }
170b5aff6deSClément Léger 
1713fd340e5SEtienne Carriere /*
1723fd340e5SEtienne Carriere  * Helper functions for dt_drivers querying driver provider information
1733fd340e5SEtienne Carriere  */
1743fd340e5SEtienne Carriere 
1753fd340e5SEtienne Carriere int fdt_get_dt_driver_cells(const void *fdt, int nodeoffset,
1763fd340e5SEtienne Carriere 			    enum dt_driver_type type)
1773fd340e5SEtienne Carriere {
1783fd340e5SEtienne Carriere 	const char *cells_name = NULL;
1793fd340e5SEtienne Carriere 	const fdt32_t *c = NULL;
1803fd340e5SEtienne Carriere 	int len = 0;
1813fd340e5SEtienne Carriere 
182b5aff6deSClément Léger 	if (dt_driver_use_parent_controller(type))
183b5aff6deSClément Léger 		return 0;
184b5aff6deSClément Léger 
1853fd340e5SEtienne Carriere 	switch (type) {
1863fd340e5SEtienne Carriere 	case DT_DRIVER_CLK:
1873fd340e5SEtienne Carriere 		cells_name = "#clock-cells";
1883fd340e5SEtienne Carriere 		break;
189*ed33eb2eSEtienne Carriere 	case DT_DRIVER_INTERRUPT:
190*ed33eb2eSEtienne Carriere 		cells_name = "#interrupt-cells";
191*ed33eb2eSEtienne Carriere 		break;
192c78b2c66SEtienne Carriere 	case DT_DRIVER_RSTCTRL:
193c78b2c66SEtienne Carriere 		cells_name = "#reset-cells";
194c78b2c66SEtienne Carriere 		break;
1954fc179b6SThomas Perrot 	case DT_DRIVER_GPIO:
1964fc179b6SThomas Perrot 		cells_name = "#gpio-cells";
1974fc179b6SThomas Perrot 		break;
198e7a2db34SClément Léger 	case DT_DRIVER_I2C:
199e7a2db34SClément Léger 		return 0;
2003fd340e5SEtienne Carriere 	default:
2013fd340e5SEtienne Carriere 		panic();
2023fd340e5SEtienne Carriere 	}
2033fd340e5SEtienne Carriere 
2043fd340e5SEtienne Carriere 	c = fdt_getprop(fdt, nodeoffset, cells_name, &len);
2053fd340e5SEtienne Carriere 	if (!c)
2063fd340e5SEtienne Carriere 		return len;
2073fd340e5SEtienne Carriere 
2083fd340e5SEtienne Carriere 	if (len != sizeof(*c))
2093fd340e5SEtienne Carriere 		return -FDT_ERR_BADNCELLS;
2103fd340e5SEtienne Carriere 
2113fd340e5SEtienne Carriere 	return fdt32_to_cpu(*c);
2123fd340e5SEtienne Carriere }
2133fd340e5SEtienne Carriere 
2143fd340e5SEtienne Carriere unsigned int dt_driver_provider_cells(struct dt_driver_provider *prv)
2153fd340e5SEtienne Carriere {
2163fd340e5SEtienne Carriere 	return prv->provider_cells;
2173fd340e5SEtienne Carriere }
218f498c404SEtienne Carriere 
2198dca59b4SEtienne Carriere struct dt_driver_provider *
2208dca59b4SEtienne Carriere dt_driver_get_provider_by_node(int nodeoffset, enum dt_driver_type type)
221f498c404SEtienne Carriere {
222f498c404SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
223f498c404SEtienne Carriere 
224f498c404SEtienne Carriere 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
2258dca59b4SEtienne Carriere 		if (prv->nodeoffset == nodeoffset && prv->type == type)
226f498c404SEtienne Carriere 			return prv;
227f498c404SEtienne Carriere 
228f498c404SEtienne Carriere 	return NULL;
229f498c404SEtienne Carriere }
230f498c404SEtienne Carriere 
2318dca59b4SEtienne Carriere struct dt_driver_provider *
2328dca59b4SEtienne Carriere dt_driver_get_provider_by_phandle(uint32_t phandle, enum dt_driver_type type)
233f498c404SEtienne Carriere {
234f498c404SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
235f498c404SEtienne Carriere 
236f498c404SEtienne Carriere 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
2378dca59b4SEtienne Carriere 		if (prv->phandle == phandle && prv->type == type)
238f498c404SEtienne Carriere 			return prv;
239f498c404SEtienne Carriere 
240f498c404SEtienne Carriere 	return NULL;
241f498c404SEtienne Carriere }
242a22e85b2SEtienne Carriere 
243a22e85b2SEtienne Carriere static void *device_from_provider_prop(struct dt_driver_provider *prv,
24433cc94dfSClément Léger 				       const void *fdt, int phandle_node,
24533cc94dfSClément Léger 				       const uint32_t *prop, TEE_Result *res)
246a22e85b2SEtienne Carriere {
2478fd620f7SEtienne Carriere 	struct dt_pargs *pargs = NULL;
248a22e85b2SEtienne Carriere 	unsigned int n = 0;
249a22e85b2SEtienne Carriere 	void *device = NULL;
250a22e85b2SEtienne Carriere 
251a22e85b2SEtienne Carriere 	pargs = calloc(1, prv->provider_cells * sizeof(uint32_t *) +
252a22e85b2SEtienne Carriere 		       sizeof(*pargs));
253d8b14b46SEtienne Carriere 	if (!pargs) {
254d8b14b46SEtienne Carriere 		*res = TEE_ERROR_OUT_OF_MEMORY;
255a22e85b2SEtienne Carriere 		return NULL;
256d8b14b46SEtienne Carriere 	}
257a22e85b2SEtienne Carriere 
25833cc94dfSClément Léger 	pargs->fdt = fdt;
25933cc94dfSClément Léger 	pargs->phandle_node = phandle_node;
260a22e85b2SEtienne Carriere 	pargs->args_count = prv->provider_cells;
261a22e85b2SEtienne Carriere 	for (n = 0; n < prv->provider_cells; n++)
262a22e85b2SEtienne Carriere 		pargs->args[n] = fdt32_to_cpu(prop[n + 1]);
263a22e85b2SEtienne Carriere 
264d8b14b46SEtienne Carriere 	device = prv->get_of_device(pargs, prv->priv_data, res);
265a22e85b2SEtienne Carriere 
266a22e85b2SEtienne Carriere 	free(pargs);
267a22e85b2SEtienne Carriere 
268a22e85b2SEtienne Carriere 	return device;
269a22e85b2SEtienne Carriere }
270a22e85b2SEtienne Carriere 
271e7a2db34SClément Léger void *dt_driver_device_from_parent(const void *fdt, int nodeoffset,
272e7a2db34SClément Léger 				   enum dt_driver_type type, TEE_Result *res)
273e7a2db34SClément Léger {
274e7a2db34SClément Léger 	int parent = -1;
275e7a2db34SClément Léger 	struct dt_driver_provider *prv = NULL;
276e7a2db34SClément Léger 
277e7a2db34SClément Léger 	assert(fdt == get_secure_dt());
278e7a2db34SClément Léger 
279e7a2db34SClément Léger 	parent = fdt_parent_offset(fdt, nodeoffset);
280e7a2db34SClément Léger 	if (parent < 0) {
281e7a2db34SClément Léger 		*res =  TEE_ERROR_GENERIC;
282e7a2db34SClément Léger 		return NULL;
283e7a2db34SClément Léger 	}
284e7a2db34SClément Léger 
285e7a2db34SClément Léger 	prv = dt_driver_get_provider_by_node(parent, type);
286e7a2db34SClément Léger 	if (!prv) {
287e7a2db34SClément Léger 		/* No provider registered yet */
288e7a2db34SClément Léger 		*res = TEE_ERROR_DEFER_DRIVER_INIT;
289e7a2db34SClément Léger 		return NULL;
290e7a2db34SClément Léger 	}
291e7a2db34SClément Léger 
292e7a2db34SClément Léger 	return device_from_provider_prop(prv, fdt, nodeoffset, NULL, res);
293e7a2db34SClément Léger }
294e7a2db34SClément Léger 
295a22e85b2SEtienne Carriere void *dt_driver_device_from_node_idx_prop(const char *prop_name,
296a22e85b2SEtienne Carriere 					  const void *fdt, int nodeoffset,
297d8b14b46SEtienne Carriere 					  unsigned int prop_idx,
2988dca59b4SEtienne Carriere 					  enum dt_driver_type type,
299d8b14b46SEtienne Carriere 					  TEE_Result *res)
300a22e85b2SEtienne Carriere {
301a22e85b2SEtienne Carriere 	int len = 0;
302a22e85b2SEtienne Carriere 	int idx = 0;
303a22e85b2SEtienne Carriere 	int idx32 = 0;
304a22e85b2SEtienne Carriere 	int prv_cells = 0;
30533cc94dfSClément Léger 	int phandle_node = -1;
306a22e85b2SEtienne Carriere 	uint32_t phandle = 0;
307a22e85b2SEtienne Carriere 	const uint32_t *prop = NULL;
308a22e85b2SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
309a22e85b2SEtienne Carriere 
310a22e85b2SEtienne Carriere 	prop = fdt_getprop(fdt, nodeoffset, prop_name, &len);
311d8b14b46SEtienne Carriere 	if (!prop) {
312b17cf5c8SEtienne Carriere 		DMSG("Property %s missing in node %s", prop_name,
313b17cf5c8SEtienne Carriere 		     fdt_get_name(fdt, nodeoffset, NULL));
3140adca93aSGatien Chevallier 		*res = TEE_ERROR_ITEM_NOT_FOUND;
315a22e85b2SEtienne Carriere 		return NULL;
316d8b14b46SEtienne Carriere 	}
317a22e85b2SEtienne Carriere 
318a22e85b2SEtienne Carriere 	while (idx < len) {
319a22e85b2SEtienne Carriere 		idx32 = idx / sizeof(uint32_t);
320a22e85b2SEtienne Carriere 		phandle = fdt32_to_cpu(prop[idx32]);
321f1f7c58eSClément Léger 		if (!phandle) {
322f1f7c58eSClément Léger 			if (!prop_idx)
323f1f7c58eSClément Léger 				break;
324f1f7c58eSClément Léger 			idx += sizeof(phandle);
325f1f7c58eSClément Léger 			prop_idx--;
326f1f7c58eSClément Léger 			continue;
327f1f7c58eSClément Léger 		}
328a22e85b2SEtienne Carriere 
329b5aff6deSClément Léger 		/*
330b5aff6deSClément Léger 		 * In some cases, pinctrl, i2c, nvmem, etc, the consumer phandle
331b5aff6deSClément Léger 		 * points directly to a subnode of the parent. In such cases,
332b5aff6deSClément Léger 		 * the provider does not have any "-cells" property and
333b5aff6deSClément Léger 		 * potentially no "phandle" property.
334b5aff6deSClément Léger 		 */
335b5aff6deSClément Léger 		if (dt_driver_use_parent_controller(type)) {
336b5aff6deSClément Léger 			phandle_node = fdt_node_offset_by_phandle(fdt, phandle);
337b5aff6deSClément Léger 			if (phandle_node < 0) {
338b5aff6deSClément Léger 				*res = TEE_ERROR_GENERIC;
339b5aff6deSClément Léger 				return NULL;
340b5aff6deSClément Léger 			}
341b5aff6deSClément Léger 
342b5aff6deSClément Léger 			nodeoffset = fdt_parent_offset(fdt, phandle_node);
343b5aff6deSClément Léger 			if (nodeoffset < 0) {
344b5aff6deSClément Léger 				*res = TEE_ERROR_GENERIC;
345b5aff6deSClément Léger 				return NULL;
346b5aff6deSClément Léger 			}
347b5aff6deSClément Léger 
348b5aff6deSClément Léger 			prv = dt_driver_get_provider_by_node(nodeoffset, type);
349b5aff6deSClément Léger 			if (!prv) {
350b5aff6deSClément Léger 				*res = TEE_ERROR_DEFER_DRIVER_INIT;
351b5aff6deSClément Léger 				return NULL;
352b5aff6deSClément Léger 			}
353b5aff6deSClément Léger 		} else {
3548dca59b4SEtienne Carriere 			prv = dt_driver_get_provider_by_phandle(phandle, type);
355d8b14b46SEtienne Carriere 			if (!prv) {
356a3f00f7dSEtienne Carriere 				/* No provider registered yet */
357a3f00f7dSEtienne Carriere 				*res = TEE_ERROR_DEFER_DRIVER_INIT;
358a22e85b2SEtienne Carriere 				return NULL;
359d8b14b46SEtienne Carriere 			}
360b5aff6deSClément Léger 		}
361a22e85b2SEtienne Carriere 
362a22e85b2SEtienne Carriere 		prv_cells = dt_driver_provider_cells(prv);
363a22e85b2SEtienne Carriere 		if (prop_idx) {
364a22e85b2SEtienne Carriere 			prop_idx--;
365a22e85b2SEtienne Carriere 			idx += sizeof(phandle) + prv_cells * sizeof(uint32_t);
366a22e85b2SEtienne Carriere 			continue;
367a22e85b2SEtienne Carriere 		}
368a22e85b2SEtienne Carriere 
36933cc94dfSClément Léger 		return device_from_provider_prop(prv, fdt, phandle_node,
37033cc94dfSClément Léger 						 prop + idx32, res);
371a22e85b2SEtienne Carriere 	}
372a22e85b2SEtienne Carriere 
3730adca93aSGatien Chevallier 	*res = TEE_ERROR_ITEM_NOT_FOUND;
374a22e85b2SEtienne Carriere 	return NULL;
375a22e85b2SEtienne Carriere }
376ef20efc4SEtienne Carriere 
377c9bd3375SEtienne Carriere static void __maybe_unused print_probe_list(const void *fdt __maybe_unused)
378b3a88b52SEtienne Carriere {
379b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
380b3a88b52SEtienne Carriere 	unsigned int count = 0;
381b3a88b52SEtienne Carriere 
382b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
383b3a88b52SEtienne Carriere 		count++;
384b3a88b52SEtienne Carriere 
385c9bd3375SEtienne Carriere 	DMSG("Probe list: %u elements", count);
386b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
387c9bd3375SEtienne Carriere 		DMSG("|- Driver %s probes on node %s",
388b3a88b52SEtienne Carriere 		     elt->dt_drv->name,
389b3a88b52SEtienne Carriere 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
390b3a88b52SEtienne Carriere 
391c9bd3375SEtienne Carriere 	DMSG("`- Probe list end");
392c9bd3375SEtienne Carriere 
393c9bd3375SEtienne Carriere 	count = 0;
394c9bd3375SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
395c9bd3375SEtienne Carriere 		count++;
396c9bd3375SEtienne Carriere 
397c9bd3375SEtienne Carriere 	DMSG("Failed list: %u elements", count);
398c9bd3375SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
399c9bd3375SEtienne Carriere 		EMSG("|- Driver %s on node %s failed", elt->dt_drv->name,
400c9bd3375SEtienne Carriere 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
401c9bd3375SEtienne Carriere 
402c9bd3375SEtienne Carriere 	DMSG("`- Failed list end");
403b3a88b52SEtienne Carriere }
404b3a88b52SEtienne Carriere 
405b3a88b52SEtienne Carriere /*
406b3a88b52SEtienne Carriere  * Probe element: push to ready list if succeeds, push to probe list if probe
407b3a88b52SEtienne Carriere  * if deferred, panic with an error trace otherwise.
408b3a88b52SEtienne Carriere  */
409b3a88b52SEtienne Carriere static TEE_Result probe_driver_node(const void *fdt,
410b3a88b52SEtienne Carriere 				    struct dt_driver_probe *elt)
411b3a88b52SEtienne Carriere {
412b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
413b3a88b52SEtienne Carriere 	const char __maybe_unused *drv_name = NULL;
414b3a88b52SEtienne Carriere 	const char __maybe_unused *node_name = NULL;
415b3a88b52SEtienne Carriere 
416b3a88b52SEtienne Carriere 	node_name = fdt_get_name(fdt, elt->nodeoffset, NULL);
417b3a88b52SEtienne Carriere 	drv_name = elt->dt_drv->name;
418c4c84e2cSSahil Malhotra 
419c4c84e2cSSahil Malhotra 	if (!elt->dt_drv->probe) {
420c4c84e2cSSahil Malhotra 		DMSG("No probe operator for driver %s, skipped", drv_name);
421c4c84e2cSSahil Malhotra 		return TEE_SUCCESS;
422c4c84e2cSSahil Malhotra 	}
423c4c84e2cSSahil Malhotra 
424b3a88b52SEtienne Carriere 	FMSG("Probing %s on node %s", drv_name, node_name);
425b3a88b52SEtienne Carriere 
426b3a88b52SEtienne Carriere 	res = elt->dt_drv->probe(fdt, elt->nodeoffset, elt->dm->compat_data);
427b3a88b52SEtienne Carriere 	switch (res) {
428b3a88b52SEtienne Carriere 	case TEE_SUCCESS:
429b3a88b52SEtienne Carriere 		TAILQ_INSERT_HEAD(&dt_driver_ready_list, elt, link);
430b3a88b52SEtienne Carriere 
431b3a88b52SEtienne Carriere 		DMSG("element: %s on node %s initialized", drv_name, node_name);
432b3a88b52SEtienne Carriere 		break;
433b3a88b52SEtienne Carriere 	case TEE_ERROR_DEFER_DRIVER_INIT:
434b3a88b52SEtienne Carriere 		elt->deferrals++;
435b3a88b52SEtienne Carriere 		TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
436b3a88b52SEtienne Carriere 
437b3a88b52SEtienne Carriere 		DMSG("element: %s on node %s deferred %u time(s)", drv_name,
438b3a88b52SEtienne Carriere 		     node_name, elt->deferrals);
439b3a88b52SEtienne Carriere 		break;
44052199c35SVesa Jääskeläinen 	case TEE_ERROR_NODE_DISABLED:
44152199c35SVesa Jääskeläinen 		DMSG("element: %s on node %s is disabled", drv_name, node_name);
44252199c35SVesa Jääskeläinen 		break;
443b3a88b52SEtienne Carriere 	default:
444736cb9e1SEtienne Carriere 		TAILQ_INSERT_HEAD(&dt_driver_failed_list, elt, link);
445736cb9e1SEtienne Carriere 
446736cb9e1SEtienne Carriere 		EMSG("Failed to probe %s on node %s: %#"PRIx32,
447b3a88b52SEtienne Carriere 		     drv_name, node_name, res);
448736cb9e1SEtienne Carriere 		break;
449b3a88b52SEtienne Carriere 	}
450b3a88b52SEtienne Carriere 
451b3a88b52SEtienne Carriere 	return res;
452b3a88b52SEtienne Carriere }
453b3a88b52SEtienne Carriere 
454b3a88b52SEtienne Carriere static TEE_Result alloc_elt_and_probe(const void *fdt, int node,
455b3a88b52SEtienne Carriere 				      const struct dt_driver *dt_drv,
456b3a88b52SEtienne Carriere 				      const struct dt_device_match *dm)
457b3a88b52SEtienne Carriere {
458b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
459b3a88b52SEtienne Carriere 
460b3a88b52SEtienne Carriere 	/* Will be freed when lists are released */
461b3a88b52SEtienne Carriere 	elt = calloc(1, sizeof(*elt));
462b3a88b52SEtienne Carriere 	if (!elt)
463b3a88b52SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
464b3a88b52SEtienne Carriere 
465b3a88b52SEtienne Carriere 	elt->nodeoffset = node;
466b3a88b52SEtienne Carriere 	elt->dt_drv = dt_drv;
467b3a88b52SEtienne Carriere 	elt->dm = dm;
468b3a88b52SEtienne Carriere 	elt->type = dt_drv->type;
469b3a88b52SEtienne Carriere 
470b3a88b52SEtienne Carriere 	return probe_driver_node(fdt, elt);
471b3a88b52SEtienne Carriere }
472b3a88b52SEtienne Carriere 
473ef20efc4SEtienne Carriere /* Lookup a compatible driver, possibly of a specific @type, for the FDT node */
474ef20efc4SEtienne Carriere static TEE_Result probe_device_by_compat(const void *fdt, int node,
475ef20efc4SEtienne Carriere 					 const char *compat,
476ef20efc4SEtienne Carriere 					 enum dt_driver_type type)
477ef20efc4SEtienne Carriere {
478ef20efc4SEtienne Carriere 	const struct dt_driver *drv = NULL;
479ef20efc4SEtienne Carriere 	const struct dt_device_match *dm = NULL;
480ef20efc4SEtienne Carriere 
481ef20efc4SEtienne Carriere 	for_each_dt_driver(drv) {
482ef20efc4SEtienne Carriere 		if (drv->type != type)
483ef20efc4SEtienne Carriere 			continue;
484ef20efc4SEtienne Carriere 
485ef20efc4SEtienne Carriere 		for (dm = drv->match_table; dm && dm->compatible; dm++)
486ef20efc4SEtienne Carriere 			if (strcmp(dm->compatible, compat) == 0)
487b3a88b52SEtienne Carriere 				return alloc_elt_and_probe(fdt, node, drv, dm);
488ef20efc4SEtienne Carriere 	}
489ef20efc4SEtienne Carriere 
490ef20efc4SEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
491ef20efc4SEtienne Carriere }
492ef20efc4SEtienne Carriere 
493b3a88b52SEtienne Carriere /*
494b3a88b52SEtienne Carriere  * Lookup the best matching compatible driver, possibly of a specific @type,
495b3a88b52SEtienne Carriere  * for the FDT node.
496b3a88b52SEtienne Carriere  */
497ef20efc4SEtienne Carriere TEE_Result dt_driver_probe_device_by_node(const void *fdt, int nodeoffset,
498ef20efc4SEtienne Carriere 					  enum dt_driver_type type)
499ef20efc4SEtienne Carriere {
500ef20efc4SEtienne Carriere 	int idx = 0;
501ef20efc4SEtienne Carriere 	int len = 0;
502ef20efc4SEtienne Carriere 	int count = 0;
503ef20efc4SEtienne Carriere 	const char *compat = NULL;
504ef20efc4SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
505ef20efc4SEtienne Carriere 
506b3a88b52SEtienne Carriere 	assert_type_is_valid(type);
507b3a88b52SEtienne Carriere 
508ef20efc4SEtienne Carriere 	count = fdt_stringlist_count(fdt, nodeoffset, "compatible");
509ef20efc4SEtienne Carriere 	if (count < 0)
510ef20efc4SEtienne Carriere 		return TEE_ERROR_ITEM_NOT_FOUND;
511ef20efc4SEtienne Carriere 
512ef20efc4SEtienne Carriere 	for (idx = 0; idx < count; idx++) {
513ef20efc4SEtienne Carriere 		compat = fdt_stringlist_get(fdt, nodeoffset, "compatible",
514ef20efc4SEtienne Carriere 					    idx, &len);
515ef20efc4SEtienne Carriere 		if (!compat)
516ef20efc4SEtienne Carriere 			return TEE_ERROR_GENERIC;
517ef20efc4SEtienne Carriere 
518ef20efc4SEtienne Carriere 		res = probe_device_by_compat(fdt, nodeoffset, compat, type);
519ef20efc4SEtienne Carriere 
520ef20efc4SEtienne Carriere 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
521ef20efc4SEtienne Carriere 			return res;
522ef20efc4SEtienne Carriere 	}
523ef20efc4SEtienne Carriere 
524ef20efc4SEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
525ef20efc4SEtienne Carriere }
526b3a88b52SEtienne Carriere 
527b3a88b52SEtienne Carriere static TEE_Result process_probe_list(const void *fdt)
528b3a88b52SEtienne Carriere {
529b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
530b3a88b52SEtienne Carriere 	struct dt_driver_probe *prev = NULL;
531c9bd3375SEtienne Carriere 	static unsigned int __maybe_unused loop_count;
532c9bd3375SEtienne Carriere 	static unsigned int __maybe_unused deferral_loop_count;
533b3a88b52SEtienne Carriere 	bool __maybe_unused one_deferred = false;
534b3a88b52SEtienne Carriere 	bool one_probed_ok = false;
535b3a88b52SEtienne Carriere 
536b3a88b52SEtienne Carriere 	do {
537b3a88b52SEtienne Carriere 		loop_count++;
538b3a88b52SEtienne Carriere 		FMSG("Probe loop %u after %u for deferral(s)", loop_count,
539b3a88b52SEtienne Carriere 		     deferral_loop_count);
540b3a88b52SEtienne Carriere 
541b3a88b52SEtienne Carriere 		/* Hack here for TRACE_DEBUG messages on probe list elements */
542b3a88b52SEtienne Carriere 		if (TRACE_LEVEL >= TRACE_FLOW)
543b3a88b52SEtienne Carriere 			print_probe_list(fdt);
544b3a88b52SEtienne Carriere 
545b3a88b52SEtienne Carriere 		if (TAILQ_EMPTY(&dt_driver_probe_list))
546b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
547b3a88b52SEtienne Carriere 
548b3a88b52SEtienne Carriere 		/*
549b3a88b52SEtienne Carriere 		 * Probe from current end to top. Deferred probed node are
550b3a88b52SEtienne Carriere 		 * pushed back after current tail for the next probe round.
551b3a88b52SEtienne Carriere 		 * Reset probe result flags and see status after probe round.
552b3a88b52SEtienne Carriere 		 */
553b3a88b52SEtienne Carriere 		one_deferred = false;
554b3a88b52SEtienne Carriere 		one_probed_ok = false;
555b3a88b52SEtienne Carriere 		added_node = false;
556b3a88b52SEtienne Carriere 
557b3a88b52SEtienne Carriere 		TAILQ_FOREACH_REVERSE_SAFE(elt, &dt_driver_probe_list,
558b3a88b52SEtienne Carriere 					   dt_driver_probe_head, link, prev) {
559b3a88b52SEtienne Carriere 			TAILQ_REMOVE(&dt_driver_probe_list, elt, link);
560b3a88b52SEtienne Carriere 
561b3a88b52SEtienne Carriere 			switch (probe_driver_node(fdt, elt)) {
562b3a88b52SEtienne Carriere 			case TEE_SUCCESS:
563b3a88b52SEtienne Carriere 				one_probed_ok = true;
564b3a88b52SEtienne Carriere 				break;
565b3a88b52SEtienne Carriere 			case TEE_ERROR_DEFER_DRIVER_INIT:
566b3a88b52SEtienne Carriere 				one_deferred = true;
567b3a88b52SEtienne Carriere 				break;
568b3a88b52SEtienne Carriere 			default:
569736cb9e1SEtienne Carriere 				break;
570b3a88b52SEtienne Carriere 			}
571b3a88b52SEtienne Carriere 		}
572b3a88b52SEtienne Carriere 
573b3a88b52SEtienne Carriere 		if (one_deferred)
574b3a88b52SEtienne Carriere 			deferral_loop_count++;
575b3a88b52SEtienne Carriere 
576b3a88b52SEtienne Carriere 	} while (added_node || one_probed_ok);
577b3a88b52SEtienne Carriere 
578c9bd3375SEtienne Carriere 	DMSG("Unresolved dependencies after %u rounds, %u deferred",
579b3a88b52SEtienne Carriere 	     loop_count, deferral_loop_count);
580b3a88b52SEtienne Carriere 
581c9bd3375SEtienne Carriere 	if (one_deferred)
582c9bd3375SEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
583c9bd3375SEtienne Carriere 	else
584c9bd3375SEtienne Carriere 		return TEE_ERROR_GENERIC;
585b3a88b52SEtienne Carriere }
586b3a88b52SEtienne Carriere 
587b3a88b52SEtienne Carriere static int driver_probe_compare(struct dt_driver_probe *candidate,
588b3a88b52SEtienne Carriere 				struct dt_driver_probe *elt)
589b3a88b52SEtienne Carriere {
590b3a88b52SEtienne Carriere 	if (candidate->nodeoffset != elt->nodeoffset ||
591b3a88b52SEtienne Carriere 	    candidate->type != elt->type)
592b3a88b52SEtienne Carriere 		return 1;
593b3a88b52SEtienne Carriere 
594b3a88b52SEtienne Carriere 	assert(elt->dt_drv == candidate->dt_drv);
595b3a88b52SEtienne Carriere 	return 0;
596b3a88b52SEtienne Carriere }
597b3a88b52SEtienne Carriere 
598b3a88b52SEtienne Carriere /*
599b3a88b52SEtienne Carriere  * Return TEE_SUCCESS if compatible found
600b3a88b52SEtienne Carriere  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
601b3a88b52SEtienne Carriere  */
602b3a88b52SEtienne Carriere static TEE_Result add_node_to_probe(const void *fdt, int node,
603b3a88b52SEtienne Carriere 				    const struct dt_driver *dt_drv,
604b3a88b52SEtienne Carriere 				    const struct dt_device_match *dm)
605b3a88b52SEtienne Carriere {
606b3a88b52SEtienne Carriere 	const char __maybe_unused *node_name = fdt_get_name(fdt, node, NULL);
607b3a88b52SEtienne Carriere 	const char __maybe_unused *drv_name = dt_drv->name;
608b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
609b3a88b52SEtienne Carriere 	struct dt_driver_probe elt_new = {
610b3a88b52SEtienne Carriere 		.dm = dm,
611b3a88b52SEtienne Carriere 		.dt_drv = dt_drv,
612b3a88b52SEtienne Carriere 		.nodeoffset = node,
613b3a88b52SEtienne Carriere 		.type = dt_drv->type,
614b3a88b52SEtienne Carriere 	};
615b3a88b52SEtienne Carriere 
616b3a88b52SEtienne Carriere 	/* If node/type found in probe list or ready list, nothing to do */
617b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
618b3a88b52SEtienne Carriere 		if (!driver_probe_compare(&elt_new, elt))
619b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
620b3a88b52SEtienne Carriere 
621b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_ready_list, link)
622b3a88b52SEtienne Carriere 		if (!driver_probe_compare(&elt_new, elt))
623b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
624b3a88b52SEtienne Carriere 
625b3a88b52SEtienne Carriere 	elt = malloc(sizeof(*elt));
626b3a88b52SEtienne Carriere 	if (!elt)
627b3a88b52SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
628b3a88b52SEtienne Carriere 
629b3a88b52SEtienne Carriere 	DMSG("element: %s on node %s", node_name, drv_name);
630b3a88b52SEtienne Carriere 
631b3a88b52SEtienne Carriere 	memcpy(elt, &elt_new, sizeof(*elt));
632b3a88b52SEtienne Carriere 
633b3a88b52SEtienne Carriere 	added_node = true;
634b3a88b52SEtienne Carriere 
635b3a88b52SEtienne Carriere 	TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
636b3a88b52SEtienne Carriere 
637b3a88b52SEtienne Carriere 	/* Hack here for TRACE_DEBUG messages on current probe list elements */
638b3a88b52SEtienne Carriere 	if (TRACE_LEVEL >= TRACE_FLOW)
639b3a88b52SEtienne Carriere 		print_probe_list(fdt);
640b3a88b52SEtienne Carriere 
641b3a88b52SEtienne Carriere 	return TEE_SUCCESS;
642b3a88b52SEtienne Carriere }
643b3a88b52SEtienne Carriere 
644b3a88b52SEtienne Carriere /*
645b3a88b52SEtienne Carriere  * Add a node to the probe list if a dt_driver matches target compatible.
646b3a88b52SEtienne Carriere  *
647b3a88b52SEtienne Carriere  * If @type is DT_DRIVER_ANY, probe list can hold only 1 driver to probe for
648b3a88b52SEtienne Carriere  * the node. A node may probe several drivers if have a unique driver type.
649b3a88b52SEtienne Carriere  *
650b3a88b52SEtienne Carriere  * Return TEE_SUCCESS if compatible found
651b3a88b52SEtienne Carriere  *	  TEE_ERROR_ITEM_NOT_FOUND if no matching driver
652b3a88b52SEtienne Carriere  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
653b3a88b52SEtienne Carriere  */
654b3a88b52SEtienne Carriere static TEE_Result add_probe_node_by_compat(const void *fdt, int node,
655b3a88b52SEtienne Carriere 					   const char *compat)
656b3a88b52SEtienne Carriere {
657b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_ITEM_NOT_FOUND;
658b3a88b52SEtienne Carriere 	const struct dt_driver *dt_drv = NULL;
659b3a88b52SEtienne Carriere 	const struct dt_device_match *dm = NULL;
660b3a88b52SEtienne Carriere 	uint32_t found_types = 0;
661b3a88b52SEtienne Carriere 
662b3a88b52SEtienne Carriere 	for_each_dt_driver(dt_drv) {
663b3a88b52SEtienne Carriere 		for (dm = dt_drv->match_table; dm && dm->compatible; dm++) {
664b3a88b52SEtienne Carriere 			if (strcmp(dm->compatible, compat) == 0) {
665b3a88b52SEtienne Carriere 				assert(dt_drv->type < 32);
666b3a88b52SEtienne Carriere 
667b3a88b52SEtienne Carriere 				res = add_node_to_probe(fdt, node, dt_drv, dm);
668b3a88b52SEtienne Carriere 				if (res)
669b3a88b52SEtienne Carriere 					return res;
670b3a88b52SEtienne Carriere 
671b3a88b52SEtienne Carriere 				if (found_types & BIT(dt_drv->type)) {
672b3a88b52SEtienne Carriere 					EMSG("Driver %s multi hit on type %u",
673b3a88b52SEtienne Carriere 					     dt_drv->name, dt_drv->type);
674b3a88b52SEtienne Carriere 					panic();
675b3a88b52SEtienne Carriere 				}
676b3a88b52SEtienne Carriere 				found_types |= BIT(dt_drv->type);
677b3a88b52SEtienne Carriere 
678b3a88b52SEtienne Carriere 				/* Matching found for this driver, try next */
679b3a88b52SEtienne Carriere 				break;
680b3a88b52SEtienne Carriere 			}
681b3a88b52SEtienne Carriere 		}
682b3a88b52SEtienne Carriere 	}
683b3a88b52SEtienne Carriere 
684b3a88b52SEtienne Carriere 	return res;
685b3a88b52SEtienne Carriere }
686b3a88b52SEtienne Carriere 
687b3a88b52SEtienne Carriere /*
688b3a88b52SEtienne Carriere  * Add the node to the probe list if matching compatible drivers are found.
689b3a88b52SEtienne Carriere  * Follow node's compatible property list ordering to find matching driver.
690b3a88b52SEtienne Carriere  */
691b3a88b52SEtienne Carriere TEE_Result dt_driver_maybe_add_probe_node(const void *fdt, int node)
692b3a88b52SEtienne Carriere {
693b3a88b52SEtienne Carriere 	int idx = 0;
694b3a88b52SEtienne Carriere 	int len = 0;
695b3a88b52SEtienne Carriere 	int count = 0;
696b3a88b52SEtienne Carriere 	const char *compat = NULL;
697b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
698b3a88b52SEtienne Carriere 
699f354a5d8SGatien Chevallier 	if (fdt_get_status(fdt, node) == DT_STATUS_DISABLED)
700b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
701b3a88b52SEtienne Carriere 
702b3a88b52SEtienne Carriere 	count = fdt_stringlist_count(fdt, node, "compatible");
703b3a88b52SEtienne Carriere 	if (count < 0)
704b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
705b3a88b52SEtienne Carriere 
706b3a88b52SEtienne Carriere 	for (idx = 0; idx < count; idx++) {
707b3a88b52SEtienne Carriere 		compat = fdt_stringlist_get(fdt, node, "compatible", idx, &len);
708b3a88b52SEtienne Carriere 		assert(compat && len > 0);
709b3a88b52SEtienne Carriere 
710b3a88b52SEtienne Carriere 		res = add_probe_node_by_compat(fdt, node, compat);
711b3a88b52SEtienne Carriere 
712b3a88b52SEtienne Carriere 		/* Stop lookup if something was found */
713b3a88b52SEtienne Carriere 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
714b3a88b52SEtienne Carriere 			return res;
715b3a88b52SEtienne Carriere 	}
716b3a88b52SEtienne Carriere 
717b3a88b52SEtienne Carriere 	return TEE_SUCCESS;
718b3a88b52SEtienne Carriere }
719b3a88b52SEtienne Carriere 
720b3a88b52SEtienne Carriere static void parse_node(const void *fdt, int node)
721b3a88b52SEtienne Carriere {
722b3a88b52SEtienne Carriere 	TEE_Result __maybe_unused res = TEE_ERROR_GENERIC;
723b3a88b52SEtienne Carriere 	int subnode = 0;
724b3a88b52SEtienne Carriere 
725b3a88b52SEtienne Carriere 	fdt_for_each_subnode(subnode, fdt, node) {
726b3a88b52SEtienne Carriere 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
727b3a88b52SEtienne Carriere 		if (res) {
728b3a88b52SEtienne Carriere 			EMSG("Failed on node %s with %#"PRIx32,
729b3a88b52SEtienne Carriere 			     fdt_get_name(fdt, subnode, NULL), res);
730b3a88b52SEtienne Carriere 			panic();
731b3a88b52SEtienne Carriere 		}
732b3a88b52SEtienne Carriere 
733b3a88b52SEtienne Carriere 		/*
734b3a88b52SEtienne Carriere 		 * Rescursively parse the FDT, skipping disabled nodes.
735b3a88b52SEtienne Carriere 		 * FDT is expected reliable and core shall have sufficient
736b3a88b52SEtienne Carriere 		 * stack depth to possibly parse all DT nodes.
737b3a88b52SEtienne Carriere 		 */
738b3a88b52SEtienne Carriere 		if (IS_ENABLED(CFG_DRIVERS_DT_RECURSIVE_PROBE)) {
739f354a5d8SGatien Chevallier 			if (fdt_get_status(fdt, subnode) == DT_STATUS_DISABLED)
740b3a88b52SEtienne Carriere 				continue;
741b3a88b52SEtienne Carriere 
742b3a88b52SEtienne Carriere 			parse_node(fdt, subnode);
743b3a88b52SEtienne Carriere 		}
744b3a88b52SEtienne Carriere 	}
745b3a88b52SEtienne Carriere }
746b3a88b52SEtienne Carriere 
747b3a88b52SEtienne Carriere /*
748b3a88b52SEtienne Carriere  * Parse FDT for nodes and save in probe list the node for which a dt_driver
749b3a88b52SEtienne Carriere  * matches node's compatible property.
750b3a88b52SEtienne Carriere  */
751c9bd3375SEtienne Carriere static TEE_Result probe_dt_drivers_early(void)
752b3a88b52SEtienne Carriere {
753c9bd3375SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
754b3a88b52SEtienne Carriere 	const void *fdt = NULL;
755b3a88b52SEtienne Carriere 
756d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
757d2289450SVesa Jääskeläinen 	if (!fdt)
758b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
759b3a88b52SEtienne Carriere 
760b3a88b52SEtienne Carriere 	parse_node(fdt, fdt_path_offset(fdt, "/"));
761b3a88b52SEtienne Carriere 
762c9bd3375SEtienne Carriere 	res = process_probe_list(fdt);
763c9bd3375SEtienne Carriere 	if (res == TEE_ERROR_DEFER_DRIVER_INIT) {
764c9bd3375SEtienne Carriere 		DMSG("Deferred drivers probing");
765c9bd3375SEtienne Carriere 		print_probe_list(fdt);
766c9bd3375SEtienne Carriere 		res = TEE_SUCCESS;
767b3a88b52SEtienne Carriere 	}
768b3a88b52SEtienne Carriere 
769c9bd3375SEtienne Carriere 	return res;
770c9bd3375SEtienne Carriere }
771c9bd3375SEtienne Carriere 
772c9bd3375SEtienne Carriere static TEE_Result probe_dt_drivers(void)
773c9bd3375SEtienne Carriere {
774c9bd3375SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
775c9bd3375SEtienne Carriere 	const void *fdt = NULL;
776c9bd3375SEtienne Carriere 
777d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
778d2289450SVesa Jääskeläinen 	if (!fdt)
779c9bd3375SEtienne Carriere 		return TEE_SUCCESS;
780c9bd3375SEtienne Carriere 
781c9bd3375SEtienne Carriere 	res = process_probe_list(fdt);
782c9bd3375SEtienne Carriere 	if (res || !TAILQ_EMPTY(&dt_driver_failed_list)) {
783c9bd3375SEtienne Carriere 		EMSG("Probe sequence result: %#"PRIx32, res);
784c9bd3375SEtienne Carriere 		print_probe_list(fdt);
785c9bd3375SEtienne Carriere 	}
786c9bd3375SEtienne Carriere 	if (res)
787c9bd3375SEtienne Carriere 		panic();
788c9bd3375SEtienne Carriere 
789c9bd3375SEtienne Carriere 	return TEE_SUCCESS;
790c9bd3375SEtienne Carriere }
791c9bd3375SEtienne Carriere 
792c9bd3375SEtienne Carriere early_init_late(probe_dt_drivers_early);
793b3a88b52SEtienne Carriere driver_init(probe_dt_drivers);
794ea29d587SEtienne Carriere 
795f21b3ed5SEtienne Carriere static TEE_Result release_probe_lists(void)
796f21b3ed5SEtienne Carriere {
797f21b3ed5SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
798f21b3ed5SEtienne Carriere 	struct dt_driver_probe *next = NULL;
799115944b5SEtienne Carriere 	struct dt_driver_provider *prov = NULL;
800115944b5SEtienne Carriere 	struct dt_driver_provider *next_prov = NULL;
801d2289450SVesa Jääskeläinen 	const void *fdt = NULL;
802f21b3ed5SEtienne Carriere 
803d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
804d2289450SVesa Jääskeläinen 	if (!fdt)
805f21b3ed5SEtienne Carriere 		return TEE_SUCCESS;
806f21b3ed5SEtienne Carriere 
807f21b3ed5SEtienne Carriere 	assert(fdt && TAILQ_EMPTY(&dt_driver_probe_list));
808f21b3ed5SEtienne Carriere 
809115944b5SEtienne Carriere 	TAILQ_FOREACH_SAFE(elt, &dt_driver_ready_list, link, next)
810f21b3ed5SEtienne Carriere 		free(elt);
811115944b5SEtienne Carriere 
812736cb9e1SEtienne Carriere 	TAILQ_FOREACH_SAFE(elt, &dt_driver_failed_list, link, next)
813736cb9e1SEtienne Carriere 	       free(elt);
814736cb9e1SEtienne Carriere 
815115944b5SEtienne Carriere 	SLIST_FOREACH_SAFE(prov, &dt_driver_provider_list, link, next_prov)
816115944b5SEtienne Carriere 	       free(prov);
817f21b3ed5SEtienne Carriere 
818f21b3ed5SEtienne Carriere 	return TEE_SUCCESS;
819f21b3ed5SEtienne Carriere }
820f21b3ed5SEtienne Carriere 
821f21b3ed5SEtienne Carriere release_init_resource(release_probe_lists);
822f21b3ed5SEtienne Carriere 
823ea29d587SEtienne Carriere /*
824ea29d587SEtienne Carriere  * Simple bus support: handy to parse subnodes
825ea29d587SEtienne Carriere  */
826ea29d587SEtienne Carriere static TEE_Result simple_bus_probe(const void *fdt, int node,
827ea29d587SEtienne Carriere 				   const void *compat_data __unused)
828ea29d587SEtienne Carriere {
829ea29d587SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
830ea29d587SEtienne Carriere 	int subnode = 0;
831ea29d587SEtienne Carriere 
832ea29d587SEtienne Carriere 	fdt_for_each_subnode(subnode, fdt, node) {
833ea29d587SEtienne Carriere 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
834ea29d587SEtienne Carriere 		if (res) {
835ea29d587SEtienne Carriere 			EMSG("Failed on node %s with %#"PRIx32,
836ea29d587SEtienne Carriere 			     fdt_get_name(fdt, subnode, NULL), res);
837ea29d587SEtienne Carriere 			panic();
838ea29d587SEtienne Carriere 		}
839ea29d587SEtienne Carriere 	}
840ea29d587SEtienne Carriere 
841ea29d587SEtienne Carriere 	return TEE_SUCCESS;
842ea29d587SEtienne Carriere }
843ea29d587SEtienne Carriere 
844ea29d587SEtienne Carriere static const struct dt_device_match simple_bus_match_table[] = {
845ea29d587SEtienne Carriere 	{ .compatible = "simple-bus" },
846ea29d587SEtienne Carriere 	{ }
847ea29d587SEtienne Carriere };
848ea29d587SEtienne Carriere 
84961bdedeaSJerome Forissier DEFINE_DT_DRIVER(simple_bus_dt_driver) = {
850ea29d587SEtienne Carriere 	.name = "simple-bus",
851ea29d587SEtienne Carriere 	.match_table = simple_bus_match_table,
852ea29d587SEtienne Carriere 	.probe = simple_bus_probe,
853ea29d587SEtienne Carriere };
854