xref: /optee_os/core/pta/bcm/elog.c (revision 2391d619a7d07dbc2526a2a6b8ba01a44589becb)
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3  * Copyright 2019 Broadcom.
4  */
5 
6 #include <drivers/bcm/bnxt.h>
7 #include <io.h>
8 #include <kernel/pseudo_ta.h>
9 #include <mm/core_memprot.h>
10 #include <mm/core_mmu.h>
11 #include <string.h>
12 #include <trace.h>
13 
14 #define ELOG_SERVICE_UUID \
15 		{ 0x6272636D, 0x2019, 0x0701, \
16 		{ 0x42, 0x43, 0x4D, 0x5F, 0x45, 0x4C, 0x4F, 0x47 } }
17 
18 #define ELOG_TA_NAME			"pta_bcm_elog.ta"
19 
20 #define BCM_NITRO_FW_LOAD_ADDR			0x8ae00000
21 #define BCM_NITRO_CRASH_DUMP_BASE_ADDR		0x8b000000
22 
23 /* Default ELOG buffer size 1MB */
24 #define DEFAULT_ELOG_BUFFER_SIZE		0x100000U
25 
26 /*
27  * Get Error log memory dump
28  *
29  * [out]    memref[0]:    Destination
30  * [in]     value[1].a:   Offset
31  */
32 #define PTA_BCM_ELOG_CMD_GET_ELOG_MEM		1
33 
34 /*
35  * Get nitro crash_dump memory
36  *
37  * [out]    memref[0]:    Destination
38  * [in]     value[1].a:   Offset
39  */
40 #define PTA_BCM_ELOG_CMD_GET_NITRO_CRASH_DUMP	2
41 
42 /*
43  * Load nitro firmware memory
44  *
45  * [in]     memref[0]:    Nitro f/w image data
46  * [in]     value[1].a:   Offset for loading f/w image
47  * [in]     value[2].a:   Firmware image size
48  */
49 #define PTA_BCM_ELOG_CMD_LOAD_NITRO_FW		3
50 
51 #define BCM_ELOG_GLOBAL_METADATA_SIG		0x45524c47
52 
53 #define MAX_NITRO_CRASH_DUMP_MEM_SIZE		0x2000000
54 #define MAX_NITRO_FW_LOAD_MEM_SIZE		0x200000
55 
56 /* Load Nitro fw image to SEC DDR memory */
57 static TEE_Result pta_elog_load_nitro_fw(uint32_t param_types,
58 					 TEE_Param params[TEE_NUM_PARAMS])
59 {
60 	TEE_Result res = TEE_SUCCESS;
61 	paddr_t src_paddr = BCM_NITRO_FW_LOAD_ADDR + BNXT_IMG_SECMEM_OFFSET;
62 	vaddr_t src_vaddr = 0;
63 	uint32_t offset = 0, sz = 0;
64 	char *buf = NULL;
65 	uint32_t exp_param_types = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INPUT,
66 						   TEE_PARAM_TYPE_VALUE_INPUT,
67 						   TEE_PARAM_TYPE_VALUE_INPUT,
68 						   TEE_PARAM_TYPE_NONE);
69 
70 	if (exp_param_types != param_types) {
71 		EMSG("Invalid Param types");
72 		return TEE_ERROR_BAD_PARAMETERS;
73 	}
74 
75 	/* Check if firmware file size exceeds reserved memory size */
76 	if (params[2].value.a > MAX_NITRO_FW_LOAD_MEM_SIZE) {
77 		EMSG("Invalid access");
78 		return TEE_ERROR_EXCESS_DATA;
79 	}
80 
81 	offset = params[1].value.a;
82 
83 	/*
84 	 * Check if offset is within memory range reserved for nitro firmware
85 	 * minus default size of buffer
86 	 */
87 	if (offset > MAX_NITRO_FW_LOAD_MEM_SIZE - DEFAULT_ELOG_BUFFER_SIZE) {
88 		EMSG("Invalid access");
89 		return TEE_ERROR_ACCESS_DENIED;
90 	}
91 
92 	buf = params[0].memref.buffer;
93 	sz = params[0].memref.size;
94 
95 	src_vaddr = (vaddr_t)phys_to_virt((uintptr_t)src_paddr + offset,
96 					  MEM_AREA_RAM_SEC, sz);
97 	if (!src_vaddr) {
98 		EMSG("Not enough memory mapped");
99 		return TEE_ERROR_BAD_PARAMETERS;
100 	}
101 
102 	memcpy((char *)src_vaddr, buf, sz);
103 
104 	cache_op_inner(DCACHE_AREA_CLEAN, (void *)src_vaddr, sz);
105 
106 	return res;
107 }
108 
109 static uint32_t get_dump_data(vaddr_t src, TEE_Param params[TEE_NUM_PARAMS])
110 {
111 	char *buf = NULL;
112 	uint32_t sz = 0;
113 
114 	buf = params[0].memref.buffer;
115 	sz = params[0].memref.size;
116 
117 	/*
118 	 * If request size exceeds default buf size
119 	 * override request size to default DEFAULT_ELOG_BUFFER_SIZE
120 	 */
121 	if (sz > DEFAULT_ELOG_BUFFER_SIZE)
122 		sz = DEFAULT_ELOG_BUFFER_SIZE;
123 
124 	DMSG("buf %p sz 0x%x", buf, sz);
125 
126 	memcpy(buf, (char *)src, sz);
127 
128 	params[0].memref.size = sz;
129 
130 	return sz;
131 }
132 
133 /* Copy nitro crash dump data */
134 static TEE_Result pta_elog_nitro_crash_dump(uint32_t param_types,
135 					    TEE_Param params[TEE_NUM_PARAMS])
136 {
137 	TEE_Result res = TEE_SUCCESS;
138 	paddr_t src_paddr = BCM_NITRO_CRASH_DUMP_BASE_ADDR;
139 	vaddr_t src_vaddr = 0;
140 	uint32_t offset = 0;
141 	uint32_t exp_param_types = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_OUTPUT,
142 						   TEE_PARAM_TYPE_VALUE_INPUT,
143 						   TEE_PARAM_TYPE_NONE,
144 						   TEE_PARAM_TYPE_NONE);
145 	uint32_t sz = 0;
146 
147 	if (exp_param_types != param_types) {
148 		EMSG("Invalid Param types");
149 		return TEE_ERROR_BAD_PARAMETERS;
150 	}
151 
152 	offset = params[1].value.a;
153 
154 	/*
155 	 * Check if offset is within memory range reserved for nitro crash dump
156 	 * minus default size of buffer
157 	 */
158 	if (offset > MAX_NITRO_CRASH_DUMP_MEM_SIZE - DEFAULT_ELOG_BUFFER_SIZE) {
159 		EMSG("Invalid access");
160 		return TEE_ERROR_ACCESS_DENIED;
161 	}
162 
163 	sz = MIN(params[0].memref.size, DEFAULT_ELOG_BUFFER_SIZE);
164 	src_vaddr = (vaddr_t)phys_to_virt((uintptr_t)src_paddr + offset,
165 					  MEM_AREA_RAM_SEC, sz);
166 	if (!src_vaddr) {
167 		EMSG("Not enough memory mapped");
168 		return TEE_ERROR_BAD_PARAMETERS;
169 	}
170 
171 	/* TODO : check if NITRO_CRASH_DUMP is available */
172 
173 	cache_op_inner(DCACHE_AREA_INVALIDATE, (void *)src_vaddr,
174 		       DEFAULT_ELOG_BUFFER_SIZE);
175 
176 	get_dump_data(src_vaddr, params);
177 
178 	return res;
179 }
180 
181 /* Copy soc error log data */
182 static TEE_Result pta_elog_dump(uint32_t param_types,
183 				TEE_Param params[TEE_NUM_PARAMS])
184 {
185 	TEE_Result res = TEE_SUCCESS;
186 	paddr_t src_paddr = CFG_BCM_ELOG_BASE;
187 	vaddr_t src_vaddr = 0;
188 	uint32_t exp_param_types = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_OUTPUT,
189 						   TEE_PARAM_TYPE_VALUE_INPUT,
190 						   TEE_PARAM_TYPE_NONE,
191 						   TEE_PARAM_TYPE_NONE);
192 	uint32_t sz = 0;
193 
194 	if (exp_param_types != param_types) {
195 		EMSG("Invalid Param types");
196 		return TEE_ERROR_BAD_PARAMETERS;
197 	}
198 
199 	sz = MIN(params[0].memref.size, DEFAULT_ELOG_BUFFER_SIZE);
200 	src_vaddr = (vaddr_t)phys_to_virt(src_paddr, MEM_AREA_RAM_NSEC, sz);
201 	if (!src_vaddr) {
202 		EMSG("Not enough memory mapped");
203 		return TEE_ERROR_BAD_PARAMETERS;
204 	}
205 
206 	/* Validate if Error logs are present */
207 	if ((*(uint32_t *)src_vaddr) != BCM_ELOG_GLOBAL_METADATA_SIG) {
208 		EMSG("Elog Not setup");
209 		return TEE_ERROR_NOT_SUPPORTED;
210 	}
211 
212 	get_dump_data(src_vaddr, params);
213 
214 	return res;
215 }
216 
217 static TEE_Result invoke_command(void *session_context __unused,
218 				 uint32_t cmd_id,
219 				 uint32_t param_types,
220 				 TEE_Param params[TEE_NUM_PARAMS])
221 {
222 	TEE_Result res = TEE_SUCCESS;
223 
224 	DMSG("command entry point[%d] for \"%s\"", cmd_id, ELOG_TA_NAME);
225 
226 	switch (cmd_id) {
227 	case PTA_BCM_ELOG_CMD_GET_ELOG_MEM:
228 		res = pta_elog_dump(param_types, params);
229 		break;
230 	case PTA_BCM_ELOG_CMD_GET_NITRO_CRASH_DUMP:
231 		res = pta_elog_nitro_crash_dump(param_types, params);
232 		break;
233 	case PTA_BCM_ELOG_CMD_LOAD_NITRO_FW:
234 		res = pta_elog_load_nitro_fw(param_types, params);
235 		break;
236 	default:
237 		EMSG("cmd: %d Not supported %s", cmd_id, ELOG_TA_NAME);
238 		res = TEE_ERROR_NOT_SUPPORTED;
239 		break;
240 	}
241 
242 	return res;
243 }
244 
245 pseudo_ta_register(.uuid = ELOG_SERVICE_UUID,
246 		   .name = ELOG_TA_NAME,
247 		   .flags = PTA_DEFAULT_FLAGS,
248 		   .invoke_command_entry_point = invoke_command);
249