xref: /optee_os/core/kernel/dt_driver.c (revision 193944aadbe838780b4c6b9c94c0a739526b5e79)
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:
113*193944aaSEtienne 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:
200*193944aaSEtienne 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 
2218dca59b4SEtienne Carriere struct dt_driver_provider *
2228dca59b4SEtienne Carriere dt_driver_get_provider_by_node(int nodeoffset, enum dt_driver_type type)
223f498c404SEtienne Carriere {
224f498c404SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
225f498c404SEtienne Carriere 
226f498c404SEtienne Carriere 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
2278dca59b4SEtienne Carriere 		if (prv->nodeoffset == nodeoffset && prv->type == type)
228f498c404SEtienne Carriere 			return prv;
229f498c404SEtienne Carriere 
230f498c404SEtienne Carriere 	return NULL;
231f498c404SEtienne Carriere }
232f498c404SEtienne Carriere 
2338dca59b4SEtienne Carriere struct dt_driver_provider *
2348dca59b4SEtienne Carriere dt_driver_get_provider_by_phandle(uint32_t phandle, enum dt_driver_type type)
235f498c404SEtienne Carriere {
236f498c404SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
237f498c404SEtienne Carriere 
238f498c404SEtienne Carriere 	SLIST_FOREACH(prv, &dt_driver_provider_list, link)
2398dca59b4SEtienne Carriere 		if (prv->phandle == phandle && prv->type == type)
240f498c404SEtienne Carriere 			return prv;
241f498c404SEtienne Carriere 
242f498c404SEtienne Carriere 	return NULL;
243f498c404SEtienne Carriere }
244a22e85b2SEtienne Carriere 
245b357d34fSEtienne Carriere static TEE_Result device_from_provider_prop(struct dt_driver_provider *prv,
24633cc94dfSClément Léger 					    const void *fdt, int phandle_node,
247b357d34fSEtienne Carriere 					    const uint32_t *prop, void **device)
248a22e85b2SEtienne Carriere {
249b357d34fSEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
2508fd620f7SEtienne Carriere 	struct dt_pargs *pargs = NULL;
251a22e85b2SEtienne Carriere 	unsigned int n = 0;
252a22e85b2SEtienne Carriere 
253a22e85b2SEtienne Carriere 	pargs = calloc(1, prv->provider_cells * sizeof(uint32_t *) +
254a22e85b2SEtienne Carriere 		       sizeof(*pargs));
255b357d34fSEtienne Carriere 	if (!pargs)
256b357d34fSEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
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 
264b357d34fSEtienne Carriere 	res = prv->get_of_device(pargs, prv->priv_data, device);
265a22e85b2SEtienne Carriere 
266a22e85b2SEtienne Carriere 	free(pargs);
267a22e85b2SEtienne Carriere 
268b357d34fSEtienne Carriere 	return res;
269a22e85b2SEtienne Carriere }
270a22e85b2SEtienne Carriere 
271b357d34fSEtienne Carriere TEE_Result dt_driver_device_from_parent(const void *fdt, int nodeoffset,
272b357d34fSEtienne Carriere 					enum dt_driver_type type, void **device)
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);
280b357d34fSEtienne Carriere 	if (parent < 0)
281b357d34fSEtienne Carriere 		return TEE_ERROR_GENERIC;
282e7a2db34SClément Léger 
283e7a2db34SClément Léger 	prv = dt_driver_get_provider_by_node(parent, type);
284e7a2db34SClément Léger 	if (!prv) {
285e7a2db34SClément Léger 		/* No provider registered yet */
286b357d34fSEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
287e7a2db34SClément Léger 	}
288e7a2db34SClément Léger 
289b357d34fSEtienne Carriere 	return device_from_provider_prop(prv, fdt, nodeoffset, NULL, device);
290e7a2db34SClément Léger }
291e7a2db34SClément Léger 
292b357d34fSEtienne Carriere TEE_Result dt_driver_device_from_node_idx_prop_phandle(const char *prop_name,
293b357d34fSEtienne Carriere 						       const void *fdt,
294b357d34fSEtienne Carriere 						       int nodeoffs,
29550dd2af0SEtienne Carriere 						       unsigned int prop_index,
29650dd2af0SEtienne Carriere 						       enum dt_driver_type type,
29750dd2af0SEtienne Carriere 						       uint32_t phandle,
298b357d34fSEtienne Carriere 						       void **device)
29950dd2af0SEtienne Carriere {
30050dd2af0SEtienne Carriere 	int len = 0;
30150dd2af0SEtienne Carriere 	const uint32_t *prop = NULL;
30250dd2af0SEtienne Carriere 	int phandle_node_unused = -1;
30350dd2af0SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
30450dd2af0SEtienne Carriere 
30550dd2af0SEtienne Carriere 	prop = fdt_getprop(fdt, nodeoffs, prop_name, &len);
30650dd2af0SEtienne Carriere 	if (!prop) {
30750dd2af0SEtienne Carriere 		if (len != -FDT_ERR_NOTFOUND) {
30850dd2af0SEtienne Carriere 			DMSG("Corrupted node %s", prop_name);
309b357d34fSEtienne Carriere 			return TEE_ERROR_GENERIC;
31050dd2af0SEtienne Carriere 		} else {
31150dd2af0SEtienne Carriere 			DMSG("Property %s missing in node %s", prop_name,
31250dd2af0SEtienne Carriere 			     fdt_get_name(fdt, nodeoffs, NULL));
313b357d34fSEtienne Carriere 			return TEE_ERROR_ITEM_NOT_FOUND;
31450dd2af0SEtienne Carriere 		}
31550dd2af0SEtienne Carriere 	}
31650dd2af0SEtienne Carriere 
31750dd2af0SEtienne Carriere 	prv = dt_driver_get_provider_by_phandle(phandle, type);
318b357d34fSEtienne Carriere 	if (!prv)
319b357d34fSEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
32050dd2af0SEtienne Carriere 
32150dd2af0SEtienne Carriere 	prop_index *= dt_driver_provider_cells(prv);
322b357d34fSEtienne Carriere 	if ((prop_index + 1) * sizeof(*prop) > (size_t)len)
323b357d34fSEtienne Carriere 		return TEE_ERROR_ITEM_NOT_FOUND;
32450dd2af0SEtienne Carriere 
32550dd2af0SEtienne Carriere 	return device_from_provider_prop(prv, fdt, phandle_node_unused,
326b357d34fSEtienne Carriere 					 prop + prop_index, device);
32750dd2af0SEtienne Carriere }
32850dd2af0SEtienne Carriere 
329b357d34fSEtienne Carriere TEE_Result dt_driver_device_from_node_idx_prop(const char *prop_name,
330a22e85b2SEtienne Carriere 					       const void *fdt, int nodeoffset,
331d8b14b46SEtienne Carriere 					       unsigned int prop_idx,
3328dca59b4SEtienne Carriere 					       enum dt_driver_type type,
333b357d34fSEtienne Carriere 					       void **device)
334a22e85b2SEtienne Carriere {
335a22e85b2SEtienne Carriere 	int len = 0;
336a22e85b2SEtienne Carriere 	int idx = 0;
337a22e85b2SEtienne Carriere 	int idx32 = 0;
338a22e85b2SEtienne Carriere 	int prv_cells = 0;
33933cc94dfSClément Léger 	int phandle_node = -1;
340a22e85b2SEtienne Carriere 	uint32_t phandle = 0;
341a22e85b2SEtienne Carriere 	const uint32_t *prop = NULL;
342a22e85b2SEtienne Carriere 	struct dt_driver_provider *prv = NULL;
343a22e85b2SEtienne Carriere 
344a22e85b2SEtienne Carriere 	prop = fdt_getprop(fdt, nodeoffset, prop_name, &len);
345d8b14b46SEtienne Carriere 	if (!prop) {
346b17cf5c8SEtienne Carriere 		DMSG("Property %s missing in node %s", prop_name,
347b17cf5c8SEtienne Carriere 		     fdt_get_name(fdt, nodeoffset, NULL));
348b357d34fSEtienne Carriere 		return TEE_ERROR_ITEM_NOT_FOUND;
349d8b14b46SEtienne Carriere 	}
350a22e85b2SEtienne Carriere 
351a22e85b2SEtienne Carriere 	while (idx < len) {
352a22e85b2SEtienne Carriere 		idx32 = idx / sizeof(uint32_t);
353a22e85b2SEtienne Carriere 		phandle = fdt32_to_cpu(prop[idx32]);
354f1f7c58eSClément Léger 		if (!phandle) {
355f1f7c58eSClément Léger 			if (!prop_idx)
356f1f7c58eSClément Léger 				break;
357f1f7c58eSClément Léger 			idx += sizeof(phandle);
358f1f7c58eSClément Léger 			prop_idx--;
359f1f7c58eSClément Léger 			continue;
360f1f7c58eSClément Léger 		}
361a22e85b2SEtienne Carriere 
362b5aff6deSClément Léger 		/*
363b5aff6deSClément Léger 		 * In some cases, pinctrl, i2c, nvmem, etc, the consumer phandle
364b5aff6deSClément Léger 		 * points directly to a subnode of the parent. In such cases,
365b5aff6deSClément Léger 		 * the provider does not have any "-cells" property and
366b5aff6deSClément Léger 		 * potentially no "phandle" property.
367b5aff6deSClément Léger 		 */
368b5aff6deSClément Léger 		if (dt_driver_use_parent_controller(type)) {
369b5aff6deSClément Léger 			phandle_node = fdt_node_offset_by_phandle(fdt, phandle);
370b357d34fSEtienne Carriere 			if (phandle_node < 0)
371b357d34fSEtienne Carriere 				return TEE_ERROR_GENERIC;
372b5aff6deSClément Léger 
373b5aff6deSClément Léger 			nodeoffset = fdt_parent_offset(fdt, phandle_node);
374b357d34fSEtienne Carriere 			if (nodeoffset < 0)
375b357d34fSEtienne Carriere 				return TEE_ERROR_GENERIC;
376b5aff6deSClément Léger 
377b5aff6deSClément Léger 			prv = dt_driver_get_provider_by_node(nodeoffset, type);
378b357d34fSEtienne Carriere 			if (!prv)
379b357d34fSEtienne Carriere 				return TEE_ERROR_DEFER_DRIVER_INIT;
380b5aff6deSClément Léger 		} else {
3818dca59b4SEtienne Carriere 			prv = dt_driver_get_provider_by_phandle(phandle, type);
382b357d34fSEtienne Carriere 			if (!prv)
383b357d34fSEtienne Carriere 				return TEE_ERROR_DEFER_DRIVER_INIT;
384b5aff6deSClément Léger 		}
385a22e85b2SEtienne Carriere 
386a22e85b2SEtienne Carriere 		prv_cells = dt_driver_provider_cells(prv);
387a22e85b2SEtienne Carriere 		if (prop_idx) {
388a22e85b2SEtienne Carriere 			prop_idx--;
389a22e85b2SEtienne Carriere 			idx += sizeof(phandle) + prv_cells * sizeof(uint32_t);
390a22e85b2SEtienne Carriere 			continue;
391a22e85b2SEtienne Carriere 		}
392a22e85b2SEtienne Carriere 
39333cc94dfSClément Léger 		return device_from_provider_prop(prv, fdt, phandle_node,
394b357d34fSEtienne Carriere 						 prop + idx32, device);
395a22e85b2SEtienne Carriere 	}
396a22e85b2SEtienne Carriere 
397b357d34fSEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
398a22e85b2SEtienne Carriere }
399ef20efc4SEtienne Carriere 
400c9bd3375SEtienne Carriere static void __maybe_unused print_probe_list(const void *fdt __maybe_unused)
401b3a88b52SEtienne Carriere {
402b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
403b3a88b52SEtienne Carriere 	unsigned int count = 0;
404b3a88b52SEtienne Carriere 
405b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
406b3a88b52SEtienne Carriere 		count++;
407b3a88b52SEtienne Carriere 
408c9bd3375SEtienne Carriere 	DMSG("Probe list: %u elements", count);
409b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
410c9bd3375SEtienne Carriere 		DMSG("|- Driver %s probes on node %s",
411b3a88b52SEtienne Carriere 		     elt->dt_drv->name,
412b3a88b52SEtienne Carriere 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
413b3a88b52SEtienne Carriere 
414c9bd3375SEtienne Carriere 	DMSG("`- Probe list end");
415c9bd3375SEtienne Carriere 
416c9bd3375SEtienne Carriere 	count = 0;
417c9bd3375SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
418c9bd3375SEtienne Carriere 		count++;
419c9bd3375SEtienne Carriere 
420c9bd3375SEtienne Carriere 	DMSG("Failed list: %u elements", count);
421c9bd3375SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_failed_list, link)
422c9bd3375SEtienne Carriere 		EMSG("|- Driver %s on node %s failed", elt->dt_drv->name,
423c9bd3375SEtienne Carriere 		     fdt_get_name(fdt, elt->nodeoffset, NULL));
424c9bd3375SEtienne Carriere 
425c9bd3375SEtienne Carriere 	DMSG("`- Failed list end");
426b3a88b52SEtienne Carriere }
427b3a88b52SEtienne Carriere 
428b3a88b52SEtienne Carriere /*
429b3a88b52SEtienne Carriere  * Probe element: push to ready list if succeeds, push to probe list if probe
430b3a88b52SEtienne Carriere  * if deferred, panic with an error trace otherwise.
431b3a88b52SEtienne Carriere  */
432b3a88b52SEtienne Carriere static TEE_Result probe_driver_node(const void *fdt,
433b3a88b52SEtienne Carriere 				    struct dt_driver_probe *elt)
434b3a88b52SEtienne Carriere {
435b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
436b3a88b52SEtienne Carriere 	const char __maybe_unused *drv_name = NULL;
437b3a88b52SEtienne Carriere 	const char __maybe_unused *node_name = NULL;
438b3a88b52SEtienne Carriere 
439b3a88b52SEtienne Carriere 	node_name = fdt_get_name(fdt, elt->nodeoffset, NULL);
440b3a88b52SEtienne Carriere 	drv_name = elt->dt_drv->name;
441c4c84e2cSSahil Malhotra 
442c4c84e2cSSahil Malhotra 	if (!elt->dt_drv->probe) {
443c4c84e2cSSahil Malhotra 		DMSG("No probe operator for driver %s, skipped", drv_name);
444c4c84e2cSSahil Malhotra 		return TEE_SUCCESS;
445c4c84e2cSSahil Malhotra 	}
446c4c84e2cSSahil Malhotra 
447b3a88b52SEtienne Carriere 	FMSG("Probing %s on node %s", drv_name, node_name);
448b3a88b52SEtienne Carriere 
449b3a88b52SEtienne Carriere 	res = elt->dt_drv->probe(fdt, elt->nodeoffset, elt->dm->compat_data);
450b3a88b52SEtienne Carriere 	switch (res) {
451b3a88b52SEtienne Carriere 	case TEE_SUCCESS:
452b3a88b52SEtienne Carriere 		TAILQ_INSERT_HEAD(&dt_driver_ready_list, elt, link);
453b3a88b52SEtienne Carriere 
454b3a88b52SEtienne Carriere 		DMSG("element: %s on node %s initialized", drv_name, node_name);
455b3a88b52SEtienne Carriere 		break;
456b3a88b52SEtienne Carriere 	case TEE_ERROR_DEFER_DRIVER_INIT:
457b3a88b52SEtienne Carriere 		elt->deferrals++;
458b3a88b52SEtienne Carriere 		TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
459b3a88b52SEtienne Carriere 
460b3a88b52SEtienne Carriere 		DMSG("element: %s on node %s deferred %u time(s)", drv_name,
461b3a88b52SEtienne Carriere 		     node_name, elt->deferrals);
462b3a88b52SEtienne Carriere 		break;
46352199c35SVesa Jääskeläinen 	case TEE_ERROR_NODE_DISABLED:
46452199c35SVesa Jääskeläinen 		DMSG("element: %s on node %s is disabled", drv_name, node_name);
46552199c35SVesa Jääskeläinen 		break;
466b3a88b52SEtienne Carriere 	default:
467736cb9e1SEtienne Carriere 		TAILQ_INSERT_HEAD(&dt_driver_failed_list, elt, link);
468736cb9e1SEtienne Carriere 
469736cb9e1SEtienne Carriere 		EMSG("Failed to probe %s on node %s: %#"PRIx32,
470b3a88b52SEtienne Carriere 		     drv_name, node_name, res);
471736cb9e1SEtienne Carriere 		break;
472b3a88b52SEtienne Carriere 	}
473b3a88b52SEtienne Carriere 
474b3a88b52SEtienne Carriere 	return res;
475b3a88b52SEtienne Carriere }
476b3a88b52SEtienne Carriere 
477b3a88b52SEtienne Carriere static TEE_Result alloc_elt_and_probe(const void *fdt, int node,
478b3a88b52SEtienne Carriere 				      const struct dt_driver *dt_drv,
479b3a88b52SEtienne Carriere 				      const struct dt_device_match *dm)
480b3a88b52SEtienne Carriere {
481b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
482b3a88b52SEtienne Carriere 
483b3a88b52SEtienne Carriere 	/* Will be freed when lists are released */
484b3a88b52SEtienne Carriere 	elt = calloc(1, sizeof(*elt));
485b3a88b52SEtienne Carriere 	if (!elt)
486b3a88b52SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
487b3a88b52SEtienne Carriere 
488b3a88b52SEtienne Carriere 	elt->nodeoffset = node;
489b3a88b52SEtienne Carriere 	elt->dt_drv = dt_drv;
490b3a88b52SEtienne Carriere 	elt->dm = dm;
491b3a88b52SEtienne Carriere 	elt->type = dt_drv->type;
492b3a88b52SEtienne Carriere 
493b3a88b52SEtienne Carriere 	return probe_driver_node(fdt, elt);
494b3a88b52SEtienne Carriere }
495b3a88b52SEtienne Carriere 
496ef20efc4SEtienne Carriere /* Lookup a compatible driver, possibly of a specific @type, for the FDT node */
497ef20efc4SEtienne Carriere static TEE_Result probe_device_by_compat(const void *fdt, int node,
498ef20efc4SEtienne Carriere 					 const char *compat,
499ef20efc4SEtienne Carriere 					 enum dt_driver_type type)
500ef20efc4SEtienne Carriere {
501ef20efc4SEtienne Carriere 	const struct dt_driver *drv = NULL;
502ef20efc4SEtienne Carriere 	const struct dt_device_match *dm = NULL;
503ef20efc4SEtienne Carriere 
504ef20efc4SEtienne Carriere 	for_each_dt_driver(drv) {
505ef20efc4SEtienne Carriere 		if (drv->type != type)
506ef20efc4SEtienne Carriere 			continue;
507ef20efc4SEtienne Carriere 
508ef20efc4SEtienne Carriere 		for (dm = drv->match_table; dm && dm->compatible; dm++)
509ef20efc4SEtienne Carriere 			if (strcmp(dm->compatible, compat) == 0)
510b3a88b52SEtienne Carriere 				return alloc_elt_and_probe(fdt, node, drv, dm);
511ef20efc4SEtienne Carriere 	}
512ef20efc4SEtienne Carriere 
513ef20efc4SEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
514ef20efc4SEtienne Carriere }
515ef20efc4SEtienne Carriere 
516b3a88b52SEtienne Carriere /*
517b3a88b52SEtienne Carriere  * Lookup the best matching compatible driver, possibly of a specific @type,
518b3a88b52SEtienne Carriere  * for the FDT node.
519b3a88b52SEtienne Carriere  */
520ef20efc4SEtienne Carriere TEE_Result dt_driver_probe_device_by_node(const void *fdt, int nodeoffset,
521ef20efc4SEtienne Carriere 					  enum dt_driver_type type)
522ef20efc4SEtienne Carriere {
523ef20efc4SEtienne Carriere 	int idx = 0;
524ef20efc4SEtienne Carriere 	int len = 0;
525ef20efc4SEtienne Carriere 	int count = 0;
526ef20efc4SEtienne Carriere 	const char *compat = NULL;
527ef20efc4SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
528ef20efc4SEtienne Carriere 
529b3a88b52SEtienne Carriere 	assert_type_is_valid(type);
530b3a88b52SEtienne Carriere 
531ef20efc4SEtienne Carriere 	count = fdt_stringlist_count(fdt, nodeoffset, "compatible");
532ef20efc4SEtienne Carriere 	if (count < 0)
533ef20efc4SEtienne Carriere 		return TEE_ERROR_ITEM_NOT_FOUND;
534ef20efc4SEtienne Carriere 
535ef20efc4SEtienne Carriere 	for (idx = 0; idx < count; idx++) {
536ef20efc4SEtienne Carriere 		compat = fdt_stringlist_get(fdt, nodeoffset, "compatible",
537ef20efc4SEtienne Carriere 					    idx, &len);
538ef20efc4SEtienne Carriere 		if (!compat)
539ef20efc4SEtienne Carriere 			return TEE_ERROR_GENERIC;
540ef20efc4SEtienne Carriere 
541ef20efc4SEtienne Carriere 		res = probe_device_by_compat(fdt, nodeoffset, compat, type);
542ef20efc4SEtienne Carriere 
543ef20efc4SEtienne Carriere 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
544ef20efc4SEtienne Carriere 			return res;
545ef20efc4SEtienne Carriere 	}
546ef20efc4SEtienne Carriere 
547ef20efc4SEtienne Carriere 	return TEE_ERROR_ITEM_NOT_FOUND;
548ef20efc4SEtienne Carriere }
549b3a88b52SEtienne Carriere 
550b3a88b52SEtienne Carriere static TEE_Result process_probe_list(const void *fdt)
551b3a88b52SEtienne Carriere {
552b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
553b3a88b52SEtienne Carriere 	struct dt_driver_probe *prev = NULL;
554c9bd3375SEtienne Carriere 	static unsigned int __maybe_unused loop_count;
555c9bd3375SEtienne Carriere 	static unsigned int __maybe_unused deferral_loop_count;
556b3a88b52SEtienne Carriere 	bool __maybe_unused one_deferred = false;
557b3a88b52SEtienne Carriere 	bool one_probed_ok = false;
558b3a88b52SEtienne Carriere 
559b3a88b52SEtienne Carriere 	do {
560b3a88b52SEtienne Carriere 		loop_count++;
561b3a88b52SEtienne Carriere 		FMSG("Probe loop %u after %u for deferral(s)", loop_count,
562b3a88b52SEtienne Carriere 		     deferral_loop_count);
563b3a88b52SEtienne Carriere 
564b3a88b52SEtienne Carriere 		/* Hack here for TRACE_DEBUG messages on probe list elements */
565b3a88b52SEtienne Carriere 		if (TRACE_LEVEL >= TRACE_FLOW)
566b3a88b52SEtienne Carriere 			print_probe_list(fdt);
567b3a88b52SEtienne Carriere 
568b3a88b52SEtienne Carriere 		if (TAILQ_EMPTY(&dt_driver_probe_list))
569b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
570b3a88b52SEtienne Carriere 
571b3a88b52SEtienne Carriere 		/*
572b3a88b52SEtienne Carriere 		 * Probe from current end to top. Deferred probed node are
573b3a88b52SEtienne Carriere 		 * pushed back after current tail for the next probe round.
574b3a88b52SEtienne Carriere 		 * Reset probe result flags and see status after probe round.
575b3a88b52SEtienne Carriere 		 */
576b3a88b52SEtienne Carriere 		one_deferred = false;
577b3a88b52SEtienne Carriere 		one_probed_ok = false;
578b3a88b52SEtienne Carriere 		added_node = false;
579b3a88b52SEtienne Carriere 
580b3a88b52SEtienne Carriere 		TAILQ_FOREACH_REVERSE_SAFE(elt, &dt_driver_probe_list,
581b3a88b52SEtienne Carriere 					   dt_driver_probe_head, link, prev) {
582b3a88b52SEtienne Carriere 			TAILQ_REMOVE(&dt_driver_probe_list, elt, link);
583b3a88b52SEtienne Carriere 
584b3a88b52SEtienne Carriere 			switch (probe_driver_node(fdt, elt)) {
585b3a88b52SEtienne Carriere 			case TEE_SUCCESS:
586b3a88b52SEtienne Carriere 				one_probed_ok = true;
587b3a88b52SEtienne Carriere 				break;
588b3a88b52SEtienne Carriere 			case TEE_ERROR_DEFER_DRIVER_INIT:
589b3a88b52SEtienne Carriere 				one_deferred = true;
590b3a88b52SEtienne Carriere 				break;
591b3a88b52SEtienne Carriere 			default:
592736cb9e1SEtienne Carriere 				break;
593b3a88b52SEtienne Carriere 			}
594b3a88b52SEtienne Carriere 		}
595b3a88b52SEtienne Carriere 
596b3a88b52SEtienne Carriere 		if (one_deferred)
597b3a88b52SEtienne Carriere 			deferral_loop_count++;
598b3a88b52SEtienne Carriere 
599b3a88b52SEtienne Carriere 	} while (added_node || one_probed_ok);
600b3a88b52SEtienne Carriere 
601c9bd3375SEtienne Carriere 	DMSG("Unresolved dependencies after %u rounds, %u deferred",
602b3a88b52SEtienne Carriere 	     loop_count, deferral_loop_count);
603b3a88b52SEtienne Carriere 
604c9bd3375SEtienne Carriere 	if (one_deferred)
605c9bd3375SEtienne Carriere 		return TEE_ERROR_DEFER_DRIVER_INIT;
606c9bd3375SEtienne Carriere 	else
607c9bd3375SEtienne Carriere 		return TEE_ERROR_GENERIC;
608b3a88b52SEtienne Carriere }
609b3a88b52SEtienne Carriere 
610b3a88b52SEtienne Carriere static int driver_probe_compare(struct dt_driver_probe *candidate,
611b3a88b52SEtienne Carriere 				struct dt_driver_probe *elt)
612b3a88b52SEtienne Carriere {
613b3a88b52SEtienne Carriere 	if (candidate->nodeoffset != elt->nodeoffset ||
614b3a88b52SEtienne Carriere 	    candidate->type != elt->type)
615b3a88b52SEtienne Carriere 		return 1;
616b3a88b52SEtienne Carriere 
617b3a88b52SEtienne Carriere 	assert(elt->dt_drv == candidate->dt_drv);
618b3a88b52SEtienne Carriere 	return 0;
619b3a88b52SEtienne Carriere }
620b3a88b52SEtienne Carriere 
621b3a88b52SEtienne Carriere /*
622b3a88b52SEtienne Carriere  * Return TEE_SUCCESS if compatible found
623b3a88b52SEtienne Carriere  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
624b3a88b52SEtienne Carriere  */
625b3a88b52SEtienne Carriere static TEE_Result add_node_to_probe(const void *fdt, int node,
626b3a88b52SEtienne Carriere 				    const struct dt_driver *dt_drv,
627b3a88b52SEtienne Carriere 				    const struct dt_device_match *dm)
628b3a88b52SEtienne Carriere {
629b3a88b52SEtienne Carriere 	const char __maybe_unused *node_name = fdt_get_name(fdt, node, NULL);
630b3a88b52SEtienne Carriere 	const char __maybe_unused *drv_name = dt_drv->name;
631b3a88b52SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
632b3a88b52SEtienne Carriere 	struct dt_driver_probe elt_new = {
633b3a88b52SEtienne Carriere 		.dm = dm,
634b3a88b52SEtienne Carriere 		.dt_drv = dt_drv,
635b3a88b52SEtienne Carriere 		.nodeoffset = node,
636b3a88b52SEtienne Carriere 		.type = dt_drv->type,
637b3a88b52SEtienne Carriere 	};
638b3a88b52SEtienne Carriere 
639b3a88b52SEtienne Carriere 	/* If node/type found in probe list or ready list, nothing to do */
640b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_probe_list, link)
641b3a88b52SEtienne Carriere 		if (!driver_probe_compare(&elt_new, elt))
642b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
643b3a88b52SEtienne Carriere 
644b3a88b52SEtienne Carriere 	TAILQ_FOREACH(elt, &dt_driver_ready_list, link)
645b3a88b52SEtienne Carriere 		if (!driver_probe_compare(&elt_new, elt))
646b3a88b52SEtienne Carriere 			return TEE_SUCCESS;
647b3a88b52SEtienne Carriere 
648b3a88b52SEtienne Carriere 	elt = malloc(sizeof(*elt));
649b3a88b52SEtienne Carriere 	if (!elt)
650b3a88b52SEtienne Carriere 		return TEE_ERROR_OUT_OF_MEMORY;
651b3a88b52SEtienne Carriere 
652b3a88b52SEtienne Carriere 	DMSG("element: %s on node %s", node_name, drv_name);
653b3a88b52SEtienne Carriere 
654b3a88b52SEtienne Carriere 	memcpy(elt, &elt_new, sizeof(*elt));
655b3a88b52SEtienne Carriere 
656b3a88b52SEtienne Carriere 	added_node = true;
657b3a88b52SEtienne Carriere 
658b3a88b52SEtienne Carriere 	TAILQ_INSERT_TAIL(&dt_driver_probe_list, elt, link);
659b3a88b52SEtienne Carriere 
660b3a88b52SEtienne Carriere 	/* Hack here for TRACE_DEBUG messages on current probe list elements */
661b3a88b52SEtienne Carriere 	if (TRACE_LEVEL >= TRACE_FLOW)
662b3a88b52SEtienne Carriere 		print_probe_list(fdt);
663b3a88b52SEtienne Carriere 
664b3a88b52SEtienne Carriere 	return TEE_SUCCESS;
665b3a88b52SEtienne Carriere }
666b3a88b52SEtienne Carriere 
667b3a88b52SEtienne Carriere /*
668b3a88b52SEtienne Carriere  * Add a node to the probe list if a dt_driver matches target compatible.
669b3a88b52SEtienne Carriere  *
670b3a88b52SEtienne Carriere  * If @type is DT_DRIVER_ANY, probe list can hold only 1 driver to probe for
671b3a88b52SEtienne Carriere  * the node. A node may probe several drivers if have a unique driver type.
672b3a88b52SEtienne Carriere  *
673b3a88b52SEtienne Carriere  * Return TEE_SUCCESS if compatible found
674b3a88b52SEtienne Carriere  *	  TEE_ERROR_ITEM_NOT_FOUND if no matching driver
675b3a88b52SEtienne Carriere  *	  TEE_ERROR_OUT_OF_MEMORY if heap is exhausted
676b3a88b52SEtienne Carriere  */
677b3a88b52SEtienne Carriere static TEE_Result add_probe_node_by_compat(const void *fdt, int node,
678b3a88b52SEtienne Carriere 					   const char *compat)
679b3a88b52SEtienne Carriere {
680b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_ITEM_NOT_FOUND;
681b3a88b52SEtienne Carriere 	const struct dt_driver *dt_drv = NULL;
682b3a88b52SEtienne Carriere 	const struct dt_device_match *dm = NULL;
683b3a88b52SEtienne Carriere 	uint32_t found_types = 0;
684b3a88b52SEtienne Carriere 
685b3a88b52SEtienne Carriere 	for_each_dt_driver(dt_drv) {
686b3a88b52SEtienne Carriere 		for (dm = dt_drv->match_table; dm && dm->compatible; dm++) {
687b3a88b52SEtienne Carriere 			if (strcmp(dm->compatible, compat) == 0) {
688b3a88b52SEtienne Carriere 				assert(dt_drv->type < 32);
689b3a88b52SEtienne Carriere 
690b3a88b52SEtienne Carriere 				res = add_node_to_probe(fdt, node, dt_drv, dm);
691b3a88b52SEtienne Carriere 				if (res)
692b3a88b52SEtienne Carriere 					return res;
693b3a88b52SEtienne Carriere 
694b3a88b52SEtienne Carriere 				if (found_types & BIT(dt_drv->type)) {
695b3a88b52SEtienne Carriere 					EMSG("Driver %s multi hit on type %u",
696b3a88b52SEtienne Carriere 					     dt_drv->name, dt_drv->type);
697b3a88b52SEtienne Carriere 					panic();
698b3a88b52SEtienne Carriere 				}
699b3a88b52SEtienne Carriere 				found_types |= BIT(dt_drv->type);
700b3a88b52SEtienne Carriere 
701b3a88b52SEtienne Carriere 				/* Matching found for this driver, try next */
702b3a88b52SEtienne Carriere 				break;
703b3a88b52SEtienne Carriere 			}
704b3a88b52SEtienne Carriere 		}
705b3a88b52SEtienne Carriere 	}
706b3a88b52SEtienne Carriere 
707b3a88b52SEtienne Carriere 	return res;
708b3a88b52SEtienne Carriere }
709b3a88b52SEtienne Carriere 
710b3a88b52SEtienne Carriere /*
711b3a88b52SEtienne Carriere  * Add the node to the probe list if matching compatible drivers are found.
712b3a88b52SEtienne Carriere  * Follow node's compatible property list ordering to find matching driver.
713b3a88b52SEtienne Carriere  */
714b3a88b52SEtienne Carriere TEE_Result dt_driver_maybe_add_probe_node(const void *fdt, int node)
715b3a88b52SEtienne Carriere {
716b3a88b52SEtienne Carriere 	int idx = 0;
717b3a88b52SEtienne Carriere 	int len = 0;
718b3a88b52SEtienne Carriere 	int count = 0;
719b3a88b52SEtienne Carriere 	const char *compat = NULL;
720b3a88b52SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
721b3a88b52SEtienne Carriere 
722f354a5d8SGatien Chevallier 	if (fdt_get_status(fdt, node) == DT_STATUS_DISABLED)
723b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
724b3a88b52SEtienne Carriere 
725b3a88b52SEtienne Carriere 	count = fdt_stringlist_count(fdt, node, "compatible");
726b3a88b52SEtienne Carriere 	if (count < 0)
727b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
728b3a88b52SEtienne Carriere 
729b3a88b52SEtienne Carriere 	for (idx = 0; idx < count; idx++) {
730b3a88b52SEtienne Carriere 		compat = fdt_stringlist_get(fdt, node, "compatible", idx, &len);
731b3a88b52SEtienne Carriere 		assert(compat && len > 0);
732b3a88b52SEtienne Carriere 
733b3a88b52SEtienne Carriere 		res = add_probe_node_by_compat(fdt, node, compat);
734b3a88b52SEtienne Carriere 
735b3a88b52SEtienne Carriere 		/* Stop lookup if something was found */
736b3a88b52SEtienne Carriere 		if (res != TEE_ERROR_ITEM_NOT_FOUND)
737b3a88b52SEtienne Carriere 			return res;
738b3a88b52SEtienne Carriere 	}
739b3a88b52SEtienne Carriere 
740b3a88b52SEtienne Carriere 	return TEE_SUCCESS;
741b3a88b52SEtienne Carriere }
742b3a88b52SEtienne Carriere 
743b3a88b52SEtienne Carriere static void parse_node(const void *fdt, int node)
744b3a88b52SEtienne Carriere {
745b3a88b52SEtienne Carriere 	TEE_Result __maybe_unused res = TEE_ERROR_GENERIC;
746b3a88b52SEtienne Carriere 	int subnode = 0;
747b3a88b52SEtienne Carriere 
748b3a88b52SEtienne Carriere 	fdt_for_each_subnode(subnode, fdt, node) {
749b3a88b52SEtienne Carriere 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
750b3a88b52SEtienne Carriere 		if (res) {
751b3a88b52SEtienne Carriere 			EMSG("Failed on node %s with %#"PRIx32,
752b3a88b52SEtienne Carriere 			     fdt_get_name(fdt, subnode, NULL), res);
753b3a88b52SEtienne Carriere 			panic();
754b3a88b52SEtienne Carriere 		}
755b3a88b52SEtienne Carriere 
756b3a88b52SEtienne Carriere 		/*
757b3a88b52SEtienne Carriere 		 * Rescursively parse the FDT, skipping disabled nodes.
758b3a88b52SEtienne Carriere 		 * FDT is expected reliable and core shall have sufficient
759b3a88b52SEtienne Carriere 		 * stack depth to possibly parse all DT nodes.
760b3a88b52SEtienne Carriere 		 */
761b3a88b52SEtienne Carriere 		if (IS_ENABLED(CFG_DRIVERS_DT_RECURSIVE_PROBE)) {
762f354a5d8SGatien Chevallier 			if (fdt_get_status(fdt, subnode) == DT_STATUS_DISABLED)
763b3a88b52SEtienne Carriere 				continue;
764b3a88b52SEtienne Carriere 
765b3a88b52SEtienne Carriere 			parse_node(fdt, subnode);
766b3a88b52SEtienne Carriere 		}
767b3a88b52SEtienne Carriere 	}
768b3a88b52SEtienne Carriere }
769b3a88b52SEtienne Carriere 
770b3a88b52SEtienne Carriere /*
771b3a88b52SEtienne Carriere  * Parse FDT for nodes and save in probe list the node for which a dt_driver
772b3a88b52SEtienne Carriere  * matches node's compatible property.
773b3a88b52SEtienne Carriere  */
774c9bd3375SEtienne Carriere static TEE_Result probe_dt_drivers_early(void)
775b3a88b52SEtienne Carriere {
776c9bd3375SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
777b3a88b52SEtienne Carriere 	const void *fdt = NULL;
778b3a88b52SEtienne Carriere 
779d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
780d2289450SVesa Jääskeläinen 	if (!fdt)
781b3a88b52SEtienne Carriere 		return TEE_SUCCESS;
782b3a88b52SEtienne Carriere 
783b3a88b52SEtienne Carriere 	parse_node(fdt, fdt_path_offset(fdt, "/"));
784b3a88b52SEtienne Carriere 
785c9bd3375SEtienne Carriere 	res = process_probe_list(fdt);
786c9bd3375SEtienne Carriere 	if (res == TEE_ERROR_DEFER_DRIVER_INIT) {
787c9bd3375SEtienne Carriere 		DMSG("Deferred drivers probing");
788c9bd3375SEtienne Carriere 		print_probe_list(fdt);
789c9bd3375SEtienne Carriere 		res = TEE_SUCCESS;
790b3a88b52SEtienne Carriere 	}
791b3a88b52SEtienne Carriere 
792c9bd3375SEtienne Carriere 	return res;
793c9bd3375SEtienne Carriere }
794c9bd3375SEtienne Carriere 
795c9bd3375SEtienne Carriere static TEE_Result probe_dt_drivers(void)
796c9bd3375SEtienne Carriere {
797c9bd3375SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
798c9bd3375SEtienne Carriere 	const void *fdt = NULL;
799c9bd3375SEtienne Carriere 
800d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
801d2289450SVesa Jääskeläinen 	if (!fdt)
802c9bd3375SEtienne Carriere 		return TEE_SUCCESS;
803c9bd3375SEtienne Carriere 
804c9bd3375SEtienne Carriere 	res = process_probe_list(fdt);
805c9bd3375SEtienne Carriere 	if (res || !TAILQ_EMPTY(&dt_driver_failed_list)) {
806c9bd3375SEtienne Carriere 		EMSG("Probe sequence result: %#"PRIx32, res);
807c9bd3375SEtienne Carriere 		print_probe_list(fdt);
808c9bd3375SEtienne Carriere 		panic();
8098f3e49faSGatien Chevallier 	}
810c9bd3375SEtienne Carriere 
811c9bd3375SEtienne Carriere 	return TEE_SUCCESS;
812c9bd3375SEtienne Carriere }
813c9bd3375SEtienne Carriere 
814c9bd3375SEtienne Carriere early_init_late(probe_dt_drivers_early);
815b3a88b52SEtienne Carriere driver_init(probe_dt_drivers);
816ea29d587SEtienne Carriere 
817f21b3ed5SEtienne Carriere static TEE_Result release_probe_lists(void)
818f21b3ed5SEtienne Carriere {
819f21b3ed5SEtienne Carriere 	struct dt_driver_probe *elt = NULL;
820f21b3ed5SEtienne Carriere 	struct dt_driver_probe *next = NULL;
821115944b5SEtienne Carriere 	struct dt_driver_provider *prov = NULL;
822115944b5SEtienne Carriere 	struct dt_driver_provider *next_prov = NULL;
823d2289450SVesa Jääskeläinen 	const void *fdt = NULL;
824f21b3ed5SEtienne Carriere 
825d2289450SVesa Jääskeläinen 	fdt = get_secure_dt();
826d2289450SVesa Jääskeläinen 	if (!fdt)
827f21b3ed5SEtienne Carriere 		return TEE_SUCCESS;
828f21b3ed5SEtienne Carriere 
829f21b3ed5SEtienne Carriere 	assert(fdt && TAILQ_EMPTY(&dt_driver_probe_list));
830f21b3ed5SEtienne Carriere 
831115944b5SEtienne Carriere 	TAILQ_FOREACH_SAFE(elt, &dt_driver_ready_list, link, next)
832f21b3ed5SEtienne Carriere 		free(elt);
833115944b5SEtienne Carriere 
834736cb9e1SEtienne Carriere 	TAILQ_FOREACH_SAFE(elt, &dt_driver_failed_list, link, next)
835736cb9e1SEtienne Carriere 	       free(elt);
836736cb9e1SEtienne Carriere 
837115944b5SEtienne Carriere 	SLIST_FOREACH_SAFE(prov, &dt_driver_provider_list, link, next_prov)
838115944b5SEtienne Carriere 	       free(prov);
839f21b3ed5SEtienne Carriere 
840f21b3ed5SEtienne Carriere 	return TEE_SUCCESS;
841f21b3ed5SEtienne Carriere }
842f21b3ed5SEtienne Carriere 
843f21b3ed5SEtienne Carriere release_init_resource(release_probe_lists);
844f21b3ed5SEtienne Carriere 
845ea29d587SEtienne Carriere /*
846ea29d587SEtienne Carriere  * Simple bus support: handy to parse subnodes
847ea29d587SEtienne Carriere  */
848ea29d587SEtienne Carriere static TEE_Result simple_bus_probe(const void *fdt, int node,
849ea29d587SEtienne Carriere 				   const void *compat_data __unused)
850ea29d587SEtienne Carriere {
851ea29d587SEtienne Carriere 	TEE_Result res = TEE_ERROR_GENERIC;
852ea29d587SEtienne Carriere 	int subnode = 0;
853ea29d587SEtienne Carriere 
854ea29d587SEtienne Carriere 	fdt_for_each_subnode(subnode, fdt, node) {
855ea29d587SEtienne Carriere 		res = dt_driver_maybe_add_probe_node(fdt, subnode);
856ea29d587SEtienne Carriere 		if (res) {
857ea29d587SEtienne Carriere 			EMSG("Failed on node %s with %#"PRIx32,
858ea29d587SEtienne Carriere 			     fdt_get_name(fdt, subnode, NULL), res);
859ea29d587SEtienne Carriere 			panic();
860ea29d587SEtienne Carriere 		}
861ea29d587SEtienne Carriere 	}
862ea29d587SEtienne Carriere 
863ea29d587SEtienne Carriere 	return TEE_SUCCESS;
864ea29d587SEtienne Carriere }
865ea29d587SEtienne Carriere 
866ea29d587SEtienne Carriere static const struct dt_device_match simple_bus_match_table[] = {
867ea29d587SEtienne Carriere 	{ .compatible = "simple-bus" },
868ea29d587SEtienne Carriere 	{ }
869ea29d587SEtienne Carriere };
870ea29d587SEtienne Carriere 
87161bdedeaSJerome Forissier DEFINE_DT_DRIVER(simple_bus_dt_driver) = {
872ea29d587SEtienne Carriere 	.name = "simple-bus",
873ea29d587SEtienne Carriere 	.match_table = simple_bus_match_table,
874ea29d587SEtienne Carriere 	.probe = simple_bus_probe,
875ea29d587SEtienne Carriere };
876