1 /*
2  * Copyright (c) 2019-2022, Arm Limited. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <assert.h>
8 
9 #include <common/debug.h>
10 #include <common/fdt_wrappers.h>
11 #include <lib/fconf/fconf_dyn_cfg_getter.h>
12 #include <lib/object_pool.h>
13 #include <libfdt.h>
14 
15 #include <platform_def.h>
16 
17 /* We currently use FW, TB_FW, SOC_FW, TOS_FW, NT_FW and HW configs  */
18 #define MAX_DTB_INFO	U(6)
19 /*
20  * Compile time assert if FW_CONFIG_ID is 0 which is more
21  * unlikely as 0 is a valid image ID for FIP as per the current
22  * code but still to avoid code breakage in case of unlikely
23  * event when image IDs get changed.
24  */
25 CASSERT(FW_CONFIG_ID != U(0), assert_invalid_fw_config_id);
26 
27 static struct dyn_cfg_dtb_info_t dtb_infos[MAX_DTB_INFO];
28 static OBJECT_POOL_ARRAY(dtb_info_pool, dtb_infos);
29 
30 /*
31  * This function is used to alloc memory for config information from
32  * global pool and set the configuration information.
33  */
set_config_info(uintptr_t config_addr,uintptr_t ns_config_addr,uint32_t config_max_size,unsigned int config_id)34 void set_config_info(uintptr_t config_addr, uintptr_t ns_config_addr,
35 		     uint32_t config_max_size,
36 		     unsigned int config_id)
37 {
38 	struct dyn_cfg_dtb_info_t *dtb_info;
39 
40 	dtb_info = pool_alloc(&dtb_info_pool);
41 	dtb_info->config_addr = config_addr;
42 	dtb_info->ns_config_addr = ns_config_addr;
43 	dtb_info->config_max_size = config_max_size;
44 	dtb_info->config_id = config_id;
45 }
46 
47 /* Get index of the config_id image */
dyn_cfg_dtb_info_get_index(unsigned int config_id)48 unsigned int dyn_cfg_dtb_info_get_index(unsigned int config_id)
49 {
50 	unsigned int index;
51 
52 	/* Positions index to the proper config-id */
53 	for (index = 0U; index < MAX_DTB_INFO; index++) {
54 		if (dtb_infos[index].config_id == config_id) {
55 			return index;
56 		}
57 	}
58 
59 	return FCONF_INVALID_IDX;
60 }
61 
dyn_cfg_dtb_info_getter(unsigned int config_id)62 struct dyn_cfg_dtb_info_t *dyn_cfg_dtb_info_getter(unsigned int config_id)
63 {
64 	/* Positions index to the proper config-id */
65 	unsigned int index = dyn_cfg_dtb_info_get_index(config_id);
66 
67 	if (index < MAX_DTB_INFO) {
68 		return &dtb_infos[index];
69 	}
70 
71 	WARN("FCONF: Invalid config id %u\n", config_id);
72 
73 	return NULL;
74 }
75 
fconf_populate_dtb_registry(uintptr_t config)76 int fconf_populate_dtb_registry(uintptr_t config)
77 {
78 	int rc;
79 	int node, child;
80 
81 	/* As libfdt use void *, we can't avoid this cast */
82 	const void *dtb = (void *)config;
83 
84 	/*
85 	 * In case of BL1, fw_config dtb information is already
86 	 * populated in global dtb_infos array by 'set_fw_config_info'
87 	 * function, Below check is present to avoid re-population of
88 	 * fw_config information.
89 	 *
90 	 * Other BLs, satisfy below check and populate fw_config information
91 	 * in global dtb_infos array.
92 	 */
93 	if (dtb_infos[0].config_id == 0U) {
94 		uint32_t config_max_size = fdt_totalsize(dtb);
95 		set_config_info(config, ~0UL, config_max_size, FW_CONFIG_ID);
96 	}
97 
98 	/* Find the node offset point to "fconf,dyn_cfg-dtb_registry" compatible property */
99 	const char *compatible_str = "fconf,dyn_cfg-dtb_registry";
100 	node = fdt_node_offset_by_compatible(dtb, -1, compatible_str);
101 	if (node < 0) {
102 		ERROR("FCONF: Can't find %s compatible in dtb\n", compatible_str);
103 		return node;
104 	}
105 
106 	fdt_for_each_subnode(child, dtb, node) {
107 		uint32_t config_max_size, config_id;
108 		uintptr_t config_addr;
109 		uintptr_t ns_config_addr = ~0UL;
110 		uint64_t val64;
111 
112 		/* Read configuration dtb information */
113 		rc = fdt_read_uint64(dtb, child, "load-address", &val64);
114 		if (rc < 0) {
115 			ERROR("FCONF: Incomplete configuration property in dtb-registry.\n");
116 			return rc;
117 		}
118 		config_addr = (uintptr_t)val64;
119 
120 		rc = fdt_read_uint32(dtb, child, "max-size", &config_max_size);
121 		if (rc < 0) {
122 			ERROR("FCONF: Incomplete configuration property in dtb-registry.\n");
123 			return rc;
124 		}
125 
126 		rc = fdt_read_uint32(dtb, child, "id", &config_id);
127 		if (rc < 0) {
128 			ERROR("FCONF: Incomplete configuration property in dtb-registry.\n");
129 			return rc;
130 		}
131 
132 		VERBOSE("FCONF: dyn_cfg.dtb_registry cell found with:\n");
133 		VERBOSE("\tload-address = %lx\n", config_addr);
134 		VERBOSE("\tmax-size = 0x%x\n", config_max_size);
135 		VERBOSE("\tconfig-id = %u\n", config_id);
136 
137 		rc = fdt_read_uint64(dtb, child, "ns-load-address", &val64);
138 		if (rc == 0) {
139 			ns_config_addr = (uintptr_t)val64;
140 			VERBOSE("\tns-load-address = %lx\n", ns_config_addr);
141 		}
142 
143 		set_config_info(config_addr, ns_config_addr, config_max_size,
144 				config_id);
145 	}
146 
147 	if ((child < 0) && (child != -FDT_ERR_NOTFOUND)) {
148 		ERROR("%d: fdt_for_each_subnode(): %d\n", __LINE__, node);
149 		return child;
150 	}
151 
152 	return 0;
153 }
154 
155 FCONF_REGISTER_POPULATOR(FW_CONFIG, dyn_cfg, fconf_populate_dtb_registry);
156