1 /*
2  * Copyright (c) 2019-2020, 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  */
set_config_info(uintptr_t config_addr,uint32_t config_max_size,unsigned int config_id)32 void set_config_info(uintptr_t config_addr, uint32_t config_max_size,
33 			unsigned int config_id)
34 {
35 	struct dyn_cfg_dtb_info_t *dtb_info;
36 
37 	dtb_info = pool_alloc(&dtb_info_pool);
38 	dtb_info->config_addr = config_addr;
39 	dtb_info->config_max_size = config_max_size;
40 	dtb_info->config_id = config_id;
41 }
42 
dyn_cfg_dtb_info_getter(unsigned int config_id)43 struct dyn_cfg_dtb_info_t *dyn_cfg_dtb_info_getter(unsigned int config_id)
44 {
45 	unsigned int index;
46 
47 	/* Positions index to the proper config-id */
48 	for (index = 0U; index < MAX_DTB_INFO; index++) {
49 		if (dtb_infos[index].config_id == config_id) {
50 			return &dtb_infos[index];
51 		}
52 	}
53 
54 	WARN("FCONF: Invalid config id %u\n", config_id);
55 
56 	return NULL;
57 }
58 
fconf_populate_dtb_registry(uintptr_t config)59 int fconf_populate_dtb_registry(uintptr_t config)
60 {
61 	int rc;
62 	int node, child;
63 
64 	/* As libfdt use void *, we can't avoid this cast */
65 	const void *dtb = (void *)config;
66 
67 	/*
68 	 * In case of BL1, fw_config dtb information is already
69 	 * populated in global dtb_infos array by 'set_fw_config_info'
70 	 * function, Below check is present to avoid re-population of
71 	 * fw_config information.
72 	 *
73 	 * Other BLs, satisfy below check and populate fw_config information
74 	 * in global dtb_infos array.
75 	 */
76 	if (dtb_infos[0].config_id == 0U) {
77 		uint32_t config_max_size = fdt_totalsize(dtb);
78 		set_config_info(config, config_max_size, FW_CONFIG_ID);
79 	}
80 
81 	/* Find the node offset point to "fconf,dyn_cfg-dtb_registry" compatible property */
82 	const char *compatible_str = "fconf,dyn_cfg-dtb_registry";
83 	node = fdt_node_offset_by_compatible(dtb, -1, compatible_str);
84 	if (node < 0) {
85 		ERROR("FCONF: Can't find %s compatible in dtb\n", compatible_str);
86 		return node;
87 	}
88 
89 	fdt_for_each_subnode(child, dtb, node) {
90 		uint32_t config_max_size, config_id;
91 		uintptr_t config_addr;
92 		uint64_t val64;
93 
94 		/* Read configuration dtb information */
95 		rc = fdt_read_uint64(dtb, child, "load-address", &val64);
96 		if (rc < 0) {
97 			ERROR("FCONF: Incomplete configuration property in dtb-registry.\n");
98 			return rc;
99 		}
100 		config_addr = (uintptr_t)val64;
101 
102 		rc = fdt_read_uint32(dtb, child, "max-size", &config_max_size);
103 		if (rc < 0) {
104 			ERROR("FCONF: Incomplete configuration property in dtb-registry.\n");
105 			return rc;
106 		}
107 
108 		rc = fdt_read_uint32(dtb, child, "id", &config_id);
109 		if (rc < 0) {
110 			ERROR("FCONF: Incomplete configuration property in dtb-registry.\n");
111 			return rc;
112 		}
113 
114 		VERBOSE("FCONF: dyn_cfg.dtb_registry cell found with:\n");
115 		VERBOSE("\tload-address = %lx\n", config_addr);
116 		VERBOSE("\tmax-size = 0x%x\n", config_max_size);
117 		VERBOSE("\tconfig-id = %u\n", config_id);
118 
119 		set_config_info(config_addr, config_max_size, config_id);
120 	}
121 
122 	if ((child < 0) && (child != -FDT_ERR_NOTFOUND)) {
123 		ERROR("%d: fdt_for_each_subnode(): %d\n", __LINE__, node);
124 		return child;
125 	}
126 
127 	return 0;
128 }
129 
130 FCONF_REGISTER_POPULATOR(FW_CONFIG, dyn_cfg, fconf_populate_dtb_registry);
131