xref: /rk3399_ARM-atf/bl32/tsp/tsp_main.c (revision 5f0cdb059d7d5c3a8a834074a7f236b85d014dde)
1 /*
2  * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #include <arch_helpers.h>
32 #include <bl_common.h>
33 #include <bl32.h>
34 #include <debug.h>
35 #include <platform.h>
36 #include <platform_def.h>
37 #include <spinlock.h>
38 #include <stdio.h>
39 #include <tsp.h>
40 
41 /*******************************************************************************
42  * Declarations of linker defined symbols which will help us find the layout
43  * of trusted SRAM
44  ******************************************************************************/
45 extern unsigned long __RO_START__;
46 extern unsigned long __COHERENT_RAM_END__;
47 
48 /*******************************************************************************
49  * Lock to control access to the console
50  ******************************************************************************/
51 spinlock_t console_lock;
52 
53 /*******************************************************************************
54  * Per cpu data structure to populate parameters for an SMC in C code and use
55  * a pointer to this structure in assembler code to populate x0-x7
56  ******************************************************************************/
57 static tsp_args_t tsp_smc_args[PLATFORM_CORE_COUNT];
58 
59 /*******************************************************************************
60  * Per cpu data structure to keep track of TSP activity
61  ******************************************************************************/
62 work_statistics_t tsp_stats[PLATFORM_CORE_COUNT];
63 
64 /*******************************************************************************
65  * The BL32 memory footprint starts with an RO sections and ends
66  * with a section for coherent RAM. Use it to find the memory size
67  ******************************************************************************/
68 #define BL32_TOTAL_BASE (unsigned long)(&__RO_START__)
69 
70 #define BL32_TOTAL_LIMIT (unsigned long)(&__COHERENT_RAM_END__)
71 
72 static tsp_args_t *set_smc_args(uint64_t arg0,
73 			     uint64_t arg1,
74 			     uint64_t arg2,
75 			     uint64_t arg3,
76 			     uint64_t arg4,
77 			     uint64_t arg5,
78 			     uint64_t arg6,
79 			     uint64_t arg7)
80 {
81 	uint64_t mpidr = read_mpidr();
82 	uint32_t linear_id;
83 	tsp_args_t *pcpu_smc_args;
84 
85 	/*
86 	 * Return to Secure Monitor by raising an SMC. The results of the
87 	 * service are passed as an arguments to the SMC
88 	 */
89 	linear_id = platform_get_core_pos(mpidr);
90 	pcpu_smc_args = &tsp_smc_args[linear_id];
91 	write_sp_arg(pcpu_smc_args, TSP_ARG0, arg0);
92 	write_sp_arg(pcpu_smc_args, TSP_ARG1, arg1);
93 	write_sp_arg(pcpu_smc_args, TSP_ARG2, arg2);
94 	write_sp_arg(pcpu_smc_args, TSP_ARG3, arg3);
95 	write_sp_arg(pcpu_smc_args, TSP_ARG4, arg4);
96 	write_sp_arg(pcpu_smc_args, TSP_ARG5, arg5);
97 	write_sp_arg(pcpu_smc_args, TSP_ARG6, arg6);
98 	write_sp_arg(pcpu_smc_args, TSP_ARG7, arg7);
99 
100 	return pcpu_smc_args;
101 }
102 
103 /*******************************************************************************
104  * TSP main entry point where it gets the opportunity to initialize its secure
105  * state/applications. Once the state is initialized, it must return to the
106  * SPD with a pointer to the 'tsp_vector_table' jump table.
107  ******************************************************************************/
108 uint64_t tsp_main(void)
109 {
110 	uint64_t mpidr = read_mpidr();
111 	uint32_t linear_id = platform_get_core_pos(mpidr);
112 
113 	/* Initialize the platform */
114 	bl32_platform_setup();
115 
116 	/* Initialize secure/applications state here */
117 	tsp_generic_timer_start();
118 
119 	/* Update this cpu's statistics */
120 	tsp_stats[linear_id].smc_count++;
121 	tsp_stats[linear_id].eret_count++;
122 	tsp_stats[linear_id].cpu_on_count++;
123 
124 	spin_lock(&console_lock);
125 	printf("TSP %s\n\r", build_message);
126 	INFO("Total memory base : 0x%x\n", (unsigned long)BL32_TOTAL_BASE);
127 	INFO("Total memory size : 0x%x bytes\n",
128 			 (unsigned long)(BL32_TOTAL_LIMIT - BL32_TOTAL_BASE));
129 	INFO("cpu 0x%x: %d smcs, %d erets %d cpu on requests\n", mpidr,
130 	     tsp_stats[linear_id].smc_count,
131 	     tsp_stats[linear_id].eret_count,
132 	     tsp_stats[linear_id].cpu_on_count);
133 	spin_unlock(&console_lock);
134 
135 	return (uint64_t) &tsp_vector_table;
136 }
137 
138 /*******************************************************************************
139  * This function performs any remaining book keeping in the test secure payload
140  * after this cpu's architectural state has been setup in response to an earlier
141  * psci cpu_on request.
142  ******************************************************************************/
143 tsp_args_t *tsp_cpu_on_main(void)
144 {
145 	uint64_t mpidr = read_mpidr();
146 	uint32_t linear_id = platform_get_core_pos(mpidr);
147 
148 	/* Initialize secure/applications state here */
149 	tsp_generic_timer_start();
150 
151 	/* Update this cpu's statistics */
152 	tsp_stats[linear_id].smc_count++;
153 	tsp_stats[linear_id].eret_count++;
154 	tsp_stats[linear_id].cpu_on_count++;
155 
156 	spin_lock(&console_lock);
157 	printf("SP: cpu 0x%x turned on\n\r", mpidr);
158 	INFO("cpu 0x%x: %d smcs, %d erets %d cpu on requests\n", mpidr,
159 	     tsp_stats[linear_id].smc_count,
160 	     tsp_stats[linear_id].eret_count,
161 	     tsp_stats[linear_id].cpu_on_count);
162 	spin_unlock(&console_lock);
163 
164 	/* Indicate to the SPD that we have completed turned ourselves on */
165 	return set_smc_args(TSP_ON_DONE, 0, 0, 0, 0, 0, 0, 0);
166 }
167 
168 /*******************************************************************************
169  * This function performs any remaining book keeping in the test secure payload
170  * before this cpu is turned off in response to a psci cpu_off request.
171  ******************************************************************************/
172 tsp_args_t *tsp_cpu_off_main(uint64_t arg0,
173 			   uint64_t arg1,
174 			   uint64_t arg2,
175 			   uint64_t arg3,
176 			   uint64_t arg4,
177 			   uint64_t arg5,
178 			   uint64_t arg6,
179 			   uint64_t arg7)
180 {
181 	uint64_t mpidr = read_mpidr();
182 	uint32_t linear_id = platform_get_core_pos(mpidr);
183 
184 	/*
185 	 * This cpu is being turned off, so disable the timer to prevent the
186 	 * secure timer interrupt from interfering with power down. A pending
187 	 * interrupt will be lost but we do not care as we are turning off.
188 	 */
189 	tsp_generic_timer_stop();
190 
191 	/* Update this cpu's statistics */
192 	tsp_stats[linear_id].smc_count++;
193 	tsp_stats[linear_id].eret_count++;
194 	tsp_stats[linear_id].cpu_off_count++;
195 
196 	spin_lock(&console_lock);
197 	printf("SP: cpu 0x%x off request\n\r", mpidr);
198 	INFO("cpu 0x%x: %d smcs, %d erets %d cpu off requests\n", mpidr,
199 	     tsp_stats[linear_id].smc_count,
200 	     tsp_stats[linear_id].eret_count,
201 	     tsp_stats[linear_id].cpu_off_count);
202 	spin_unlock(&console_lock);
203 
204 
205 	/* Indicate to the SPD that we have completed this request */
206 	return set_smc_args(TSP_OFF_DONE, 0, 0, 0, 0, 0, 0, 0);
207 }
208 
209 /*******************************************************************************
210  * This function performs any book keeping in the test secure payload before
211  * this cpu's architectural state is saved in response to an earlier psci
212  * cpu_suspend request.
213  ******************************************************************************/
214 tsp_args_t *tsp_cpu_suspend_main(uint64_t power_state,
215 			       uint64_t arg1,
216 			       uint64_t arg2,
217 			       uint64_t arg3,
218 			       uint64_t arg4,
219 			       uint64_t arg5,
220 			       uint64_t arg6,
221 			       uint64_t arg7)
222 {
223 	uint64_t mpidr = read_mpidr();
224 	uint32_t linear_id = platform_get_core_pos(mpidr);
225 
226 	/*
227 	 * Save the time context and disable it to prevent the secure timer
228 	 * interrupt from interfering with wakeup from the suspend state.
229 	 */
230 	tsp_generic_timer_save();
231 	tsp_generic_timer_stop();
232 
233 	/* Update this cpu's statistics */
234 	tsp_stats[linear_id].smc_count++;
235 	tsp_stats[linear_id].eret_count++;
236 	tsp_stats[linear_id].cpu_suspend_count++;
237 
238 	spin_lock(&console_lock);
239 	printf("SP: cpu 0x%x suspend request. power state: 0x%x\n\r",
240 	       mpidr, power_state);
241 	INFO("cpu 0x%x: %d smcs, %d erets %d cpu suspend requests\n", mpidr,
242 	     tsp_stats[linear_id].smc_count,
243 	     tsp_stats[linear_id].eret_count,
244 	     tsp_stats[linear_id].cpu_suspend_count);
245 	spin_unlock(&console_lock);
246 
247 	/* Indicate to the SPD that we have completed this request */
248 	return set_smc_args(TSP_SUSPEND_DONE, 0, 0, 0, 0, 0, 0, 0);
249 }
250 
251 /*******************************************************************************
252  * This function performs any book keeping in the test secure payload after this
253  * cpu's architectural state has been restored after wakeup from an earlier psci
254  * cpu_suspend request.
255  ******************************************************************************/
256 tsp_args_t *tsp_cpu_resume_main(uint64_t suspend_level,
257 			      uint64_t arg1,
258 			      uint64_t arg2,
259 			      uint64_t arg3,
260 			      uint64_t arg4,
261 			      uint64_t arg5,
262 			      uint64_t arg6,
263 			      uint64_t arg7)
264 {
265 	uint64_t mpidr = read_mpidr();
266 	uint32_t linear_id = platform_get_core_pos(mpidr);
267 
268 	/* Restore the generic timer context */
269 	tsp_generic_timer_restore();
270 
271 	/* Update this cpu's statistics */
272 	tsp_stats[linear_id].smc_count++;
273 	tsp_stats[linear_id].eret_count++;
274 	tsp_stats[linear_id].cpu_resume_count++;
275 
276 	spin_lock(&console_lock);
277 	printf("SP: cpu 0x%x resumed. suspend level %d \n\r",
278 	       mpidr, suspend_level);
279 	INFO("cpu 0x%x: %d smcs, %d erets %d cpu suspend requests\n", mpidr,
280 	     tsp_stats[linear_id].smc_count,
281 	     tsp_stats[linear_id].eret_count,
282 	     tsp_stats[linear_id].cpu_suspend_count);
283 	spin_unlock(&console_lock);
284 
285 	/* Indicate to the SPD that we have completed this request */
286 	return set_smc_args(TSP_RESUME_DONE, 0, 0, 0, 0, 0, 0, 0);
287 }
288 
289 /*******************************************************************************
290  * TSP fast smc handler. The secure monitor jumps to this function by
291  * doing the ERET after populating X0-X7 registers. The arguments are received
292  * in the function arguments in order. Once the service is rendered, this
293  * function returns to Secure Monitor by raising SMC.
294  ******************************************************************************/
295 tsp_args_t *tsp_smc_handler(uint64_t func,
296 			       uint64_t arg1,
297 			       uint64_t arg2,
298 			       uint64_t arg3,
299 			       uint64_t arg4,
300 			       uint64_t arg5,
301 			       uint64_t arg6,
302 			       uint64_t arg7)
303 {
304 	uint64_t results[2];
305 	uint64_t service_args[2];
306 	uint64_t mpidr = read_mpidr();
307 	uint32_t linear_id = platform_get_core_pos(mpidr);
308 	const char *smc_type;
309 
310 	/* Update this cpu's statistics */
311 	tsp_stats[linear_id].smc_count++;
312 	tsp_stats[linear_id].eret_count++;
313 
314 	smc_type = ((func >> 31) & 1) == 1 ? "fast" : "standard";
315 
316 	printf("SP: cpu 0x%x received %s smc 0x%x\n", read_mpidr(), smc_type, func);
317 	INFO("cpu 0x%x: %d smcs, %d erets\n", mpidr,
318 	     tsp_stats[linear_id].smc_count,
319 	     tsp_stats[linear_id].eret_count);
320 
321 	/* Render secure services and obtain results here */
322 	results[0] = arg1;
323 	results[1] = arg2;
324 
325 	/*
326 	 * Request a service back from dispatcher/secure monitor. This call
327 	 * return and thereafter resume exectuion
328 	 */
329 	tsp_get_magic(service_args);
330 
331 	/* Determine the function to perform based on the function ID */
332 	switch (TSP_BARE_FID(func)) {
333 	case TSP_ADD:
334 		results[0] += service_args[0];
335 		results[1] += service_args[1];
336 		break;
337 	case TSP_SUB:
338 		results[0] -= service_args[0];
339 		results[1] -= service_args[1];
340 		break;
341 	case TSP_MUL:
342 		results[0] *= service_args[0];
343 		results[1] *= service_args[1];
344 		break;
345 	case TSP_DIV:
346 		results[0] /= service_args[0] ? service_args[0] : 1;
347 		results[1] /= service_args[1] ? service_args[1] : 1;
348 		break;
349 	default:
350 		break;
351 	}
352 
353 	return set_smc_args(func, 0,
354 			    results[0],
355 			    results[1],
356 			    0, 0, 0, 0);
357 }
358 
359