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