xref: /optee_os/core/kernel/dt_driver.c (revision c9c53de1811fe1360246789bc5f60f16f68d0e23)
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:
112ed33eb2eSEtienne Carriere 	case DT_DRIVER_INTERRUPT:
113193944aaSEtienne Carriere 	case DT_DRIVER_REGULATOR:
114b3a88b52SEtienne Carriere 		return;
115b3a88b52SEtienne Carriere 	default:
116b3a88b52SEtienne Carriere 		assert(0);
117b3a88b52SEtienne Carriere 	}
118b3a88b52SEtienne Carriere }
119b3a88b52SEtienne Carriere 
1203fd340e5SEtienne Carriere /*
1213fd340e5SEtienne Carriere  * Driver provider registering API functions
1223fd340e5SEtienne Carriere  */
1233fd340e5SEtienne Carriere 
1243fd340e5SEtienne Carriere TEE_Result dt_driver_register_provider(const void *fdt, int nodeoffset,
1253fd340e5SEtienne Carriere 				       get_of_device_func get_of_device,
1263fd340e5SEtienne Carriere 				       void *priv, enum dt_driver_type type)
1273fd340e5SEtienne Carriere {
1283fd340e5SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
1293fd340e5SEtienne Carriere 	int provider_cells = 0;
1303fd340e5SEtienne Carriere 	uint32_t phandle = 0;
1313fd340e5SEtienne Carriere 
132b3a88b52SEtienne Carriere 	assert_type_is_valid(type);
133b3a88b52SEtienne Carriere 
1343fd340e5SEtienne Carriere 	provider_cells = fdt_get_dt_driver_cells(fdt, nodeoffset, type);
1353fd340e5SEtienne Carriere 	if (provider_cells < 0) {
1363fd340e5SEtienne Carriere 		DMSG("Failed to find provider cells: %d", provider_cells);
1373fd340e5SEtienne Carriere 		return TEE_ERROR_GENERIC;
1383fd340e5SEtienne Carriere 	}
1393fd340e5SEtienne Carriere 
1403fd340e5SEtienne Carriere 	phandle = fdt_get_phandle(fdt, nodeoffset);
1410f9f9a37SGatien Chevallier 	if (phandle == (uint32_t)-1) {
1423fd340e5SEtienne Carriere 		DMSG("Failed to find provide phandle");
1433fd340e5SEtienne Carriere 		return TEE_ERROR_GENERIC;
1443fd340e5SEtienne Carriere 	}
1453fd340e5SEtienne Carriere 
1463fd340e5SEtienne Carriere 	prv = calloc(1, sizeof(*prv));
1473fd340e5SEtienne Carriere 	if (!prv)
1483fd340e5SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
1493fd340e5SEtienne Carriere 
1503fd340e5SEtienne Carriere 	prv->nodeoffset = nodeoffset;
1513fd340e5SEtienne Carriere 	prv->type = type;
1523fd340e5SEtienne Carriere 	prv->provider_cells = provider_cells;
1533fd340e5SEtienne Carriere 	prv->phandle = phandle;
1543fd340e5SEtienne Carriere 	prv->get_of_device = get_of_device;
1553fd340e5SEtienne Carriere 	prv->priv_data = priv;
1563fd340e5SEtienne Carriere 
1573fd340e5SEtienne Carriere 	SLIST_INSERT_HEAD(&dt_driver_provider_list, prv, link);
1583fd340e5SEtienne Carriere 
1593fd340e5SEtienne Carriere 	return TEE_SUCCESS;
1603fd340e5SEtienne Carriere }
1613fd340e5SEtienne Carriere 
162b5aff6deSClément Léger static bool dt_driver_use_parent_controller(enum dt_driver_type type)
163b5aff6deSClément Léger {
164b5aff6deSClément Léger 	switch (type) {
165b5aff6deSClément Léger 	case DT_DRIVER_PINCTRL:
166b5aff6deSClément Léger 		return true;
167b5aff6deSClément Léger 	default:
168b5aff6deSClément Léger 		return false;
169b5aff6deSClément Léger 	}
170b5aff6deSClément Léger }
171b5aff6deSClément Léger 
1723fd340e5SEtienne Carriere /*
1733fd340e5SEtienne Carriere  * Helper functions for dt_drivers querying driver provider information
1743fd340e5SEtienne Carriere  */
1753fd340e5SEtienne Carriere 
1763fd340e5SEtienne Carriere int fdt_get_dt_driver_cells(const void *fdt, int nodeoffset,
1773fd340e5SEtienne Carriere 			    enum dt_driver_type type)
1783fd340e5SEtienne Carriere {
1793fd340e5SEtienne Carriere 	const char *cells_name = NULL;
1803fd340e5SEtienne Carriere 	const fdt32_t *c = NULL;
1813fd340e5SEtienne Carriere 	int len = 0;
1823fd340e5SEtienne Carriere 
183b5aff6deSClément Léger 	if (dt_driver_use_parent_controller(type))
184b5aff6deSClément Léger 		return 0;
185b5aff6deSClément Léger 
1863fd340e5SEtienne Carriere 	switch (type) {
1873fd340e5SEtienne Carriere 	case DT_DRIVER_CLK:
1883fd340e5SEtienne Carriere 		cells_name = "#clock-cells";
1893fd340e5SEtienne Carriere 		break;
190ed33eb2eSEtienne Carriere 	case DT_DRIVER_INTERRUPT:
191ed33eb2eSEtienne Carriere 		cells_name = "#interrupt-cells";
192ed33eb2eSEtienne Carriere 		break;
193c78b2c66SEtienne Carriere 	case DT_DRIVER_RSTCTRL:
194c78b2c66SEtienne Carriere 		cells_name = "#reset-cells";
195c78b2c66SEtienne Carriere 		break;
1964fc179b6SThomas Perrot 	case DT_DRIVER_GPIO:
1974fc179b6SThomas Perrot 		cells_name = "#gpio-cells";
1984fc179b6SThomas Perrot 		break;
199e7a2db34SClément Léger 	case DT_DRIVER_I2C:
200193944aaSEtienne Carriere 	case DT_DRIVER_REGULATOR:
201e7a2db34SClément Léger 		return 0;
2023fd340e5SEtienne Carriere 	default:
2033fd340e5SEtienne Carriere 		panic();
2043fd340e5SEtienne Carriere 	}
2053fd340e5SEtienne Carriere 
2063fd340e5SEtienne Carriere 	c = fdt_getprop(fdt, nodeoffset, cells_name, &len);
2073fd340e5SEtienne Carriere 	if (!c)
2083fd340e5SEtienne Carriere 		return len;
2093fd340e5SEtienne Carriere 
2103fd340e5SEtienne Carriere 	if (len != sizeof(*c))
2113fd340e5SEtienne Carriere 		return -FDT_ERR_BADNCELLS;
2123fd340e5SEtienne Carriere 
2133fd340e5SEtienne Carriere 	return fdt32_to_cpu(*c);
2143fd340e5SEtienne Carriere }
2153fd340e5SEtienne Carriere 
2163fd340e5SEtienne Carriere unsigned int dt_driver_provider_cells(struct dt_driver_provider *prv)
2173fd340e5SEtienne Carriere {
2183fd340e5SEtienne Carriere 	return prv->provider_cells;
2193fd340e5SEtienne Carriere }
220f498c404SEtienne Carriere 
221*c9c53de1SEtienne Carriere void *dt_driver_provider_priv_data(struct dt_driver_provider *prv)
222*c9c53de1SEtienne Carriere {
223*c9c53de1SEtienne Carriere 	return prv->priv_data;
224*c9c53de1SEtienne Carriere }
225*c9c53de1SEtienne Carriere 
2268dca59b4SEtienne Carriere struct dt_driver_provider *
2278dca59b4SEtienne Carriere dt_driver_get_provider_by_node(int nodeoffset, enum dt_driver_type type)
228f498c404SEtienne Carriere {
229f498c404SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
230f498c404SEtienne Carriere 
231f498c404SEtienne Carriere 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
2328dca59b4SEtienne Carriere 		if (prv->nodeoffset == nodeoffset && prv->type == type)
233f498c404SEtienne Carriere 			return prv;
234f498c404SEtienne Carriere 
235f498c404SEtienne Carriere 	return NULL;
236f498c404SEtienne Carriere }
237f498c404SEtienne Carriere 
2388dca59b4SEtienne Carriere struct dt_driver_provider *
2398dca59b4SEtienne Carriere dt_driver_get_provider_by_phandle(uint32_t phandle, enum dt_driver_type type)
240f498c404SEtienne Carriere {
241f498c404SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
242f498c404SEtienne Carriere 
243f498c404SEtienne Carriere 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
2448dca59b4SEtienne Carriere 		if (prv->phandle == phandle && prv->type == type)
245f498c404SEtienne Carriere 			return prv;
246f498c404SEtienne Carriere 
247f498c404SEtienne Carriere 	return NULL;
248f498c404SEtienne Carriere }
249a22e85b2SEtienne Carriere 
250b357d34fSEtienne Carriere static TEE_Result device_from_provider_prop(struct dt_driver_provider *prv,
25133cc94dfSClément Léger 					    const void *fdt, int phandle_node,
252b357d34fSEtienne Carriere 					    const uint32_t *prop, void **device)
253a22e85b2SEtienne Carriere {
254b357d34fSEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
2558fd620f7SEtienne Carriere 	struct dt_pargs *pargs = NULL;
256a22e85b2SEtienne Carriere 	unsigned int n = 0;
257a22e85b2SEtienne Carriere 
258a22e85b2SEtienne Carriere 	pargs = calloc(1, prv->provider_cells * sizeof(uint32_t *) +
259a22e85b2SEtienne Carriere 		       sizeof(*pargs));
260b357d34fSEtienne Carriere 	if (!pargs)
261b357d34fSEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
262a22e85b2SEtienne Carriere 
26333cc94dfSClément Léger 	pargs->fdt = fdt;
26433cc94dfSClément Léger 	pargs->phandle_node = phandle_node;
265a22e85b2SEtienne Carriere 	pargs->args_count = prv->provider_cells;
266a22e85b2SEtienne Carriere 	for (n = 0; n < prv->provider_cells; n++)
267a22e85b2SEtienne Carriere 		pargs->args[n] = fdt32_to_cpu(prop[n + 1]);
268a22e85b2SEtienne Carriere 
269b357d34fSEtienne Carriere 	res = prv->get_of_device(pargs, prv->priv_data, device);
270a22e85b2SEtienne Carriere 
271a22e85b2SEtienne Carriere 	free(pargs);
272a22e85b2SEtienne Carriere 
273b357d34fSEtienne Carriere 	return res;
274a22e85b2SEtienne Carriere }
275a22e85b2SEtienne Carriere 
276b357d34fSEtienne Carriere TEE_Result dt_driver_device_from_parent(const void *fdt, int nodeoffset,
277b357d34fSEtienne Carriere 					enum dt_driver_type type, void **device)
278e7a2db34SClément Léger {
279e7a2db34SClément Léger 	int parent = -1;
280e7a2db34SClément Léger 	struct dt_driver_provider *prv = NULL;
281e7a2db34SClément Léger 
282e7a2db34SClément Léger 	assert(fdt == get_secure_dt());
283e7a2db34SClément Léger 
284e7a2db34SClément Léger 	parent = fdt_parent_offset(fdt, nodeoffset);
285b357d34fSEtienne Carriere 	if (parent < 0)
286b357d34fSEtienne Carriere 		return TEE_ERROR_GENERIC;
287e7a2db34SClément Léger 
288e7a2db34SClément Léger 	prv = dt_driver_get_provider_by_node(parent, type);
289e7a2db34SClément Léger 	if (!prv) {
290e7a2db34SClément Léger 		/* No provider registered yet */
291b357d34fSEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
292e7a2db34SClément Léger 	}
293e7a2db34SClément Léger 
294b357d34fSEtienne Carriere 	return device_from_provider_prop(prv, fdt, nodeoffset, NULL, device);
295e7a2db34SClément Léger }
296e7a2db34SClément Léger 
297b357d34fSEtienne Carriere TEE_Result dt_driver_device_from_node_idx_prop_phandle(const char *prop_name,
298b357d34fSEtienne Carriere 						       const void *fdt,
299b357d34fSEtienne Carriere 						       int nodeoffs,
30050dd2af0SEtienne Carriere 						       unsigned int prop_index,
30150dd2af0SEtienne Carriere 						       enum dt_driver_type type,
30250dd2af0SEtienne Carriere 						       uint32_t phandle,
303b357d34fSEtienne Carriere 						       void **device)
30450dd2af0SEtienne Carriere {
30550dd2af0SEtienne Carriere 	int len = 0;
30650dd2af0SEtienne Carriere 	const uint32_t *prop = NULL;
30750dd2af0SEtienne Carriere 	int phandle_node_unused = -1;
30850dd2af0SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
30950dd2af0SEtienne Carriere 
31050dd2af0SEtienne Carriere 	prop = fdt_getprop(fdt, nodeoffs, prop_name, &len);
31150dd2af0SEtienne Carriere 	if (!prop) {
31250dd2af0SEtienne Carriere 		if (len != -FDT_ERR_NOTFOUND) {
31350dd2af0SEtienne Carriere 			DMSG("Corrupted node %s", prop_name);
314b357d34fSEtienne Carriere 			return TEE_ERROR_GENERIC;
31550dd2af0SEtienne Carriere 		} else {
31650dd2af0SEtienne Carriere 			DMSG("Property %s missing in node %s", prop_name,
31750dd2af0SEtienne Carriere 			     fdt_get_name(fdt, nodeoffs, NULL));
318b357d34fSEtienne Carriere 			return TEE_ERROR_ITEM_NOT_FOUND;
31950dd2af0SEtienne Carriere 		}
32050dd2af0SEtienne Carriere 	}
32150dd2af0SEtienne Carriere 
32250dd2af0SEtienne Carriere 	prv = dt_driver_get_provider_by_phandle(phandle, type);
323b357d34fSEtienne Carriere 	if (!prv)
324b357d34fSEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
32550dd2af0SEtienne Carriere 
32650dd2af0SEtienne Carriere 	prop_index *= dt_driver_provider_cells(prv);
327b357d34fSEtienne Carriere 	if ((prop_index + 1) * sizeof(*prop) > (size_t)len)
328b357d34fSEtienne Carriere 		return TEE_ERROR_ITEM_NOT_FOUND;
32950dd2af0SEtienne Carriere 
33050dd2af0SEtienne Carriere 	return device_from_provider_prop(prv, fdt, phandle_node_unused,
331b357d34fSEtienne Carriere 					 prop + prop_index, device);
33250dd2af0SEtienne Carriere }
33350dd2af0SEtienne Carriere 
334b357d34fSEtienne Carriere TEE_Result dt_driver_device_from_node_idx_prop(const char *prop_name,
335a22e85b2SEtienne Carriere 					       const void *fdt, int nodeoffset,
336d8b14b46SEtienne Carriere 					       unsigned int prop_idx,
3378dca59b4SEtienne Carriere 					       enum dt_driver_type type,
338b357d34fSEtienne Carriere 					       void **device)
339a22e85b2SEtienne Carriere {
340a22e85b2SEtienne Carriere 	int len = 0;
341a22e85b2SEtienne Carriere 	int idx = 0;
342a22e85b2SEtienne Carriere 	int idx32 = 0;
343a22e85b2SEtienne Carriere 	int prv_cells = 0;
34433cc94dfSClément Léger 	int phandle_node = -1;
345a22e85b2SEtienne Carriere 	uint32_t phandle = 0;
346a22e85b2SEtienne Carriere 	const uint32_t *prop = NULL;
347a22e85b2SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
348a22e85b2SEtienne Carriere 
349a22e85b2SEtienne Carriere 	prop = fdt_getprop(fdt, nodeoffset, prop_name, &len);
350d8b14b46SEtienne Carriere 	if (!prop) {
351b17cf5c8SEtienne Carriere 		DMSG("Property %s missing in node %s", prop_name,
352b17cf5c8SEtienne Carriere 		     fdt_get_name(fdt, nodeoffset, NULL));
353b357d34fSEtienne Carriere 		return TEE_ERROR_ITEM_NOT_FOUND;
354d8b14b46SEtienne Carriere 	}
355a22e85b2SEtienne Carriere 
356a22e85b2SEtienne Carriere 	while (idx < len) {
357a22e85b2SEtienne Carriere 		idx32 = idx / sizeof(uint32_t);
358a22e85b2SEtienne Carriere 		phandle = fdt32_to_cpu(prop[idx32]);
359f1f7c58eSClément Léger 		if (!phandle) {
360f1f7c58eSClément Léger 			if (!prop_idx)
361f1f7c58eSClément Léger 				break;
362f1f7c58eSClément Léger 			idx += sizeof(phandle);
363f1f7c58eSClément Léger 			prop_idx--;
364f1f7c58eSClément Léger 			continue;
365f1f7c58eSClément Léger 		}
366a22e85b2SEtienne Carriere 
367b5aff6deSClément Léger 		/*
368b5aff6deSClément Léger 		 * In some cases, pinctrl, i2c, nvmem, etc, the consumer phandle
369b5aff6deSClément Léger 		 * points directly to a subnode of the parent. In such cases,
370b5aff6deSClément Léger 		 * the provider does not have any "-cells" property and
371b5aff6deSClément Léger 		 * potentially no "phandle" property.
372b5aff6deSClément Léger 		 */
373b5aff6deSClément Léger 		if (dt_driver_use_parent_controller(type)) {
374b5aff6deSClément Léger 			phandle_node = fdt_node_offset_by_phandle(fdt, phandle);
375b357d34fSEtienne Carriere 			if (phandle_node < 0)
376b357d34fSEtienne Carriere 				return TEE_ERROR_GENERIC;
377b5aff6deSClément Léger 
378b5aff6deSClément Léger 			nodeoffset = fdt_parent_offset(fdt, phandle_node);
379b357d34fSEtienne Carriere 			if (nodeoffset < 0)
380b357d34fSEtienne Carriere 				return TEE_ERROR_GENERIC;
381b5aff6deSClément Léger 
382b5aff6deSClément Léger 			prv = dt_driver_get_provider_by_node(nodeoffset, type);
383b357d34fSEtienne Carriere 			if (!prv)
384b357d34fSEtienne Carriere 				return TEE_ERROR_DEFER_DRIVER_INIT;
385b5aff6deSClément Léger 		} else {
3868dca59b4SEtienne Carriere 			prv = dt_driver_get_provider_by_phandle(phandle, type);
387b357d34fSEtienne Carriere 			if (!prv)
388b357d34fSEtienne Carriere 				return TEE_ERROR_DEFER_DRIVER_INIT;
389b5aff6deSClément Léger 		}
390a22e85b2SEtienne Carriere 
391a22e85b2SEtienne Carriere 		prv_cells = dt_driver_provider_cells(prv);
392a22e85b2SEtienne Carriere 		if (prop_idx) {
393a22e85b2SEtienne Carriere 			prop_idx--;
394a22e85b2SEtienne Carriere 			idx += sizeof(phandle) + prv_cells * sizeof(uint32_t);
395a22e85b2SEtienne Carriere 			continue;
396a22e85b2SEtienne Carriere 		}
397a22e85b2SEtienne Carriere 
39833cc94dfSClément Léger 		return device_from_provider_prop(prv, fdt, phandle_node,
399b357d34fSEtienne Carriere 						 prop + idx32, device);
400a22e85b2SEtienne Carriere 	}
401a22e85b2SEtienne Carriere 
402b357d34fSEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
403a22e85b2SEtienne Carriere }
404ef20efc4SEtienne Carriere 
405c9bd3375SEtienne Carriere static void __maybe_unused print_probe_list(const void *fdt __maybe_unused)
406b3a88b52SEtienne Carriere {
407b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
408b3a88b52SEtienne Carriere 	unsigned int count = 0;
409b3a88b52SEtienne Carriere 
410b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
411b3a88b52SEtienne Carriere 		count++;
412b3a88b52SEtienne Carriere 
413c9bd3375SEtienne Carriere 	DMSG("Probe list: %u elements", count);
414b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
415c9bd3375SEtienne Carriere 		DMSG("|- Driver %s probes on node %s",
416b3a88b52SEtienne Carriere 		     elt->dt_drv->name,
417b3a88b52SEtienne Carriere 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
418b3a88b52SEtienne Carriere 
419c9bd3375SEtienne Carriere 	DMSG("`- Probe list end");
420c9bd3375SEtienne Carriere 
421c9bd3375SEtienne Carriere 	count = 0;
422c9bd3375SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
423c9bd3375SEtienne Carriere 		count++;
424c9bd3375SEtienne Carriere 
425c9bd3375SEtienne Carriere 	DMSG("Failed list: %u elements", count);
426c9bd3375SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
427c9bd3375SEtienne Carriere 		EMSG("|- Driver %s on node %s failed", elt->dt_drv->name,
428c9bd3375SEtienne Carriere 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
429c9bd3375SEtienne Carriere 
430c9bd3375SEtienne Carriere 	DMSG("`- Failed list end");
431b3a88b52SEtienne Carriere }
432b3a88b52SEtienne Carriere 
433b3a88b52SEtienne Carriere /*
434b3a88b52SEtienne Carriere  * Probe element: push to ready list if succeeds, push to probe list if probe
435b3a88b52SEtienne Carriere  * if deferred, panic with an error trace otherwise.
436b3a88b52SEtienne Carriere  */
437b3a88b52SEtienne Carriere static TEE_Result probe_driver_node(const void *fdt,
438b3a88b52SEtienne Carriere 				    struct dt_driver_probe *elt)
439b3a88b52SEtienne Carriere {
440b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
441b3a88b52SEtienne Carriere 	const char __maybe_unused *drv_name = NULL;
442b3a88b52SEtienne Carriere 	const char __maybe_unused *node_name = NULL;
443b3a88b52SEtienne Carriere 
444b3a88b52SEtienne Carriere 	node_name = fdt_get_name(fdt, elt->nodeoffset, NULL);
445b3a88b52SEtienne Carriere 	drv_name = elt->dt_drv->name;
446c4c84e2cSSahil Malhotra 
447c4c84e2cSSahil Malhotra 	if (!elt->dt_drv->probe) {
448c4c84e2cSSahil Malhotra 		DMSG("No probe operator for driver %s, skipped", drv_name);
449c4c84e2cSSahil Malhotra 		return TEE_SUCCESS;
450c4c84e2cSSahil Malhotra 	}
451c4c84e2cSSahil Malhotra 
452b3a88b52SEtienne Carriere 	FMSG("Probing %s on node %s", drv_name, node_name);
453b3a88b52SEtienne Carriere 
454b3a88b52SEtienne Carriere 	res = elt->dt_drv->probe(fdt, elt->nodeoffset, elt->dm->compat_data);
455b3a88b52SEtienne Carriere 	switch (res) {
456b3a88b52SEtienne Carriere 	case TEE_SUCCESS:
457b3a88b52SEtienne Carriere 		TAILQ_INSERT_HEAD(&dt_driver_ready_list, elt, link);
458b3a88b52SEtienne Carriere 
459b3a88b52SEtienne Carriere 		DMSG("element: %s on node %s initialized", drv_name, node_name);
460b3a88b52SEtienne Carriere 		break;
461b3a88b52SEtienne Carriere 	case TEE_ERROR_DEFER_DRIVER_INIT:
462b3a88b52SEtienne Carriere 		elt->deferrals++;
463b3a88b52SEtienne Carriere 		TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
464b3a88b52SEtienne Carriere 
465b3a88b52SEtienne Carriere 		DMSG("element: %s on node %s deferred %u time(s)", drv_name,
466b3a88b52SEtienne Carriere 		     node_name, elt->deferrals);
467b3a88b52SEtienne Carriere 		break;
46852199c35SVesa Jääskeläinen 	case TEE_ERROR_NODE_DISABLED:
46952199c35SVesa Jääskeläinen 		DMSG("element: %s on node %s is disabled", drv_name, node_name);
47052199c35SVesa Jääskeläinen 		break;
471b3a88b52SEtienne Carriere 	default:
472736cb9e1SEtienne Carriere 		TAILQ_INSERT_HEAD(&dt_driver_failed_list, elt, link);
473736cb9e1SEtienne Carriere 
474736cb9e1SEtienne Carriere 		EMSG("Failed to probe %s on node %s: %#"PRIx32,
475b3a88b52SEtienne Carriere 		     drv_name, node_name, res);
476736cb9e1SEtienne Carriere 		break;
477b3a88b52SEtienne Carriere 	}
478b3a88b52SEtienne Carriere 
479b3a88b52SEtienne Carriere 	return res;
480b3a88b52SEtienne Carriere }
481b3a88b52SEtienne Carriere 
482b3a88b52SEtienne Carriere static TEE_Result alloc_elt_and_probe(const void *fdt, int node,
483b3a88b52SEtienne Carriere 				      const struct dt_driver *dt_drv,
484b3a88b52SEtienne Carriere 				      const struct dt_device_match *dm)
485b3a88b52SEtienne Carriere {
486b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
487b3a88b52SEtienne Carriere 
488b3a88b52SEtienne Carriere 	/* Will be freed when lists are released */
489b3a88b52SEtienne Carriere 	elt = calloc(1, sizeof(*elt));
490b3a88b52SEtienne Carriere 	if (!elt)
491b3a88b52SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
492b3a88b52SEtienne Carriere 
493b3a88b52SEtienne Carriere 	elt->nodeoffset = node;
494b3a88b52SEtienne Carriere 	elt->dt_drv = dt_drv;
495b3a88b52SEtienne Carriere 	elt->dm = dm;
496b3a88b52SEtienne Carriere 	elt->type = dt_drv->type;
497b3a88b52SEtienne Carriere 
498b3a88b52SEtienne Carriere 	return probe_driver_node(fdt, elt);
499b3a88b52SEtienne Carriere }
500b3a88b52SEtienne Carriere 
501ef20efc4SEtienne Carriere /* Lookup a compatible driver, possibly of a specific @type, for the FDT node */
502ef20efc4SEtienne Carriere static TEE_Result probe_device_by_compat(const void *fdt, int node,
503ef20efc4SEtienne Carriere 					 const char *compat,
504ef20efc4SEtienne Carriere 					 enum dt_driver_type type)
505ef20efc4SEtienne Carriere {
506ef20efc4SEtienne Carriere 	const struct dt_driver *drv = NULL;
507ef20efc4SEtienne Carriere 	const struct dt_device_match *dm = NULL;
508ef20efc4SEtienne Carriere 
509ef20efc4SEtienne Carriere 	for_each_dt_driver(drv) {
510ef20efc4SEtienne Carriere 		if (drv->type != type)
511ef20efc4SEtienne Carriere 			continue;
512ef20efc4SEtienne Carriere 
513ef20efc4SEtienne Carriere 		for (dm = drv->match_table; dm && dm->compatible; dm++)
514ef20efc4SEtienne Carriere 			if (strcmp(dm->compatible, compat) == 0)
515b3a88b52SEtienne Carriere 				return alloc_elt_and_probe(fdt, node, drv, dm);
516ef20efc4SEtienne Carriere 	}
517ef20efc4SEtienne Carriere 
518ef20efc4SEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
519ef20efc4SEtienne Carriere }
520ef20efc4SEtienne Carriere 
521b3a88b52SEtienne Carriere /*
522b3a88b52SEtienne Carriere  * Lookup the best matching compatible driver, possibly of a specific @type,
523b3a88b52SEtienne Carriere  * for the FDT node.
524b3a88b52SEtienne Carriere  */
525ef20efc4SEtienne Carriere TEE_Result dt_driver_probe_device_by_node(const void *fdt, int nodeoffset,
526ef20efc4SEtienne Carriere 					  enum dt_driver_type type)
527ef20efc4SEtienne Carriere {
528ef20efc4SEtienne Carriere 	int idx = 0;
529ef20efc4SEtienne Carriere 	int len = 0;
530ef20efc4SEtienne Carriere 	int count = 0;
531ef20efc4SEtienne Carriere 	const char *compat = NULL;
532ef20efc4SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
533ef20efc4SEtienne Carriere 
534b3a88b52SEtienne Carriere 	assert_type_is_valid(type);
535b3a88b52SEtienne Carriere 
536ef20efc4SEtienne Carriere 	count = fdt_stringlist_count(fdt, nodeoffset, "compatible");
537ef20efc4SEtienne Carriere 	if (count < 0)
538ef20efc4SEtienne Carriere 		return TEE_ERROR_ITEM_NOT_FOUND;
539ef20efc4SEtienne Carriere 
540ef20efc4SEtienne Carriere 	for (idx = 0; idx < count; idx++) {
541ef20efc4SEtienne Carriere 		compat = fdt_stringlist_get(fdt, nodeoffset, "compatible",
542ef20efc4SEtienne Carriere 					    idx, &len);
543ef20efc4SEtienne Carriere 		if (!compat)
544ef20efc4SEtienne Carriere 			return TEE_ERROR_GENERIC;
545ef20efc4SEtienne Carriere 
546ef20efc4SEtienne Carriere 		res = probe_device_by_compat(fdt, nodeoffset, compat, type);
547ef20efc4SEtienne Carriere 
548ef20efc4SEtienne Carriere 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
549ef20efc4SEtienne Carriere 			return res;
550ef20efc4SEtienne Carriere 	}
551ef20efc4SEtienne Carriere 
552ef20efc4SEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
553ef20efc4SEtienne Carriere }
554b3a88b52SEtienne Carriere 
555b3a88b52SEtienne Carriere static TEE_Result process_probe_list(const void *fdt)
556b3a88b52SEtienne Carriere {
557b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
558b3a88b52SEtienne Carriere 	struct dt_driver_probe *prev = NULL;
559c9bd3375SEtienne Carriere 	static unsigned int __maybe_unused loop_count;
560c9bd3375SEtienne Carriere 	static unsigned int __maybe_unused deferral_loop_count;
561b3a88b52SEtienne Carriere 	bool __maybe_unused one_deferred = false;
562b3a88b52SEtienne Carriere 	bool one_probed_ok = false;
563b3a88b52SEtienne Carriere 
564b3a88b52SEtienne Carriere 	do {
565b3a88b52SEtienne Carriere 		loop_count++;
566b3a88b52SEtienne Carriere 		FMSG("Probe loop %u after %u for deferral(s)", loop_count,
567b3a88b52SEtienne Carriere 		     deferral_loop_count);
568b3a88b52SEtienne Carriere 
569b3a88b52SEtienne Carriere 		/* Hack here for TRACE_DEBUG messages on probe list elements */
570b3a88b52SEtienne Carriere 		if (TRACE_LEVEL >= TRACE_FLOW)
571b3a88b52SEtienne Carriere 			print_probe_list(fdt);
572b3a88b52SEtienne Carriere 
573b3a88b52SEtienne Carriere 		if (TAILQ_EMPTY(&dt_driver_probe_list))
574b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
575b3a88b52SEtienne Carriere 
576b3a88b52SEtienne Carriere 		/*
577b3a88b52SEtienne Carriere 		 * Probe from current end to top. Deferred probed node are
578b3a88b52SEtienne Carriere 		 * pushed back after current tail for the next probe round.
579b3a88b52SEtienne Carriere 		 * Reset probe result flags and see status after probe round.
580b3a88b52SEtienne Carriere 		 */
581b3a88b52SEtienne Carriere 		one_deferred = false;
582b3a88b52SEtienne Carriere 		one_probed_ok = false;
583b3a88b52SEtienne Carriere 		added_node = false;
584b3a88b52SEtienne Carriere 
585b3a88b52SEtienne Carriere 		TAILQ_FOREACH_REVERSE_SAFE(elt, &dt_driver_probe_list,
586b3a88b52SEtienne Carriere 					   dt_driver_probe_head, link, prev) {
587b3a88b52SEtienne Carriere 			TAILQ_REMOVE(&dt_driver_probe_list, elt, link);
588b3a88b52SEtienne Carriere 
589b3a88b52SEtienne Carriere 			switch (probe_driver_node(fdt, elt)) {
590b3a88b52SEtienne Carriere 			case TEE_SUCCESS:
591b3a88b52SEtienne Carriere 				one_probed_ok = true;
592b3a88b52SEtienne Carriere 				break;
593b3a88b52SEtienne Carriere 			case TEE_ERROR_DEFER_DRIVER_INIT:
594b3a88b52SEtienne Carriere 				one_deferred = true;
595b3a88b52SEtienne Carriere 				break;
596b3a88b52SEtienne Carriere 			default:
597736cb9e1SEtienne Carriere 				break;
598b3a88b52SEtienne Carriere 			}
599b3a88b52SEtienne Carriere 		}
600b3a88b52SEtienne Carriere 
601b3a88b52SEtienne Carriere 		if (one_deferred)
602b3a88b52SEtienne Carriere 			deferral_loop_count++;
603b3a88b52SEtienne Carriere 
604b3a88b52SEtienne Carriere 	} while (added_node || one_probed_ok);
605b3a88b52SEtienne Carriere 
606c9bd3375SEtienne Carriere 	DMSG("Unresolved dependencies after %u rounds, %u deferred",
607b3a88b52SEtienne Carriere 	     loop_count, deferral_loop_count);
608b3a88b52SEtienne Carriere 
609c9bd3375SEtienne Carriere 	if (one_deferred)
610c9bd3375SEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
611c9bd3375SEtienne Carriere 	else
612c9bd3375SEtienne Carriere 		return TEE_ERROR_GENERIC;
613b3a88b52SEtienne Carriere }
614b3a88b52SEtienne Carriere 
615b3a88b52SEtienne Carriere static int driver_probe_compare(struct dt_driver_probe *candidate,
616b3a88b52SEtienne Carriere 				struct dt_driver_probe *elt)
617b3a88b52SEtienne Carriere {
618b3a88b52SEtienne Carriere 	if (candidate->nodeoffset != elt->nodeoffset ||
619b3a88b52SEtienne Carriere 	    candidate->type != elt->type)
620b3a88b52SEtienne Carriere 		return 1;
621b3a88b52SEtienne Carriere 
622b3a88b52SEtienne Carriere 	assert(elt->dt_drv == candidate->dt_drv);
623b3a88b52SEtienne Carriere 	return 0;
624b3a88b52SEtienne Carriere }
625b3a88b52SEtienne Carriere 
626b3a88b52SEtienne Carriere /*
627b3a88b52SEtienne Carriere  * Return TEE_SUCCESS if compatible found
628b3a88b52SEtienne Carriere  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
629b3a88b52SEtienne Carriere  */
630b3a88b52SEtienne Carriere static TEE_Result add_node_to_probe(const void *fdt, int node,
631b3a88b52SEtienne Carriere 				    const struct dt_driver *dt_drv,
632b3a88b52SEtienne Carriere 				    const struct dt_device_match *dm)
633b3a88b52SEtienne Carriere {
634b3a88b52SEtienne Carriere 	const char __maybe_unused *node_name = fdt_get_name(fdt, node, NULL);
635b3a88b52SEtienne Carriere 	const char __maybe_unused *drv_name = dt_drv->name;
636b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
637b3a88b52SEtienne Carriere 	struct dt_driver_probe elt_new = {
638b3a88b52SEtienne Carriere 		.dm = dm,
639b3a88b52SEtienne Carriere 		.dt_drv = dt_drv,
640b3a88b52SEtienne Carriere 		.nodeoffset = node,
641b3a88b52SEtienne Carriere 		.type = dt_drv->type,
642b3a88b52SEtienne Carriere 	};
643b3a88b52SEtienne Carriere 
644b3a88b52SEtienne Carriere 	/* If node/type found in probe list or ready list, nothing to do */
645b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
646b3a88b52SEtienne Carriere 		if (!driver_probe_compare(&elt_new, elt))
647b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
648b3a88b52SEtienne Carriere 
649b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_ready_list, link)
650b3a88b52SEtienne Carriere 		if (!driver_probe_compare(&elt_new, elt))
651b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
652b3a88b52SEtienne Carriere 
653b3a88b52SEtienne Carriere 	elt = malloc(sizeof(*elt));
654b3a88b52SEtienne Carriere 	if (!elt)
655b3a88b52SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
656b3a88b52SEtienne Carriere 
657b3a88b52SEtienne Carriere 	DMSG("element: %s on node %s", node_name, drv_name);
658b3a88b52SEtienne Carriere 
659b3a88b52SEtienne Carriere 	memcpy(elt, &elt_new, sizeof(*elt));
660b3a88b52SEtienne Carriere 
661b3a88b52SEtienne Carriere 	added_node = true;
662b3a88b52SEtienne Carriere 
663b3a88b52SEtienne Carriere 	TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
664b3a88b52SEtienne Carriere 
665b3a88b52SEtienne Carriere 	/* Hack here for TRACE_DEBUG messages on current probe list elements */
666b3a88b52SEtienne Carriere 	if (TRACE_LEVEL >= TRACE_FLOW)
667b3a88b52SEtienne Carriere 		print_probe_list(fdt);
668b3a88b52SEtienne Carriere 
669b3a88b52SEtienne Carriere 	return TEE_SUCCESS;
670b3a88b52SEtienne Carriere }
671b3a88b52SEtienne Carriere 
672b3a88b52SEtienne Carriere /*
673b3a88b52SEtienne Carriere  * Add a node to the probe list if a dt_driver matches target compatible.
674b3a88b52SEtienne Carriere  *
675b3a88b52SEtienne Carriere  * If @type is DT_DRIVER_ANY, probe list can hold only 1 driver to probe for
676b3a88b52SEtienne Carriere  * the node. A node may probe several drivers if have a unique driver type.
677b3a88b52SEtienne Carriere  *
678b3a88b52SEtienne Carriere  * Return TEE_SUCCESS if compatible found
679b3a88b52SEtienne Carriere  *	  TEE_ERROR_ITEM_NOT_FOUND if no matching driver
680b3a88b52SEtienne Carriere  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
681b3a88b52SEtienne Carriere  */
682b3a88b52SEtienne Carriere static TEE_Result add_probe_node_by_compat(const void *fdt, int node,
683b3a88b52SEtienne Carriere 					   const char *compat)
684b3a88b52SEtienne Carriere {
685b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_ITEM_NOT_FOUND;
686b3a88b52SEtienne Carriere 	const struct dt_driver *dt_drv = NULL;
687b3a88b52SEtienne Carriere 	const struct dt_device_match *dm = NULL;
688b3a88b52SEtienne Carriere 	uint32_t found_types = 0;
689b3a88b52SEtienne Carriere 
690b3a88b52SEtienne Carriere 	for_each_dt_driver(dt_drv) {
691b3a88b52SEtienne Carriere 		for (dm = dt_drv->match_table; dm && dm->compatible; dm++) {
692b3a88b52SEtienne Carriere 			if (strcmp(dm->compatible, compat) == 0) {
693b3a88b52SEtienne Carriere 				assert(dt_drv->type < 32);
694b3a88b52SEtienne Carriere 
695b3a88b52SEtienne Carriere 				res = add_node_to_probe(fdt, node, dt_drv, dm);
696b3a88b52SEtienne Carriere 				if (res)
697b3a88b52SEtienne Carriere 					return res;
698b3a88b52SEtienne Carriere 
699b3a88b52SEtienne Carriere 				if (found_types & BIT(dt_drv->type)) {
700b3a88b52SEtienne Carriere 					EMSG("Driver %s multi hit on type %u",
701b3a88b52SEtienne Carriere 					     dt_drv->name, dt_drv->type);
702b3a88b52SEtienne Carriere 					panic();
703b3a88b52SEtienne Carriere 				}
704b3a88b52SEtienne Carriere 				found_types |= BIT(dt_drv->type);
705b3a88b52SEtienne Carriere 
706b3a88b52SEtienne Carriere 				/* Matching found for this driver, try next */
707b3a88b52SEtienne Carriere 				break;
708b3a88b52SEtienne Carriere 			}
709b3a88b52SEtienne Carriere 		}
710b3a88b52SEtienne Carriere 	}
711b3a88b52SEtienne Carriere 
712b3a88b52SEtienne Carriere 	return res;
713b3a88b52SEtienne Carriere }
714b3a88b52SEtienne Carriere 
715b3a88b52SEtienne Carriere /*
716b3a88b52SEtienne Carriere  * Add the node to the probe list if matching compatible drivers are found.
717b3a88b52SEtienne Carriere  * Follow node's compatible property list ordering to find matching driver.
718b3a88b52SEtienne Carriere  */
719b3a88b52SEtienne Carriere TEE_Result dt_driver_maybe_add_probe_node(const void *fdt, int node)
720b3a88b52SEtienne Carriere {
721b3a88b52SEtienne Carriere 	int idx = 0;
722b3a88b52SEtienne Carriere 	int len = 0;
723b3a88b52SEtienne Carriere 	int count = 0;
724b3a88b52SEtienne Carriere 	const char *compat = NULL;
725b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
726b3a88b52SEtienne Carriere 
727f354a5d8SGatien Chevallier 	if (fdt_get_status(fdt, node) == DT_STATUS_DISABLED)
728b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
729b3a88b52SEtienne Carriere 
730b3a88b52SEtienne Carriere 	count = fdt_stringlist_count(fdt, node, "compatible");
731b3a88b52SEtienne Carriere 	if (count < 0)
732b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
733b3a88b52SEtienne Carriere 
734b3a88b52SEtienne Carriere 	for (idx = 0; idx < count; idx++) {
735b3a88b52SEtienne Carriere 		compat = fdt_stringlist_get(fdt, node, "compatible", idx, &len);
736b3a88b52SEtienne Carriere 		assert(compat && len > 0);
737b3a88b52SEtienne Carriere 
738b3a88b52SEtienne Carriere 		res = add_probe_node_by_compat(fdt, node, compat);
739b3a88b52SEtienne Carriere 
740b3a88b52SEtienne Carriere 		/* Stop lookup if something was found */
741b3a88b52SEtienne Carriere 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
742b3a88b52SEtienne Carriere 			return res;
743b3a88b52SEtienne Carriere 	}
744b3a88b52SEtienne Carriere 
745b3a88b52SEtienne Carriere 	return TEE_SUCCESS;
746b3a88b52SEtienne Carriere }
747b3a88b52SEtienne Carriere 
748b3a88b52SEtienne Carriere static void parse_node(const void *fdt, int node)
749b3a88b52SEtienne Carriere {
750b3a88b52SEtienne Carriere 	TEE_Result __maybe_unused res = TEE_ERROR_GENERIC;
751b3a88b52SEtienne Carriere 	int subnode = 0;
752b3a88b52SEtienne Carriere 
753b3a88b52SEtienne Carriere 	fdt_for_each_subnode(subnode, fdt, node) {
754b3a88b52SEtienne Carriere 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
755b3a88b52SEtienne Carriere 		if (res) {
756b3a88b52SEtienne Carriere 			EMSG("Failed on node %s with %#"PRIx32,
757b3a88b52SEtienne Carriere 			     fdt_get_name(fdt, subnode, NULL), res);
758b3a88b52SEtienne Carriere 			panic();
759b3a88b52SEtienne Carriere 		}
760b3a88b52SEtienne Carriere 
761b3a88b52SEtienne Carriere 		/*
762b3a88b52SEtienne Carriere 		 * Rescursively parse the FDT, skipping disabled nodes.
763b3a88b52SEtienne Carriere 		 * FDT is expected reliable and core shall have sufficient
764b3a88b52SEtienne Carriere 		 * stack depth to possibly parse all DT nodes.
765b3a88b52SEtienne Carriere 		 */
766b3a88b52SEtienne Carriere 		if (IS_ENABLED(CFG_DRIVERS_DT_RECURSIVE_PROBE)) {
767f354a5d8SGatien Chevallier 			if (fdt_get_status(fdt, subnode) == DT_STATUS_DISABLED)
768b3a88b52SEtienne Carriere 				continue;
769b3a88b52SEtienne Carriere 
770b3a88b52SEtienne Carriere 			parse_node(fdt, subnode);
771b3a88b52SEtienne Carriere 		}
772b3a88b52SEtienne Carriere 	}
773b3a88b52SEtienne Carriere }
774b3a88b52SEtienne Carriere 
775b3a88b52SEtienne Carriere /*
776b3a88b52SEtienne Carriere  * Parse FDT for nodes and save in probe list the node for which a dt_driver
777b3a88b52SEtienne Carriere  * matches node's compatible property.
778b3a88b52SEtienne Carriere  */
779c9bd3375SEtienne Carriere static TEE_Result probe_dt_drivers_early(void)
780b3a88b52SEtienne Carriere {
781c9bd3375SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
782b3a88b52SEtienne Carriere 	const void *fdt = NULL;
783b3a88b52SEtienne Carriere 
784d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
785d2289450SVesa Jääskeläinen 	if (!fdt)
786b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
787b3a88b52SEtienne Carriere 
788b3a88b52SEtienne Carriere 	parse_node(fdt, fdt_path_offset(fdt, "/"));
789b3a88b52SEtienne Carriere 
790c9bd3375SEtienne Carriere 	res = process_probe_list(fdt);
791c9bd3375SEtienne Carriere 	if (res == TEE_ERROR_DEFER_DRIVER_INIT) {
792c9bd3375SEtienne Carriere 		DMSG("Deferred drivers probing");
793c9bd3375SEtienne Carriere 		print_probe_list(fdt);
794c9bd3375SEtienne Carriere 		res = TEE_SUCCESS;
795b3a88b52SEtienne Carriere 	}
796b3a88b52SEtienne Carriere 
797c9bd3375SEtienne Carriere 	return res;
798c9bd3375SEtienne Carriere }
799c9bd3375SEtienne Carriere 
800c9bd3375SEtienne Carriere static TEE_Result probe_dt_drivers(void)
801c9bd3375SEtienne Carriere {
802c9bd3375SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
803c9bd3375SEtienne Carriere 	const void *fdt = NULL;
804c9bd3375SEtienne Carriere 
805d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
806d2289450SVesa Jääskeläinen 	if (!fdt)
807c9bd3375SEtienne Carriere 		return TEE_SUCCESS;
808c9bd3375SEtienne Carriere 
809c9bd3375SEtienne Carriere 	res = process_probe_list(fdt);
810c9bd3375SEtienne Carriere 	if (res || !TAILQ_EMPTY(&dt_driver_failed_list)) {
811c9bd3375SEtienne Carriere 		EMSG("Probe sequence result: %#"PRIx32, res);
812c9bd3375SEtienne Carriere 		print_probe_list(fdt);
813c9bd3375SEtienne Carriere 		panic();
8148f3e49faSGatien Chevallier 	}
815c9bd3375SEtienne Carriere 
816c9bd3375SEtienne Carriere 	return TEE_SUCCESS;
817c9bd3375SEtienne Carriere }
818c9bd3375SEtienne Carriere 
819c9bd3375SEtienne Carriere early_init_late(probe_dt_drivers_early);
820b3a88b52SEtienne Carriere driver_init(probe_dt_drivers);
821ea29d587SEtienne Carriere 
822f21b3ed5SEtienne Carriere static TEE_Result release_probe_lists(void)
823f21b3ed5SEtienne Carriere {
824f21b3ed5SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
825f21b3ed5SEtienne Carriere 	struct dt_driver_probe *next = NULL;
826115944b5SEtienne Carriere 	struct dt_driver_provider *prov = NULL;
827115944b5SEtienne Carriere 	struct dt_driver_provider *next_prov = NULL;
828d2289450SVesa Jääskeläinen 	const void *fdt = NULL;
829f21b3ed5SEtienne Carriere 
830d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
831d2289450SVesa Jääskeläinen 	if (!fdt)
832f21b3ed5SEtienne Carriere 		return TEE_SUCCESS;
833f21b3ed5SEtienne Carriere 
834f21b3ed5SEtienne Carriere 	assert(fdt && TAILQ_EMPTY(&dt_driver_probe_list));
835f21b3ed5SEtienne Carriere 
836115944b5SEtienne Carriere 	TAILQ_FOREACH_SAFE(elt, &dt_driver_ready_list, link, next)
837f21b3ed5SEtienne Carriere 		free(elt);
838115944b5SEtienne Carriere 
839736cb9e1SEtienne Carriere 	TAILQ_FOREACH_SAFE(elt, &dt_driver_failed_list, link, next)
840736cb9e1SEtienne Carriere 	       free(elt);
841736cb9e1SEtienne Carriere 
842115944b5SEtienne Carriere 	SLIST_FOREACH_SAFE(prov, &dt_driver_provider_list, link, next_prov)
843115944b5SEtienne Carriere 	       free(prov);
844f21b3ed5SEtienne Carriere 
845f21b3ed5SEtienne Carriere 	return TEE_SUCCESS;
846f21b3ed5SEtienne Carriere }
847f21b3ed5SEtienne Carriere 
848f21b3ed5SEtienne Carriere release_init_resource(release_probe_lists);
849f21b3ed5SEtienne Carriere 
850ea29d587SEtienne Carriere /*
851ea29d587SEtienne Carriere  * Simple bus support: handy to parse subnodes
852ea29d587SEtienne Carriere  */
853ea29d587SEtienne Carriere static TEE_Result simple_bus_probe(const void *fdt, int node,
854ea29d587SEtienne Carriere 				   const void *compat_data __unused)
855ea29d587SEtienne Carriere {
856ea29d587SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
857ea29d587SEtienne Carriere 	int subnode = 0;
858ea29d587SEtienne Carriere 
859ea29d587SEtienne Carriere 	fdt_for_each_subnode(subnode, fdt, node) {
860ea29d587SEtienne Carriere 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
861ea29d587SEtienne Carriere 		if (res) {
862ea29d587SEtienne Carriere 			EMSG("Failed on node %s with %#"PRIx32,
863ea29d587SEtienne Carriere 			     fdt_get_name(fdt, subnode, NULL), res);
864ea29d587SEtienne Carriere 			panic();
865ea29d587SEtienne Carriere 		}
866ea29d587SEtienne Carriere 	}
867ea29d587SEtienne Carriere 
868ea29d587SEtienne Carriere 	return TEE_SUCCESS;
869ea29d587SEtienne Carriere }
870ea29d587SEtienne Carriere 
871ea29d587SEtienne Carriere static const struct dt_device_match simple_bus_match_table[] = {
872ea29d587SEtienne Carriere 	{ .compatible = "simple-bus" },
873ea29d587SEtienne Carriere 	{ }
874ea29d587SEtienne Carriere };
875ea29d587SEtienne Carriere 
87661bdedeaSJerome Forissier DEFINE_DT_DRIVER(simple_bus_dt_driver) = {
877ea29d587SEtienne Carriere 	.name = "simple-bus",
878ea29d587SEtienne Carriere 	.match_table = simple_bus_match_table,
879ea29d587SEtienne Carriere 	.probe = simple_bus_probe,
880ea29d587SEtienne Carriere };
881