blob: 6de5feb0e07105318bbdc9eede9f0796c4f953fa [file] [log] [blame]
Achin Gupta86f23532019-10-11 15:41:16 +01001/*
Olivier Deprezeae45962021-01-19 15:06:47 +01002 * Copyright (c) 2020-2021, ARM Limited and Contributors. All rights reserved.
Achin Gupta86f23532019-10-11 15:41:16 +01003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#include <assert.h>
8#include <errno.h>
9#include <string.h>
10
11#include <arch_helpers.h>
Olivier Deprez2bae35f2020-04-16 13:39:06 +020012#include <arch/aarch64/arch_features.h>
Achin Gupta86f23532019-10-11 15:41:16 +010013#include <bl31/bl31.h>
14#include <common/debug.h>
15#include <common/runtime_svc.h>
16#include <lib/el3_runtime/context_mgmt.h>
17#include <lib/smccc.h>
18#include <lib/spinlock.h>
19#include <lib/utils.h>
Achin Gupta86f23532019-10-11 15:41:16 +010020#include <plat/common/common_def.h>
21#include <plat/common/platform.h>
22#include <platform_def.h>
J-Alves2672cde2020-05-07 18:42:25 +010023#include <services/ffa_svc.h>
Achin Gupta86f23532019-10-11 15:41:16 +010024#include <services/spmd_svc.h>
25#include <smccc_helpers.h>
26#include "spmd_private.h"
27
28/*******************************************************************************
29 * SPM Core context information.
30 ******************************************************************************/
Olivier Deprez2bae35f2020-04-16 13:39:06 +020031static spmd_spm_core_context_t spm_core_context[PLATFORM_CORE_COUNT];
Achin Gupta86f23532019-10-11 15:41:16 +010032
33/*******************************************************************************
34 * SPM Core attribute information read from its manifest.
35 ******************************************************************************/
Olivier Deprez2bae35f2020-04-16 13:39:06 +020036static spmc_manifest_attribute_t spmc_attrs;
Achin Gupta86f23532019-10-11 15:41:16 +010037
38/*******************************************************************************
Max Shvetsov745889c2020-02-27 14:54:21 +000039 * SPM Core entry point information. Discovered on the primary core and reused
40 * on secondary cores.
41 ******************************************************************************/
42static entry_point_info_t *spmc_ep_info;
43
44/*******************************************************************************
Olivier Deprez73ef0dc2020-06-19 15:33:41 +020045 * SPM Core context on CPU based on mpidr.
46 ******************************************************************************/
47spmd_spm_core_context_t *spmd_get_context_by_mpidr(uint64_t mpidr)
48{
Max Shvetsovf80c64d2020-08-25 11:50:18 +010049 int core_idx = plat_core_pos_by_mpidr(mpidr);
50
51 if (core_idx < 0) {
52 ERROR("Invalid mpidr: %llx, returned ID: %d\n", mpidr, core_idx);
53 panic();
54 }
55
56 return &spm_core_context[core_idx];
Olivier Deprez73ef0dc2020-06-19 15:33:41 +020057}
58
59/*******************************************************************************
Olivier Deprez2bae35f2020-04-16 13:39:06 +020060 * SPM Core context on current CPU get helper.
61 ******************************************************************************/
62spmd_spm_core_context_t *spmd_get_context(void)
63{
Olivier Deprez73ef0dc2020-06-19 15:33:41 +020064 return spmd_get_context_by_mpidr(read_mpidr());
Olivier Deprez2bae35f2020-04-16 13:39:06 +020065}
66
67/*******************************************************************************
Olivier Deprezc7631a52020-03-23 09:53:06 +010068 * SPM Core ID getter.
69 ******************************************************************************/
70uint16_t spmd_spmc_id_get(void)
71{
72 return spmc_attrs.spmc_id;
73}
74
75/*******************************************************************************
Max Shvetsov745889c2020-02-27 14:54:21 +000076 * Static function declaration.
77 ******************************************************************************/
Olivier Deprez2bae35f2020-04-16 13:39:06 +020078static int32_t spmd_init(void);
Olivier Deprez69ca84a2020-02-07 15:44:43 +010079static int spmd_spmc_init(void *pm_addr);
J-Alves2672cde2020-05-07 18:42:25 +010080static uint64_t spmd_ffa_error_return(void *handle,
Olivier Deprez2bae35f2020-04-16 13:39:06 +020081 int error_code);
82static uint64_t spmd_smc_forward(uint32_t smc_fid,
83 bool secure_origin,
84 uint64_t x1,
85 uint64_t x2,
86 uint64_t x3,
87 uint64_t x4,
88 void *handle);
Max Shvetsov745889c2020-02-27 14:54:21 +000089
90/*******************************************************************************
Olivier Deprez2bae35f2020-04-16 13:39:06 +020091 * This function takes an SPMC context pointer and performs a synchronous
92 * SPMC entry.
Achin Gupta86f23532019-10-11 15:41:16 +010093 ******************************************************************************/
94uint64_t spmd_spm_core_sync_entry(spmd_spm_core_context_t *spmc_ctx)
95{
96 uint64_t rc;
97
98 assert(spmc_ctx != NULL);
99
100 cm_set_context(&(spmc_ctx->cpu_ctx), SECURE);
101
102 /* Restore the context assigned above */
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000103#if SPMD_SPM_AT_SEL2
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000104 cm_el2_sysregs_context_restore(SECURE);
Olivier Deprez9a2e5be2021-05-21 18:00:04 +0200105#else
106 cm_el1_sysregs_context_restore(SECURE);
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000107#endif
Achin Gupta86f23532019-10-11 15:41:16 +0100108 cm_set_next_eret_context(SECURE);
109
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000110 /* Enter SPMC */
Achin Gupta86f23532019-10-11 15:41:16 +0100111 rc = spmd_spm_core_enter(&spmc_ctx->c_rt_ctx);
112
113 /* Save secure state */
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000114#if SPMD_SPM_AT_SEL2
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000115 cm_el2_sysregs_context_save(SECURE);
Olivier Deprez9a2e5be2021-05-21 18:00:04 +0200116#else
117 cm_el1_sysregs_context_save(SECURE);
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000118#endif
Achin Gupta86f23532019-10-11 15:41:16 +0100119
120 return rc;
121}
122
123/*******************************************************************************
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200124 * This function returns to the place where spmd_spm_core_sync_entry() was
Achin Gupta86f23532019-10-11 15:41:16 +0100125 * called originally.
126 ******************************************************************************/
127__dead2 void spmd_spm_core_sync_exit(uint64_t rc)
128{
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200129 spmd_spm_core_context_t *ctx = spmd_get_context();
Achin Gupta86f23532019-10-11 15:41:16 +0100130
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200131 /* Get current CPU context from SPMC context */
Achin Gupta86f23532019-10-11 15:41:16 +0100132 assert(cm_get_context(SECURE) == &(ctx->cpu_ctx));
133
134 /*
135 * The SPMD must have initiated the original request through a
136 * synchronous entry into SPMC. Jump back to the original C runtime
137 * context with the value of rc in x0;
138 */
139 spmd_spm_core_exit(ctx->c_rt_ctx, rc);
140
141 panic();
142}
143
144/*******************************************************************************
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200145 * Jump to the SPM Core for the first time.
Achin Gupta86f23532019-10-11 15:41:16 +0100146 ******************************************************************************/
147static int32_t spmd_init(void)
148{
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200149 spmd_spm_core_context_t *ctx = spmd_get_context();
150 uint64_t rc;
Achin Gupta86f23532019-10-11 15:41:16 +0100151
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200152 VERBOSE("SPM Core init start.\n");
Olivier Deprez7c016332019-10-28 09:03:13 +0000153
Olivier Deprez4ab7a4a2021-06-21 09:47:13 +0200154 /* Primary boot core enters the SPMC for initialization. */
155 ctx->state = SPMC_STATE_ON_PENDING;
Achin Gupta86f23532019-10-11 15:41:16 +0100156
157 rc = spmd_spm_core_sync_entry(ctx);
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200158 if (rc != 0ULL) {
Achin Gupta86f23532019-10-11 15:41:16 +0100159 ERROR("SPMC initialisation failed 0x%llx\n", rc);
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200160 return 0;
Achin Gupta86f23532019-10-11 15:41:16 +0100161 }
162
Olivier Deprez7c016332019-10-28 09:03:13 +0000163 ctx->state = SPMC_STATE_ON;
164
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200165 VERBOSE("SPM Core init end.\n");
Achin Gupta86f23532019-10-11 15:41:16 +0100166
167 return 1;
168}
169
170/*******************************************************************************
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200171 * Loads SPMC manifest and inits SPMC.
Achin Gupta86f23532019-10-11 15:41:16 +0100172 ******************************************************************************/
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100173static int spmd_spmc_init(void *pm_addr)
Achin Gupta86f23532019-10-11 15:41:16 +0100174{
Olivier Deprez4ab7a4a2021-06-21 09:47:13 +0200175 cpu_context_t *cpu_ctx;
176 unsigned int core_id;
Achin Gupta86f23532019-10-11 15:41:16 +0100177 uint32_t ep_attr;
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200178 int rc;
Achin Gupta86f23532019-10-11 15:41:16 +0100179
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200180 /* Load the SPM Core manifest */
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100181 rc = plat_spm_core_manifest_load(&spmc_attrs, pm_addr);
Max Shvetsov745889c2020-02-27 14:54:21 +0000182 if (rc != 0) {
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200183 WARN("No or invalid SPM Core manifest image provided by BL2\n");
184 return rc;
Achin Gupta86f23532019-10-11 15:41:16 +0100185 }
186
187 /*
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200188 * Ensure that the SPM Core version is compatible with the SPM
189 * Dispatcher version.
Achin Gupta86f23532019-10-11 15:41:16 +0100190 */
J-Alves2672cde2020-05-07 18:42:25 +0100191 if ((spmc_attrs.major_version != FFA_VERSION_MAJOR) ||
192 (spmc_attrs.minor_version > FFA_VERSION_MINOR)) {
193 WARN("Unsupported FFA version (%u.%u)\n",
Achin Gupta86f23532019-10-11 15:41:16 +0100194 spmc_attrs.major_version, spmc_attrs.minor_version);
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200195 return -EINVAL;
Achin Gupta86f23532019-10-11 15:41:16 +0100196 }
197
J-Alves2672cde2020-05-07 18:42:25 +0100198 VERBOSE("FFA version (%u.%u)\n", spmc_attrs.major_version,
Achin Gupta86f23532019-10-11 15:41:16 +0100199 spmc_attrs.minor_version);
200
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200201 VERBOSE("SPM Core run time EL%x.\n",
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000202 SPMD_SPM_AT_SEL2 ? MODE_EL2 : MODE_EL1);
Achin Gupta86f23532019-10-11 15:41:16 +0100203
Max Shvetsove79062e2020-03-12 15:16:40 +0000204 /* Validate the SPMC ID, Ensure high bit is set */
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200205 if (((spmc_attrs.spmc_id >> SPMC_SECURE_ID_SHIFT) &
206 SPMC_SECURE_ID_MASK) == 0U) {
207 WARN("Invalid ID (0x%x) for SPMC.\n", spmc_attrs.spmc_id);
208 return -EINVAL;
Max Shvetsove79062e2020-03-12 15:16:40 +0000209 }
210
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200211 /* Validate the SPM Core execution state */
Achin Gupta86f23532019-10-11 15:41:16 +0100212 if ((spmc_attrs.exec_state != MODE_RW_64) &&
213 (spmc_attrs.exec_state != MODE_RW_32)) {
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100214 WARN("Unsupported %s%x.\n", "SPM Core execution state 0x",
Achin Gupta86f23532019-10-11 15:41:16 +0100215 spmc_attrs.exec_state);
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200216 return -EINVAL;
Achin Gupta86f23532019-10-11 15:41:16 +0100217 }
218
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100219 VERBOSE("%s%x.\n", "SPM Core execution state 0x",
220 spmc_attrs.exec_state);
Achin Gupta86f23532019-10-11 15:41:16 +0100221
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000222#if SPMD_SPM_AT_SEL2
223 /* Ensure manifest has not requested AArch32 state in S-EL2 */
224 if (spmc_attrs.exec_state == MODE_RW_32) {
225 WARN("AArch32 state at S-EL2 is not supported.\n");
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200226 return -EINVAL;
Achin Gupta86f23532019-10-11 15:41:16 +0100227 }
228
229 /*
230 * Check if S-EL2 is supported on this system if S-EL2
231 * is required for SPM
232 */
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200233 if (!is_armv8_4_sel2_present()) {
234 WARN("SPM Core run time S-EL2 is not supported.\n");
235 return -EINVAL;
Achin Gupta86f23532019-10-11 15:41:16 +0100236 }
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000237#endif /* SPMD_SPM_AT_SEL2 */
Achin Gupta86f23532019-10-11 15:41:16 +0100238
239 /* Initialise an entrypoint to set up the CPU context */
240 ep_attr = SECURE | EP_ST_ENABLE;
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200241 if ((read_sctlr_el3() & SCTLR_EE_BIT) != 0ULL) {
Achin Gupta86f23532019-10-11 15:41:16 +0100242 ep_attr |= EP_EE_BIG;
Max Shvetsov745889c2020-02-27 14:54:21 +0000243 }
244
Achin Gupta86f23532019-10-11 15:41:16 +0100245 SET_PARAM_HEAD(spmc_ep_info, PARAM_EP, VERSION_1, ep_attr);
Achin Gupta86f23532019-10-11 15:41:16 +0100246
247 /*
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200248 * Populate SPSR for SPM Core based upon validated parameters from the
249 * manifest.
Achin Gupta86f23532019-10-11 15:41:16 +0100250 */
251 if (spmc_attrs.exec_state == MODE_RW_32) {
252 spmc_ep_info->spsr = SPSR_MODE32(MODE32_svc, SPSR_T_ARM,
253 SPSR_E_LITTLE,
254 DAIF_FIQ_BIT |
255 DAIF_IRQ_BIT |
256 DAIF_ABT_BIT);
257 } else {
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000258
259#if SPMD_SPM_AT_SEL2
260 static const uint32_t runtime_el = MODE_EL2;
261#else
262 static const uint32_t runtime_el = MODE_EL1;
263#endif
264 spmc_ep_info->spsr = SPSR_64(runtime_el,
Achin Gupta86f23532019-10-11 15:41:16 +0100265 MODE_SP_ELX,
266 DISABLE_ALL_EXCEPTIONS);
267 }
268
Olivier Deprez4ab7a4a2021-06-21 09:47:13 +0200269 /* Set an initial SPMC context state for all cores. */
270 for (core_id = 0U; core_id < PLATFORM_CORE_COUNT; core_id++) {
271 spm_core_context[core_id].state = SPMC_STATE_OFF;
Max Shvetsov745889c2020-02-27 14:54:21 +0000272
Olivier Deprez4ab7a4a2021-06-21 09:47:13 +0200273 /* Setup an initial cpu context for the SPMC. */
274 cpu_ctx = &spm_core_context[core_id].cpu_ctx;
275 cm_setup_context(cpu_ctx, spmc_ep_info);
Achin Gupta86f23532019-10-11 15:41:16 +0100276
Olivier Deprez4ab7a4a2021-06-21 09:47:13 +0200277 /*
278 * Pass the core linear ID to the SPMC through x4.
279 * (TF-A implementation defined behavior helping
280 * a legacy TOS migration to adopt FF-A).
281 */
282 write_ctx_reg(get_gpregs_ctx(cpu_ctx), CTX_GPREG_X4, core_id);
283 }
Achin Gupta86f23532019-10-11 15:41:16 +0100284
Olivier Deprez9afca122019-10-28 09:15:52 +0000285 /* Register power management hooks with PSCI */
286 psci_register_spd_pm_hook(&spmd_pm);
287
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200288 /* Register init function for deferred init. */
Achin Gupta86f23532019-10-11 15:41:16 +0100289 bl31_register_bl32_init(&spmd_init);
290
Olivier Deprez4ab7a4a2021-06-21 09:47:13 +0200291 INFO("SPM Core setup done.\n");
292
Achin Gupta86f23532019-10-11 15:41:16 +0100293 return 0;
Max Shvetsov745889c2020-02-27 14:54:21 +0000294}
Achin Gupta86f23532019-10-11 15:41:16 +0100295
Max Shvetsov745889c2020-02-27 14:54:21 +0000296/*******************************************************************************
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200297 * Initialize context of SPM Core.
Max Shvetsov745889c2020-02-27 14:54:21 +0000298 ******************************************************************************/
299int spmd_setup(void)
300{
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100301 void *spmc_manifest;
Max Shvetsov745889c2020-02-27 14:54:21 +0000302 int rc;
Achin Gupta86f23532019-10-11 15:41:16 +0100303
Max Shvetsov745889c2020-02-27 14:54:21 +0000304 spmc_ep_info = bl31_plat_get_next_image_ep_info(SECURE);
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200305 if (spmc_ep_info == NULL) {
306 WARN("No SPM Core image provided by BL2 boot loader.\n");
307 return -EINVAL;
Max Shvetsov745889c2020-02-27 14:54:21 +0000308 }
309
310 /* Under no circumstances will this parameter be 0 */
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200311 assert(spmc_ep_info->pc != 0ULL);
Max Shvetsov745889c2020-02-27 14:54:21 +0000312
313 /*
314 * Check if BL32 ep_info has a reference to 'tos_fw_config'. This will
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200315 * be used as a manifest for the SPM Core at the next lower EL/mode.
Max Shvetsov745889c2020-02-27 14:54:21 +0000316 */
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100317 spmc_manifest = (void *)spmc_ep_info->args.arg0;
318 if (spmc_manifest == NULL) {
319 ERROR("Invalid or absent SPM Core manifest.\n");
320 return -EINVAL;
Max Shvetsov745889c2020-02-27 14:54:21 +0000321 }
322
323 /* Load manifest, init SPMC */
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100324 rc = spmd_spmc_init(spmc_manifest);
Max Shvetsov745889c2020-02-27 14:54:21 +0000325 if (rc != 0) {
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200326 WARN("Booting device without SPM initialization.\n");
Max Shvetsov745889c2020-02-27 14:54:21 +0000327 }
328
Olivier Deprez69ca84a2020-02-07 15:44:43 +0100329 return rc;
Max Shvetsov745889c2020-02-27 14:54:21 +0000330}
331
332/*******************************************************************************
333 * Forward SMC to the other security state
334 ******************************************************************************/
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200335static uint64_t spmd_smc_forward(uint32_t smc_fid,
336 bool secure_origin,
337 uint64_t x1,
338 uint64_t x2,
339 uint64_t x3,
340 uint64_t x4,
341 void *handle)
Max Shvetsov745889c2020-02-27 14:54:21 +0000342{
Olivier Deprezebc34772020-04-16 16:59:21 +0200343 unsigned int secure_state_in = (secure_origin) ? SECURE : NON_SECURE;
344 unsigned int secure_state_out = (!secure_origin) ? SECURE : NON_SECURE;
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100345
Max Shvetsov745889c2020-02-27 14:54:21 +0000346 /* Save incoming security state */
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000347#if SPMD_SPM_AT_SEL2
Olivier Deprez9a2e5be2021-05-21 18:00:04 +0200348 if (secure_state_in == NON_SECURE) {
349 cm_el1_sysregs_context_save(secure_state_in);
350 }
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100351 cm_el2_sysregs_context_save(secure_state_in);
Olivier Deprez9a2e5be2021-05-21 18:00:04 +0200352#else
353 cm_el1_sysregs_context_save(secure_state_in);
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000354#endif
Max Shvetsov745889c2020-02-27 14:54:21 +0000355
356 /* Restore outgoing security state */
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000357#if SPMD_SPM_AT_SEL2
Olivier Deprez9a2e5be2021-05-21 18:00:04 +0200358 if (secure_state_out == NON_SECURE) {
359 cm_el1_sysregs_context_restore(secure_state_out);
360 }
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100361 cm_el2_sysregs_context_restore(secure_state_out);
Olivier Deprez9a2e5be2021-05-21 18:00:04 +0200362#else
363 cm_el1_sysregs_context_restore(secure_state_out);
Max Shvetsove7fd80e2020-02-25 13:55:00 +0000364#endif
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100365 cm_set_next_eret_context(secure_state_out);
Max Shvetsov745889c2020-02-27 14:54:21 +0000366
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100367 SMC_RET8(cm_get_context(secure_state_out), smc_fid, x1, x2, x3, x4,
Max Shvetsov745889c2020-02-27 14:54:21 +0000368 SMC_GET_GP(handle, CTX_GPREG_X5),
369 SMC_GET_GP(handle, CTX_GPREG_X6),
370 SMC_GET_GP(handle, CTX_GPREG_X7));
371}
372
373/*******************************************************************************
J-Alves2672cde2020-05-07 18:42:25 +0100374 * Return FFA_ERROR with specified error code
Max Shvetsov745889c2020-02-27 14:54:21 +0000375 ******************************************************************************/
J-Alves2672cde2020-05-07 18:42:25 +0100376static uint64_t spmd_ffa_error_return(void *handle, int error_code)
Max Shvetsov745889c2020-02-27 14:54:21 +0000377{
J-Alves64ff9932021-03-01 10:26:59 +0000378 SMC_RET8(handle, (uint32_t) FFA_ERROR,
379 FFA_TARGET_INFO_MBZ, (uint32_t)error_code,
J-Alves2672cde2020-05-07 18:42:25 +0100380 FFA_PARAM_MBZ, FFA_PARAM_MBZ, FFA_PARAM_MBZ,
381 FFA_PARAM_MBZ, FFA_PARAM_MBZ);
Achin Gupta86f23532019-10-11 15:41:16 +0100382}
383
Olivier Deprez33e44122020-04-16 17:54:27 +0200384/*******************************************************************************
385 * spmd_check_address_in_binary_image
386 ******************************************************************************/
387bool spmd_check_address_in_binary_image(uint64_t address)
388{
389 assert(!check_uptr_overflow(spmc_attrs.load_address, spmc_attrs.binary_size));
390
391 return ((address >= spmc_attrs.load_address) &&
392 (address < (spmc_attrs.load_address + spmc_attrs.binary_size)));
393}
394
Olivier Deprezebc34772020-04-16 16:59:21 +0200395/******************************************************************************
396 * spmd_is_spmc_message
397 *****************************************************************************/
398static bool spmd_is_spmc_message(unsigned int ep)
399{
400 return ((ffa_endpoint_destination(ep) == SPMD_DIRECT_MSG_ENDPOINT_ID)
401 && (ffa_endpoint_source(ep) == spmc_attrs.spmc_id));
402}
403
Olivier Deprez33e44122020-04-16 17:54:27 +0200404/******************************************************************************
405 * spmd_handle_spmc_message
406 *****************************************************************************/
Olivier Deprezc7631a52020-03-23 09:53:06 +0100407static int spmd_handle_spmc_message(unsigned long long msg,
408 unsigned long long parm1, unsigned long long parm2,
409 unsigned long long parm3, unsigned long long parm4)
Olivier Deprez33e44122020-04-16 17:54:27 +0200410{
411 VERBOSE("%s %llx %llx %llx %llx %llx\n", __func__,
412 msg, parm1, parm2, parm3, parm4);
413
Olivier Deprez33e44122020-04-16 17:54:27 +0200414 return -EINVAL;
415}
416
Achin Gupta86f23532019-10-11 15:41:16 +0100417/*******************************************************************************
J-Alves2672cde2020-05-07 18:42:25 +0100418 * This function handles all SMCs in the range reserved for FFA. Each call is
Achin Gupta86f23532019-10-11 15:41:16 +0100419 * either forwarded to the other security state or handled by the SPM dispatcher
420 ******************************************************************************/
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200421uint64_t spmd_smc_handler(uint32_t smc_fid,
422 uint64_t x1,
423 uint64_t x2,
424 uint64_t x3,
425 uint64_t x4,
426 void *cookie,
427 void *handle,
Achin Gupta86f23532019-10-11 15:41:16 +0100428 uint64_t flags)
429{
Olivier Deprezeae45962021-01-19 15:06:47 +0100430 unsigned int linear_id = plat_my_core_pos();
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200431 spmd_spm_core_context_t *ctx = spmd_get_context();
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100432 bool secure_origin;
433 int32_t ret;
J-Alves4c95c702020-05-26 14:03:05 +0100434 uint32_t input_version;
Achin Gupta86f23532019-10-11 15:41:16 +0100435
436 /* Determine which security state this SMC originated from */
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100437 secure_origin = is_caller_secure(flags);
Achin Gupta86f23532019-10-11 15:41:16 +0100438
Olivier Deprezeae45962021-01-19 15:06:47 +0100439 VERBOSE("SPM(%u): 0x%x 0x%llx 0x%llx 0x%llx 0x%llx "
440 "0x%llx 0x%llx 0x%llx\n",
441 linear_id, smc_fid, x1, x2, x3, x4,
442 SMC_GET_GP(handle, CTX_GPREG_X5),
443 SMC_GET_GP(handle, CTX_GPREG_X6),
444 SMC_GET_GP(handle, CTX_GPREG_X7));
Achin Gupta86f23532019-10-11 15:41:16 +0100445
446 switch (smc_fid) {
J-Alves2672cde2020-05-07 18:42:25 +0100447 case FFA_ERROR:
Achin Gupta86f23532019-10-11 15:41:16 +0100448 /*
449 * Check if this is the first invocation of this interface on
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200450 * this CPU. If so, then indicate that the SPM Core initialised
Achin Gupta86f23532019-10-11 15:41:16 +0100451 * unsuccessfully.
452 */
Olivier Deprez7c016332019-10-28 09:03:13 +0000453 if (secure_origin && (ctx->state == SPMC_STATE_ON_PENDING)) {
Achin Gupta86f23532019-10-11 15:41:16 +0100454 spmd_spm_core_sync_exit(x2);
Max Shvetsov745889c2020-02-27 14:54:21 +0000455 }
Achin Gupta86f23532019-10-11 15:41:16 +0100456
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100457 return spmd_smc_forward(smc_fid, secure_origin,
Max Shvetsov745889c2020-02-27 14:54:21 +0000458 x1, x2, x3, x4, handle);
Achin Gupta86f23532019-10-11 15:41:16 +0100459 break; /* not reached */
460
J-Alves2672cde2020-05-07 18:42:25 +0100461 case FFA_VERSION:
J-Alves4c95c702020-05-26 14:03:05 +0100462 input_version = (uint32_t)(0xFFFFFFFF & x1);
Achin Gupta86f23532019-10-11 15:41:16 +0100463 /*
J-Alves4c95c702020-05-26 14:03:05 +0100464 * If caller is secure and SPMC was initialized,
465 * return FFA_VERSION of SPMD.
466 * If caller is non secure and SPMC was initialized,
467 * return SPMC's version.
468 * Sanity check to "input_version".
Achin Gupta86f23532019-10-11 15:41:16 +0100469 */
J-Alves4c95c702020-05-26 14:03:05 +0100470 if ((input_version & FFA_VERSION_BIT31_MASK) ||
471 (ctx->state == SPMC_STATE_RESET)) {
472 ret = FFA_ERROR_NOT_SUPPORTED;
473 } else if (!secure_origin) {
J-Alves64ff9932021-03-01 10:26:59 +0000474 ret = MAKE_FFA_VERSION(spmc_attrs.major_version,
475 spmc_attrs.minor_version);
J-Alves4c95c702020-05-26 14:03:05 +0100476 } else {
J-Alves64ff9932021-03-01 10:26:59 +0000477 ret = MAKE_FFA_VERSION(FFA_VERSION_MAJOR,
478 FFA_VERSION_MINOR);
J-Alves4c95c702020-05-26 14:03:05 +0100479 }
480
J-Alves64ff9932021-03-01 10:26:59 +0000481 SMC_RET8(handle, (uint32_t)ret, FFA_TARGET_INFO_MBZ,
482 FFA_TARGET_INFO_MBZ, FFA_PARAM_MBZ, FFA_PARAM_MBZ,
483 FFA_PARAM_MBZ, FFA_PARAM_MBZ, FFA_PARAM_MBZ);
Achin Gupta86f23532019-10-11 15:41:16 +0100484 break; /* not reached */
485
J-Alves2672cde2020-05-07 18:42:25 +0100486 case FFA_FEATURES:
Achin Gupta86f23532019-10-11 15:41:16 +0100487 /*
488 * This is an optional interface. Do the minimal checks and
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200489 * forward to SPM Core which will handle it if implemented.
Achin Gupta86f23532019-10-11 15:41:16 +0100490 */
491
492 /*
J-Alves2672cde2020-05-07 18:42:25 +0100493 * Check if x1 holds a valid FFA fid. This is an
Achin Gupta86f23532019-10-11 15:41:16 +0100494 * optimization.
495 */
J-Alves2672cde2020-05-07 18:42:25 +0100496 if (!is_ffa_fid(x1)) {
497 return spmd_ffa_error_return(handle,
J-Alves64ff9932021-03-01 10:26:59 +0000498 FFA_ERROR_NOT_SUPPORTED);
Max Shvetsov745889c2020-02-27 14:54:21 +0000499 }
Achin Gupta86f23532019-10-11 15:41:16 +0100500
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200501 /* Forward SMC from Normal world to the SPM Core */
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100502 if (!secure_origin) {
503 return spmd_smc_forward(smc_fid, secure_origin,
Max Shvetsov745889c2020-02-27 14:54:21 +0000504 x1, x2, x3, x4, handle);
Achin Gupta86f23532019-10-11 15:41:16 +0100505 }
Max Shvetsov745889c2020-02-27 14:54:21 +0000506
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200507 /*
508 * Return success if call was from secure world i.e. all
J-Alves2672cde2020-05-07 18:42:25 +0100509 * FFA functions are supported. This is essentially a
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200510 * nop.
511 */
J-Alves2672cde2020-05-07 18:42:25 +0100512 SMC_RET8(handle, FFA_SUCCESS_SMC32, x1, x2, x3, x4,
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200513 SMC_GET_GP(handle, CTX_GPREG_X5),
514 SMC_GET_GP(handle, CTX_GPREG_X6),
515 SMC_GET_GP(handle, CTX_GPREG_X7));
516
Achin Gupta86f23532019-10-11 15:41:16 +0100517 break; /* not reached */
518
J-Alves2672cde2020-05-07 18:42:25 +0100519 case FFA_ID_GET:
Max Shvetsove79062e2020-03-12 15:16:40 +0000520 /*
J-Alves2672cde2020-05-07 18:42:25 +0100521 * Returns the ID of the calling FFA component.
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200522 */
Max Shvetsove79062e2020-03-12 15:16:40 +0000523 if (!secure_origin) {
J-Alves2672cde2020-05-07 18:42:25 +0100524 SMC_RET8(handle, FFA_SUCCESS_SMC32,
525 FFA_TARGET_INFO_MBZ, FFA_NS_ENDPOINT_ID,
526 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
527 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
528 FFA_PARAM_MBZ);
Max Shvetsove79062e2020-03-12 15:16:40 +0000529 }
530
J-Alves2672cde2020-05-07 18:42:25 +0100531 SMC_RET8(handle, FFA_SUCCESS_SMC32,
532 FFA_TARGET_INFO_MBZ, spmc_attrs.spmc_id,
533 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
534 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
535 FFA_PARAM_MBZ);
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200536
Max Shvetsove79062e2020-03-12 15:16:40 +0000537 break; /* not reached */
538
Olivier Deprezeae45962021-01-19 15:06:47 +0100539 case FFA_SECONDARY_EP_REGISTER_SMC64:
540 if (secure_origin) {
541 ret = spmd_pm_secondary_ep_register(x1);
542
543 if (ret < 0) {
544 SMC_RET8(handle, FFA_ERROR_SMC64,
545 FFA_TARGET_INFO_MBZ, ret,
546 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
547 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
548 FFA_PARAM_MBZ);
549 } else {
550 SMC_RET8(handle, FFA_SUCCESS_SMC64,
551 FFA_TARGET_INFO_MBZ, FFA_PARAM_MBZ,
552 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
553 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
554 FFA_PARAM_MBZ);
555 }
556 }
557
558 return spmd_ffa_error_return(handle, FFA_ERROR_NOT_SUPPORTED);
559 break; /* Not reached */
560
Daniel Boulby27f35df2021-02-03 12:13:19 +0000561 case FFA_SPM_ID_GET:
562 if (MAKE_FFA_VERSION(1, 1) > FFA_VERSION_COMPILED) {
563 return spmd_ffa_error_return(handle,
564 FFA_ERROR_NOT_SUPPORTED);
565 }
566 /*
567 * Returns the ID of the SPMC or SPMD depending on the FF-A
568 * instance where this function is invoked
569 */
570 if (!secure_origin) {
571 SMC_RET8(handle, FFA_SUCCESS_SMC32,
572 FFA_TARGET_INFO_MBZ, spmc_attrs.spmc_id,
573 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
574 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
575 FFA_PARAM_MBZ);
576 }
577 SMC_RET8(handle, FFA_SUCCESS_SMC32,
578 FFA_TARGET_INFO_MBZ, SPMD_DIRECT_MSG_ENDPOINT_ID,
579 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
580 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
581 FFA_PARAM_MBZ);
582
583 break; /* not reached */
584
Olivier Deprez33e44122020-04-16 17:54:27 +0200585 case FFA_MSG_SEND_DIRECT_REQ_SMC32:
586 if (secure_origin && spmd_is_spmc_message(x1)) {
587 ret = spmd_handle_spmc_message(x3, x4,
588 SMC_GET_GP(handle, CTX_GPREG_X5),
589 SMC_GET_GP(handle, CTX_GPREG_X6),
590 SMC_GET_GP(handle, CTX_GPREG_X7));
591
592 SMC_RET8(handle, FFA_SUCCESS_SMC32,
593 FFA_TARGET_INFO_MBZ, ret,
594 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
595 FFA_PARAM_MBZ, FFA_PARAM_MBZ,
596 FFA_PARAM_MBZ);
597 } else {
598 /* Forward direct message to the other world */
599 return spmd_smc_forward(smc_fid, secure_origin,
600 x1, x2, x3, x4, handle);
601 }
602 break; /* Not reached */
603
604 case FFA_MSG_SEND_DIRECT_RESP_SMC32:
605 if (secure_origin && spmd_is_spmc_message(x1)) {
606 spmd_spm_core_sync_exit(0);
607 } else {
608 /* Forward direct message to the other world */
609 return spmd_smc_forward(smc_fid, secure_origin,
610 x1, x2, x3, x4, handle);
611 }
612 break; /* Not reached */
613
J-Alves2672cde2020-05-07 18:42:25 +0100614 case FFA_RX_RELEASE:
615 case FFA_RXTX_MAP_SMC32:
616 case FFA_RXTX_MAP_SMC64:
617 case FFA_RXTX_UNMAP:
Ruari Phipps93dff702020-07-28 10:33:35 +0100618 case FFA_PARTITION_INFO_GET:
J-Alves2621cfd2021-03-11 17:46:47 +0000619#if MAKE_FFA_VERSION(1, 1) <= FFA_VERSION_COMPILED
620 case FFA_NOTIFICATION_BITMAP_CREATE:
621 case FFA_NOTIFICATION_BITMAP_DESTROY:
622 case FFA_NOTIFICATION_BIND:
623 case FFA_NOTIFICATION_UNBIND:
624 case FFA_NOTIFICATION_SET:
625 case FFA_NOTIFICATION_GET:
626 case FFA_NOTIFICATION_INFO_GET:
627 case FFA_NOTIFICATION_INFO_GET_SMC64:
628#endif
Ruari Phipps93dff702020-07-28 10:33:35 +0100629 /*
J-Alves2621cfd2021-03-11 17:46:47 +0000630 * Above calls should not be forwarded from Secure world to
631 * Normal world.
Ruari Phipps93dff702020-07-28 10:33:35 +0100632 *
633 * Fall through to forward the call to the other world
634 */
J-Alves2672cde2020-05-07 18:42:25 +0100635 case FFA_MSG_RUN:
Achin Gupta86f23532019-10-11 15:41:16 +0100636 /* This interface must be invoked only by the Normal world */
Ruari Phipps93dff702020-07-28 10:33:35 +0100637
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100638 if (secure_origin) {
J-Alves2672cde2020-05-07 18:42:25 +0100639 return spmd_ffa_error_return(handle,
Ruari Phipps93dff702020-07-28 10:33:35 +0100640 FFA_ERROR_NOT_SUPPORTED);
Achin Gupta86f23532019-10-11 15:41:16 +0100641 }
642
643 /* Fall through to forward the call to the other world */
J-Alves2672cde2020-05-07 18:42:25 +0100644 case FFA_MSG_SEND:
J-Alves2672cde2020-05-07 18:42:25 +0100645 case FFA_MSG_SEND_DIRECT_REQ_SMC64:
J-Alves2672cde2020-05-07 18:42:25 +0100646 case FFA_MSG_SEND_DIRECT_RESP_SMC64:
647 case FFA_MEM_DONATE_SMC32:
648 case FFA_MEM_DONATE_SMC64:
649 case FFA_MEM_LEND_SMC32:
650 case FFA_MEM_LEND_SMC64:
651 case FFA_MEM_SHARE_SMC32:
652 case FFA_MEM_SHARE_SMC64:
653 case FFA_MEM_RETRIEVE_REQ_SMC32:
654 case FFA_MEM_RETRIEVE_REQ_SMC64:
655 case FFA_MEM_RETRIEVE_RESP:
656 case FFA_MEM_RELINQUISH:
657 case FFA_MEM_RECLAIM:
658 case FFA_SUCCESS_SMC32:
659 case FFA_SUCCESS_SMC64:
Achin Gupta86f23532019-10-11 15:41:16 +0100660 /*
661 * TODO: Assume that no requests originate from EL3 at the
662 * moment. This will change if a SP service is required in
663 * response to secure interrupts targeted to EL3. Until then
664 * simply forward the call to the Normal world.
665 */
666
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100667 return spmd_smc_forward(smc_fid, secure_origin,
Max Shvetsov745889c2020-02-27 14:54:21 +0000668 x1, x2, x3, x4, handle);
Achin Gupta86f23532019-10-11 15:41:16 +0100669 break; /* not reached */
670
J-Alves2672cde2020-05-07 18:42:25 +0100671 case FFA_MSG_WAIT:
Achin Gupta86f23532019-10-11 15:41:16 +0100672 /*
673 * Check if this is the first invocation of this interface on
674 * this CPU from the Secure world. If so, then indicate that the
Olivier Deprez2bae35f2020-04-16 13:39:06 +0200675 * SPM Core initialised successfully.
Achin Gupta86f23532019-10-11 15:41:16 +0100676 */
Olivier Deprez7c016332019-10-28 09:03:13 +0000677 if (secure_origin && (ctx->state == SPMC_STATE_ON_PENDING)) {
Achin Gupta86f23532019-10-11 15:41:16 +0100678 spmd_spm_core_sync_exit(0);
679 }
680
Max Shvetsov745889c2020-02-27 14:54:21 +0000681 /* Fall through to forward the call to the other world */
Olivier Deprezae18caf2021-04-02 11:09:10 +0200682 case FFA_INTERRUPT:
J-Alves2672cde2020-05-07 18:42:25 +0100683 case FFA_MSG_YIELD:
Achin Gupta86f23532019-10-11 15:41:16 +0100684 /* This interface must be invoked only by the Secure world */
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100685 if (!secure_origin) {
J-Alves2672cde2020-05-07 18:42:25 +0100686 return spmd_ffa_error_return(handle,
687 FFA_ERROR_NOT_SUPPORTED);
Achin Gupta86f23532019-10-11 15:41:16 +0100688 }
689
Olivier Deprez41ff36a2019-12-23 16:21:12 +0100690 return spmd_smc_forward(smc_fid, secure_origin,
Max Shvetsov745889c2020-02-27 14:54:21 +0000691 x1, x2, x3, x4, handle);
Achin Gupta86f23532019-10-11 15:41:16 +0100692 break; /* not reached */
693
694 default:
695 WARN("SPM: Unsupported call 0x%08x\n", smc_fid);
J-Alves2672cde2020-05-07 18:42:25 +0100696 return spmd_ffa_error_return(handle, FFA_ERROR_NOT_SUPPORTED);
Achin Gupta86f23532019-10-11 15:41:16 +0100697 }
698}