xref: /optee_os/core/pta/bcm/elog.c (revision 7fb525f1f8a6709ba8adc89b1d2f2995dae26803)
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		0x100000
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 	src_vaddr = (vaddr_t)phys_to_virt((uintptr_t)src_paddr + offset,
93 					  MEM_AREA_RAM_SEC);
94 
95 	buf = params[0].memref.buffer;
96 	sz = params[0].memref.size;
97 
98 	memcpy((char *)src_vaddr, buf, sz);
99 
100 	cache_op_inner(DCACHE_AREA_CLEAN, (void *)src_vaddr, sz);
101 
102 	return res;
103 }
104 
105 static uint32_t get_dump_data(vaddr_t src, TEE_Param params[TEE_NUM_PARAMS])
106 {
107 	char *buf = NULL;
108 	uint32_t sz = 0;
109 
110 	buf = params[0].memref.buffer;
111 	sz = params[0].memref.size;
112 
113 	/*
114 	 * If request size exceeds default buf size
115 	 * override request size to default DEFAULT_ELOG_BUFFER_SIZE
116 	 */
117 	if (sz > DEFAULT_ELOG_BUFFER_SIZE)
118 		sz = DEFAULT_ELOG_BUFFER_SIZE;
119 
120 	DMSG("buf %p sz 0x%x", buf, sz);
121 
122 	memcpy(buf, (char *)src, sz);
123 
124 	params[0].memref.size = sz;
125 
126 	return sz;
127 }
128 
129 /* Copy nitro crash dump data */
130 static TEE_Result pta_elog_nitro_crash_dump(uint32_t param_types,
131 					    TEE_Param params[TEE_NUM_PARAMS])
132 {
133 	TEE_Result res = TEE_SUCCESS;
134 	paddr_t src_paddr = BCM_NITRO_CRASH_DUMP_BASE_ADDR;
135 	vaddr_t src_vaddr = 0;
136 	uint32_t offset = 0;
137 	uint32_t exp_param_types = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_OUTPUT,
138 						   TEE_PARAM_TYPE_VALUE_INPUT,
139 						   TEE_PARAM_TYPE_NONE,
140 						   TEE_PARAM_TYPE_NONE);
141 
142 	if (exp_param_types != param_types) {
143 		EMSG("Invalid Param types");
144 		return TEE_ERROR_BAD_PARAMETERS;
145 	}
146 
147 	offset = params[1].value.a;
148 
149 	/*
150 	 * Check if offset is within memory range reserved for nitro crash dump
151 	 * minus default size of buffer
152 	 */
153 	if (offset > MAX_NITRO_CRASH_DUMP_MEM_SIZE - DEFAULT_ELOG_BUFFER_SIZE) {
154 		EMSG("Invalid access");
155 		return TEE_ERROR_ACCESS_DENIED;
156 	}
157 
158 	src_vaddr = (vaddr_t)phys_to_virt((uintptr_t)src_paddr + offset,
159 					  MEM_AREA_RAM_SEC);
160 
161 	/* TODO : check if NITRO_CRASH_DUMP is available */
162 
163 	cache_op_inner(DCACHE_AREA_INVALIDATE,
164 		       (void *)src_vaddr, DEFAULT_ELOG_BUFFER_SIZE);
165 
166 	get_dump_data(src_vaddr, params);
167 
168 	return res;
169 }
170 
171 /* Copy soc error log data */
172 static TEE_Result pta_elog_dump(uint32_t param_types,
173 				TEE_Param params[TEE_NUM_PARAMS])
174 {
175 	TEE_Result res = TEE_SUCCESS;
176 	paddr_t src_paddr = CFG_BCM_ELOG_BASE;
177 	vaddr_t src_vaddr = 0;
178 	uint32_t exp_param_types = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_OUTPUT,
179 						   TEE_PARAM_TYPE_VALUE_INPUT,
180 						   TEE_PARAM_TYPE_NONE,
181 						   TEE_PARAM_TYPE_NONE);
182 
183 	if (exp_param_types != param_types) {
184 		EMSG("Invalid Param types");
185 		return TEE_ERROR_BAD_PARAMETERS;
186 	}
187 
188 	src_vaddr = (vaddr_t)phys_to_virt(src_paddr, MEM_AREA_RAM_NSEC);
189 
190 	/* Validate if Error logs are present */
191 	if ((*(uint32_t *)src_vaddr) != BCM_ELOG_GLOBAL_METADATA_SIG) {
192 		EMSG("Elog Not setup");
193 		return TEE_ERROR_NOT_SUPPORTED;
194 	}
195 
196 	get_dump_data(src_vaddr, params);
197 
198 	return res;
199 }
200 
201 static TEE_Result invoke_command(void *session_context __unused,
202 				 uint32_t cmd_id,
203 				 uint32_t param_types,
204 				 TEE_Param params[TEE_NUM_PARAMS])
205 {
206 	TEE_Result res = TEE_SUCCESS;
207 
208 	DMSG("command entry point[%d] for \"%s\"", cmd_id, ELOG_TA_NAME);
209 
210 	switch (cmd_id) {
211 	case PTA_BCM_ELOG_CMD_GET_ELOG_MEM:
212 		res = pta_elog_dump(param_types, params);
213 		break;
214 	case PTA_BCM_ELOG_CMD_GET_NITRO_CRASH_DUMP:
215 		res = pta_elog_nitro_crash_dump(param_types, params);
216 		break;
217 	case PTA_BCM_ELOG_CMD_LOAD_NITRO_FW:
218 		res = pta_elog_load_nitro_fw(param_types, params);
219 		break;
220 	default:
221 		EMSG("cmd: %d Not supported %s", cmd_id, ELOG_TA_NAME);
222 		res = TEE_ERROR_NOT_SUPPORTED;
223 		break;
224 	}
225 
226 	return res;
227 }
228 
229 pseudo_ta_register(.uuid = ELOG_SERVICE_UUID,
230 		   .name = ELOG_TA_NAME,
231 		   .flags = PTA_DEFAULT_FLAGS,
232 		   .invoke_command_entry_point = invoke_command);
233