xref: /rk3399_ARM-atf/services/std_svc/drtm/drtm_main.c (revision b1392f429cdd368ea2b8e183a1ac0fb31deaf694)
1 /*
2  * Copyright (c) 2022 Arm Limited. All rights reserved.
3  *
4  * SPDX-License-Identifier:    BSD-3-Clause
5  *
6  * DRTM service
7  *
8  * Authors:
9  *	Lucian Paul-Trifu <lucian.paultrifu@gmail.com>
10  *	Brian Nezvadovitz <brinez@microsoft.com> 2021-02-01
11  */
12 
13 #include <stdint.h>
14 
15 #include <arch.h>
16 #include <arch_helpers.h>
17 #include <common/bl_common.h>
18 #include <common/debug.h>
19 #include <common/runtime_svc.h>
20 #include <drivers/auth/crypto_mod.h>
21 #include "drtm_main.h"
22 #include "drtm_measurements.h"
23 #include "drtm_remediation.h"
24 #include <lib/el3_runtime/context_mgmt.h>
25 #include <lib/psci/psci_lib.h>
26 #include <lib/xlat_tables/xlat_tables_v2.h>
27 #include <plat/common/platform.h>
28 #include <services/drtm_svc.h>
29 #include <services/sdei.h>
30 #include <platform_def.h>
31 
32 /* Structure to store DRTM features specific to the platform. */
33 static drtm_features_t plat_drtm_features;
34 
35 /* DRTM-formatted memory map. */
36 static drtm_memory_region_descriptor_table_t *plat_drtm_mem_map;
37 
38 /* DLME header */
39 struct_dlme_data_header dlme_data_hdr_init;
40 
41 /* Minimum data memory requirement */
42 uint64_t dlme_data_min_size;
43 
44 int drtm_setup(void)
45 {
46 	bool rc;
47 	const plat_drtm_tpm_features_t *plat_tpm_feat;
48 	const plat_drtm_dma_prot_features_t *plat_dma_prot_feat;
49 
50 	INFO("DRTM service setup\n");
51 
52 	/* Read boot PE ID from MPIDR */
53 	plat_drtm_features.boot_pe_id = read_mpidr_el1() & MPIDR_AFFINITY_MASK;
54 
55 	rc = drtm_dma_prot_init();
56 	if (rc) {
57 		return INTERNAL_ERROR;
58 	}
59 
60 	/*
61 	 * initialise the platform supported crypto module that will
62 	 * be used by the DRTM-service to calculate hash of DRTM-
63 	 * implementation specific components
64 	 */
65 	crypto_mod_init();
66 
67 	/* Build DRTM-compatible address map. */
68 	plat_drtm_mem_map = drtm_build_address_map();
69 	if (plat_drtm_mem_map == NULL) {
70 		return INTERNAL_ERROR;
71 	}
72 
73 	/* Get DRTM features from platform hooks. */
74 	plat_tpm_feat = plat_drtm_get_tpm_features();
75 	if (plat_tpm_feat == NULL) {
76 		return INTERNAL_ERROR;
77 	}
78 
79 	plat_dma_prot_feat = plat_drtm_get_dma_prot_features();
80 	if (plat_dma_prot_feat == NULL) {
81 		return INTERNAL_ERROR;
82 	}
83 
84 	/*
85 	 * Add up minimum DLME data memory.
86 	 *
87 	 * For systems with complete DMA protection there is only one entry in
88 	 * the protected regions table.
89 	 */
90 	if (plat_dma_prot_feat->dma_protection_support ==
91 			ARM_DRTM_DMA_PROT_FEATURES_DMA_SUPPORT_COMPLETE) {
92 		dlme_data_min_size =
93 			sizeof(drtm_memory_region_descriptor_table_t) +
94 			sizeof(drtm_mem_region_t);
95 		dlme_data_hdr_init.dlme_prot_regions_size = dlme_data_min_size;
96 	} else {
97 		/*
98 		 * TODO set protected regions table size based on platform DMA
99 		 * protection configuration
100 		 */
101 		panic();
102 	}
103 
104 	dlme_data_hdr_init.dlme_addr_map_size = drtm_get_address_map_size();
105 	dlme_data_hdr_init.dlme_tcb_hashes_table_size =
106 				plat_drtm_get_tcb_hash_table_size();
107 	dlme_data_hdr_init.dlme_impdef_region_size =
108 				plat_drtm_get_imp_def_dlme_region_size();
109 
110 	dlme_data_min_size += dlme_data_hdr_init.dlme_addr_map_size +
111 			      PLAT_DRTM_EVENT_LOG_MAX_SIZE +
112 			      dlme_data_hdr_init.dlme_tcb_hashes_table_size +
113 			      dlme_data_hdr_init.dlme_impdef_region_size;
114 
115 	dlme_data_min_size = page_align(dlme_data_min_size, UP)/PAGE_SIZE;
116 
117 	/* Fill out platform DRTM features structure */
118 	/* Only support default PCR schema (0x1) in this implementation. */
119 	ARM_DRTM_TPM_FEATURES_SET_PCR_SCHEMA(plat_drtm_features.tpm_features,
120 		ARM_DRTM_TPM_FEATURES_PCR_SCHEMA_DEFAULT);
121 	ARM_DRTM_TPM_FEATURES_SET_TPM_HASH(plat_drtm_features.tpm_features,
122 		plat_tpm_feat->tpm_based_hash_support);
123 	ARM_DRTM_TPM_FEATURES_SET_FW_HASH(plat_drtm_features.tpm_features,
124 		plat_tpm_feat->firmware_hash_algorithm);
125 	ARM_DRTM_MIN_MEM_REQ_SET_MIN_DLME_DATA_SIZE(plat_drtm_features.minimum_memory_requirement,
126 		dlme_data_min_size);
127 	ARM_DRTM_MIN_MEM_REQ_SET_DCE_SIZE(plat_drtm_features.minimum_memory_requirement,
128 		plat_drtm_get_min_size_normal_world_dce());
129 	ARM_DRTM_DMA_PROT_FEATURES_SET_MAX_REGIONS(plat_drtm_features.dma_prot_features,
130 		plat_dma_prot_feat->max_num_mem_prot_regions);
131 	ARM_DRTM_DMA_PROT_FEATURES_SET_DMA_SUPPORT(plat_drtm_features.dma_prot_features,
132 		plat_dma_prot_feat->dma_protection_support);
133 	ARM_DRTM_TCB_HASH_FEATURES_SET_MAX_NUM_HASHES(plat_drtm_features.tcb_hash_features,
134 		plat_drtm_get_tcb_hash_features());
135 
136 	return 0;
137 }
138 
139 static inline uint64_t drtm_features_tpm(void *ctx)
140 {
141 	SMC_RET2(ctx, 1ULL, /* TPM feature is supported */
142 		 plat_drtm_features.tpm_features);
143 }
144 
145 static inline uint64_t drtm_features_mem_req(void *ctx)
146 {
147 	SMC_RET2(ctx, 1ULL, /* memory req Feature is supported */
148 		 plat_drtm_features.minimum_memory_requirement);
149 }
150 
151 static inline uint64_t drtm_features_boot_pe_id(void *ctx)
152 {
153 	SMC_RET2(ctx, 1ULL, /* Boot PE feature is supported */
154 		 plat_drtm_features.boot_pe_id);
155 }
156 
157 static inline uint64_t drtm_features_dma_prot(void *ctx)
158 {
159 	SMC_RET2(ctx, 1ULL, /* DMA protection feature is supported */
160 		 plat_drtm_features.dma_prot_features);
161 }
162 
163 static inline uint64_t drtm_features_tcb_hashes(void *ctx)
164 {
165 	SMC_RET2(ctx, 1ULL, /* TCB hash feature is supported */
166 		 plat_drtm_features.tcb_hash_features);
167 }
168 
169 static enum drtm_retc drtm_dl_check_caller_el(void *ctx)
170 {
171 	uint64_t spsr_el3 = read_ctx_reg(get_el3state_ctx(ctx), CTX_SPSR_EL3);
172 	uint64_t dl_caller_el;
173 	uint64_t dl_caller_aarch;
174 
175 	dl_caller_el = spsr_el3 >> MODE_EL_SHIFT & MODE_EL_MASK;
176 	dl_caller_aarch = spsr_el3 >> MODE_RW_SHIFT & MODE_RW_MASK;
177 
178 	/* Caller's security state is checked from drtm_smc_handle function */
179 
180 	/* Caller can be NS-EL2/EL1 */
181 	if (dl_caller_el == MODE_EL3) {
182 		ERROR("DRTM: invalid launch from EL3\n");
183 		return DENIED;
184 	}
185 
186 	if (dl_caller_aarch != MODE_RW_64) {
187 		ERROR("DRTM: invalid launch from non-AArch64 execution state\n");
188 		return DENIED;
189 	}
190 
191 	return SUCCESS;
192 }
193 
194 static enum drtm_retc drtm_dl_check_cores(void)
195 {
196 	bool running_on_single_core;
197 	uint64_t this_pe_aff_value = read_mpidr_el1() & MPIDR_AFFINITY_MASK;
198 
199 	if (this_pe_aff_value != plat_drtm_features.boot_pe_id) {
200 		ERROR("DRTM: invalid launch on a non-boot PE\n");
201 		return DENIED;
202 	}
203 
204 	running_on_single_core = psci_is_last_on_cpu_safe();
205 	if (!running_on_single_core) {
206 		ERROR("DRTM: invalid launch due to non-boot PE not being turned off\n");
207 		return DENIED;
208 	}
209 
210 	return SUCCESS;
211 }
212 
213 static enum drtm_retc drtm_dl_prepare_dlme_data(const struct_drtm_dl_args *args)
214 {
215 	int rc;
216 	uint64_t dlme_data_paddr;
217 	size_t dlme_data_max_size;
218 	uintptr_t dlme_data_mapping;
219 	struct_dlme_data_header *dlme_data_hdr;
220 	uint8_t *dlme_data_cursor;
221 	size_t dlme_data_mapping_bytes;
222 	size_t serialised_bytes_actual;
223 
224 	dlme_data_paddr = args->dlme_paddr + args->dlme_data_off;
225 	dlme_data_max_size = args->dlme_size - args->dlme_data_off;
226 
227 	/*
228 	 * The capacity of the given DLME data region is checked when
229 	 * the other dynamic launch arguments are.
230 	 */
231 	if (dlme_data_max_size < dlme_data_min_size) {
232 		ERROR("%s: assertion failed:"
233 		      " dlme_data_max_size (%ld) < dlme_data_total_bytes_req (%ld)\n",
234 		      __func__, dlme_data_max_size, dlme_data_min_size);
235 		panic();
236 	}
237 
238 	/* Map the DLME data region as NS memory. */
239 	dlme_data_mapping_bytes = ALIGNED_UP(dlme_data_max_size, DRTM_PAGE_SIZE);
240 	rc = mmap_add_dynamic_region_alloc_va(dlme_data_paddr,
241 					      &dlme_data_mapping,
242 					      dlme_data_mapping_bytes,
243 					      MT_RW_DATA | MT_NS |
244 					      MT_SHAREABILITY_ISH);
245 	if (rc != 0) {
246 		WARN("DRTM: %s: mmap_add_dynamic_region() failed rc=%d\n",
247 		     __func__, rc);
248 		return INTERNAL_ERROR;
249 	}
250 	dlme_data_hdr = (struct_dlme_data_header *)dlme_data_mapping;
251 	dlme_data_cursor = (uint8_t *)dlme_data_hdr + sizeof(*dlme_data_hdr);
252 
253 	memcpy(dlme_data_hdr, (const void *)&dlme_data_hdr_init,
254 	       sizeof(*dlme_data_hdr));
255 
256 	/* Set the header version and size. */
257 	dlme_data_hdr->version = 1;
258 	dlme_data_hdr->this_hdr_size = sizeof(*dlme_data_hdr);
259 
260 	/* Prepare DLME protected regions. */
261 	drtm_dma_prot_serialise_table(dlme_data_cursor,
262 				      &serialised_bytes_actual);
263 	assert(serialised_bytes_actual ==
264 	       dlme_data_hdr->dlme_prot_regions_size);
265 	dlme_data_cursor += serialised_bytes_actual;
266 
267 	/* Prepare DLME address map. */
268 	if (plat_drtm_mem_map != NULL) {
269 		memcpy(dlme_data_cursor, plat_drtm_mem_map,
270 		       dlme_data_hdr->dlme_addr_map_size);
271 	} else {
272 		WARN("DRTM: DLME address map is not in the cache\n");
273 	}
274 	dlme_data_cursor += dlme_data_hdr->dlme_addr_map_size;
275 
276 	/* Prepare DRTM event log for DLME. */
277 	drtm_serialise_event_log(dlme_data_cursor, &serialised_bytes_actual);
278 	assert(serialised_bytes_actual <= PLAT_DRTM_EVENT_LOG_MAX_SIZE);
279 	dlme_data_hdr->dlme_tpm_log_size = serialised_bytes_actual;
280 	dlme_data_cursor += serialised_bytes_actual;
281 
282 	/*
283 	 * TODO: Prepare the TCB hashes for DLME, currently its size
284 	 * 0
285 	 */
286 	dlme_data_cursor += dlme_data_hdr->dlme_tcb_hashes_table_size;
287 
288 	/* Implementation-specific region size is unused. */
289 	dlme_data_cursor += dlme_data_hdr->dlme_impdef_region_size;
290 
291 	/*
292 	 * Prepare DLME data size, includes all data region referenced above
293 	 * alongwith the DLME data header
294 	 */
295 	dlme_data_hdr->dlme_data_size = dlme_data_cursor - (uint8_t *)dlme_data_hdr;
296 
297 	/* Unmap the DLME data region. */
298 	rc = mmap_remove_dynamic_region(dlme_data_mapping, dlme_data_mapping_bytes);
299 	if (rc != 0) {
300 		ERROR("%s(): mmap_remove_dynamic_region() failed"
301 		      " unexpectedly rc=%d\n", __func__, rc);
302 		panic();
303 	}
304 
305 	return SUCCESS;
306 }
307 
308 /*
309  * Note: accesses to the dynamic launch args, and to the DLME data are
310  * little-endian as required, thanks to TF-A BL31 init requirements.
311  */
312 static enum drtm_retc drtm_dl_check_args(uint64_t x1,
313 					 struct_drtm_dl_args *a_out)
314 {
315 	uint64_t dlme_start, dlme_end;
316 	uint64_t dlme_img_start, dlme_img_ep, dlme_img_end;
317 	uint64_t dlme_data_start, dlme_data_end;
318 	uintptr_t args_mapping;
319 	size_t args_mapping_size;
320 	struct_drtm_dl_args *a;
321 	struct_drtm_dl_args args_buf;
322 	int rc;
323 
324 	if (x1 % DRTM_PAGE_SIZE != 0) {
325 		ERROR("DRTM: parameters structure is not "
326 		      DRTM_PAGE_SIZE_STR "-aligned\n");
327 		return INVALID_PARAMETERS;
328 	}
329 
330 	args_mapping_size = ALIGNED_UP(sizeof(struct_drtm_dl_args), DRTM_PAGE_SIZE);
331 	rc = mmap_add_dynamic_region_alloc_va(x1, &args_mapping, args_mapping_size,
332 					      MT_MEMORY | MT_NS | MT_RO |
333 					      MT_SHAREABILITY_ISH);
334 	if (rc != 0) {
335 		WARN("DRTM: %s: mmap_add_dynamic_region() failed rc=%d\n",
336 		      __func__, rc);
337 		return INTERNAL_ERROR;
338 	}
339 	a = (struct_drtm_dl_args *)args_mapping;
340 	/*
341 	 * TODO: invalidate all data cache before reading the data passed by the
342 	 * DCE Preamble.  This is required to avoid / defend against racing with
343 	 * cache evictions.
344 	 */
345 	args_buf = *a;
346 
347 	rc = mmap_remove_dynamic_region(args_mapping, args_mapping_size);
348 	if (rc) {
349 		ERROR("%s(): mmap_remove_dynamic_region() failed unexpectedly"
350 		      " rc=%d\n", __func__, rc);
351 		panic();
352 	}
353 	a = &args_buf;
354 
355 	if (a->version != 1) {
356 		ERROR("DRTM: parameters structure incompatible with major version %d\n",
357 		      ARM_DRTM_VERSION_MAJOR);
358 		return NOT_SUPPORTED;
359 	}
360 
361 	if (!(a->dlme_img_off < a->dlme_size &&
362 	      a->dlme_data_off < a->dlme_size)) {
363 		ERROR("DRTM: argument offset is outside of the DLME region\n");
364 		return INVALID_PARAMETERS;
365 	}
366 	dlme_start = a->dlme_paddr;
367 	dlme_end = a->dlme_paddr + a->dlme_size;
368 	dlme_img_start = a->dlme_paddr + a->dlme_img_off;
369 	dlme_img_ep = dlme_img_start + a->dlme_img_ep_off;
370 	dlme_img_end = dlme_img_start + a->dlme_img_size;
371 	dlme_data_start = a->dlme_paddr + a->dlme_data_off;
372 	dlme_data_end = dlme_end;
373 
374 	/*
375 	 * TODO: validate that the DLME physical address range is all NS memory,
376 	 * return INVALID_PARAMETERS if it is not.
377 	 * Note that this check relies on platform-specific information. For
378 	 * examples, see psci_plat_pm_ops->validate_ns_entrypoint() or
379 	 * arm_validate_ns_entrypoint().
380 	 */
381 
382 	/* Check the DLME regions arguments. */
383 	if ((dlme_start % DRTM_PAGE_SIZE) != 0) {
384 		ERROR("DRTM: argument DLME region is not "
385 		      DRTM_PAGE_SIZE_STR "-aligned\n");
386 		return INVALID_PARAMETERS;
387 	}
388 
389 	if (!(dlme_start < dlme_end &&
390 	      dlme_start <= dlme_img_start && dlme_img_start < dlme_img_end &&
391 	      dlme_start <= dlme_data_start && dlme_data_start < dlme_data_end)) {
392 		ERROR("DRTM: argument DLME region is discontiguous\n");
393 		return INVALID_PARAMETERS;
394 	}
395 
396 	if (dlme_img_start < dlme_data_end && dlme_data_start < dlme_img_end) {
397 		ERROR("DRTM: argument DLME regions overlap\n");
398 		return INVALID_PARAMETERS;
399 	}
400 
401 	/* Check the DLME image region arguments. */
402 	if ((dlme_img_start % DRTM_PAGE_SIZE) != 0) {
403 		ERROR("DRTM: argument DLME image region is not "
404 		      DRTM_PAGE_SIZE_STR "-aligned\n");
405 		return INVALID_PARAMETERS;
406 	}
407 
408 	if (!(dlme_img_start <= dlme_img_ep && dlme_img_ep < dlme_img_end)) {
409 		ERROR("DRTM: DLME entry point is outside of the DLME image region\n");
410 		return INVALID_PARAMETERS;
411 	}
412 
413 	if ((dlme_img_ep % 4) != 0) {
414 		ERROR("DRTM: DLME image entry point is not 4-byte-aligned\n");
415 		return INVALID_PARAMETERS;
416 	}
417 
418 	/* Check the DLME data region arguments. */
419 	if ((dlme_data_start % DRTM_PAGE_SIZE) != 0) {
420 		ERROR("DRTM: argument DLME data region is not "
421 		      DRTM_PAGE_SIZE_STR "-aligned\n");
422 		return INVALID_PARAMETERS;
423 	}
424 
425 	if (dlme_data_end - dlme_data_start < dlme_data_min_size) {
426 		ERROR("DRTM: argument DLME data region is short of %lu bytes\n",
427 		      dlme_data_min_size - (size_t)(dlme_data_end - dlme_data_start));
428 		return INVALID_PARAMETERS;
429 	}
430 
431 	/* Check the Normal World DCE region arguments. */
432 	if (a->dce_nwd_paddr != 0) {
433 		uint32_t dce_nwd_start = a->dce_nwd_paddr;
434 		uint32_t dce_nwd_end = dce_nwd_start + a->dce_nwd_size;
435 
436 		if (!(dce_nwd_start < dce_nwd_end)) {
437 			ERROR("DRTM: argument Normal World DCE region is dicontiguous\n");
438 			return INVALID_PARAMETERS;
439 		}
440 
441 		if (dce_nwd_start < dlme_end && dlme_start < dce_nwd_end) {
442 			ERROR("DRTM: argument Normal World DCE regions overlap\n");
443 			return INVALID_PARAMETERS;
444 		}
445 	}
446 
447 	*a_out = *a;
448 	return SUCCESS;
449 }
450 
451 static void drtm_dl_reset_dlme_el_state(enum drtm_dlme_el dlme_el)
452 {
453 	uint64_t sctlr;
454 
455 	/*
456 	 * TODO: Set PE state according to the PSCI's specification of the initial
457 	 * state after CPU_ON, or to reset values if unspecified, where they exist,
458 	 * or define sensible values otherwise.
459 	 */
460 
461 	switch (dlme_el) {
462 	case DLME_AT_EL1:
463 		sctlr = read_sctlr_el1();
464 		break;
465 
466 	case DLME_AT_EL2:
467 		sctlr = read_sctlr_el2();
468 		break;
469 
470 	default: /* Not reached */
471 		ERROR("%s(): dlme_el has the unexpected value %d\n",
472 		      __func__, dlme_el);
473 		panic();
474 	}
475 
476 	sctlr &= ~(/* Disable DLME's EL MMU, since the existing page-tables are untrusted. */
477 		   SCTLR_M_BIT
478 		   | SCTLR_EE_BIT               /* Little-endian data accesses. */
479 		  );
480 
481 	sctlr |= SCTLR_C_BIT | SCTLR_I_BIT; /* Allow instruction and data caching. */
482 
483 	switch (dlme_el) {
484 	case DLME_AT_EL1:
485 		write_sctlr_el1(sctlr);
486 		break;
487 
488 	case DLME_AT_EL2:
489 		write_sctlr_el2(sctlr);
490 		break;
491 	}
492 }
493 
494 static void drtm_dl_reset_dlme_context(enum drtm_dlme_el dlme_el)
495 {
496 	void *ns_ctx = cm_get_context(NON_SECURE);
497 	gp_regs_t *gpregs = get_gpregs_ctx(ns_ctx);
498 	uint64_t spsr_el3 = read_ctx_reg(get_el3state_ctx(ns_ctx), CTX_SPSR_EL3);
499 
500 	/* Reset all gpregs, including SP_EL0. */
501 	memset(gpregs, 0, sizeof(*gpregs));
502 
503 	/* Reset SP_ELx. */
504 	switch (dlme_el) {
505 	case DLME_AT_EL1:
506 		write_sp_el1(0);
507 		break;
508 
509 	case DLME_AT_EL2:
510 		write_sp_el2(0);
511 		break;
512 	}
513 
514 	/*
515 	 * DLME's async exceptions are masked to avoid a NWd attacker's timed
516 	 * interference with any state we established trust in or measured.
517 	 */
518 	spsr_el3 |= SPSR_DAIF_MASK << SPSR_DAIF_SHIFT;
519 
520 	write_ctx_reg(get_el3state_ctx(ns_ctx), CTX_SPSR_EL3, spsr_el3);
521 }
522 
523 static void drtm_dl_prepare_eret_to_dlme(const struct_drtm_dl_args *args, enum drtm_dlme_el dlme_el)
524 {
525 	void *ctx = cm_get_context(NON_SECURE);
526 	uint64_t dlme_ep = DL_ARGS_GET_DLME_ENTRY_POINT(args);
527 	uint64_t spsr_el3 = read_ctx_reg(get_el3state_ctx(ctx), CTX_SPSR_EL3);
528 
529 	/* Next ERET is to the DLME's EL. */
530 	spsr_el3 &= ~(MODE_EL_MASK << MODE_EL_SHIFT);
531 	switch (dlme_el) {
532 	case DLME_AT_EL1:
533 		spsr_el3 |= MODE_EL1 << MODE_EL_SHIFT;
534 		break;
535 
536 	case DLME_AT_EL2:
537 		spsr_el3 |= MODE_EL2 << MODE_EL_SHIFT;
538 		break;
539 	}
540 
541 	/* Next ERET is to the DLME entry point. */
542 	cm_set_elr_spsr_el3(NON_SECURE, dlme_ep, spsr_el3);
543 }
544 
545 static uint64_t drtm_dynamic_launch(uint64_t x1, void *handle)
546 {
547 	enum drtm_retc ret = SUCCESS;
548 	enum drtm_retc dma_prot_ret;
549 	struct_drtm_dl_args args;
550 	/* DLME should be highest NS exception level */
551 	enum drtm_dlme_el dlme_el = (el_implemented(2) != EL_IMPL_NONE) ? MODE_EL2 : MODE_EL1;
552 
553 	/* Ensure that only boot PE is powered on */
554 	ret = drtm_dl_check_cores();
555 	if (ret != SUCCESS) {
556 		SMC_RET1(handle, ret);
557 	}
558 
559 	/*
560 	 * Ensure that execution state is AArch64 and the caller
561 	 * is highest non-secure exception level
562 	 */
563 	ret = drtm_dl_check_caller_el(handle);
564 	if (ret != SUCCESS) {
565 		SMC_RET1(handle, ret);
566 	}
567 
568 	ret = drtm_dl_check_args(x1, &args);
569 	if (ret != SUCCESS) {
570 		SMC_RET1(handle, ret);
571 	}
572 
573 	/* Ensure that there are no SDEI event registered */
574 #if SDEI_SUPPORT
575 	if (sdei_get_registered_event_count() != 0) {
576 		SMC_RET1(handle, DENIED);
577 	}
578 #endif /* SDEI_SUPPORT */
579 
580 	/*
581 	 * Engage the DMA protections.  The launch cannot proceed without the DMA
582 	 * protections due to potential TOC/TOU vulnerabilities w.r.t. the DLME
583 	 * region (and to the NWd DCE region).
584 	 */
585 	ret = drtm_dma_prot_engage(&args.dma_prot_args,
586 				   DL_ARGS_GET_DMA_PROT_TYPE(&args));
587 	if (ret != SUCCESS) {
588 		SMC_RET1(handle, ret);
589 	}
590 
591 	/*
592 	 * The DMA protection is now engaged.  Note that any failure mode that
593 	 * returns an error to the DRTM-launch caller must now disengage DMA
594 	 * protections before returning to the caller.
595 	 */
596 
597 	ret = drtm_take_measurements(&args);
598 	if (ret != SUCCESS) {
599 		goto err_undo_dma_prot;
600 	}
601 
602 	ret = drtm_dl_prepare_dlme_data(&args);
603 	if (ret != SUCCESS) {
604 		goto err_undo_dma_prot;
605 	}
606 
607 	/*
608 	 * Note that, at the time of writing, the DRTM spec allows a successful
609 	 * launch from NS-EL1 to return to a DLME in NS-EL2.  The practical risk
610 	 * of a privilege escalation, e.g. due to a compromised hypervisor, is
611 	 * considered small enough not to warrant the specification of additional
612 	 * DRTM conduits that would be necessary to maintain OSs' abstraction from
613 	 * the presence of EL2 were the dynamic launch only be allowed from the
614 	 * highest NS EL.
615 	 */
616 
617 	dlme_el = (el_implemented(2) != EL_IMPL_NONE) ? MODE_EL2 : MODE_EL1;
618 
619 	drtm_dl_reset_dlme_el_state(dlme_el);
620 	drtm_dl_reset_dlme_context(dlme_el);
621 
622 	drtm_dl_prepare_eret_to_dlme(&args, dlme_el);
623 
624 	/*
625 	 * TODO: invalidate the instruction cache before jumping to the DLME.
626 	 * This is required to defend against potentially-malicious cache contents.
627 	 */
628 
629 	/* Return the DLME region's address in x0, and the DLME data offset in x1.*/
630 	SMC_RET2(handle, args.dlme_paddr, args.dlme_data_off);
631 
632 err_undo_dma_prot:
633 	dma_prot_ret = drtm_dma_prot_disengage();
634 	if (dma_prot_ret != SUCCESS) {
635 		ERROR("%s(): drtm_dma_prot_disengage() failed unexpectedly"
636 		      " rc=%d\n", __func__, ret);
637 		panic();
638 	}
639 
640 	SMC_RET1(handle, ret);
641 }
642 
643 uint64_t drtm_smc_handler(uint32_t smc_fid,
644 			  uint64_t x1,
645 			  uint64_t x2,
646 			  uint64_t x3,
647 			  uint64_t x4,
648 			  void *cookie,
649 			  void *handle,
650 			  uint64_t flags)
651 {
652 	/* Check that the SMC call is from the Normal World. */
653 	if (!is_caller_non_secure(flags)) {
654 		SMC_RET1(handle, NOT_SUPPORTED);
655 	}
656 
657 	switch (smc_fid) {
658 	case ARM_DRTM_SVC_VERSION:
659 		INFO("DRTM service handler: version\n");
660 		/* Return the version of current implementation */
661 		SMC_RET1(handle, ARM_DRTM_VERSION);
662 		break;	/* not reached */
663 
664 	case ARM_DRTM_SVC_FEATURES:
665 		if (((x1 >> ARM_DRTM_FUNC_SHIFT) & ARM_DRTM_FUNC_MASK) ==
666 		    ARM_DRTM_FUNC_ID) {
667 			/* Dispatch function-based queries. */
668 			switch (x1 & FUNCID_MASK) {
669 			case ARM_DRTM_SVC_VERSION:
670 				SMC_RET1(handle, SUCCESS);
671 				break;	/* not reached */
672 
673 			case ARM_DRTM_SVC_FEATURES:
674 				SMC_RET1(handle, SUCCESS);
675 				break;	/* not reached */
676 
677 			case ARM_DRTM_SVC_UNPROTECT_MEM:
678 				SMC_RET1(handle, SUCCESS);
679 				break;	/* not reached */
680 
681 			case ARM_DRTM_SVC_DYNAMIC_LAUNCH:
682 				SMC_RET1(handle, SUCCESS);
683 				break;	/* not reached */
684 
685 			case ARM_DRTM_SVC_CLOSE_LOCALITY:
686 				WARN("ARM_DRTM_SVC_CLOSE_LOCALITY feature %s",
687 				     "is not supported\n");
688 				SMC_RET1(handle, NOT_SUPPORTED);
689 				break;	/* not reached */
690 
691 			case ARM_DRTM_SVC_GET_ERROR:
692 				SMC_RET1(handle, SUCCESS);
693 				break;	/* not reached */
694 
695 			case ARM_DRTM_SVC_SET_ERROR:
696 				SMC_RET1(handle, SUCCESS);
697 				break;	/* not reached */
698 
699 			case ARM_DRTM_SVC_SET_TCB_HASH:
700 				WARN("ARM_DRTM_SVC_TCB_HASH feature %s",
701 				     "is not supported\n");
702 				SMC_RET1(handle, NOT_SUPPORTED);
703 				break;	/* not reached */
704 
705 			case ARM_DRTM_SVC_LOCK_TCB_HASH:
706 				WARN("ARM_DRTM_SVC_LOCK_TCB_HASH feature %s",
707 				     "is not supported\n");
708 				SMC_RET1(handle, NOT_SUPPORTED);
709 				break;	/* not reached */
710 
711 			default:
712 				ERROR("Unknown DRTM service function\n");
713 				SMC_RET1(handle, NOT_SUPPORTED);
714 				break;	/* not reached */
715 			}
716 		} else {
717 			/* Dispatch feature-based queries. */
718 			switch (x1 & ARM_DRTM_FEAT_ID_MASK) {
719 			case ARM_DRTM_FEATURES_TPM:
720 				INFO("++ DRTM service handler: TPM features\n");
721 				return drtm_features_tpm(handle);
722 				break;	/* not reached */
723 
724 			case ARM_DRTM_FEATURES_MEM_REQ:
725 				INFO("++ DRTM service handler: Min. mem."
726 				     " requirement features\n");
727 				return drtm_features_mem_req(handle);
728 				break;	/* not reached */
729 
730 			case ARM_DRTM_FEATURES_DMA_PROT:
731 				INFO("++ DRTM service handler: "
732 				     "DMA protection features\n");
733 				return drtm_features_dma_prot(handle);
734 				break;	/* not reached */
735 
736 			case ARM_DRTM_FEATURES_BOOT_PE_ID:
737 				INFO("++ DRTM service handler: "
738 				     "Boot PE ID features\n");
739 				return drtm_features_boot_pe_id(handle);
740 				break;	/* not reached */
741 
742 			case ARM_DRTM_FEATURES_TCB_HASHES:
743 				INFO("++ DRTM service handler: "
744 				     "TCB-hashes features\n");
745 				return drtm_features_tcb_hashes(handle);
746 				break;	/* not reached */
747 
748 			default:
749 				ERROR("Unknown ARM DRTM service feature\n");
750 				SMC_RET1(handle, NOT_SUPPORTED);
751 				break;	/* not reached */
752 			}
753 		}
754 
755 	case ARM_DRTM_SVC_UNPROTECT_MEM:
756 		INFO("DRTM service handler: unprotect mem\n");
757 		return drtm_unprotect_mem(handle);
758 		break;	/* not reached */
759 
760 	case ARM_DRTM_SVC_DYNAMIC_LAUNCH:
761 		INFO("DRTM service handler: dynamic launch\n");
762 		return drtm_dynamic_launch(x1, handle);
763 		break;	/* not reached */
764 
765 	case ARM_DRTM_SVC_CLOSE_LOCALITY:
766 		WARN("DRTM service handler: close locality %s\n",
767 		     "is not supported");
768 		SMC_RET1(handle, NOT_SUPPORTED);
769 		break;	/* not reached */
770 
771 	case ARM_DRTM_SVC_GET_ERROR:
772 		INFO("DRTM service handler: get error\n");
773 		drtm_get_error(handle);
774 		break;	/* not reached */
775 
776 	case ARM_DRTM_SVC_SET_ERROR:
777 		INFO("DRTM service handler: set error\n");
778 		drtm_set_error(x1, handle);
779 		break;	/* not reached */
780 
781 	case ARM_DRTM_SVC_SET_TCB_HASH:
782 		WARN("DRTM service handler: set TCB hash %s\n",
783 		     "is not supported");
784 		SMC_RET1(handle, NOT_SUPPORTED);
785 		break;  /* not reached */
786 
787 	case ARM_DRTM_SVC_LOCK_TCB_HASH:
788 		WARN("DRTM service handler: lock TCB hash %s\n",
789 		     "is not supported");
790 		SMC_RET1(handle, NOT_SUPPORTED);
791 		break;  /* not reached */
792 
793 	default:
794 		ERROR("Unknown DRTM service function: 0x%x\n", smc_fid);
795 		SMC_RET1(handle, SMC_UNK);
796 		break;	/* not reached */
797 	}
798 
799 	/* not reached */
800 	SMC_RET1(handle, SMC_UNK);
801 }
802